home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / SYSOPS.ZIP / QWIKLIST.ZIP / QWIKLIST.DOC < prev    next >
Text File  |  1995-05-24  |  11KB  |  246 lines
  1.                         Qwik-List v1.13 Documentation
  2.                      ==================================
  3.  
  4.                                 DISCLAIMER
  5.                                 ----------
  6.     This program is guaranteed to do nothing more than take up space.
  7.     By using this software, you the user, agree that any coincidental
  8.     damage arising from its use or misuse is the sole responsibility
  9.     of the user and not of the authors.  This program was designed with
  10.     a single purpose in mind and we are reasonably sure that it does
  11.     nothing more than what we claim. 
  12.           
  13.   Note:   I have included LIST.COM which Qwik-List calls for when you 
  14.           choose to view the created listing.  LIST.COM is also shareware 
  15.           and requires registration by the user with its authors.
  16.  
  17.           This program requires that you already have one or more of the
  18.           supported compression utilities installed on your system somewhere
  19.           in your DOS path or in the same directory that you will install
  20.           Qwik-List v1.13.  If Qwik-List cannot locate any of your 
  21.           compression utilities, it will not attempt to extract anything.
  22.           
  23.  ==========================================================================
  24.               This program was compressed with COMPACK v4.5
  25.               ---------------------------------------------
  26.  
  27. How to use:
  28. ------------
  29.  
  30.   1. Qwik-List depends upon your decompression utilities to exist in
  31.      either the same directory in which IDFILER.EXE resides or to be 
  32.      somewhere in your DOS path.  It will not extract descriptions if 
  33.      otherwise.
  34.  
  35.   2. When the program starts, you are given a menu of options that can
  36.      be modified to suit your needs.  Simply choose the command letter for
  37.      the setting(s) that you wish to change.  When you have completed your
  38.      setup you can press ENTER to begin processing or ESCAPE to abort.
  39.  
  40.   3. Here is a brief description of each menu option and its use:
  41.  
  42.      [S] Source drive:\path     : 
  43.  
  44.         This line is your drive letter and path of the directory of files
  45.         that you wish to process.  It must be in the format of:
  46.         [drive letter]:\[directory name] such as C:\DOS.  Qwik-List
  47.         will ignore any entry that does not contain the colon and slash.
  48.  
  49.      [T] Target drive:\path     : 
  50.  
  51.         This line is your drive letter and path of the directory that you
  52.         wish Qwik-List to do its processing and to write the output file
  53.         listing.  The syntax is the same as Source drive:\path.
  54.         Pressing ENTER on this line while blank will use the identical
  55.         drive and path as the Source drive and path.
  56.  
  57.      
  58.      
  59.      
  60.      
  61.      [F] File name to create    :
  62.  
  63.         This line contains the filename of your output file listing.
  64.         It can be any name you wish.  This option is not available until
  65.         Qwik-List is registered.
  66.      
  67.      [N] Name of File-Insert    :
  68.  
  69.         This is a text file or any other file of your choosing.
  70.         It can be an advertisement for your BBS, an announcement of some 
  71.         kind or whatever you wish.   When File-Insert Mode is turned on, 
  72.         Qwik-List will compress this file into each of your archived  
  73.         files.
  74. ** NOTE ** 
  75.         The filename must be L00K-AT.ME! in the unregistered version and
  76.         must exist in the same directory as QWIKLIST.EXE to use this feature.
  77.         Once registered, the filename can be anything you choose.
  78.  
  79.      [H] Header at top of list  : ON/OFF
  80.  
  81.         This toggles the header (heading printed at the top of each output
  82.         file) on and off.  This option is not available until Qwik-List
  83.         is registered.
  84. ** NEW **  
  85.         You can design your own file list header after you have registered     
  86.         Qwik-List.   The header must be a standard text file and the
  87.         filename must be QWIKLIST.HDR.
  88.  
  89.      [1] Include File Size      : ON/OFF
  90.  
  91.         Toggles whether to list the file size for each file in the output
  92.         file listing.
  93.      
  94.      [2] Include File Date      : ON/OFF
  95.  
  96.         Toggles whether to list the file date for each file in the output
  97.         file listing.
  98.      
  99.      [3] Include Descriptions   : ON/OFF
  100.  
  101.         Toggles whether to list the description for each file in the output
  102.         file listing.
  103.      
  104.      [+] Append Output File     : ON/OFF
  105.  
  106.         This toggle gives you the option of appending the list you are about
  107.         to create onto the end of an existing file list.  The output file
  108.         name must be the same as the existing file for this feature to work.
  109.         See also "[@] Sub-Directories  : ON/SORT/OFF"  below
  110.  
  111.      [C] Compressed Files Only  : ON/OFF
  112.  
  113.         This toggles whether or not you want ALL of the files in the source
  114.         directory to be listed or only the .ZIP .ARJ and .SDN files.
  115.  
  116.      [I] Interactive Mode       : ON/ALL/OFF
  117.  
  118.         This toggles the Interactive mode.  The interactive mode, when turned
  119.         on, will prompt you to manually enter a one line description for a
  120.         file when none was found within the archive.
  121.         ALL mode will let you edit the DIZ/SDI of each file.
  122.         ** This feature is disabled if KWIKDIZ.EXE is not found in your path.
  123.  
  124.      [A] Auto-Add descriptions  : ON/OFF
  125.  
  126.         Used in conjuction with Interactive Mode.  When this option is turned
  127.         on, it will add the manually entered description into the compressed
  128.         file for future use.  Auto-Add will not work without Interactive Mode
  129.         on so by toggling this feature Qwik-List automatically turns
  130.         Interactive Mode.
  131.      ---*** Qwik-List WILL NOT violate the "security envelope" of .SDN
  132.             or .ARJ files and will simply ignore this command when coming
  133.             across a "sealed" SDN or ARJ file.
  134.         ** This feature is disabled if KWIKDIZ.EXE is not found in your path.
  135.      
  136.      [M] Move Undescribed Files : ON/OFF
  137.          This toggles whether to move the files without descriptions to the
  138.          target directory.  This feature only works if the Source path and
  139.          the Target path are different.
  140.  
  141.      [$] Strip High ASCII       : ON/OFF
  142.  
  143.         This toggles the stripping of characters such as those used in  
  144.         bordering and in some text artwork.  Many BBS's cannot or will
  145.         not strip these for you so it is useful to strip them when making
  146.         your list file.
  147.  
  148.      [P] Pack File-Inserts     : ON/OFF
  149.      
  150.         This command toggles the Jumk-Mail Mode.  File-Insert is a
  151.         feature that allows you to compress one of your own files
  152.         (text file advertisement, for example) into each of the files in
  153.         your source directory during processing.  
  154.         ** NOTE ** This feature is disabled if Qwik-List cannot find
  155.                    the File-Insert filename in the current directory.
  156.         ** The filename must be L00K-AT.ME! in the unregistered version.
  157.      ---*** Qwik-List WILL NOT violate the "security envelope" of .SDN
  158.             or .ARJ files and will simply ignore this command when coming
  159.             across a "sealed" SDN or ARJ file.
  160.  
  161.      [@] Sub-Directories       : ON/SORT/OFF
  162.  
  163.         This switch works in relation to the Append File List function.
  164.         If this switch is on and Append File List is OFF then Qwik-List
  165.         will create separate file listings for each directory in the
  166.         target directory.
  167.         If this switch is on SORT, Qwik-List will put each individual
  168.         file list in its corresponding source directory.
  169.         
  170.      [/] Save Configuration
  171.  
  172.         This option saves the current configuration to the file QWIKLIST.SET
  173.         in the current directory.  If QWIKLIST.SET does not exist, this
  174.         command will create it automatically.
  175.      
  176.  
  177.  
  178. What does Qwik-List do?
  179. --------------------------
  180.  This program searches the supported archive type (.ZIP, .ARJ, .SDN, .ARC,
  181.  .LZH, .LHA, .RAR, .PAK) in the specified directory for the files 
  182.  FILE_ID.DIZ or DESC.SDI (and SDN.ID. in .SDN files). 
  183.  These are description files found in most compressed files describing 
  184.  the archived program.  Qwik-List extracts this description file and 
  185.  reads it. It then writes the description to a text file of your choosing 
  186.  which will contain the complete listing of every .ZIP and .ARJ file in the 
  187.  specified directory along with their descriptions.  The text file can be 
  188.  used for importing files into a BBS database, CD-ROM Door, or can simply 
  189.  be used as a catalog listing of your archived collections.
  190.  
  191.  This version also reads the internal descriptions found in .MOD sound files.
  192.  
  193.  If Qwik-List finds a text file by the same filename as chosen
  194.  at startup in the target path, it will rename it with a .OLD extension
  195.  during operation and then will restore the original file name when finished.
  196.  
  197.  This program is very simple and has much room for improvement and change
  198.  so try it out and then give me all of your suggestions, comments, and
  199.  ideas.  I will do what I can to incorporate your ideas into future versions.
  200.  
  201.  
  202.  
  203.  
  204.    This version of Qwik-List is SHAREWARE.  This means that you can 
  205.    try it out for a period of time and then either pay me for it or 
  206.    discontinue using it. It is unlawful to continue using shareware programs 
  207.    after the initial demo period.   
  208.             *  THE DEMO PERIOD FOR "Qwik-List" IS 30 DAYS.  *
  209.  
  210.   If you enjoy this program and would like to continue using it then please 
  211.   register it.
  212.  
  213.   Send $25.00 to:   Kevin Smith
  214.                     1403 E. Elm #9
  215.                     Springfield, MO.  65802
  216.                     ------------------------
  217.     You will also receive a free registration key for Kwik-Diz v1.x
  218.  
  219.   Credit Cards are not accepted by the BBS at this time.
  220.  
  221.       A registered code will be generated in your name within 24 hours
  222.       of receipt of your payment and will be made available to you from 
  223.       GadgetSoft Solutions BBS. 
  224.       
  225.       If you do not want to get your code from the BBS, I can either send 
  226.       it to you by US Mail, by a voice telephone call or I can send the 
  227.       code to you by Fido NETMAIL.
  228.       
  229.       When you register Qwik-List you are entitled to and will receive
  230.       free minor upgrades to the software as well as 1/2 price on all future  
  231.       major releases of this program as well as any of our other products.
  232.  
  233.  
  234.  
  235.  
  236. **  For product support, suggestions or bug reports contact:
  237.  
  238.              Kevin Smith  
  239.              Sysop of GadgetSoft Solutions BBS         
  240.              Springfield, MO. 65802         
  241.              
  242.              BBS : (417) 865-7386 
  243.            Voice : (417) 865-0974
  244.         Fido-Net : (1:284/79)  GadgetSoft Solutions BBS
  245.                       
  246.