1.\" $NetBSD: uuencode.1,v 1.13 2002/02/08 01:36:36 ross 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 March 19, 1999 37.Dt UUENCODE 1 38.Os 39.Sh NAME 40.Nm uuencode , 41.Nm uudecode 42.Nd encode/decode a binary file 43.Sh SYNOPSIS 44.Nm 45.Op Ar file 46.Ar name 47.Nm uudecode 48.Op Fl p 49.Op Ar file ... 50.Sh DESCRIPTION 51.Nm 52and 53.Nm uudecode 54are used to transmit binary files over transmission mediums 55that do not support other than simple 56.Tn ASCII 57data. 58.Pp 59.Nm 60reads 61.Ar file 62(or by default the standard input) and writes an encoded version 63to the standard output. 64The encoding uses only printing 65.Tn ASCII 66characters and includes the 67mode of the file and the operand 68.Ar name 69for use by 70.Nm uudecode . 71.Pp 72.Nm uudecode 73transforms 74.Em uuencoded 75files (or by default, the standard input) into the original form. 76The resulting file is named 77.Ar name 78and will have the mode of the original file except that setuid 79and execute bits are not retained; if the 80.Fl p 81option is specified, the data will be written to the standard output. 82.Nm uudecode 83ignores any leading and trailing lines. 84.Sh EXIT STATUS 85The 86.Nm uudecode 87and 88.Nm 89utilities exits 0 on success, and \*[Gt]0 if an error occurs. 90.Sh EXAMPLES 91The following example packages up a source tree, compresses it, 92uuencodes it and mails it to a user on another system. 93When 94.Nm uudecode 95is run on the target system, the file ``src_tree.tar.Z'' will be 96created which may then be uncompressed and extracted into the original 97tree. 98.Pp 99.Bd -literal -offset indent -compact 100tar cf \- src_tree \&| compress \&| 101uuencode src_tree.tar.Z \&| mail sys1!sys2!user 102.Ed 103.Sh SEE ALSO 104.Xr compress 1 , 105.Xr mail 1 , 106.Xr uucp 1 , 107.Xr uuencode 5 108.Sh STANDARDS 109The 110.Nm uudecode 111and 112.Nm 113utilities conform to 114.St -p1003.2-92 . 115.Sh HISTORY 116The 117.Nm uudecode 118and 119.Nm 120utilities appeared in 121.Bx 4.0 . 122.Sh BUGS 123The encoded form of the file is expanded by 35% (3 bytes become 4 plus 124control information). 125