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