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