home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / AVAILIST.ZIP / AVAILIST.PRN < prev    next >
Encoding:
Text File  |  1993-01-04  |  17.9 KB  |  428 lines
  1.      ----------------------------------------------------------------------
  2.                                                                          
  3.                             AvaiList Revision 1.10                        
  4.                   'A Master Files and New Files List Generator'           
  5.                           Compiled: February 6, 1989
  6.                                                                          
  7.                                      By:                                  
  8.                                Andrew D. Farmer                           
  9.                     FidoNet 1:163/115 - AlterNet 7:483/1.0                
  10.  
  11.  
  12.                AvaiList is Copyright (c) 1989 by Andrew D. Farmer         
  13.                          All rights strictly reserved.                    
  14.  
  15.      ----------------------------------------------------------------------
  16.  
  17.      --------------------
  18.       THE LEGAL BUSINESS 
  19.      --------------------
  20.  
  21.      AvaiList  is guaranteed to do nothing  except take up disk space.  Use 
  22.      it  at your own risk.  No warranty is stated or implied.   The  author 
  23.      shall  not  be responsible for any damages resulting  from  it's  use, 
  24.      directly or indirectly.
  25.  
  26.      AvaiList is distributed as a Freely Available Copyrighted Program,  no 
  27.      fee  may be charged for distribution and the distribution  archive  is 
  28.      not to be tampered with or altered in ANY way.
  29.  
  30.      AvaiList cannot be distributed in a modified form of any sort.
  31.  
  32.      Modified  Source  code, likewise, may NOT be distributed. If  you  are 
  33.      planning on porting the code to another operating system, or have code 
  34.      changes that you think are highly beneficial, then please contact  the 
  35.      author directly for assistance or guidance.
  36.  
  37.      While AvaiList is freely available for use in  non-corporate environs,
  38.      donations to the author will always be gratefully accepted.
  39.  
  40.      The  Author may be contacted at the 2 Network Addresses listed on  the 
  41.      Mast Head, or by surface mail as follows:
  42.  
  43.                             Andrew D. Farmer
  44.                             P.O.Box 11087 Station H
  45.                             Nepean, Ontario
  46.                             K2H 7T8  CANADA
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.      AvaiList Revision 1.10 Documentation                            Page 2
  57.  
  58.      -----------------------------------------
  59.       THE DISTRIBUTION ARCHIVE (ALST_110.ZOO) 
  60.      -----------------------------------------
  61.  
  62.      This archive should have included the following files:
  63.  
  64.      AVAILIST.DOC  -  The Documentation, formated for reading on screen.
  65.      AVAILIST.PRN  -  The Documentation, formated for printing.
  66.      AVAILIST.CFG  -  Sample Configuration File.
  67.      AVAILIST.EXE  -  The Executable Program.
  68.      ALST_SRC.ZOO  -  The Complete Source Code Archive.
  69.  
  70.  
  71.      --------------
  72.       WHAT IT DOES 
  73.      --------------
  74.  
  75.      AvaiList  is a program to generate 'Master' file lists and 'New'  file 
  76.      lists. It creates the lists based on information it finds in the files 
  77.      DIR.BBS and FILES.BBS in each of the file sub-directories.
  78.  
  79.      AvaiList DOES NOT need to be made aware of Opus style area numbers, it 
  80.      only  requires the paths to the file directories to be listed  in  the 
  81.      Configuration file (AVAILIST.CFG by default) and the presence of the 2
  82.      .BBS files.  AvaiList can, however, read the Opus System files  if you
  83.      desire.
  84.  
  85.      You may additionally have a 'Header' and 'Extra Info' file to be added 
  86.      to  the Master List, please refer to the Sections "Support Files"  and
  87.      "Command Line Syntax" for more information.
  88.  
  89.      AvaiList's  Screen  output is in the form of  Opus/Binkley  Style  Log 
  90.      Entries,  output may be redirected to a file to create a Log File  for 
  91.      later perusal, or to Nul to keep the screen clean.
  92.  
  93.      AvaiList needs about 64K of available memory, plus enough room to load
  94.      your selected Archiving utility, if you are using the Archive switch.
  95.  
  96.      ------------------------------------------------
  97.       THE CONFIGURATION FILE (DEFAULT: AVAILIST.CFG) 
  98.      ------------------------------------------------
  99.  
  100.      The AVAILIST.CFG is totally optional if you use the Opus System Files,
  101.      otherwise, it must only contain the paths to the file directories.  In
  102.      addition you may place within this file commands that replace/simulate
  103.      command line options. Every single option in the AvaiList.Cfg file may
  104.      also be  placed on the command line (except the Area Paths) and if  an
  105.      identical  option is placed BOTH in the file and on the  command line,
  106.      then the value on the command line will be used.
  107.  
  108.      The presence and usage of this file simply allows you to  pre-set your
  109.      command  line options in advance,  thus allowing you to avoid  90 mile
  110.      long command lines.
  111.      AvaiList Revision 1.10 Documentation                            Page 3
  112.  
  113.      If  you use  an AvaiList.Cfg  in conjunction  with a -R as  the  first
  114.      command  line switch,  AvaiList will ignore  the command line and  run
  115.      from pre-set Configuration only.
  116.  
  117.      You  may additionally select a  different name for your  Configuration
  118.      file by using the -R command line switch. Please Note: If you select a
  119.      different config file using -R ALL OTHER COMMAND LINE SWITCHES WILL BE
  120.      IGNORED.
  121.  
  122.      See the sample AvaiList.Cfg file for more information on its usage.
  123.  
  124.  
  125.      ---------------
  126.       SUPPORT FILES 
  127.      ---------------
  128.  
  129.      * DIR.BBS
  130.     
  131.        AvaiList  will search for this  file in each of  the specified  File
  132.        Area Sub-Directories.  The first line DIR.BBS is used for the Header
  133.        fo r that block  of Files.  If the DIR.BBS file  is not found in the
  134.        directory, then the Drive:\Path is used as the title.
  135.  
  136.      * FILES.BBS
  137.   
  138.        AvaiList  will search for this  file in each of  the specified  File
  139.        Area Sub-Directories.  The FILES.BBS is used as the list of Files to
  140.        place into the Master List.  If a FILES.BBS file is not found in the
  141.        directory, then 'No Files' is placed into the Master List.
  142.     
  143.        Each  Line  of  the Files.Bbs file is analyzed  separately,  if  the 
  144.        character in Column one (1) is a Hyphen (-) or  a Space ( ), and you
  145.        have NOT  used the -C command  line switch, then the  line is simply
  146.        copied wholesale into the Master List.  Otherwise the 1st contiguous
  147.        block  of characters is assumed to be the  File Name and the Rest of
  148.        the line is assumed to be the Description.  The lines will be Output
  149.        to the Master List in the form:
  150.  
  151.        FileName  Size-in-bytes  File-Date-Stamp  Description
  152.  
  153.        You  can  disable  the listing of File-Date-Stamp by  using  the  -D 
  154.        command line switch, see the section "Command Line Syntax" for  more 
  155.        information.
  156.  
  157.        If  the FileName does not exist in the directory, then  STORED  will 
  158.        appear  in  the Size-in-bytes area and OFF-LINE will appear  in  the 
  159.        File-Date-Stamp area. If you are using -D to suppress the File-Date-
  160.        Stamp, then non-existent files will be listed with the word  OFFLINE 
  161.        in the Size-in-bytes area.
  162.  
  163.  
  164.  
  165.  
  166.      AvaiList Revision 1.10 Documentation                            Page 4
  167.  
  168.        I  have also coded support for those that like to use  wildcards  in 
  169.        Files.Bbs files. If more than one file in the directory matches  the 
  170.        FileName  listed  in Files.Bbs, then the Master  List  will  contain 
  171.        separate  entries, including FileSize and DateStamp, for  each  file 
  172.        matching  the FileSpec. The single Description will be used for  ALL 
  173.        the matching entries.
  174.  
  175.      * AVAILIST.HDR
  176.  
  177.        AvaiList  will  search for this file in the  default  directory.  If 
  178.        found, the entire contents of the file will be placed at the Top  of 
  179.        the Master and NewFile Lists.
  180.  
  181.        You may select a different name (or directory) for the file by using
  182.        the H command line switch, or the HEADER Configuration keyword.
  183.    
  184.      * AVAILIST.EXI
  185.  
  186.        AvaiList  will  search for this file in the  default  directory.  If 
  187.        found,  the  entire  contents of the file will be  placed  into  the 
  188.        Master  List  between  the  the  AvaiList.Hdr  Information  and  the 
  189.        Directory-by-Directory Listings.
  190.  
  191.        This  file can be extremely handy for listing such things  as  magic 
  192.        file names or password restrictions.
  193.  
  194.        You may select a different name (or directory) for the file by using
  195.        the E command line switch, or the EXTRA Configuration keyword.
  196.  
  197.        Please note that this file WILL NOT be placed into NewFile Lists.
  198.  
  199.  
  200.      ---------------------
  201.       COMMAND LINE SYNTAX 
  202.      ---------------------
  203.  
  204.      Usage: AvaiList <-R> or <-Ooutfile plus Optional Switches>
  205.  
  206.      The  command Line switches may be placed in any order as long as  they 
  207.      are  prefixed with either a / or a - symbol. Switches Listed in  angle 
  208.      brackets are optional. If no switches are used, a Syntax Summary  will 
  209.      be  presented to you.  Any Switch,  except -R,  may be pre-set  in the
  210.      Configuration File.
  211.  
  212.      Switches are:
  213.  
  214.         *  -A<arc_cmd>
  215.     
  216.            This  turns Archive Mode On, it will cause the  finished  Master 
  217.            List,  and NewFile list if selected, to be Archived into an  Arc 
  218.            file  using  the  same trunk name as the Master  File,  and  the 
  219.            Extention of the Archiver Used.
  220.  
  221.      AvaiList Revision 1.10 Documentation                            Page 5
  222.  
  223.            The modifier 'arc_cmd' is one of the following: ARC, DWC, PKARC,
  224.            PKPAK, PAK or ZOO. If no 'arc_cmd' modifier is specified it will
  225.            default to using ZOO.
  226.  
  227.         *  -B
  228.  
  229.            Allows you to selct what sort of Box will be used in the  Output
  230.            lists. BoxType's 1 through 4 use IBM-PC characters, therefore to
  231.            disable the use of the IBM Extended Character set you must use a
  232.            BoxType of 0. The default BoxType is 4.
  233.  
  234.            BoxTypes are:
  235.  
  236.              0    1    2    3    4        0 = Hatches (Non-IBM)
  237.             ---  ┌─┐  ╔═╗  ╓─╖  ╒═╕       1 = Single Rule
  238.                  │ │  ║ ║  ║ ║  │ │       2 = Double Rule
  239.             ---  └─┘  ╚═╝  ╙─╜  ╘═╛       3 = Single Top, Double Sides
  240.                                           4 = Double Top, Single Sides
  241.  
  242.         *  -C 
  243.  
  244.            Comment Control Switch. If this switch is used,  then all of the
  245.            comments in Files.Bbs will NOT be copied to the Master List, but
  246.            instead will simply be ignored.  Note: Comments lines will NEVER
  247.            be included in the New File List.
  248.  
  249.         *  -D
  250.    
  251.            This switch turns OFF the listing of the Date for each file.  If 
  252.            this switch is not used, then the DOS Date for the file will  be 
  253.            automatically  placed in the Master and NewFile Lists. Use  this 
  254.            switch to disable that automatic addition. 
  255.  
  256.         *  -Efilespec
  257.    
  258.            Allows you to override the default 'Extra Info' File Name.
  259.  
  260.         *  -F<days>
  261.  
  262.            This  switch turns NewFile flagging on. If this switch is  used, 
  263.            all  files less than 7 days old will have an asterix (*)  placed 
  264.            beside its entry in the Master List.
  265.  
  266.            If  you plan on using the -N switch to create an output list  of 
  267.            New  Files, it should be noted that this (-F) switch is  a  pre-
  268.            requisite for use of the -N switch.
  269.  
  270.            The Optional modifier 'days' can be any number between 1 and 99. 
  271.            This sets the maximum number of days old a file can be and still 
  272.            get  flagged  as new. As stated above, the default  value  is  7 
  273.            days, use this modifier to change that default.
  274.  
  275.  
  276.      AvaiList Revision 1.10 Documentation                            Page 6
  277.  
  278.         *  -Hfilespec
  279.    
  280.            Allows you to override the default 'Header' File Name.
  281.  
  282.         *  -K
  283.  
  284.            By default,  any files that are listed in the Files.Bbs,  but do 
  285.            not reside in the directory are listed in the list  along with a
  286.            comment  that they are off-line.  If this switch is used,  those
  287.            'missing' files will simply be ignored, and not placed  into the
  288.            list in any form.
  289.  
  290.         *  -M
  291.  
  292.            When this switch is used in conjunction with the -A command,  it 
  293.            will  cause the finished Master List to be Moved to the  Archive 
  294.            instead  of  simply being added. In other words it  deletes  the 
  295.            original after Arcing.
  296.  
  297.         *  -Noutfile
  298.  
  299.            When  this switch is used in conjunction with the -F switch,  it 
  300.            causes an Output List of New Files to be created along with  the 
  301.            Master  List.  If this  Switch  is used,  the  'outfile'  is NOT
  302.            optional and must be provided for execution to occur.
  303.  
  304.            The  modifier  'outfile' can be either a simple  filename  or  a 
  305.            [drive:]\path\filename.
  306.  
  307.         *  -Ooutfile
  308.  
  309.            This  is the name of the file to use for generating  the  Master 
  310.            List.  This  Switch  is NOT optional and must  be  provided  for 
  311.            execution to occur.
  312.  
  313.            The  modifier  'outfile' can be either a simple  filename  or  a 
  314.            [drive:]\path + filename.
  315.  
  316.         *  -Q
  317.  
  318.            Causes  AvaiList to shut-up and be quiet.  If used, the 'Runtime
  319.            Configuartion' screen will NOT be presented to you.
  320.  
  321.         *  -R
  322.  
  323.            Causes  AvaiList to  ignore the  command line  and run  based on
  324.            Configuarion File information only. If used, this switch MUST be
  325.            the first command line switch &  ALL OTHER COMMAND SWITCHES WILL
  326.            BE IGNORED.
  327.  
  328.            By  default AvaiList will search for AvaiList.Cfg in the default
  329.            directory,  you may over-ride this by selecting a  Configuration
  330.            File directly following the R switch.
  331.      AvaiList Revision 1.10 Documentation                            Page 7
  332.  
  333.         *  -S
  334.  
  335.            Causes AvaiList to search the Opus System.Bbs Files for the Path
  336.            Information.  It will use ALL the areas it finds.  AvaiList will 
  337.            NEVER read Area 0, and will only search through the System files
  338.            until it detects a gap in the files (ie:  it will only  read the
  339.            System files one by one until it hits a number that doesn't have
  340.            a corresponding System??.Bbs file), this allows you to 'Hide' an
  341.            area, by placing a 'dead' area before it.
  342.  
  343.            NOTE:  The use of this switch will over-ride any 'Area' keywords
  344.            in the Configuration file.
  345.  
  346.            WARNING: This feature only suports Opus 1.03 style System files,
  347.            it should also support Opus 1.10 'decimal' system files. It will
  348.            NOT support Opus 1.10 Hexadecimal System Files.
  349.  
  350.         *  -T
  351.  
  352.            Causes  the total number of Files & Bytes in each area NOT to be
  353.            reported at  the end of that  area's listing in the Master List.
  354.            Default action WILL report these totals.
  355.    
  356.            This switch has no effect on any NewFile list being produced.
  357.  
  358.         *  -Z
  359.  
  360.            Allows  you to select what  identification character to  use for
  361.            flaging of NEW files. Default action is to use an asterix (*).
  362.  
  363.  
  364.      ------------------      EXIT ERRORLEVELS 
  365.      ------------------
  366.  
  367.      There are 6 possible ErrorLevels that AvaiList can return to DOS  upon 
  368.      program completion or abortion. They are as follows:
  369.  
  370.         *  ErrorLevel 5    -  Can't Open the Opus System Files
  371.         *  ErrorLevel 4    -  Unable to Write to NewFile Output File.
  372.         *  ErrorLevel 3    -  Unable to Write to Master Output File.
  373.         *  ErrorLevel 2    -  No File Area Paths were Specified.
  374.         *  ErrorLevel 1    -  Bad Command Line/Config File Syntax usage.
  375.         *  ErrorLevel 0    -  Successful Completion of AvailList.
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.      AvaiList Revision 1.10 Documentation                            Page 8
  386.  
  387.      -----------------------------
  388.       CREDIT, WHERE CREDIT IS DUE 
  389.      -----------------------------
  390.  
  391.      I would like to thank my Beta Team for AvaiList, they offered up thier
  392.      Hard Disks as sacrifice to this software!  Alphabetically they are:
  393.  
  394.            Scott Dudley ....... Kingston, Ontario ........ 1:148/314
  395.            Stephen Hendricks .. Perry Hall, Maryland ..... 1:261/1049
  396.            Tom Hendricks ...... Lutherville, Maryland .... 1:261/662
  397.            Bruce Miller ....... Ottawa, Ontario .......... 1:163/201
  398.            Dan Thomson ........ Ottawa, Ontario .......... 7:483/103
  399.            Ken Wilson ......... Ottawa, Ontario .......... 1:163/211
  400.  
  401.      A  special thanks to Dan "Sam" Thomson for all his timely reports  and 
  402.      ideas  on all my projects, they always came when I was ready to  throw 
  403.      in the towel.  Thanks, Sam ... for everything.
  404.  
  405.      ----------------
  406.       CLOSING NATTER 
  407.      ----------------
  408.  
  409.      I believe I have outlined everything in this documentation. I may have 
  410.      left  something  out,  and probably have. I expect  I'll  remember  an 
  411.      important one as soon as this release is on it's way through  Software 
  412.      Distribution ;-).
  413.  
  414.      If  you have any problems you can't fix or questions you can't  answer 
  415.      then  please contact me via NetMail or surface mail. I will always  do 
  416.      my best to support my software, but it is, by definition un-supported. 
  417.      I will answer queries as time allows, please be patient when  awaiting 
  418.      a reply.
  419.  
  420.      Thank You......and congratulations for reading all the way through the
  421.      documentation <Grin>.
  422.  
  423.      Andrew D. Farmer
  424.      Ottawa, Ontario, Canada
  425.      February 6, 1989
  426.  
  427.      ----------------------------------------------------------------------
  428.