openbsd-ports/archivers/gshar+gunshar/patches/patch-doc_shar_1

181 lines
8.0 KiB
Plaintext

--- doc/shar.1.orig Sat May 30 17:34:15 2015
+++ doc/shar.1 Mon Sep 7 19:38:10 2015
@@ -1,4 +1,4 @@
-.de1 NOP
+.TH gshar 1 "27 Dec 2012" "GNU sharutils (4.13.1)" "User Commands"
. it 1 an-trap
. if \\n[.$] \,\\$*\/
..
@@ -18,10 +18,10 @@
.\" From the definitions shar-opts.def
.\" and the template file agman-cmd.tpl
.SH NAME
-\f\*[B-Font]shar\fP
+\f\*[B-Font]gshar\fP
\- create a shell archive
.SH SYNOPSIS
-\f\*[B-Font]shar\fP
+\f\*[B-Font]gshar\fP
.\" Mixture of short (flag) options and long options
[\f\*[B-Font]\-flags\f[]]
[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]]
@@ -33,12 +33,12 @@
If no \fIfile\fPs are specified, the list of input files is read
from standard input. Standard input must not be a terminal.
.SH "DESCRIPTION"
-\fBshar\fP creates "shell archives" (or shar files) which are in
+\fBgshar\fP creates "shell archives" (or shar files) which are in
text format and can be emailed. These files may be unpacked later by
executing them with \fI/bin/sh\fP. The resulting archive is sent to
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
+specifying \fBgshar\fP "smartness". Archives may be fairly simple
(\fB--vanilla-operation\fP) or essentially a mailable \fBtar\fP
archive.
.sp
@@ -168,7 +168,7 @@ This option is a member of the mixed-uuencode class of
.sp
Automatically determine if the files are text or binary and archive
correctly. Files found to be binary are uuencoded prior to packing.
-This is the default behavior for \fBshar\fP.
+This is the default behavior for \fBgshar\fP.
.sp
For a file to be considered a text file instead of a binary file,
all the following should be true:
@@ -270,9 +270,9 @@ necessary. The allowed values are specified as with t
The archive parts created with this option must be unpacked in the
correct order. If the recipient of the shell archives wants to put
all of them in a single email folder (file), they will have to be
-saved in the correct order for \fBunshar\fP to unpack them all at
+saved in the correct order for \fBgunshar\fP to unpack them all at
once (using one of the split archive options).
-see: unshar Invocation.
+see: gunshar 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[]
read file list from a file.
@@ -294,7 +294,7 @@ For example:
.nf
{ echo \--compact xz
find . \-type f \-print | sort
- } | shar \-S \-p \-L50K \-o /somewhere/big
+ } | gshar \-S \-p \-L50K \-o /somewhere/big
.fi
.TP
.NOP \f\*[B-Font]\-S\f[], \f\*[B-Font]\-\-stdin\-file\-list\f[]
@@ -316,7 +316,7 @@ files. See the \fB--net-headers\fP option.
.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
+\fBgshar\fP will normally determine the submitter name by querying
the system. Use this option if it is being done on behalf of another.
.TP
.NOP \f\*[B-Font]\-a\f[], \f\*[B-Font]\-\-net\-headers\f[]
@@ -361,7 +361,7 @@ start of each output file.
translate messages in the script.
.sp
Translate messages in the script. If you have set the \fBLANG\fP
-environment variable, messages printed by \fBshar\fP will be in the
+environment variable, messages printed by \fBgshar\fP will be in the
specified language. The produced script will still be emitted using
messages in the lingua franca of the computer world: English. This
option will cause the script messages to appear in the languages
@@ -416,7 +416,7 @@ decompression or decoding in the unpacking environment
.NOP \f\*[B-Font]\-P\f[], \f\*[B-Font]\-\-no\-piping\f[]
use temporary files between programs.
.sp
-In the \fIshar\fP file, use a temporary file to hold file contents
+In the \fIgshar\fP file, use a temporary file to hold file contents
between unpacking stages instead of using pipes. This option is
mandatory when you know the unpacking will happen on systems that do
not support pipes.
@@ -450,13 +450,13 @@ feature mainly for archives to be passed among agreeab
Certainly, \fB-X\fP is \fInot\fP for shell archives which are to be
submitted to Usenet or other public networks.
.sp
-The problem is that \fBunshar\fP programs or procedures often feed
+The problem is that \fBgunshar\fP programs or procedures often feed
\fI/bin/sh\fP from its standard input, thus putting \fI/bin/sh\fP
and the shell archive script in competition for input lines. As an
-attempt to alleviate this problem, \fBshar\fP will try to detect
+attempt to alleviate this problem, \fBgshar\fP will try to detect
if \fI/dev/tty\fP exists at the receiving site and will use it to
read user replies. But this does not work in all cases, it may happen
-that the receiving user will have to avoid using \fBunshar\fP
+that the receiving user will have to avoid using \fBgunshar\fP
programs or procedures, and call \fI/bin/sh\fP directly. In vanilla
mode, using \fI/dev/tty\fP is not even attempted.
.TP
@@ -483,7 +483,7 @@ restore in one directory, despite hierarchy.
Restore by the base file name only, rather than path. This option
causes only file names to be used, which is useful when building a
shar from several directories, or another directory. Note that if a
-directory name is passed to shar, the substructure of that directory
+directory name is passed to gshar, the substructure of that directory
will be restored whether this option is specified or not.
.SS "Internationalization options"
.TP
@@ -491,7 +491,7 @@ will be restored whether this option is specified or n
do not internationalize.
.sp
Do not produce internationalized shell archives, use default English
-messages. By default, shar produces archives that will try to output
+messages. By default, gshar produces archives that will try to output
messages in the unpackers preferred language (as determined by the
LANG/LC_MESSAGES environmental variables) when they are unpacked. If
no message file for the unpackers language is found at unpack time,
@@ -500,7 +500,7 @@ messages will be in English.
.NOP \f\*[B-Font]\-\-print\-text\-domain\-dir\f[]
print directory with shar messages.
.sp
-Prints the directory shar looks in to find messages files
+Prints the directory gshar looks in to find messages files
for different languages, then immediately exits.
.SS "User feedback/entertainment"
.TP
@@ -541,7 +541,7 @@ The file "\fI$HOME/.sharrc\fP" will be used, if presen
.SH WARNINGS
No attempt is made to restore the protection and modification dates
for directories, even if this is done by default for files. Thus, if
-a directory is given to \fBshar\fP, the protection and modification
+a directory is given to \fBgshar\fP, the protection and modification
dates of corresponding unpacked directory may not match those of the
original.
.sp
@@ -579,10 +579,10 @@ archive which will use only the file names at unpack t
.br
.in +4
.nf
-shar *.c > cprog.shar
-shar \-Q *.[ch] > cprog.shar
-shar \-B \-l28 \-oarc.sh *.arc
-shar \-f /lcl/src/u*.c > u.sh
+gshar *.c > cprog.shar
+gshar \-Q *.[ch] > cprog.shar
+gshar \-B \-l28 \-oarc.sh *.arc
+gshar \-f /lcl/src/u*.c > u.sh
.in -4
.fi
.SH "EXIT STATUS"
@@ -614,9 +614,9 @@ libopts had an internal operational error. Please rep
it to autogen-users@lists.sourceforge.net. Thank you.
.PP
.SH "SEE ALSO"
-unshar(1)
+gunshar(1)
.SH AUTHORS
-The \fIshar\fP and \fIunshar\fP programs is the collective work of
+The \fIgshar\fP and \fIgunshar\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.
@@ -631,5 +631,5 @@ reports. It helps to spot the message.
Please send bug reports to: bug-gnu-utils@gnu.org
.SH "NOTES"
-This manual page was \fIAutoGen\fP-erated from the \fBshar\fP
+This manual page was \fIAutoGen\fP-erated from the \fBgshar\fP
option definitions.