From 272a9b3b47f03d63486030fde78fed90a9061360 Mon Sep 17 00:00:00 2001 From: deraadt Date: Sat, 25 Nov 1995 16:07:17 +0000 Subject: [PATCH] documentation repair; from andrew@wipux2.wifo.uni-mannheim.; netbsd pr #1786 --- usr.bin/uuencode/Makefile | 4 +- usr.bin/uuencode/uuencode.1 | 3 +- usr.bin/uuencode/uuencode.5 | 103 ++++++++++++++++++++++++++++++++++++ 3 files changed, 106 insertions(+), 4 deletions(-) create mode 100644 usr.bin/uuencode/uuencode.5 diff --git a/usr.bin/uuencode/Makefile b/usr.bin/uuencode/Makefile index 66d3ab072fa..ddc12769d82 100644 --- a/usr.bin/uuencode/Makefile +++ b/usr.bin/uuencode/Makefile @@ -1,8 +1,8 @@ # $NetBSD: Makefile,v 1.4 1994/12/22 12:31:20 cgd Exp $ # @(#)Makefile 8.1 (Berkeley) 6/6/93 -PROG= uuencode -MAN= uuencode.1 uuencode.format.5 +#PROG= uuencode +MAN= uuencode.1 uuencode.5 MLINKS= uuencode.1 uudecode.1 .include diff --git a/usr.bin/uuencode/uuencode.1 b/usr.bin/uuencode/uuencode.1 index 63a0c5d5cc1..566a06b1e5b 100644 --- a/usr.bin/uuencode/uuencode.1 +++ b/usr.bin/uuencode/uuencode.1 @@ -101,8 +101,7 @@ utilities exits 0 on success, and >0 if an error occurs. .Xr compress 1 , .Xr mail 1 , .Xr uucp 1 , -.Xr uuencode 5 , -.Xr format 5 +.Xr uuencode 5 .Sh STANDARDS The .Nm uudecode diff --git a/usr.bin/uuencode/uuencode.5 b/usr.bin/uuencode/uuencode.5 new file mode 100644 index 00000000000..7e741d6ddcf --- /dev/null +++ b/usr.bin/uuencode/uuencode.5 @@ -0,0 +1,103 @@ +.\" $NetBSD: uuencode.format.5,v 1.3 1994/11/17 07:39:45 jtc Exp $ +.\" +.\" Copyright (c) 1989, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" 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. +.\" +.\" 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. +.\" +.\" @(#)uuencode.format.5 8.2 (Berkeley) 1/12/94 +.\" +.Dd January 12, 1994 +.Dt UUENCODE 5 +.Os BSD 4 +.Sh NAME +.Nm uuencode +.Nd format of an encoded uuencode file +.Sh DESCRIPTION +Files output by +.Xr uuencode 1 +consist of a header line, +followed by a number of body lines, +and a trailer line. +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. +.Pp +The header line is distinguished by having the first +6 characters +.Dq begin\ \& +(note the trailing space). +The word +.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. +.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 +.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 uucp 1 , +.Xr mail 1 +.Sh HISTORY +The +.Nm uuencode +file format appeared in +.Bx 4.0 . +.\" It was named uuencode.5 prior to 4.3 -- 2.20.1