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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)uuencode.format.5   8.2 (Berkeley) 1/12/94
  29 .\" $FreeBSD: src/usr.bin/uuencode/uuencode.format.5,v 1.8.2.4 2001/10/18 10:27:01 ru Exp $
  30 .\" $DragonFly: src/usr.bin/uuencode/uuencode.format.5,v 1.2 2003/06/17 04:29:33 dillon Exp $
  31 .\"
  32 .Dd January 12, 1994
  33 .Dt UUENCODE 5
  34 .Os
  35 .Sh NAME
  36 .Nm uuencode
  37 .Nd format of an encoded uuencode file
  38 .Sh DESCRIPTION
  39 Files output by
  40 .Xr uuencode 1
  41 consist of a header line,
  42 followed by a number of body lines,
  43 and a trailer line.
  44 The
  45 .Xr uudecode 1
  46 command
  47 will ignore any lines preceding the header or
  48 following the trailer.
  49 Lines preceding a header must not, of course,
  50 look like a header.
  51 .Pp
  52 The header line is distinguished by having the first
  53 6 characters
  54 .Dq begin\ \&
  55 (note the trailing space).
  56 The word
  57 .Em begin
  58 is followed by a mode (in octal),
  59 and a string which names the remote file.
  60 A space separates the three items in the header line.
  61 .Pp
  62 The body consists of a number of lines, each at most 62 characters
  63 long (including the trailing newline).
  64 These consist of a character count,
  65 followed by encoded characters,
  66 followed by a newline.
  67 The character count is a single printing character,
  68 and represents an integer, the number of bytes
  69 the rest of the line represents.
  70 Such integers are always in the range from 1 to 45 or 64 and can
  71 be determined by subtracting the character space (octal 40)
  72 from the character.
  73 Character 64 represents a count of zero.
  74 .Pp
  75 Groups of 3 bytes are stored in 4 characters, 6 bits per character.
  76 All characters are always in range from 1 to 64 and are offset by a
  77 space (octal 40) to make the characters printing.
  78 Character
  79 64 represents a count of zero.
  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 null characters 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 backquote (octal 140) character.
  89 .Pp
  90 The trailer line consists of
  91 .Dq end
  92 on a line by itself.
  93 .Sh SEE ALSO
  94 .Xr mail 1 ,
  95 .Xr uucp 1 ,
  96 .Xr uudecode 1 ,
  97 .Xr uuencode 1
  98 .Sh HISTORY
  99 The
 100 .Nm
 101 file format appeared in
 102 .Bx 4.0 .
 103 .\" It was named uuencode.5 prior to 4.3