+-----------------------------------------------------------------------------+
| Enhanced WHO v1.0 |
| Written by Drew [PWA] |
| Docs last updated 02-01-96 |
+-----------------------------------------------------------------------------+
+-----------------------------------------------------------------------------+
| 0. Table of Contents |
+-----------------------------------------------------------------------------+
1. Introduction
2. Packaging
3. Installation
4. More Program Information
5. Configuration - External Files
6. Other Program Information
7. Contacting the Author
+-----------------------------------------------------------------------------+
| 1. Introduction |
+-----------------------------------------------------------------------------+
Enhanced WHO is a PCBoard 15.2+ PPE replacement for your WHO command.
It allows users to view node activity with a variety of useful infor-
mation. For sysops, configurability and flexibility along with speed
of execution is totally unprecedented. Enhanced WHO features:
[*] Lightbar node selection
[*] Real-time node activity updating
[*] External PPE spawning
[*] Viewable user stats for users online
[*] Viewable file xfer stats during file xfers
[*] Configurable headers, footers, displays, text, everything!
The best way to find out if all the features is useful to you is try
it. Please peruse this documentation thoroughly to avoid any problems.
+-----------------------------------------------------------------------------+
| 2. Packaging |
+-----------------------------------------------------------------------------+
Your zip file should contain the following files:
EWHO .PPE The main EWHO ppe.
EWHO .DOC Documentation for EWHO.
EWHOHLP1 EWHO Help Screen #1
EWHOHLP2 EWHO Help Screen #2
EWHOPCB .ZIP Sample Configuration - Default PCBoard style
EWHOCNAV .ZIP Sample Configuration - CNAV style
EWHOAMIX .ZIP Sample Configuration - AMIX style
EWHOTSP .ZIP Sample Configuration - As seen on my system
EWHOFING .ZIP Sample FINGER.PPE with source.
OTHERDJP .DOC Other stuff I've written.
FILE_ID .DIZ File (zip) description.
PWA .NFO PWA info file.
TSP .NFO My bbs ad.
Note that files without an extension are PCBoard language aware.
If any of these files are missing, be warned that you may have a copy
that has been tampered with. If you have any extra files, they are
extraneous and unnecessary.
+-----------------------------------------------------------------------------+
| 3. Installation |
+-----------------------------------------------------------------------------+
Unzip all files from the archive into it's own directory and install
EWHO.PPE in your CMD.LST. Unzip one of the included zip files which
contain a sample configuration. This will extract the needed display
and configuration files for you to modify for your system.
EWHO can be a a new command or as a replacement for the default
"WHO" command. Please refer to your PCBoard documentation on how
to add a new command to your CMD.LST.
COMMAND LINE PARAMETERS
-----------------------
There are two valid parameters you may pass to EWHO upon execution:
/QUIT EWHO will display node activity and quit. In contrast, the
normal mode of operation is to wait for a specified number of
seconds for user input before terminating.
/OLM EWHO will display node activity and then prompt the user for
information regarding sending an online message (broadcast
message).
INCLUDED ZIP FILES
------------------
There are several sample configurations included with EWHO:
EWHOAMIX AMI-X style
EWHOCNAV CNAV style
EWHOPCB PCBoard style
EWHOTSP Style as seen on my system
EWHOFING Sample FINGER.PPE with source
Simple unzip any of the first four to use. The FINGER.PPE is included
as an example of what a FINGER.PPE may look like, if you choose to use
one instead of the internal routines. I've included source so you that
all the posers out there who rip code can make a release out of it. :)
+-----------------------------------------------------------------------------+
| 4. More Program Information |
+-----------------------------------------------------------------------------+
Without the /QUIT parameter, EWHO will display node activity, and then
wait for user input before automatically quitting. The time it waits
is specified in EWHOCFG.
While waiting for user input, node activity is updated in real-time.
The time between updates is also specifed in EWHOCFG. Note that only
nodes which have had a change in activity will be updated. If the
number of nodes you have displayed plus the length of the header and
footer display files exceed 22 (the maximum number of lines shown on
the sysop's local screen), then EWHO will automatically quit after
printing node activity as if the /QUIT parameter were specified. This
occurs because there are too many nodes to display on the screen for
real-time updating.
+-----------------------------------------------------------------------------+
| 5. Configuration - External Files |
+-----------------------------------------------------------------------------+
All external configuration files are fully language aware. Simply
append the corresponding extension for usage in another language.
Most configuration files are either self-explanatory or well docu-
mented within. If you are very familiar with installing PPE's in
general, you should have no problem understanding how the external
files work. However, the information contained therein is still
repeated here to centralize a main source of reference.
EWHOCFG
-----------------------------------------------------------------------
This is the main configuration file which properly defines many of the
options featured in Enhanced WHO. There are three sections in the
config file: 1) General Info, 2) Node Info, and 3) Protocol Info.
Each section begins with a "title" line, followed by a separator, and
a blank line between each section. These lines are actually ignored
by the PPE itself, but must be present for correct usage.
Section 1 - General Information
-------------------------------
Line 1: Reserved for future use.
Line 2: Full path name of PPE to use for viewing another user
(ie: a "finger.ppe") or "internal" for the internal viewer.
Line 3: Full path name of PPE to use for online/broadcast messages
(OLM) or "internal" for the internal olm.
Line 4: Various options:
Token 1: "yes" or "no" : log usage to caller log
Token 2: Number of seconds between node updates (in real-
time). Only nodes where the activity has changed
will actually be updated, so the display does not
look "blinky". This is more commonly known as
"active mode".
Token 3: Number of seconds before auto-quitting the PPE.
This is the number of seconds before the PPE auto-
quits, so users do not just sit there and watch
the real-time updates.
Token 4: Column number of where to start printing the
lightbar
Token 5: Length/width of the lightbar.
Token 6: Color of lightbar (highlight color).
Section 2 - Node Information
----------------------------
Line 1: Number of nodes to display
Line 2: The text to display when there is no caller online.
Line 3: The full pathname of DSZ.LOG. The path must be the main
node directory.
Repeat Lines 2 & 3 for each node you wish to have displayed.
Section 3 - Protocol Information
--------------------------------
Line 1: Number of protocols on your system.
Line 2: The letter used to select the protocol on your system.
Line 3: The protocol name/description.
Note: This information is *not* read from PCBPROT.DAT
because it is not uncommon for the protocol name
to be longer than needed for displaying in this PPE.
EWHOBOT
-----------------------------------------------------------------------
This is merely the footer of the main "who" display.
EWHODAT
-----------------------------------------------------------------------
Various text strings/prompts used to describe possible node activities.
PCBoard color codes and macros are allowed in the text. Note that
three of the strings use a replacement code "%OPT% to add information
that is determined at run-time. The three to note are:
Activity Sample Text
---------------- --------------------
Out in a Door Using Door: %OPT%
Enter a Message Writing Msg to: %OPT%
Viewing a File Viewing file: %OPT%
EWHODSP
-----------------------------------------------------------------------
This defines a number of cosmetic text strings (prompts) as well as how
the actual information for each node is displayed. For best results,
use PCBEDIT to edit this file, as it uses the @POS macros extensively.
Note that lines 1-3 use "replacement" codes to fill in actual informa-
tion at run-time:
Replacement codes for Lines 1 & 2:
----------------------------------
%N% Node number
%U% User name
%S% Node status/activity
%C% No caller online string
Replacement codes for Lines 3
-----------------------------
%N% File number
%ULDL% Upload / Download status
%MIXFNAME% Filename being xfer'ed in mixed case
%SIZE% File size in bytes
%PROT% Protocol being used
%CPS% CPS rate of transferred file
%ERRS% Number of errors in transfer
The remaining lines after Line 3 are merely text prompts/strings.
EWHONODE
-----------------------------------------------------------------------
This shows the node information when no caller is online. There are
several replacement codes to be aware of:
%NODENUM% Node number
%IDLETIME% Time since idle
%IDLEMINS% Number of minutes idle
%LASTCALL% Last caller on (includes their city/usernote)
EWHOTOP
-----------------------------------------------------------------------
This is merely the header of the main "who" display. There are no
replacement codes here.
EWHOUSER
-----------------------------------------------------------------------
This is used in the internal routines for showing user information of
an online user. The valid replacement codes are:
%CAP_NAME% User name in all caps
%MIX_NAME% User name in mixed case
%CAP_CITY% City (user note) in all caps
%MIX_CITY% City (user note) in mixed case
%SL% Security level
%NC% Number of calls made
%CNUM% Caller number to system
%FDL% Files downloaded
%BDL% Bytes downloaded
%FUL% Files uploaded
%BUL% Bytes uploaded
%LOGIN_TIME% Time of login
%LOGIN_SPEED% Modem connect speed
%PORT_SPEED% Port speed for that node
EWHOXBOT
-----------------------------------------------------------------------
This is the footer show when displaying information during a file
transfer. The valid replacement codes are:
%N% File number during listing
%MIXFNAME% File name being transfered in mixed case.
%CAPFNAME% File name being transfered in all caps.
%SIZE% File size in bytes (comma delimited).
%CPS% CPS rate of transfered file.
%PROT% Protocol used to transfer file.
%ULDL% Upload/Download status of file.
%ERRS% Number of errors during transmission of file.
EWHOXTOP
-----------------------------------------------------------------------
This is the header shown when displaying information during a file
transfer. The valid replacement codes used here are identical to
EWHOUSER.
+-----------------------------------------------------------------------------+
| 6. Other Program Information |
+-----------------------------------------------------------------------------+
This utility is FREEWARE. No registration is required and there are
no nag screens. However, comments, suggestions and donations will
certainly be accepted. :) If you find this little utility useful,
feel free drop me a quick note.
Credit where credit is due:
Midnight Slasher, for writing the first extremely robust node
activity viewer (CNAV). Many sysops still use this too!
Bad Spirit, for writing a CNAV clone (ENV, Enhanced Node Viewer).
He was in PWA for a while, but due to unknown reasons, has decided
to more or less quit the scene.
+-----------------------------------------------------------------------------+
| 7. Contacting the Author |
+-----------------------------------------------------------------------------+
I am rarely on IRC, so don't be a dork and bother other PWA members.
Don't ask for source, and don't ask to be a distribution site, because
we don't have any.
You can reach me in the following ways:
Internet email : drew@topaz.com
Other : Attitude Net
Peace,
--Drew
