Changeset 3613 in kBuild for trunk/src/sed/doc/sed.1

Timestamp:

Sep 19, 2024 12:34:43 AM (7 months ago)

Author:

bird

Message:

src/sed: Merged in changes between 4.1.5 and 4.9 from the vendor branch. (svn merge ^{/vendor/sed/4.1.5} /vendor/sed/current .)

Location:

trunk/src/sed

Files:

• . (modified) (1 prop)
• doc/sed.1 (modified) (18 diffs)

trunk/src/sed/doc/sed.1

@@ -1 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.28.
-.TH SED "1" "February 2006" "sed version 4.1.4" "User Commands"
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.5.
+.TH SED "1" "November 2022" "GNU sed 4.9" "User Commands"
 .SH NAME
 sed \- stream editor for filtering and transforming text
 .SH SYNOPSIS
-.B sed
-[\fIOPTION\fR]... \fI{script-only-if-no-other-script} \fR[\fIinput-file\fR]...
+.nf
+sed [-V] [--version] [--help] [-n] [--quiet] [--silent]
+    [-l N] [--line-length=N] [-u] [--unbuffered]
+    [-E] [-r] [--regexp-extended]
+    [-e script] [--expression=script]
+    [-f script-file] [--file=script-file]
+    [script-if-no-other-script]
+    [file...]
+.fi
 .SH DESCRIPTION
 .ds sd \fIsed\fP
@@ -25 +32 @@
 suppress automatic printing of pattern space
 .HP
-\fB\-e\fR script, \fB\-\-expression\fR=\fIscript\fR
+\fB\-\-debug\fR
+.IP
+annotate program execution
+.HP
+\fB\-e\fR script, \fB\-\-expression\fR=\fI\,script\/\fR
 .IP
 add the script to the commands to be executed
 .HP
-\fB\-f\fR script-file, \fB\-\-file\fR=\fIscript\-file\fR
-.IP
-add the contents of script-file to the commands to be executed
-.HP
-\fB\-i[SUFFIX]\fR, \fB\-\-in\-place\fR[=\fISUFFIX\fR]
-.IP
-edit files in place (makes backup if extension supplied)
-.HP
-\fB\-l\fR N, \fB\-\-line\-length\fR=\fIN\fR
-.IP
-specify the desired line-wrap length for the `l' command
+\fB\-f\fR script\-file, \fB\-\-file\fR=\fI\,script\-file\/\fR
+.IP
+add the contents of script\-file to the commands to be executed
+.HP
+\fB\-\-follow\-symlinks\fR
+.IP
+follow symlinks when processing in place
+.HP
+\fB\-i[SUFFIX]\fR, \fB\-\-in\-place\fR[=\fI\,SUFFIX\/\fR]
+.IP
+edit files in place (makes backup if SUFFIX supplied)
+.HP
+\fB\-l\fR N, \fB\-\-line\-length\fR=\fI\,N\/\fR
+.IP
+specify the desired line\-wrap length for the `l' command
 .HP
 \fB\-\-posix\fR
@@ -45 +60 @@
 disable all GNU extensions.
 .HP
-\fB\-r\fR, \fB\-\-regexp\-extended\fR
-.IP
-use extended regular expressions in the script.
+\fB\-E\fR, \fB\-r\fR, \fB\-\-regexp\-extended\fR
+.IP
+use extended regular expressions in the script
+(for portability use POSIX \fB\-E\fR).
 .HP
 \fB\-s\fR, \fB\-\-separate\fR
 .IP
-consider files as separate rather than as a single continuous
-long stream.
+consider files as separate rather than as a single,
+continuous long stream.
+.HP
+\fB\-\-sandbox\fR
+.IP
+operate in sandbox mode (disable e/r/w commands).
 .HP
 \fB\-u\fR, \fB\-\-unbuffered\fR
@@ -58 +78 @@
 load minimal amounts of data from the input files and flush
 the output buffers more often
+.HP
+\fB\-z\fR, \fB\-\-null\-data\fR
+.IP
+separate lines by NUL characters
 .TP
 \fB\-\-help\fR
@@ -66 +90 @@
 .PP
 If no \fB\-e\fR, \fB\-\-expression\fR, \fB\-f\fR, or \fB\-\-file\fR option is given, then the first
-non-option argument is taken as the sed script to interpret.  All
+non\-option argument is taken as the sed script to interpret.  All
 remaining arguments are names of input files; if no input files are
 specified, then the standard input is read.
 .PP
