xref: /original-bsd/usr.bin/uuencode/uuencode.1 (revision cfa2a17a)
1.\" Copyright (c) 1980, 1990 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" %sccs.include.redist.man%
5.\"
6.\"     @(#)uuencode.1	6.9 (Berkeley) 04/23/91
7.\"
8.Dd
9.Dt UUENCODE 1
10.Os BSD 4
11.Sh NAME
12.Nm uuencode ,
13.Nm uudecode
14.Nd encode/decode a binary file
15.Sh SYNOPSIS
16.Nm uuencode
17.Op Ar file
18.Ar name
19.Nm uudecode
20.Op Ar file ...
21.Sh DESCRIPTION
22.Nm Uuencode
23and
24.Nm uudecode
25are used to transmit binary files over transmission mediums
26that do not support other than simple
27.Tn ASCII
28data.
29.Pp
30.Nm Uuencode
31reads
32.Ar file
33(or by default the standard input) and writes an encoded version
34to the standard output.
35The encoding uses only printing
36.Tn ASCII
37characters and includes the
38mode of the file and the operand
39.Ar name
40for use by
41.Nm uudecode .
42.Pp
43.Nm Uudecode
44transforms
45.Em uuencoded
46files (or by default, the standard input) into the original form.
47The resulting file is named
48.Ar name
49and will have the mode of the original file except that setuid
50and execute bits are not retained.
51.Nm Uudecode
52ignores any leading and trailing lines.
53.Sh EXAMPLES
54The following example packages up a source tree, compresses it,
55uuencodes it and mails it to a user on another system.
56When
57.Nm uudecode
58is run on the target system, the file ``src_tree.tar.Z'' will be
59created which may then be uncompressed and extracted into the original
60tree.
61.Pp
62.Bd -literal -offset indent -compact
63tar cf \- src_tree \&| compress \&|
64uuencode src_tree.tar.Z \&| mail sys1!sys2!user
65.Ed
66.Sh SEE ALSO
67.Xr compress 1 ,
68.Xr mail 1 ,
69.Xr uucp 1 ,
70.Xr uuencode 5 ,
71.Xr format 5
72.Sh BUGS
73The encoded form of the file is expanded by 35% (3 bytes become 4 plus
74control information).
75.Sh HISTORY
76The
77.Nm
78command appeared in
79.Bx 4.0 .
80