4.3BSD-Reno/src/usr.bin/uuencode/uuencode.format.5

.\" Copyright (c) 1989 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms are permitted provided
.\" that: (1) source distributions retain this entire copyright notice and
.\" comment, and (2) distributions including binaries display the following
.\" acknowledgement:  ``This product includes software developed by the
.\" University of California, Berkeley and its contributors'' in the
.\" documentation or other materials provided with the distribution and in
.\" all advertising materials mentioning features or use of this software.
.\" Neither the name of the University nor the names of its contributors may
.\" be used to endorse or promote products derived from this software without
.\" specific prior written permission.
.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
.\"
.\"	@(#)uuencode.format.5	6.3 (Berkeley) 6/23/90
.\"
.TH UUENCODE 5 "June 23, 1990"
.AT 3
.SH NAME
uuencode \- format of an encoded uuencode file
.SH DESCRIPTION
Files output by
.I uuencode(1)
consist of a header line,
followed by a number of body lines,
and a trailer line.
.I Uudecode(1)
will ignore any lines preceding the header or
following the trailer.
Lines preceding a header must not, of course,
look like a header.
.PP
The header line is distinguished by having the first
6 characters \*(lqbegin\ \*(rq.
The word
.I begin
is followed by a mode (in octal),
and a string which names the remote file.
A space separates the three items in the header line.
.PP
The body consists of a number of lines, each at most 62 characters
long (including the trailing newline).
These consist of a character count,
followed by encoded characters,
followed by a newline.
The character count is a single printing character,
and represents an integer, the number of bytes
the rest of the line represents.
Such integers are always in the range from 0 to 63 and can
be determined by subtracting the character space (octal 40)
from the character.
.PP
Groups of 3 bytes are stored in 4 characters, 6 bits per character.
All are offset by a space to make the characters printing.
The last line may be shorter than the normal 45 bytes.
If the size is not a multiple of 3, this fact can be determined
by the value of the count on the last line.
Extra garbage will be included to make the character count a multiple
of 4.
The body is terminated by a line with a count of zero.
This line consists of one ASCII space.
.PP
The trailer line consists of \*(lqend\*(rq on a line by itself.
.SH "SEE ALSO"
uuencode(1), uudecode(1), uusend(1), uucp(1), mail(1)