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