-E-mail bug reports to: [email protected] .
-Be sure to include the word ``sed'' somewhere in the ``Subject:'' field.
+GNU sed home page: <https://www.gnu.org/software/sed/>.
+General help using GNU software: <https://www.gnu.org/gethelp/>.
+E\-mail bug reports to: <bug\[email protected]>.
 .SH "COMMAND SYNOPSIS"
 This is just a brief synopsis of \*(sd commands to serve as
@@ -89 +114 @@
 .RI # comment
 The comment extends until the next newline (or the end of a
-.B -e
+.B \-e
 script fragment).
 .TP
@@ -114 +139 @@
 which has each embedded newline preceded by a backslash.
 .TP
-q
+q [\fIexit-code\fR]
 Immediately quit the \*(sd script without processing
-any more input,
-except that if auto-print is not disabled
-the current pattern space will be printed.
-.TP
-Q
+any more input, except that if auto-print is not disabled
+the current pattern space will be printed.  The exit code
+argument is a GNU extension.
+.TP
+Q [\fIexit-code\fR]
 Immediately quit the \*(sd script without processing
-any more input.
+any more input.  This is a GNU extension.
 .TP
 .RI r\  filename
@@ -131 +156 @@
 Append a line read from
 .IR filename .
+Each invocation of the command reads a line from the file.
+This is a GNU extension.
 .SS
 Commands which accept address ranges
@@ -144 +171 @@
 is omitted, branch to end of script.
 .TP
-.RI t\  label
-If a s/// has done a successful substitution since the
-last input line was read and since the last t or T
-command, then branch to
-.IR label ;
-if
-.I label
-is omitted, branch to end of script.
-.TP
-.RI T\  label
-If no s/// has done a successful substitution since the
-last input line was read and since the last t or T
-command, then branch to
-.IR label ;
-if
-.I label
-is omitted, branch to end of script.
-.TP
 c \e
 .TP
@@ -174 +183 @@
 .TP
 D
-Delete up to the first embedded newline in the pattern space.
-Start next cycle, but skip reading from the input
-if there is still data in the pattern space.
+If pattern space contains no newline, start a normal new cycle as if
+the d command was issued.  Otherwise, delete text in the pattern
+space up to the first newline, and restart cycle with the resultant
+pattern space, without reading a new line of input.
 .TP
 h H
@@ -184 +194 @@
 Copy/append hold space to pattern space.
 .TP
-x
-Exchange the contents of the hold and pattern spaces.
-.TP
 l
 List out the current line in a ``visually unambiguous'' form.
+.TP
+.RI l\  width
+List out the current line in a ``visually unambiguous'' form,
+breaking it at
+.I width
+characters.  This is a GNU extension.
 .TP
 n N
@@ -215 +228 @@
 .IR regexp .
 .TP
+.RI t\  label
+If a s/// has done a successful substitution since the
+last input line was read and since the last t or T
+command, then branch to
+.IR label ;
+if
+.I label
+is omitted, branch to end of script.
+.TP
+.RI T\  label
+If no s/// has done a successful substitution since the
+last input line was read and since the last t or T
+command, then branch to
+.IR label ;
+if
+.I label
+is omitted, branch to end of script.  This is a GNU
+extension.
+.TP
 .RI w\  filename
 Write the current pattern space to
@@ -222 +254 @@
 Write the first line of the current pattern space to
 .IR filename .
+This is a GNU extension.
+.TP
+x
+Exchange the contents of the hold and pattern spaces.
 .TP
 .RI y/ source / dest /
@@ -269 +305 @@
 .I number
 Match only the specified line
-.IR number .
+.IR number
+(which increments cumulatively across files, unless the
+.B \-s
+option is specified on the command line).
 .TP
 .IR first ~ step
@@ -276 +315 @@
 line starting with line
 .IR first .
-For example, ``sed -n 1~2p'' will print all the odd-numbered lines in
+For example, ``sed \-n 1~2p'' will print all the odd-numbered lines in
 the input stream, and the address 2~5 will match every fifth line,
-starting with the second. (This is an extension.)
+starting with the second.
+.I first
+can be zero; in this case, \*(sd operates as if it were equal to
+.IR step .
+(This is an extension.)
 .TP
 $
@@ -286 +329 @@
 Match lines matching the regular expression
 .IR regexp .
+Matching is performed on the current pattern space, which
+can be modified with commands such as ``s///''.
 .TP
 .BI \fR\e\fPc regexp c
@@ -309 +354 @@
 .RI 1, addr2
 form will still be at the beginning of its range.
+This works only when
+.I addr2
+is a regular expression.
 .TP
 .IR addr1 ,+ N
@@ -337 +385 @@
 .BR \et ,
 and other sequences.
+The \fI-E\fP option switches to using extended regular expressions instead;
+it has been supported for years by GNU sed, and is now
+included in POSIX.
 .SH BUGS
 .PP
 E-mail bug reports to
-.BR [email protected] .
-Be sure to include the word ``sed'' somewhere in the ``Subject:'' field.
-Also, please include the output of ``sed --version'' in the body
+.BR [email protected] .
+Also, please include the output of ``sed \-\-version'' in the body
 of your report if at all possible.
+.SH AUTHOR
+Written by Jay Fenlason, Tom Lord, Ken Pizzini,
+Paolo Bonzini, Jim Meyering, and Assaf Gordon.
+.PP
+This sed program was built with SELinux support.
+SELinux is enabled on this system.
+.PP
+GNU sed home page: <https://www.gnu.org/software/sed/>.
+General help using GNU software: <https://www.gnu.org/gethelp/>.
+E\-mail bug reports to: <bug\[email protected]>.
 .SH COPYRIGHT
-Copyright \(co 2003 Free Software Foundation, Inc.
+Copyright \(co 2022 Free Software Foundation, Inc.
+License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
 .br
-This is free software; see the source for copying conditions.  There is NO
-warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE,
-to the extent permitted by law.
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
 .SH "SEE ALSO"
 .BR awk (1),