Package: sharutils
Version: 1:4.15.2-9
Severity: minor
Tags: patch
Dear Maintainer,
here are some notes and editorial fixes for the manual.
The patch is in the attachment.
-.-
The concerned man page was autogenerated (autogen).
-.-
Any program (person), that produces man pages, should check its content for
defects by using
groff -mandoc -t -ww -b -z [ -K utf8 | k ] <file>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
So any "generator" should check its products with the above mentioned
'groff' and additionally with 'nroff ...'.
This is just a simple quality control measure.
The "generator" may have to be corrected to get a better man page,
the source file may, and any additional file may.
-.-
The difference between the formatted outputs can be seen with:
nroff -man <file1> > <out1>
nroff -man <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -man -Z - "
instead of "nroff -man"
Add the option "-t", if the file contains a table.
Read the output of "diff -u" with "less -R" or similar.
-.-.
If "man" (man-db) is used to check the manual for warnings,
the following must be set:
The option "-warnings=w"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT="-ww -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint shar.1": (possibly shortened list)
mandoc: shar.1:536:2: WARNING: skipping paragraph macro: PP empty
mandoc: shar.1:579:2: WARNING: skipping paragraph macro: br after sp
mandoc: shar.1:615:2: WARNING: skipping paragraph macro: PP empty
mandoc: shar.1:625:95: STYLE: input text line longer than 80 bytes: This
program is rele...
-.-.
Change '-' (\-) to '\(en' (en-dash) for a numeric range.
GNU gnulib has recently (2023-06-18) updated its
"build_aux/update-copyright" to recognize "\(en" in man pages.
shar.1:624:Copyright (C) 1994-2015 Free Software Foundation, Inc. all rights
reserved.
-.-.
Change two HYPHEN-MINUSES (code 0x2D) to an em-dash (\(em),
if one is intended. An en-dash is usually surrounded by a space,
while an em-dash is used without spaces.
"man" (1 byte characters in input) transforms an en-dash (\(en) to one
HYPHEN-MINUS,
and an em-dash to two HYPHEN-MINUSES without considering the space
around it.
If "--" are two single "-" (end of options) then use "\-\-".
shar.1:42:(\fB--vanilla-operation\fP) or essentially a mailable \fBtar\fP
shar.1:46:recognized. If the \fB--intermix-type\fP option has been specified,
shar.1:74:e.g. \fB--gzip\fP. Those options, however, are being deprecated.
shar.1:76:with \fB-C xz\fP or \fB--compactor=xz\fP.
shar.1:142:This is an alias for the \fI--level-of-compression\fR option.
shar.1:215:the \fB--whole-size-limit\fP or \fB--split-size-limit\fP
shar.1:268:\fB--whole-size-limit\fP option.
shar.1:289:If the \fB--intermix-type\fP option is specified on the command
shar.1:295: { echo \--compact xz
shar.1:304:\fB--input-file-list=-\fP.
shar.1:314:files. See the \fB--net-headers\fP option.
shar.1:333:\fB--submitter\fP option. The \fIname\fP must be provided with the
shar.1:334:\fB--archive-name\fP option. If the archive name includes a slash
shar.1:389:especially if \fB--uuencode\fP or a compression option is used.
shar.1:412:(\fB--mixed-uuencode\fP) to text mode (\fB--text-files\fP).
shar.1:429:\fB--query-user\fP option is specified, the unpack will not
shar.1:431:\fB--cut-mark\fP is passed as a parameter to the script when
shar.1:448:together with vanilla mode (\fB--vanilla-operation\fP). Use this
shar.1:513:This is an alias for the \fI--quiet\fR option.
-.-.
Change (or include a "FIXME" paragraph about) misused SI (metric)
numeric prefixes (or names) to the binary ones, like Ki (kibi), Mi
(mebi), Gi (gibi), or Ti (tebi), if indicated.
If the metric prefixes are correct, add the definitions or an
explanation to avoid misunderstanding.
244:respectively. 4M (4194304) is the maximum allowed.
-.-.
Mark a full stop (.) and the exclamation mark (!) with "\&",
if it does not mean an end of a sentence.
This is a preventive action,
the paragraph could be reshaped, e.g., after changes.
When typing, one does not always notice when the line wraps after the
period.
There are too many examples of input lines in manual pages,
that end with an abbreviation point.
This marking is robust, and independent of the position on the line.
It corresponds to "\ " in TeX, and to "@:" in Texinfo.
74:e.g. \fB--gzip\fP. Those options, however, are being deprecated.
624:Copyright (C) 1994-2015 Free Software Foundation, Inc. all rights reserved.
-.-.
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
42:(\fB--vanilla-operation\fP) or essentially a mailable \fBtar\fP
46:recognized. If the \fB--intermix-type\fP option has been specified,
74:e.g. \fB--gzip\fP. Those options, however, are being deprecated.
76:with \fB-C xz\fP or \fB--compactor=xz\fP.
142:This is an alias for the \fI--level-of-compression\fR option.
215:the \fB--whole-size-limit\fP or \fB--split-size-limit\fP
268:\fB--whole-size-limit\fP option.
289:If the \fB--intermix-type\fP option is specified on the command
304:\fB--input-file-list=-\fP.
314:files. See the \fB--net-headers\fP option.
333:\fB--submitter\fP option. The \fIname\fP must be provided with the
334:\fB--archive-name\fP option. If the archive name includes a slash
389:especially if \fB--uuencode\fP or a compression option is used.
412:(\fB--mixed-uuencode\fP) to text mode (\fB--text-files\fP).
429:\fB--query-user\fP option is specified, the unpack will not
431:\fB--cut-mark\fP is passed as a parameter to the script when
448:together with vanilla mode (\fB--vanilla-operation\fP). Use this
513:This is an alias for the \fI--quiet\fR option.
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.
42:(\fB--vanilla-operation\fP) or essentially a mailable \fBtar\fP
46:recognized. If the \fB--intermix-type\fP option has been specified,
74:e.g. \fB--gzip\fP. Those options, however, are being deprecated.
76:with \fB-C xz\fP or \fB--compactor=xz\fP.
96:.in -4
142:This is an alias for the \fI--level-of-compression\fR option.
215:the \fB--whole-size-limit\fP or \fB--split-size-limit\fP
238:.in -4
264:.in -4
268:\fB--whole-size-limit\fP option.
289:If the \fB--intermix-type\fP option is specified on the command
295: { echo \--compact xz
304:\fB--input-file-list=-\fP.
314:files. See the \fB--net-headers\fP option.
333:\fB--submitter\fP option. The \fIname\fP must be provided with the
334:\fB--archive-name\fP option. If the archive name includes a slash
389:especially if \fB--uuencode\fP or a compression option is used.
412:(\fB--mixed-uuencode\fP) to text mode (\fB--text-files\fP).
429:\fB--query-user\fP option is specified, the unpack will not
431:\fB--cut-mark\fP is passed as a parameter to the script when
448:together with vanilla mode (\fB--vanilla-operation\fP). Use this
513:This is an alias for the \fI--quiet\fR option.
586:.in -4
-.-.
Strings longer than 3/4 of a standard line length (80)
85 .NOP \f\*[B-Font]\-g\f[] \f\*[I-Font]level\f[],
\f\*[B-Font]\-\-level\-of\-compression\f[]=\f\*[I-Font]level\f[]
-.-.
Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.
74:e.g. \fB--gzip\fP. Those options, however, are being deprecated.
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
shar.1: line 66 length 103
.NOP \f\*[B-Font]\-C\f[] \f\*[I-Font]program\f[],
\f\*[B-Font]\-\-compactor\f[]=\f\*[I-Font]program\f[]
shar.1: line 85 length 112
.NOP \f\*[B-Font]\-g\f[] \f\*[I-Font]level\f[],
\f\*[B-Font]\-\-level\-of\-compression\f[]=\f\*[I-Font]level\f[]
shar.1: line 147 length 103
.NOP \f\*[B-Font]\-b\f[] \f\*[I-Font]bits\f[],
\f\*[B-Font]\-\-bits\-per\-code\f[]=\f\*[I-Font]bits\f[]
shar.1: line 210 length 106
.NOP \f\*[B-Font]\-o\f[] \f\*[I-Font]prefix\f[],
\f\*[B-Font]\-\-output\-prefix\f[]=\f\*[I-Font]prefix\f[]
shar.1: line 223 length 106
.NOP \f\*[B-Font]\-l\f[] \f\*[I-Font]size\f[],
\f\*[B-Font]\-\-whole\-size\-limit\f[]=\f\*[I-Font]size\f[]
shar.1: line 249 length 106
.NOP \f\*[B-Font]\-L\f[] \f\*[I-Font]size\f[],
\f\*[B-Font]\-\-split\-size\-limit\f[]=\f\*[I-Font]size\f[]
shar.1: line 277 length 105
.NOP \f\*[B-Font]\-I\f[] \f\*[I-Font]file\f[],
\f\*[B-Font]\-\-input\-file\-list\f[]=\f\*[I-Font]file\f[]
shar.1: line 310 length 101
.NOP \f\*[B-Font]\-n\f[] \f\*[I-Font]name\f[],
\f\*[B-Font]\-\-archive\-name\f[]=\f\*[I-Font]name\f[]
shar.1: line 316 length 107
.NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]who@where\f[],
\f\*[B-Font]\-\-submitter\f[]=\f\*[I-Font]who@where\f[]
shar.1: line 391 length 105
.NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]delim\f[],
\f\*[B-Font]\-\-here\-delimiter\f[]=\f\*[I-Font]delim\f[]
shar.1: line 521 length 108
.NOP \f\*[B-Font]\-R\f[] [\f\*[I-Font]cfgfile\f[]],
\f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]]
shar.1: line 526 length 137
.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[]
shar.1: line 532 length 104
.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[]}]}]
shar.1: line 625 length 95
This program is released under the terms of the GNU General Public License,
version 3 or later.
-.-.
Use the name of units in text; use symbols in tables and
calculations.
The rule is to have a (no-break, \~) space between a number and
its units (see "www.bipm.org/en/publications/si-brochure")
244:respectively. 4M (4194304) is the maximum allowed.
-.-.
Name of a manual is set in bold, the section in roman.
See man-pages(7).
617:unshar(1)
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a dash
(\-, minus) if it matches "[[:alph:]]-[[:alpha:]]" in the name of an
option).
Facilitates the copy and paste of an option in UTF-8 text.
Is not needed in ordinary words like "mother-in-law", that are not
copied and pasted to a command line (which needs ASCII code)
28:[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]]
42:(\fB--vanilla-operation\fP) or essentially a mailable \fBtar\fP
46:recognized. If the \fB--intermix-type\fP option has been specified,
141:.NOP \f\*[B-Font]\-\-level-for-gzip\f[]
142:This is an alias for the \fI--level-of-compression\fR option.
215:the \fB--whole-size-limit\fP or \fB--split-size-limit\fP
225:This option is a member of the whole-size-limit class of options.
246:Unlike the \fBsplit-size-limit\fP option, this allows the recipient
251:This option is a member of the whole-size-limit class of options.
268:\fB--whole-size-limit\fP option.
289:If the \fB--intermix-type\fP option is specified on the command
304:\fB--input-file-list=-\fP.
314:files. See the \fB--net-headers\fP option.
334:\fB--archive-name\fP option. If the archive name includes a slash
412:(\fB--mixed-uuencode\fP) to text mode (\fB--text-files\fP).
429:\fB--query-user\fP option is specified, the unpack will not
431:\fB--cut-mark\fP is passed as a parameter to the script when
435: sh shar-archive-file \-c
448:together with vanilla mode (\fB--vanilla-operation\fP). Use this
518:.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
521:.NOP \f\*[B-Font]\-R\f[] [\f\*[I-Font]cfgfile\f[]],
\f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]]
526:.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[]
528:The \fIno-load-opts\fP form will disable the loading
529:of earlier config/rc/ini files. \fI\-\-no-load-opts\fP is handled early,
632:Please send bug reports to: bug-gnu-ut...@gnu.org
-.-.
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z -K utf8":
troff: backtrace: file '<stdin>':30
troff:<stdin>:30: warning: register 'Pp' not defined
Where is this variable supposed to be defined?
-.-
Spelling mistakes
miscelleaneous -> miscellaneous
-.-
Use a thousands separator in long numbers
1000000 -> 1,000,000
1048576 -> 1,048,576
4194304 -> 4,194,304
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.7.12-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages sharutils depends on:
ii libc6 2.38-11
sharutils recommends no packages.
Versions of packages sharutils suggests:
pn bsd-mailx | mailx <none>
pn sharutils-doc <none>
-- no debconf information
--- shar.1 2024-05-27 23:56:38.008561703 +0000
+++ shar.1.new 2024-05-28 14:16:20.334092282 +0000
@@ -25,7 +25,7 @@
.\" Mixture of short (flag) options and long options
[\f\*[B-Font]\-flags\f[]]
[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]]
-[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]]
+[\f\*[B-Font]\-\-option\-name\f[][[=| ]\f\*[I-Font]value\f[]]]
[<file>...]
.sp \n(Ppu
.ne 2
@@ -39,11 +39,11 @@ executing them with \fI/bin/sh\fP. The
standard out unless the \fB-o\fP option is given. A wide range of
features provide extensive flexibility in manufacturing shars and in
specifying \fBshar\fP "smartness". Archives may be fairly simple
-(\fB--vanilla-operation\fP) or essentially a mailable \fBtar\fP
+(\fB\-\-vanilla\-operation\fP) or essentially a mailable \fBtar\fP
archive.
.sp
Options may be specified in any order until a \fBfile\fP argument is
-recognized. If the \fB--intermix-type\fP option has been specified,
+recognized. If the \fB\-\-intermix\-type\fP option has been specified,
more compression and encoding options will be recognized between the
\fIfile\fP arguments.
.sp
@@ -63,7 +63,8 @@ Allow positional parameter options. The
encoding method options may be intermixed with file names.
Files named after these options will be processed in the specified way.
.TP
-.NOP \f\*[B-Font]\-C\f[] \f\*[I-Font]program\f[],
\f\*[B-Font]\-\-compactor\f[]=\f\*[I-Font]program\f[]
+.NOP \f\*[B-Font]\-C\f[] \f\*[I-Font]program\f[], \
+\f\*[B-Font]\-\-compactor\f[]=\f\*[I-Font]program\f[]
specify compaction (compression) program.
This option may appear an unlimited number of times.
This option must not appear in combination with any of the following options:
@@ -71,9 +72,9 @@ vanilla-operation.
.sp
The \fBgzip\fP, \fBbzip2\fP and \fBcompress\fP compactor
commands may be specified by the program name as the option name,
-e.g. \fB--gzip\fP. Those options, however, are being deprecated.
+e.g., \fB\-\-gzip\fP. Those options, however, are being deprecated.
There is also the \fBxz\fP compactor now. Specify \fBxz\fP
-with \fB-C xz\fP or \fB--compactor=xz\fP.
+with \fB-C xz\fP or \fB\-\-compactor=xz\fP.
.sp
Specifying the compactor "\fBnone\fP" will disable file compression.
Compressed files are never processed as plain text. They are always
@@ -82,7 +83,8 @@ them.
.sp
Specifying the compactor \fBcompress\fP is deprecated.
.TP
-.NOP \f\*[B-Font]\-g\f[] \f\*[I-Font]level\f[],
\f\*[B-Font]\-\-level\-of\-compression\f[]=\f\*[I-Font]level\f[]
+.NOP \f\*[B-Font]\-g\f[] \f\*[I-Font]level\f[], \
+\f\*[B-Font]\-\-level\-of\-compression\f[]=\f\*[I-Font]level\f[]
pass \fILEVEL\fP for compression.
This option takes an integer number as its argument.
The value of
@@ -91,9 +93,10 @@ is constrained to being:
.in +4
.nf
.na
-in the range 1 through 9
+in the range 1 through 9
.fi
.in -4
+.ad
The default
\f\*[I-Font]level\f[]
for this option is:
@@ -138,13 +141,14 @@ packing. The recipient must have \fBuud
.B
NOTE: THIS OPTION IS DEPRECATED
.TP
-.NOP \f\*[B-Font]\-\-level-for-gzip\f[]
-This is an alias for the \fI--level-of-compression\fR option.
+.NOP \f\*[B-Font]\-\-level\-for\-gzip\f[]
+This is an alias for the \fI\-\-level\-of\-compression\fR option.
.sp
.B
NOTE: THIS OPTION IS DEPRECATED
.TP
-.NOP \f\*[B-Font]\-b\f[] \f\*[I-Font]bits\f[],
\f\*[B-Font]\-\-bits\-per\-code\f[]=\f\*[I-Font]bits\f[]
+.NOP \f\*[B-Font]\-b\f[] \f\*[I-Font]bits\f[], \
+\f\*[B-Font]\-\-bits\-per\-code\f[]=\f\*[I-Font]bits\f[]
pass \fIbits\fP (default 12) to compress.
The default
\f\*[I-Font]bits\f[]
@@ -207,12 +211,13 @@ programs do not like, you may find diffi
using FTP or SSH/SCP, the non-conforming text files should be okay.
.SS "Specifying file selection and output modes"
.TP
-.NOP \f\*[B-Font]\-o\f[] \f\*[I-Font]prefix\f[],
\f\*[B-Font]\-\-output\-prefix\f[]=\f\*[I-Font]prefix\f[]
+.NOP \f\*[B-Font]\-o\f[] \f\*[I-Font]prefix\f[], \
+\f\*[B-Font]\-\-output\-prefix\f[]=\f\*[I-Font]prefix\f[]
print output to file PREFIX.nn.
.sp
Save the archive to files \fIprefix.01\fP thru \fIprefix.nn\fP
instead of sending all output to standard out. Must be specified when
-the \fB--whole-size-limit\fP or \fB--split-size-limit\fP
+the \fB\-\-whole-size\-limit\fP or \fB\-\-split\-size\-limit\fP
options are specified.
.sp
When \fBprefix\fP contains a \fB%\fP character, \fBprefix\fP is then
@@ -220,7 +225,8 @@ interpreted as a \fBsprintf\fP format, w
a single decimal number. When \fBprefix\fP does not contain such a
\fB%\fP character, the string \fB.%02d\fP is internally appended.
.TP
-.NOP \f\*[B-Font]\-l\f[] \f\*[I-Font]size\f[],
\f\*[B-Font]\-\-whole\-size\-limit\f[]=\f\*[I-Font]size\f[]
+.NOP \f\*[B-Font]\-l\f[] \f\*[I-Font]size\f[], \
+\f\*[B-Font]\-\-whole\-size\-limit\f[]=\f\*[I-Font]size\f[]
split archive, not files, to \fIsize\fP.
This option is a member of the whole-size-limit class of options.
This option must appear in combination with the following options:
@@ -232,21 +238,23 @@ is constrained to being:
.in +4
.nf
.na
-in the range 8 through 1023, or
-in the range 8192 through 4194304
+in the range 8 through 1023, or
+in the range 8,192 through 4,194,304
.fi
.in -4
.sp
Limit the output file size to \fIsize\fP bytes, but don't split input
files. If \fIsize\fP is less than 1024, then it will be multiplied
by 1024. The value may also be specified with a k, K, m or M suffix.
-The number is then multiplied by 1000, 1024, 1000000, or 1048576,
-respectively. 4M (4194304) is the maximum allowed.
+The number is then multiplied by 1000, 1024, 1,000,000, or 1,048,576,
+respectively.
+4\ MiB (mebibytes) (4,194,304) is the maximum allowed.
.sp
Unlike the \fBsplit-size-limit\fP option, this allows the recipient
of the shar files to unpack them in any order.
.TP
-.NOP \f\*[B-Font]\-L\f[] \f\*[I-Font]size\f[],
\f\*[B-Font]\-\-split\-size\-limit\f[]=\f\*[I-Font]size\f[]
+.NOP \f\*[B-Font]\-L\f[] \f\*[I-Font]size\f[], \
+\f\*[B-Font]\-\-split\-size\-limit\f[]=\f\*[I-Font]size\f[]
split archive or files to \fIsize\fP.
This option is a member of the whole-size-limit class of options.
This option must appear in combination with the following options:
@@ -258,14 +266,14 @@ is constrained to being:
.in +4
.nf
.na
-in the range 8 through 1023, or
-in the range 8192 through 4194304
+in the range 8 through 1023, or
+in the range 8,192 through 4,194,304
.fi
.in -4
.sp
Limit output file size to \fIsize\fP bytes, splitting files if
necessary. The allowed values are specified as with the
-\fB--whole-size-limit\fP option.
+\fB\-\-whole\-size\-limit\fP option.
.sp
The archive parts created with this option must be unpacked in the
correct order. If the recipient of the shell archives wants to put
@@ -274,7 +282,8 @@ saved in the correct order for \fBunshar
once (using one of the split archive options).
see: unshar Invocation.
.TP
-.NOP \f\*[B-Font]\-I\f[] \f\*[I-Font]file\f[],
\f\*[B-Font]\-\-input\-file\-list\f[]=\f\*[I-Font]file\f[]
+.NOP \f\*[B-Font]\-I\f[] \f\*[I-Font]file\f[], \
+\f\*[B-Font]\-\-input\-file\-list\f[]=\f\*[I-Font]file\f[]
read file list from a file.
.sp
This option causes \fIfile\fP to be reopened as standard input. If
@@ -286,13 +295,13 @@ Input must be in a form similar to that
one filename per line. This switch is especially useful when the
command line will not hold the list of files to be archived.
.sp
-If the \fB--intermix-type\fP option is specified on the command
+If the \fB\-\-intermix\-type\fP option is specified on the command
line, then the compression options may be included in the standard
input on lines by themselves and no file name may begin with a hyphen.
.sp
For example:
.nf
- { echo \--compact xz
+ { echo \-\-compact xz
find . \-type f \-print | sort
} | shar \-S \-p \-L50K \-o /somewhere/big
.fi
@@ -301,19 +310,21 @@ For example:
read file list from standard input.
.sp
This option is actually a no-op. It is a wrapper for
-\fB--input-file-list=-\fP.
+\%\fB\-\-input\-file\-list=\-\fP.
.sp
.B
NOTE: THIS OPTION IS DEPRECATED
.SS "Controlling the shar headers"
.TP
-.NOP \f\*[B-Font]\-n\f[] \f\*[I-Font]name\f[],
\f\*[B-Font]\-\-archive\-name\f[]=\f\*[I-Font]name\f[]
+.NOP \f\*[B-Font]\-n\f[] \f\*[I-Font]name\f[], \
+\f\*[B-Font]\-\-archive\-name\f[]=\f\*[I-Font]name\f[]
use \fIname\fP to document the archive.
.sp
Name of archive to be included in the subject header of the shar
-files. See the \fB--net-headers\fP option.
+files. See the \fB\-\-net\-headers\fP option.
.TP
-.NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]who@where\f[],
\f\*[B-Font]\-\-submitter\f[]=\f\*[I-Font]who@where\f[]
+.NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]who@where\f[], \
+\f\*[B-Font]\-\-submitter\f[]=\f\*[I-Font]who@where\f[]
override the submitter name.
.sp
\fBshar\fP will normally determine the submitter name by querying
@@ -330,8 +341,8 @@ Adds specialized email headers:
Archive-name: \fIname\fP/part##
.fi
The \fIwho@@where\fP is normally derived, but can be specified with the
-\fB--submitter\fP option. The \fIname\fP must be provided with the
-\fB--archive-name\fP option. If the archive name includes a slash
+\fB\-\-submitter\fP option. The \fIname\fP must be provided with the
+\fB\-\-archive\-name\fP option. If the archive name includes a slash
(\fB/\fP) character, then the \fB/part##\fP is omitted. Thus
\fB-n xyzzy\fP produces:
.nf
@@ -370,7 +381,7 @@ is produced.
.SS "Protecting against transmission issues"
.TP
.NOP \f\*[B-Font]\-\-no\-character\-count\f[]
-do not use `wc \-c' to check size.
+do not use 'wc \-c' to check size.
.sp
Do NOT check each file with 'wc \-c' after unpack.
The default is to check.
@@ -386,9 +397,10 @@ apply the prefix character on every line
.sp
Forces the prefix character to be prepended to every line, even if
not required. This option may slightly increase the size of the archive,
-especially if \fB--uuencode\fP or a compression option is used.
+especially if \fB\-\-uuencode\fP or a compression option is used.
.TP
-.NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]delim\f[],
\f\*[B-Font]\-\-here\-delimiter\f[]=\f\*[I-Font]delim\f[]
+.NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]delim\f[], \
+\f\*[B-Font]\-\-here\-delimiter\f[]=\f\*[I-Font]delim\f[]
use \fIdelim\fP to delimit the files.
The default
\f\*[I-Font]delim\f[]
@@ -409,7 +421,7 @@ existence of \fBecho\fP, \fBtest\fP and
unpacking environment.
.sp
It changes the default behavior from mixed mode
-(\fB--mixed-uuencode\fP) to text mode (\fB--text-files\fP).
+(\fB\-\-mixed-uuencode\fP) to text mode (\fB\-\-text\-files\fP).
Warnings are produced if options are specified that will require
decompression or decoding in the unpacking environment.
.TP
@@ -426,9 +438,9 @@ blindly overwrite existing files.
.sp
Create the archive so that when processed it will overwrite existing
files without checking first. If neither this option nor the
-\fB--query-user\fP option is specified, the unpack will not
+\fB\-\-query-user\fP option is specified, the unpack will not
overwrite pre-existing files. In all cases, however, if
-\fB--cut-mark\fP is passed as a parameter to the script when
+\fB\-\-cut-mark\fP is passed as a parameter to the script when
unpacking, then existing files will be overwritten unconditionally.
.sp
.nf
@@ -445,7 +457,7 @@ overwritten. Do not use for shars submi
.sp
Use of this option produces shars which \fIwill\fP cause problems
with some unshar-style procedures, particularly when used
-together with vanilla mode (\fB--vanilla-operation\fP). Use this
+together with vanilla mode (\fB\-\-vanilla-operation\fP). Use this
feature mainly for archives to be passed among agreeable parties.
Certainly, \fB-X\fP is \fInot\fP for shell archives which are to be
submitted to Usenet or other public networks.
@@ -510,7 +522,7 @@ do not output verbose messages.
omit progress messages.
.TP
.NOP \f\*[B-Font]\-\-silent\f[]
-This is an alias for the \fI--quiet\fR option.
+This is an alias for the \fI\-\-quiet\fR option.
.TP
.NOP \f\*[B-Font]\-h\f[], \f\*[B-Font]\-\-help\f[]
Display usage information and exit.
@@ -518,22 +530,25 @@ Display usage information and exit.
.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
Pass the extended usage information through a pager.
.TP
-.NOP \f\*[B-Font]\-R\f[] [\f\*[I-Font]cfgfile\f[]],
\f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]]
+.NOP \f\*[B-Font]\-R\f[] [\f\*[I-Font]cfgfile\f[]], \
+\f\*[B-Font]\-\-save\-opts\f[] [=\f\*[I-Font]cfgfile\f[]]
Save the option state to \fIcfgfile\fP. The default is the \fIlast\fP
configuration file listed in the \fBOPTION PRESETS\fP section, below.
The command will exit after updating the config file.
.TP
-.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[]
+.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[]
Load options from \fIcfgfile\fP.
The \fIno-load-opts\fP form will disable the loading
-of earlier config/rc/ini files. \fI\-\-no-load-opts\fP is handled early,
+of earlier config/rc/ini files. \fI\-\-no-load\-opts\fP is handled early,
out of order.
.TP
-.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[]}]}]
+.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[]}]}]
Output version of program and exit. The default mode is `v', a simple
version. The `c' mode will print copyright information and `n' will
print the full copyright notice.
-.PP
.SH "OPTION PRESETS"
Any option that is not marked as \fInot presettable\fP may be preset
by loading values from configuration ("RC" or ".INI") file(s).
@@ -576,7 +591,6 @@ archive of all uuencoded \fI.arc\fP file
starting from \fIarc.sh.01\fP. The last example gives a shell
archive which will use only the file names at unpack time.
.sp
-.br
.in +4
.nf
shar *.c > cprog.shar
@@ -612,17 +626,17 @@ A specified configuration file could not
.NOP 70 " (EX_SOFTWARE)"
libopts had an internal operational error. Please report
it to autogen-us...@lists.sourceforge.net. Thank you.
-.PP
.SH "SEE ALSO"
-unshar(1)
+.BR unshar (1)
.SH AUTHORS
The \fIshar\fP and \fIunshar\fP programs is the collective work of
many authors. Many people contributed by reporting problems,
suggesting various improvements or submitting actual code. A list of
these people is in the \fITHANKS\fP file in the sharutils distribution.
.SH "COPYRIGHT"
-Copyright (C) 1994-2015 Free Software Foundation, Inc. all rights reserved.
-This program is released under the terms of the GNU General Public License,
version 3 or later.
+Copyright (C) 1994\(en2015 Free Software Foundation, Inc.\& all rights
reserved.
+This program is released under the terms of the GNU General Public License,
+version 3 or later.
.SH BUGS
Please put \fBsharutils\fP in the subject line for emailed bug
reports. It helps to spot the message.
