home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / RG_FDC12.ZIP / RG-FDC.DOC < prev    next >
Encoding:
Text File  |  1993-01-17  |  7.2 KB  |  185 lines
  1.  
  2.                File Description Cleaner v1.2 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 RG-FDC v1.2.  However, he cannot be
  10. responsible for any damages or other losses suffered as a result of running
  11. RG-FDC v1.2 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. RG-FDC v1.2 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 RG-FDC constitutes acceptance of the stated terms and conditions.
  23.  
  24. RG-FDC is NOT FREEWARE.  It is distributed under the concept of ShareWare.
  25. Users are allowed to try this program in its unregistered state for 30 days
  26. before paying for and registering with the author.  If, after 30 days, you
  27. decide that RG-FDC performs to your expectations, you are required by
  28. law to pay for and register your copy with the author. If the software does
  29. not meet your needs, and you do not plan on registering with the author
  30. after your 30 day trial period, you are to cease usage of RG-FDC. Continued
  31. use beyond the authorized evaluation period requires payment of the
  32. registration fee in full. Besides, it's only five bucks!
  33.  
  34.  
  35. What is RG File Description Cleaner?
  36. ------------------------------------
  37.  
  38.      Do you ever get tired of people who upload files with descriptions in
  39. all caps, or all lowers?  Some people use a weird mix of caps and lowers. It
  40. can really make a mess of your file directories.  Renegade File Description
  41. Cleaner will allow you to choose between several different standardized file
  42. descriptions and ensure that your file bases are kept in that format.  The
  43. easiest way to use RG-FDC is to put it in your nightly events.
  44.  
  45.      Renegade File Description Cleaner v1.2 is compiled with Turbo C++ and
  46. Turbo Assembler.  It is written in C and Assembly for optimum speed and
  47. performance.  RG-FDC v1.2 is fully network/multinode compatible, as well as
  48. Desqview friendly.
  49.  
  50.  
  51. How to use RG File Description Cleaner:
  52. ---------------------------------------
  53.  
  54.      Renegade File Description Cleaner v1.2 has 4 formats.  You must choose
  55. one of the four (-c, -l, -n, -u).
  56.  
  57. ___________________________________________________________________________
  58. 1) RG-FDC -c     The recommended "clean" mode.  All words will start with
  59.                  capital letters and have lower case following.  Also,
  60.                  version numbers (v1.2) will have a lower case v.
  61.  
  62.      EXAMPLE:
  63.  
  64.      This is the file description *TEST*
  65.  
  66.      becomes:
  67.  
  68.      This Is The File Description *Test*
  69. ___________________________________________________________________________
  70. 2) RG-FDC -l     Makes all letters lower case.
  71.  
  72. EXAMPLE:
  73.  
  74. This is the file description *TEST*
  75.  
  76. becomes:
  77.  
  78. this is the file description *test*
  79. ___________________________________________________________________________
  80. 3) RG-FDC -n     Makes the first letter of the first word in each sentence
  81.                  upper case.  All other letters are lower case.  This mode
  82.                  attempts to create "normal" english.  However, it is not
  83.                  entirely reliable, as it must rely on puncuation.  If the
  84.                  puncuation is not correct (which it often isn't) then the
  85.                  sentence will not be 100% correct.
  86.  
  87. EXAMPLE:
  88.  
  89. This is the file description *TEST*.  test #2.
  90.  
  91. becomes:
  92.  
  93. This is the file description *test*.  Test #2.
  94. ___________________________________________________________________________
  95. 4) RG-FDC -u     Makes all letters upper case.
  96.  
  97. EXAMPLE:
  98.  
  99. This is the file description *TEST*
  100.  
  101. becomes:
  102.  
  103. THIS IS THE FILE DESCRIPTION *TEST*
  104. ___________________________________________________________________________
  105.  
  106.      There are two optional switches that can be added in conjunction with
  107. the chosen format (-f, -q).  You may use one, both or neither.
  108.  
  109. RG-FDC -c -f    -f Activates fast mode.  Fast mode means that RG-FDC
  110.                    uses your existing *.dir files for all operations.
  111.                    No backup files are created.  Without -f, your old
  112.                    *.dir files are renamed to *.fdc and new "cleaned"
  113.                    *.dir files are created.  If anything goes wrong,
  114.                    you can rename the old *.fdc files.
  115.  
  116.  
  117. RG-FDC -c -q    -q Activates quiet mode.  This means that the user will
  118.                  not see the descriptions on the screen as they are
  119.                  "cleaned".  Only a base number will be displayed to
  120.                  give an indication of progress.
  121.  
  122.  
  123. What about special words?
  124. -------------------------
  125.  
  126.      A new feature in version v1.2 is RG-FDC.CAP.  This is a text file
  127. list of all words that you would like to have in all capital letters.
  128. Examples are "words" such as VGA, DOS, XXX, and so on.  You may add as
  129. many of these to the file, 1 per line, as you desire (or as much as your
  130. computer memory can handle).  RG-FDC.CAP is not case sensitive.  VGA can
  131. be included as vga, Vga, VGA...
  132.  
  133.      Keep in mind that the more special words you add to this file, the
  134. longer it will take RG-FDC to process your file descriptions.  RG-FDC.CAP
  135. must not be renamed, and needs to be located in your main BBS directory with
  136. RG-FDC.EXE.  If you do not want any special words, delete RG-FDC.CAP.  This
  137. feature is only active in -c, -l, & -n modes.  Also, try to prioritize the
  138. special words in RG-FDC.CAP with the most frequently used words at the top.
  139. This will slightly speed up the time it takes to process your file bases.
  140. If there is enough interest in this program (i.e. if I get several
  141. registrations) I will recode this feature with faster routines.
  142.  
  143.       EXAMPLE:
  144.  
  145.       RG-FDC.CAP contains           bbs
  146.                                     vga
  147.                                     new
  148.  
  149.      This is a new test of a vga bbs utility.
  150.  
  151.      becomes
  152.  
  153.      This is a NEW test of a VGA BBS utility.
  154.  
  155.  
  156. How do I register RG-FDC ?
  157. --------------------------
  158.  
  159.      Simply fill out register.frm which is included in this archive, and
  160. mail it along with $5 to
  161.  
  162.                                 Jack Brahce
  163.                                 PO Box  242
  164.                              Davison, MI 48423
  165.  
  166.  
  167.      Where do I get technical support, current versions, other Quality
  168. Renegade utilities or report suggestions/bugs?
  169. ----------------------------------------------------------------------
  170.  
  171.      Call
  172.                              The Shark's Mouth
  173.                               1-313-658-1110
  174.                              Fido  1:2240/108
  175.                      1200-19200   USR 14.4 Dual Standard
  176.  
  177.            FREQ  "rg-fdc"  for the latest File Description Cleaner.
  178.            FREQ  "qfile"  for the lastet Quality File Lister.
  179.  
  180.      New users have access to download my newest utilities on their
  181. first call.
  182.  
  183. ----------------------------------------------------------------------
  184.  
  185.