[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.9

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