home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / snipps97.zip / UUSYNTAX.MAN < prev    next >
Text File  |  1997-07-04  |  3KB  |  63 lines
  1. +++Date last modified: 05-Jul-1997
  2.  
  3.             Syntax for SNIPPETS' UUENCODE and UUDECODE utilities
  4.             ----------------------------------------------------
  5.  
  6.  
  7. Users not familiar with Unix utilities or filters in general have expressed
  8. some problems using the implementations of UUENCODE and UUDECODE in SNIPPETS.
  9. This file is a quick syntax reference for these implementations.
  10.  
  11.  
  12. UUENCODE:
  13. ---------
  14.  
  15. The syntax for this utility may be either...
  16.  
  17.       UUENCODE [input_file] file_name > uuencoded_file
  18.  
  19. ...or...
  20.  
  21.       UUENCODE file_name < input_file > uuencoded_file
  22.  
  23. The UUENCODE utility encodes a binary file using only printable characters to
  24. facilitate transmission of such files (e.g. .ZIP archives) across trans-
  25. mission media designed for the transmission of textual data only. Although
  26. the internal format of the uuencoded file is not important, it does carry
  27. with it both the name of the uuencoded file as well as its encoded data.
  28.  
  29. The first, optional, argument is the local file name of the file to be
  30. encoded. If the file name is not supplied, the input will be taken from
  31. stdin, i.e. it will act as a true filter (see note below!)
  32.  
  33. The second, required, argument is the name to use when decoding the file.
  34. This is the name that is stored in the first line of the uuencoded file.
  35.  
  36. All other arguments are used with the redirection operators, ">" and "<". If
  37. a local file name isn't specified, one must be redirected to stdin using the
  38. "<" operator. The output of uuencode is always to stdout. To send it to a
  39. file rather than appearing on the console, you should use the ">" operator.
  40.  
  41. NOTE: There is one side effect of this implementation that can cause problems
  42.       in some environments. If the local file name is explicitly specified as
  43.       the optional first argument, everything proceeds as expected. However,
  44.       if the input file is redirected, it may cause unwanted translation of
  45.       newline characters. For example, on my DOS machine, uuencoding a
  46.       redirected text file, then decoding with the SNIPPETS utilities will
  47.       result in the CR/LF pairs terminating each line to be changed to LF
  48.       characters. The solution is to explicitly provide the input file name
  49.       rather than redirecting it.
  50.  
  51.  
  52. UUDECODE:
  53. ---------
  54.  
  55. UUDECODE is used to decode a file which has been encoded using the UUENCODE
  56. utility. Its syntax is...
  57.  
  58. UUDECODE < uuencoded_file
  59.  
  60. Note that no command line arguments are used and the file to be decoded is
  61. simply redirected to the utility. The decoded output is written directly to a
  62. file whose name is speciified in the first line of the uuencoded file.
  63.