freebsd-dev/bin/ed/ed.1

1006 lines
22 KiB
Groff
Raw Normal View History

1999-08-27 23:15:48 +00:00
.\" $FreeBSD$
.Dd July 3, 2004
1998-05-13 07:41:13 +00:00
.Dt ED 1
.Os
.Sh NAME
2000-01-10 12:20:30 +00:00
.Nm ed ,
.Nm red
1998-05-13 07:41:13 +00:00
.Nd text editor
.Sh SYNOPSIS
.Nm
1998-05-13 07:41:13 +00:00
.Op Fl
.Op Fl sx
.Op Fl p Ar string
.Op Ar file
.Nm red
.Op Fl
.Op Fl sx
.Op Fl p Ar string
.Op Ar file
1998-05-13 07:41:13 +00:00
.Sh DESCRIPTION
2002-04-16 20:08:06 +00:00
The
.Nm
utility is a line-oriented text editor.
It is used to create, display, modify and otherwise manipulate text
files.
When invoked as
.Nm red ,
the editor runs in
.Qq restricted
mode, in which the only difference is that the editor restricts the
use of filenames which start with
.Ql \&!
(interpreted as shell commands by
2002-07-04 13:22:22 +00:00
.Nm )
or contain a
.Ql \&/ .
Note that editing outside of the current directory is only prohibited
if the user does not have write access to the current directory.
If a user has write access to the current directory, then symbolic
links can be created in the current directory, in which case
.Nm red
will not stop the user from editing the file that the symbolic link
points to.
2000-12-15 17:37:31 +00:00
.Pp
If invoked with a
1998-05-13 07:41:13 +00:00
.Ar file
argument, then a copy of
1998-05-13 07:41:13 +00:00
.Ar file
is read into the editor's buffer.
Changes are made to this copy and not directly to
1998-05-13 07:41:13 +00:00
.Ar file
itself.
Upon quitting
.Nm ,
2002-07-04 13:22:22 +00:00
any changes not explicitly saved with a
1998-05-13 07:41:13 +00:00
.Em w
command are lost.
2000-12-15 17:37:31 +00:00
.Pp
Editing is done in two distinct modes:
1998-05-13 07:41:13 +00:00
.Em command
and
1998-05-13 07:41:13 +00:00
.Em input .
When first invoked,
1998-05-13 07:41:13 +00:00
.Nm
is in command mode.
In this mode commands are read from the standard input and
executed to manipulate the contents of the editor buffer.
A typical command might look like:
1998-05-13 07:41:13 +00:00
.Pp
.Sm off
.Cm ,s No / Em old Xo
.No / Em new
.No / Cm g
.Xc
.Sm on
.Pp
which replaces all occurrences of the string
1998-05-13 07:41:13 +00:00
.Em old
with
1998-05-13 07:41:13 +00:00
.Em new .
.Pp
When an input command, such as
1998-05-13 07:41:13 +00:00
.Em a
(append),
1998-05-13 07:41:13 +00:00
.Em i
(insert) or
1998-05-13 07:41:13 +00:00
.Em c
(change), is given,
1998-05-13 07:41:13 +00:00
.Nm
2002-07-04 13:22:22 +00:00
enters input mode.
This is the primary means
of adding text to a file.
In this mode, no commands are available;
instead, the standard input is written
2002-07-04 13:22:22 +00:00
directly to the editor buffer.
Lines consist of text up to and
including a
1998-05-13 07:41:13 +00:00
.Em newline
character.
Input mode is terminated by
1998-05-13 07:41:13 +00:00
entering a single period
2000-12-15 17:37:31 +00:00
.Pq Em .\&
1998-05-13 07:41:13 +00:00
on a line.
.Pp
All
1998-05-13 07:41:13 +00:00
.Nm
commands operate on whole lines or ranges of lines; e.g.,
the
1998-05-13 07:41:13 +00:00
.Em d
command deletes lines; the
1998-05-13 07:41:13 +00:00
.Em m
command moves lines, and so on.
It is possible to modify only a portion of a line by means of replacement,
2002-07-04 13:22:22 +00:00
as in the example above.
However even here, the
1998-05-13 07:41:13 +00:00
.Em s
command is applied to whole lines at a time.
1998-05-13 07:41:13 +00:00
.Pp
In general,
1998-05-13 07:41:13 +00:00
.Nm
commands consist of zero or more line addresses, followed by a single
character command and possibly additional parameters; i.e.,
commands have the structure:
1998-05-13 07:41:13 +00:00
.Pp
.Sm off
.Xo
.Op Ar address Op , Ar address
.Ar command Op Ar parameters
1998-05-13 07:41:13 +00:00
.Xc
.Sm on
.Pp
The address(es) indicate the line or range of lines to be affected by the
2002-07-04 13:22:22 +00:00
command.
If fewer addresses are given than the command accepts, then
default addresses are supplied.
1998-05-13 07:41:13 +00:00
.Sh OPTIONS
The following options are available:
.Bl -tag -width indent
.It Fl s
Suppress diagnostics.
This should be used if
1998-05-13 07:41:13 +00:00
.Nm Ns 's
standard input is from a script.
1998-05-13 07:41:13 +00:00
.It Fl x
Prompt for an encryption key to be used in subsequent reads and writes
(see the
1998-05-13 07:41:13 +00:00
.Em x
command).
1998-05-13 07:41:13 +00:00
.It Fl p Ar string
2002-07-04 13:22:22 +00:00
Specify a command prompt.
This may be toggled on and off with the
1998-05-13 07:41:13 +00:00
.Em P
command.
1998-05-13 07:41:13 +00:00
.It Ar file
2002-07-04 13:22:22 +00:00
Specify the name of a file to read.
If
1998-05-13 07:41:13 +00:00
.Ar file
is prefixed with a
2002-07-04 13:22:22 +00:00
bang (!), then it is interpreted as a shell command.
In this case,
what is read is
the standard output of
1998-05-13 07:41:13 +00:00
.Ar file
executed via
1998-05-13 07:41:13 +00:00
.Xr sh 1 .
To read a file whose name begins with a bang, prefix the
name with a backslash (\\).
The default filename is set to
1998-05-13 07:41:13 +00:00
.Ar file
only if it is not prefixed with a bang.
1998-05-13 07:41:13 +00:00
.El
.Sh LINE ADDRESSING
An address represents the number of a line in the buffer.
2002-04-16 20:08:06 +00:00
The
.Nm
utility maintains a
1998-05-13 07:41:13 +00:00
.Em current address
which is
typically supplied to commands as the default address when none is specified.
2002-07-04 13:22:22 +00:00
When a file is first read, the current address is set to the last line
of the file.
In general, the current address is set to the last line
affected by a command.
1998-05-13 07:41:13 +00:00
.Pp
A line address is
constructed from one of the bases in the list below, optionally followed
2002-07-04 13:22:22 +00:00
by a numeric offset.
The offset may include any combination
of digits, operators (i.e.,
1998-05-13 07:41:13 +00:00
.Em + ,
.Em -
and
1998-05-13 07:41:13 +00:00
.Em ^ )
and whitespace.
Addresses are read from left to right, and their values are computed
relative to the current address.
1998-05-13 07:41:13 +00:00
.Pp
One exception to the rule that addresses represent line numbers is the
address
1998-05-13 07:41:13 +00:00
.Em 0
(zero).
This means "before the first line,"
and is legal wherever it makes sense.
1998-05-13 07:41:13 +00:00
.Pp
An address range is two addresses separated either by a comma or
semi-colon.
The value of the first address in a range cannot exceed the
2002-07-04 13:22:22 +00:00
value of the second.
If only one address is given in a range, then
the second address is set to the given address.
If an
1998-05-13 07:41:13 +00:00
.Em n Ns -tuple
of addresses is given where
1998-05-13 07:41:13 +00:00
.Em "n\ >\ 2" ,
then the corresponding range is determined by the last two addresses in
the
.Em n Ns -tuple .
If only one address is expected, then the last address is used.
1998-05-13 07:41:13 +00:00
.Pp
Each address in a comma-delimited range is interpreted relative to the
2002-07-04 13:22:22 +00:00
current address.
In a semi-colon-delimited range, the first address is
used to set the current address, and the second address is interpreted
relative to the first.
1998-05-13 07:41:13 +00:00
.Pp
The following address symbols are recognized:
.Bl -tag -width indent
.It .
The current line (address) in the buffer.
1998-05-13 07:41:13 +00:00
.It $
The last line in the buffer.
1998-05-13 07:41:13 +00:00
.It n
The
.Em n Ns th
line in the buffer
where
1998-05-13 07:41:13 +00:00
.Em n
is a number in the range
1998-05-13 07:41:13 +00:00
.Em [0,$] .
.It - or ^
The previous line.
This is equivalent to
1998-05-13 07:41:13 +00:00
.Em -1
and may be repeated with cumulative effect.
1998-05-13 07:41:13 +00:00
.It -n or ^n
The
1998-05-13 07:41:13 +00:00
.Em n Ns th
previous line, where
1998-05-13 07:41:13 +00:00
.Em n
is a non-negative number.
1998-05-13 07:41:13 +00:00
.It +
The next line.
This is equivalent to
1998-05-13 07:41:13 +00:00
.Em +1
and may be repeated with cumulative effect.
2001-07-15 07:53:42 +00:00
.It +n
The
1998-05-13 07:41:13 +00:00
.Em n Ns th
next line, where
1998-05-13 07:41:13 +00:00
.Em n
is a non-negative number.
1998-05-13 07:41:13 +00:00
.It , or %
2002-07-04 13:22:22 +00:00
The first through last lines in the buffer.
This is equivalent to
the address range
1998-05-13 07:41:13 +00:00
.Em 1,$ .
.It ;
2002-07-04 13:22:22 +00:00
The current through last lines in the buffer.
This is equivalent to
the address range
1998-05-13 07:41:13 +00:00
.Em .,$ .
.It /re/
The next line containing the regular expression
.Em re .
The search wraps to the beginning of the buffer and continues down to the
current line, if necessary.
// repeats the last search.
1998-05-13 07:41:13 +00:00
.It ?re?
The
previous line containing the regular expression
1998-05-13 07:41:13 +00:00
.Em re .
The search wraps to the end of the buffer and continues up to the
current line, if necessary.
?? repeats the last search.
1998-05-13 07:41:13 +00:00
.It 'lc
The
line previously marked by a
1998-05-13 07:41:13 +00:00
.Em k
(mark) command, where
1998-05-13 07:41:13 +00:00
.Em lc
is a lower case letter.
1998-05-13 07:41:13 +00:00
.El
.Sh REGULAR EXPRESSIONS
Regular expressions are patterns used in selecting text.
1998-05-13 07:41:13 +00:00
For example, the command:
.Pp
.Sm off
.Cm g No / Em string Xo
.No /
.Xc
.Sm on
.Pp
prints all lines containing
1998-05-13 07:41:13 +00:00
.Em string .
Regular expressions are also
used by the
1998-05-13 07:41:13 +00:00
.Em s
command for selecting old text to be replaced with new.
1998-05-13 07:41:13 +00:00
.Pp
In addition to a specifying string literals, regular expressions can
represent
2002-07-04 13:22:22 +00:00
classes of strings.
Strings thus represented are said to be matched
by the corresponding regular expression.
If it is possible for a regular expression
to match several strings in a line, then the left-most longest match is
the one selected.
1998-05-13 07:41:13 +00:00
.Pp
The following symbols are used in constructing regular expressions:
1998-05-13 07:41:13 +00:00
.Bl -tag -width indent
.It c
Any character
1998-05-13 07:41:13 +00:00
.Em c
2002-07-04 13:22:22 +00:00
not listed below, including
.Ql \&{ ,
.Ql \&} ,
.Ql \&( ,
.Ql \&) ,
.Ql <
and
.Ql > ,
matches itself.
1998-05-13 07:41:13 +00:00
.It Pf \e c
Any backslash-escaped character
1998-05-13 07:41:13 +00:00
.Em c ,
2002-07-04 13:22:22 +00:00
except for
.Ql \&{ ,
.Ql \&} ,
.Ql \&( ,
.Ql \&) ,
.Ql <
and
.Ql > ,
matches itself.
1998-05-13 07:41:13 +00:00
.It .
Match any single character.
.It Op char-class
Match any single character in
.Em char-class .
2002-07-04 13:22:22 +00:00
To include a
.Ql \&]
in
1998-05-13 07:41:13 +00:00
.Em char-class ,
it must be the first character.
A range of characters may be specified by separating the end characters
2002-07-04 13:22:22 +00:00
of the range with a
.Ql - ,
e.g.,
.Ql a-z
specifies the lower case characters.
The following literal expressions can also be used in
1998-05-13 07:41:13 +00:00
.Em char-class
to specify sets of characters:
1998-05-13 07:41:13 +00:00
.Pp
.Bl -column "[:alnum:]" "[:cntrl:]" "[:lower:]" "[:xdigit:]" -compact
.It [:alnum:] Ta [:cntrl:] Ta [:lower:] Ta [:space:]
.It [:alpha:] Ta [:digit:] Ta [:print:] Ta [:upper:]
.It [:blank:] Ta [:graph:] Ta [:punct:] Ta [:xdigit:]
.El
1998-05-13 07:41:13 +00:00
.Pp
2002-07-04 13:22:22 +00:00
If
.Ql -
appears as the first or last
character of
1998-05-13 07:41:13 +00:00
.Em char-class ,
then it matches itself.
All other characters in
1998-05-13 07:41:13 +00:00
.Em char-class
match themselves.
1998-05-13 07:41:13 +00:00
.Pp
Patterns in
.Em char-class
of the form:
1998-05-13 07:41:13 +00:00
.Pp
.Bl -item -compact -offset 2n
.It
2000-12-18 14:48:17 +00:00
.Op \&. Ns Ar col-elm Ns .\&
or,
.It
.Op = Ns Ar col-elm Ns =
.El
1998-05-13 07:41:13 +00:00
.Pp
where
.Ar col-elm
is a
1998-05-13 07:41:13 +00:00
.Em collating element
are interpreted according to the current locale settings
(not currently supported).
See
1998-05-13 07:41:13 +00:00
.Xr regex 3
and
.Xr re_format 7
for an explanation of these constructs.
1998-05-13 07:41:13 +00:00
.It Op ^char-class
Match any single character, other than newline, not in
.Em char-class .
.Em Char-class
is defined
as above.
1998-05-13 07:41:13 +00:00
.It ^
If
.Em ^
is the first character of a regular expression, then it
anchors the regular expression to the beginning of a line.
Otherwise, it matches itself.
1998-05-13 07:41:13 +00:00
.It $
If
.Em $
is the last character of a regular expression, it
anchors the regular expression to the end of a line.
Otherwise, it matches itself.
1998-05-13 07:41:13 +00:00
.It Pf \e <
Anchor the single character regular expression or subexpression
immediately following it to the beginning of a word.
(This may not be available)
1998-05-13 07:41:13 +00:00
.It Pf \e >
Anchor the single character regular expression or subexpression
immediately following it to the end of a word.
(This may not be available)
1998-05-13 07:41:13 +00:00
.It Pf \e (re\e)
Define a subexpression
.Em re .
Subexpressions may be nested.
1998-05-13 07:41:13 +00:00
A subsequent backreference of the form
.Pf \e Em n ,
1998-05-13 07:41:13 +00:00
where
.Em n
is a number in the range [1,9], expands to the text matched by the
1998-05-13 07:41:13 +00:00
.Em n Ns th
subexpression.
2002-07-04 13:22:22 +00:00
For example, the regular expression
.Ql \e(.*\e)\e1
matches any string
consisting of identical adjacent substrings.
Subexpressions are ordered relative to
their left delimiter.
1998-05-13 07:41:13 +00:00
.It *
Match the single character regular expression or subexpression
2002-07-04 13:22:22 +00:00
immediately preceding it zero or more times.
If
1998-05-13 07:41:13 +00:00
.Em *
is the first
character of a regular expression or subexpression, then it matches
2002-07-04 13:22:22 +00:00
itself.
The
1998-05-13 07:41:13 +00:00
.Em *
operator sometimes yields unexpected results.
2002-07-04 13:22:22 +00:00
For example, the regular expression
.Ql b*
matches the beginning of
the string
.Ql abbb
(as opposed to the substring
.Ql bbb ) ,
since a null match
is the only left-most match.
1998-05-13 07:41:13 +00:00
.It \e{n,m\e} or \e{n,\e} or \e{n\e}
Match the single character regular expression or subexpression
immediately preceding it at least
1998-05-13 07:41:13 +00:00
.Em n
and at most
1998-05-13 07:41:13 +00:00
.Em m
times.
If
1998-05-13 07:41:13 +00:00
.Em m
is omitted, then it matches at least
1998-05-13 07:41:13 +00:00
.Em n
times.
If the comma is also omitted, then it matches exactly
1998-05-13 07:41:13 +00:00
.Em n
times.
1998-05-13 07:41:13 +00:00
.El
.Pp
Additional regular expression operators may be defined depending on the
particular
1998-05-13 07:41:13 +00:00
.Xr regex 3
implementation.
1998-05-13 07:41:13 +00:00
.Sh COMMANDS
All
1998-05-13 07:41:13 +00:00
.Nm
commands are single characters, though some require additional parameters.
If a command's parameters extend over several lines, then
each line except for the last
must be terminated with a backslash (\\).
2000-12-15 17:37:31 +00:00
.Pp
In general, at most one command is allowed per line.
However, most commands accept a print suffix, which is any of
1998-05-13 07:41:13 +00:00
.Em p
(print),
1998-05-13 07:41:13 +00:00
.Em l
(list),
or
1998-05-13 07:41:13 +00:00
.Em n
(enumerate),
to print the last line affected by the command.
2000-12-15 17:37:31 +00:00
.Pp
An interrupt (typically ^C) has the effect of aborting the current command
and returning the editor to command mode.
2000-12-15 17:37:31 +00:00
.Pp
2002-04-16 20:08:06 +00:00
The
.Nm
utility
2002-07-04 13:22:22 +00:00
recognizes the following commands.
The commands are shown together with
the default address or address range supplied if none is
specified (in parenthesis).
1998-05-13 07:41:13 +00:00
.Bl -tag -width indent
.It (.)a
Append text to the buffer after the addressed line.
Text is entered in input mode.
The current address is set to last line entered.
1998-05-13 07:41:13 +00:00
.It (.,.)c
2002-07-04 13:22:22 +00:00
Change lines in the buffer.
The addressed lines are deleted
from the buffer, and text is appended in their place.
Text is entered in input mode.
The current address is set to last line entered.
1998-05-13 07:41:13 +00:00
.It (.,.)d
Delete the addressed lines from the buffer.
If there is a line after the deleted range, then the current address is set
to this line.
Otherwise the current address is set to the line
before the deleted range.
1998-05-13 07:41:13 +00:00
.It e Ar file
Edit
.Ar file ,
and sets the default filename.
If
1998-05-13 07:41:13 +00:00
.Ar file
2002-07-04 13:22:22 +00:00
is not specified, then the default filename is used.
Any lines in the buffer are deleted before
the new file is read.
The current address is set to the last line read.
1998-05-13 07:41:13 +00:00
.It e Ar !command
Edit the standard output of
.Ar !command ,
(see
1998-05-13 07:41:13 +00:00
.Ar !command
below).
The default filename is unchanged.
Any lines in the buffer are deleted before the output of
1998-05-13 07:41:13 +00:00
.Ar command
is read.
The current address is set to the last line read.
1998-05-13 07:41:13 +00:00
.It E Ar file
Edit
.Ar file
unconditionally.
This is similar to the
1998-05-13 07:41:13 +00:00
.Em e
command,
except that unwritten changes are discarded without warning.
The current address is set to the last line read.
1998-05-13 07:41:13 +00:00
.It f Ar file
Set the default filename to
.Ar file .
If
1998-05-13 07:41:13 +00:00
.Ar file
is not specified, then the default unescaped filename is printed.
1998-05-13 07:41:13 +00:00
.It (1,$)g/re/command-list
Apply
.Ar command-list
to each of the addressed lines matching a regular expression
1998-05-13 07:41:13 +00:00
.Ar re .
The current address is set to the
line currently matched before
1998-05-13 07:41:13 +00:00
.Ar command-list
is executed.
At the end of the
1998-05-13 07:41:13 +00:00
.Em g
command, the current address is set to the last line affected by
1998-05-13 07:41:13 +00:00
.Ar command-list .
.Pp
Each command in
1998-05-13 07:41:13 +00:00
.Ar command-list
must be on a separate line,
and every line except for the last must be terminated by a backslash
(\\).
Any commands are allowed, except for
1998-05-13 07:41:13 +00:00
.Em g ,
.Em G ,
.Em v ,
and
1998-05-13 07:41:13 +00:00
.Em V .
A newline alone in
1998-05-13 07:41:13 +00:00
.Ar command-list
2001-07-15 07:53:42 +00:00
is equivalent to a
1998-05-13 07:41:13 +00:00
.Em p
command.
1998-05-13 07:41:13 +00:00
.It (1,$)G/re/
Interactively edit the addressed lines matching a regular expression
.Ar re .
For each matching line,
the line is printed,
the current address is set,
2001-07-15 07:53:42 +00:00
and the user is prompted to enter a
1998-05-13 07:41:13 +00:00
.Ar command-list .
At the end of the
1998-05-13 07:41:13 +00:00
.Em G
command, the current address
is set to the last line affected by (the last)
1998-05-13 07:41:13 +00:00
.Ar command-list .
.Pp
The format of
1998-05-13 07:41:13 +00:00
.Ar command-list
is the same as that of the
1998-05-13 07:41:13 +00:00
.Em g
2002-07-04 13:22:22 +00:00
command.
A newline alone acts as a null command list.
A single
.Ql &
repeats the last non-null command list.
1998-05-13 07:41:13 +00:00
.It H
Toggle the printing of error explanations.
By default, explanations are not printed.
It is recommended that ed scripts begin with this command to
aid in debugging.
1998-05-13 07:41:13 +00:00
.It h
Print an explanation of the last error.
.It (.)i
Insert text in the buffer before the current line.
Text is entered in input mode.
The current address is set to the last line entered.
1998-05-13 07:41:13 +00:00
.It (.,.+1)j
2002-07-04 13:22:22 +00:00
Join the addressed lines.
The addressed lines are
deleted from the buffer and replaced by a single
line containing their joined text.
The current address is set to the resultant line.
1998-05-13 07:41:13 +00:00
.It (.)klc
Mark a line with a lower case letter
.Em lc .
2002-07-04 13:22:22 +00:00
The line can then be addressed as
1998-05-13 07:41:13 +00:00
.Em 'lc
(i.e., a single quote followed by
.Em lc )
2002-07-04 13:22:22 +00:00
in subsequent commands.
The mark is not cleared until the line is
deleted or otherwise modified.
1998-05-13 07:41:13 +00:00
.It (.,.)l
Print the addressed lines unambiguously.
If a single line fills more than one screen (as might be the case
2002-07-04 13:22:22 +00:00
when viewing a binary file, for instance), a
.Dq Li --More--
2001-07-15 07:53:42 +00:00
prompt is printed on the last line.
2002-04-16 20:08:06 +00:00
The
.Nm
utility waits until the RETURN key is pressed
2001-07-15 07:53:42 +00:00
before displaying the next screen.
The current address is set to the last line
printed.
1998-05-13 07:41:13 +00:00
.It (.,.)m(.)
2002-07-04 13:22:22 +00:00
Move lines in the buffer.
The addressed lines are moved to after the
right-hand destination address, which may be the address
1998-05-13 07:41:13 +00:00
.Em 0
(zero).
The current address is set to the
last line moved.
1998-05-13 07:41:13 +00:00
.It (.,.)n
Print the addressed lines along with
2002-07-04 13:22:22 +00:00
their line numbers.
The current address is set to the last line
printed.
1998-05-13 07:41:13 +00:00
.It (.,.)p
Print the addressed lines.
The current address is set to the last line
printed.
1998-05-13 07:41:13 +00:00
.It P
Toggle the command prompt on and off.
Unless a prompt was specified by with command-line option
1998-05-13 07:41:13 +00:00
.Fl p Ar string ,
the command prompt is by default turned off.
.It q
Quit
.Nm .
1998-05-13 07:41:13 +00:00
.It Q
Quit
.Nm
unconditionally.
This is similar to the
1998-05-13 07:41:13 +00:00
.Em q
command,
except that unwritten changes are discarded without warning.
1998-05-13 07:41:13 +00:00
.It ($)r Ar file
Read
.Ar file
2002-07-04 13:22:22 +00:00
to after the addressed line.
If
1998-05-13 07:41:13 +00:00
.Ar file
is not specified, then the default
2002-07-04 13:22:22 +00:00
filename is used.
If there was no default filename prior to the command,
then the default filename is set to
1998-05-13 07:41:13 +00:00
.Ar file .
Otherwise, the default filename is unchanged.
The current address is set to the last line read.
1998-05-13 07:41:13 +00:00
.It ($)r Ar !command
Read
to after the addressed line
the standard output of
1998-05-13 07:41:13 +00:00
.Ar !command ,
(see the
1998-05-13 07:41:13 +00:00
.Ar !command
below).
The default filename is unchanged.
The current address is set to the last line read.
1998-05-13 07:41:13 +00:00
.It (.,.)s/re/replacement/
.It (.,.)s/re/replacement/g
.It (.,.)s/re/replacement/n
Replace text in the addressed lines
matching a regular expression
1998-05-13 07:41:13 +00:00
.Ar re
with
1998-05-13 07:41:13 +00:00
.Ar replacement .
By default, only the first match in each line is replaced.
If the
1998-05-13 07:41:13 +00:00
.Em g
(global) suffix is given, then every match to be replaced.
The
1998-05-13 07:41:13 +00:00
.Em n
suffix, where
1998-05-13 07:41:13 +00:00
.Em n
is a positive number, causes only the
1998-05-13 07:41:13 +00:00
.Em n Ns th
match to be replaced.
It is an error if no substitutions are performed on any of the addressed
lines.
The current address is set the last line affected.
1998-05-13 07:41:13 +00:00
.Pp
.Ar Re
and
1998-05-13 07:41:13 +00:00
.Ar replacement
may be delimited by any character other than space and newline
(see the
1998-05-13 07:41:13 +00:00
.Em s
command below).
If one or two of the last delimiters is omitted, then the last line
affected is printed as though the print suffix
1998-05-13 07:41:13 +00:00
.Em p
were specified.
1998-05-13 07:41:13 +00:00
.Pp
2002-07-04 13:22:22 +00:00
An unescaped
.Ql &
in
1998-05-13 07:41:13 +00:00
.Ar replacement
is replaced by the currently matched text.
The character sequence
1998-05-13 07:41:13 +00:00
.Em \em ,
where
1998-05-13 07:41:13 +00:00
.Em m
is a number in the range [1,9], is replaced by the
1998-05-13 07:41:13 +00:00
.Em m th
backreference expression of the matched text.
If
1998-05-13 07:41:13 +00:00
.Ar replacement
2002-07-04 13:22:22 +00:00
consists of a single
.Ql % ,
then
1998-05-13 07:41:13 +00:00
.Ar replacement
from the last substitution is used.
Newlines may be embedded in
1998-05-13 07:41:13 +00:00
.Ar replacement
if they are escaped with a backslash (\\).
1998-05-13 07:41:13 +00:00
.It (.,.)s
Repeat the last substitution.
This form of the
1998-05-13 07:41:13 +00:00
.Em s
command accepts a count suffix
1998-05-13 07:41:13 +00:00
.Em n ,
or any combination of the characters
1998-05-13 07:41:13 +00:00
.Em r ,
.Em g ,
and
1998-05-13 07:41:13 +00:00
.Em p .
If a count suffix
1998-05-13 07:41:13 +00:00
.Em n
is given, then only the
1998-05-13 07:41:13 +00:00
.Em n Ns th
match is replaced.
The
1998-05-13 07:41:13 +00:00
.Em r
suffix causes
the regular expression of the last search to be used instead of the
that of the last substitution.
The
1998-05-13 07:41:13 +00:00
.Em g
suffix toggles the global suffix of the last substitution.
The
1998-05-13 07:41:13 +00:00
.Em p
suffix toggles the print suffix of the last substitution
The current address is set to the last line affected.
1998-05-13 07:41:13 +00:00
.It (.,.)t(.)
Copy (i.e., transfer) the addressed lines to after the right-hand
destination address, which may be the address
1998-05-13 07:41:13 +00:00
.Em 0
(zero).
The current address is set to the last line
copied.
1998-05-13 07:41:13 +00:00
.It u
Undo the last command and restores the current address
to what it was before the command.
The global commands
1998-05-13 07:41:13 +00:00
.Em g ,
.Em G ,
.Em v ,
and
1998-05-13 07:41:13 +00:00
.Em V .
are treated as a single command by undo.
1998-05-13 07:41:13 +00:00
.Em u
is its own inverse.
1998-05-13 07:41:13 +00:00
.It (1,$)v/re/command-list
Apply
.Ar command-list
to each of the addressed lines not matching a regular expression
1998-05-13 07:41:13 +00:00
.Ar re .
This is similar to the
1998-05-13 07:41:13 +00:00
.Em g
command.
1998-05-13 07:41:13 +00:00
.It (1,$)V/re/
Interactively edit the addressed lines not matching a regular expression
.Ar re .
This is similar to the
1998-05-13 07:41:13 +00:00
.Em G
command.
1998-05-13 07:41:13 +00:00
.It (1,$)w Ar file
Write the addressed lines to
.Ar file .
Any previous contents of
1998-05-13 07:41:13 +00:00
.Ar file
is lost without warning.
If there is no default filename, then the default filename is set to
1998-05-13 07:41:13 +00:00
.Ar file ,
2002-07-04 13:22:22 +00:00
otherwise it is unchanged.
If no filename is specified, then the default
filename is used.
The current address is unchanged.
1998-05-13 07:41:13 +00:00
.It (1,$)wq Ar file
Write the addressed lines to
.Ar file ,
and then executes a
1998-05-13 07:41:13 +00:00
.Em q
command.
1998-05-13 07:41:13 +00:00
.It (1,$)w Ar !command
Write the addressed lines to the standard input of
.Ar !command ,
(see the
1998-05-13 07:41:13 +00:00
.Em !command
below).
The default filename and current address are unchanged.
1998-05-13 07:41:13 +00:00
.It (1,$)W Ar file
Append the addressed lines to the end of
.Ar file .
This is similar to the
1998-05-13 07:41:13 +00:00
.Em w
command, expect that the previous contents of file is not clobbered.
The current address is unchanged.
1998-05-13 07:41:13 +00:00
.It x
Prompt for an encryption key which is used in subsequent reads and
2002-07-04 13:22:22 +00:00
writes.
If a newline alone is entered as the key, then encryption is
turned off.
Otherwise, echoing is disabled while a key is read.
1998-05-13 07:41:13 +00:00
Encryption/decryption is done using the
.Xr bdes 1
algorithm.
.It Pf (.+1)z n
Scroll
.Ar n
2002-07-04 13:22:22 +00:00
lines at a time starting at addressed line.
If
1998-05-13 07:41:13 +00:00
.Ar n
is not specified, then the current window size is used.
The current address is set to the last line printed.
1998-05-13 07:41:13 +00:00
.It !command
Execute
.Ar command
via
1998-05-13 07:41:13 +00:00
.Xr sh 1 .
If the first character of
1998-05-13 07:41:13 +00:00
.Ar command
2002-07-04 13:22:22 +00:00
is
.Ql \&! ,
then it is replaced by text of the
previous
1998-05-13 07:41:13 +00:00
.Ar !command .
2002-04-16 20:08:06 +00:00
The
.Nm
utility does not process
1998-05-13 07:41:13 +00:00
.Ar command
for backslash (\\) escapes.
However, an unescaped
1998-05-13 07:41:13 +00:00
.Em %
is replaced by the default filename.
2002-07-04 13:22:22 +00:00
When the shell returns from execution, a
.Ql \&!
is printed to the standard output.
The current line is unchanged.
1998-05-13 07:41:13 +00:00
.It ($)=
Print the line number of the addressed line.
.It (.+1)newline
Print the addressed line, and sets the current address to
that line.
1998-05-13 07:41:13 +00:00
.El
.Sh FILES
.Bl -tag -width /tmp/ed.* -compact
.It /tmp/ed.*
buffer file
.It ed.hup
the file to which
.Nm
2002-07-04 13:22:22 +00:00
attempts to write the buffer if the terminal hangs up
1998-05-13 07:41:13 +00:00
.El
.Sh DIAGNOSTICS
When an error occurs,
1998-05-13 07:41:13 +00:00
.Nm
2002-07-04 13:22:22 +00:00
prints a
.Ql \&?
and either returns to command mode
or exits if its input is from a script.
An explanation of the last error can be
printed with the
1998-05-13 07:41:13 +00:00
.Em h
(help) command.
2000-12-15 17:37:31 +00:00
.Pp
2001-07-15 07:53:42 +00:00
Since the
1998-05-13 07:41:13 +00:00
.Em g
2002-07-04 13:22:22 +00:00
(global) command masks any errors from failed searches and substitutions,
it can be used to perform conditional operations in scripts; e.g.,
1998-05-13 07:41:13 +00:00
.Pp
.Sm off
.Cm g No / Em old Xo
.No / Cm s
.No // Em new
.No /
.Xc
.Sm on
.Pp
replaces any occurrences of
1998-05-13 07:41:13 +00:00
.Em old
with
1998-05-13 07:41:13 +00:00
.Em new .
If the
1998-05-13 07:41:13 +00:00
.Em u
(undo) command occurs in a global command list, then
the command list is executed only once.
2000-12-15 17:37:31 +00:00
.Pp
If diagnostics are not disabled, attempting to quit
1998-05-13 07:41:13 +00:00
.Nm
or edit another file before writing a modified buffer
results in an error.
If the command is entered a second time, it succeeds,
but any changes to the buffer are lost.
.Sh SEE ALSO
.Xr bdes 1 ,
.Xr sed 1 ,
.Xr sh 1 ,
.Xr vi 1 ,
.Xr regex 3
.Pp
USD:12-13
.Rs
.%A B. W. Kernighan
.%A P. J. Plauger
.%B Software Tools in Pascal
.%O Addison-Wesley
.%D 1981
.Re
.Sh LIMITATIONS
The
.Nm
utility processes
.Ar file
arguments for backslash escapes, i.e., in a filename,
any characters preceded by a backslash (\\) are
interpreted literally.
.Pp
If a text (non-binary) file is not terminated by a newline character,
then
.Nm
appends one on reading/writing it.
In the case of a binary file,
.Nm
does not append a newline on reading/writing.
.Pp
per line overhead: 4 ints
1998-05-13 07:41:13 +00:00
.Sh HISTORY
2001-06-04 23:33:02 +00:00
An
1998-05-13 07:41:13 +00:00
.Nm
command appeared in
Version 1 AT&T UNIX.
.Sh BUGS
The
.Nm
utility does not recognize multibyte characters.