Debian Codegraph @

upstream/debian-unstable/man1/unshar.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 unshar 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 unshar-opts.def
19 .\" and the template file agman-cmd.tpl
20 .SH NAME
21 \f\*[B-Font]unshar\fP
22 \- unpack a shar archive
23 .SH SYNOPSIS
24 \f\*[B-Font]unshar\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 The operands that this program operates on may be specified either
34 on the command line or read from standard input, one per line.
35 In that input, leading and trailing white space is stripped,
36 blank lines are ignored.
37 Standard input may not be a terminal.
38 .sp \n(Ppu
39 .ne 2
40
41 .SH "DESCRIPTION"
42 Unshar scans the input files (typically email messages) looking for
43 the start of a shell archive. If no files are given, then standard
44 input is processed instead. It then passes each archive discovered
45 through an invocation of the shell program to unpack it.
46 .sp \n(Ppu
47 .ne 2
48
49 This program will perform its function for every file named on the command
50 line or every file named in a list read from stdin. The arguments or input
51 names must be pre\-existing files. The input list may contain comments,
52 which are blank lines or lines beginning with a '#' character.
53 .SH "OPTIONS"
54 .TP
55 .NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]dir\f[], \f\*[B-Font]\-\-directory\f[]=\f\*[I-Font]dir\f[]
56 unpack into the directory \fIdir\fP.
57 .sp
58 The input file names are relative to the current directory
59 when the program was started. This option tells \fBunshar\fP
60 to insert a \fBcd <dir>\fP commad at the start of the
61 \fBshar\fP text written to the shell.
62 .TP
63 .NOP \f\*[B-Font]\-c\f[], \f\*[B-Font]\-\-overwrite\f[]
64 overwrite any pre-existing files.
65 .sp
66 This option is passed through as an option to the shar file. Many
67 shell archive scripts accept a \fB-c\fP argument to indicate that
68 existing files should be overwritten.
69 .TP
70 .NOP \f\*[B-Font]\-f\f[], \f\*[B-Font]\-\-force\f[]
71 This is an alias for the \fI--overwrite\fR option.
72 .TP
73 .NOP \f\*[B-Font]\-E\f[] \f\*[I-Font]split\-mark\f[], \f\*[B-Font]\-\-split\-at\f[]=\f\*[I-Font]split\-mark\f[]
74 split input on \fBsplit-mark\fP lines.
75 The default
76 \f\*[I-Font]split\-mark\f[]
77 for this option is:
78 .ti +4
79 exit 0
80 .sp
81 With this option, \fBunshar\fP isolates each different shell archive
82 from the others which have been placed in the same file, unpacking each
83 in turn, from the beginning of the file to the end. Its proper
84 operation relies on the fact that many shar files are terminated by a
85 readily identifiable string at the start of the last line.
86 .sp
87 For example, noticing that most `.signatures' have a double hyphen
88 ("--") on a line right before them, one can then sometimes use
89 \fB--split-at=--\fP. The signature will then be skipped, along with
90 the headers of the following message.
91 .TP
92 .NOP \f\*[B-Font]\-e\f[], \f\*[B-Font]\-\-exit\-0\f[]
93 split input on "exit 0" lines.
94 This option must not appear in combination with any of the following options:
95 split-at.
96 .sp
97 Most shell archives end with a line consisting of simply "exit 0".
98 This option is equivalent to (and conflicts with)
99 \fB--split-at="exit 0"\fP.
100 .TP
101 .NOP \f\*[B-Font]\-D\f[], \f\*[B-Font]\-\-debug\f[]
102 debug the shell code.
103 .sp
104 "set \-x" will be emitted into the code the shell interprets.
105 .TP
106 .NOP \f\*[B-Font]\-h\f[], \f\*[B-Font]\-\-help\f[]
107 Display usage information and exit.
108 .TP
109 .NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
110 Pass the extended usage information through a pager.
111 .TP
112 .NOP \f\*[B-Font]\-R\f[] [\f\*[I-Font]cfgfile\f[]], \f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]]
113 Save the option state to \fIcfgfile\fP. The default is the \fIlast\fP
114 configuration file listed in the \fBOPTION PRESETS\fP section, below.
115 The command will exit after updating the config file.
116 .TP
117 .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[]
118 Load options from \fIcfgfile\fP.
119 The \fIno-load-opts\fP form will disable the loading
120 of earlier config/rc/ini files. \fI\-\-no-load-opts\fP is handled early,
121 out of order.
122 .TP
123 .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[]}]}]
124 Output version of program and exit. The default mode is `v', a simple
125 version. The `c' mode will print copyright information and `n' will
126 print the full copyright notice.
127 .PP
128 .SH "OPTION PRESETS"
129 Any option that is not marked as \fInot presettable\fP may be preset
130 by loading values from configuration ("RC" or ".INI") file(s).
131 The file "\fI$HOME/.sharrc\fP" will be used, if present.
132 .SH "FILES"
133 See \fBOPTION PRESETS\fP for configuration files.
134 .SH "EXIT STATUS"
135 One of the following exit values will be returned:
136 .TP
137 .NOP 0 " (EXIT_SUCCESS)"
138 Successful program execution.
139 .TP
140 .NOP 1 " (EXIT_FAILURE)"
141 There was an error in command usage.
142 .TP
143 .NOP 2 " (EXIT_POPEN_PROBLEM)"
144 cannot spawn or write to a shell process
145 .TP
146 .NOP 3 " (EXIT_CANNOT_CREATE)"
147 cannot create output file
148 .TP
149 .NOP 4 " (EXIT_BAD_DIRECTORY)"
150 the working directory structure is invalid
151 .TP
152 .NOP 5 " (EXIT_NOMEM)"
153 memory allocation failure
154 .TP
155 .NOP 6 " (EXIT_INVALID)"
156 invalid input, does not contain a shar file
157 .TP
158 .NOP 66 " (EX_NOINPUT)"
159 A specified configuration file could not be loaded.
160 .TP
161 .NOP 70 " (EX_SOFTWARE)"
162 libopts had an internal operational error. Please report
163 it to [email protected]. Thank you.
164 .PP
165 .SH "SEE ALSO"
166 shar(1)
167 .SH AUTHORS
168 The \fIshar\fP and \fIunshar\fP programs is the collective work of
169 many authors. Many people contributed by reporting problems,
170 suggesting various improvements or submitting actual code. A list of
171 these people is in the \fITHANKS\fP file in the sharutils distribution.
172 .SH "COPYRIGHT"
173 Copyright (C) 1994-2015 Free Software Foundation, Inc. all rights reserved.
174 This program is released under the terms of the GNU General Public License, version 3 or later.
175 .SH BUGS
176 Please put \fBsharutils\fP in the subject line for emailed bug
177 reports. It helps to spot the message.
178 .sp \n(Ppu
179 .ne 2
180
181 Please send bug reports to: [email protected]
182 .SH "NOTES"
183 This manual page was \fIAutoGen\fP-erated from the \fBunshar\fP
184 option definitions.