home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / mailers / nlu_111.zip / NLU.DOC < prev    next >
Text File  |  1993-06-15  |  35KB  |  792 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                           Node List Update Utility 1.05b
  13.  
  14.                                  Copyright 1993
  15.  
  16.                               All Rights Reserved
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.                                 By Les Fenison
  31.  
  32.                              Fido Net  1:105/751
  33.  
  34.                               Family Net 8:77/7
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.                       Advanced Computer Design & Consulting
  50.                              24008 Butteville Rd NE
  51.                                Aurora, OR 970022
  52.                                  (503) 678-3050
  53.  
  54.  
  55. ═════════════════════════════════════════════════════════════════════════════
  56.                       Node List Update Utility (NLU)                Page 1
  57. ═════════════════════════════════════════════════════════════════════════════
  58.  
  59.  
  60.  
  61.                                     CONTENTS
  62.  
  63.          1  Disclamer....................................Page 2
  64.          2  What is Node List Update Utility?............Page 2
  65.          3  Programs Needed to Operate NLU...............Page 3
  66.          4  About Shareware..............................Page 3
  67.          5  How To Register..............................Page 4
  68.          6  The ACDC BBS.................................Page 4
  69.          7  System Requirements..........................Page 5
  70.          8  Distribution Files...........................Page 5
  71.            8.1  Version History..........................Page 5
  72.          9  Running NLU..................................Page 5
  73.         10  Configuring NLU..............................Page 6-11
  74.               Regkey.....................................Page 6
  75.               MaxDiffs...................................Page 6
  76.               MaxLists...................................Page 6
  77.               InboundDir.................................Page 6
  78.               DownloadDir................................Page 7
  79.               NodeListDir................................Page 7
  80.               ListName(s)................................Page 7
  81.               DiffName(s)................................Page 7
  82.               ListDesc(s)................................Page 8
  83.               DiffDesc(s)................................Page 8
  84.               LogFile....................................Page 8
  85.               LogMode....................................Page 8
  86.               LogStyle...................................Page 8
  87.               TossFiles..................................Page 9
  88.               Update_FileList............................Page 9
  89.               FileList_Order.............................Page 9
  90.               Zip, Zip2..................................Page 9
  91.               Unzip, Unzip2..............................Page 9
  92.               Zipview, Zipview2..........................Page 9
  93.               Arc, Arc2..................................Page 9
  94.               UnArc, UnArc2..............................Page 9
  95.               ArcView, ArcView2..........................Page 9
  96.               Lzh, Lzh2..................................Page 10
  97.               UnLzh, UnLzh2..............................Page 10
  98.               LzhView, LzhView2..........................Page 10
  99.               ArcPref....................................Page 10
  100.               ApplyDiff..................................Page 10
  101.               Cleanup....................................Page 10
  102.               Convert....................................Page 11
  103.               SkipTest...................................Page 11
  104.               MagicDir...................................Page 11
  105.               MagicList..................................Page 11
  106.         11  Program Flow Description.....................Page 12-14
  107.  
  108.  
  109. ═════════════════════════════════════════════════════════════════════════════
  110.                       Node List Update Utility (NLU)                Page 2
  111. ═════════════════════════════════════════════════════════════════════════════
  112.  
  113.   1  Disclaimer
  114.  
  115.  
  116.        ACDC hereby disclaims all warranties relating to this product,
  117.   whether express or implied, including without limitation any implied
  118.   warranties of merchant ability or fitness for a particular purpose. ACDC
  119.   cannot and will not be liable for any special, incidental, consequential,
  120.   indirect or similar damages due to loss of data or any other reason, even if
  121.   ACDC or an authorized ACDC agent has been advised of the possibility
  122.   of such damages.  In no event shall the liability for any damages ever
  123.   exceed the price paid for the license to use software, regardless of the
  124.   form and/or extent of the claim.  The user of this program bears all risk as
  125.   to the quality and performance of the software.
  126.  
  127.  
  128.   2  What is Node List Update Utility?
  129.  
  130.        It is a utility that will process your incoming nodelists.  (If
  131.   enabled) it will toss the incoming nodelists from your inbound directory
  132.   to the directory where you store your nodelists available for download
  133.   from hereon refereed to as the download directory. It can optionally
  134.   update your FILES.BBS with a description that you provide which can
  135.   include a day number.
  136.         Next NLU will check to see if their is a LIST or DIFF in your
  137.   download directory that is newer than the one in your active directory.
  138.   The active directory is the directory where your mailer, BBS, and or
  139.   nodelist compiler looks for lists and diffs.  If a newer list or diff
  140.   does exist in the download directory it will be unachieved into the
  141.   active directory.
  142.         Next (if enabled) it will apply the DIFFS to the LISTS and
  143.   optionally cleanup the old diffs and lists.
  144.         Next it will check to see if there is a list or diff in the
  145.   active directory that is not yet in the download directory.  If it
  146.   finds a newer list or diff it will archive it and place it in your
  147.   download directory and optionally update FILES.BBS.
  148.         Next it will check to see if there are more of a DIFF or LIST
  149.   in the download directory than you specified as a maximum.  If so it
  150.   will purge old diffs or lists.
  151.  
  152.         The program comes with three different versions.  There is a
  153.   OS/2 version called NLU2.EXE, a DOS version called NLU_DOS.EXE, and
  154.   a family mode version which will run in either OS/2 or DOS called
  155.   NLU.EXE.
  156.  
  157.  
  158.  
  159. ═════════════════════════════════════════════════════════════════════════════
  160.                       Node List Update Utility (NLU)                Page 3
  161. ═════════════════════════════════════════════════════════════════════════════
  162.  
  163.  
  164.   3  Programs Needed to Operate NLU
  165.  
  166.   There are three methods of compression supported.  They are ZIP, ARC,
  167.   and LZH.  You will need utilities for the methods that you use on your
  168.   system.  It is recommended that you have all three just in case someone
  169.   sends you a different version of a list or diff.  Utilities to apply
  170.   the DIFF files such as XLAXDIFF or other such utilities may also be
  171.   used.
  172.  
  173.   IMPORTANT NOTE ABOUT UNARCHIVERS!!!!
  174.   Not all archivers will support wild cards.  It is your responsibility
  175.   to make sure that your unarchivers will support wild cards and a
  176.   view option.   The syntax used to archive, unarchive, and view contents
  177.   must be supplied in NLU.CTL.
  178.  
  179.   4  About Shareware
  180.  
  181.  
  182.   NLU is Shareware.  PKZIP, LHA, and ARC are also shareware. Shareware is NOT
  183.   free.  It is computer software offered for sale at a set price and the only
  184.   real difference between Shareware and other commercial software products is
  185.   the method of distribution and the important "try before you buy" feature.
  186.   With Shareware you are normally licensed by the owner/author of the program
  187.   to operate the Shareware distribution copy on a trial basis.  Then if you
  188.   like it and make regular use of it, you are bound to pay for it.
  189.  
  190.        Registered users are those users that elect to pay for NLU ($5) and
  191.   register that payment with ACDC.  By virtue of registration and payment
  192.   for the program, registered users are granted a license to continue to
  193.   utilize the program on their personal computer for as long as they choose.
  194.   This license authorizes the user to use the program on any personal computer
  195.   system he or she may own so long as the program is operated on only one
  196.   computer system at a time.
  197.  
  198.        Site licenses for use of NLU on multiple computers are available upon
  199.   request at a reduced fee that is based on the number of single machines
  200.   licensed for use.
  201.  
  202.  
  203.  
  204. ═════════════════════════════════════════════════════════════════════════════
  205.                       Node List Update Utility (NLU)                Page 4
  206. ═════════════════════════════════════════════════════════════════════════════
  207.  
  208.   5  How To Register
  209.  
  210.  
  211.        There is no functional difference between the Shareware distribution
  212.   version of NLU and the registered version except for the annoying beeps
  213.   and delays and user intervention at the end of the program.  Registering
  214.   your copy will remove the little annoyances.
  215.  
  216.        The price of NLU is $5.00. you may register NLU by sending a check
  217.   or money order to us.  See the included file NLU_REG.DOC for the
  218.   order form.
  219.  
  220.        Special site license rates for licensing multiple copies are available.
  221.   Please call for rate schedule information.
  222.  
  223.        Foreign (non-US/Canada) orders must include a $2.00 special handling
  224.   fee in addition to the $5.00 registration fee.  Also, no checks on banks
  225.   located outside the United States will be accepted.
  226.  
  227.        This Shareware version of NLU may be freely copied and passed on to
  228.   other individual users for their evaluation.
  229.  
  230.        Upgrades to later versions are available to all users on the
  231.   ACDC BBS at no cost.  Access to the BBS is a privilege granted by ACDC
  232.   that may be revoked at any time for any reason.  Those who request
  233.   upgrades via telephone or mail must remit a $5.00 charge for an upgrade.
  234.   upgrades from the BBS are free.
  235.  
  236.  
  237.   6  The ACDC BBS
  238.  
  239.         The ACDC BBS is up from 12am midnight to 7am Pacific time.  The
  240.   BBS phone line is a voice line during daytime hours.
  241.           (503) 678-3050 - 1200/2400/9600//14400/16800 (USR DUAL STD)
  242.  
  243.        The ACDC Shareware Products BBS operates 6 hours per day, 7 days
  244.   per week excluding mail hour from 2am to 3am and is open to all callers.
  245.  
  246.   The latest version of NLU and all programs that are supported or used by
  247.   NLU may be obtained via the BBS or file request.  To file request the
  248.   latest version of NLU use the magic filename of NLU.  To request the
  249.   full package of archive utilities used by NLU use the magic filename
  250.   of NLU_UTIL.  You may also file request our files list with the magic
  251.   filename of FILES.  The BBS also serves as an avenue for product
  252.   support.  You may report problems or ask questions about the operation of
  253.   NLU via the message facility of the BBS.  Or send netmail to Les Fenison.
  254.   Our Fido Net address is 1:105/751 and the Family Net address is 8:77/7.
  255.  
  256.  
  257. ═════════════════════════════════════════════════════════════════════════════
  258.                       Node List Update Utility (NLU)                Page 5
  259. ═════════════════════════════════════════════════════════════════════════════
  260.  
  261.   7  System Requirements
  262.  
  263.  
  264.        NLU may be operated on any IBM PC/XT/AT/PS2 or compatible running under
  265.   DOS 2.0 and above or OS/2.
  266.  
  267.        All monitor and graphics cards are supported, including "composite" (2
  268.   color) monitors and backlit laptop screens.
  269.  
  270.  
  271.  
  272.   8  Distribution Files
  273.  
  274.  
  275.        The following files are included in NLU distribution package:
  276.  
  277.                  NLU.EXE         - Family mode version
  278.                  NLU_DOS         - DOS version
  279.                  NLU2.EXE        - OS/2 Version
  280.                  NLU.CTL         - Commented Configuration File
  281.                  NLU.DOC         - This Manual
  282.                  NLU_REG.DOC     - Registration information & Form
  283.                  WHATSNEW.NLU    - Latest product info (if needed)
  284.  
  285.        ACDC prohibits the modification of any of these files in any way,
  286.   shape, or form except by the individual evaluator or purchaser.
  287.  
  288.   8.1  Version History
  289.  
  290.   1.0b  - Initial beta release.
  291.   1.01b - Corrected a bug that in some rare cases could cause the day number
  292.           entered into the FILES.BBS to be 0. Fixed some minor cosmetic
  293.           things.  Added to the DEBUG level of the log so it would include
  294.           output of all shell commands.
  295.  
  296.   9  Running NLU
  297.  
  298.        To access NLU from anywhere in your system, place the EXE file in
  299.   a directory that is identified in your DOS path string. To operate NLU,
  300.   simple type the name of the EXE file and press the Enter key.  NLU will
  301.   need to know where its configuration file is.  If the configuration file
  302.   is found in the current directory it will use it.  If the configuration
  303.   file is not in the current directory then you may specify the path and
  304.   name of the configuration file on the command line.  The default
  305.   configuration file is NLU.CTL but may be called anything you want as
  306.   long as it is specified on the command line.
  307.  
  308.  
  309.  
  310. ═════════════════════════════════════════════════════════════════════════════
  311.                       Node List Update Utility (NLU)                Page 6
  312. ═════════════════════════════════════════════════════════════════════════════
  313.  
  314.   10  Configuring NLU
  315.  
  316.  
  317.        Configuration data is normally stored in a file named NLU.CTL.
  318.   This file is heavily commented and should be very easy to setup with
  319.   any text editor.
  320.   
  321.         The configuration file is made up of comments and keywords
  322.   followed by options.  The keywords and options are as follow;
  323.  
  324.         Keywords may be in any case upper or lower.  All comments must
  325.   begin with a semicolon(;). Keywords MUST start in column 0.  A space
  326.   before a keyword will keep it from working. The format is a KEYWORD
  327.   followed by OPTIONS The keyword should be followed by the option in
  328.   the following format;
  329.  
  330.   MAXDIFFS 5
  331.  
  332.   Do not include quotes such as
  333.  
  334.   MAXDIFFS "5".
  335.  
  336.   Do not use equal signs such as
  337.  
  338.   MAXDIFFS=5.
  339.  
  340.   KEYWORDS;
  341.  
  342.   REGKEY
  343.         After this keyword you should enter your registration key. If you
  344.   are not registered then DO NOT include this keyword.  Registration
  345.   entitles you to free support, removes the annoying sounds and delays,
  346.   and removes the user intervention at the end.  It only costs $5.
  347.   See NLU_REG.DOC for registration information.
  348.  
  349.  
  350.   MAXDIFFS
  351.         Maximum number of nodediffs to keep in the download directory.
  352.   If the keyword is left out nodediffs will not be purged. Same with
  353.   MAXDIFFS 0. For example, if you only wanted to keep the five latest
  354.   NODEDIFFS you would use the MAXDIFFS 5
  355.  
  356.  
  357.   MAXLISTS
  358.         Maximum number of nodelists to keep in the download directory.
  359.   If this keyword is left out nodediffs will not be purged. Same with
  360.   MAXLISTS 0.
  361.  
  362.  
  363.   INBOUNDDIR
  364.         This is the path where your mailer puts the inbound files.  This
  365.   path is ignored unless the TOSSFILES keyword is used. Place the whole
  366.   path including the drive letter after the INBOUNDDIR keyword.
  367.  
  368.  
  369. ═════════════════════════════════════════════════════════════════════════════
  370.                       Node List Update Utility (NLU)                Page 7
  371. ═════════════════════════════════════════════════════════════════════════════
  372.  
  373.   DOWNLOADDIR
  374.         This is the path where you keep your nodelists and nodediffs for
  375.   download or filerequest.  Place the whole path including the drive
  376.   letter after the keyword.
  377.  
  378.  
  379.   NODELISTDIR
  380.         This is the path to your active nodelists. This is where your
  381.   nodelist.### files are kept and where your nodediff.### files are
  382.   applied to the nodelist.###.  Place the whole path including the drive
  383.   letter after the keyword.
  384.  
  385.  
  386.   LISTNAME
  387.         This keyword should be followed by the name of the nodelist file
  388.   with the no extension. This keyword may be used more than
  389.   once if you have lists for more than one net. If used more than once
  390.   for more than one list then the order of the lists MUST BE THE SAME AS
  391.   THE DESCRIPTIONS IN LISTDESC AND DIFFNAMES!! Place the whole path
  392.   including the drive letter after the keyword.  For example if you had
  393.   the fido list, the family net list, and the D'bridge list you would use
  394.   the following;
  395.  
  396.             LISTNAME NODELIST
  397.             LISTNAME FMLYLIST
  398.             LISTNAME DBNET
  399.  
  400.  
  401.   DIFFNAME
  402.         This keyword works just like the LISTNAME keyword and follows the
  403.   same rules.  If specified more than once for more than one net the order
  404.   MUST BE THE SAME AS THE ORDER USED IN LISTNAME AND THE DESCRIPTIONS AND
  405.   LIST NAMES!  For example, If you had the lists we used in the example
  406.   above for LISTNAME then you must use the following for DIFFNAME.
  407.  
  408.             DIFFNAME NODEDIFF
  409.             DIFFNAME FMLYDIFF
  410.             DIFFNAME DBDIFF
  411.  
  412.   If one of the lists is rather small and never has a diff but rather a
  413.   new list every week then you must specify the diff anyway to keep the
  414.   number of entries the same as the LISTNAME and LISTDESC.
  415.  
  416.  
  417. ═════════════════════════════════════════════════════════════════════════════
  418.                       Node List Update Utility (NLU)                Page 8
  419. ═════════════════════════════════════════════════════════════════════════════
  420.  
  421.  
  422.   LISTDESC
  423.         Follow this keyword with the description for the NODELIST.Z##
  424.   in the FILES.BBS file.  This keyword is ignored unless the
  425.   UPDATE_FILELIST keyword is used.  If you want a day number to
  426.   be included in the description then replace the day number
  427.   with a ~D.  For example if you wanted the description to read;
  428.   Node list for day number 101 you would use the following;
  429.  
  430.             LISTDESC Nodelist for day number ~D
  431.  
  432.   If a download counter is used then it should be added here as well
  433.   Here is an example of a download counter;
  434.  
  435.             LISTDESC [000] Nodelist for day number ~D
  436.  
  437.   If you have lists for more than one network then YOU MUST HAVE MORE
  438.   THAN ONE LISTDESC.  The number of list descriptions must be the
  439.   same as the number of calls to LISTNAME and DIFFNAME. The order and
  440.   quantity must be exactly the same!  Here is an example that would
  441.   work with the above examples.
  442.  
  443.             LISTDESC FidoNET nodelist for day number ~d
  444.             LISTDESC Family Net list for day number ~d
  445.             LISTDESC Dbridge net list for day number ~d
  446.  
  447.  
  448.   DIFFDESC
  449.         This works the same as LISTDESC except it is used for the diff
  450.   files.  Once again you must have the same number of entrys here as
  451.   you have in LISTDESC, LISTNAME, and DIFFNAME.  The order and quantity
  452.   must be the same. Here is an example that will work with the above
  453.   examples;
  454.  
  455.             DIFFDESC FidoNET nodediff for day number ~d
  456.             DIFFDESC Family Net diff for day number ~d
  457.             DIFFDESC Dbridge diff for day number ~d
  458.  
  459.   LOGFILE
  460.         If you want a log file put the full path and file name after this
  461.   keyword.
  462.  
  463.  
  464.   LOGMODE
  465.         Options available for this keyword are TERSE, VERBOSE, DEBUG, and
  466.   NONE.  TERSE will log all errors and any true action.  In other words, if
  467.   NLU were to check for files to toss and there were none it would not be
  468.   logged but if there were files to toss it would log it.  Using VERBOSE
  469.   will log everything that TERSE logs plus some progress information.  DEBUG
  470.   will log everything that TERSE and VERBOSE will log plus much more
  471.   including commands that were issued to external utilities like PKZIP and
  472.   so on.
  473.  
  474.   LOGSTYLE
  475.         Options available for this keyword are FRONTDOOR, DBRIDGE, and
  476.   BINK.  More options can be added as I receive samples of other logs.
  477.  
  478.  
  479. ═════════════════════════════════════════════════════════════════════════════
  480.                       Node List Update Utility (NLU)                Page 9
  481. ═════════════════════════════════════════════════════════════════════════════
  482.  
  483.  
  484.   TOSSFILES
  485.         This keyword has no options.  If the keyword is present then files
  486.   will be tossed from the inbound directory specified in INBOUNDDIR to
  487.   the download directory specified in DOWNLOADDIR.
  488.  
  489.  
  490.   UPDATE_FILELIST
  491.         This keyword has no options.  If the keyword is present then the
  492.   FILES.BBS files will be updated.
  493.  
  494.  
  495.   FILELIST_ORDER
  496.         If the UPDATE_FILELIST keyword is not used then this keyword will be
  497.   completely ignored! The options for this keyword are TOP BOTTOM and SORT.
  498.   If TOP is used then the description will be placed on the top of the
  499.   FILES.BBS.  If BOTTOM is specified then the description will be placed
  500.   at the bottom of the FILES.BBS.  If the SORT option is specified then
  501.   the description will be inserted at the point where the FILE fits in
  502.   alphabetical order. The options TOP, BOTTOM, & SORT MUST BE IN CAPS!
  503.  
  504.  
  505.   ZIP       DOS Command to add a file to a zip
  506.   ZIP2      OS/2 Command to add a file to a zip
  507.   UNZIP     DOS Command to extract a file from a zip
  508.   UNZIP2    OS/2 Command to extract a file from a zip
  509.   ZIPVIEW   DOS Command to view a zip file.
  510.   ZIPVIEW2  OS/2 Command to view a zip file.
  511.  
  512.         The above keywords are the command line syntax for ziping and
  513.   unzipping. DO NOT use destructive options such as -M to move
  514.   to a zip but rather -A to add to a zip.  Likewise for unzipping
  515.   don't use the command that deletes the origional .zip.  If the
  516.   keyword is needed and is not provided then the zipping or
  517.   unzipping will not take place.  WARNING!!!  Some versions of zip
  518.   will cause the system to lockup if the wrong command line options
  519.   are used!.  To be sure that the command line options are correct
  520.   try the command first from the command line yourself.  Any command
  521.   that requires operator response beyond the initial command line will
  522.   not work with NLU.
  523.  
  524.  
  525.   ARC       DOS Command to add a file to an arc file.
  526.   ARC2      OS/2 Command to add a file to an arc file.
  527.   UNARC     DOS Command extract a file from an arc file.
  528.   UNARC2    OS/2 Command to add a file from an arc file.
  529.   ARCVIEW   DOS Command to view the contents of an arc file.
  530.   ARCVIEW2  OS/2 Command to view the contents of an arc file.
  531.  
  532.         The above keywords are the command line syntax for arcing and
  533.   unarcing. DO NOT use destructive options such as -M to move
  534.   to a arc but rather -A to add to a arc.  Likewise for unarcing
  535.   don't use the command that deletes the origional .arc.  If the
  536.   keyword is needed and is not provided then the arcing or
  537.   unarcing will not take place.  WARNING!!!  Some versions of arc
  538.   will cause the system to lockup if the wrong command line options
  539.   are used!.  To be sure that the command line options are correct
  540.   try the command first from the command line yourself.  Any command
  541.   that requires operator response beyond the initial command line will
  542.   not work with NLU.
  543.  
  544.  
  545. ═════════════════════════════════════════════════════════════════════════════
  546.                       Node List Update Utility (NLU)                Page 10
  547. ═════════════════════════════════════════════════════════════════════════════
  548.  
  549.  
  550.   LZH       DOS Command to add a file to an lzh file.
  551.   LZH2      OS/2 Command to add a file to an lzh file.
  552.   UNLZH     DOS Command extract a file from an lzh file.
  553.   UNLZH2    OS/2 Command to add a file from an lzh file.
  554.   LZHVIEW   DOS Command to view the contents of an lzh file.
  555.   LZHVIEW2  OS/2 Command to view the contents of an lzh file.
  556.  
  557.         The above keywords are the command line syntax for lzhing and
  558.   unlzhing. DO NOT use destructive options such as -M to move
  559.   to a lzh but rather -A to add to a lzh.  Likewise for unlzhing
  560.   don't use the command that deletes the origional .lzh.  If the
  561.   keyword is needed and is not provided then the lzhing or
  562.   unlzhing will not take place. WARNING!!!  Some versions of LHA
  563.   will cause the system to lockup if the wrong command line options
  564.   are used!.  To be sure that the command line options are correct
  565.   try the command first from the command line yourself.  Any command
  566.   that requires operator response beyond the initial command line will
  567.   not work with NLU.
  568.  
  569.   ARCPREF
  570.         Options are Z for zip, A for arc, or L for LZH.  This will specify
  571.   your preference of packing methods.
  572.  
  573.   APPLYDIFF
  574.         Include this keyword if you want diffs applied to lists.
  575.  
  576.   APPLYCOMMAND    DOS command to apply diffs
  577.   APPLYCOMMAND2   OS/2 command to apply diffs
  578.  
  579.         After these keywords place the command to apply diffs.  If you need
  580.   to be in a special directory to run the command then use a batch
  581.   or .cmd file that does the CD for you.  It is not necessary for the
  582.   batch or cmd file to return you to the current directory.
  583.  
  584.   CLEANUP
  585.         Cleanup has four options, LISTS, DIFFS, ALL, and NONE.  This keyword
  586.   has no effect if you did not include the APPLYDIFF keyword.  This
  587.   keyword specifies what files to cleanup after applying a nodediff.
  588.   With the LISTS option, the old list will be removed from the active
  589.   directory after applying the diff and creating the new list.  The
  590.   DIFFS option will cause the diff to be deleted from the active
  591.   directory after being applied. The ALL option cleans up both lists
  592.   and diffs.  The NONE option disables all cleanup the same as omitting
  593.   the keyword.
  594.  
  595.  
  596.  
  597.  
  598. ═════════════════════════════════════════════════════════════════════════════
  599.                       Node List Update Utility (NLU)                Page 11
  600. ═════════════════════════════════════════════════════════════════════════════
  601.  
  602.   CONVERT
  603.         Convert has no options.  Including this keyword will cause any archived
  604.   files that are in a different format than the format specified in the
  605.   ARCPREF keyword will be converted to your preferred format.
  606.  
  607.  
  608.   SKIPTEST
  609.         The use of this keyword is NOT RECOMMENDED!  This keyword will disable
  610.   the archive confidence test that runs each time NLU is started.  The
  611.   confidence test tests all necessary options of the archive commands
  612.   to make sure they are installed properly.  In the event that you
  613.   install a new version of zip, arc, LHA or whatever this test will insure
  614.   that your lists and diffs will not be trashed as a result of an
  615.   unexpected change.
  616.  
  617.  
  618.   MAGICDIR
  619.         This keyword should be followed by the path to a magic file
  620.   directory.  This is for mailers like D'bridge that don't have a magic
  621.   file list.  If this keyword is used then the magic directory will be
  622.   updated to contain only the newest of each list and diff.  This means
  623.   that you can tell your mailer to send {magicdir}\nodelist.* for the
  624.   magic file NODELIST and so on.  Comment out this keyword if you do
  625.   not want to keep a magic directory or don't want NLU to update it.
  626.  
  627.   MAGICLIST
  628.         This keyword specifies the name of the list file that your
  629.   mailer uses to specify magic file names.  The format of this list
  630.   file is;
  631.       MAGICNAME d:\pathname\filename.ext
  632.   for example
  633.       NODELIST E:\FILES\NODELIST\NODELIST.Z41
  634.       NODEDIFF E:\FILES\NODELIST\NODEDIFF.Z41
  635.       FMLYDIFF E:\FILES\NODELIST\FMLYDIFF.Z41
  636.       FMLYLIST E:\FILES\NODELIST\FMLYLIST.Z41
  637.       etc.
  638.  
  639.  
  640.  
  641.  
  642. ═════════════════════════════════════════════════════════════════════════════
  643.                       Node List Update Utility (NLU)                Page 12
  644. ═════════════════════════════════════════════════════════════════════════════
  645.  
  646.                             Program Flow
  647.  
  648.   Before getting started with the program flow it is very important to
  649.   understand some terminology.  First of all there are four directories
  650.   involved. Each directory has a name which will be used from hereon.
  651.   First there is the inbound directory where your mailer puts incoming
  652.   files.  This directory will be called "INBOUND".  Then there is the
  653.   directory where you keep files for others to download and/or file
  654.   request.  This directory will be called "DOWNLOAD".  The third directory
  655.   is the directory where you keep your unarchived lists for your nodelist
  656.   compiler.  This directory will be called "ACTIVE".  Some mailers will
  657.   support MAGIC file names which can be used for people to file request
  658.   the latest LIST or DIFF.  The latest LIST & DIFF can be kept in a special
  659.   directory for Magic file requesting.  This directory will be refereed
  660.   to as MAGICDIR.
  661.  
  662.   Since this document is written for both the technically minded and the
  663.   not so technically minded I will attempt to describe the program flow
  664.   in a rather simple form so that all will understand.  In the flow I will
  665.   place labels. You will find some lines that say "GO BACK TO LABEL ###".
  666.   This should be self explanatory soon.
  667.  
  668.   Beginning the Program Flow;
  669.  
  670. STEP 1 ** CONFIDENCE TEST **
  671.      If the SKIPTEST keyword is NOT included then;
  672.          Run the archive confidence test by creating a test text file
  673.          called TESTFILE.123.   This file is then archived into a LZH
  674.          format file called TESTFILE.L23.  The LHA view command is then
  675.          executed to see if the origional TESTFILE.123 can be found. Then
  676.          LHA is called to unarchive TESTFILE.L23 into TESTFILE.123. This
  677.          will test all three commands (archiving, unarchiving, & viewing).
  678.          If any of these three failed the program will display an error
  679.          message and terminate.  This test is then repeated with the
  680.          ARC format then with the ZIP format.
  681.  
  682. STEP 2 ** REGISTRATION CHECK **
  683.      If you are NOT registered then;
  684.          Annoying beeps and sounds and delays will happen and you will
  685.          be told that you are not registered and just how cheap it is to
  686.          register your copy ($5).
  687.  
  688.      If you ARE registered then;
  689.          Your name will quickly and silently be displayed as the
  690.          registered owner.
  691.  
  692. STEP 3 ** FILE TOSS **
  693.      If the TOSSFILES keyword IS included then;
  694.          Any files in the INBOUND directory that have a file name matching
  695.          a file name specified with either the LISTNAME or DIFFNAME keyword
  696.          will be MOVED to the DOWNLOAD directory.
  697.  
  698.          If the UPDATE_FILELIST keyword is included then;
  699.              The files that were just tossed into the DOWNLOAD directory
  700.              will be inserted into the FILES.BBS files in the order
  701.              specified by FILELIST_ORDER.  The descriptions added will
  702.              be as specified in LISTDESC or DIFFDESC.
  703.  
  704.  
  705.  
  706. ═════════════════════════════════════════════════════════════════════════════
  707.                       Node List Update Utility (NLU)                Page 13
  708. ═════════════════════════════════════════════════════════════════════════════
  709.  
  710. STEP 4 ** FILE CONVERSION **
  711.      If the CONVERT keyword IS included then;
  712.          Any files that are in the DOWNLOAD directory that are in a format
  713.          other than that specified by the ARCPREF keyword will be converted
  714.          to the format specified by ARCPREF.  The FILES.BBS file will be
  715.          updated with the modified file names.
  716.  
  717. STEP 5 ** LIST & DIFF INSTALLATION **
  718.      If there is a LIST file in the DOWNLOAD directory that is newer than
  719.      the file in the ACTIVE directory by the same name then;
  720.          The file is unarchived into the active directory.
  721.  
  722.      If there is a DIFF file in the DOWNLOAD directory that is newer than
  723.      the file in the ACTIVE directory by the same name then;
  724.          The file is unarchived into the active directory.
  725.  
  726. STEP 6 ** DIFF TO LIST APPLICATION **
  727.      If there is a DIFF file in the ACTIVE directory AND the APPLYDIFF
  728.      keyword is used then;
  729.          The command specified by the APPLYCOMMAND or APPLYCOMMAND2 will
  730.          be executed and DIFFS applied to LISTS.
  731.  
  732. STEP 7 ** NEW LIST ARCHIVING **
  733.      If there is a LIST file in the ACTIVE directory newer than the newest
  734.      file by the same name in the DOWNLOAD directory then;
  735.          The newer LIST file will be archived into the DOWNLOAD directory
  736.          using the format specified in the ARCPREF keyword. If the
  737.          UPDATE_FILESLIST keyword is specified then The FILES.BBS file will
  738.          be updated with the newly archived file.
  739.  
  740. STEP 8 ** DOWNLOAD DIRECTORY PURGING **
  741.      If the number of LISTS in the DOWNLOAD directory is greater than
  742.      the number of lists specified by MAXLISTS then;
  743.          The oldest LIST files will be purged until the number of lists
  744.          is NOT greater than the number of lists specified by the MAXLISTS
  745.          keyword.  This is a per list name function.  For example: if you
  746.          have two different lists like NODELIST and FMLYLIST then this
  747.          procedure would be repeated for each list.
  748.  
  749.      If the number of DIFFS in the DOWNLOAD directory is greater than
  750.      the number of diffs specified by MAXDIFFS then;
  751.          The oldest DIFF files will be purged until the number of diffs
  752.          is NOT greater than the number of diffs specified by the MAXDIFFS
  753.          keyword.  This is a per diff name function.  For example: if you
  754.          have two different diffs like NODEDIFF and FMLYDIFF then this
  755.          procedure would be repeated for each diff.
  756.  
  757. STEP 9 ** ACTIVE DIRECTORY PURGING / CLEANUP
  758.      If there are more than one of each LIST in the ACTIVE directory and
  759.      the CLEANUP keyword includes ALL or LISTS then;
  760.          The excess lists will be deleted from ACTIVE.
  761.  
  762.      If there are ANY DIFFS in the ACTIVE directory and the CLEANUP keyword
  763.      includes ALL or DIFFS then;
  764.          All DIFFS will be deleted from ACTIVE.
  765.  
  766.  
  767. ═════════════════════════════════════════════════════════════════════════════
  768.                       Node List Update Utility (NLU)                Page 14
  769. ═════════════════════════════════════════════════════════════════════════════
  770.  
  771. STEP 10 ** MAGIC FILE UPDATE **
  772.      If the keyword MAGICDIR is used then;
  773.          The MAGICDIR directory will be updated to include only the newest
  774.          of each LIST and DIFF file.
  775.  
  776.      If the MAGICLIST keyword is used then;
  777.          The magic list will be updated to include only the newest of each
  778.          of the LISTS and DIFFS.
  779.  
  780. STEP 11 ** MORE REGISTRATION CHECKING **
  781.      If you are NOT registered then;
  782.          You will be presented with a random four digit number and asked
  783.          to re-enter that number to continue.  The program will not
  784.          continue until you re-enter that number.  Each time you enter
  785.          an incorrect number you will be presented with the same number
  786.          again and asked to enter it.  This makes it impossible to run
  787.          in unattended mode until you register.  It's only $5.00 to
  788.          register.
  789.  
  790.      END of Program.
  791.  
  792.