128 lines
3.6 KiB
Groff
128 lines
3.6 KiB
Groff
.\" $NetBSD: uuencode.1,v 1.16 2006/09/24 15:56:42 wiz Exp $
|
|
.\"
|
|
.\" Copyright (c) 1980, 1990, 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" @(#)uuencode.1 8.1 (Berkeley) 6/6/93
|
|
.\"
|
|
.Dd September 24, 2006
|
|
.Dt UUENCODE 1
|
|
.Os
|
|
.Sh NAME
|
|
.Nm uuencode ,
|
|
.Nm uudecode
|
|
.Nd encode/decode a binary file
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl m
|
|
.Op Ar file
|
|
.Ar name
|
|
.Nm uudecode
|
|
.Op Fl m | Fl p
|
|
.Op Ar file ...
|
|
.Sh DESCRIPTION
|
|
.Nm
|
|
and
|
|
.Nm uudecode
|
|
are used to transmit binary files over transmission mediums
|
|
that do not support other than simple
|
|
.Tn ASCII
|
|
data.
|
|
.Pp
|
|
The following options are available:
|
|
.Bl -tag
|
|
.It Fl m
|
|
Use base64 encoding.
|
|
.El
|
|
.Pp
|
|
.Nm
|
|
reads
|
|
.Ar file
|
|
(or by default the standard input) and writes an encoded version
|
|
to the standard output.
|
|
The encoding uses only printing
|
|
.Tn ASCII
|
|
characters and includes the
|
|
mode of the file and the operand
|
|
.Ar name
|
|
for use by
|
|
.Nm uudecode .
|
|
.Pp
|
|
.Nm uudecode
|
|
transforms
|
|
.Em uuencoded
|
|
files (or by default, the standard input) into the original form.
|
|
The resulting file is named
|
|
.Ar name
|
|
and will have the mode of the original file except that setuid
|
|
and execute bits are not retained; if the
|
|
.Fl p
|
|
option is specified, the data will be written to the standard output.
|
|
.Nm uudecode
|
|
ignores any leading and trailing lines.
|
|
.Sh EXIT STATUS
|
|
The
|
|
.Nm uudecode
|
|
and
|
|
.Nm
|
|
utilities exits 0 on success, and \*[Gt]0 if an error occurs.
|
|
.Sh EXAMPLES
|
|
The following example packages up a source tree, compresses it,
|
|
uuencodes it and mails it to a user on another system.
|
|
When
|
|
.Nm uudecode
|
|
is run on the target system, the file ``src_tree.tar.Z'' will be
|
|
created which may then be uncompressed and extracted into the original
|
|
tree.
|
|
.Pp
|
|
.Bd -literal -offset indent -compact
|
|
tar cf \- src_tree \&| compress \&|
|
|
uuencode src_tree.tar.Z \&| mail sys1!sys2!user
|
|
.Ed
|
|
.Sh SEE ALSO
|
|
.Xr compress 1 ,
|
|
.Xr mail 1 ,
|
|
.Xr uucp 1 ,
|
|
.Xr uuencode 5
|
|
.Sh STANDARDS
|
|
The
|
|
.Nm uudecode
|
|
and
|
|
.Nm
|
|
utilities conform to
|
|
.St -p1003.2-92 .
|
|
.Sh HISTORY
|
|
The
|
|
.Nm uudecode
|
|
and
|
|
.Nm
|
|
utilities appeared in
|
|
.Bx 4.0 .
|
|
.Sh BUGS
|
|
The encoded form of the file is expanded by 35% (3 bytes become 4 plus
|
|
control information).
|