diff options
| author | Jacob McDonnell <jacob@jacobmcdonnell.com> | 2026-04-25 19:54:44 -0400 |
|---|---|---|
| committer | Jacob McDonnell <jacob@jacobmcdonnell.com> | 2026-04-25 19:54:44 -0400 |
| commit | a9157ce950dfe2fc30795d43b9d79b9d1bffc48b (patch) | |
| tree | 9df484304b560466d145e662c1c254ff0e9ae0ba /static/openbsd/man1/uuencode.1 | |
| parent | 160aa82b2d39c46ad33723d7d909cb4972efbb03 (diff) | |
docs: Added All OpenBSD Manuals
Diffstat (limited to 'static/openbsd/man1/uuencode.1')
| -rw-r--r-- | static/openbsd/man1/uuencode.1 | 238 |
1 files changed, 238 insertions, 0 deletions
diff --git a/static/openbsd/man1/uuencode.1 b/static/openbsd/man1/uuencode.1 new file mode 100644 index 00000000..d434875a --- /dev/null +++ b/static/openbsd/man1/uuencode.1 @@ -0,0 +1,238 @@ +.\" $OpenBSD: uuencode.1,v 1.25 2015/09/09 16:00:22 sobrado Exp $ +.\" $FreeBSD: uuencode.1,v 1.26 2003/03/18 14:24:47 fanf 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 +.\" $FreeBSD$ +.\" +.Dd $Mdocdate: September 9 2015 $ +.Dt UUENCODE 1 +.Os +.Sh NAME +.Nm uuencode , +.Nm uudecode , +.Nm b64encode , +.Nm b64decode +.Nd encode/decode a binary file +.Sh SYNOPSIS +.Nm uuencode +.Op Fl m +.Op Fl o Ar output_file +.Op Ar file +.Ar name +.Nm uudecode +.Op Fl cimprs +.Op Ar +.Nm uudecode +.Op Fl i +.Fl o Ar output_file +.Op Ar file +.Pp +.Nm b64encode +.Op Fl o Ar output_file +.Op Ar file +.Ar name +.Nm b64decode +.Op Fl ciprs +.Op Ar +.Nm b64decode +.Op Fl i +.Fl o Ar output_file +.Op Ar file +.Sh DESCRIPTION +The +.Nm uuencode +and +.Nm uudecode +utilities are used to transmit binary files over transmission mediums +that do not support formats other than printable +.Tn ASCII +data. +.Nm b64encode +and +.Nm b64decode +are equivalent to running +.Nm uuencode +and +.Nm uudecode +respectively with the +.Fl m +flag specified. +.Pp +.Nm uuencode +reads +.Ar file +(or by default, the standard input) and writes an encoded version +to the standard output, or to +.Ar output_file +if it has been specified. +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 +.Dq uuencoded +files (or by default, the standard input) into the original form. +The resulting file is named either +.Ar name +or (depending on options passed to +.Nm uudecode ) +.Ar output_file +and will have the mode of the original file except that set-user-ID +and execute bits are not retained. +.Nm uudecode +ignores any leading and trailing lines. +.Pp +The options for +.Nm uuencode +are as follows: +.Bl -tag -width Ds +.It Fl m +Use the Base64 method of encoding, rather than the traditional +.Nm +algorithm. +.It Fl o Ar output_file +Output to +.Ar output_file +instead of standard output. +.El +.Pp +The options for +.Nm uudecode +are as follows: +.Bl -tag -width Ds +.It Fl c +Decode more than one uuencoded file from +.Ar file +if possible. +.It Fl i +Do not overwrite files. +.It Fl m +When used with the +.Fl r +flag, decode Base64 input instead of traditional +.Nm +input. +Without +.Fl r +it has no effect. +.It Fl o Ar output_file +Output to +.Ar output_file +instead of any pathname contained in the input data. +.It Fl p +Decode +.Ar file +and write output to standard output. +.It Fl r +Decode raw (or broken) input which is missing the initial and +possibly the final framing lines. +The input is assumed to be in the traditional +.Nm +encoding, but if the +.Fl m +flag is used, or if the utility is invoked as +.Nm b64decode , +then the input is assumed to be in Base64 format. +.It Fl s +Do not strip output pathname to base filename. +By default +.Nm uudecode +deletes any prefix ending with the last slash '/' for security +reasons. +.El +.Sh EXIT STATUS +.Ex -std uuencode uudecode b64encode b64decode +.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 +.Pa src_tree.tar.Z +will be created which may then be uncompressed and extracted +into the original tree. +.Bd -literal -offset indent +$ tar cf - src_tree | compress | \e +uuencode src_tree.tar.Z | mail user@example.com +.Ed +.Pp +The following example unpacks all uuencoded +files from your mailbox into your current working directory. +.Bd -literal -offset indent +$ uudecode -c < $MAIL +.Ed +.Pp +The following example extracts a compressed tar +archive from your mailbox +.Bd -literal -offset indent +$ uudecode -o /dev/stdout < $MAIL | zcat | tar xfv - +.Ed +.Sh SEE ALSO +.Xr basename 1 , +.Xr compress 1 , +.Xr mail 1 , +.Xr uuencode 5 +.Sh STANDARDS +The +.Nm uudecode +and +.Nm uuencode +utilities are compliant with the +.St -p1003.1-2008 +specification. +.Pp +The flags +.Op Fl ciprs +are extensions to that specification. +.Pp +The use of the +.Fl o +flag for +.Nm uuencode +and the +.Fl m +flag for +.Nm uudecode +are also extensions to that specification. +.Sh HISTORY +The +.Nm uudecode +and +.Nm +utilities appeared in +.Bx 4.0 . +.Sh BUGS +Files encoded using the traditional algorithm are expanded by 35% +(3 bytes become 4 plus control information). |
