bin/uuencode/uuencode.1

   1 .\" Copyright (c) 1980, 1990, 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.1  8.1 (Berkeley) 6/6/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd January 27, 2002
  32 .Dt UUENCODE 1
  33 .Os
  34 .Sh NAME
  35 .Nm uuencode ,
  36 .Nm uudecode ,
  37 .Nm b64encode ,
  38 .Nm b64decode
  39 .Nd encode/decode a binary file
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl m
  43 .Op Fl r
  44 .Op Fl o Ar output_file
  45 .Op Ar file
  46 .Ar name
  47 .Nm uudecode
  48 .Op Fl cimprs
  49 .Op Ar
  50 .Nm uudecode
  51 .Op Fl i
  52 .Fl o Ar output_file
  53 .Nm b64encode
  54 .Op Fl r
  55 .Op Fl o Ar output_file
  56 .Op Ar file
  57 .Ar name
  58 .Nm b64decode
  59 .Op Fl cimprs
  60 .Op Ar
  61 .Nm b64decode
  62 .Op Fl i
  63 .Fl o Ar output_file
  64 .Op Ar file
  65 .Sh DESCRIPTION
  66 The
  67 .Nm
  68 and
  69 .Nm uudecode
  70 utilities are used to transmit binary files over transmission mediums
  71 that do not support other than simple
  72 .Tn ASCII
  73 data.
  74 The
  75 .Nm b64encode
  76 utility is synonymous with
  77 .Nm
  78 with the
  79 .Fl m
  80 flag specified.
  81 The
  82 .Nm b64decode
  83 utility is synonymous with
  84 .Nm uudecode
  85 with the
  86 .Fl m
  87 flag specified.
  88 .Pp
  89 The
  90 .Nm
  91 utility reads
  92 .Ar file
  93 (or by default the standard input) and writes an encoded version
  94 to the standard output, or
  95 .Ar output_file
  96 if one has been specified.
  97 The encoding uses only printing
  98 .Tn ASCII
  99 characters and includes the
 100 mode of the file and the operand
 101 .Ar name
 102 for use by
 103 .Nm uudecode .
 104 .Pp
 105 The
 106 .Nm uudecode
 107 utility transforms
 108 .Em uuencoded
 109 files (or by default, the standard input) into the original form.
 110 The resulting file is named either
 111 .Ar name
 112 or (depending on options passed to
 113 .Nm uudecode )
 114 .Ar output_file
 115 and will have the mode of the original file except that setuid
 116 and execute bits are not retained.
 117 The
 118 .Nm uudecode
 119 utility ignores any leading and trailing lines.
 120 .Pp
 121 The following options are available for
 122 .Nm :
 123 .Bl -tag -width ident
 124 .It Fl m
 125 Use the Base64 method of encoding, rather than the traditional
 126 .Nm
 127 algorithm.
 128 .It Fl r
 129 Produce raw output by excluding the initial and final framing lines.
 130 .It Fl o Ar output_file
 131 Output to
 132 .Ar output_file
 133 instead of standard output.
 134 .El
 135 .Pp
 136 The following options are available for
 137 .Nm uudecode :
 138 .Bl -tag -width ident
 139 .It Fl c
 140 Decode more than one uuencoded file from
 141 .Ar file
 142 if possible.
 143 .It Fl i
 144 Do not overwrite files.
 145 .It Fl m
 146 When used with the
 147 .Fl r
 148 flag, decode Base64 input instead of traditional
 149 .Nm
 150 input.
 151 Without
 152 .Fl r
 153 it has no effect.
 154 .It Fl o Ar output_file
 155 Output to
 156 .Ar output_file
 157 instead of any pathname contained in the input data.
 158 .It Fl p
 159 Decode
 160 .Ar file
 161 and write output to standard output.
 162 .It Fl r
 163 Decode raw (or broken) input, which is missing the initial and
 164 possibly the final framing lines.
 165 The input is assumed to be in the traditional
 166 .Nm
 167 encoding, but if the
 168 .Fl m
 169 flag is used, or if the utility is invoked as
 170 .Nm b64decode ,
 171 then the input is assumed to be in Base64 format.
 172 .It Fl s
 173 Do not strip output pathname to base filename.
 174 By default
 175 .Nm uudecode
 176 deletes any prefix ending with the last slash '/' for security
 177 reasons.
 178 .El
 179 .Sh EXAMPLES
 180 The following example packages up a source tree, compresses it,
 181 uuencodes it and mails it to a user on another system.
 182 When
 183 .Nm uudecode
 184 is run on the target system, the file ``src_tree.tar.Z'' will be
 185 created which may then be uncompressed and extracted into the original
 186 tree.
 187 .Pp
 188 .Bd -literal -offset indent -compact
 189 tar cf \- src_tree \&| compress \&|
 190 uuencode src_tree.tar.Z \&| mail user@example.com
 191 .Ed
 192 .Pp
 193 The following example unpacks all uuencoded
 194 files from your mailbox into your current working directory.
 195 .Pp
 196 .Bd -literal -offset indent -compact
 197 uudecode -c < $MAIL
 198 .Ed
 199 .Pp
 200 The following example extracts a compressed tar
 201 archive from your mailbox
 202 .Pp
 203 .Bd -literal -offset indent -compact
 204 uudecode -o /dev/stdout < $MAIL | zcat | tar xfv -
 205 .Ed
 206 .Sh SEE ALSO
 207 .Xr basename 1 ,
 208 .Xr compress 1 ,
 209 .Xr mail 1 ,
 210 .Xr uuencode 5
 211 .Sh HISTORY
 212 The
 213 .Nm uudecode
 214 and
 215 .Nm
 216 utilities appeared in
 217 .Bx 4.0 .
 218 .Sh BUGS
 219 Files encoded using the traditional algorithm are expanded by 35% (3
 220 bytes become 4 plus control information).