home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / CEREBRUM / DFRAG320.ZIP / DEFRAG.DOC next >
Text File  |  2000-03-18  |  18KB  |  411 lines
  1.  
  2.  
  3.             ▒▒▒▒▒▄  ▒▒▒▒▒▒▄ ▒▒▒▒▒▒▄ ▒▒▒▒▒▒▄ ▒▒▒▒▒▒▄ ▒▒▒▒▒▒▄ 
  4.             ▒▒█▀▒▒█ ▒▒█▀▀▀▀ ▒▒█▀▀▀▀ ▒▒█▀▒▒█ ▒▒█▀▒▒█ ▒▒█▀▀▀▀  
  5.             ▒▒█ ▒▒█ ▒▒▒▒▒▄  ▒▒▒▒▒▄  ▒▒▒▒▒█▀ ▒▒▒▒▒▒█ ▒▒█▒▒▒▄  
  6.             ▒▒█ ▒▒█ ▒▒█▀▀▀  ▒▒█▀▀▀  ▒▒█▀▒▒▄ ▒▒█▀▒▒█ ▒▒█ ▒▒█  
  7.             ▒▒▒▒▒█▀ ▒▒▒▒▒▒▄ ▒▒█     ▒▒█ ▒▒█ ▒▒█ ▒▒█ ▒▒▒▒▒▒█   
  8.              ▀▀▀▀▀   ▀▀▀▀▀▀  ▀▀      ▀▀  ▀▀  ▀▀  ▀▀  ▀▀▀▀▀▀   
  9.  
  10.                    ▒▒▒▒▒▒▒▄     ▒▒▒▒▒▒▒▄  ▒▒▒▒▒▒▒▄
  11.                     ▀▀▀▀▒▒█      ▀▀▀▀▒▒█  ▒▒█▀▀▒▒█
  12.                      ▒▒▒▒▒█     ▒▒▒▒▒▒▒█  ▒▒█  ▒▒█
  13.                      ▀▀▀▒▒█     ▒▒█       ▒▒█  ▒▒█
  14.                    ▒▒▒▒▒▒▒█ ▒▒▄ ▒▒▒▒▒▒▒▄  ▒▒▒▒▒▒▒█
  15.                     ▀▀▀▀▀▀▀  ▀▀  ▀▀▀▀▀▀▀   ▀▀▀▀▀▀▀
  16.  
  17.  
  18.                 A Quality WWIV Utility Release From Cerebrum
  19.  
  20.                                    and
  21.  
  22.                            Lawrence C. Bensinger
  23.                                (a.k.a. Dawg)
  24.  
  25.                               #1 @2121  WWIVnet
  26.                               #1 @122   FILEnet 
  27.  
  28.                              dawg@mindspring.com
  29.                        http://www.mindspring.com/~dawg
  30.  
  31.  
  32.  
  33. i. Contents, or "How do I find anything in this file?"
  34.  
  35.      The following outline may help you find the information you need a little
  36. faster:
  37.  
  38.      i. Contents, or "How do I find anything in this file?"
  39.     ii. Introduction and Shareware Information
  40.      I. System Requirements, or "What's the LEAST I can get by with!?"
  41.     II. Disclaimers, or "Whose fault is it?"
  42.    III. Getting Started or "Screw the docs, what do I DO!?"
  43.     IV. DEFRAG.EXE and WWIV.INI what's what?
  44.      V. What is DEFRAG?, or "What's it do?"
  45.     VI. How does DEFRAG work?, or "How's it do that?"
  46.    VII. Registering DEFRAG, or "A Plea for Money"
  47.   VIII. Running DEFRAG.EXE
  48.     IX. Running DEFRAG.EXE revisited, or "What are my options?"
  49.      X. Warnings, or "Why did I DO that!?"
  50.     XI. Copyright Information, or "Who owns what?"
  51.    XII. Revision History/Information/New Features (moved to history.doc)
  52.   XIII. Personal Stuff About the Author and How to Reach Him
  53.  
  54.  
  55.  
  56. I.  System Requirements, or "What's the LEAST I can get by with!?"
  57.  
  58.      DEFRAG v3.20 REQUIRES that you be running WWIV version 4.30 or higher.
  59. Version 3.20 of DEFRAG will NOT work with any versions of WWIV previous to
  60. v4.30, unless you specifically tell it to do so.
  61.  
  62.      DEFRAG also requires that you be running WWIV on an IBM PC/XT/AT
  63. (including 386's & 486's) or compatible system.  Color monitors are supported
  64. (in text mode), but since the colors are "acceptable", I've never bothered to
  65. change them to look all that nifty.  It ain't broke, so I ain't fixed it.
  66.  
  67.      As far as RAM is concerned, DEFRAG will--at a bare mininum--need at LEAST
  68. 32k of free memory to work its magic.  That number (32k) is for ONE message
  69. base.  Depending on how many message bases you have, this number will go UP by
  70. about 4-15k for each extra sub.  If there is not enough free memory, DEFRAG
  71. will abort and let you know that it couldn't grab enough memory.  If you get
  72. such a message, try removing TSRs and other programs, or, if you are trying to
  73. run DEFRAG under WWIV while shelled to DOS (as a chain or by pressing
  74. Shift-F10 or F at WFC), [Q]uit the BBS and try running DEFRAG all by itself
  75. with WWIV out of memory.
  76.  
  77.     DEFRAG also requires that you have at LEAST twice as much free disk space
  78. as your largest message base.  So, if you have 64 subs, and one of them is
  79. 700k, you will probably need 1.4 megs of free disk space for DEFRAG to operate
  80. properly.  (Please note that this is a liberal guesstimate -- you may find
  81. that you only need AS MUCH extra space as your largest sub, not necessarily
  82. twice as much...or you may find that you only need half as much extra space --
  83. it all depends on how many subs, what's in them, and if and when you ever
  84. DEFRAG'ed them).
  85.  
  86.  
  87.  
  88. ii.  Introduction and Shareware Information
  89.  
  90.      The purpose of DEFRAG is simple -- to defragment the message bases and
  91. e-mail files to remove unused (or "dead") space and allow faster message
  92. reading from disk, as well as to attempt to repair damaged messages.  As a
  93. by-product of good code-writing, DEFRAG will usually also repair certain
  94. problems with message bases and EMAIL.DAT, including the "exploding" EMAIL.DAT
  95. problem people seem to be having recently.
  96.  
  97.  
  98.          **   DEFRAG  is submitted to  the general public  as   **
  99.          **   Shareware.   As such,  you are granted a 30-day   **
  100.          **   trial  usage  period,   after  which  you  must   **
  101.          **   register  DEFRAG  with the author,  or you must   **
  102.          **   discontinue  using it.  Please see Section VII,   **
  103.          **   "Registering DEFRAG" (or the file REGISTER.DOC)   **
  104.          **   for further discussion  of your rights  to this   **
  105.          **   software.                                         **
  106.  
  107.  
  108.  
  109. II. DISCLAIMERS, or "Whose fault is it?"
  110.  
  111.  
  112.      The compiled program DEFRAG and the documentation are pro-
  113.      vided AS IS, with no warranty or personal guarantee.  I am
  114.      not responsible for any damage this program does to your
  115.      system or your data files.  For that reason, BACK UP YOUR DATA
  116.      before running DEFRAG, at least the first time.
  117.  
  118.  
  119.  
  120. III. Getting Started or "Screw the docs, what do I DO!?"
  121.  
  122.      For the basic user, the command DEFRAG on the DOS command line will do
  123. all the message bases.  DEFRAG /E+ will include the e-mail file (EMAIL.DAT) as
  124. well.  Other, more specialized options are outlined below.
  125.  
  126.  
  127.  
  128. IV. DEFRAG.EXE and WWIV.INI what's what?
  129.  
  130.  
  131.      The other thing that will be accomplished the first time you run DEFRAG
  132. is that it will add itself to your WWIV.INI file.  The following is what is
  133. added:
  134.  
  135. [Defrag]
  136. Reg_Num                = 0
  137. Reg_Key                = 0
  138. Version                = 3.19ß
  139. Logging                = Yes
  140. Defrag_Email           = No
  141. Sound                  = Yes
  142.  
  143. These are the default values.  I personally have Defrag_Email turned on;
  144. however since the program's prior behavior was to ignore email.dat by default
  145. I chose to have it continue to do so.  Two things to note here.  First is that
  146. if you use any of the command line switches below they *WILL* override any
  147. settings from WWIV.INI.  Secondly is that to change values simply edit
  148. WWIV.INI; however you can use the command "DEFRAG REGISTER" just like that to
  149. enter your registration information.  Considering that of the remaining four
  150. options, one is an informational item and the other three are yes/no toggles
  151. I saw no point in adding those.  I *may* add these settings to the editor
  152. in WWIVsys, but until I update it for WWIV 4.30 I don't know.
  153.  
  154.  
  155. V. What is DEFRAG?
  156.  
  157.      DEFRAG is a utility used to defragment WWIV Message Bases that use
  158. Storage Type 2 or Storage Type 5 (by modification only, unless WSS gets it
  159. into WWIV v4.24+), as defined in BOARDEDIT.  (For quick reference, Type 2 is
  160. the type where all the messages are stored in one file in 512-byte blocks, and
  161. Type 5 is the type where all messages are stored sequentially.  Type 5 storage
  162. has NOT been implemented in WWIV yet, but the structure IS there.)
  163.  
  164.  
  165.  
  166. VI. How does DEFRAG work?
  167.  
  168.      DEFRAG begins by reading CONFIG.DAT, which tells it where all your
  169. messages are being stored.  Next, it reads SUBS.DAT, which tells it the name
  170. and number of all your message bases, plus some info about how they are
  171. stored.  Then it starts processing the message bases.
  172.   
  173.      To process a message base, DEFRAG reads in the appropriate data file for
  174. the message base.  This tells DEFRAG how many messages there are and how each
  175. one is actually stored.  If you have more messages in the message base than
  176. the limit is currently set at (for example, you just lowered the max messages
  177. limit from 100 to 50, and there are still 100 messages there, DEFRAG will
  178. delete them for you, starting with the first message and going on through as
  179. many as needed, skipping any marked unremovable.  Then, it processes each
  180. remaining message individually, converting them to a new type if necessary. In
  181. addition, if you just set up a new sub in BOARDEDIT, WWIV automatically makes
  182. it an 80k file.  DEFRAG will now STRIP off the excess disk space used if it
  183. does not hold any messages.  The screen tells you at all times exactly what is
  184. happening.
  185.  
  186.      DEFRAG does not use a true compression algorithm, such as PKZIP or RAR.
  187. All it does is remove the "dead" space from a message file which is no longer
  188. being used.  The amount of space you'll reclaim will fluctuate based on many
  189. things.  Among those are the number of subs you have, the activity of those
  190. subs, and how often you run DEFRAG.  Below are a couple of excerpts from my
  191. log file.  These are ran on a K5/100 running under Win98.  On my P3/450 the
  192. speed numbers are much better.
  193.  
  194. DEFRAG Log Entry for 03/13/1999 at 14:44:17
  195. ═══════════════════════════════════════════
  196.      19473 messages processed.
  197.   67534336 bytes (65951.5k) processed.
  198.    8056320 bytes (7867.5k) saved!
  199.       3468 bytes per message (average).
  200.       2.75 minutes elapsed.
  201.    7081.09 messages per minute.
  202. ═══════════════════════════════════════════
  203.  
  204. DEFRAG Log Entry for 03/20/1999 at 16:22:33
  205. ═══════════════════════════════════════════
  206.      19827 messages processed.
  207.   67168256 bytes (65594.0k) processed.
  208.    7271936 bytes (7101.5k) saved!
  209.       3387 bytes per message (average).
  210.       3.18 minutes elapsed.
  211.    6228.38 messages per minute.
  212. ═══════════════════════════════════════════
  213.  
  214.  
  215. VII. Registering DEFRAG, or "A Plea for Money"
  216.  
  217.      As of DEFRAG v2.00 it became shareware.  I am continuing with Spackle's
  218. policy of "Lifetime Registration" on Defrag.  I have also left the same
  219. unregistered delays that Spackle had in.  These are detailed below.
  220.  
  221.      * Subs above 80 (#79 according to BOARDEDIT) are not    ***REMOVED***
  222.        defragmented.                                         ***REMOVED***
  223.      * A small plea for registration is shown before DEFRAG
  224.        begins its work, and there is a VERY small delay for
  225.        unregistered users to read the registration plea.
  226.      * Unregistered copies will wait for keyboard input after
  227.        execution, or will automatically time out after 3 minutes.
  228.  
  229. To register please fill out the order.frm included in the archive file and
  230. send it to the address listed on the form.  If you have previously registered
  231. you will in fact need to have a new registration key generated.  I do have a
  232. list of registered users from Spackle and if you are one of those users, I
  233. do still need you to fill out the form.  However you can simply email it to
  234. the internet address listed (dawg@mindspring.com) and I'll send you a new
  235. registration code.  You'll need to either manually insert the code and number
  236. into WWIV.INI or run "DEFRAG REGISTER" and enter it that way.
  237.  
  238.  
  239. VIII. Running DEFRAG.EXE?
  240.  
  241.      Running DEFRAG involves two easy steps:
  242.  
  243.      1.  Copy DEFRAG.EXE to your main BBS directory - \WWIV, \BBS or
  244.          whatever you call it.
  245.      2.  At the main BBS DOS prompt (e.g. C:\WWIV>), just type DEFRAG with
  246.          no parameters.
  247.  
  248.      The default command will defragment all of your message bases and WILL
  249. create a log (DEFRAG.LOG) in your GFILES directory.  It will not touch your
  250. EMAIL.DAT, but that's alright for now.  We'll get to that next.
  251.  
  252.  
  253.  
  254. IX. Running DEFRAG.EXE revisited, or "What are my options?"
  255.  
  256.  
  257.      DEFRAG is run using the following convention:
  258.  
  259.        DEFRAG [/?] [/D{xx|xx-yy}] [/E{+|-}] [/L{+|-}] [/O{+|-}] [/S{+|-}]
  260.  
  261.      The following (defaults are marked with the "*" characters) parameters or
  262. options are available:
  263.  
  264.    /Dxx     DEFRAGment only certain message bases, specified by the
  265.             xx parameter.  Specify nn by the number in BOARDEDIT
  266.             (i.e. sub #1 while logged on would be 0 to DEFRAG).
  267.             The number xx cannot be higher than the maximum number
  268.             of subs available (DEFRAG will check this anyhow, so
  269.             don't worry too much if you enter a wrong number).
  270.  
  271.    /Dxx-yy  DEFRAGments a range of subs from xx to yy, inclusive.
  272.  
  273.    /E       Enable/*Disable* EMAIL.DAT defragmentation.
  274.  
  275.    /L       *Enable*/Disable logging of DEFRAG's activities or errors.
  276.             DEFRAG.LOG is updated BY DEFAULT unless you specify the /L-
  277.             parameter on the command line.  (DEFRAG.LOG is created if it
  278.             doesn't exist.)
  279.  
  280.    /O       Only defragment EMAIL.DAT - ignore message bases.
  281.  
  282.    /S       *Enable*/Disable sound.  Default is on.  /S- turns it off.
  283.  
  284.    /W       *Enable*/Disable stripping of WWIV ^C colors from subnames
  285.  
  286.    /?       Show a help screen similar to what you see here.
  287.  
  288.      To enable or disable an option you place a "+" or "-" after it, such as
  289. "/L-" to disable the log or "/E+" to enable EMAIL.DAT defragmentation.  The
  290. /Cnn and /Xnn options are repetitive, for example:
  291.  
  292.      DEFRAG /D0 /D4 /D8 /D11 /D23
  293.  
  294. would defragment subs 1, 5, 9, 12, and 24.  (Remember, sub 0 in BOARDEDIT is
  295. actually sub 1 on the board itself - DEFRAG uses BOARDEDIT's info, not what
  296. you see when you log on.)  These options can all be used interchangeably (and
  297. repetitively).
  298.  
  299. Here are a few examples:
  300.  
  301.    DEFRAG /O /D2       Defrag EMAIL.DAT and sub 3 and create a log
  302.  
  303.    DEFRAG /E- /D1 /L-  Disable EMAIL.DAT defrag/defrag sub 2 & no log
  304.  
  305.    DEFRAG /E /L /S     Defrag EMAIL.DAT, create a log, no sound
  306.  
  307.    DEFRAG /D3-35 /E-   Defrag sub #4-#36, no EMAIL.DAT, with a log
  308.  
  309.    DEFRAG /W /O        Defrag EMAIL.DAT and all subs, strip ^C colors
  310.  
  311.    DEFRAG /?           Show small help screen
  312.  
  313.  
  314.  
  315. X. Warnings, or "Why did I DO that!?"
  316.  
  317.  
  318.      Although DEFRAG's operations have improved considerably since its first
  319. incarnation, it is still rather unwise to halt the execution of DEFRAG while
  320. it is working on your message bases.  It may not erase any files, but it may
  321. well scramble them.  You may hit CTRL-C or CTRL- Break at any time to exit,
  322. but this is not a suggested option.  In fact, I strongly discourage doing
  323. ANYTHING until DEFRAG has completed its work.  DEFRAG WILL automatically make
  324. backup files before any work is actually done; however, no guarantee is made
  325. or implied that DEFRAG is 100% safe with ALL possible combinations of number
  326. of message bases, size of user list, version of WWIV, modifications made to
  327. WWIV, etc.  Diverting a program from its normal path of events is not
  328. generally a good idea.  Still, it is possible, and sometimes useful to do so.
  329. I have TRIED to make DEFRAG damage my files, without success; however, I can't
  330. suggest you do the same.
  331.  
  332.      And to quell a few rumors that have been floating around, DEFRAG does not
  333. touch the user list in any way.  In fact, the code for DEFRAG doesn't even
  334. "know" that such an file or data structure even exists (only WWIV data
  335. structure pertinent to DEFRAG itself are made known to DEFRAG.C [example:
  336. configrec and messagerec are "known" to DEFRAG.C, but userrec is not].)  Sysops
  337. having problems with duplicate accounts in their USER.LST should look
  338. elsewhere (in fact, I've had similar problems, and suspect it is possibly a
  339. bug in 4.22 itself).
  340.  
  341.  
  342. XI. Copyright Information, or "Who owns what?"
  343.  
  344.      DEFRAG and its accompanying documentation and support files are Copyright
  345. (c) 1997-2000 by Lawrence C. Bensinger.  Under NO CIRCUMSTANCES shall any
  346. "new" or revised version of either the executable(s) or the documentation or
  347. both be released to anyone without prior knowledge of and written consent from
  348. the Lawrence C. Bensinger.  No other public releases will be allowed.  If you
  349. have any suggestions on how to improve DEFRAG, please mail them to me (see end
  350. of document).
  351.  
  352.  
  353.  
  354. XII. Revision History/Information
  355.  
  356.      Moved to history.doc.
  357.  
  358.  
  359. XIII. Personal Data Regarding the Author and How to Reach Him
  360.  
  361.      There have been several people that have contributed to Defrag.  The
  362. original incarnation was written by Jeff Garzik (aka East Bay Ray).  Jeff
  363. wrote some tremendous mods for WWIV back in the 4.1x era and wrote the
  364. initial Defrag.  When he left the WWIV world to pursue a degree at Georgia
  365. Tech, he passed the code on to...
  366.  
  367.      Scott Schnegelberger (aka Spackle) with help from Cris McRae (aka JAFO).
  368. They are responsible for Defrag looking and working the way it does today.
  369. If you have ever seen the source back in the 1.xx era's you can really
  370. appreciate the amount of work they've done.
  371.  
  372.      I purchased the code from Scott in late 1997.  I had already picked up
  373. the source of the FMD utilities and had unsuccessfully tried to contact JAFO
  374. to purchase the source of his.  The main reason behind this is that I use
  375. and like these utilities and have no desire for them to become abandoned as
  376. have the many Tolkien utilities I registered throughout the years.  As I said
  377. publicly when I picked up Defrag, it is what I'd consider a "mature" program
  378. and as such I didn't see a lot of need to add features.  I did dump the
  379. defrag.key and added WWIV.INI support in it's place; but otherwise the program
  380. does a nice job and I see no real reason to break something that works so
  381. well.  So while I will address any bugs and/or new WWIV versions unless there
  382. is a suggestion out there with some real merit what you see is what Defrag
  383. is and will be.
  384.  
  385.  
  386.      I can be contacted at the following addresses:
  387.      WWIV-Based (In order of preference):
  388.        1@122  Filenet
  389.        1@2121 WWIVnet
  390.  
  391.      Internet-Based (Again in order of preference):
  392.        dawg@mindspring.com
  393.        cbensinger@email.com
  394.  
  395.      Fidonet
  396.        1:100/235
  397.  
  398.  
  399.      The bbs is still open in case you need this or any other file.  The
  400. number is (636)940-1253 (note the area code changed 5/99 to this).  You can
  401. also visit my web page (http://www.mindspring.com/~dawg).  I don't have any
  402. of my programs online yet, but I should in the near future.  In the interim
  403. you can telnet to Frank Reid's bbs (Eagle's Dare) and get them.  I believe
  404. the address to telnet to is simply filenet.wwiv.net but I'm not for sure.
  405.  
  406.                                   ----------
  407.  
  408.                         Thanks for using DEFRAG v3.20!
  409.  
  410.                              --------------------
  411.