summaryrefslogtreecommitdiff
path: root/usr/src/man/man1/sed.1
blob: 3eca2b5418a25fa0f48d68f86e2b57fb762df7fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
.\" Copyright (c) 1992, 1993
.\"     The Regents of the University of California.  All rights reserved.
.\"
.\" Copyright 2011 Nexenta Systems, Inc. All rights reserved.
.\" Copyright 2020 OmniOS Community Edition (OmniOSce) Association.
.\"
.\" 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 "Aug 21, 2020"
.SH NAME
\fBsed\fP
\- stream editor
.SH SYNOPSIS
\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
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
\fBsed\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
\fBregex\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.
.PP
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.

If an input file is growing while sed is running, the
``$''
address match may be unreliable.
.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.

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.
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
\fBregex\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
  function
  ...
  function
.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
\fBregex\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(7).
.SH EXIT STATUS
The \fBsed\fP utility exits 0 on success, and >0 if an error occurs.
.SH SEE ALSO
\fBawk\fP(1),
\fBed\fP(1),
\fBgrep\fP(1),
\fBregex\fP(7)
.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.