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.\"
34.Dd January 12, 1994
35.Dt UUENCODE 5
36.Os BSD 4
37.Sh NAME
38.Nm uuencode
39.Nd format of an encoded uuencode file
40.Sh DESCRIPTION
41Files output by
42.Xr uuencode 1
43consist of a header line,
44followed by a number of body lines,
45and a trailer line.
46The
47.Xr uudecode 1
48command
49will ignore any lines preceding the header or
50following the trailer.
51Lines preceding a header must not, of course,
52look like a header.
53.Pp
54The header line is distinguished by having the first
556 characters
56.Dq begin\ \&
57(note the trailing space).
58The word
59.Em begin
60is followed by a mode (in octal),
61and a string which names the remote file.
62A space separates the three items in the header line.
63.Pp
64The body consists of a number of lines, each at most 62 characters
65long (including the trailing newline).
66These consist of a character count,
67followed by encoded characters,
68followed by a newline.
69The character count is a single printing character,
70and represents an integer, the number of bytes
71the rest of the line represents.
72Such integers are always in the range from 1 to 45 or 64 and can
73be determined by subtracting the character space (octal 40)
74from the character.
75Character 64 represents a count of zero.
76.Pp
77Groups of 3 bytes are stored in 4 characters, 6 bits per character.
78All characters are always in range from 1 to 64 and are offset by a
79space (octal 40) to make the characters printing. Character
8064 represents a count of zero.
81The last line may be shorter than the normal 45 bytes.
82If the size is not a multiple of 3, this fact can be determined
83by the value of the count on the last line.
84Extra garbage will be included to make the character count a multiple
85of 4.
86The body is terminated by a line with a count of zero.
87This line consists of one
88.Tn ASCII
89backquote (octal 140) character.
90.Pp
91The trailer line consists of
92.Dq end
93on a line by itself.
94.Sh SEE ALSO
95.Xr mail 1 ,
96.Xr uucp 1 ,
97.Xr uudecode 1 ,
98.Xr uuencode 1
99.Sh HISTORY
100The
101.Nm uuencode
102file format appeared in
103.Bx 4.0 .
104.\" It was named uuencode.5 prior to 4.3
105