diff options
Diffstat (limited to 'usr/src/man/man1/sed.1')
| -rw-r--r-- | usr/src/man/man1/sed.1 | 1199 |
1 files changed, 662 insertions, 537 deletions
diff --git a/usr/src/man/man1/sed.1 b/usr/src/man/man1/sed.1 index 3b69a70403..9ec2b67dd9 100644 --- a/usr/src/man/man1/sed.1 +++ b/usr/src/man/man1/sed.1 @@ -1,545 +1,670 @@ -'\" te -.\" Copyright 1989 AT&T -.\" Copyright (c) 1998, Sun Microsystems, Inc. All Rights Reserved -.\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved -.\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at -.\" http://www.opengroup.org/bookstore/. -.\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html. -.\" This notice shall appear on any product containing this material. -.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. -.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. -.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH sed 1 "23 Jul 1998" "SunOS 5.11" "User Commands" +.\" Copyright (c) 1992, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" This code is derived from software contributed to Berkeley by +.\" the Institute of Electrical and Electronics Engineers, Inc. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 4. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.TH SED 1 "May 24, 2009" .SH NAME -sed \- stream editor +\fBsed\fP +\- stream editor .SH SYNOPSIS -.LP -.nf -\fB/usr/bin/sed\fR [\fB-n\fR] \fIscript\fR [\fIfile\fR]... -.fi - -.LP -.nf -\fB/usr/bin/sed\fR [\fB-n\fR] [\fB-e\fR \fIscript\fR]... [\fB-f\fR \fIscript_file\fR]... - [\fIfile\fR]... -.fi - -.LP -.nf -\fB/usr/xpg4/bin/sed\fR [\fB-n\fR] \fIscript\fR [\fIfile\fR]... -.fi - -.LP -.nf -\fB/usr/xpg4/bin/sed\fR [\fB-n\fR] [\fB-e\fR \fIscript\fR]... [\fB-f\fR \fIscript_file\fR]... - [\fIfile\fR]... -.fi - +.br +\fBsed\fP +[\fB\-Ealnr\fP] +\fIcommand\fP +[\fIfile ...\fP] +.br +\fBsed\fP +[\fB\-Ealnr\fP] +[\fB\-e\fP \fIcommand\fP] +[\fB\-f\fP \fIcommand_file\fP] +[\fB\-I\fP \fIextension\fP] +[\fB\-i\fP \fIextension\fP] +[\fIfile ...\fP] .SH DESCRIPTION -.sp -.LP -The \fBsed\fR utility is a stream editor that reads one or more text files, -makes editing changes according to a script of editing commands, and writes the -results to standard output. The script is obtained from either the \fIscript\fR -operand string, or a combination of the option-arguments from the \fB-e\fR -\fIscript\fR and \fB-f\fR \fIscript_file\fR options. -.sp -.LP -The \fBsed\fR utility is a text editor. It cannot edit binary files or files -containing ASCII NUL (\e0) characters or very long lines. -.SH OPTIONS -.sp -.LP -The following options are supported: -.sp -.ne 2 -.mk -.na -\fB\fB-e\fR \fIscript\fR \fR -.ad -.RS 19n -.rt -\fIscript\fR is an edit command for \fBsed\fR. See USAGE below for more -information on the format of \fIscript\fR. If there is just one \fB-e\fR option -and no \fB-f\fR options, the flag \fB-e\fR may be omitted. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-f\fR \fIscript_file\fR \fR -.ad -.RS 19n -.rt -Takes the script from \fIscript_file\fR. \fIscript_file\fR consists of editing -commands, one per line. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB-n\fR \fR -.ad -.RS 19n -.rt -Suppresses the default output. -.RE - -.sp -.LP -Multiple \fB-e\fR and \fB-f\fR options may be specified. All commands are added -to the script in the order specified, regardless of their origin. -.SH OPERANDS -.sp -.LP -The following operands are supported: -.sp -.ne 2 -.mk -.na -\fB\fIfile\fR \fR -.ad -.RS 11n -.rt -A path name of a file whose contents will be read and edited. If multiple -\fIfile\fR operands are specified, the named files will be read in the order -specified and the concatenation will be edited. If no \fIfile\fR operands are -specified, the standard input will be used. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fIscript\fR \fR -.ad -.RS 11n -.rt -A string to be used as the script of editing commands. The application must not -present a \fIscript\fR that violates the restrictions of a text file except -that the final character need not be a \fBNEWLINE\fR character. -.RE - -.SH USAGE -.sp -.LP -A script consists of editing commands, one per line, of the following form: -.sp -.LP -[ \|\fIaddress\fR \|[ \|, \|\fIaddress\fR \|] \|] \|\fIcommand\fR \|[ -\|\fIarguments\fR \|] -.sp -.LP -Zero or more blank characters are accepted before the first address and before -\fIcommand\fR. Any number of semicolons are accepted before the first address. -.sp -.LP -In normal operation, \fBsed\fR cyclically copies a line of input (less its -terminating \fBNEWLINE\fR character) into a \fIpattern space\fR (unless there -is something left after a \fBD\fR command), applies in sequence all commands -whose \fIaddresses\fR select that pattern space, and copies the resulting -pattern space to the standard output (except under \fB-n\fR) and deletes the -pattern space. Whenever the pattern space is written to standard output or a -named file, \fBsed\fR will immediately follow it with a \fINEWLINE\fR -character. -.sp -.LP -Some of the commands use a \fIhold space\fR to save all or part of the -\fIpattern space\fR for subsequent retrieval. The \fIpattern\fR and \fIhold -spaces\fR will each be able to hold at least \fB8192\fR bytes. -.SS "sed Addresses" -.sp -.LP -An \fIaddress\fR is either empty, a decimal number that counts input lines -cumulatively across files, a \fB$\fR that addresses the last line of input, or -a context address, which consists of a \fB/\fR\fIregular expression\fR\fB/\fR -as described on the \fBregexp\fR(5) manual page. -.sp -.LP +The +\fBsed\fP +utility reads the specified files, or the standard input if no files +are specified, modifying the input as specified by a list of commands. +The input is then written to the standard output. + +A single command may be specified as the first argument to +\fB.\fP +Multiple commands may be specified by using the +\fB\-e\fP +or +\fB\-f\fP +options. +All commands are applied to the input in the order they are specified +regardless of their origin. + +The following options are available: +.TP +\fB\-E\fP +Interpret regular expressions as extended (modern) regular expressions +rather than basic regular expressions (BRE's). +The +\fBre_format\fP(7) +manual page fully describes both formats. +.TP +\fB\-a\fP +The files listed as parameters for the +``w'' +functions are created (or truncated) before any processing begins, +by default. +The +\fB\-a\fP +option causes +\fBsed\fP +to delay opening each file until a command containing the related +``w'' +function is applied to a line of input. +.TP +\fB\-e\fP \fIcommand\fP +Append the editing commands specified by the +\fIcommand\fP +argument +to the list of commands. +.TP +\fB\-f\fP \fIcommand_file\fP +Append the editing commands found in the file +\fIcommand_file\fP +to the list of commands. +The editing commands should each be listed on a separate line. +.TP +\fB\-I\fP \fIextension\fP +Edit files in-place, saving backups with the specified +\fIextension\fP. +If a zero-length +\fIextension\fP +is given, no backup will be saved. +It is not recommended to give a zero-length +\fIextension\fP +when in-place editing files, as you risk corruption or partial content +in situations where disk space is exhausted, etc. + +Note that in-place editing with +\fB\-I\fP +still takes place in a single continuous line address space covering +all files, although each file preserves its individuality instead of +forming one output stream. +The line counter is never reset between files, address ranges can span +file boundaries, and the +``$'' +address matches only the last line of the last file. +(See +.B "Sed Addresses" . ) +That can lead to unexpected results in many cases of in-place editing, +where using +\fB\-i\fP +is desired. +.TP +\fB\-i\fP \fIextension\fP +Edit files in-place similarly to +\fB\-I\fP, +but treat each file independently from other files. +In particular, line numbers in each file start at 1, +the +``$'' +address matches the last line of the current file, +and address ranges are limited to the current file. +(See +.B "Sed Addresses" . ) +The net result is as though each file were edited by a separate +\fBsed\fP +instance. +.TP +\fB\-l\fP +Make output line buffered. +.TP +\fB\-n\fP +By default, each line of input is echoed to the standard output after +all of the commands have been applied to it. +The +\fB\-n\fP +option suppresses this behavior. +.TP +\fB\-r\fP +Same as +\fB\-E\fP +for compatibility with GNU sed. + +The form of a +\fBsed\fP +command is as follows: + +[address[,address]]function[arguments] + +Whitespace may be inserted before the first address and the function +portions of the command. + +Normally, +\fBsed\fP +cyclically copies a line of input, not including its terminating newline +character, into a +.IR "pattern space" , +(unless there is something left after a +``D'' +function), +applies all of the commands with addresses that select that pattern space, +copies the pattern space to the standard output, appending a newline, and +deletes the pattern space. + +Some of the functions use a +.IR "hold space" +to save all or part of the pattern space for subsequent retrieval. +.SH "Sed Addresses" +An address is not required, but if specified must have one of the +following formats: +.IP \(bu +a number that counts +input lines +cumulatively across input files (or in each file independently +if a +\fB\-i\fP +option is in effect); +.IP \(bu +a dollar +(``$'') +character that addresses the last line of input (or the last line +of the current file if a +\fB\-i\fP +option was specified); +.IP \(bu +a context address +that consists of a regular expression preceded and followed by a +delimiter. The closing delimiter can also optionally be followed by the +``I'' +character, to indicate that the regular expression is to be matched +in a case-insensitive way. + A command line with no addresses selects every pattern space. -.sp -.LP -A command line with one address selects each pattern space that matches the + +A command line with one address selects all of the pattern spaces +that match the address. + +A command line with two addresses selects an inclusive range. +This +range starts with the first pattern space that matches the first address. -.sp -.LP -A command line with two addresses selects the inclusive range from the first -pattern space that matches the first address through the next pattern space -that matches the second address. Thereafter the process is repeated, looking -again for the first address. (If the second address is a number less than or -equal to the line number selected by the first address, only the line -corresponding to the first address is selected.) -.sp -.LP -Typically, address are separated from each other by a comma (,). They may also -be separated by a semicolon (;). -.SS "sed Regular Expressions" -.sp -.LP -\fBsed\fR supports the basic regular expressions described on the -\fBregexp\fR(5) manual page, with the following additions: -.sp -.ne 2 -.mk -.na -\fB\fI\ecREc\fR \fR -.ad -.RS 11n -.rt -In a context address, the construction \fI\ecREc\fR, where \fIc\fR is any -character other than a backslash or \fBNEWLINE\fR character, is identical to -/\fIRE\fR/. If the character designated by \fIc\fR appears following a -backslash, then it is considered to be that literal character, which does not -terminate the RE. For example, in the context address \fB\exabc\exdefx\fR, the -second \fBx\fR stands for itself, so that the regular expression is -\fBabcxdef\fR. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB\en\fR \fR -.ad -.RS 11n -.rt -The escape sequence \fB\en\fR matches a \fINEWLINE\fR character embedded in the -pattern space. A literal \fBNEWLINE\fR character must not be used in the -regular expression of a context address or in the substitute command. -.RE - -.sp -.LP -Editing commands can be applied only to non-selected pattern spaces by use of -the negation command \fB!\fR (described below). -.SS "sed Editing Commands" -.sp -.LP -In the following list of functions the maximum number of permissible addresses -for each function is indicated. -.sp -.LP -The \fBr\fR and \fBw\fR commands take an optional \fIrfile\fR (or \fIwfile\fR) -parameter, separated from the command letter by one or more blank characters. -.sp -.LP -Multiple commands can be specified by separating them with a semicolon -(\fB;\fR) on the same command line. -.sp -.LP -The \fItext\fR argument consists of one or more lines, all but the last of -which end with \fB\e\fR to hide the \fBNEWLINE\fR. Each embedded \fBNEWLINE\fR -character in the text must be preceded by a backslash. Other backslashes in -text are removed and the following character is treated literally. Backslashes -in text are treated like backslashes in the replacement string of an \fBs\fR -command, and may be used to protect initial blanks and tabs against the -stripping that is done on every script line. The \fIrfile\fR or \fIwfile\fR -argument must terminate the command line and must be preceded by exactly one -blank. The use of the \fIwfile\fR parameter causes that file to be initially -created, if it does not exist, or will replace the contents of an existing -file. There can be at most 10 distinct \fIwfile\fR arguments. -.sp -.LP -Regular expressions match entire strings, not just individual lines, but a -\fBNEWLINE\fR character is matched by \fB\en\fR in a \fBsed\fR RE. A -\fBNEWLINE\fR character is not allowed in an RE. Also notice that \fB\en\fR -cannot be used to match a \fBNEWLINE\fR character at the end of an input line; -\fBNEWLINE\fR characters appear in the pattern space as a result of the \fBN\fR -editing command. -.sp -.LP -Two of the commands take a \fIcommand-list\fR, which is a list of \fBsed\fR -commands separated by \fBNEWLINE\fR characters, as follows: -.sp -.in +2 -.nf -{ \fIcommand\fR -\fIcommand\fR +The end of the range is the next following pattern space +that matches the second address. +If the second address is a number +less than or equal to the line number first selected, only that +line is selected. +The number in the second address may be prefixed with a +(``\&+'') +to specify the number of lines to match after the first pattern. +In the case when the second address is a context +address, +\fBsed\fP +does not re-match the second address against the +pattern space that matched the first address. +Starting at the +first line following the selected range, +\fBsed\fP +starts looking again for the first address. + +Editing commands can be applied to non-selected pattern spaces by use +of the exclamation character +(``\&!'') +function. +.SH "Sed Regular Expressions" +The regular expressions used in +\fB,\fP +by default, are basic regular expressions (BREs, see +\fBre_format\fP(7) +for more information), but extended (modern) regular expressions can be used +instead if the +\fB\-E\fP +flag is given. +In addition, +\fBsed\fP +has the following two additions to regular expressions: + +.IP 1. +In a context address, any character other than a backslash +(``\e'') +or newline character may be used to delimit the regular expression. +The opening delimiter needs to be preceded by a backslash +unless it is a slash. +For example, the context address +\exabcx +is equivalent to +/abc/ . +Also, putting a backslash character before the delimiting character +within the regular expression causes the character to be treated literally. +For example, in the context address +\exabc\exdefx , +the RE delimiter is an +``x'' +and the second +``x'' +stands for itself, so that the regular expression is +``abcxdef''. + +.IP 2. +The escape sequence \en matches a newline character embedded in the +pattern space. +You cannot, however, use a literal newline character in an address or +in the substitute command. + +One special feature of +\fBsed\fP +regular expressions is that they can default to the last regular +expression used. +If a regular expression is empty, i.e., just the delimiter characters +are specified, the last regular expression encountered is used instead. +The last regular expression is defined as the last regular expression +used as part of an address or substitute command, and at run-time, not +compile-time. +For example, the command +``/abc/s//XXX/'' +will substitute +``XXX'' +for the pattern +``abc''. +.SH "Sed Functions" +In the following list of commands, the maximum number of permissible +addresses for each command is indicated by [0addr], [1addr], or [2addr], +representing zero, one, or two addresses. + +The argument +.IR text +consists of one or more lines. +To embed a newline in the text, precede it with a backslash. +Other backslashes in text are deleted and the following character +taken literally. + +The +``r'' +and +``w'' +functions take an optional file parameter, which should be separated +from the function letter by white space. +Each file given as an argument to +\fBsed\fP +is created (or its contents truncated) before any input processing begins. + +The +``b'', +``r'', +``s'', +``t'', +``w'', +``y'', +``\&!'', +and +``\&:'' +functions all accept additional arguments. +The following synopses indicate which arguments have to be separated from +the function letters by white space characters. + +Two of the functions take a function-list. +This is a list of +\fBsed\fP +functions separated by newlines, as follows: + +{ function +.br + function +.br + ... +.br + function +.br } -.fi -.in -2 - -.sp -.LP -The \fB{\fR can be preceded with blank characters and can be followed with -white space. The \fIcommands\fR can be preceded by white space. The terminating -\fB}\fR must be preceded by a \fBNEWLINE\fR character and can be preceded or -followed by <blank>s. The braces may be preceded or followed by <blank>s. The -command may be preceded by <blank>s, but may not be followed by <blank>s. -.sp -.LP -The following table lists the functions, with the maximum number of permissible -addresses. -.sp - -.sp -.TS -tab() box; -cw(.92i) |cw(1.38i) |cw(3.21i) -lw(.92i) |lw(1.38i) |lw(3.21i) -. -Max AddressCommandDescription -_ -1\fBa\e\fR \fItext\fRT{ -Append by executing \fBN\fR command or beginning a new cycle. Place \fItext\fR on the output before reading the next input line. -T} -_ -2\fBb\fR \fIlabel\fRT{ -Branch to the \fB:\fR command bearing the \fIlabel \fR. If \fIlabel\fR is empty, branch to the end of the script. Labels are recognized unique up to eight characters. -T} -_ -2\fBc\e\fR \fItext\fRT{ -Change. Delete the pattern space. Place \fItext\fR on the output. Start the next cycle. -T} -2\fBd\fRT{ -Delete the pattern space. Start the next cycle. -T} -_ -2\fBD\fRT{ -Delete the initial segment of the pattern space through the first new-line. Start the next cycle. (See the \fBN\fR command below.) -T} -_ -2\fBg\fRT{ -Replace the contents of the pattern space by the contents of the hold space. -T} -_ -2\fBG\fRT{ -Append the contents of the hold space to the pattern space. -T} -_ -2\fBh\fRT{ -Replace the contents of the hold space by the contents of the pattern space. -T} -_ -2\fBH\fRT{ -Append the contents of the pattern space to the hold space. -T} -_ -1\fBi\e\fR \fItext\fRT{ -Insert. Place \fItext\fR on the standard output. -T} -_ -2\fBl\fRT{ -\fB/usr/bin/sed\fR: List the pattern space on the standard output in an unambiguous form. Non-printable characters are displayed in octal notation and long lines are folded. -T} -_ -T{ -\fB/usr/xpg4/bin/sed\fR: List the pattern space on the standard output in an unambiguous form. Non-printable characters are displayed in octal notation and long lines are folded. The characters (\fB\e\e\fR, \fB\ea\fR, \fB\eb\fR, \fB\ef\fR, \fB\er\fR, \fB\et\fR, and \fB\ev\fR) are written as the corresponding escape sequences. Non-printable characters not in that table will be written as one three-digit octal number (with a preceding backslash character) for each byte in the character (most significant byte first). If the size of a byte on the system is greater than nine bits, the format used for non-printable characters is implementation dependent. -T} -T{ -Long lines are folded, with the point of folding indicated by writing a backslash followed by a \fBNEWLINE\fR; the length at which folding occurs is unspecified, but should be appropriate for the output device. The end of each line is marked with a \fB$\fR. -T} -_ -2\fBn\fRT{ -Copy the pattern space to the standard output if default output is not suppressed. Replace the pattern space with the next line of input. -T} -_ -2\fBN\fRT{ -Append the next line of input to the pattern space with an embedded new-line. (The current line number changes.) If no next line of input is available, the \fBN\fR command verb shall branch to the end of the script and quit without starting a new cycle and without writing the pattern space. -T} -_ -2\fBp\fRT{ -Print. Copy the pattern space to the standard output. -T} -_ -2\fBP\fRT{ -Copy the initial segment of the pattern space through the first new-line to the standard output. -T} -_ -1\fBq\fRT{ -Quit. Branch to the end of the script. Do not start a new cycle. -T} -_ -2\fBr\fR \fIrfile\fRT{ -Read the contents of \fI rfile\fR. Place them on the output before reading the next input line. If \fIrfile\fR does not exist or cannot be read, it is treated as if it were an empty file, causing no error condition. -T} -_ -2\fBt\fR \fIlabel\fRT{ -Test. Branch to the \fB:\fR command bearing the \fIlabel\fR if any substitutions have been made since the most recent reading of an input line or execution of a \fBt\fR. If \fIlabel\fR is empty, branch to the end of the script. -T} -_ -2\fBw\fR \fIwfile\fRT{ -Write. Append the pattern space to \fIwfile\fR. The first occurrence of \fBw\fR will cause \fIwfile\fR to be cleared. Subsequent invocations of \fBw\fR will append. Each time the \fBsed\fR command is used, \fIwfile\fR is overwritten. -T} -_ -2\fBx\fRT{ -Exchange the contents of the pattern and hold spaces. -T} -_ -2\fB!\fR \fIcommand\fRT{ -Don't. Apply the \fIcommand\fR (or group, if \fIcommand\fR is \fB{\|\fR) only to lines \fInot\fR selected by the address(es). -T} -_ -0\fB:\fR \fIlabel\fRT{ -This command does nothing; it bears a \fIlabel\fR for \fBb\fR and \fBt\fR commands to branch to. -T} -_ -1\fB=\fRT{ -Place the current line number on the standard output as a line. -T} -_ -2\fB{\fR\fIcommand-list\fR\fB}\fRT{ -Execute \fIcommand-list\fR only when the pattern space is selected. -T} -0An empty command is ignored. -_ -0\fB#\fRT{ -If a \fB#\fR appears as the first character on a line of a script file, then that entire line is treated as a comment, with one exception: if a \fB#\fR appears on the first line and the character after the \fB#\fR is an \fBn\fR, then the default output will be suppressed. The rest of the line after \fB#n\fR is also ignored. A script file must contain at least one non-comment line. -T} -.TE - -.sp - -.sp -.TS -tab() box; -cw(.92i) |cw(4.58i) -lw(.92i) |lw(4.58i) -. -Max AddrCommand (Using \fIstrings\fR) and Description -_ -2\fBs\fR/\fIregular expression\fR/\fIreplacement\fR/\fIflags\fR -T{ -Substitute the \fIreplacement\fR string for instances of the \fIregular expression\fR in the pattern space. Any character other than backslash or newline can be used instead of a slash to delimit the RE and the replacement. Within the RE and the replacement, the RE delimiter itself can be used as a literal character if it is preceded by a backslash. -T} -T{ -An ampersand (\fB&\fR) appearing in the \fIreplacement\fR will be replaced by the string matching the RE. The special meaning of \fB&\fR in this context can be suppressed by preceding it by backslash. The characters \fB\e\fR\fIn\fR, where \fIn\fR is a digit, will be replaced by the text matched by the corresponding backreference expression. For each backslash (\e) encountered in scanning \fIreplacement\fR from beginning to end, the following character loses its special meaning (if any). It is unspecified what special meaning is given to any character other than &, \e or digits. -T} -T{ -A line can be split by substituting a \fBNEWLINE \fRcharacter into it. The application must escape the \fBNEWLINE \fRcharacter in the \fIreplacement\fR by preceding it with backslash. A substitution is considered to have been performed even if the replacement string is identical to the string that it replaces. -T} -\fIflags\fR is zero or more of: -T{ -\fIn\fR \fIn\fR= 1 - 512. Substitute for just the \fI n\fRth occurrence of the \fIregular expression.\fR -T} -T{ -\fBg\fR Global. Substitute for all nonoverlapping instances of the \fIregular expression\fR rather than just the first one. If both \fIg\fR and \fIn\fR are specified, the results are unspecified. -T} -_ -T{ -\fBp\fR Print the pattern space if a replacement was made. -T} -T{ -\fBP\fR Copy the initial segment of the pattern space through the first new-line to the standard output. -T} -T{ -\fBw\fR \fIwfile\fR Write. Append the pattern space to \fIwfile\fR if a replacement was made. The first occurrence of \fBw\fR will cause \fIwfile\fR to be cleared. Subsequent invocations of \fBw\fR will append. Each time the \fBsed\fR command is used, \fIwfile\fR is overwritten. -T} -_ -2\fBy\fR/ \fIstring1\fR / \fIstring2\fR / -T{ -Transform. Replace all occurrences of characters in \fI string1\fR with the corresponding characters in \fIstring2\fR. \fIstring1\fR and \fIstring2\fR must have the same number of characters, or if any of the characters in \fIstring1 \fR appear more than once, the results are undefined. Any character other than backslash or \fBNEWLINE\fR can be used instead of slash to delimit the strings. Within \fIstring1\fR and \fIstring2\fR, the delimiter itself can be used as a literal character if it is preceded by a backslash. For example, \fBy\fR/abc/ABC/ replaces a with A, b with B, and c with C. -T} -.TE - -.sp -.LP -See \fBlargefile\fR(5) for the description of the behavior of \fBsed\fR when -encountering files greater than or equal to 2 Gbyte ( 2^31 bytes). -.SH EXAMPLES -.LP -\fBExample 1 \fRAn example sed script -.sp -.LP -This \fBsed\fR script simulates the \fBBSD \fR\fBcat\fR \fB-s\fR command, -squeezing excess blank lines from standard input. - -.sp -.in +2 -.nf -sed \(min ' -# Write non-empty lines. -/./ { - p - d - } -# Write a single empty line, then look for more empty lines. -/^$/ p -# Get next line, discard the held <newline> (empty line), -# and look for more empty lines. -:Empty -/^$/ { - N - s/.// - b Empty - } -# Write the non-empty line before going back to search -# for the first in a set of empty lines. - p -\&' -.fi -.in -2 - -.SH ENVIRONMENT VARIABLES -.sp -.LP -See \fBenviron\fR(5) for descriptions of the following environment variables -that affect the execution of \fBsed\fR: \fBLANG\fR, \fBLC_ALL\fR, -\fBLC_COLLATE\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR. -.SH EXIT STATUS -.sp -.LP -The following exit values are returned: -.sp -.ne 2 -.mk -.na -\fB\fB0\fR \fR -.ad -.RS 7n -.rt -Successful completion. -.RE - -.sp -.ne 2 -.mk -.na -\fB\fB>0\fR \fR -.ad -.RS 7n -.rt -An error occurred. -.RE - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.SS "/usr/bin/sed" -.sp - -.sp -.TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE -_ -CSINot enabled -.TE - -.SS "/usr/xpg4/bin/sed" -.sp - -.sp -.TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE -_ -CSIEnabled -_ -Interface StabilityStandard -.TE +.br + +The +``{'' +can be preceded by white space and can be followed by white space. +The function can be preceded by white space. +The terminating +``}'' +must be preceded by a newline or optional white space. + +.TP +[2addr] function-list +Execute function-list only when the pattern space is selected. + +.TP +[1addr]a\e +.TP +text +Write +.IR text +to standard output immediately before each attempt to read a line of input, +whether by executing the +``N'' +function or by beginning a new cycle. + +.TP +[2addr]b[label] +Branch to the +``\&:'' +function with the specified label. +If the label is not specified, branch to the end of the script. + +.TP +[2addr]c\e +.TP +text +Delete the pattern space. +With 0 or 1 address or at the end of a 2-address range, +.IR text +is written to the standard output. + +.TP +[2addr]d +Delete the pattern space and start the next cycle. + +.TP +[2addr]D +Delete the initial segment of the pattern space through the first +newline character and start the next cycle. + +.TP +[2addr]g +Replace the contents of the pattern space with the contents of the +hold space. +.TP +[2addr]G +Append a newline character followed by the contents of the hold space +to the pattern space. + +.TP +[2addr]h +Replace the contents of the hold space with the contents of the +pattern space. + +.TP +[2addr]H +Append a newline character followed by the contents of the pattern space +to the hold space. + +.TP +[1addr]i\e +.TP +text +Write +.IR text +to the standard output. + +.TP +[2addr]l +(The letter ell.) +Write the pattern space to the standard output in a visually unambiguous +form. +This form is as follows: + +.TP +backslash +\e\e +.TP +alert +\ea +.TP +form-feed +\ef +.TP +carriage-return +\er +.TP +tab +\et +.TP +vertical tab +\ev + +Nonprintable characters are written as three-digit octal numbers (with a +preceding backslash) for each byte in the character (most significant byte +first). +Long lines are folded, with the point of folding indicated by displaying +a backslash followed by a newline. +The end of each line is marked with a +``$''. + +.TP +[2addr]n +Write the pattern space to the standard output if the default output has +not been suppressed, and replace the pattern space with the next line of +input. + +.TP +[2addr]N +Append the next line of input to the pattern space, using an embedded +newline character to separate the appended material from the original +contents. +Note that the current line number changes. + +.TP +[2addr]p +Write the pattern space to standard output. + +.TP +[2addr]P +Write the pattern space, up to the first newline character to the +standard output. + +.TP +[1addr]q +Branch to the end of the script and quit without starting a new cycle. + +.TP +[1addr]r file +Copy the contents of +.IR file +to the standard output immediately before the next attempt to read a +line of input. +If +.IR file +cannot be read for any reason, it is silently ignored and no error +condition is set. + +.TP +[2addr]s/regular expression/replacement/flags +Substitute the replacement string for the first instance of the regular +expression in the pattern space. +Any character other than backslash or newline can be used instead of +a slash to delimit the RE and the replacement. +Within the RE and the replacement, the RE delimiter itself can be used as +a literal character if it is preceded by a backslash. + +An ampersand +(``&'') +appearing in the replacement is replaced by the string matching the RE. +The special meaning of +``&'' +in this context can be suppressed by preceding it by a backslash. +The string +``\e#'', +where +``#'' +is a digit, is replaced by the text matched +by the corresponding backreference expression (see +\fBre_format\fP(7)) . + +A line can be split by substituting a newline character into it. +To specify a newline character in the replacement string, precede it with +a backslash. + +The value of +.IR flags +in the substitute function is zero or more of the following: +.TP +\fIN\fP +Make the substitution only for the +\fIN\fP'th +occurrence of the regular expression in the pattern space. +.TP +g +Make the substitution for all non-overlapping matches of the +regular expression, not just the first one. +.TP +p +Write the pattern space to standard output if a replacement was made. +If the replacement string is identical to that which it replaces, it +is still considered to have been a replacement. +.TP +w file +Append the pattern space to +.IR file +if a replacement was made. +If the replacement string is identical to that which it replaces, it +is still considered to have been a replacement. +.TP +I +Match the regular expression in a case-insensitive way. + +.TP +[2addr]t [label] +Branch to the +``\&:'' +function bearing the label if any substitutions have been made since the +most recent reading of an input line or execution of a +``t'' +function. +If no label is specified, branch to the end of the script. + +.TP +[2addr]w file +Append the pattern space to the +.IR file . + +.TP +[2addr]x +Swap the contents of the pattern and hold spaces. + +.TP +[2addr]y/string1/string2/ +Replace all occurrences of characters in +.IR string1 +in the pattern space with the corresponding characters from +.IR string2 . +Any character other than a backslash or newline can be used instead of +a slash to delimit the strings. +Within +.IR string1 +and +.IR string2 , +a backslash followed by any character other than a newline is that literal +character, and a backslash followed by an ``n'' is replaced by a newline +character. + +.TP +[2addr]!function +.TP +[2addr]!function-list +Apply the function or function-list only to the lines that are +.IR not +selected by the address(es). + +.TP +[0addr]:label +This function does nothing; it bears a label to which the +``b'' +and +``t'' +commands may branch. + +.TP +[1addr]= +Write the line number to the standard output followed by a newline +character. + +.TP +[0addr] +Empty lines are ignored. + +.TP +[0addr]# +The +``#'' +and the remainder of the line are ignored (treated as a comment), with +the single exception that if the first two characters in the file are +``#n'', +the default output is suppressed. +This is the same as specifying the +\fB\-n\fP +option on the command line. +.SH ENVIRONMENT +The +.IR COLUMNS , LANG , LC_ALL , LC_CTYPE +and +.IR LC_COLLATE +environment variables affect the execution of +\fBsed\fP +as described in +\fBenviron\fP(5). +.SH EXIT STATUS +The \fBsed\fP utility exits 0 on success, and >0 if an error occurs. .SH SEE ALSO -.sp -.LP -\fBawk\fR(1), \fBed\fR(1), \fBgrep\fR(1), \fBattributes\fR(5), -\fBenviron\fR(5), \fBlargefile\fR(5), \fBregexp\fR(5), \fBstandards\fR(5) +\fBawk\fP(1), +\fBed\fP(1), +\fBgrep\fP(1), +\fBregex\fP(3), +\fBre_format\fP(5) +.SH STANDARDS +The +\fBsed\fP +utility is expected to be a superset of the IEEE Std 1003.2 (``POSIX.2'') +specification. + +The +\fB\-E\fP, I , a +and +\fB\-i\fP +options, the prefixing +``\&+'' +in the second member of an address range, +as well as the +``I'' +flag to the address regular expression and substitution command are +non-standard extensions and may not be available on other operating systems. +.SH HISTORY +A +\fBsed\fP +command, written by L. E. McMahon, appeared in Version 7 AT&T UNIX. +.SH AUTHORS + +"Diomidis D. Spinellis" <dds@FreeBSD.org> +.SH BUGS +Multibyte characters containing a byte with value 0x5C (ASCII `\e') +may be incorrectly treated as line continuation characters in arguments to the +``a'', +``c'' +and +``i'' +commands. +Multibyte characters cannot be used as delimiters with the +``s'' +and +``y'' +commands. |