Debian Codegraph @

upstream/debian-unstable/man1/uuencode.1

raw
1 .de1 NOP
2 . it 1 an-trap
3 . if \\n[.$] \,\\$*\/
4 ..
5 .ie t \
6 .ds B-Font [CB]
7 .ds I-Font [CI]
8 .ds R-Font [CR]
9 .el \
10 .ds B-Font B
11 .ds I-Font I
12 .ds R-Font R
13 .TH uuencode 1 "30 May 2015" "GNU sharutils (4.15.2)" "User Commands"
14 .\"
15 .\" DO NOT EDIT THIS FILE (in-mem file)
16 .\"
17 .\" It has been AutoGen-ed
18 .\" From the definitions uuencode-opts.def
19 .\" and the template file agman-cmd.tpl
20 .SH NAME
21 \f\*[B-Font]uuencode\fP
22 \- encode a file into email friendly text
23 .SH SYNOPSIS
24 \f\*[B-Font]uuencode\fP
25 .\" Mixture of short (flag) options and long options
26 [\f\*[B-Font]\-flags\f[]]
27 [\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]]
28 [\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]]
29 [<in-file>] <output-name>
30 .sp \n(Ppu
31 .ne 2
32
33 .SH "DESCRIPTION"
34 \fIuuencode\fP is used to create an ASCII representation of a file
35 that can be sent over channels that may otherwise corrupt the data.
36 Specifically, email cannot handle binary data and will often even
37 insert a character when the six character sequence "\nFrom " is seen.
38 .sp
39 \fIuuencode\fP will read \fIin-file\fP if provided and otherwise
40 read data from standard in and write the encoded form to standard out.
41 The output will begin with a header line for use by \fIuudecode\fP
42 giving it the resulting suggested file \fIoutput-name\fP and access
43 mode. If the \fIoutput-name\fP is specifically \fI/dev/stdout\fP,
44 then \fIuudecode\fP will emit the decoded file to standard out.
45 .sp
46 \fBNote\fP: \fIuuencode\fP uses buffered input and assumes that it
47 is not hand typed from a tty. The consequence is that at a tty, you
48 may need to hit Ctl-D several times to terminate input.
49 .SH "OPTIONS"
50 .TP
51 .NOP \f\*[B-Font]\-m\f[], \f\*[B-Font]\-\-base64\f[]
52 convert using base64.
53 .sp
54 By default, \fIuuencode\fP will encode using the traditional
55 conversion. It is slower and less compact than base64.
56 The encoded form of the file is expanded by 37% for UU encoding
57 and by 35% for base64 encoding (3 bytes become 4 plus control
58 information).
59 .TP
60 .NOP \f\*[B-Font]\-e\f[], \f\*[B-Font]\-\-encode\-file\-name\f[]
61 encode the output file name.
62 .sp
63 Since output file names may contain characters that are not
64 handled well by various transmission modes, you may specify
65 that the \fIoutput-name\fP be base64 encoded as well.
66 (Traditional uuencoding of the file name is not supported.)
67 .TP
68 .NOP \f\*[B-Font]\-h\f[], \f\*[B-Font]\-\-help\f[]
69 Display usage information and exit.
70 .TP
71 .NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
72 Pass the extended usage information through a pager.
73 .TP
74 .NOP \f\*[B-Font]\-R\f[] [\f\*[I-Font]cfgfile\f[]], \f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]]
75 Save the option state to \fIcfgfile\fP. The default is the \fIlast\fP
76 configuration file listed in the \fBOPTION PRESETS\fP section, below.
77 The command will exit after updating the config file.
78 .TP
79 .NOP \f\*[B-Font]\-r\f[] \f\*[I-Font]cfgfile\f[], \f\*[B-Font]\-\-load-opts\f[]=\f\*[I-Font]cfgfile\f[], \f\*[B-Font]\-\-no-load-opts\f[]
80 Load options from \fIcfgfile\fP.
81 The \fIno-load-opts\fP form will disable the loading
82 of earlier config/rc/ini files. \fI\-\-no-load-opts\fP is handled early,
83 out of order.
84 .TP
85 .NOP \f\*[B-Font]\-v\f[] [{\f\*[I-Font]v|c|n\f[] \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}]}]
86 Output version of program and exit. The default mode is `v', a simple
87 version. The `c' mode will print copyright information and `n' will
88 print the full copyright notice.
89 .PP
90 .SH "OPTION PRESETS"
91 Any option that is not marked as \fInot presettable\fP may be preset
92 by loading values from configuration ("RC" or ".INI") file(s).
93 The file "\fI$HOME/.sharrc\fP" will be used, if present.
94 .SH STANDARDS
95 This implementation is compliant with P1003.2b/D11.
96 .SH "FILES"
97 See \fBOPTION PRESETS\fP for configuration files.
98 .SH "EXIT STATUS"
99 One of the following exit values will be returned:
100 .TP
101 .NOP 0 " (EXIT_SUCCESS)"
102 Successful program execution.
103 .TP
104 .NOP 1 " (EXIT_FAILURE)"
105 The operation failed or the command syntax was not valid.
106 .TP
107 .NOP 66 " (EX_NOINPUT)"
108 A specified configuration file could not be loaded.
109 .TP
110 .NOP 70 " (EX_SOFTWARE)"
111 libopts had an internal operational error. Please report
112 it to [email protected]. Thank you.
113 .PP
114 .SH "SEE ALSO"
115 uudecode(1), uuencode(5)
116 .SH HISTORY
117 The \fBuuencode\fP command first appeared in BSD 4.0.
118 .SH "AUTHORS"
119 Free Software Foundation, Inc.
120 .SH "COPYRIGHT"
121 Copyright (C) 1994-2015 Free Software Foundation, Inc. all rights reserved.
122 This program is released under the terms of the GNU General Public License, version 3 or later.
123 .SH BUGS
124 Please put \fBsharutils\fP in the subject line for emailed bug
125 reports. It helps to spot the message.
126 .sp \n(Ppu
127 .ne 2
128
129 Please send bug reports to: [email protected]
130 .SH "NOTES"
131 This manual page was \fIAutoGen\fP-erated from the \fBuuencode\fP
132 option definitions.