source: trunk/athena/bin/tarmail/btoa.1 @ 10

Revision 10, 1.8 KB checked in by jtkohl, 39 years ago (diff)
Initial revision
Line 
1.TH btoa LOCAL
2.SH NAME
3btoa, atob, tarmail, untarmail \- encode/decode binary to printable ASCII
4.SH SYNOPSIS
5.B btoa
6< inbinary
7> outtext
8.PP
9.B atob
10< intext
11> outbinary
12.PP
13.B tarmail
14who subject files ...
15.SH DESCRIPTION
16.I btoa
17is a filter that reads anything from the standard input, and encodes it into
18printable ASCII on the standard output.  It also attaches checksum
19information used by the reverse filter "atob" to check integrity.  atob gives
20NO output (and exits with an error message) if its input is garbage or the
21checksums do not check.
22.PP
23tarmail ralph here-it-is-ralph foo.c a.out
24.PP
25.I tarmail
26is a shell that tar's up all the given files, pipes them through btoa, and
27mails them to the given person with the given subject phrase.  "tarmail" with no
28args will print a short message reminding you what the required args are.
29When the mail is received at the other end, that person should use
30mail to save the
31message in some temporary file name (say "xx").  Then saying "untarmail xx"
32will decode the message and untar it.  By using tarmail, binary files and
33entire directory structures can be easily transmitted between machines.
34Naturally, you should understand what tar itself does before you use tarmail.
35.PP
36Other uses:
37.PP
38crypt < secrets | btoa | mail ralph
39.PP
40will mail the encrypted contents of the file "secrets" to ralph.  If ralph
41knows the encryption key, he can decode it by saving the mail (say in "xx"),
42and then running:
43.PP
44atob < xx | crypt
45.PP
46(crypt requests the key from the terminal,
47and the "secrets" come out on the terminal).
48.SH FILES
49/usr/local/bin:  the programs
50.SH AUTHOR
51Paul Rutter
52.SH FEATURES
53It uses a compact base-85 encoding so that
544 bytes are encoded into 5 characters.
55.SH BUGS
56It uses an obscure base-85 "squoz code" scheme
57to encode 4 bytes into 5 characters.
Note: See TracBrowser for help on using the repository browser.