Debian Codegraph @

upstream/debian-unstable/man1/uudecode.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 uudecode 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 uudecode-opts.def
19 .\" and the template file agman-cmd.tpl
20 .SH NAME
21 \f\*[B-Font]uudecode\fP
22 \- decode an encoded file
23 .SH SYNOPSIS
24 \f\*[B-Font]uudecode\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 [<file>...]
30 .sp \n(Ppu
31 .ne 2
32
33 If no \fIfile\fP(s) are provided, then standard input is decoded.
34 .SH "DESCRIPTION"
35 \fIuudecode\fP transforms uuencoded files into their original form.
36 .sp
37 The encoded file(s) may be specified on the command line, or one may
38 be read from standard input. The output file name is specified in
39 the encoded file, but may be overridden with the \fB-o\fP option.
40 It will have the mode of the original file, except that setuid and
41 execute bits are not retained. If the output file is specified to
42 be \fI/dev/stdout\fP or \fI-\fP, the result will be written to
43 standard output. If there are multiple input files and the second or
44 subsquent file specifies standard output, the decoded data will be
45 written to the same file as the previous output. Don't do that.
46 .sp
47 \fIuudecode\fP ignores any leading and trailing lines. It looks
48 for a line that starts with "\fBbegin\fP" and proceeds until the
49 end-of-encoding marker is found. The program determines from the
50 header line of the encoded file which of the two supported encoding
51 schemes was used and whether or not the output file name has been
52 encoded with base64 encoding. See \fIuuencode(5)\fP.
53 .SH "OPTIONS"
54 .TP
55 .NOP \f\*[B-Font]\-o\f[] \f\*[I-Font]file\f[], \f\*[B-Font]\-\-output\-file\f[]=\f\*[I-Font]file\f[]
56 direct output to \fIfile\fP.
57 .sp
58 If specified, decoded data are written to this file. When multiple
59 inputs are specified on the command line, this option cannot be
60 specified. All decoded data must be written to the file name
61 encoded in the data.
62 .TP
63 .NOP \f\*[B-Font]\-c\f[], \f\*[B-Font]\-\-ignore\-chmod\f[]
64 ignore \fBfchmod(3P)\fP errors.
65 .sp
66 By default, if the output file permissions cannot be changed to
67 the permissions specified in the encoded data, the file will not
68 be written out and execution stops. This option will cause that
69 error to be ignored. The resulting file will have all the data,
70 but the incorrect mode settings.
71 .sp
72 \fBfchmod()\fP errors are also ignored if
73 \fBPOSIXLY_CORRECT\fP is set in the environment. RE:
74 \fIhttp://austingroupbugs.net/view.php?id=635\fP
75 .sp
76 A warning is always emitted when \fBfchmod()\fP fails.
77 .TP
78 .NOP \f\*[B-Font]\-h\f[], \f\*[B-Font]\-\-help\f[]
79 Display usage information and exit.
80 .TP
81 .NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more\-help\f[]
82 Pass the extended usage information through a pager.
83 .TP
84 .NOP \f\*[B-Font]\-R\f[] [\f\*[I-Font]cfgfile\f[]], \f\*[B-Font]\-\-save\-opts\f[] [=\f\*[I-Font]cfgfile\f[]]
85 Save the option state to \fIcfgfile\fP. The default is the \fIlast\fP
86 configuration file listed in the \fBOPTION PRESETS\fP section, below.
87 The command will exit after updating the config file.
88 .TP
89 .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[]
90 Load options from \fIcfgfile\fP.
91 The \fIno\-load\-opts\fP form will disable the loading
92 of earlier config/rc/ini files. \fI\-\-no\-load\-opts\fP is handled early,
93 out of order.
94 .TP
95 .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[]}]}]
96 Output version of program and exit. The default mode is `v', a simple
97 version. The `c' mode will print copyright information and `n' will
98 print the full copyright notice.
99 .PP
100 .sp
101 .SH "OPTION PRESETS"
102 Any option that is not marked as \fInot presettable\fP may be preset
103 by loading values from configuration ("RC" or ".INI") file(s).
104 The file "\fI$HOME/.sharrc\fP" will be used, if present.
105 .SH STANDARDS
106 This implementation is compliant with P1003.2b/D11.
107 .SH "FILES"
108 See \fBOPTION PRESETS\fP for configuration files.
109 .SH "EXIT STATUS"
110 One of the following exit values will be returned:
111 .TP
112 .NOP 0 " (EXIT_SUCCESS)"
113 Successful program execution.
114 .TP
115 .NOP 1 " (EXIT_OPTION_ERROR)"
116 The command options were misconfigured.
117 .TP
118 .NOP 2 " (EXIT_INVALID)"
119 (warning) One or more input files contained no valid data
120 .TP
121 .NOP 4 " (EXIT_NO_INPUT)"
122 (warning) The specified input file was not found
123 .TP
124 .NOP 8 " (EXIT_NO_OUTPUT)"
125 The specified output file could not be created (error); or else one of the output files could not be written or its access mode could not be changed (warnings). The accompanying message(s) will distinguish.
126 .TP
127 .NOP 9 " (EXIT_NO_MEM)"
128 No process memory available
129 .TP
130 .NOP 66 " (EX_NOINPUT)"
131 A specified configuration file could not be loaded.
132 .TP
133 .NOP 70 " (EX_SOFTWARE)"
134 libopts had an internal operational error. Please report
135 it to [email protected]. Thank you.
136 .sp \n(Ppu
137 .ne 2
138
139 The exit status codes are (mostly) warning codes.
140 As such, each code is "or"\-ed into the final exit code as the input
141 files are processed. For example, an exit code of '6' is not listed
142 above. It is the sum of \fBEXIT_INVALID\fP and \fBEXIT_NO_INPUT\fP.
143 It would mean that at least one input file contained invalid
144 data and also at least one input file could not be found at all.
145 .PP
146 .SH "SEE ALSO"
147 uuencode(1), uuencode(5)
148 .SH "AUTHORS"
149 Free Software Foundation, Inc.
150 .SH "COPYRIGHT"
151 Copyright (C) 1994-2015 Free Software Foundation, Inc. all rights reserved.
152 This program is released under the terms of the GNU General Public License, version 3 or later.
153 .SH BUGS
154 Please put \fBsharutils\fP in the subject line for emailed bug
155 reports. It helps to spot the message.
156 .sp \n(Ppu
157 .ne 2
158
159 If more than one \fIname\fP in the encoded files are the same, or
160 if the second or following input files specifies standard output
161 for the output file, then the result is probably not what is expected.
162 Specifically, standard output will be appended to and named output
163 files will be replaced.
164 .sp \n(Ppu
165 .ne 2
166
167 Please send bug reports to: [email protected]
168 .SH "NOTES"
169 This manual page was \fIAutoGen\fP-erated from the \fBuudecode\fP
170 option definitions.