home *** CD-ROM | disk | FTP | other *** search
/ CD-ROM Aktief 1995 #6 / CDA_6.iso / shell / txt / inewskit.arj / UUXFER.EXE / UUXFER20.DOC < prev   
Text File  |  1990-11-05  |  10KB  |  219 lines
  1. UUXFER ver 2.0 Documentation
  2.  
  3. UUXFER ver 2.0 copyright (C) 1990 by David M. Read
  4. UUXFER is shareware!!  Please read the registration information at
  5.        the end of this file!
  6.  
  7.  
  8. UUXFER allows you to encode and decode files for mailing via
  9. electronic mail.  During the ENcoding process, binary files
  10. are transformed into (larger) plain-text ASCII text files so
  11. that the network's mail programs can handle them.  During the
  12. DEcoding process, the files are converted back into binary
  13. form.
  14.  
  15. For most cases, you can just use UUXFER's default settings,
  16. which will encode or decode any size file with the standard
  17. format.  Some mail systems, however, cannot handle files
  18. larger than some maximum size (usually around 32 kilobytes).
  19. For the case of posting especially large files, you can change
  20. UUXFER's settings to accomodate this.
  21.  
  22. If you select option 'A' (Split) then UUXFER will split the output
  23. data into sections no larger than the size indicated by option 'S'.
  24. The actualy file size will be a little larger because of some extra
  25. data written to the file. Further, each output file will have
  26. "---cut here---" lines added before and after the data in order
  27. to facilitate posting to the net.
  28.  
  29. There are other options available from the menu. If you choose
  30. the "Merge" option ('M'), UUXFER will search for all files which
  31. have sequenced extensions with the same filename...that is to say,
  32. if you have 3 files that belong together, named FILE.1 FILE.2 and
  33. FILE.3, and you choose the "Merge..." option, UUXFER will decode
  34. each one, appending the data to the output file as it goes.  The
  35. numbers must be in the correct order for UUXFER to assemble them
  36. properly!  Additionally, UUXFER will attempt to skip over all
  37. headers and trailers, but will inform you if it is not able
  38. to distiguish normal text from UUENCODED data, in which case
  39. you will have to trim this text out yourself.  It is possible (though
  40. unlikely) that some normal text might fool UUXFER into thinking that
  41. it has encountered uuencoded data...if you encounter such cases, please
  42. notify the author at readdm@dopey.cc.utexas.edu, and include a sample
  43. of the text which caused the problem.
  44.  
  45. You may change the number of 4-byte cells of output data with
  46. option 'C' (Cells), although this is not recommended.  Under normal
  47. circumstances, the default setting of 15 will produce lines of
  48. data which almost any mail system will be able to handle.  Under no
  49. circumstances should you raise this number above 19; in fact, UUXFER
  50. will not allow you to do so.  Again, changing this setting, as they
  51. say in the army, is contra-indicated.
  52.  
  53. UUXFER also supports another common form of data encoding, namely
  54. the XX-encode standard, which is used primarily to avoid problems
  55. associated with transferring files between IBM mainframes and the
  56. rest of the world.  If you encounter an XX-encoded file you wish
  57. to decode, no special steps are necessary; UUXFER will recognize
  58. these files and decode them automatically.  If you wish to ENcode
  59. a file with the XX character set, you may select option 'X' from
  60. the main menu to toggle the XX character set on & off.
  61.  
  62. Sometimes encoders use nonstandard character sets, for reasons I
  63. don't understand.  Usually they will place a 'table' line before
  64. the data starts in order to provide other decoders with a list of
  65. the characters used in the encoding process.  Again, if you only
  66. wish to DEcode files with these tables, no extra steps are needed.
  67. If you wish to write one of these tables at the head of your data,
  68. you may choose option 'T' from the menu.  Alternatively, if you
  69. wish to do something to confuse everybody, you may design your
  70. own bizarre character set and place it in a file called TABLE.UUX,
  71. and then select option 'R' (Ext. set) to have UUXFER read this table
  72. and use it in the encoding process.  Selecting this option will also
  73. automatically activate the "Write table" option, but you may toggle
  74. the latter option off if you desire (this is useful *only* if you wish
  75. to write encoded data which no one in the world can decode without
  76. lots of grief).
  77.  
  78. If UUXFER finds that a target file already exists, it will warn you
  79. about the problem, unless you specify option 'O' (Overwrite), in which
  80. case UUXFER will be silent.  In the command-line mode (see below), UUXFER
  81. will warn you and abort the process (again, specifying the -o option will
  82. override).
  83.  
  84. Finally, you can run UUXFER in a command-line mode, which is handy
  85. if you wish to run it from batch files.  All parameters are accessible
  86. via command-line switches. Below is a list of command-line arguments,
  87. which are as close to the menu-option choices as is practical.
  88. The only option which differs from the menu-options is M, which in the
  89. command-line mode turns on both the 'Split' and 'Merge' options globally.
  90.  
  91. Usage:  uuxfer [params]
  92. Params: -Efilename  Encode <filename>
  93.         -Dfilename  Decode <filename>
  94.         -M          Sets UUXFER in "multiple" mode, where encoded output
  95.                     are split, and input files to be decoded are merged.
  96.         -Sn         Sets maximum file size for split-up output files to n
  97.                     bytes.  Default value: 32 KBytes/file (n = 32767)
  98.         -Cn         Sets maximum number of 4-byte cells to n cells per
  99.                     output line.  Default value: 15 cells/line.
  100.         -I          Displays registrastion information, ignoring all other
  101.                     command-line parameters and exiting afterwards.
  102.         -X          Select the XX character set.
  103.         -R          Read an external character set from TABLE.UUX
  104.         -T          Write a Table before the data.
  105.         -O          Overwrite pre-existing files.
  106.  
  107.  
  108. You may not specify an output file name; UUXFER will choose an
  109. appropriate one for you.  If in ENcoding mode, it will make
  110. the output file name the same as the input filename, with the
  111. extension changed to .UUE for single output files (.XXE if you
  112. are XX-encoding the files, or sequential numbers for multiple files.
  113. For the DEcoding process, UUXFER will use the output filename
  114. specified in the encoded data as the default.  For merging multiple
  115. files, UUXFER will ignore any extension you specify and replace it
  116. with sequential numbers.  If you do not specify an action
  117. (-e or -d parameters) then UUXFER will enter menu-driven mode,
  118. with parameters set to whatever was specified on the command line.
  119.  
  120. Examples of command-line usage:
  121.  
  122. uuxfer -emyfile.exe
  123.         will cause UUXFER to encode file myfile.exe into the output
  124.         file myfile.uue
  125.  
  126. uuxfer -dmyfile.uue -o
  127.         decodes file myfile.uue into whatever the uuencoded data specifies
  128.         as the output file name, overwriting any pre-existing copies
  129.         of that file.
  130.  
  131. uuxfer -m -emyfile1.exe -dmyfile2
  132.         encodes myfile1.exe, splitting the file at the default maximum
  133.         file size (32767 bytes/file); decodes files myfile2.1 through
  134.         myfile2.x where x is the highest numbered extension.
  135.  
  136. uuxfer -c12 -s2000
  137.         sets cells-per-line to 12 and maximum file size to 2000 bytes/file
  138.         and then enters menu-driven mode
  139.  
  140. uuxfer -t -x -emyfile.exe
  141.         Encodes myfile.exe with the XX character set, using myfile.xxe as
  142.         the output file name.  Writes a character table before the data
  143.         begins.
  144.  
  145. uuxfer -r -emyfile.exe
  146.         Encodes myfile.exe using the character set specified in TABLE.UUX.
  147.         The operation will abort if problems are encountered while reading
  148.         TABLE.UUX.  UUXFER will also write a copy of this table before the
  149.         encoded data starts.
  150.  
  151.  
  152. Compiling UUXFER
  153.  
  154. UUXFER should compile as presented with a simple 'cc uuxfer.c' command on
  155. almost any system.  There are some enhancements targeted at particular
  156. environments, however.  If you are compiling UUXFER under an ANSI compliant
  157. C compiler, you should #define ANSI_C (see the initial screenful of code,
  158. remove the comment identifiers where necessary).  Under MS-DOS, you should
  159. #define MS_DOS via similar procedure.  A #define UNIX line is available for
  160. the UNIX environment (actually, this one is needed because certain header
  161. files must be included for proper compiling in UNIX boxes).
  162.  
  163. Three display options are supported; There is a TURBO_C mode which utilizes
  164. certain standard library functions under TURBO-C.  UUXFER supports the
  165. System V 'Curses' library if you #define CURSES.  Finally, UUXFER defaults
  166. to the DUMB_IO mode, where everything is simple and stupid.  This mode is
  167. not visually appealing, but it should work on *any* compiler.
  168.  
  169. Note for lawyers: MS-DOS is a registered trademark of Microsoft, Inc.
  170. `System V' and `Curses' are registered trademarks of AT&T, Inc.
  171.  
  172.  
  173. REGISTRATION information
  174.  
  175. UUXFER v 2.0 is shareware, which means that you are free to distribute it
  176. to anyone, as long as you distribute all associated files (namely uuxfer20.c
  177. and uuxfer20.doc).  Further, you are free to use UUXFER without payment
  178. for a period of up to thirty (30) days, after which you must register it
  179. if you are to continue using it.
  180.  
  181. Registered users will receive updates of UUXFER as they are written;
  182. updates will be sent free of charge via electronic mail, or on diskette
  183. (if available for user's computer) for a nominal fee.
  184.  
  185. To register your copy of UUXFER, simply fill out the form below (or
  186. just write the requested information down on a piece of paper),
  187. and send it with a check or money order for $10 (made payable to David
  188. Read) to:
  189.  
  190.    Blade Technologies
  191.    Attn: David Read
  192.    6101 Balcones Dr. Suite 300
  193.    Austin, TX 78731
  194.  
  195.    Registration form for UUXFER ver. 2.0:
  196.  
  197.       Your name:________________________________________
  198.  
  199.    Your address:________________________________________
  200.  
  201.            city:_____________________
  202.  
  203.           state:_______
  204.  
  205.             zip:_______
  206.  
  207.    How did you obtain your copy of UUXFER v. 2.0?
  208.  
  209.    [  ]  From an anonymous ftp archive
  210.  
  211.    [  ]  From UseNet (NetNews)
  212.  
  213.    [  ]  From a bulletin board
  214.  
  215.    [  ]  From a friend
  216.  
  217.    [  ]  Other (please specify: __________________________________________)
  218.  
  219.