Annotation of src/usr.bin/uuencode/uuencode.5, Revision 1.8
1.7 aaron 1: .\" $OpenBSD: uuencode.5,v 1.6 1999/05/23 14:11:06 aaron Exp $
1.1 deraadt 2: .\" $NetBSD: uuencode.format.5,v 1.3 1994/11/17 07:39:45 jtc Exp $
3: .\"
4: .\" Copyright (c) 1989, 1991, 1993
5: .\" The Regents of the University of California. All rights reserved.
6: .\"
7: .\" Redistribution and use in source and binary forms, with or without
8: .\" modification, are permitted provided that the following conditions
9: .\" are met:
10: .\" 1. Redistributions of source code must retain the above copyright
11: .\" notice, this list of conditions and the following disclaimer.
12: .\" 2. Redistributions in binary form must reproduce the above copyright
13: .\" notice, this list of conditions and the following disclaimer in the
14: .\" documentation and/or other materials provided with the distribution.
15: .\" 3. All advertising materials mentioning features or use of this software
16: .\" must display the following acknowledgement:
17: .\" This product includes software developed by the University of
18: .\" California, Berkeley and its contributors.
19: .\" 4. Neither the name of the University nor the names of its contributors
20: .\" may be used to endorse or promote products derived from this software
21: .\" without specific prior written permission.
22: .\"
23: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33: .\" SUCH DAMAGE.
34: .\"
35: .\" @(#)uuencode.format.5 8.2 (Berkeley) 1/12/94
36: .\"
37: .Dd January 12, 1994
38: .Dt UUENCODE 5
1.6 aaron 39: .Os
1.1 deraadt 40: .Sh NAME
41: .Nm uuencode
42: .Nd format of an encoded uuencode file
43: .Sh DESCRIPTION
44: Files output by
45: .Xr uuencode 1
46: consist of a header line,
47: followed by a number of body lines,
48: and a trailer line.
49: The
50: .Xr uudecode 1
51: command
52: will ignore any lines preceding the header or
53: following the trailer.
54: Lines preceding a header must not, of course,
55: look like a header.
56: .Pp
57: The header line is distinguished by having the first
58: 6 characters
59: .Dq begin\ \&
60: (note the trailing space).
61: The word
62: .Em begin
63: is followed by a mode (in octal),
64: and a string which names the remote file.
65: A space separates the three items in the header line.
66: .Pp
67: The body consists of a number of lines, each at most 62 characters
68: long (including the trailing newline).
69: These consist of a character count,
70: followed by encoded characters,
71: followed by a newline.
72: The character count is a single printing character,
73: and represents an integer, the number of bytes
74: the rest of the line represents.
75: Such integers are always in the range from 0 to 63 and can
76: be determined by subtracting the character space (octal 40)
77: from the character.
78: .Pp
79: Groups of 3 bytes are stored in 4 characters, 6 bits per character.
80: All are offset by a space to make the characters printing.
81: The last line may be shorter than the normal 45 bytes.
82: If the size is not a multiple of 3, this fact can be determined
83: by the value of the count on the last line.
84: Extra garbage will be included to make the character count a multiple
85: of 4.
86: The body is terminated by a line with a count of zero.
87: This line consists of one
88: .Tn ASCII
1.3 deraadt 89: \` (opening single quote) character.
1.1 deraadt 90: .Pp
91: The trailer line consists of
92: .Dq end
93: on a line by itself.
94: .Sh SEE ALSO
1.5 alex 95: .Xr mail 1 ,
1.4 aaron 96: .Xr uudecode 1 ,
1.5 alex 97: .Xr uuencode 1
1.1 deraadt 98: .Sh HISTORY
99: The
1.7 aaron 100: .Nm
1.1 deraadt 101: file format appeared in
102: .Bx 4.0 .
103: .\" It was named uuencode.5 prior to 4.3