View source for Sed/manpage

'''sed''' - manual page for [[sed]](1) version 4.1.3 (January 2005)

== Synopsis ==

 sed [OPTION]... {script-only-if-no-other-script} [input-file]...

== Description ==

Sed is a stream editor. A stream editor is used to perform basic text transformations on an input stream (a file or input from a pipeline). While in some ways similar to an editor which permits scripted edits (such as ed), sed works by making only one pass over the input(s), and is consequently more efficient. But it is sed's ability to filter text in a pipeline which particularly distinguishes it from other types of editors.

* suppress automatic printing of pattern space:
 -n, --quiet, --silent

* add the script to the commands to be executed:
 -e script, --expression=script

* add the contents of script-file to the commands to be executed:
 -f script-file, --file=script-file

* edit files in place (makes backup if extension supplied):
 -i[SUFFIX], --in-place[=SUFFIX]

* specify the desired line-wrap length for the '<tt>l</tt>' command
 -l N, --line-length=N

* disable all GNU extensions:
 --posix

* use extended regular expressions in the script:
 -r, --regexp-extended

* consider files as separate rather than as a single continuous long stream:
 -s, --separate

* load minimal amounts of data from the input files and flush the output buffers more often:
 -u, --unbuffered

* display this help and exit:
 --help

* output version information and exit:
 --version

If no <tt>-e</tt>, <tt>--expression</tt>, <tt>-f</tt>, or <tt>--file</tt> option is given, then the first 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.

== Command synopsis ==

This is just a brief synopsis of sed commands to serve as a reminder to those who already know sed; other documentation (such as the texinfo document) must be consulted for fuller descriptions.

=== Zero-address "commands" ===

* Label for <tt>b</tt> and <tt>t</tt> commands:
 : label

* The comment extends until the next newline (or the end of a <tt>-e</tt> script fragment):
 #comment

* The closing bracket of a <tt>{ }</tt> block:
 }

=== Zero- or one-address commands ===

* Print the current line number:
 =

* Append text, which has each embedded newline preceded by a backslash:
 a \
 text

* Insert text, which has each embedded newline preceded by a backslash:
 i \
 text

* Immediately quit the sed script without processing any more input, except that if auto-print is not disabled the current pattern space will be printed:
 q

* Immediately quit the sed script without processing any more input:
 Q

* Append text read from filename:
 r filename

* Append a line read from filename:
 R filename

=== Commands which accept address ranges ===

* Begin a block of commands (end with a <tt>}</tt>):
 {

* Branch to label; if label is omitted, branch to end of script:
 b label

* If a <tt>s///</tt> has done a successful substitution since the last input line was read and since the last <tt>t</tt> or <tt>T</tt> command, then branch to label; if label is omitted, branch to end of script:
 t label

* If no <tt>s///</tt> has done a successful substitution since the last input line was read and since the last <tt>t</tt> or <tt>T</tt> command, then branch to label; if label is omitted, branch to end of script:
 T label

* Replace the selected lines with text, which has each embedded newline preceded by a backslash:
 c \
 text

* Delete pattern space. Start next cycle:
 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:
 D

* Copy/append pattern space to hold space:
 h H

* Copy/append hold space to pattern space:
 g G

* Exchange the contents of the hold and pattern spaces:
 x

* List out the current line in a "visually unambiguous" form:
 l

* Read/append the next line of input into the pattern space:
 n N

* Print the current pattern space:
 p

* Print up to the first embedded newline of the current pattern space:
 P

* Attempt to match regexp against the pattern space. If successful, replace that portion matched with replacement. The replacement may contain the special character <tt>&</tt> to refer to that portion of the pattern space which  matched, and the special escapes <tt>\1</tt> through <tt>\9</tt> to refer to the corresponding matching sub-expressions in the regexp:
 s/regexp/replacement/

* Write the current pattern space to filename:
 w filename

* Write the first line of the current pattern space to filename:
 W filename

* Transliterate the characters in the pattern space which appear in <tt>source</tt> to the corresponding character in <tt>dest</tt>:
 y/source/dest/

=== Addresses ===

Sed commands can be given with no addresses, in which case the command will be executed for all input lines; with one address, in which case the command will only be executed for input lines which match that address; or with two addresses, in which case the command will be executed for all input lines which match the inclusive range of lines starting from the first address and continuing to the second address. Three things to note about address ranges: the syntax is <tt>addr1,addr2</tt> (i.e., the addresses are separated by a comma); the line which <tt>addr1</tt> matched will always be accepted, even if <tt>addr2</tt> selects an earlier line; and if <tt>addr2</tt> is a regexp, it will not be tested against the line that <tt>addr1</tt> matched.

After the address (or address-range), and before the command, a <tt>!</tt> may be inserted, which specifies that the command shall only be executed if the address (or address-range) does not match.

==== The following address types are supported ====

* Match only the specified line number:
 number

* Match every <tt>step</tt>'th line starting with line first. For example, "<tt>sed -n 1~2p</tt>" will print all the  odd-numbered lines in the input stream, and the address <tt>2~5</tt> will match every fifth line, starting with the second. (This is an extension.):
 first~step

* Match the last line:
 $

* Match lines matching the regular expression <tt>regexp</tt>:
 /regexp/

* Match lines matching the regular expression regexp. The '''<tt>c</tt>''' may be any character:
 \'''c'''regexp'''c'''

==== GNU sed also supports some special 2-address forms ====

* Start out in "matched first address" state, until <tt>addr2</tt> is found. This is similar to <tt>1,addr2</tt>, except that if <tt>addr2</tt> matches the very first line of input the <tt>0,addr2</tt> form will be at the end of its range, whereas the <tt>1,addr2</tt> form will still be at the beginning of its range:
 0,addr2

* Will match <tt>addr1</tt> and the <tt>N</tt> lines following <tt>addr1</tt>:
 addr1,+N

* Will match <tt>addr1</tt> and the lines following <tt>addr1</tt> until the next line whose input line number is a multiple of <tt>N</tt>:
 addr1,~N

== [[Regular expression]]s ==

POSIX.2 BREs should be supported, but they aren't completely because of performance problems. The <tt>\n</tt> sequence in a regular expression matches the newline character, and similarly for <tt>\a</tt>, <tt>\t</tt>, and other sequences.

== Copyright ==
Copyright © 2003 Free Software Foundation, Inc.

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.

== See also ==

* [[awk]]
* [[ed]]
* [[grep]]
* [[tr]]
* [[perlre]]
* sed.info
* any of various books on sed, the sed FAQ (http://sed.sf.net/grabbag/tutorials/sedfaq.html), http://sed.sf.net/grabbag/.

Note: The full documentation for sed is maintained as a Texinfo manual. If the info and sed programs are properly installed at your site, the command
 info sed
should give you access to the complete manual.

[[Category:Linux Command Line Tools]]
[[Category:Scripting languages]]