[BACK]Return to uuencode.1 CVS log [TXT][DIR] Up to [local] / src / usr.bin / uuencode

Annotation of src/usr.bin/uuencode/uuencode.1, Revision 1.13

1.13    ! millert     1: .\"    $OpenBSD: uuencode.1,v 1.12 2003/01/11 11:07:51 hugh Exp $
1.1       deraadt     2: .\"    $NetBSD: uuencode.1,v 1.4 1994/11/17 07:39:42 jtc Exp $
                      3: .\"
                      4: .\" Copyright (c) 1980, 1990, 1993
                      5: .\"    The Regents of the University of California.  All rights reserved.
                      6: .\"
                      7: .\" Redistribution and use in source and binary forms, with or without
                      8: .\" modification, are permitted provided that the following conditions
                      9: .\" are met:
                     10: .\" 1. Redistributions of source code must retain the above copyright
                     11: .\"    notice, this list of conditions and the following disclaimer.
                     12: .\" 2. Redistributions in binary form must reproduce the above copyright
                     13: .\"    notice, this list of conditions and the following disclaimer in the
                     14: .\"    documentation and/or other materials provided with the distribution.
1.13    ! millert    15: .\" 3. Neither the name of the University nor the names of its contributors
1.1       deraadt    16: .\"    may be used to endorse or promote products derived from this software
                     17: .\"    without specific prior written permission.
                     18: .\"
                     19: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     20: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     21: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     22: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     23: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     24: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     25: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     26: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     27: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     28: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     29: .\" SUCH DAMAGE.
                     30: .\"
                     31: .\"     @(#)uuencode.1 8.1 (Berkeley) 6/6/93
                     32: .\"
                     33: .Dd June 6, 1993
                     34: .Dt UUENCODE 1
1.6       aaron      35: .Os
1.1       deraadt    36: .Sh NAME
                     37: .Nm uuencode ,
                     38: .Nm uudecode
                     39: .Nd encode/decode a binary file
                     40: .Sh SYNOPSIS
                     41: .Nm uuencode
                     42: .Op Ar file
                     43: .Ar name
                     44: .Nm uudecode
1.4       dgregor    45: .Op Fl p
1.1       deraadt    46: .Op Ar file ...
                     47: .Sh DESCRIPTION
1.5       aaron      48: .Nm uuencode
1.1       deraadt    49: and
                     50: .Nm uudecode
                     51: are used to transmit binary files over transmission mediums
1.12      hugh       52: that do not support formats other than printable
1.1       deraadt    53: .Tn ASCII
                     54: data.
                     55: .Pp
1.5       aaron      56: .Nm uuencode
1.1       deraadt    57: reads
                     58: .Ar file
1.5       aaron      59: (or by default, the standard input) and writes an encoded version
1.1       deraadt    60: to the standard output.
                     61: The encoding uses only printing
                     62: .Tn ASCII
                     63: characters and includes the
                     64: mode of the file and the operand
                     65: .Ar name
                     66: for use by
                     67: .Nm uudecode .
                     68: .Pp
1.5       aaron      69: .Nm uudecode
1.1       deraadt    70: transforms
1.5       aaron      71: .Dq uuencoded
1.1       deraadt    72: files (or by default, the standard input) into the original form.
                     73: The resulting file is named
                     74: .Ar name
1.5       aaron      75: and will have the mode of the original file except that set-user-ID
1.7       aaron      76: and execute bits are not retained.
                     77: If the
1.4       dgregor    78: .Fl p
                     79: option is specified, the output will instead be written to stdout.
1.5       aaron      80: .Nm uudecode
1.1       deraadt    81: ignores any leading and trailing lines.
                     82: .Sh EXAMPLES
                     83: The following example packages up a source tree, compresses it,
                     84: uuencodes it and mails it to a user on another system.
                     85: When
                     86: .Nm uudecode
1.7       aaron      87: is run on the target system, the file
                     88: .Pa src_tree.tar.Z
                     89: will be created which may then be uncompressed and extracted
                     90: into the original tree.
1.1       deraadt    91: .Pp
                     92: .Bd -literal -offset indent -compact
1.10      deraadt    93: $ tar cf \- src_tree \&| compress \&| \\
1.11      fgsch      94: uuencode src_tree.tar.Z \&| mail user@example.com
1.1       deraadt    95: .Ed
1.7       aaron      96: .Pp
                     97: Both utilities exit 0 on success or >0 if an error occurred.
1.1       deraadt    98: .Sh SEE ALSO
                     99: .Xr compress 1 ,
                    100: .Xr mail 1 ,
1.2       deraadt   101: .Xr uuencode 5
1.1       deraadt   102: .Sh STANDARDS
1.6       aaron     103: The
1.1       deraadt   104: .Nm uudecode
                    105: and
                    106: .Nm uuencode
1.6       aaron     107: utilities conform to
1.1       deraadt   108: .St -p1003.2-92 .
                    109: .Sh HISTORY
                    110: The
                    111: .Nm uudecode
                    112: and
                    113: .Nm uuencode
                    114: utilities appeared in
                    115: .Bx 4.0 .
                    116: .Sh BUGS
                    117: The encoded form of the file is expanded by 35% (3 bytes become 4 plus
                    118: control information).