home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / packer / uugrab / uugrab.doc < prev    next >
Text File  |  1992-12-07  |  6KB  |  161 lines
  1. Documentation for UUGRAB Version 1.6    (c)1992 by Harald Boegeholz
  2.  
  3.  
  4.  
  5. UUGRAB is a 16 bit OS/2 program to decode multi-part uuencoded binaries
  6. posted in UseNet newsgroups such as comp.binaries.os2 and
  7. comp.binaries.ibm.pc. It requires that every news article is stored in a
  8. file by itself. This is usually the case in the news spool directory, so
  9. one can either directly use UUGRAB on the spool directory or copy the
  10. files from there. It also requires a uudecode program which reads from
  11. stdin. UUGRAB pipes directly into uudecode, so uudecode can NOT be a DOS
  12. program since pipes from OS/2 programs to DOS programs don't work.
  13.  
  14. UUGRAB works by reading all specified files and parsing the Subject:
  15. header in each file. There it looks for the expression
  16.  
  17.      <digits> [<whitespace>] ( "of" | "/" ) [<whitespace>] <digits>
  18.  
  19. to identify the number of parts and part number for each article. For
  20. all complete binaries found, UUGRAB then either uses its internal
  21. "uucat" decoder together with an external UUDECODE or executes an
  22. arbitrary command specified by the -c option.
  23.  
  24. UUGRAB reads and writes a history file named uugrab.rc in the current
  25. directory to keep track of the message-IDs of the successfully decoded
  26. binaries. This way each binary is decoded only once, even if the old
  27. articles haven't expired yet. If you don't like this feature, simply
  28. delete uugrab.rc before calling uugrab.
  29.  
  30.  
  31.  
  32. Usage: uugrab [-a] [-c <command>] [-d] [-i <n>] [-n] [-v] files...
  33.  
  34. Options
  35. -------
  36.  
  37. -a  decode all files, even those without part numbers.
  38.     If this option is not specified, UUGRAB only decodes files with
  39.     suitable part numbers in the Subject header. With -a, files without
  40.     part numbers in the Subject header are decoded, too.
  41.  
  42. -c <command>
  43.     execute the specified command for all binaries. The command is
  44.     executed with the filenames of all parts of a binary as arguments in
  45.     the correct order. No checks are made for maximum command line
  46.     length! If -c is not specified, UUGRAB pipes each binary into
  47.     UUDECODE, which must be present in the PATH and read stdin. Under
  48.     OS/2, UUDECODE may not be a DOS program since pipes from OS/2
  49.     programs to DOS programs don't work.
  50.  
  51. -d  save descriptions.
  52.     This option can not be used together with the -c option. If -d is
  53.     specified, the beginning of the first article(s) up to the begin
  54.     line of the uuencoded binary is saved in a separate file. The
  55.     filename is determined from the name of the uuencoded binary by
  56.     changing the last extension to .des or appending .des if no
  57.     extension is present.
  58.  
  59. -i <n>
  60.     ignore <n> fields at beginning of subject
  61.     This option removes the first <n> fields from the beginning of the
  62.     Subject line before parsing it. Fields are separated by white space.
  63.     This is necessary for binaries in which the first field of the
  64.     subject contains a unique posting id (e.g., comp.binaries.os2,
  65.     comp.binaries.ibm.pc), since UUGRAB identifies parts of the same
  66.     binary by identical subject lines.
  67.  
  68. -n  don't do anything; just display what would be done
  69.     This option is highly recommended for beginners. With -n, UUGRAB
  70.     displays to stdout the actions it would take if -n were not
  71.     specified. The output is in a form suitable to be used as a batch
  72.     file (and thus not quite nice to read :-) ).
  73.  
  74.  
  75. Examples:
  76. ---------
  77.  
  78. To decode all binaries from a comp.binaries.os2 spool directory and save
  79. the descriptions, change to that directory and
  80.  
  81.   uugrab -i 1 -d *
  82.  
  83.  
  84. If you administer the spool directory manually (like I do on my home
  85. machine), you may want to delete the articles you successfully decoded.
  86. To do this, first delete the history file uugrab.rc. Then, the command
  87.  
  88.   uugrab -i 1 -c del *
  89.  
  90. will delete all news articles previously decoded. This works by applying
  91. the del command to all binaries instead of decoding them. (CAUTION: if
  92. new articles have arrived in the meantime, they will be deleted too!).
  93. Note that incomplete postings will remain intact since the del command
  94. (like the decoder before) is only executed for complete postings.
  95.  
  96.  
  97. Special notes for the Unix version:
  98. -----------------------------------
  99.  
  100. The source code of UUGRAB contains some #ifdefs which should allow
  101. compiling it under Unix. For compiling under OS/2, you have to define
  102. the constant OS2. Otherwise, Unix is assumed. If your Unix C library
  103. doesn't have stricmp, define the constant NOSTRICMP.
  104.  
  105. There are some minor differences in the behavior of uugrab when compiled
  106. under Unix:
  107.  
  108. 1. If the -n option is used, uugrab outputs a shell script suitable for
  109.    /bin/sh instead of a batch file for CMD.EXE.
  110.  
  111. 2. The history file is called .uugrabrc
  112.  
  113. 3. My name is spelled without an Umlaut
  114.  
  115.  
  116. History:
  117. --------
  118.  
  119. 1.0: Initial version
  120.  
  121. 1.1: Added internal uucat, together with -d and -n options.
  122.      Wrote this documentation.
  123.  
  124. 1.2: Fixed bug that occured when -d was not specified.
  125.  
  126. 1.3: Added history file. Improved provisions to compile under Unix
  127.  
  128. 1.4: Fixed bug: Allowed generating command lines of arbitrary length
  129.  
  130. 1.5: Added -v option. uugrab is less "noisy" by default now.
  131.  
  132. 1.6: Added support for long filenames. Improved messages. Included a
  133.      version of uudecode in the archive for convenience.
  134.  
  135.  
  136. License:
  137. --------
  138.  
  139. You are free to use uugrab for any purpose you like except making money
  140. of it. You can use the source code in any way you like as long as you
  141. leave my name in it.
  142.  
  143. UUGRAB contains parts of the program uucat which was placed in the
  144. public domain by d84sp@efd.lth.se (Stefan Parmark). See the source for
  145. details.
  146.  
  147.  
  148. Contacting the author:
  149. ----------------------
  150.  
  151. Feel free to send suggestions and/or bug reports to
  152.  
  153.   <hwb@texnix.stgt.sub.org>.
  154.  
  155. If you are sending large mails (>100k) or can't reach that address,
  156. please use my secondary address
  157.  
  158.   <hwb@machnix.mathematik.uni-stuttgart.de>.
  159.  
  160. ------------------------ End of uugrab.doc -------------------------
  161.