doc: env: simplify extra info in the man page

* man/env.x: Avoid confusion in the [OPTIONS] section
by renaming to [SCRIPT OPTION HANDLING], and removing info
regarding default signal handling, which is best
restricted to the full info manual.
Addresses https://bugs.gnu.org/72914
This commit is contained in:
Pádraig Brady
2024-09-23 21:17:28 +01:00
parent 7337076ecf
commit 4da7daa01f

View File

@@ -7,11 +7,10 @@
env \- run a program in a modified environment
[DESCRIPTION]
.\" Add any additional description here
[OPTIONS]
.SS "\-S/\-\-split\-string usage in scripts"
[SCRIPT OPTION HANDLING]
The
.B \-S
option allows specifying multiple parameters in a script.
option allows specifying multiple arguments in a script.
Running a script named
.B 1.pl
containing the following first line:
@@ -24,7 +23,7 @@ containing the following first line:
.RE
.PP
Will execute
.B "perl \-w \-T 1.pl".
.B "perl \-w \-T 1.pl"
.PP
Without the
.B '\-S'
@@ -38,20 +37,6 @@ parameter the script will likely fail with:
.PP
See the full documentation for more details.
.PP
.SS "\-\-default-signal[=SIG]" usage
This option allows setting a signal handler to its default
action, which is not possible using the traditional shell
trap command. The following example ensures that seq
will be terminated by SIGPIPE no matter how this signal
is being handled in the process invoking the command.
.PP
.RS
.nf
sh \-c 'env \-\-default-signal=PIPE seq inf | head \-n1'
.fi
.RE
.PP
[NOTES]
POSIX's exec(3p) pages says: