BSD 4_3_Net_2 release

[unix-history] / usr / src / usr.bin / uuencode / uuencode.format.5

diff --git a/usr/src/usr.bin/uuencode/uuencode.format.5 b/usr/src/usr.bin/uuencode/uuencode.format.5
index ec5e660..14a8751 100644 (file)
--- a/usr/src/usr.bin/uuencode/uuencode.format.5
+++ b/usr/src/usr.bin/uuencode/uuencode.format.5
@@ -1,34 +1,65 @@
-.\" Copyright (c) 1989 The Regents of the University of California.
+.\" Copyright (c) 1989, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" %sccs.include.redist.man%
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. 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.

 .\"
 .\"

-.\"    @(#)uuencode.format.5   6.3 (Berkeley) %G%
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.TH UUENCODE 5 ""
-.AT 3
-.SH NAME
-uuencode \- format of an encoded uuencode file
-.SH DESCRIPTION
+.\"     @(#)uuencode.format.5  6.4 (Berkeley) 5/10/91
+.\"
+.Dd May 10, 1991
+.Dt UUENCODE 5
+.Os BSD 4.0
+.Sh NAME
+.Nm uuencode
+.Nd format of an encoded uuencode file
+.Sh DESCRIPTION

 Files output by
 Files output by

-.I uuencode(1)
+.Xr uuencode 1

 consist of a header line,
 followed by a number of body lines,
 and a trailer line.
 consist of a header line,
 followed by a number of body lines,
 and a trailer line.

-.I Uudecode(1)
+The
+.Xr uudecode 1
+command

 will ignore any lines preceding the header or
 following the trailer.
 Lines preceding a header must not, of course,
 look like a header.
 will ignore any lines preceding the header or
 following the trailer.
 Lines preceding a header must not, of course,
 look like a header.

-.PP
+.Pp

 The header line is distinguished by having the first
 The header line is distinguished by having the first

-6 characters \*(lqbegin\ \*(rq.
+6 characters
+.Dq begin\ \&

 The word
 The word

-.I begin
+.Em 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.
 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
+.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,
 The body consists of a number of lines, each at most 62 characters
 long (including the trailing newline).
 These consist of a character count,


@@ -40,7 +71,7 @@ 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.
 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
+.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.
 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.


@@ -49,8 +80,22 @@ 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.
 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)
+This line consists of one
+.Tn ASCII
+space.
+.Pp
+The trailer line consists of
+.Dq end
+on a line by itself.
+.Sh SEE ALSO
+.Xr uuencode 1 ,
+.Xr uudecode 1 ,
+.Xr uusend 1 ,
+.Xr uucp 1 ,
+.Xr mail 1
+.Sh HISTORY
+The
+.Nm
+file format appeared in
+.Bx 4.0 .
+.\" It was named uuencode.5 prior to 4.3