home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / comms / u2 / !U2 / Manual < prev    next >
Text File  |  1993-05-26  |  14KB  |  325 lines
  1.                 +-------------------------------------+
  2.                 | Manual for ALT-itude Software's !U2 |
  3.                 +-------------------------------------+
  4.                 
  5.                      This software is FREEWARE.
  6.                 It may be freely distributed so long
  7.                   as no money is exchanged, except
  8.                    to cover costs of distribution
  9.                       ie post & packing or the
  10.                         cost of the disk and
  11.                     all the files are included in 
  12.                       the distributed version.
  13.  
  14.            This software is (C) 1992-3 ALT-itude Software
  15.  
  16. You are not *required* to register your copy, but doing so will enable us to 
  17. send you any upgrades as and when they become available, and to send us your
  18. comments etc.
  19.  
  20.  
  21. 1. Introduction
  22. ---------------
  23. !U2 is a RISC OS, multi-tasking binary to ascii convertor, using uuencoding 
  24. and decoding routines derived from those written by the University of 
  25. California for UNIX-UNIX transfers. 
  26.  
  27. The raison d'etre behind such conversions is most e-mailers' inability to 
  28. reliably handle any non-ascii characters; ie those with hex values outside 
  29. the range &032-&127.
  30.  
  31. !U2 is not the fastest uuen/decoder available under RISC OS (nor is it by 
  32. any means the slowest!), but it _does_ have more features than any other 
  33. we have come across, and we like it ;-) !
  34.  
  35. !U2 has two filetypes defined by it (these filetypes are subject to 
  36. verification by Acorn - we haven't asked them and they might want us to 
  37. use something else...):
  38.  
  39.         &00D - Decoded - a general (binary) decoded file
  40.         &00E - Encoded - a U2Encoded file
  41.  
  42. A U2Encoded file is, in essence, no different from an ordinary uuencoded 
  43. uuencoded file, but there are some RISC OS specific subtleties which are 
  44. explained below.
  45.  
  46. !U2's sprites are designed to be used with !DeskPatch. If you don't have 
  47. !DeskPatch, then don't worry - you won't notice anything amiss, but you're 
  48. missing out on a lot!
  49.  
  50. 2.Usage
  51. -------
  52.  
  53. 2.1 General
  54. -----------
  55. Double-click on the !U2 icon to load it, or double-click on an Encoded file 
  56. if !U2 has already been 'seen', this will load !U2 and begin decoding the 
  57. file.
  58.  
  59. To encode a binary file, drag it to the icon; to decode an encoded file, 
  60. either double-click on it or drag it to the icon. 
  61.  
  62. !U2 supports Ian Ashley's uuencoded filetype, &7FE, and treats plain text 
  63. files (&fff) as encoded. The latter can be loaded either by dragging to the 
  64. icon or double-clicking while holding down <CTRL>. 
  65. To decode a file encoded across several parts, place the parts, named in 
  66. order, in a directory and drag the directory to the !U2 icon. Decoding will 
  67. be slightly quicker if you name the directory and parts to similar names, 
  68. eg. files named Picture/01, Picture/02,... and the directory named Picture. 
  69. This isn't strictly necessary, but is advisable.
  70.  
  71. 2.2 Processing Options.
  72. -----------------------
  73.  
  74. 2.2.1 Encoding Options
  75. ----------------------
  76. The encoding options are controlled by the Options dialogue box (opened by 
  77. selecting 'Options...' in the iconbar menu) and by the 'Split' entry and 
  78. submenu. 
  79.  
  80. The Options dialogue box buttons perform the following:
  81.  
  82.   o <file>/uue       - names the encoded file as a (truncated) form of the 
  83.                        original filename, appended with /uue for compatib-
  84.                        ility with other systems (/ becomes replaced with .
  85.                        on UNIX/DOS systems).
  86.   o Enc_xx/uue       - names the encoded file with an incremented number.
  87.   o Include Filetype - includes the filetype of the original file in the 
  88.                        encoding.
  89.  
  90. 'Split' will split the encoding across several files. This is particularly 
  91. useful if you wish to encode a file which is several hundred kbytes big, as 
  92. most e-mailers have a maximum size of file which they will mail. If ticked, 
  93. !U2 will create a directory (called <file>~) and spread the encoding across 
  94. files named <file>/00, <file>/01, etc. If the original file starts with '!', 
  95. !U2 will replace this with a '>' so as to avoid any truck with problems with 
  96. application shells.
  97.  
  98. The Split submenu contains three entries: 'Lines', KBytes', and a writeable, 
  99. numeric entry. This enables you to enter a number to govern the size of each 
  100. part of the split encoding, and whether !U2 interprets this number as the 
  101. size of each part in lines or KBytes. 1300 lines is approximately equal to 
  102. 80 Kb, and is the default. !U2 will default to a value of 4k (66 lines) if 
  103. a lower value is entered. The number shown is the size of the parts as 
  104. specified by which entry is ticked. If you enter a number, then click on the 
  105. unticked entry, the number will change. (Try it - you'll see what we mean.)  
  106.  
  107. You should note that RISC OS (3.10 and earlier) allows a _maximum_ of 77 
  108. files per directory. !U2 will inform you if you enter a value which would 
  109. result in more than 77 parts.
  110.  
  111. A U2Encoded Sprite with 'Split' and 'Include' selected will begin 
  112. something like this:
  113.  
  114. +--BEGIN-Cut here-[screen part 01 of 01]----------------------+
  115. begin ff9 screen
  116. M`0```!````#\GP``[)\``'-C<F5E;@```````#````#/`````````!,```"L
  117. M````K`````P`````____`/___P#=W=T`W=W=`+N[NP"[N[L`F9F9`)F9F0!W
  118.  
  119. and end something like this:
  120.  
  121. M=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W
  122. "!P!W
  123. `
  124. end
  125. +--END-Cut here-[screen part 01 of 01]------------------------+
  126.  
  127. whereas if neither are selected it looks like this:
  128.  
  129. +--BEGIN Cut here [ screen] ------------------------------------+
  130. begin 660 screen
  131. M`0```!````#\GP``[)\``'-C<F5E;@```````#````#/`````````!,```"L
  132. M````K`````P`````____`/___P#=W=T`W=W=`+N[NP"[N[L`F9F9`)F9F0!W
  133.  
  134. and this:
  135.  
  136. M=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W=W
  137. "!P!W
  138. `
  139. end
  140. +-- END Cut here [ screen] -------------------------------------+
  141.  
  142. If you choose a size which is a little too close to a factor of the total 
  143. encoded size, then the 'cut' lines may say the wrong number of parts, eg 
  144. they may say 'part 03 of 04' when there _are_ only 3 parts. Don't worry 
  145. about this - !U2 will do a full encoding or none at all. You might want to 
  146. choose a different size, though, or inform whomever is receiving the parts 
  147. that you really have sent all of them!
  148.  
  149. Other uudecoders will treat the hex number in the 'begin' line as the 
  150. access codes for the file. Other Acorn uudecoders will look for the filetype 
  151. in an extra line at the start of the file. We decided to have the filetype 
  152. included in the 'begin' line. However, we recognise that if this file is 
  153. decoded on a non-Acorn system, or with a different decoder then this might 
  154. cause problems with file access, which is why you have the choice of 
  155. including the filetype or not. 
  156.  
  157. The filename of the binary file is included in the encoding. To make things 
  158. as easy as possible for the user, any '/'s in the Acorn filename will be 
  159. written as '.'s in the encoded file. (!U2 retranslates these characters on 
  160. decoding.) Not doing this would cause problems with decoding on non-Acorn 
  161. systems. 
  162.  
  163. 2.2.2 Decoding Options
  164. ----------------------
  165. The encoding options are controlled by the Options dialogue box (opened by 
  166. selecting 'Options...' in the iconbar menu).
  167.  
  168.   o Original             - names the decoded binary file from the name 
  169.                            included in the 'begin' line of the encoded 
  170.                            file. Don't use this if the file doesn't have 
  171.                            such a name in the encoding.
  172.   o Dec_xx               - names the decoded binary file with an incremented 
  173.                            number.
  174.   o Set Decoded Filetype - sets the filetype of the decoded file, either by 
  175.                            reading it from the encoded file or by having it 
  176.                            entered in the writeable icon on the dialogue 
  177.                            box.
  178.     o Read               - will cause !U2 to look for the filetype in the 
  179.                            'begin' line. Don't use this if the file was not 
  180.                            encoded by !U2 with the 'Include' option set.
  181.                            Enter the filetype by hand as detailed below.
  182.     o User               - will cause !U2 to look for the filetype in the 
  183.