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