home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR24 / FLST120.ZIP / FASTLST.DOC < prev    next >
Text File  |  1994-01-13  |  17KB  |  602 lines

  1. ******************************************************************************
  2. *                                                                            *
  3. *                                                                            *
  4. *           *******   **     ****   ******  ****     ****   ******           *
  5. *            **   *  ****   **  **  * ** *   **     **  **  * ** *           *
  6. *            ** *   **  **  **        **     **     **        **             *
  7. *            ****   **  **   ****     **     **      ****     **             *
  8. *            ** *   ******      **    **     **   *     **    **             *
  9. *            **     **  **  **  **    **     **  ** **  **    **             *
  10. *           ****    **  **   ****    ****   *******  ****    ****            *
  11. *                                                                            *
  12. *                                                                            *
  13. *              A Fast, Flexible and Powerful nodelist compiler               *
  14. *                                                                            *
  15. *                                                                            *
  16. ******************************************************************************
  17. *                                                                            *
  18. *              (C)  Copyright 1992-1994  by  Alberto Pasquale                *
  19. *                                                                            *
  20. *                   A L L   R I G H T S   R E S E R V E D                    *
  21. *                                                                            *
  22. ******************************************************************************
  23. *                                                                            *
  24. *   FastLst required many hours of work: if you like it and would like to    *
  25. *   support me in developing this and other similar products, please         *
  26. *   register. See REGISTER.DOC for more details.                             *
  27. *                                                                            *
  28. ******************************************************************************
  29. *                                                                            *
  30. *                        How to contact the author:                          *
  31. *                                                                            *
  32. *   email:       Alberto Pasquale of 2:332/504.1@fidonet.org                 *
  33. *                When sending crash netmail, please call:                    *
  34. *                2:332/504@fidonet.org +39-59-450600 V32b                    *
  35. *                2:332/511@fidonet.org +39-59-450643 V32b                    *
  36. *                2:332/524@fidonet.org +39-59-581127 HST/V32                 *
  37. *                                                                            *
  38. *   postal mail: Alberto Pasquale                                            *
  39. *                Viale Verdi 106                                             *
  40. *                41100 Modena                                                *
  41. *                Italy                                                       *
  42. *                                                                            *
  43. ******************************************************************************
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.                         FastLst ver 1.20 User Manual
  62.  
  63.  
  64.  
  65.                                  DISCLAIMER
  66.  
  67.          FastLst is provided as is and comes with no warranty of any
  68.          kind, either expressed or implied. In no event will the author
  69.          be liable for any damages resulting from the direct or indirect
  70.          use of this software.
  71.          The user of this program bears all risk as to its quality and
  72.          performance.
  73.  
  74.  
  75.                                    LICENSE
  76.  
  77.          FastLst
  78.          Copyright 1992-1994 by Alberto Pasquale, Modena, Italy
  79.          All rights reserved. Commercial distribution and/or use
  80.          prohibited without written permission of the author.
  81.  
  82.          You may copy and distribute verbatim copies of the original
  83.          distribution archive of FastLst, providing you don't charge
  84.          any fee exceeding your actual costs.
  85.  
  86.          You may enclose FastLst in CD-ROM collections of ShareWare
  87.          and Public Domain programs or keep it in BBS download areas
  88.          provided you do not charge any specific fee for the download.
  89.  
  90.          If you regularly use FastLst, you should REGISTER your copy
  91.          (See Register.Doc).
  92.  
  93.  
  94.          Files in the original archive:
  95.  
  96.          FastLst.Exe   The executable program (OS/2 or Dos version)
  97.          FastLst.Cfg   The sample configuration file
  98.          FastLst.Doc   This documentation file
  99.          Readme.1st    Important notes
  100.          Whatsnew.Txt  Fixes and additions
  101.          Register.Doc  Info on Registration
  102.          Register.Frm  The Registration Form
  103.          Register.Cum  Special offer for cumulative registrations
  104.          FlstWish.Txt  I ask for your opinion
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.                                      Pag.  1
  120.  
  121.          MAIN CHARACTERISTICS:
  122.  
  123.          - Compiles Version 7 format nodelists.
  124.  
  125.          - Support for old "Fidouser.Lst" sysop list
  126.  
  127.          - Multiple output nodelist compilation from one config file.
  128.  
  129.          - Decompression and compilation of new lists and diffs are
  130.            automatically executed when necessary, with no need for
  131.            clumsy batch files.
  132.  
  133.          - Very fast operation
  134.  
  135.          - Full 4D (point) support, both via the "Point,..." and
  136.            "Boss,..." keywords.
  137.  
  138.          - Easy addition of nodes via the "Node,<address>,..." keyword
  139.            in a private list.
  140.  
  141.          - In the case of SysOps of multiple nodes, keeps in the sysop
  142.            lists (fidouser.lst and sysop.ndx) all the name/address
  143.            entries. Allows to keep one address only for specified
  144.            ones.
  145.  
  146.          - User Cost (Msg Fee) can be set different from Call Cost.
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.                                      Pag.  2
  180.  
  181.                                 OVERALL OPERATION
  182.  
  183.  
  184.          FastLst has been designed to be invoked regularly from
  185.          one of your main batch files, after mail has been received
  186.          or at pre-arranged times at your pleasure: if any new
  187.          (compressed or not) nodelist/nodediff is detected, Fastlst
  188.          processes them as required, otherwise it immediately exits
  189.          with no further delay.
  190.  
  191.          If you want FastLst to compile all of your nodelists even
  192.          if no new ones are present, you need to use the -f command
  193.          line switch.
  194.  
  195.          For each "output block" in the config file:
  196.  
  197.          - New compressed lists or diffs are detected and unarchived.
  198.          - New diffs are detected and applied: the resulting new
  199.            nodelist is archived, if so requested in the config file.
  200.          - New lists are detected and the pertinent output nodelists
  201.            are rebuilt.
  202.            If no new list is found for a specific "output block", that
  203.            output nodelist is not compiled, unless the -f command line
  204.            switch is specified.
  205.  
  206.          If you use the automatic Archive/Unarchive features of FastLst,
  207.          you are supposed to always have in the pertinent directory
  208.          an up-to-date copy of each nodelist (FastLst unarchives new
  209.          lists/diffs only, it does not unarchive the lists that
  210.          have already been unarchived in previous runs).
  211.  
  212.          ATTENTION:
  213.          - Every time the config file is changed, FastLst rebuilds all
  214.            the output nodelists, as if the -f command line switch was
  215.            specified.
  216.          - Every time a PasswordFile is changed, FastLst rebuild
  217.            the nodelists that use it.
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.                                      Pag.  3
  240.  
  241.                    4D POINT SUPPORT: POINT and BOSS keywords
  242.  
  243.  
  244.          The source nodelist and nodediff must be in standard "St.
  245.          Louis" format, as described in FTS-0005. FastLst allows an
  246.          extension to the input nodelist format in order to support
  247.          true "4D" points.
  248.  
  249.          First method:
  250.          Points are entered in the nodelist directly following their
  251.          bossnode.  Each one starts with the "Point,<point>" keyword.
  252.          Example:
  253.  
  254.          ...
  255.          ...
  256.          ,504,Videl_3,Modena_I,Roberto_Zanasi,39-59-450600,9600,CM,XA,V32B,V42B
  257.          Point,1,Pasquale,Modena_I,Alberto_Pasquale,-!Unpublished-,9600,
  258.          Point,2,SysOp,Modena_I,Roberto_Zanasi,-!Unpublished-,2400,
  259.          Point,3,Carta,Modena,Francesco_Carta,-!Unpublished-,2400,
  260.          ...
  261.          ...
  262.  
  263.          Second method:
  264.          Points are entered in the nodelist after the "Boss,<address>"
  265.          keyword. Example:
  266.  
  267.          ...
  268.          ...
  269.          Boss,2:332/504
  270.          ,1,Pasquale,Modena_I,Alberto_Pasquale,-!Unpublished-,9600,
  271.          ,2,SysOp,Modena_I,Roberto_Zanasi,-!Unpublished-,2400,
  272.          ,3,Carta,Modena,Francesco_Carta,-!Unpublished-,2400,
  273.          ...
  274.          ...
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.                                     Pag.  4
  300.  
  301.                                 The NODE Keyword
  302.  
  303.  
  304.          Another extension over FTS-0005 is provided to allow easy
  305.          addition of nodes in small private lists.
  306.  
  307.          When you need to add a node to your nodelist to call it or to
  308.          enforce a session password with it, you can use the
  309.          "Node,<address>,..." keyword to avoid the necessity of adding
  310.          its Zone and Host coordinators.
  311.  
  312.          You should specify a full 4D address (point optional).
  313.  
  314.          Any subsequent entry will take the current address as a
  315.          starting point.
  316.  
  317.          E.g.: You want to add 9:8/7.3
  318.  
  319.          With "Node,...":
  320.          ...
  321.          ...
  322.          Node,9:8/7.3,Mickey,DisneyLand,Mickey_Mouse,1-800-111,9600,CM
  323.          ...
  324.          ...
  325.  
  326.          With "Boss,...":
  327.          ...
  328.          ...
  329.          Boss,9:8/7
  330.          ,3,Mickey,DisneyLand,Mickey_Mouse,1-800-111,9600,CM
  331.          ...
  332.          ...
  333.  
  334.          With the traditional method:
  335.          ...
  336.          ...
  337.          Zone,9,...
  338.          Host,8,...
  339.          ,7,...
  340.          Point,3,Mickey,DisneyLand,Mickey_Mouse,1-800-111,9600,CM
  341.          ...
  342.          ...
  343.  
  344.  
  345.          Now let's add 8:7/6 and 8:7/7:
  346.  
  347.          With "Node,...":
  348.          ...
  349.          ...
  350.          Node,8:7/6,Mickey,DisneyLand,Mickey_Mouse,1-800-111,9600,CM
  351.          ,7,Duck,DisneyLand,Donald_Duck,1-800-112,9600,CM
  352.          ...
  353.          ...
  354.  
  355.  
  356.  
  357.  
  358.  
  359.                                     Pag.  5
  360.  
  361.          With the traditional method:
  362.          ...
  363.          ...
  364.          Zone,8,...
  365.          Host,7,...
  366.          ,6,Mickey,DisneyLand,Mickey_Mouse,1-800-111,9600,CM
  367.          ,7,Duck,DisneyLand,Donald_Duck,1-800-112,9600,CM
  368.          ...
  369.          ...
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.                                     Pag.  6
  420.  
  421.                              CONFIGURATION FILE
  422.  
  423.  
  424.          FastLst requires a configuration file (defaults to
  425.          FastLst.Cfg in the current directory). Before using FastLst
  426.          you should edit the sample config file, following the comments
  427.          in it. The keywords are not case sensitive.
  428.  
  429.          You should keep a copy of the original sample FastLst.Cfg,
  430.          since it is extensively commented and it represents the real
  431.          documentation of FastLst.
  432.  
  433.          Each line is parsed up to a 256 chars length, so don't go
  434.          further (you can always split address lists into smaller ones).
  435.  
  436.          In the OS/2 version, any file specification can be a legal
  437.          OS/2 name, between double quotes if necessary.
  438.  
  439.          Please be aware that the generation of text files (FidoTxt,
  440.          FidoPrn, FidoUserLst verbs) and the use of many options and
  441.          overrides can dramatically slow down the compilation process:
  442.          use only the options/overrides that you really need if you mind
  443.          compilation time.
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.                                     Pag.  7
  480.  
  481.                              COMMAND LINE PARAMETERS
  482.  
  483.  
  484.          -c<config>
  485.               Use <config> configuration file instead of FASTLST.CFG.
  486.  
  487.          -f
  488.               Force compilation even if no new list/diff has been
  489.               detected.
  490.  
  491.          -p
  492.               Prepare: Unarc new lists and diffs, Apply diffs and Arc
  493.               new nodelists, do not compile nodelists.
  494.  
  495.          -r
  496.               When applying a diff, FastLst usually deletes the newly
  497.               generated source nodelist file if a CRC error is detected.
  498.               With this switch the new nodelist is _not_ deleted, so
  499.               that it will be processed anyway.
  500.  
  501.               When compiling a list, FastLst usually aborts the
  502.               compilation of the current output nodelist if a CRC error
  503.               is detected.
  504.               With this switch the current output nodelist will be
  505.               entirely compiled anyway.
  506.  
  507.          -h or -?
  508.               for help
  509.  
  510.  
  511.  
  512.                                    ERRORLEVELS
  513.  
  514.           0    Normal termination
  515.           1    Help requested
  516.           2    File Open error
  517.           3    Can't find nodelist file
  518.           4    Disk Full
  519.           5    Can't find config file
  520.           6    Configuration error
  521.           7    Out of memory
  522.           8    Read error while applying diff
  523.           9    CRC error (applying diff)
  524.          10    CRC error (compiling list)
  525.          11    User Break
  526.          12    Cannot replace old output nodelist files with new ones
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.                                     Pag.  8
  540.  
  541.                                 MISCELLANEOUS INFO
  542.  
  543.  
  544.                                  MULTIPLE SYSOPS
  545.  
  546.          In the case of SysOps of more than one system, all the
  547.          name/address couples are put in the SysOp Name Lists
  548.          (Fidouser.lst and Sysop.ndx).
  549.  
  550.          If you want to keep one only name/address couple for some
  551.          multiple SysOps, you can use the "SysDup <AddrLst>" option
  552.          in the config file: the SysOps who have one of the listed
  553.          addresses will be present in the SysOp lists with that entry
  554.          only, even if they have other addresses.
  555.  
  556.          Example: Let's suppose that Robert Everywhere has 4 nodes:
  557.  
  558.          EveryWhere, Robert      1:456/987.0
  559.          EveryWhere, Robert      2:123/457.0
  560.          EveryWhere, Robert      2:123/457.8
  561.          EveryWhere, Robert      6:321/567.0
  562.  
  563.          By default all the 4 addresses are available in the sysop
  564.          lists (and some programs allow to choose among them, e.g.
  565.          TimEd message editor by Gerard van Essen).
  566.  
  567.          If you prefer to keep one address only, you can specify the
  568.          desired address in a SysDup line in the config file:
  569.          e.g. "SysDup 2:123/457.8".
  570.  
  571.  
  572.  
  573.                             REDIRECTED SYSTEMS
  574.  
  575.          Redirected systems (Unpublished phone number, on HOLD) are
  576.          given the phone number, baud rate, modem type, cost and
  577.          flags of the preceding coordinator, the Board name is
  578.          prepended with '-R-'.
  579.            If you have a session password with the system to be redirected
  580.          or with the system it should be redirected to, no redirection
  581.          is done in order to prevent password-mismatch errors in the
  582.          case the Unpublished/Hold System calls you.
  583.            These non-redirected systems take an EMPTY phone number string,
  584.          so that your mailer does not send unwanted strings to your modem
  585.          attempting to call these systems, should something appear in your
  586.          outbound addressed to them.
  587.            Pay attention: if you want to directly call these
  588.          null_phone-systems or their coordinators, you have to give
  589.          them a phone number using the "Phone <Addr> <NewNumber>"
  590.          statement in the configuration file.
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.                                 <The End>
  598.  
  599.                                      Pag.  9
  600.  
  601.  
  602.