summaryrefslogtreecommitdiff
path: root/man/1/uuencode
diff options
context:
space:
mode:
authorCharles.Forsyth <devnull@localhost>2006-12-22 20:52:35 +0000
committerCharles.Forsyth <devnull@localhost>2006-12-22 20:52:35 +0000
commit46439007cf417cbd9ac8049bb4122c890097a0fa (patch)
tree6fdb25e5f3a2b6d5657eb23b35774b631d4d97e4 /man/1/uuencode
parent37da2899f40661e3e9631e497da8dc59b971cbd0 (diff)
20060303-partial
Diffstat (limited to 'man/1/uuencode')
-rw-r--r--man/1/uuencode79
1 files changed, 79 insertions, 0 deletions
diff --git a/man/1/uuencode b/man/1/uuencode
new file mode 100644
index 00000000..89d6a366
--- /dev/null
+++ b/man/1/uuencode
@@ -0,0 +1,79 @@
+.TH UUENCODE 1
+.SH NAME
+uuencode, uudecode \- encode/decode a file
+.SH SYNOPSIS
+.B uuencode
+[
+.I sourcefile
+]
+.I remotefile
+.PP
+.B uudecode
+[
+.B -p
+]
+[
+.I encodedfile ...
+]
+.SH DESCRIPTION
+.I Uuencode
+and
+.I Uudecode
+are used to transmit files over transmission mediums that do not support other than simple
+ASCII data.
+.PP
+.I Uuencode
+converts a file to a purely ASCII based representation. It encodes the contents of
+.I sourcefile
+or the standard input if no source file is given. The
+.I remotefile
+is included in the encoded file's header as the name of the file into which
+.I uudecode
+should place the decoded data. The header also includes the permission modes of the
+source file so that these can be preserved on decoding. The encoded output of
+.I uuencode
+is sent to the standard output.
+.PP
+.I Uudecode
+reads a file, ignoring any leading and trailing lines that are not part of the encoding, and
+recreates the original file with the filename and mode specified in it's header. The file
+to decode is
+.I encodedfile
+or standard input if none is given. The
+.B -p
+flag can be used to send the decoded data to standard output rather than saving it in
+the file whose name is specified in the header.
+.SH EXAMPLES
+.PP
+Encode a dis file limbo.dis so that it can be included in a mail message:
+.IP
+.EX
+uuencode limbo.dis limbo.dis > tmp
+<place in mail message and send to recipient>
+.EE
+.PP
+Decode the mail message(msg say):
+.IP
+.EX
+cat msg | uudecode
+.EE
+.PP
+This creates the file limbo.dis.
+.PP
+Decode the mail message into a file of your choosing(tmp.dis say):
+.IP
+.EX
+cat msg | uudecode -p > tmp.dis
+.EE
+.SH SOURCE
+.B /appl/cmd/uuencode.b
+.br
+.B /appl/cmd/uudecode.b
+.SH BUGS
+The encoded file is expanded by at least a third.
+.br
+Decoding a file may overwrite an existing file.
+.br
+Uuencode should take the remote file name to be the same as the source file if one
+is not given.
+