1 .\" Copyright (c) 1980, 1990, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" From: @(#)uuencode.1 8.1 (Berkeley) 6/6/93
40 .Nd encode/decode a binary file
48 .Op Fl o Ar output_file
60 .Op Fl o Ar output_file
79 utilities are used to transmit binary files over transmission mediums
80 that do not support other than simple
85 utility is synonymous with
92 utility is synonymous with
100 utility acts as a base64 decoder when passed the
105 flag and as a base64 encoder otherwise.
106 As a decoder it only accepts raw base64 input
107 and as an encoder it does not produce the framing lines.
109 reads standard input or
111 if it is provided and writes to standard output.
122 are accepted for compatibility with GNU base64,
123 but the latter is unimplemented and silently ignored.
129 (or by default the standard input) and writes an encoded version
130 to the standard output, or
132 if one has been specified.
133 The encoding uses only printing
135 characters and includes the
136 mode of the file and the operand
145 files (or by default, the standard input) into the original form.
146 The resulting file is named either
148 or (depending on options passed to
151 and will have the mode of the original file except that setuid
152 and execute bits are not retained.
155 utility ignores any leading and trailing lines.
157 The following options are available for
159 .Bl -tag -width ident
161 Use the Base64 method of encoding, rather than the traditional
165 Produce raw output by excluding the initial and final framing lines.
166 .It Fl o Ar output_file
169 instead of standard output.
172 The following options are available for
174 .Bl -tag -width ident
176 Decode more than one uuencoded file from
180 Do not overwrite files.
184 flag, decode Base64 input instead of traditional
190 .It Fl o Ar output_file
193 instead of any pathname contained in the input data.
197 and write output to standard output.
199 Decode raw (or broken) input, which is missing the initial and
200 possibly the final framing lines.
201 The input is assumed to be in the traditional
205 flag is used, or if the utility is invoked as
207 then the input is assumed to be in Base64 format.
209 Do not strip output pathname to base filename.
212 deletes any prefix ending with the last slash '/' for security
218 accepts the following option:
219 .Bl -tag -width ident
221 Wrap encoded output after
226 is a generic utility that can run
227 any of the aforementioned encoders and decoders.
228 It can also run algorithms that are not available
229 through a dedicated program:
232 is a quoted-printable converter
233 and accepts the following options:
234 .Bl -tag -width ident
237 .It Fl o Ar output_file
240 instead of standard output.
242 The following example packages up a source tree, compresses it,
243 uuencodes it and mails it to a user on another system.
246 is run on the target system, the file ``src_tree.tar.Z'' will be
247 created which may then be uncompressed and extracted into the original
250 .Bd -literal -offset indent -compact
251 tar cf \- src_tree \&| compress \&|
252 uuencode src_tree.tar.Z \&| mail user@example.com
255 The following example unpacks all uuencoded
256 files from your mailbox into your current working directory.
258 .Bd -literal -offset indent -compact
262 The following example extracts a compressed tar
263 archive from your mailbox
265 .Bd -literal -offset indent -compact
266 uudecode -o /dev/stdout < $MAIL | zcat | tar xfv -
272 .Xr uucp 1 Pq Pa ports/net/freebsd-uucp ,
279 utilities appeared in
282 Files encoded using the traditional algorithm are expanded by 35% (3
283 bytes become 4 plus control information).