home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / QFILE11.ZIP / QFILE.DOC < prev    next >
Encoding:
Text File  |  1993-01-08  |  10.9 KB  |  273 lines
  1.  
  2.                          Qfile v1.1 Documentation
  3.                          ------------------------
  4.  
  5. Legal Stuff
  6. -----------
  7.  
  8. The author has taken every precaution to ensure that no harm or damage
  9. will occur on systems running Quality File v1.1.  However, he cannot be
  10. responsible for any damages or other losses suffered as a result of running
  11. Quality File v1.1 on your system.  The user assumes full responsibility for
  12. the proper use of this program, whether damage occurs as a fault of
  13. operator error or software error.
  14.  
  15. NO WARRANTIES ARE IMPLIED OR EXPRESSLY STATED.
  16.  
  17. Quality File and this documentation are copyrighted materials of Jack
  18. Brahce.  All rights to these materials are reserved, and are protected
  19. under United States and International Copyright Laws.  No part of these
  20. materials may be reproduced or modified in any way.
  21.  
  22. Use of Quality File constitutes acceptance of the stated terms and
  23. conditions.
  24.  
  25. Quality File is NOT FREEWARE.  It is distributed under the concept of
  26. ShareWare.  Users are allowed to try this program in its unregistered state
  27. for 30 days before paying for and registering with the author.  If,
  28. after 30 days, you decide that Quality File performs to your expectations,
  29. you are required by law to pay for and register your copy with the author.
  30. If the software does not meet your needs, and you do not plan on
  31. registering with the author after your 30 day trial period, you are to
  32. cease usage of Quality File.  Continued use beyond the authorized
  33. evaluation period requires payment of the registration fee in full.
  34. Besides, it's only five bucks!
  35.  
  36.  
  37. Why another Renegade file list utility?
  38. ---------------------------------------
  39.  
  40. I had been using an old Renegade File list with limited features for a
  41. short while, only to have it zip up my BBS .dat files (including my user
  42. list) and put them online for download!  That was enough of that program.
  43. So I went on a search for a new file list utility.  After trying the
  44. programs out there already, I was unable to find one that met my needs.
  45. What I did find was run time errors, single output styles, one list only
  46. output, lack of support for high drive letters, and so on and so forth.  It
  47. was time to sit down and whip out something on the order of the old
  48. Magnafile for Telegard!
  49.  
  50.  
  51. What does Quality File 1.1 offer?
  52. ---------------------------------
  53.  
  54. - Multiple config files, so that you can make as many different lists as
  55.   you desire.
  56.  
  57. - Multiple style options, so that you can choose the information that you
  58.   want to be in the output list.  All file status flags are supported
  59.   (OFFLINE, UNVALID, RESUME), as are extended descriptions, file name, file
  60.   size, file description, uploader name, upload date, and number of
  61.   downloads.
  62.  
  63. - File stats, so that you can see exactly how much you have where, in both
  64.   number of files and kbytes of files offline and online.
  65.  
  66. - Days old flag.  With this you can output a list of files a certain number
  67.   of days (selected by you) old.  Nice for new files lists for your users.
  68.  
  69. - Header file.  Put your own ASCII/ANSI bbs ad at the beginning of the list.
  70.  
  71. - File sharing/Multinode support.  You can generate lists even with a user
  72.   online (Renegade keeps several files open when a user is online).  This
  73.   means sysops running multinode systems will not have to shut down the BBS
  74.   to run automatic file lists in an event.
  75.  
  76. - Desqview aware.  Direct screen writes do not bleed through to your
  77.   other windows.
  78.  
  79. - Auto config file creation.  Simply type qfile and the name of the config
  80.   file you want, and if it does not exist, you will be walked through a
  81.   simple creation routine.  You DO NOT have to type in all the base names!
  82.   Additionally, the config file is text, so it can be easily edited.
  83.  
  84. - Written in C and Assembly with smart error checking.  If you make a
  85.   mistake editing a config file, Qfile will tell you what line the error is
  86.   on!  None of this RUN TIME ERROR stuff!
  87.  
  88. New in v1.1
  89. -----------
  90.  
  91. - Compressed output files with support for several popular archivers.
  92.  
  93. - More configurability in filebase stats.  Sysops can now choose to have
  94.   no stats at all if desired.
  95.  
  96. - File point ratio message is now an option.
  97.  
  98. - Config files are now created with full commenting for easier editing.
  99.  
  100. - Sysop definable ANSI color output.  Or, a default color scheme can
  101.   be selected.  You can now make color "new files" lists to be displayed
  102.   from Renegade as system bulletins.
  103.  
  104. - Sysops can now choose file points instead of file size.
  105.  
  106.  
  107.      If that isn't enough, tell me what else you want and I'll see if I
  108. can't add it into the next version.
  109.  
  110.  
  111. How do I use Qfile?
  112. -------------------
  113.  
  114.     To start Qfile, put the qfile.exe file in your main Renegade directory
  115. and type QFILE filename.cfg where filename.cfg is whatever you want to call
  116. your config file.  I recommend something descriptive, such as new.cfg for
  117. your 30 days or newer list, freq.cfg for your file requestable list, and so
  118. on.  Don't worry if the file does not exist, because if qfile does not find
  119. the requested config file, it will ask you if you want to create it.  Just
  120. hit Y for yes, and continue to create the config file.  You can use any
  121. file extension you choose, but it is best to be consistent so that Qfile's
  122. config files are easily remembered by you.
  123.  
  124.  
  125. How do I create the config file?
  126. --------------------------------
  127.  
  128.      From DOS type
  129.  
  130. c:> QFILE CONFIG.NAM
  131.  
  132.     Where CONFIG.NAM is whatever you want to call your config file.
  133.  
  134. 1) Enter the path and filename for the desired output file list.
  135.    Example: c:\renegade\myfiles.lst
  136.  
  137. 2) Enter the path and filename of your header file.  This is any ASCII file
  138.    that you would like to appear at the beginning of your file list.
  139.    If you do not want a header file, hit return to leave this line blank.
  140.    Example: c:\renegade\header.txt
  141.  
  142. 3) Enter (Y)es or (N)o to display the file point ratio at the top of the
  143.    list.  If you are not using file points, Yes will still not display the
  144.    message.
  145.  
  146. 4) Enter (Y)es or (N)o to compress your output file.  Qfile v1.1 can
  147.    compress a file using Pkzip, Arj, or Lharc.
  148.  
  149. 4a) If Question #4 is answered (Y)es, you will be prompted to choose your
  150.     compression type.  Enter 1, 2 or 3.
  151.  
  152. 4b) Enter the file name and path of your compressed file.  DO NOT put the
  153.     compression extension in as part if the file name.
  154.     Example: c:\renegade\mylist
  155.     BAD EXAMPLE: c:\renegade\mylist.zip
  156.                                    ^^^^ WRONG!
  157.  
  158. 5) Choose 1 or 2 line modes.  Valid input keys are 1 or 2 only.
  159.  
  160.    1 line mode looks like this:
  161.    filename.ext  size(or points)   file description
  162.  
  163.    2 line looks like this:
  164.    filename.ext  size   file description
  165.                  U/L  date  by  username    # of downloads
  166.  
  167. 6) Chose 1 or 2 to select what should be displayed on line 1, either
  168.    File Points or File Size.
  169.  
  170. 7) Enter Y or N, for Yes or No you do/don't want a blank line after each
  171.    file in the file list.  This makes things a little easier to read, but
  172.    on big lists wastes a lot of space when printing the list.
  173.  
  174. 8) Enter the maximum number of days old a file can be to appear in the
  175.    list.  If you want a list of ALL your files in the selected bases,
  176.    just hit return to leave this line blank.
  177.  
  178. 9) Enter Y or N for Yes or No that you DO/DON'T want file stats at the end
  179.    of your file list.  File stats are a base by base summary of the number
  180.    and size of files.  Both offline and online files are listed separately.
  181.  
  182. 10) Enter Y or N for Yes of No that you DO/DON'T want file stats at the
  183.     end of each individual file base.  Both offline and online totals for
  184.     number of files and size of files will be displayed.
  185.  
  186. 11) This line is for your registration number.  If you are just examining
  187.     this program and have not yet registered, leave this line blank.  (Just
  188.     hit return).  Otherwise, enter the number that I have mailed to you.
  189.  
  190. 12) Enter Y or N for Yes or No that you DO/DON'T want ANSI color in the
  191.     list.  If N is entered you will jump to 13).
  192.  
  193. 12a) If 12 was answered Yes, enter Y or N for Yes or No you DO/DON'T want to
  194.      use the default colors.  The default colors are just some I chose as
  195.      looking fairly decent.  Try it once and you will see the colors.
  196.  
  197. 12b) If 12a was answered No, you will now be asked to input your choices
  198.      for the colors of various parts of the list.  The valid values are
  199.      shown at the top.  A valid color must be entered in order to continue
  200.      on with the color selection.
  201.  
  202. 13) You will now be prompted to select the file bases to be included in this
  203.     file list.  Use the space bar to toggle bases to be included.  Any
  204.     blinking base name will be included in the list.
  205.  
  206.    The following keys are active:
  207.  
  208.    DOWN ARROW:  Will move you down the list.
  209.    UP ARROW:  Will move you up the list.
  210.    END:  Will move you to the end of the list.
  211.    HOME:  Will move you to the start of the list.
  212.    F1:  Will toggle all bases active.
  213.    RETURN:  Will end your base selection and write the config file.
  214.  
  215.    As already noted, simply toggle the bases you want on, and hit return
  216.    to end.
  217.  
  218.  
  219. What now?
  220. ---------
  221.  
  222.      Once your config file is created, you are ready to make the list!  If
  223. you have not yet registered, you will be annoyed by a 10 second delay
  224. screen during which you can do nothing.  All you need to do is type qfile
  225. and the name of the config file you just created.  This time, qfile will
  226. detect the config file and create your list!
  227.  
  228. EXAMPLE:  qfile myfiles.cfg
  229.  
  230.      Additionally, you can choose this time to create more config files!
  231.  
  232.  
  233. Editing a config file
  234. ---------------------
  235.  
  236.      Editing a config file is simple.  Just load the file into your
  237. favorite text editor.  Read the comments on the lines and find the area
  238. you wish to change, and make the appropriate change.  Make sure you save
  239. the file as an ASCII file when done.  I only recommend using this for
  240. a quick change.  For anything extensive, just delete the config file and
  241. use Qfile to make a new one.
  242.  
  243.  
  244. How do I register Qfile?
  245. ------------------------
  246.  
  247.      Simply fill out register.frm which is included in this archive, and
  248. mail it along with $5 to
  249.  
  250.                                 Jack Brahce
  251.                                 PO Box  242
  252.                              Davison, MI 48423
  253.  
  254.  
  255.  
  256.      Where do I get technical support, current versions, other Quality
  257. Renegade utilities or report suggestions/bugs?
  258. ----------------------------------------------------------------------
  259.  
  260.      Call
  261.                              The Shark's Mouth
  262.                               1-313-658-1110
  263.                              Fido  1:2240/108
  264.                      1200-19200   USR 14.4 Dual Standard
  265.  
  266.                    FREQ  "qfile" for the latest version.
  267.  
  268.      New users have access to download my newest utilities on their
  269. first call.
  270.  
  271. ----------------------------------------------------------------------
  272.  
  273.