usr.bin/uuencode/uuencode.format.5

   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 .\" $FreeBSD: src/usr.bin/uuencode/uuencode.format.5,v 1.8.2.4 2001/10/18 10:27:01 ru Exp $
  34 .\" $DragonFly: src/usr.bin/uuencode/uuencode.format.5,v 1.2 2003/06/17 04:29:33 dillon Exp $
  35 .\"
  36 .Dd January 12, 1994
  37 .Dt UUENCODE 5
  38 .Os
  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 1 to 45 or 64 and can
  75 be determined by subtracting the character space (octal 40)
  76 from the character.
  77 Character 64 represents a count of zero.
  78 .Pp
  79 Groups of 3 bytes are stored in 4 characters, 6 bits per character.
  80 All characters are always in range from 1 to 64 and are offset by a
  81 space (octal 40) to make the characters printing.
  82 Character
  83 64 represents a count of zero.
  84 The last line may be shorter than the normal 45 bytes.
  85 If the size is not a multiple of 3, this fact can be determined
  86 by the value of the count on the last line.
  87 Extra null characters will be included to make the character count a multiple
  88 of 4.
  89 The body is terminated by a line with a count of zero.
  90 This line consists of one
  91 .Tn ASCII
  92 backquote (octal 140) character.
  93 .Pp
  94 The trailer line consists of
  95 .Dq end
  96 on a line by itself.
  97 .Sh SEE ALSO
  98 .Xr mail 1 ,
  99 .Xr uucp 1 ,
 100 .Xr uudecode 1 ,
 101 .Xr uuencode 1
 102 .Sh HISTORY
 103 The
 104 .Nm
 105 file format appeared in
 106 .Bx 4.0 .
 107 .\" It was named uuencode.5 prior to 4.3