home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / UTILITY / FLIST10.ARJ / FILELIST.DOC next >
Text File  |  1989-11-22  |  10KB  |  296 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                                  FileList v1.0
  11.  
  12.                      Copyright (C) 1989 by Brian McDaniel
  13.                          Documentation by Eric Golden
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.      FileList  is a  WWIV utility  which  creates  a master  listing of  your
  24.   directories. This  listing may then be  archived and put up  for downloads.
  25.   This  is very  handy and  your  users  will appreciate  the convenience  of
  26.   downloading a master listing. FileList has  the ability to count files, use
  27.   extended descriptions, create different lists of different directories, and
  28.   more. FileList is very configurable and flexible.
  29.  
  30.  
  31.  
  32.   Files Included With FileList v1.0:
  33.   ----------------------------------
  34.  
  35.  
  36.      FILELIST.DOC  -  Documentation File
  37.      FILELIST.EXE  -  Executable Program
  38.  
  39.  
  40.  
  41.   How to Use FileList:
  42.   --------------------
  43.  
  44.  
  45.      To  use FileList,  it must  be  placed  in the  WWIV directory.  This is
  46.   necessary because FileList must read the CONFIG.DAT file to determine where
  47.   the data directory is.
  48.  
  49.      When FileList is run, it outputs a list directly to the screen. In order
  50.   to capture  this listing to  a file,  the  DOS redirect switch  (>) must be
  51.   used. For example, the following command would create a listing of all your
  52.   files, and save it to the file "MASTER.LST":
  53.  
  54.      FILELIST > MASTER.LST
  55.  
  56.      After  the file  has been  saved, it  may be  copied to  a directory  or
  57.   archived for download.  Some examples on how to do  that are discussed near
  58.   the end of the documentation.
  59.  
  60.  
  61.  
  62.  
  63.  
  64.   Running FileList In Default Mode:
  65.   ---------------------------------
  66.  
  67.  
  68.      If  Filelist is  run without  parameters, it  will create  a master list
  69.   using the following rules:
  70.  
  71.  
  72.      1) It will not use Extended Descriptions.
  73.  
  74.      2) It will not count files.
  75.  
  76.      3) If  the  file  "FILELIST.DAT"  is  found  in  the  current directory,
  77.         FileList will use it as a configuration file.
  78.  
  79.      4) If  "FILELIST.DAT" is  not found  in the  current directory, FileList
  80.         will list  all directories except  Sysop, assuming the  filename used
  81.         for the Sysop directory is "SYSOP.DIR".
  82.  
  83.      5) If "HEADER.DAT" is found in  the current directory, FileList will use
  84.         it for a header file. The header text will be displayed at the top of
  85.         the  list.  Note  that  FileList  will  attempt  to read "HEADER.DAT"
  86.         regardless of parameters.
  87.  
  88.  
  89.  
  90.   Using Parameters With FileList:
  91.   -------------------------------
  92.  
  93.  
  94.      The following parameters may be used with FileList:
  95.  
  96.      FILELIST {FILENAME.EXT} {/CEN}
  97.  
  98.      Examples:
  99.  
  100.        C> FILELIST IBM.DAT /CE
  101.        C> FILELIST /N
  102.        C> FILELIST AMIGA.DAT /C
  103.  
  104.  
  105.      FILENAME.EXT is the name of  your configuration file. If a configuration
  106.   file is not specified, FileList will  look for one called "FILELIST.DAT" in
  107.   the current directory. If "FILELIST.DAT" is not found, FileList will run in
  108.   DEFAULT mode.
  109.  
  110.      The "/C" switch  will count the total files per  directory and the total
  111.   files listed in all of the directories.
  112.  
  113.      The "/E" switch will include extended descriptions.
  114.  
  115.      The "/N"  switch will NOT  use "FILELIST.DAT" if  it is found,  FileList
  116.   will  run  in  DEFAULT  mode.  Note  that  if  a  filename  is used for the
  117.   configuration file (even if it IS called "FILELIST.DAT"), FileList will use
  118.   that configuration file, regardless of the "/N" switch.
  119.  
  120.      These switches may be used in any order, preceded by a "/".
  121.  
  122.  
  123.  
  124.  
  125.  
  126.   How To Use A HEADER.DAT File:
  127.   -----------------------------
  128.  
  129.  
  130.      HEADER.DAT  is a  simple ASCII  text file.  There are several operatives
  131.   which may be used within this file to display text in various formats.
  132.  
  133.      {*DAY*}  - Display day of week (i.e. Saturday, Sunday, Monday)
  134.      {*DATE*} - Display date (i.e. May 10, 1989)
  135.      {*TIME*} - Display current time (i.e. 8:30pm)
  136.      {*L*}    - Left-justify text on following lines
  137.      {*R*}    - Right-justify text on following lines
  138.      {*C*}    - Center text on following lines (default)
  139.  
  140.      Note that the  day, date, and time operatives may  be used as many times
  141.   as necessary  within the text file,  however they may not  be duplicated on
  142.   the same line. If  they are, the first one will be  used and the second one
  143.   will  not be  interpreted. For  example, {*DAY*},  {*DAY*} would  print out
  144.   Thursday, {*DAY*}.
  145.  
  146.      The text formatting operatives will  only affect text on every FOLLOWING
  147.   line until  it reaches either the  end of the file  or a contradicting text
  148.   formatting  operative. Any  text  immediately  following a  text formatting
  149.   operative will  be ignored. Such operatives  may also not be  duplicated on
  150.   the same line. If they are, they  will both be ignored. Remember, it is not
  151.   necessary to use  a text formatting operative, it  will default to centered
  152.   text.
  153.  
  154.      Following  is a  sample HEADER.DAT  file followed  by the  text it  will
  155.   create:
  156.  
  157.      The nth Dimension
  158.      618-277-8502
  159.      {*L*}
  160.      WWIV Node @6851
  161.      {*R*}
  162.      Sysop: Brian McDaniel
  163.      {*C*}
  164.  
  165.      Listing of Downloadable Files
  166.      {*DAY*}, {*DATE*} at {*TIME*}.
  167.  
  168.  
  169.   -- The output would look like:
  170.  
  171.  
  172.   ╔═════════════════════════════════════════════════════════════════════════╗
  173.   ║                            The nth Dimension                            ║
  174.   ║                              618-277-8502                               ║
  175.   ║ WWIV Node @6851                                                         ║
  176.   ║                                                   Sysop: Brian McDaniel ║
  177.   ║                                                                         ║
  178.   ║                      Listing of Downloadable Files                      ║
  179.   ║                Wednesday, November 22, 1989 at 11:00pm.                 ║
  180.   ╚═════════════════════════════════════════════════════════════════════════╝
  181.  
  182.  
  183.  
  184.  
  185.  
  186.   How To Use A Configuration File:
  187.   --------------------------------
  188.  
  189.  
  190.      FILELIST.DAT (or  whatever you name  your config file)  is another ASCII
  191.   file. It is used to tell FileList  what to print as directory titles, which
  192.   directories to use, and in what order.
  193.  
  194.      The first line  in FILELIST.DAT is name of the  directory you would like
  195.   to print  first. The following line  is the filename of  that directory. Do
  196.   not use  extensions on this filename.  This goes on in  pairs until you are
  197.   finished listing directories.
  198.  
  199.   For example:
  200.  
  201.     Miscellaneous #1
  202.     MISC
  203.     Utilities #2
  204.     UTIL
  205.  
  206.  
  207.   -- The output would look like:
  208.  
  209.   ╔═════════════════════════════════════════════════════════════════════════╗
  210.   ║                            Farpoint Station                             ║
  211.   ║                             (618) 746-2703                              ║
  212.   ║                      Listing of Downloadable Files                      ║
  213.   ║                       Tuesday, November 14, 1989                        ║
  214.   ╚═════════════════════════════════════════════════════════════════════════╝
  215.  
  216.   ════════════════════════════╡ Miscellaneous #1 ╞═══════════════════════════
  217.  
  218.   AQUARIUM.ZIP:   38k :Watch the fish swim about on your screen
  219.   BACKTALK.ZIP:   10k :Your computer talks back to you.
  220.   BUGS    .ZIP:    3k :Crazy, bizarre, weird, screen-eating BUGS!
  221.             .
  222.             .  (continued...)
  223.             .
  224.   SQUAWK  .ZIP:   31k :This is hilarious!  Makes stupid video-game noises.
  225.   TRIVOICE.ZIP:    1k :Use three "voices" at once
  226.   WILDCLS .ZIP:    1k :Clears the screen in a different sort of way.
  227.  
  228.   ══════════════════════════════╡ Utilities #2 ╞═════════════════════════════
  229.  
  230.   2ZIP11  .ZIP:   33k :Convert ARC, PAK, and ZOO to "ZIP" format!  Excellent!
  231.   4DOS22  .ZIP:  222k :4DOS!  Replaces COMMAND.COM, versatile, AWESOME!
  232.   704K    .ZIP:    2k :Get 704K RAM in your PC
  233.             .
  234.             .  (continued...)
  235.             .
  236.   TED     .ZIP:   23k :PC Magazine's "Tiny Editor" - Brian loves it
  237.   THEFAST .ZIP:    3k :Speeds up ANSI screen writes on EGA systems!
  238.   Z-NOTE  .ZIP:   10k :Add ANSI comments/logos to your .ZIP files
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.   How To Integrate FileList With WWIV:
  246.   ------------------------------------
  247.  
  248.  
  249.      Once you have  experimented with various formats and  are satisfied with
  250.   the final results, you may then integrate  the list into WWIV. This is easy
  251.   to do. To use FileList as a daily event, it is best to create a small batch
  252.   file. This batch file may be called  when it is time for daily maintenence.
  253.   Run INIT to set the name and time for daily maintenence.
  254.  
  255.      A batch file might look like this:
  256.  
  257.      FILELIST > MASTER.LST
  258.      PKZIP FILES.ZIP MASTER.LST
  259.      COPY FILES.ZIP \BBS\DLOADS\TEXT
  260.      DEL MASTER.LST
  261.      DEL FILES.ZIP
  262.  
  263.      Or to simplify the batch file:
  264.  
  265.      FILELIST /CE > MASTER.LST
  266.      PKZIP -M DLOADS\TEXT\FILES MASTER.LST
  267.  
  268.      What you  want your list  to look  like,  how you want  it archived, and
  269.   where you put  the finished list is up  to you. For example, one  Sysop may
  270.   use FileList  twice to create two  different lists. One for  IBM files, and
  271.   one for  Amiga files. Because of  FileList's flexibility, the possibilities
  272.   are endless.
  273.  
  274.  
  275.  
  276.   Registering FileList v1.0:
  277.   --------------------------
  278.  
  279.  
  280.      FileList  v1.0 was  written by  Brian McDaniel  using Turbo  Pascal 4.0.
  281.   FileList was originally inspired from  LISTF, by Doug Fields. Documentation
  282.   for FileList was written by Eric Golden.
  283.  
  284.      If you use FileList on a regular  basis, please send a donation of $5 to
  285.   the author. Any comments, criticisms, or suggestions are welcome. Donations
  286.   will encourage future versions.
  287.  
  288.      Send donations or inquiries to:
  289.  
  290.  
  291.               Brian McDaniel                  The nth Dimension
  292.               201C Carlyle East               (618) 277-8502
  293.               Belleville, IL  62221           WWIV Node @6851
  294.  
  295.  
  296.