usr.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. 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.1  8.1 (Berkeley) 6/6/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd January 27, 2002
  36 .Dt UUENCODE 1
  37 .Os
  38 .Sh NAME
  39 .Nm uuencode ,
  40 .Nm uudecode
  41 .Nd encode/decode a binary file
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl m
  45 .Op Fl o Ar output_file
  46 .Op Ar file
  47 .Ar name
  48 .Nm uudecode
  49 .Op Fl cips
  50 .Op Ar
  51 .Nm uudecode
  52 .Op Fl i
  53 .Fl o Ar output_file
  54 .Op file
  55 .Sh DESCRIPTION
  56 .Nm Uuencode
  57 and
  58 .Nm uudecode
  59 are used to transmit binary files over transmission mediums
  60 that do not support other than simple
  61 .Tn ASCII
  62 data.
  63 .Pp
  64 .Nm Uuencode
  65 reads
  66 .Ar file
  67 (or by default the standard input) and writes an encoded version
  68 to the standard output, or
  69 .Ar output_file
  70 if one has been specified.
  71 The encoding uses only printing
  72 .Tn ASCII
  73 characters and includes the
  74 mode of the file and the operand
  75 .Ar name
  76 for use by
  77 .Nm uudecode .
  78 .Pp
  79 .Nm Uudecode
  80 transforms
  81 .Em uuencoded
  82 files (or by default, the standard input) into the original form.
  83 The resulting file is named either
  84 .Ar name
  85 or (depending on options passed to
  86 .Nm uudecode )
  87 .Ar output_file
  88 and will have the mode of the original file except that setuid
  89 and execute bits are not retained.
  90 .Nm Uudecode
  91 ignores any leading and trailing lines.
  92 .Pp
  93 The following options are available:
  94 .Pp
  95 .Nm uuencode :
  96 .Bl -tag -width ident
  97 .It Fl m
  98 Use the Base64 method of encoding, rather than the traditional
  99 .Nm
 100 algorithm.
 101 .It Fl o Ar output_file
 102 Output to
 103 .Ar output_file
 104 instead of standard output.
 105 .El
 106 .Pp
 107 .Nm uudecode :
 108 .Bl -tag -width ident
 109 .It Fl c
 110 Decode more than one uuencode'd file from
 111 .Ar file
 112 if possible.
 113 .It Fl i
 114 Do not overwrite files.
 115 .It Fl o Ar output_file
 116 Output to
 117 .Ar output_file
 118 instead of
 119 .Ar name .
 120 .It Fl p
 121 Decode
 122 .Ar file
 123 and write output to standard output.
 124 .It Fl s
 125 Do not strip output pathname to base filename.
 126 By default
 127 .Nm uudecode
 128 deletes any prefix ending with the last slash '/' for security
 129 purpose.
 130 .El
 131 .Sh EXAMPLES
 132 The following example packages up a source tree, compresses it,
 133 uuencodes it and mails it to a user on another system.
 134 When
 135 .Nm uudecode
 136 is run on the target system, the file ``src_tree.tar.Z'' will be
 137 created which may then be uncompressed and extracted into the original
 138 tree.
 139 .Pp
 140 .Bd -literal -offset indent -compact
 141 tar cf \- src_tree \&| compress \&|
 142 uuencode src_tree.tar.Z \&| mail sys1!sys2!user
 143 .Ed
 144 .Pp
 145 The following example unpack all uuencode'd
 146 files from your mailbox into your current working directory.
 147 .Pp
 148 .Bd -literal -offset indent -compact
 149 uudecode -c < $MAIL
 150 .Ed
 151 .Pp
 152 The following example extract a compress'ed tar
 153 archive from your mailbox
 154 .Pp
 155 .Bd -literal -offset indent -compact
 156 uudecode -o /dev/stdout < $MAIL | zcat | tar xfv -
 157 .Ed
 158 .Sh SEE ALSO
 159 .Xr basename 1 ,
 160 .Xr compress 1 ,
 161 .Xr mail 1 ,
 162 .Xr uucp 1 ,
 163 .Xr uuencode 5
 164 .Sh BUGS
 165 The encoded form of the file is expanded by 35% (3 bytes become 4 plus
 166 control information).
 167 .Sh HISTORY
 168 The
 169 .Nm uudecode
 170 and
 171 .Nm
 172 utilities appeared in
 173 .Bx 4.0 .