home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 2 / goldfish_vol2_cd1.bin / files / comm / mail / spluu / spluu.doc < prev    next >
Text File  |  1993-12-21  |  6KB  |  168 lines

  1. Document SplUU - by wyrd@ministry.demon.co.uk
  2.  
  3.         ******************************************************
  4.         *                                                    *
  5.         *     //////   //////   //    //     //  //     //   *
  6.         *   ///   ///  //  ///  //    //     //  //     //   *
  7.         *   ////       //  ///  //    //     //  //     //   *
  8.         *     ////     /////    //    //     //  //     //   *
  9.         *       ////   //       //    ///    //  ///    //   *
  10.         *  ///   ///   //       //     ///   //   ///   //   *
  11.         *   //////     //       /////    ////       ////     *
  12.         *                                                    *
  13.         ******************************************************
  14.  
  15.                             VERSION V01.16ß
  16.  
  17.                     "SplUU", a File Email System.
  18.  
  19.                     (c)1993 Psilocybe Systems Inc.
  20.  
  21.                    email: wyrd@ministry.demon.co.uk
  22.  
  23.  SplUU has been voted "Best software ever written, and I think we'll
  24. recursively delete our entire UNIX system today and use SplUU as our
  25. operating system instead..." by the magazine "Little White Mushroom
  26. User" in the August 2021 edition.
  27.  
  28. 0. About the Author
  29.    ~~~~~~~~~~~~~~~~
  30.  Oh, I don't believe you really read this stuff anyway. If you're bored
  31. and really want to know, email me. Better yet, I'm on IRC as "Midnight"
  32. and may even talk to you. (Wow)
  33.  
  34.  This is a beta Aminet release of SplUU. It has been tested and seems
  35. to work fine, but there _may_ still be bugs. Also I wish to improve
  36. the documentation - but have very little time as I'm studying Music
  37. Tech at the London Guildhall University at present. If anyone wants
  38. to write some decent docs (in text and AmigaGuide format) then feel
  39. free to do so. If they're any good, I'll use them in the next release.
  40.  
  41. 1. What is SplUU?
  42.    ~~~~~~~~~~~~~~
  43.  SplUU is used to prepare a file for emailing by splitting it into
  44. several files in UUEncode format. If the file has been UUEncoded
  45. previously, the UUEncoding function can be switched off.
  46.  
  47.  Remember that SplUU will try to UUEncode by default...
  48.  
  49.  Oh, and SplUU is a Command Line Interface utility! Yes, that's right,
  50. good ol' CLI. I had written a GUI version of SplUU, but I have such
  51. a deep loathing for graphical interfaces that I deleted it. Bwahaha!
  52.  
  53. 2. Syntax for use
  54.    ~~~~~~~~~~~~~~
  55. spluu [-?]
  56.  
  57. or
  58.  
  59. <[UUEncoded]file> <output_file> [-a] [-r] [-e] [-l] [-u] [-n<no_of_lines>]
  60. [-s<user@site>]
  61.  
  62. or
  63.  
  64. <input_batch> <output_unbatched> <-x> [-d]
  65.  
  66.  Arguments
  67.  ~~~~~~~~~
  68. 2.1. -a     - Overwrite.
  69.  
  70.  The -a flag will, if set, make SplUU overwrite any existing files which
  71. share the same filename as <output_file>.
  72.  
  73. 2.2. -r     - Remove.
  74.  
  75.  The -r flag will, if set, make SplUU delete the <[UUEncoded]file> after
  76. the output files have been written.
  77.  
  78. 2.3. -e     - Encoding off.
  79.  
  80.  The -e flag will, if  set, make SplUU assume that the <[UUEncoded]file>
  81. has been previously UUEncoded, and will try to split it without attempting
  82. to UUEncode.
  83.  
  84. 2.4. -l     - LhA.
  85.  
  86.  The -l flag will, if set, cause the output files to be LhAed before
  87. they are UUEncoded. You must have LhA in your system path for this to work.
  88. Note: this option is only allowed if the -e flag has _not_ been set. Pre-
  89. UUEncoded files should not need to be LhAed.
  90.  
  91. 2.5. -u     - UNIX filemode.
  92.  
  93. The -u flag will, if set, make SplUU calculate the file mode for the
  94. UUEncoded file. This may cause problems on an Amiga-only platform, but
  95. has been included for the sake of completeness.
  96.  
  97. 2.6. -n     - Number of lines.
  98.  
  99.  The -n flag, if used with a number following it directly, sets the number
  100. of lines of each UUEncoded block. This number defaults to 2000. Example
  101. use:
  102.  
  103. spluu infile outfile -n700
  104.  
  105. This will create several 700 line files - which equates to about 43K per
  106. outfile.
  107.  
  108. 3. Extracting
  109.    ~~~~~~~~~~
  110.  If the -x flag has been set, all flags other than -d are ignored. This
  111. will cause SplUU to act as a DeSplUUer. :) It will read the input file,
  112. looking for SplUU-type blocks, and will try to concatenate them in the
  113. correct order for use - the output is written to <output_file>.
  114.  
  115.  When the -x flag has been set, the -d flag can also be set. This will
  116. make SplUU attempt to UUDecode the unbatched UUEncoded file. Note that
  117. the file/path of the UUDecoded file is taken from the coded file's begin
  118. line...
  119.  
  120.  Note: The format of batch file that SplUU is able to extract from must
  121. be similar to the username.txt folder used by mailreaders such as Elm.
  122.  
  123. 4. Sendmail
  124.    ~~~~~~~~
  125.  The -s flag is used in conjunction with SENDMAIL to directly post the
  126. split output files as email. Specify the user you're mailing to after
  127. the -s, i.e.
  128.  
  129. spluu in out -a -r -swyrd@ministry.demon.co.uk
  130.  
  131.  You must have SENDMAIL in your path, and a UUCP config file in either
  132. your s: or your uulib: assignment. That is to say, you must have at
  133. least a minimum UUCP setup installed on your system.
  134.  
  135. Note: SplUU looks for the key words "NodeName", "UserName", "RealName"
  136. "Organization" and "DomainName" in the UUCP config file, and is case-
  137. sensitive, so those words must be entered exactly as listed.
  138.  
  139. 5. Example use
  140.    ~~~~~~~~~~~
  141.  Given a pre-UUEncoded file called "testfile.uue", we could:
  142.  
  143. spluu testfile.uue outfile -a -r -e
  144.  
  145.  This would create NN number of files, depending on the length of the
  146. input file, in the format:
  147.  
  148. outfile.NN
  149.  
  150.  Note that "testfile.uue" will have been deleted, due to the "-r" flag
  151. being set. Also, if there were any existing files with filenames such
  152. as "outfile.01" they will have been overwritten without any warning
  153. messages given, due to the "-a" flag being set. The "-e" flag is set to
  154. prevent SplUU from trying to UUEncode the input file, which had already
  155. been UUEncoded.
  156.  
  157. 6. Whatware?
  158.    ~~~~~~~~~
  159.  Hope you find this useful. (c)1993 Psilocybe Systems Inc.
  160.  
  161.         wyrd@ministry.demon.co.uk -- IRC:Midnight
  162.  
  163.  This software is #wiccaware - if you like it, /msg me! :)
  164.  
  165.  p.s. That means it's *free!* By all means send me a nice new A4000T-UNIX,
  166. but you haven't got to. Just don't screw with the code and re-release it.
  167.  
  168.