home *** CD-ROM | disk | FTP | other *** search
/ APDL Public Domain 1 / APDL_PD1A.iso / compress / uuencode / !UUEncode / !Help < prev    next >
Encoding:
Text File  |  1991-11-09  |  5.1 KB  |  101 lines
  1.  
  2. BRIEF INSTRUCTIONS FOR UUencoder APPLICATION
  3. ============================================
  4.  
  5. (See also the release notes in the !UUEncode.ReadMe file)
  6.  
  7. (8-bit to 7-bit UUencoder for sending all types of file over 7-bit links,
  8. such as the packet-radio mail forwarding network.)
  9.  
  10. Install the 'UU' icon on the icon bar by double-clicking on the '!UUencode'
  11. icon.
  12.  
  13. If you click the Menu (middle) mouse button on the 'UU' icon, an Options
  14. window will pop up. The default settings are fully compatible with UUBeeb,
  15. (UUencoder/decoder for the BBC Micro family), and allow the splitting of
  16. encoded files into 5k sections; small enough for forwarding via the UK
  17. packet network.
  18.  
  19. The defaults* supplied are suitable for most occasions, but if sending files
  20. direct station-to-station on a quiet frequency, you may prefer to set longer
  21. sections, or no sectioning at all.
  22.  
  23. You may make temporary changes by altering the values, and then clicking on
  24. the 'OK' box. To make these changes become the new defaults, click on the
  25. 'Save options' box instead. After making temporary changes, you can reload
  26. the defaults by clicking on the 'Load options' box. For normal use, make sure
  27. the option to encode nuls as &60 (') is selected. The option to encode them
  28. as &20 (Space) is provided only in case it is required for compatibility with
  29. other systems.
  30.  
  31. To encode a file, simply drag its icon onto the UU icon on the icon bar. A
  32. Save window will pop up. Alter the embedded filename if required; by default
  33. it is the original one. The Save filename for the encoded version is the
  34. original filename, but with the figure '1' appended. If the filename is too
  35. long to allow this, ie 10 characters long, it is truncated to 9. You may
  36. alter this filename if you wish, but it must still end in the figure '1'.
  37.  
  38. If the encoded file is broken into sections, subsequent sections will have
  39. '2' '3' etc. appended instead of '1'. If the filename is too long to allow
  40. '10' '11' etc. to be appended once the first 9 sections have been completed,
  41. it is then truncated by a further character.
  42.  
  43. The files are created under the multi-tasking desktop environment. Until the
  44. final section is complete, the 'UU' icon changes colour to show that it is
  45. 'busy'. In the first release version, it is not possible to abort encoding
  46. by pressing <Escape>, or by using the Mouse.
  47.  
  48. The resulting files are compatible with !Edit, but you will need to use the
  49. CR<->LF swap option from within !Edit if you want to examine the file or add
  50. comments. You can add text before and after the UUencoded section, ie turn
  51. it into a message, as long as the encoded part is left alone.
  52.  
  53. If your TNC driver software cannot deal with 'raw' !Edit files, reverse the
  54. CR<->LF swap before saving it. If your software CAN handle raw !Edit files,
  55. you may find it more convenient to alter the !UUencode default newline
  56. option from 'CR' to 'LF'. This will allow you to examine, modify, save and
  57. send the files without carrying out the CR<->LF swap at all.
  58.  
  59. The original Load and Execution addresses are preserved, (or the filetype
  60. and time/date if the files were saved by a 'native' application). If a
  61. BASIC program with filetype set to BASIC is encoded on an Archimedes, but
  62. later decoded on a BBC Micro, the addresses will look very strange.
  63. Nevertheless, the program can be LOADed and CHAINed in the usual way.
  64. Similar comments apply to data files and text files.
  65.  
  66. If a BASIC program is encoded on a BBC Micro, but decoded on an Archimedes,
  67. the filetype will not be set, and the file is said to be 'unstamped'.
  68. Double-clicking on such as file will not cause it to run from the desktop,
  69. as no run action has been specified. However, it may be LOADed and CHAINed
  70. from BASIC without difficulty, and if SAVEd from BASIC the filetype will
  71. automatically be set to BASIC and the problem is solved. Alternatively,
  72. there are several public-domain and copyright utilities for changing the
  73. filetype from the desktop.
  74.  
  75. In order to minimise the amount of data to be encoded, it is strongly
  76. recommended that you compress the original file or application using the
  77. !Spark utility, before UUencoding the resulting file. As well as reducing
  78. the amount of data, it overcomes the problem of UUencoding directory
  79. structures. After UUdecoding, the file can then be expanded again using
  80. !Spark or the Public Domain utuility called !Sparkplug. This technique is
  81. widely used on telephone BBSs.
  82.  
  83. Application written by Andrew Benham G8FSL. !UUencode has been released into
  84. the Public Domain, though the author retains copyright. Unmodified copies
  85. may be freely distributed, provided they are accompanied by this
  86. documentation file, and not for profit. Modest ShareWare/CareWare
  87. distribution charges are acceptable, and any monies due to the author should
  88. be donated to charity.
  89.  
  90. ReadMe file by Rick Sterry G4BLT @ GB7WRG. Initial queries to G4BLT please.
  91.  
  92. Rick Sterry, 1 Wavell Garth, Sandal Magna, WAKEFIELD, West Yorks., WF2 6JP.
  93.  
  94. * Default options are:
  95.   Newline Character -  CR  (better to use LF if your TNC driver can cope)
  96.   Encode nulls as   - &60
  97.   Output File       - Sectioned
  98.   Section size      - 1000 min 5K max
  99.  
  100. NB: There are now more choices - see the release notes
  101.