home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / TAGRB130.ZIP / TAGGRAB.DOC < prev    next >
Encoding:
Text File  |  1993-04-25  |  10.7 KB  |  305 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8. TagGrab v1.3
  9. Copyright James Goss, 1993
  10. ALL RIGHTS RESERVED
  11.  
  12. Contact:
  13.  
  14. TagGrab 1.3
  15. PO Box 10293
  16. Erie, Pa  16514
  17.  
  18. Darby Research Systems
  19. Erie, Pa
  20. (814) 825-7905
  21. N81, 2400-16.8k HST D/S
  22.  
  23.  
  24.  
  25. TagGrab is a utility which will compile all the taglines in a mail packet
  26. into your TAGLINES.MR file (or other specified).  What is a tagline?
  27. If you don't know the answer to this, you probably have no need for
  28. TagGrab.  A tagline is a short, often witty, one-liner, stuck on the
  29. end of a message.
  30.  
  31. If you are an avid tagline collector, or just like to pick out the
  32. ones that particularly attract you, TagGrab is just the tool for you.
  33. TagGrab is an easy to use, yet highly configurable tagline 'thief'.
  34.  
  35. Essentially, TagGrab will go through your QWK format mail packet and
  36. 'steal' all the taglines it can identify.  These taglines are then
  37. saved into your TAGLINES.MR file (default, you can specify another
  38. filename) for use with your off line mail reader (SLMR, 1st Reader, etc).
  39.  
  40. TagGrab will first un-archive your QWK packet.  All QWK packets are
  41. kept in archives (one file made up of many others) of all the data
  42. files for your mail reader.  One of these files is the MESSAGES.DAT
  43. file.  This is what stores your messages.  TagGrab will search this
  44. file and will store any taglines it finds in memory.
  45.  
  46. TagGrab will default to using PKUNZIP to un-archive the QWK packet.
  47. Make sure PKUNZIP.EXE is in your PATH so TagGrab can utilize it.  You
  48. can also configure TagGrab to use ARJ.
  49.  
  50. The basic usage of TagGrab is as follows, on the command line:
  51.  
  52. TAGGRAB [D:][\PATH\]BBS.QWK [option [parameter]...]
  53.  
  54. In English, this just means type TAGGRAB followed by the QWK packet
  55. name to extract all the taglines out of it, and save to the filename
  56. TAGLINES.MR.  If the TAGLINES.MR file already exists, the new taglines
  57. will be appended to the end.
  58.  
  59. However, TagGrab is much more powerful than just this.  Here is a
  60. complete overview of all the options and their parameters.
  61.  
  62. Note:  All options should be preceded by a '-' with a space separating
  63.        each option.  ex:  TAGGRAB BBS.QWK -1 -A
  64.                                            │  │
  65.                                 Options────┴──┘
  66.  
  67.        All parameters should follow the associated option by one
  68.        space.  ex:  TAGGRAB BBS.QWK -B 1
  69.                                      │ │
  70.                          Option──────┘ │
  71.                          Parameter─────┘
  72.  
  73. Descriptions will be in the format of:
  74.  
  75. -OPTION <PARAMETER TYPE>
  76.   │       └ If the option needs a parameter, this will say what kind.
  77.   │         (number, path, etc.)
  78.   │
  79.   └ Single character code, which tells TagGrab what to do
  80.  
  81. Note, if a parameter type is specified for an option, you MUST use
  82. some parameter, or TagGrab will interpret the next item on the command
  83. line as the parameter.
  84.  
  85. There will be a section covering specifications for certain mail
  86. readers at the end of this file.
  87.  
  88. -1
  89.         Use the -1 option if you are using 1st Reader.  TagGrab will
  90.         use the TAGLINES.DAT file instead of the TAGLINES.MR file.
  91.         TagGrab will also set the maximum tagline length to 60
  92.         characters.
  93.  
  94. -A
  95.         The -A option tells TagGrab to alphabetize your taglines.
  96.  
  97. -B <#>
  98.         By the means which TagGrab searches for taglines, it may
  99.         sometimes mistake a 'BBS tagline' for a 'real' tagline.  A BBS
  100.         tagline, is the one that follows the kind of tagline you're
  101.         looking for.  It tells where the message originated the BBS
  102.         phone number, etc.
  103.  
  104.         If you do not use the -B option, TagGrab will, upon suspecting
  105.         it has found a BBS tagline, by accident, ignore it, unless you
  106.         specify otherwise.
  107.  
  108.         If you use the -B option, with a 1 parameter ex:
  109.  
  110.                 TAGGRAB BBS.QWK -B 1
  111.  
  112.         TagGrab will ask if any tagline it suspects as a BBS tagline,
  113.         actually is.
  114.  
  115.         If you use the 0 parameter, TagGrab will not check for any BBS
  116.         tags, and they will all be added to your taglines file.
  117.  
  118. -D <#>
  119.         The -D option regulates TagGrabs built in duplicate tagline
  120.         checking system.  TagGrab will, by default, search all
  121.         taglines for duplicate, ignoring spaces, punctuation and case
  122.         (ie, 'a'='A').
  123.  
  124.         Using the 0 parameter tells TagGrab not to do any duplicate
  125.         checking.
  126.  
  127.         The 1 parameter will tell TagGrab only to search new taglines
  128.         for duplicates.  This is time saving and the most logical, if
  129.         you're sure the original taglines in your taglines file have
  130.         no duplicates.
  131.  
  132. -J
  133.         If your QWK packet was archived with the ARJ archiver, then
  134.         use the -J option, so TagGrab can get in to see the
  135.         MESSAGES.DAT file in the QWK packet.  By default, TagGrab will
  136.         use PKUNZIP.
  137.  
  138. -L <#>
  139.         If your mail reader will only allow taglines to be a certain
  140.         length, then use the -L option to save memory (ie, allowing
  141.         more taglines to be processed).  Just use the maximum length
  142.         TagGrab should allow as the parameter.
  143.  
  144. -N <#>
  145.         Use this option to specify the maximum number of taglines
  146.         TagGrab can process.  The default maximum is 62535 taglines.
  147.  
  148. -R
  149.         Use this option if you would like TagGrab to use the PKUNZJR
  150.         un-archiver.  This is a smaller un-archiver for packets archived
  151.         with PKZIP.
  152.  
  153.         Note, however, that using PKUNZJR will take longer to
  154.         un-archive the QWK packet.  Also note that TagGrab will be
  155.         forced to extract *all* files from the QWK packet, instead of
  156.         just the MESSAGES.DAT file.  TagGrab only deletes the
  157.         MESSAGES.DAT file when it's done with it.  Therefore, using
  158.         PKUNZJR will leave all the other files in the directory.
  159.  
  160.         You can use the -W option though, to remedy this situation, if
  161.         you like, by specifying an empty directory to work in.  Then,
  162.         after you run TagGrab, just delete the directory.
  163.  
  164. -T <FILENAME.EXT>
  165.         Use this to specify a tagline data file other than
  166.         TAGLINES.MR.  The taglines will be saved in ASCII format with
  167.         one tagline per line, unless you specified the -1 option.
  168.         Then they will be saved in 1st Reader's format.
  169.  
  170. -W <[D:]PATH>
  171.         The -W option is used to specify a working directory.  I
  172.         suggest using a temporary directory with the -R option.  I also
  173.         suggest using a RAM drive if possible to increase speed.  The
  174.         drive should be quite large though, to accommodate for the size
  175.         of the MESSAGES.DAT file in the QWK packet.  Note that TagGrab
  176.         will not create a directory.
  177.  
  178.  
  179. TagGrab will give you up to the second updates on how many taglines it
  180. finds, how many duplicates, etc.  It will also give you a percentage
  181. of completion update, so you know how far TagGrab has to go.  Sample
  182. output looks like this:
  183.  
  184.   Reading MESSAGES.DAT...  59.4, 52 New Taglines Found, 75 Total Found
  185.  
  186. The first number following the '...' indicates it is 59.4% complete (has
  187. 40.6% to go).
  188.  
  189. Mail Reader Notes...
  190.  
  191. SLMR & OLX
  192.         TagGrab works most conveniently with SLMR, since it was
  193.         written originally for SLMR.  Unregistered SLMR users may want
  194.         to specify a maximum of 57 characters per tagline (-L option).
  195.  
  196. 1st Reader
  197.         Since 1st Reader uses a different tagline data file format
  198.         than other readers, use the -1 option to tell TagGrab to use
  199.         it.
  200.  
  201. Blue Wave
  202.         Blue Wave tagline data files allow for comment lines in the
  203.         tagline data file.  These are lines whose first character is a
  204.         ';'.  TagGrab will not recognize these as comments, and will
  205.         assume them taglines, so they should be removed from the file.
  206.         Also, Blue Wave allows taglines to be a maximum of 70
  207.         characters long.
  208.  
  209. Rose Reader
  210.         Rose Reader uses the same format as SLMR and OLX.  However,
  211.         the filename is TAGLINES.DAT.  Be sure to use the following
  212.         option and parameter:
  213.  
  214.                 -T TAGLINES.DAT
  215.                               
  216. ERRORLEVELs returned:
  217.  
  218. -1 Too Few Arguments
  219. -2 Could Not Open Tagline File
  220. -3 Out of Memory
  221. -4 Un-archiving Error
  222. -5 Could Not Find .QWK Packet
  223. -6 Could Not Retrieve Current Path
  224. -7 Could Not Find Directory with .QWK Packet
  225.  
  226.  
  227. LICENSING AND DISTRIBUTION
  228.  
  229. TagGrab 1.3 is not, nor has it been, free software. It is
  230. copyrighted, and is distributed as shareware. You are granted a
  231. limited license to use TagGrab 1.3 for an evaluation period, not
  232. to exceed 30 days. Use of TagGrab 1.3 beyond the evaluation
  233. period requires registration.
  234.  
  235. Electronic Bulletin Boards may distribute TagGrab 1.3, as long
  236. as all files are included in the TagGrab 1.3 package.
  237. No fee may be charged for TagGrab 1.3, excluding fees charged
  238. for normal access to Bulletin Board Systems or distribution 
  239. diskette charges.
  240.  
  241. Vendors may also distribute TagGrab 1.3 as long as all files are included.
  242.  
  243. Please feel free to distribute the archive to anyone provided you 
  244. follow the same restrictions as above.
  245.  
  246. The following files MUST be included in the archive or disk:
  247.  
  248. TAGGRAB.EXE
  249. TAGGRAB.DOC
  250. TAGGRAB.NEW
  251. LICENSE.DOC
  252. REGISTER.FRM
  253. README.* (if exists)
  254. FILE_ID.DIZ
  255.  
  256. REGISTRATION
  257.  
  258. To register TagGrab 1.3 send $15.00 Check or Money Order to:
  259. Money Order payable to JAMES GOSS;  Make checks out to JAMES GOSS
  260.  
  261. TagGrab 1.3
  262. PO Box 10293
  263. Erie, Pa  16514
  264.  
  265. Please include Name, address, version and where you received TagGrab 1.3
  266.  
  267. You will receive the latest version on disk (specify 5.25 or 3.5)
  268. registered to you.
  269.  
  270. WARRANTY
  271.  
  272. TAGGRAB 1.3 IS SOLD "AS IS" WITHOUT WARRANTY OF ANY KIND,
  273. EXPRESSED OR IMPLIED, OR AGAINST FAILURE OF TAGGRAB 1.3 TO OPERATE
  274. IN A MANNER DESIRED BY THE USER.
  275.  
  276. IN NO EVENT WILL JAMES GOSS BE LIABLE FOR ANY DAMAGES TO DATA OR
  277. PROPERTY WHICH MAY BE CAUSED DIRECTLY OR INDIRECTLY BY THE USE OF
  278. TAGGRAB 1.3. JAMES GOSS SHALL NOT BE LIABLE FOR ANY
  279. DAMAGES, INCLUDING LOST PROFITS, LOST SAVINGS, OR ANY CLAIM BY
  280. ANY PARTY, ARISING OUT OF USE OF TAGGRAB 1.3.
  281.  
  282.  
  283.  
  284. If you have problems, running TagGrab 1.3, or just wish to
  285. comment, write:   James Goss
  286.                   PO Box 10293
  287.                   Erie, Pa  16514
  288.  
  289. Or, through Darby Research Systems, Support Board For TagGrab 1.3
  290.                               
  291. BUG REPORTS
  292.  
  293. If you should find a bug in TagGrab I would greatly appreciate it if 
  294. you were to point it out to me.  In order to make debugging easiest 
  295. on me and the user, please try to tell me the following:
  296.  
  297.         Command Line Used
  298.         System Configuration (processor, memory available, TSRs, etc.)
  299.         What output was given
  300.  
  301. If you can capture the output and send a printout of that along, that 
  302. would be most helpful.
  303.  
  304. COPYRIGHT (C) 1993  JAMES GOSS
  305.