home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / CEREBRUM / WWIVCMNT.ZIP / WWIVCMNT.DOC < prev    next >
Text File  |  1995-03-20  |  8KB  |  158 lines
  1. ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  2.   ██╗    ██╗ ██╗    ██╗ ██╗ ██╗   ██╗  ██████╗ ███╗   ███╗ ███╗   ██╗ ████████╗
  3.   ██║    ██║ ██║    ██║ ██║ ██║   ██║ ██╔════╝ ████╗ ████║ ████╗  ██║ ╚══██╔══╝
  4.   ██║ █╗ ██║ ██║ █╗ ██║ ██║ ██║   ██║ ██║      ██╔████╔██║ ██╔██╗ ██║    ██║
  5.   ██║███╗██║ ██║███╗██║ ██║ ╚██╗ ██╔╝ ██║      ██║╚██╔╝██║ ██║╚██╗██║    ██║
  6.   ╚███╔███╔╝ ╚███╔███╔╝ ██║  ╚████╔╝  ╚██████╗ ██║ ╚═╝ ██║ ██║ ╚████║    ██║
  7.    ╚══╝╚══╝   ╚══╝╚══╝  ╚═╝   ╚═══╝    ╚═════╝ ╚═╝     ╚═╝ ╚═╝  ╚═══╝    ╚═╝
  8. ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  9.                         A File Commenter for WWIV Sysops!
  10. ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  11.  
  12. What is WWIVCMNT?
  13. =================
  14.         WWIVCMNT is a handy utility that allows a WWIV sysop to periodically
  15. recomment all the files on his BBS.  It allows you to exclude certain
  16. directories from the commenting process.  You simply set the program up with
  17. a comment file, and tell it to go to town.
  18.  
  19. How Do I Set It Up?
  20. ===================
  21.         It couldn't be simpler.  Simply place WWIVCMNT.EXE in your WWIV
  22. directory, and type WWIVCMNT /C.  This enters the configuration mode.  You will
  23. be prompted for the filename of your comment file.  You can use the arrow keys
  24. to move around and find the one you want.  I reccomend setting this comment
  25. file up before hand.
  26.         You will then be asked if you want to process .ZIP and .ARJ files.
  27. This is entirely your option.
  28.         Finally, you'll be asked if you want to set up an exclusion file.  The
  29. exclusion file is a listing of all directories on your BBS.  Those that, for
  30. some reason or another, you don't want files commented in, will be listed in
  31. square brackets.([])  Any listed without the brackets will be commented.
  32.  
  33. How Do I Run It?
  34. ================
  35.         To run WWIVCMNT, simply go to your WWIV directory and type WWIVCMNT.
  36. This processes all directories using the information (comment file, etc)
  37. indicated in WWIV.INI.  If you want to register WWIVCMNT with your unique
  38. registration code (hint, hint!), then type WWIVCMNT /R.  If you want to use an
  39. exclusion file for WWIVCMNT, type WWIVCMNT /E<FILENAME>.  And if you want to
  40. use a different comment file than is set in defaults, use the /F<FILENAME>
  41. parameter.  In addition, you can specify a single directory by either
  42. the directory filename as listed in DIREDIT (use the /D parameter) or by
  43. the directory number as listed in DIREDIT (use the /S parameter).
  44.         You can abort the commenting process at any time by hitting a
  45. key while it's processing files.
  46.  
  47.         To summarize:
  48.  
  49. WWIVCMNT                : Runs WWIVCMNT with default options on all directories
  50. WWIVCMNT /C             : Configures WWIVCMNT
  51. WWIVCMNT /R             : Registers WWIVCMNT
  52. WWIVCMNT /E<FILENAME>   : Uses <FILENAME> as the exclusion file
  53. WWIVCMNT /F<FILENAME>   : Uses <FILENAME> as the comment file.
  54. WWIVCMNT /D<DIRNAME>    : Runs WWIVCMNT on a single directory, specified by the
  55.                           filename as listed in DIREDIT.
  56. WWIVCMNT /S<DIRNUMBER>  : Runs WWIVCMNT on a single direcotry, specified by the
  57.                           directory number as listed in DIREDIT.
  58.  
  59.         The /E and /F commands can be used with each other.  Likewise,
  60.         the /D and /S parameters can be used with /F.
  61.  
  62. History of WWIVCMNT
  63. ===================
  64.         I've really found it amazing how long comments can stick around.  I was
  65. bored one day and wanted to play a computer game, and when I unarchived, I
  66. found a VERY old comment from my BBS.  I'd like to be able to occasionally
  67. re-comment my files, or ensure that they have been commented, but having to
  68. write and keep updating a batch file can be a royal pain.  So I decided to sit
  69. down and write WWIVCMNT.  It's probably not the most efficient code in the
  70. world, and it can be kinda slow, especially on BIG files, but it's all
  71. automatic, and you've got a fair amount of control over it.
  72.  
  73. ■ v. 0.90 (1/30/95)
  74.         First basic version.  Simply commented files.  No automatic
  75.         configuration.  No command line parameters.  Not released.
  76.  
  77. ■ v. 1.00 (2/16/95)
  78.         First beta version to be tested.  Added easier configuration.
  79.         Added ability to use exclusion files and seperate comment files.
  80.  
  81. ■ v. 1.01 (2/27/95)
  82.         Second Beta version.  Added ability to comment single directory
  83.         (as requested by Fish (1@6115.WWIVNet)) and the ability to abort
  84.         the process (also requested by Fish)
  85.  
  86. ■ v. 1.10 (03/20/95)
  87.         First release version.
  88.  
  89.  
  90.  
  91. How Do I Register?
  92. ==================
  93.         WWIVCMNT isn't going to cost much.  It's pretty cheap.  I should charge
  94. more for it, because it was a fair amount of work, and it did cause me to fall
  95. behind some at work, since I was having too much fun working on this program.
  96. However, I was having fun, I did learn a lot, and it was a slow week at work.
  97. So I decided to only charge $5 for this program.  To register, please fill out
  98. REGISTER.FRM and send it, along with the registration fee, to the address
  99. listed in there.
  100.  
  101. Legalese
  102. ========
  103.         WWIVCMNT is copyrighted (c) 1995 by Craig Dooley and BatMage
  104.         Software.  This software is released "as is" and no guarantees,
  105.         either written or implied, are made regarding the performance of
  106.         WWIVCMNT.  Under no circumstances are Craig Dooley or BatMage
  107.         Software to be held responsible for any damages, real or
  108.         imagined, that occur as a result of the usage of WWIVCMNT.
  109.  
  110.         WWIVCMNT is Shareware.  You are allowed to run this program for a
  111.         period of 15 days for trial purposes.  At the end of those 15
  112.         days, you must either register WWIVCMNT or stop using it.
  113.  
  114.         You are encouraged to upload WWIVCMNT to any online service or
  115.         Bulletin Board, and to distribute copies to your friends.  The
  116.         original archive must be kept intact, and no changes may be made
  117.         to the documentation or the executable files contained within.
  118.  
  119. Contacting the Author
  120. =====================
  121.         You may contact the author in a variety of different ways.  I
  122.         can be reached at the following e-mail addresses:
  123.                 1@6100.WWIVNet
  124.                 1@8315.Icenet
  125.                 1@8315.Terranet
  126.                 1:376/126 [FIDONET]
  127.                 morgul@ttps.lakes.trenton.sc.us [Internet]
  128.  
  129.         I can also be reached at my bulletin board, The Trading Post [SOUTH]
  130.         at (803) 731-0690.  Supporting baud rates up to 28.8 bps.
  131.  
  132.         I can also be reached at the address listed in the REGISTER.FRM
  133.         file included within.
  134.  
  135.         If you've got any comments, suggestions, or ideas, please don't
  136.         hesitate to get in touch with me!
  137.  
  138.  
  139. Thanks go to:
  140. =============
  141.    Thanks go to the following people:
  142.  
  143.         Wayne Bell, author of the WWIV BBS software,
  144.                 without whom this program would be worthless!
  145.  
  146.         Fish (1@6115.WWIVNet) for beta testing the program on
  147.                 his BBS and giving me some ideas and suggestions.
  148.  
  149.         Mark Gilbert, my boss, for not finding out what I was
  150.                 working so hard on my computer at work!
  151.  
  152. =============================================================================
  153.                 WWIVCMNT! Copyright (c) 1995 BatMage! Software!
  154. =============================================================================
  155.  
  156.  
  157.  
  158.