home *** CD-ROM | disk | FTP | other *** search
/ Peanuts NeXT Software Archives / Peanuts-2.iso / Unix / archiver / btoa.README < prev    next >
Encoding:
Text File  |  1989-12-27  |  3.2 KB  |  77 lines
  1.              BTOA version 5.2
  2.             ------------------
  3. Written by Paul Rutter, Joe Orost & Stefan Parmark.
  4.  
  5.  
  6. Btoa was created from atob/btoa which were submitted to Usenet
  7. by Paul E. Rutter. Atob and btoa has now been merged into one
  8. program, now refered to as btoa.
  9.  
  10. Btoa converts 4 binary characters to 5 ascii ones, causing a 25%
  11. expansion. Spaces will not be used, which should make it safe
  12. to send files over Usenet without risking that blanks become
  13. tabs. 
  14.  
  15. Decoding, which previously was done with atob, is now an option
  16. of btoa. See the manual for details.
  17.  
  18. One of the drawbacks with the previous version of btoa was that,
  19. if there was an error in the file, atob only stated so, but gave
  20. no clue to its location. It used a checksum covering the
  21. total file, making it impossible to detect where the error was.
  22. I added a single-byte checksum for each row.
  23.  
  24. Further, the file contained no information about the name of the
  25. output file. Rather, stdout was used. Version 5.0 has the feature
  26. to name the file contents. It can be turned off by reading data
  27. from stdin.
  28.  
  29. A totally new feature is the ability to mend corrupted archives.
  30. This can be done as long as the header and last line are OK.
  31. It detects bad lines, informs the remote computer about this,
  32. which retransmits these lines in a special file, which btoa uses
  33. to repair the archive. See the manual for more details.
  34.  
  35. Btoa uses characters between '!' and 'u'. Special characters are
  36. 'z' meaning 4 consecutive zeros, 'y' meaning 4 spaces, and
  37. 'x' as an end-of-archive mark. The 'y' was added be me, and will
  38. not be recognized by the old version.
  39.  
  40. Old btoa encoding is still possible, as an extra option (see the
  41. manual). When decoding, btoa can tell if it's the old or new btoa
  42. format by looking at the header.
  43.  
  44. I removed the feature to exit with no output if there was en error
  45. in the archive. This was done by using a temporary file for
  46. storage. This is not a good idea for micro computer folks like
  47. me, with limited storage possibilities. I hope all realize that
  48. you shouldn't run a file that was created from a corrupted archive.
  49.  
  50. Most of the code was rewritten in order to make it execute faster.
  51. Special efforts have been made to optimize the atob part.
  52. Measured speeds are 30 kbyte/s on a Sun-3 and 4 kbyte/s on an
  53. Amiga. On the Amiga I used the VD0: recoverable RAM disk without
  54. FFS.
  55.  
  56. I have tested btoa on an Amiga 1000 and a Sun-3, and it has
  57. worked very well. If you find it doesn't work on your favourite
  58. computer, drop me a note to one of the addresses below, preferably
  59. the top one, and I'll see what I can do. Also, if you port and/or
  60. improve it, please send me the diffs, and I'll include them in the
  61. next release.
  62.  
  63. ---------------------- DISCLAIMER -------------------------------
  64.  
  65. I assume no responsibility for the use of btoa. It should work OK,
  66. and I have included lots of tests to make sure that files open,
  67. end-of-file is detected, etc.
  68.  
  69. Btoa is in the public domain. You may use it, give it away, and
  70. make improvements, as long as the names of the developers are
  71. mentioned and you don't use it to earn money. It may NOT be used
  72. commercially without my permission.
  73.  
  74. /Stefan Parmark
  75.         d84sp@efd.lth.se
  76.         d84spa@rigel.sunet.se
  77.