Commit | Line | Data |
---|---|---|
334a2eb3 KB |
1 | .\" Copyright (c) 1989 The Regents of the University of California. |
2 | .\" All rights reserved. | |
3 | .\" | |
4 | .\" Redistribution and use in source and binary forms are permitted | |
5 | .\" provided that the above copyright notice and this paragraph are | |
6 | .\" duplicated in all such forms and that any documentation, | |
7 | .\" advertising materials, and other materials related to such | |
8 | .\" distribution and use acknowledge that the software was developed | |
9 | .\" by the University of California, Berkeley. The name of the | |
10 | .\" University may not be used to endorse or promote products derived | |
11 | .\" from this software without specific prior written permission. | |
12 | .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR | |
13 | .\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED | |
14 | .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. | |
15 | .\" | |
91a0f057 | 16 | .\" @(#)uuencode.format.5 6.2 (Berkeley) %G% |
7e547544 | 17 | .\" |
d03ca85b | 18 | .TH UUENCODE 5 "" |
7e547544 KM |
19 | .AT 3 |
20 | .SH NAME | |
21 | uuencode \- format of an encoded uuencode file | |
22 | .SH DESCRIPTION | |
23 | Files output by | |
334a2eb3 | 24 | .I uuencode(1) |
7e547544 KM |
25 | consist of a header line, |
26 | followed by a number of body lines, | |
27 | and a trailer line. | |
334a2eb3 | 28 | .I Uudecode(1) |
7e547544 KM |
29 | will ignore any lines preceding the header or |
30 | following the trailer. | |
31 | Lines preceding a header must not, of course, | |
32 | look like a header. | |
33 | .PP | |
34 | The header line is distinguished by having the first | |
35 | 6 characters \*(lqbegin\ \*(rq. | |
36 | The word | |
37 | .I begin | |
38 | is followed by a mode (in octal), | |
39 | and a string which names the remote file. | |
40 | A space separates the three items in the header line. | |
41 | .PP | |
42 | The body consists of a number of lines, each at most 62 characters | |
43 | long (including the trailing newline). | |
44 | These consist of a character count, | |
45 | followed by encoded characters, | |
46 | followed by a newline. | |
47 | The character count is a single printing character, | |
48 | and represents an integer, the number of bytes | |
49 | the rest of the line represents. | |
50 | Such integers are always in the range from 0 to 63 and can | |
51 | be determined by subtracting the character space (octal 40) | |
52 | from the character. | |
53 | .PP | |
54 | Groups of 3 bytes are stored in 4 characters, 6 bits per character. | |
55 | All are offset by a space to make the characters printing. | |
56 | The last line may be shorter than the normal 45 bytes. | |
57 | If the size is not a multiple of 3, this fact can be determined | |
58 | by the value of the count on the last line. | |
59 | Extra garbage will be included to make the character count a multiple | |
60 | of 4. | |
61 | The body is terminated by a line with a count of zero. | |
62 | This line consists of one ASCII space. | |
63 | .PP | |
64 | The trailer line consists of \*(lqend\*(rq on a line by itself. | |
8df5acc2 | 65 | .SH "SEE ALSO" |
334a2eb3 | 66 | uuencode(1), uudecode(1), uusend(1), uucp(1), mail(1) |