home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 8 / CDASC08.ISO / VRAC / FLMD124.ZIP / FLM.DOC < prev    next >
Text File  |  1993-09-04  |  13KB  |  532 lines
  1. ******************************************************************************
  2. *                                                                            *
  3. *                                                                            *
  4. *                          *******  ****     **   **                         *
  5. *                           **   *   **      *** ***                         *
  6. *                           ** *     **      *******                         *
  7. *                           ****     **      *******                         *
  8. *                           ** *     **   *  ** * **                         *
  9. *                           **       **  **  **   **                         *
  10. *                          ****     *******  **   **                         *
  11. *                                                                            *
  12. *                                                                            *
  13. *                  A flexible File List Manager for Maximus                  *
  14. *                                                                            *
  15. *                                                                            *
  16. ******************************************************************************
  17. *                                                                            *
  18. *               (C) Copyright 1992-1993  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. *   FLM is fully copyrighted, however you are granted to use and distribute  *
  25. *   it in unmodified form, provided you do not make money from such use or   *
  26. *   distribution. Otherwise you are required to contact the author to        *
  27. *   reach an agreement for a written permission.                             *
  28. *                                                                            *
  29. ******************************************************************************
  30. *                                                                            *
  31. *   How to contact the author:  Alberto Pasquale                             *
  32. *                               Viale Verdi 106                              *
  33. *                               41100 Modena                                 *
  34. *                               Italy                                        *
  35. *                                                                            *
  36. *   2:332/524@fidonet.org +39-59-581127 V32/HST, Mail Only (No BBS)          *
  37. *   2:332/504@fidonet.org +39-59-450600 V32bis                               *
  38. *   2:332/511@fidonet.org +39-59-450643 V22bis                               *
  39. *                                                                            *
  40. ******************************************************************************
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.                           File List Manager ver. 1.24
  62.  
  63.  
  64.  
  65.                                    DISCLAIMER
  66.  
  67.          There is absolutely no warranty of any kind on this product.
  68.          The user of this program bears all risk as to its quality and
  69.          performance.
  70.  
  71.  
  72.                                    LICENSE
  73.  
  74.          FLM (File List Manager)
  75.          Copyright 1992-1993 by Alberto Pasquale, Modena, Italy
  76.          All rights reserved. Commercial distribution and/or use
  77.          prohibited without written permission of the author.
  78.  
  79.          You may copy and distribute verbatim copies of the original
  80.          distribution archive of FLM, providing you don't charge
  81.          any fee exceeding your actual costs.
  82.  
  83.  
  84.          Files in the original archive:
  85.  
  86.          FLM.Exe       Executable program
  87.          FLM.Cfg       Sample configuration
  88.          FLM.Doc       Documentation
  89.          NewHead.Txt   Sample new-list header
  90.          AllHead.Txt   Sample full-list header
  91.          OkHead.Lst    Sample OkFile header
  92.          Magic.Lst     Sample Magic-list
  93.          WhatsNew.Txt  Changes and additions
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.                                      Page  1
  120.  
  121.          Main characteristics:
  122.  
  123.          - To be used with Maximus 2.0 by Scott J. Dudley.
  124.  
  125.          - One-Pass generation of multiple file lists.
  126.  
  127.          - Selective Adoption of Orphans
  128.  
  129.          - Selective description deletion for missing files.
  130.  
  131.          - Minimum configuration effort required.
  132.  
  133.          - Okfile generation.
  134.  
  135.          - Okfile support for a fixed header and variable Magics.
  136.  
  137.          - Okfile support for Maxfiles.Idx (Binkley 2.55 or greater).
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  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.                                      Page  2
  180.  
  181.                                 INSTALLATION
  182.  
  183.  
  184.          1) Edit flm.cfg
  185.          2) Edit your maintenance batch in order to call FLM before FB.
  186.             This way the FileBase will be compiled from up-to-date files.bbs.
  187.  
  188.             FLM.Exe and FLM.Cfg must be in the current directory
  189.             or in your PATH.
  190.  
  191.  
  192.                            Command line switches
  193.  
  194.             -c<cfgfile>    Cfg file override
  195.  
  196.             Example: FLM -cc:\max\flm.cfg
  197.  
  198.  
  199.  
  200.                                 Errorlevels
  201.             
  202.  
  203.               1 - Error in CFG
  204.               2 - Cannot find config file
  205.             253 - Cannot read max.prm
  206.             254 - Cannot open output files
  207.             255 - Invalid parameter on command line or out-of-memory
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.                                      Page  3
  240.  
  241.                               OVERALL OPERATION
  242.  
  243.  
  244.          FLM scans all the file areas in AREA.DAT following the
  245.          AREA.NDX order (or the equivalent files defined in Max.prm).
  246.          FLM writes all the output files in one pass: for every area
  247.          all the unused output files are closed and the used ones are
  248.          opened. If too many output files are required at the same
  249.          time, FLM could exit with a "cannot open file" error.
  250.  
  251.          There can be no more than 3000 files per directory, otherwise
  252.          the exceeding files will be ignored.
  253.  
  254.          You should exclude areas on CD-ROM from Adopt and RemMis
  255.          statements, to avoid lengthy and useless operations.
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  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.                                      Page  4
  300.  
  301.  
  302.                              CONFIGURATION FILE
  303.  
  304.  
  305.          FLM requires a configuration file (defaults to FLM.Cfg).
  306.          Before using FLM you should edit this file, following the
  307.          comments in the sample one.
  308.  
  309.          The names of the various parameters are NOT case sensitive.
  310.          Items in square brackets ([]) are optional.
  311.  
  312.          <filename> is a fully qualified filename with optional drive
  313.                     and path.
  314.  
  315.          <filespec> is a filename (no path, wildcards * and ? accepted)
  316.                     The wildcards work the same as in OS/2 commands.
  317.                     * stands for 0 or more characters
  318.                     ? stands for 1 character (0 or 1 when at the end)
  319.                     . is a character as all the others
  320.                     e.g.:  'dummy' does not match 'dummy.txt'
  321.                            'dummy*' matches 'dummy.txt'
  322.                            'du?mmy.txt' does not match 'dummy.txt'
  323.                            'dummy.txt?' matches 'dummy.txt'
  324.                            'du*y.txt' matches 'duy.txt'
  325.                            'du*?y.txt' does not match 'duy.txt'
  326.                            'du*?y.txt' matches 'dumy.txt'
  327.                            'du*y.txt' does not match 'duo.txt'
  328.  
  329.  
  330.          <areaspec> is the name of a file area. You can complete an
  331.                     area name with the '*' wildcard character.
  332.                     e.g.: *    means all areas
  333.                           WIN* means all areas that begin with WIN
  334.  
  335.          ...        means that you can list any number of items.
  336.                     You can use multiple lines if you want:
  337.                     Adopt WIN* SDN*
  338.                     is equivalent to:
  339.                     Adopt WIN*
  340.                     Adopt SDN*
  341.  
  342.          <access>   is a maximus privilege and keys access
  343.                     combination, e.g.
  344.                     Favored
  345.                     Favore/1A
  346.  
  347.          <num>      is an integer number
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.                                      Page  5
  360.  
  361.          A description of the allowed keywords follows:
  362.  
  363.                             Global Keywords
  364.  
  365.  
  366.          StatusLog <filename>      - The usual Binkley Style logfile.
  367.                                      Defaults to NUL.
  368.  
  369.          MaxPrm <filename>         - The Maximus parameter file to
  370.                                      use. Required.
  371.  
  372.          Adopt [<areaspec> ...]    - Areas where you want to adopt
  373.                                      orphans.
  374.  
  375.          NoAdopt [<areaspec> ...]  - Areas to be excluded from adoption.
  376.                                      Always exclude CD-ROM areas !
  377.  
  378.          RemMis [<areaspec> ...]   - Areas where you want to remove
  379.                                      descriptions of missing files
  380.  
  381.          NoRemMis [<areaspec> ...] - Areas to be excluded from
  382.                                      RemMis. Always exclude CD-ROMs !
  383.  
  384.          WrapCol [<num> [<num>]]   - Enables word wrapping of long
  385.                                      descriptions in file lists.
  386.                                      The optional <num> give the
  387.                                      left and right margins for word
  388.                                      wrapping (default to 0 and 79).
  389.                                      Suggested values: 31 and 79.
  390.  
  391.          AdoptExclude <filespec> ...
  392.                                    - Excludes the specified files
  393.                                      from adoption.
  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.                                      Page  6
  420.  
  421.                             Local Keywords
  422.  
  423.          The following keywords refer to the preceding ListPriv
  424.          statement: you can generate multiple file lists by using
  425.          multiple ListPriv statements followed by other "local"
  426.          statements.
  427.  
  428.          ListPriv <access>         - Access for current list
  429.  
  430.          ListAreas [<areaspec> ...]
  431.                                    - Areas to be listed (if they match
  432.                                      the <access> requirement).
  433.  
  434.          NoListAreas [<areaspec> ...]
  435.                                    - Areas to be excluded from current list.
  436.  
  437.          NewDays <num>             - Files newer than <num> days are
  438.                                      listed in NewFiles list. Def: 30
  439.  
  440.          NewHeader <filename>      - Header for NewFiles list.
  441.                                      Def: no header.
  442.  
  443.          NewFiles <filename>       - Output file for new-file list.
  444.                                      Def: no output file.
  445.  
  446.          AllHeader <filename>      - Header for AllFiles list.
  447.                                      Def: no header.
  448.  
  449.          AllFiles <filename>       - Output file for all-file list.
  450.                                      Def: no output file.
  451.  
  452.          OkHeader <filename>       - Header for OkFile.
  453.                                      Def: no header.
  454.  
  455.          OkFile <filename>         - Output file for OkFile
  456.                                      Def: no output file.
  457.  
  458.          OkMaxFiles                - Use MaxFiles.Idx for File
  459.                                      Requests instead of the complete
  460.                                      list of paths (BT 2.55 or
  461.                                      greater).
  462.  
  463.          MagicFile <filename>      - List of magics and wildcarded
  464.                                      filespecs to be resolved before
  465.                                      putting them in the OkFile.
  466.                                      FLM gets the most recent file for
  467.                                      each filespec and puts it in the
  468.                                      OkFile preceded by the Magic.
  469.                                      See the sample Magic.Lst.
  470.                                      Def: no magics.
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.                                      Page  7
  480.  
  481.          WrapCol [<num> [<num>]]   - Local WrapCol setting: see the
  482.                                      global WrapCol keyword.
  483.                                      Can be used with or without a
  484.                                      global WrapCol (in the latter case
  485.                                      the local margin values override the
  486.                                      global ones).
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.                                      Page  8
  531.  
  532.