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