Return to uuencode.format.5 CVS log

Up to [local] / src / usr.bin / uuencode

Annotation of src/usr.bin/uuencode/uuencode.format.5, Revision 1.1.1.1

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