home *** CD-ROM | disk | FTP | other *** search
/ Acorn User 2 / AUCD2.iso / internet / uucoder.spk / !UUcoder / !Help < prev    next >
Text File  |  1996-03-28  |  9KB  |  216 lines
  1. UUcoder 1.21
  2. ============
  3.  
  4.  
  5. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  6. + © John Allen 1994 - 1996.  This application is Freeware and is    +
  7. + supplied on the understanding that:                               + 
  8. +                                                                   + 
  9. + 1. The source code is not altered in any way                      +
  10. + 2. Any copies made contain all of the files in the directory      +
  11. + 3. It is not sold for a profit                                    +
  12. + 4. It is not included on any disc costing more than £2 or any     +
  13. +    CD Rom costing more than £20 without my prior permission       +           +                                                                   +
  14. +                                                                   +
  15. + Please contact me before adding it to a PD library so that I can  + 
  16. + supply an up to date version.                                     + 
  17. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  18.  
  19.  
  20. UUcoder codes and decodes uuencoded files such as might be sent and 
  21. received via Usenet newsgroups on the Internet.  It works totally on 
  22. the RISC OS desktop and is designed to work only under RISC OS 3.10 and 
  23. later versions.
  24.  
  25. As well as decoding single files it will also turn a series of messages 
  26. containing sections of a uu encoded file (such as might be found in 
  27. newsgroups with'binaries' in the title) into a single decoded file.  
  28.  
  29. Likewise it will split long coded files into short sections to send in 
  30. separate messages.
  31.  
  32. If a file does not contain uuencoded data UUcoder will check whether it 
  33. contains Mime base64 code, if so it will decode it.  At present UUcoder 
  34. will not decode multi-part base64 files.
  35.  
  36. UUcoder saves and loads files to and from the Scrap directory so will 
  37. run much better on a machine with a hard disc, but then Internet (or at 
  38. least Demon) would be a pain on a machine which only had floppy drives.
  39.  
  40. The following files should be included in the UUcoder directory:
  41.  
  42. !Boot
  43. !Help
  44. !History
  45. !Run
  46. !RunImage
  47. !Sprites
  48. !Sprites22
  49. Resources directory containing: Mapping, Messages, Sprites, Sprites22, 
  50.                                 Templates
  51.  
  52. Use 
  53. ===
  54.  
  55. Double click on the UUcoder icon in the Filer window.  This installs 
  56. UUcoder on the iconbar and opens the main coding and decoding window.
  57.  
  58. Clicking on the UUcoder icon on the iconbar will re-open the main 
  59. coding and decoding window if it has been closed.  If the window is 
  60. already open it will bring it to the top of any other windows that are 
  61. open.
  62.  
  63. UUcoder is designed to be simple to use.  To decode: drop a file on the 
  64. decode icon and to code drop it on the code icon.  The resulting file 
  65. can then be dragged where ever it is required.  The instructions below 
  66. are more detailed an explain the more advanced features:
  67.  
  68.  
  69. To decode a file or series of files:
  70.  
  71. 1. Use the Choices window (opens from the menu) to set whether any 
  72. PC-style file extension should be preserved on decoding.  This is 
  73. useful if the decoded file will eventually be used on a PC or the Risc 
  74. PC 486 card.  Options set can be saved to use as default on future 
  75. sessions with UUcoder by clicking select on the 'Save' con or used just 
  76. this time by clicking 'Use'.  
  77.  
  78. 2. Drag a file containing uuencoded data to the decode icon at the 
  79. bottom right of the main window.  There's no need to edit the header 
  80. off the file, just use the whole file.  UUcoder will detect whether it 
  81. is a complete uuencoded file or give a prompt for the next file in a 
  82. series.  Continue dragging the series of coded files to the decode icon 
  83. until UUcoder detects the end of the uuencoded data.  The files must be 
  84. dragged in order.
  85.  
  86. 3. UUcoder decodes the complete uuencoded file.
  87.  
  88. 3. Edit the supplied name as appropriate, then drag the file icon to a 
  89. Filer directory display or to another application.  Alternatively enter 
  90. the full pathname of the file and click select on the 'OK' icon.  
  91. Additionally you can double-click select over the file icon to load it 
  92. into an appropriate application (if known to RISC OS at the time of 
  93. clicking). 
  94.  
  95.  
  96. To encode a file:
  97.  
  98. 1. Use the Choices window (opens from the menu) to set up the way that 
  99. UUcoder should code the file.  Select the split file option if you 
  100. think that the resulting file will be longer than the maximum length of 
  101. an e-mail message (it can be as low as 60k on some parts of the 
  102. Internet).  With this option you should set the maximum file length 
  103. that your system allows.  These options can be saved to use as defaults 
  104. on future sessions with UUcoder by clicking select over the 'Save' icon 
  105. or used just this time by clicking 'Use'.  This dialogue box also 
  106. allows you to set default file names for the resulting encoded file.  
  107. These can be full filepaths if you wish.
  108.  
  109. 2. Drag the file you wish to encode to the code icon at the top right 
  110. of the main window.  If the file is being sent to someone with a PC 
  111. rather than an Arc it should be named with the appropriate file PC file 
  112. extension, using a "/" instead of a ".".  This ensures that the PC user 
  113. gets a correctly typed file when it is decoded.  For example a gif file 
  114. "mum" should be called "mum/gif" before dragging it to UUcoder.  It 
  115. will be uuencoded with the PC file name of "mum.gif".  If there is not 
  116. a PC style file extension UUcoder will save the RISC OS filetype with 
  117. the file so that its RISC OS filetype will be restored if it is decoded 
  118. by UUcoder.
  119.  
  120. 3. UUcoder will encode the file.
  121.  
  122. 4. Edit the file name supplied by UUcoder to the name you wish to save 
  123. the file under, and drag the file icon to a Filer directory display or 
  124. to another application.  Alternatively enter the full pathname and 
  125. click select on the 'OK' icon.  If you have the split option set, and 
  126. the file is longer than the maximum length, UUcoder will split the file 
  127. and keep presenting new part-files for you to save until the whole file 
  128. has been saved.
  129.  
  130.  
  131. Features 
  132. ========
  133.  
  134. * UUcoder will accept coded files direct from other applications so, 
  135. for example, you can use the 'Save File' option of TTFN to decode files 
  136. by dragging them to the UUcoder decode icon rather than saving them on 
  137. disc first.
  138.  
  139. * UUcoder will save coded files to other applications so, for example, 
  140. you can insert an encoded file (or section of file) into a message 
  141. being composed by TTFN.
  142.  
  143. * UUcoder will also transfer decoded files directly to and from other 
  144. applications which accept direct transfer.  Note that there is a bug in 
  145. Translatr which means it will not accept .jpg files unless you edit one 
  146. line in Translatr's !Run file.  The line that reads: 
  147.  
  148.           Set Translator$Scrap <Wimp$Scrap>
  149.  
  150. should be changed to point to a different file such as: 
  151.  
  152.           Set Translator$Scrap <Wimp$Scrap>2
  153.  
  154. * Double clicking a decoded file will attempt to load it into an 
  155. application that accepts that filetype.  Note that some applications 
  156. (e.g. Spark) do not take possession of files loaded this way so it is 
  157. vital that the file is processed and saved elsewhere before UUcoder is 
  158. closed down - as all UUcoder working files in the Scrap directory are 
  159. deleted on closedown.
  160.  
  161. * Closing the main window part way through any operation will destroy 
  162. the unsaved data (as per Acorn's guidelines).  To keep the data while 
  163. closing the UUcoder main window, hold the shift key down when closing 
  164. it.  This will iconise the window on the pinboard allowing it to be 
  165. reopened by double clicking select on the window icon.
  166.  
  167. * UUcoder uses solid sprite dragging if you have it enabled on your 
  168. machine.
  169.  
  170. * UUcoder will put the RISC OS filetype at the end of any file it codes 
  171. (except files which already have PC file extensions).  When decoding 
  172. files UUcoder will check whether there is a RISC OS filetype given 
  173. after the file and will use it to filetype the decoded file.
  174.  
  175. * UUcoder will translate PC-type file extensions to RISC OS filetypes 
  176. according to the host machines DOSMap settings and (if no DosMap 
  177. setting exists) with supplied translations in the file 
  178. Resources.Mapping.  This means that output files can be double clicked 
  179. to load them into image translators such as ChangeFSI, Translatr or 
  180. FYEO2 (.jpg, .gif and tif), an MPEG viewer (.mpg) or a de-archiver such 
  181. as Spark (.arc .tar and .zip).
  182.  
  183. * Interactive Help is supported for the main window, dialogue boxes and 
  184. menus.
  185.  
  186. * Combines and decodes files which have been downloaded on a PC where 
  187. lines end <CR><LF> rather than <LF> in RISC OS.
  188.  
  189. * If UUcoder is given a file to decode which does not contain uucode it 
  190. will check whether the contents are Mime base64 code and, if so, decode 
  191. it.  At present this only works for the first section of base64 data in 
  192. a file and will not reconstruct multi-part messages.
  193.  
  194.  
  195. Background
  196. ==========
  197.  
  198. UUcoded files are put on the Internet in a wide range of forms.  This 
  199. means that it is not always easy to detect the start and end of 
  200. sections of code which need to be combined before decoding.  UUcoder 
  201. makes intelligent guesses but I would welcome examples of files where 
  202. UUcoder does not produce a valid output file.  In cases of doubt you 
  203. can edit 'END' as the line after the last coded line of a file, this 
  204. clearly signifies to UUcoder that it has reached the end of a section 
  205. and to request another file.
  206.  
  207.  
  208.  
  209. Any comments, queries, donations or bug reports to:
  210.  
  211. John Allen.
  212.  
  213. E-mail: john@bramber.demon.co.uk 
  214. Arcade: #917 
  215. Silicon Village: 819991215
  216.