home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / PCBOARD / ZLIST_12.ZIP / ZLIST.DOC < prev    next >
Text File  |  1994-03-03  |  17KB  |  328 lines
  1.  
  2.  
  3.  
  4.  
  5.   ╔════════════════════════════════════╗
  6.   ║      ▄      ▄         ▄█▄ ▄███▄    ║
  7.   ║    ▄▀██▄▄  ▀██▄▄      ██▌▐██▀▐█▌   ║░░
  8.   ║   ██▌▐█████▄▐█████▄  ▐██ ██   ▀    ║░░
  9.   ║  ▐██ ███▀▀██▌▐█▀▀██▌ ██▌▐█▌        ║──────────────────────────────────────
  10.   ║   ▀ ▐██    ██▐    ██▐██ ██         ║   ZippyList - (C) Copyright 1994
  11.   ║─────███▌──▐██▐▌──▐██▐█▌▐█▌─────────║    Whitewater Technologies, Inc.
  12.   ║    ▐████▄▄██▌██▄▄██▌██ ▐██         ║       Author: Gregg Graubins
  13.   ║    ██▌▀████▀ ▀████▀▐█▌  ██▌    █▌  ║──────────────────────────────────────
  14.   ║   ▐██▌   ▄▄█      ▐██    ██▄  ▐█▌  ║░░
  15.   ║   ▐██   ▐██▌      ██  ▄▄█▀▀██▄█▀   ║░░
  16.   ║    ██▌   ██▌     ▐█████▀    ▀▀     ║░░  *ALL* Source Code has been done
  17.   ║     ██    ██      ▀▀▀              ║░░  by Whitewater Technologies, Inc.
  18.   ║      ▀▌    ▀▌                      ║░░
  19.   ╚════════════════════════════════════╝░░
  20.     ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
  21.  
  22.  
  23.  
  24.  
  25. ╒═════════════════════════════════════════════════════════════════════════════╕
  26. │                                                                             │
  27. │ ZippyList, along with all of our other utilities, is made for TOTAL Sysop   │
  28. │ flexibility - As well as ease of use! To become familiar with ZippyList,    │
  29. │ please continue to read with the documentation.                             │
  30. │                                                                             │
  31. │ ZippyList is has FULL multi-language support. The display files will be     │
  32. │ checked for any language extensions and/or security specific display files  │
  33. │ and be displayed accordingly.                                               │
  34. │                                                                             │
  35. │ The ZTEXT file will also allow you to add your own extension! If an         │
  36. │ extension is accompanied by the ZTEXT file, ZippyList will check to see if  │
  37. │ an extension exists with the current language. If not, the default ZTEXT    │
  38. │ file will be loaded.                                                        │
  39. │                                                                             │
  40. │─────────────────────────────────────────────────────────────────────────────│
  41. │                                                                             │
  42. │ NOTE: Some features are *not* documented. Please execute ZippyList for your-│
  43. │       self and see it in action! :)                                         │
  44. │                                                                             │
  45. ╘═════════════════════════════════════════════════════════════════════════════╛
  46.  
  47.   License
  48.   ────────────────────────────────────────────────────────────────────────
  49.   You are granted a personal non-exclusive, non-transferable license to
  50.   use the enclosed program and documentation solely for your own internal
  51.   needs on one central processing unit or network of physically connected
  52.   computers. You assume the entire responsibility for the selection of
  53.   the program to achieve your intended results, and for the installation,
  54.   use and results obtained from the program.
  55.  
  56.  
  57.   Disclaimer
  58.   ────────────────────────────────────────────────────────────────────────
  59.   ZIPPYLIST AND ANY ACCOMPANYING SOFTWARE ARE PROVIDED "AS IS" WITHOUT
  60.   WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
  61.   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR  A
  62.   PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE
  63.   IS WITH YOU. SHOULD THIS SOFTWARE AFFECT YOUR SYSTEM(S), YOU ASSUME THE
  64.   ENTIRE COST OF SERVICING, OR CORRECTION. IN NO EVENT WILL THE AUTHOR BE
  65.   LIABLE TO YOU FOR ANY DAMAGES ARISING OUT OF THE USE, OR INABILITY TO
  66.   USE, OF ZIPPYLIST'S PACKAGE.
  67.  
  68.   Installing ZippyList into your PCBoard system
  69.   ────────────────────────────────────────────────────────────────────────
  70.   ZippyList is a very easy program to install. After reading and following
  71.   the steps to installing ZippyList, please read the section labeled
  72.   "Configuring Display & Menu files" (If you would like to alter the
  73.   display files, menu files, etc.)
  74.  
  75.   Although ZippyList may be executed from anywhere inside PCBoard's
  76.   environment, whether it be display files (Using the "!" command) or any
  77.   other way, the most common (And recommended) installation is through the
  78.   .CMD files. During this section, the examples relate to installing
  79.   ZippyList through your .CMD files.
  80.  
  81.   Installation precedures:
  82.   ========================
  83.  
  84.    1) Before configuring *any* files, you should have already extracted the
  85.       contents of the zipfile into a directory.
  86.  
  87.       (We use and recommend C:\PCB\PPE\ZLIST)
  88.  
  89.    2) Enter PCBSETUP | File Locations | Configuration Files and edit
  90.       your default .CMD file. Add the following command:
  91.  
  92.           Command     Security  PPE/MNU File -or- Keystroke Replacement
  93.       ══════════════  ════════  ═══════════════════════════════════════
  94.       LIST                 25   C:\PCB\PPE\ZLIST\ZLIST.PPE
  95.  
  96.       Once you've added the above into your .CMD file, exit & save your
  97.       configuration.
  98.  
  99.       Note: You may have ZippyList installed into a *different* .CMD file,
  100.       in which case just add the command wherever you wish. You may also
  101.       have a different command/security/path than what is shown above.
  102.  
  103.    3) Edit your $$LOGOFF.BAT and add the following command:
  104.  
  105.       $$LOGOFF.BAT
  106.       ============
  107.       IF EXIST C:\PCB\NODE%PCBNODE%\WORK\WHITE.ZIP DEL C:\PCB\NODE%PCBNODE%\WHITE.ZIP
  108.  
  109.       Note: You may have a different Temporary path configured - In which
  110.             case, just change the above line to correspond to your
  111.             configuration. :)
  112.  
  113.    4) The last configuration step is to edit your ZLIST.CFG file. Use a
  114.       standard text editor (i.e. Qedit, TSE, etc.) to edit this file and
  115.       alter it. The format of the ZLIST.CFG is as follows:
  116.  
  117.     ────────────────────────[ ZLIST.CFG Format ]────────────────────────
  118.     Line  1: Sysop Name
  119.     Line  2: BBS Name
  120.     Line  3: Registration Number
  121.     Line  4: Toggle to whether or not to always display welcome file.
  122.  
  123.                 YES = Always display - Regardless of exper mode.
  124.                 NO  = If user has expert mode ON, ignore the display of
  125.                       the welcome file. Vise-Versa if they have expert
  126.                       mode toggled OFF.
  127.  
  128.  ┌─ Line  5: Name of WELCOME File ─ Must be in curr. dir!
  129.  ├─ Line  6: Name of Main Menu file
  130.  ├─ Line  7: Name of Search Menu file
  131.  ├─ Line  8: Name of Search Text Menu file
  132.  ├─ Line  9: Name of Search by Filename Menu file
  133.  ├─ Line 10: Name of Search by Date Menu file
  134.  ├─ Line 11:■<This is Reserved for future use>
  135.  ├─ Line 12: Name of Execution Command display file
  136.  ├─ Line 13: Name of Clear Workspace display file
  137.  ├─ Line 14: Name of (Main Menu) HELP file
  138.  ├─ Line 15: Name of (Search Menu) HELP file
  139.  ├─ Line 16: Name of (Text Search Operation Menu) HELP file
  140.  ├─ Line 17: Name of (File Search Operation Menu) HELP file
  141.  ├─ Line 18: Name of (Date Search Operation Menu) HELP file
  142.  ├─ Line 19: Name of ZTEXT file
  143.  ├─ Line 20: File to display BEFORE scanning
  144.  ├─ Line 21: File to display WHILE scanning
  145.  ├─ Line 22: File to display AFTER scanning is completed
  146.  ├─ Line 23: Name of File to insert in the beginning of capture file;
  147.  │           Useful if you would like to explain a little about the
  148.  │           contents of the file the user downloaded.
  149.  ├─ Line 24:■<This is Reserved for future use>
  150.  ├─ Line 25: Name of Capture file to include inside Compressed file.
  151.  ├─ Line 26: Name of Compressed file to create
  152.  │
  153.  └────────┬─ Lines 5-23 must pertain in the ZippyList directory.
  154.           └─ Lines 5-26 should not include any path information.
  155.  
  156.  ┌─ Line 27: Temporary Work Directory
  157.  ├─ Line 28: Compression program filename (Path is optional, but recommended)
  158.  ├─ Line 29: Additional Parameters to pass to compression program.
  159.  ├─ Line 30: Directory to place Compressed Zipfile in.
  160.  │           Note: BE SURE TO INCLUDE THIS IN THE DLPATH.LST
  161.  │
  162.  └─────────  For lines 23-26, the following environment variables will
  163.              be converted (if used):
  164.  
  165.                   %PCBNODE%   - PCBoard Node Number
  166.                   %PCBDRIVE%  - Drive letter of PCBoard (i.e. C:)
  167.                   %PCBDIR%    - PCBoard's Home Directory
  168.  
  169.              For line 25, the following additional variables will be
  170.              converted if they exist:
  171.  
  172.                   @COMPFILE@  - Full path/filename of Compressed file
  173.                                 to be created.
  174.                   @ZCAPFILE@  - Full path/filename of Capture file to
  175.                                 be compressed.
  176.  
  177.              ZippyList is made for configurability! You may include
  178.              a file (or files) inside the compressed file by adding
  179.              your own commands to line 25.
  180.     ──────────────────────────────────────────────────────────────────
  181.  
  182.  
  183.   Configuring Display & Menu files
  184.   ────────────────────────────────────────────────────────────────────────
  185.   The most important feature of ZippyList is the configurability it has.
  186.   It will allow you to alter the way *ANY* of the Menu files, Display
  187.   files, or even prompts! If you would like to alter any of the prompts,
  188.   just edit the ZTEXT.<ext> prompt file and change it accordingly. If you
  189.   would like to change the display and/or menu files, below is a list of
  190.   the available variables that may be used in each:
  191.  
  192.  
  193.     Filename(s)  Variable(s) converted / Description (Returns)
  194.     ──────────────────────────────────────────────────────────────────────
  195.     ZMAIN ────┬─ @OPTEXT@ = Latest command ready for execution
  196.     ZSEARCH ──┤             ZippyList will automatically remember the
  197.     ZEXECMD ──┤             last search operation function the user
  198.     ZCLEAR ───┘             entered and store it into this variable.
  199.  
  200.  
  201.     ZSRCHTXT ─── @MATCHING@    = (M)atching Text (Blank if none)
  202.                  @EXCLUDING@   = (E)xcluding Text (Blank if none)
  203.                  @FILEDATE@    = (N)ew Date (000000 if none)
  204.                  @DIRECTORIES@ = (D)irectories to search
  205.                                  ZippyList will automatically 'shorten'
  206.                                  this length and parse out multiple
  207.                                  occurences of commas (,), P's (Private
  208.                                  Directory search), and will detect if an
  209.                                  "A" is found anywhere inside this field
  210.                                  and take action.
  211.                  @FLAGDL@      = A "Yes" or "No" text telling whether or
  212.                                  not the user is (F)lagging the file(s)
  213.                                  found for later download.
  214.                                           (Defaults to "No")
  215.                  @CAPTURE@     = A "Yes" or "No" text telling whether or
  216.                                  not the user if (C)apturing the search
  217.                                  into a file for flagging/download.
  218.                                           (Defaults to "Yes")
  219.                  @SRCHCMD@     = String containing the execution command.
  220.                                  This is useful to help the user become
  221.                                  more familiar with PCBoard's commands.
  222.                                            ("(N/A)" if none)
  223.  
  224.  
  225.   (Continued) Configuring Display & Menu files
  226.   ────────────────────────────────────────────────────────────────────────
  227.  
  228.     ZSRCHFLE ─── @FILENAME@    = (M)atching filename (Blank if none)
  229.                  @DIRECTORIES@ = (D)irectories to search (Defaults to "A")
  230.                                  ZippyList will automatically 'shorten'
  231.                                  this length and parse out multiple
  232.                                  occurences of commas (,), P's (Private
  233.                                  Directory search), and will detect if an
  234.                                  "A" is found anywhere inside this field
  235.                                  and take action.
  236.                  @FILEDATE@    = (N)ew Date (000000 if none)
  237.                  @FLAGDL@      = A "Yes" or "No" text telling whether or
  238.                                  not the user is (F)lagging the file(s)
  239.                                  found for later download.
  240.                                           (Defaults to "No")
  241.                  @CAPTURE@     = A "Yes" or "No" text telling whether or
  242.                                  not the user if (C)apturing the search
  243.                                  into a file for flagging/download.
  244.                                           (Defaults to "Yes")
  245.                  @SRCHCMD@     = String containing the execution command.
  246.                                  This is useful to help the user become
  247.                                  more familiar with PCBoard's commands.
  248.                                            ("(N/A)" if none)
  249.  
  250.  
  251.     ZSRCHDTE ─── @FILEDATE@    = (N)ew Date (Last Date of Search if none)
  252.                  @DIRECTORIES@ = (D)irectories to search (Defaults to "A")
  253.                                  ZippyList will automatically 'shorten'
  254.                                  this length and parse out multiple
  255.                                  occurences of commas (,), P's (Private
  256.                                  Directory search), and will detect if an
  257.                                  "A" is found anywhere inside this field
  258.                                  and take action.
  259.                  @FLAGDL@      = A "Yes" or "No" text telling whether or
  260.                                  not the user is (F)lagging the file(s)
  261.                                  found for later download.
  262.                                           (Defaults to "No")
  263.                  @CAPTURE@     = A "Yes" or "No" text telling whether or
  264.                                  not the user if (C)apturing the search
  265.                                  into a file for flagging/download.
  266.                                           (Defaults to "Yes")
  267.                  @SRCHCMD@     = String containing the execution command.
  268.                                  This is useful to help the user become
  269.                                  more familiar with PCBoard's commands.
  270.                                            ("(N/A)" if none)
  271.  
  272.  
  273.  
  274.  
  275.   Extensive Logging of ALL functions
  276.   ────────────────────────────────────────────────────────────────────────
  277.   ZippyList will automatically log *every* function that is executed while
  278.   the user is inside. When a Sysop is viewing the caller's log, you will
  279.   notice that all Errors are displayed in red - These are most likely
  280.   errors that were found because of either (a) Your compression program
  281.   was not found or (b) a display/menu file was not found.
  282.  
  283.  
  284.  
  285.   Support and Registration
  286.   ────────────────────────────────────────────────────────────────────────
  287.   There are various methods of Customer Support we will provide:
  288.  
  289.     1) Call our Support BBS (Shown Below) and enter the WWT Support
  290.        Conference. This option is preferred.
  291.  
  292.     2) Send direct Internet email to one of the following:
  293.  
  294.                   gregg.graubins@whitewater.com (*Soon*)
  295.                   gregg.graubins@aquila.com
  296.  
  297.     3) Send a RoseNet message to gregg graubins@whitewater
  298.        (You must be using the RoseReader software in conjunction to a
  299.         valid RoseMail BBS)
  300.  
  301.     4) Send a private message on AccessNet to myself.
  302.  
  303.     5) *Soon* Send a private message through Fidonet.
  304.  
  305.   A lot of work has gone into this program to make it what it is. If you
  306.   find ZippyList useful, please consider the time and work we put in to
  307.   make it possible. :) Our software will always be low in price for what it
  308.   does. There are some out there that are charging outrageous amounts of
  309.   money for such a simple program, and we are making software as an
  310.   alternative (And even better <g>) to those programs.
  311.  
  312.   You may register ZippyList (Or any of our other products) online via our
  313.   Support BBS below. (WE ACCEPT CREDIT CARD PURCHASES ALSO) The
  314.   registration is only $15 US. Once registered, the minor delay in
  315.   the beginning will be removed, all features will be enabled for your
  316.   use, and will enable you to obtain future minor versions free of charge.
  317.  
  318.  
  319.             All new versions of ZippyList may be obtained on Salt Air
  320.                            or our Support BBS:
  321.  
  322.                        Whitewater Systems - 24 Hrs
  323.                           Phone:  312-743-4912
  324.                    16.8k USRobotics HST Dual Standard
  325.  
  326.  
  327.   ────────────────────────────────────────────────────────────────────────
  328.