home *** CD-ROM | disk | FTP | other *** search
/ Carsten's PPE Collection / Carstens_PPE_Collection_2007.zip / T / T3.ZIP / CNAV.DOC < prev    next >
Text File  |  1994-08-29  |  16KB  |  295 lines
  1. ┌─────────────────────────────────────────────────────────────────────────────┐
  2. │ [CNAV]                Custom Node Activity Viewer PPE                [CNAV] │
  3. └─────────────────────────────────────────────────────────────────────────────┘
  4.           Custom Node Activity Viewer PPE (c) 1993-94 by Midnight Slasher
  5.                         Version: 3.30 Modified / Freeware
  6.                                    - 08/29/94 -
  7. ───────────────────────────────────────────────────────────────────────────────
  8. ───────────────────────────────────────────────────────────────────────────────
  9.                                                               <mslasher@io.org>
  10.  
  11. ───────────────────────────────────────────────────────────────────────────────
  12. [ FILES INCLUDED ] ····························································
  13. ───────────────────────────────────────────────────────────────────────────────
  14.   CNAV.ACT ····· The Activity Line Configuration File (Optional)
  15.   CNAV.COL ····· The Color Configuration File (Optional)
  16.   CNAV.DOC ····· Documentation and Installation Guide
  17.   CNAV.DAT ····· The Data Configuration File
  18.   CNAV.EXC ····· The Exclusion List File (Optional)
  19.   CNAV.HLP ····· The Online Help File
  20.   CNAV.HST ····· The Revison History/Whats.New File
  21.   CNAV.OPT ····· The Options File (Optional)
  22.   CNAV.PPE ····· The Node Activity Viewer PPE
  23.   CNAV.STA ····· The Statistics Display Screen (Optional)
  24.   FILE_ID.DIZ ·· Description Identification File
  25. ───────────────────────────────────────────────────────────────────────────────
  26.  
  27.  
  28. ───────────────────────────────────────────────────────────────────────────────
  29. [ PROGRAM SUMMARY ] ···························································
  30. ───────────────────────────────────────────────────────────────────────────────
  31.        This PPE  (*PCBoard Programming Language Executable*)  installs  as  a
  32.   replacement or addition to your CMD.LST file.  PCBoard v15.2+  is  required
  33.   to run this program.  Its purpose is to  replace the stock WHO command with
  34.   a program  that can display such information as: node number, who is online
  35.   their city/state or affiliations, their current  board usage function  (via
  36.   the USERNET file), connect speed and time, security level,  transferred and
  37.   transferring files and more!   It also supports a  'Fully Active'  mode for
  38.   BBSs with 18 nodes or less (explained later in this file).  The best way to
  39.   see if this program is for you is to test it out.   Follow the installation
  40.   instructions and try it out ...
  41. ───────────────────────────────────────────────────────────────────────────────
  42.  
  43.  
  44. ───────────────────────────────────────────────────────────────────────────────
  45. [ INSTALLATION ] ······························································
  46. ───────────────────────────────────────────────────────────────────────────────
  47.   1. Load PCBSETUP
  48.   2. Press B        ( File Locations )
  49.   3. Press B        ( Configuration Files )
  50.   4. Edit CMD.LST   ( Press F2 at the CMD.LST File )
  51.  
  52.            Command      Security       PPE
  53.            -------      --------       ------------------
  54.         ┌- WHO          ##             DRIVE:\PATH\CNAV.PPE
  55.       ┌─┼- SPY          ##             C:\PCB\PPE\CNAV.PPE /DEF=B
  56.       │ └- CNAV         ##             C:\PCB\PPE\CNAV.PPE /VERBOSE
  57.       │
  58.       └ Use whatever command you like ..
  59.  
  60.      Possible Command Line Parameters:
  61.  
  62.      /VERBOSE   - Force Verbose Mode  ( Include File Transfer Information )
  63.      /BRIEF     - Force Brief   Mode  ( Do not include File Transfer Info )
  64.      /TINY      - Force Tiny    Mode  ( Show minimal node information ... )
  65.      /ACTIVE    - Force Active  Mode  ( interACTIVE Auto-Updating Mode .. )
  66.  
  67.      /DEF=A     - Allow user to choose display mode by asking them when they
  68.                   run the program.  Default answer will be Active Mode.
  69.      /DEF=T     - Allow user to choose display mode by asking them when they
  70.                   run the program.  Default answer will be a Tiny Display.
  71.      /DEF=B     - Allow user to choose display mode by asking them when they
  72.                   run the program.  Default answer will be Brief Display.
  73.      /DEF=V     - Allow user to choose display mode by asking them when they
  74.                   run the program.  Default answer will be Verbose Display.
  75.  
  76.      If no command line parameters are used, a /DEF=V is assumed.
  77.  
  78.   5. Copy the CNAV.* file(s) to the SAME directory as CNAV.PPE
  79.  
  80.   6. Edit the CNAV.* file(s) in a text editor for your board
  81.      configuration and color preferences.  (Instructions are contained in
  82.      CNAV.* file(s))
  83.  
  84. NOTE: From my initial tests, this PPE requires about 60k free memory.  If you
  85.       look at your status line when you have logged onto PCBoard, you must
  86.       have 63k available in the 'memory left' indicator on your status line
  87.       (the red box).  If you do not have the memory, try increasing the window
  88.       size of your multi-tasker (assuming you are running one) or reduce
  89.       the overlay size of your PCBoard executable (.EXE) with the OVLSIZE
  90.       program that comes with PCBoard.
  91. ───────────────────────────────────────────────────────────────────────────────
  92.  
  93.  
  94. ───────────────────────────────────────────────────────────────────────────────
  95. [ EXTERNAL FILES ] ····························································
  96. ───────────────────────────────────────────────────────────────────────────────
  97.   NOTE: You can delete all the files EXCEPT CNAV.PPE and CNAV.DAT.  These are
  98.         the only necessary files.  Everything has a default built into the
  99.         program (thats why its so damn big :) )  CNAV.HLP should also exist,
  100.         but it isn't crutial.
  101.  
  102.   CNAV.DAT = Allows you to setup the number of nodes to monitor, the path and
  103.              filename(s) to your DSZ.LOG files, and you can optionally setup
  104.              Telephone Numbers/Modem Types to be displayed in the activity
  105.              line of <Open Nodes>.  A Default CNAV.DAT file has been included
  106.              for you to follow.
  107.  
  108.   CNAV.HLP = The online help file to explain to the user what each mode means,
  109.              providing you allow the user to choose the mode (ie: do not
  110.              force a certain mode with a command line parameter).
  111.  
  112.   CNAV.ACT = The Activity Configuration File.  If this file exits, CNAV will
  113.              use it for configuration information for the Activity lines.
  114.              Color codes are supported, and each line must be 38 uncolorized
  115.              characters or less.  Refer to the contained default CNAV.ACT file
  116.              to see what each line should refer to.  Delete this file if you
  117.              want to use the defaults (when deleted, CNAV will load faster).
  118.  
  119.   CNAV.COL = The Color Configuration File.  This file allows you to change any
  120.              or all of the colors used in the program.  If you wish to use
  121.              the default colors, delete this file.  It is theoretically faster
  122.              to load the program if no CNAV.COL file is found and defaults
  123.              are automatically used.  Instructions are contained within this
  124.              file.
  125.  
  126.   CNAV.OPT = The Options Configuration File.  This file allows you to toggle
  127.              the display of <Closed> and <Open> nodes with a Y/N toggle. A
  128.              Default CNAV.OPT file has been included.  If you wish to use the
  129.              defaults of "Y" for both options, you can delete this file.
  130.  
  131.   CNAV.EXC = The Optional Exclusion List.  This file allows you to list user
  132.              names (one to a line) that you DO NOT want to be displayed in
  133.              a node view if those users happen to be online.  IE:
  134.  
  135.              CNAV.EXC
  136.              ------------------
  137.              JOHN DOE
  138.              JANE DOE
  139.              ------------------
  140.  
  141.              If John Doe is online and is on Node 3, Node 3 will NOT be
  142.              displayed in a node view (in any mode).  Etc.
  143.  
  144.              Delete this file if you don't want to exclude any user names.
  145.  
  146.   CNAV.STA = The active mode Statistics File.  When a user runs CNAV in
  147.              active mode and then chooses to display the extended information
  148.              of another online user, this file will be displayed.  Since many
  149.              sysops don't want other users to view the statistics of other
  150.              members of the BBS, you can edit this file and configure exactly
  151.              what statistics you want included when a user displays the
  152.              extended information of another user.
  153.  
  154.              This is accomplished by replacement codes.  Think of replacement
  155.              codes as PCBoard Macros (@???@).  The following replacement codes
  156.              are supported.  They are the same length as the output fields
  157.              will be once they are filled in.  For example, %CONNECT_STRING
  158.              will be replaced with the Connection Speed and Port Speed and
  159.              automatically Left Justified and filled to the full 15 characters.
  160.  
  161.              %MIX_USER_FULL_NAME_FIELD = The User Name in Mixed Characters
  162.              %CAP_USER_FULL_NAME_FIELD = The User Name in Capital Letters
  163.  
  164.              %MIX_USERCITYSTATE_FIELD  = The User's City/State in Mixed Chrs
  165.              %CAP_USERCITYSTATE_FIELD  = The User's City/State in Capital Letrs
  166.  
  167.              %CONNECT_STRING           = The Connect Speed & Port Speed
  168.  
  169.              %UPT_BYTES                = Total Upload Bytes
  170.              %DNT_BYTES                = Total Download Bytes
  171.  
  172.              %LAST_SC                  = Last Directory Scan
  173.              %LAST_DT                  = Date of Last Call
  174.              %LTIM                     = Time of Last Call
  175.              %TCAL                     = Total Number of Calls
  176.  
  177.              %UPTF                     = Total Upload Files
  178.              %DNTF                     = Total Download Files
  179.  
  180.              %SL                       = Security Level
  181.  
  182.  
  183.              The actual PCBoard @ codes only work for the current user online,
  184.              (not for users on other nodes) so don't use those in this file.
  185.  
  186.              A sample CNAV.STA file has been included.  If you wish to use
  187.              the default status screen, DELETE the CNAV.STA file.  It will
  188.              be *MUCH* faster to display if it doesn't have to read in the
  189.              CNAV.STA file.
  190.  
  191.              CNAV.STA can not contain any lines that exceed 36 uncolorized
  192.              characters.  This means, if you remove all the @X color codes
  193.              from the file, it should not exceed 36 characters, starting
  194.              from column one.  This requirement is necessary since the
  195.              file transfer information (if available) is displayed on
  196.              the remaining characters on the right side of the screen.
  197.  
  198.              This file can not exceed 22 lines/rows.  If you wish to
  199.              display a blank line, include a color code on that line
  200.              with no other information.  The program sees a blank line
  201.              as the end of the file.
  202.  
  203. ───────────────────────────────────────────────────────────────────────────────
  204. [ ACTIVE MODE ] ·······························································
  205. ───────────────────────────────────────────────────────────────────────────────
  206.   I thought I'd take a moment to explain Active Mode.  The other 3 modes
  207.   are completely straight forward and do not require any user input.
  208.  
  209.        Basically: Tiny Mode - Displays Node # / User Name / User Activity
  210.  
  211.                  Brief Mode - Displays Node # / User Name / User Activity
  212.                               Security Level / User City / Login Time & Speed
  213.  
  214.                Verbose Mode - Same as Brief Mode, but if the user is
  215.                               transferring files it will display the files
  216.                               being transferred/in the users' queue.
  217.  
  218.   Active mode is a self-updating node view.  You MUST have 18 nodes or less.
  219.   (If you have 19+ nodes and attempt to run active mode, it will default
  220.   to Tiny Mode.)
  221.  
  222.   When run in this mode, CNAV displays all available nodes to the user.  It
  223.   then will wait for input: either a node number to view extended information
  224.   on, or the ENTER key or ESC key to exit the program.  The input is hotkey
  225.   activated (does not require the 'ENTER' key, unless you have more than
  226.   10 nodes and the user wishes to view node 1).
  227.  
  228.       NOTE: If you have 9 nodes or less, the display contains seperation
  229.             lines.  If you have 10-18 nodes, there are no seperation lines.
  230.             (It was written this way so all nodes can fit on one screen.)
  231.  
  232.   During this time, CNAV is checking on the other nodes.  If the activity of
  233.   another node changes, CNAV will update the screen for that node only. For
  234.   example, if Node 3 was Transferring Files and now is available for Chat,
  235.   CNAV will only update Node 3 with the proper 'Available for Chat' activity.
  236.  
  237.      NOTE: If you have toggled the display of 'OPEN NODES', 'CLOSED NODES'
  238.            or have 'EXCLUDED' any user names from the node display, CNAV will
  239.            honor these options (ofcoarse), however, if one of these excluded
  240.            nodes changes to a node that should be displayed, CNAV will rewrite
  241.            the entire node display to include the node. (since there was
  242.            previously no room for it on the display).
  243.  
  244.            For example.  If you have toggled CNAV to NOT display 'CLOSED NODES'
  245.            and Node 5 is closed, CNAV will not display node 5.  However, if
  246.            Node 5 is suddenly opened while someone is inside CNAV-Active Mode,
  247.            the display will be completely updated to include Node 5.
  248.  
  249.            If you do allow Active Mode (ie: have 18 nodes or less, or do not
  250.            force another mode with the /??? parameter), I suggest you delete
  251.            the .OPT file and display both OPEN and CLOSED nodes (the default).
  252.  
  253.                Why?  In PCBoard, when a user logs off the system, the
  254.                      node activity line for that node will first be
  255.                      'CLOSED' while it recycles, and then 'OPENED' once
  256.                      it has recycled and waits for the next caller. Because
  257.                      of this, CNAV-Active Mode would be redrawing the entire
  258.                      screen each time a node recyles (if you toggle one of
  259.                      the options and not the other).  Although this still
  260.                      would _not be_ that often, I thought I'd mention it
  261.                      anyway. (if you wondered why CNAV would sometimes
  262.                      redraw the entire active mode screen) :-)
  263.  
  264.   Once the user is in CNAV-Active mode, s/he can choose to view the stats
  265.   or file transfer information of other online members.  Open and Closed
  266.   nodes can not be viewed (they have no stats!) so input will NOT be
  267.   taken for these nodes (ie: If Node 4 is closed, and the user tries to
  268.   press "4", nothing will happen).
  269.  
  270.   When the user selects to view another online user, the statistics of that
  271.   user will be displayed.  A default screen is included within CNAV, but if you
  272.   wish to configure this screen, edit the CNAV.STA file.  Instructions and
  273.   further information are discussed above (EXTERNAL FILES - CNAV.STA). Delete
  274.   the CNAV.STA file if you wish to use the default screen, it is MUCH faster
  275.   this way.
  276.  
  277.   If the user selected is transferring files, their file transfer information
  278.   will be displayed on the same screen.  This is the same information that
  279.   would be displayed in a VERBOSE node display.
  280.  
  281.   If the user aborts the display of the stats/file transfer information, s/he
  282.   will return to the main Active Mode screen.
  283.  
  284.   The user can press ENTER or ESC to exit Active Mode and return to the BBSs
  285.   main menu.
  286.  
  287.                          o More to come ...
  288.  
  289. ───────────────────────────────────────────────────────────────────────────────
  290.       How to contact the author:  Yell real loud, perhaps I'll hear you.
  291.                              or:  mslasher@io.org
  292. ───────────────────────────────────────────────────────────────────────────────
  293. [EOF] ················································· [MS] / Midnight Slasher
  294. ───────────────────────────────────────────────────────────────────────────────
  295.