Index of Section 1 Manual Pages
| Interix / SUA | ed.1 | Interix / SUA |
ED(1) ED(1)
NAME
ed, red - line oriented text editor
SYNOPSIS
ed [ -p prompt-string ] [ - | -s ] [ -C ] [ -v ] [ -x ] [
-t tag | filename ]
red [ -p prompt-string ] [ - | -s ] [ -C ] [ -v ] [ -x ] [
-t tag | filename ]
DESCRIPTION
Ed is a standard text editor.
Ed is a powerful line oriented editor. Although
ex(1)/vi(1) have gained popularity, ed still maintains
advantages over them. Notable points are the smaller exe-
cutable size (you can often be editing before the others
finish loading), and the better response when editing from
slow terminals or across low baud data lines. Ed continues
to be used by many system utilities.
When invoked as red the editor behaves as ed except that
specified files must be in the current working directory,
and no shell commands are allowed for any command.
OPTIONS
When a filename is present ed starts by simulating an e
command (see below) If no filename is present ed starts
with an empty buffer. Alternatively a tag may be supplied
with the -t option (see ctags(1)) that will determine the
file and location within that file where the tag is
located. The option -p allows for the setting of a prompt
string in ed. The option -s suppresses the printing of
explanatory output (from the commands e, E, r, w, W and
wq; see below) and should be used with a script. For
backward compatability with older scripts - is supported
to mean the same as the -s option; only one of -s or - may
be used. The -C option is to indicate that a script
should continue even after encountering an error; the
default (tradition) is to exit immediately when a script
is executing. The -v option will display a message of
which mode (BSD or POSIX) ed as been set locally and the
version of ed. This is useful for determining the
described behavior below.
Ed performs all changes to a copy of the file which is
contained in a buffer. For the changes to have an effect
one of the write commands ( w, W, wq, or Wq) must be
issued.
The contents of the buffer can changed by issuing commands
that are lead by zero, one, or two addresses. All commands
are alphabetically listed below with their parameter
structures if applicable; trailing structures not
described with commands are regarded as erroneous. Com-
mands that accept zero addresses regard the presence of
any address as an error.
Ed works in two modes: command, and input. The two modes
are exclusive of each other. While in command mode ed
accepts commands that display, modify, or give information
about the buffer. While in input mode ed accepts lines of
text to be added to the buffer.
Addressing in ed specifies one or more lines contained in
the buffer. For commands that expect at least one
address, and none are given, default addresses will be
used. Using addresses in ed involves understanding that
during the execution of most ed commands that a current
line ( current) exists. Current (as a rule of thumb) is
the location in the buffer that the last command issued
affected; some commands do not affect current. Each com-
mand description (below) describes its affects on current
as the affect will vary depending under which compile
option (BSD or POSIX) ed was compiled under. Addresses
can be divided into three cases: one address (single
address), two addresses (an address pair), and special
address forms.
For the first two cases an address is formed with the use
of:
1. A positive decimal integer (e.g. 123) indicating a
line number in the buffer. Line number 1 is the
first line in the buffer.
2. The `.' character indicating the current line (cur-
rent).
3. The `$' character which indicates the last line in
the buffer.
4. A regular expression (RE) enclosed with `/'s as
delimiters (i.e. /RE/). This causes a forward
search to the first occurrence of the specified RE.
The address will then become this line. The char-
acter sequence \/ escapes the forwardslash from
being a delimiter. The search will wrap from the
bottom of the buffer to the top of the buffer if
need be. Ed RE's are, outside of this document,
now refered to as basic regular expressions. Basic
regular expressions (BRE's), traditionally
described in ed(1) are now fully described in
regex(7). BRE's are, for the most part, the same as
the old RE's - the name has changed and the expres-
sions extended to meet POSIX 1003.2 specifications.
(See the search command for more details.)
5. A RE enclosed with `?'s as delimiters (i.e. ?RE?).
This will cause a backward search to the first
occurrence of the specified BRE. The address will
then become this line. The character sequence \?
escapes the questionmark from being a delimiter.
The search will wrap from the top of the buffer to
the bottom of the buffer if need be. (See the
search command for more details.)
6. A line previously marked by the `k' command (see
below). `x addresses the line marked by the single
lower-case letter `x' (from the portable character
set in the range a-z).
7. An address of the form 1-6 followed by a `+' fol-
lowed by an integer number, n, specifies the line
to be addressed is n lines after the address of the
form 1-6. If the address starts with a `+' then by
default the addressed line is taken with respect to
current (equivalent to `.'; form 2). If no integer
number is given then 1 is added to the address.
Hence, if more than one `+' is given in a sequence,
with no integer number following, 1 is added to the
address for each `+'. Therefore, +++ is eqivalent
to +3, but +++1 is equivalent to +1.
8. An address of the form 1-6 followed by a `-' fol-
lowed by an integer number, n, specifies the line
to be addressed is n lines before the address of
the form 1-6. If the address starts with a `-'
then by default the addressed line is taken with
respect to current (`.'; form 1). If no integer
number is given then 1 is subtracted from the
address. Hence, if more than one `-' is given in a
sequence, with no integer number following, 1 is
subtracted from the address for each `-'. There-
fore, --- is eqivalent to -3, but ---1 is equiva-
lent to -1. For backward compatibility `^' is the
equivalent to `-'.
9. A `,' (comma) may be used to separate two addresses
of the form 1-8 to create an address pair. The
first address must occur no later in the buffer
than the second address to be legal.
10. A `;' (semicolon) may be used to separate two
addresses of the form 1-8 to create an address
pair. With this form the second address is evalu-
ated with respect to and after the first address
has been evaluated. This is useful when addresses
of the forms 2-8 are used. The first address must
occur no later in the buffer than the second
address to be legal.
NOTE: Addresses of the forms 7 and 8 cannot be followed
by addresses of forms 2-6; it is an error.
The following are special address forms that cannot be
combined with any of the address forms listed above. A
`,' by itself represents the address pair `1,$'. Likewise
`%' by itself represents the address pair `1,$'. A `;' by
itself represents the address pair `.,$'.
The ed commands listed below default to the addresses pre-
fixing the commands. Commands without default addresses
accept zero addresses. The parentheses with the default
addresses are not part of the address; they are used to
show that the addresses are default.
Generally only one command appears on a line at a time.
However, many of the commands may be suffixed by `l', `n',
or `p', in which case the current line is printed in the
manner discussed below. These suffixes may be combined in
any order.
(.)a
.
Append text after the addressed line. A `.' in the
first column followed immediately by a
places ed back in command mode - the `.' is not
included in the text. Line 0 is legal for this com-
mand; text will be placed at the top of the buffer.
Current is the last line appended (or the addressed
line if no text given).
(.,.)c
.
Change text on the addressed line(s). The addressed
lines are deleted before ed is placed in input mode.
A `.' in the first column followed immediately by a
places ed back in command mode - the `.' is
not included in the text. Current is the new last
line appended (or if no text is given the line after
the addressed line deleted).
(.,.)d
Delete the addressed line(s) from the buffer. Deleted
lines may be recovered with the undo command (u; see
below). Current is the line after the last addressed
line deleted.
e [filename]
Edit the new file `filename'. The buffer is cleared
and the new file is placed in the buffer. If the
buffer has been modified since the last write command
ed will issue a warning (`?'); a second issuing of
the command will be obeyed regardless. The number of
characters read is printed (unless -s is specified at
startup). If `filename' is missing, the remembered
name is used. If `filename' is lead by ! then it
shall be interpreted as a shell command to be exe-
cuted, from which the standard output will be placed
into the buffer; `filename' will be non-remembered.
When executing as red `filename' cannot start with !.
Undo will not restore the buffer to its state before
the edit command. Current is the last line in the
buffer (`$').
E [filename]
E works the same as e except if the buffer has been
modified no warning is issued.
f [filename]
Print the remembered filename. If `filename' is
specified the remembered filename will be set to
`filename'. If `filename' is lead by ! then it shall
be interpreted as a shell command to be executed,
from which the standard output will be used as the
new remembered filename. When executing as red
`filename' cannot start with !. Current is
unchanged.
(1,$)g/regular expression/command list
The global command first marks all lines matching the
regular expression. For each matching line, the com-
mand list is executed. At the start of each command
list execution, current is set to equal that line;
current may change as each command in the command
list is executed for that line. The first command of
the command list begins on the same line as the
global command. Generally, in the command list one
command occupies a line. Thus to have multiple com-
mands in the command list it is necessary to escape
the at the end of each line so that the
global command does not interpret it as an indication
that the command list entry has ended. The
is escaped by proceeding it with a backslash (`\').
Similarly with the commands that set ed into input
mode the of the entered text need to be
escaped. If the `.' used to end input mode is the
last line of the command list the following
the `.' need not be escaped, or the `.' may be omit-
ted entirely. Commands in the command list can
affect any line in the buffer. For the behaviour of
each ed command within a command list refer to the
information on the individual command, particularly s
and !. The commands g, G, v, V, and ! are permitted
in the command list, but should be used with caution.
The command list defaults to p if left empty (i.e.
g/RE/p). For the regular expression the delimiters
can be any characters except for and ; delimiters within a regular expression can be
escaped with a backslash preceeding it.
(1,$)G/regular expression/
The interactive global command works similar to g.
The first step is to mark every line which matches
the given regular expression. For every line matched
it will print this line, set current to this line,
and accept one command (not including a, c, i, g, G,
v, and V) for execution. The command can affect any
line in the buffer. `&' by itself executes the last
non-null command. A return by itself will act as a
null command. Current will be set to the last line
affected by the last successful command input. If no
match or an input command error occurs current will
be set to the last line searched by G. G can be pre-
maturely ended by `ctrl-C' (SIGINT). For the
behaviour of each ed command within a command list
refer to the information on the individual command,
particularly s and !.
h
The help command displays a message explaining the
most recent command error (indicated by `?'). Current
is unchanged.
H
This toggles on or off the automatic display of mes-
sages explaining the most recent command error in
place of `?'. Current is unchanged.
(.)i
.
The insert command places ed in input mode with the
text being placed before the addressed line. Line 0
is invalid for this command. A `.' in the first col-
umn followed immediately by a return places ed back
in command mode - the `.' is not included in the
text. Current is the last line inserted. If no text
is inserted then current is the addressed when ed is
compiled for POSIX; compiled for BSD, current is the
addressed line -1.
(.,.+1)j
The join command joins the addressed lines together
to make one line. If no addresses are specified cur-
rent and current+1 lines are joined. If one address
only is given then no join is performed. Current
becomes that line if ed has been compiled under the
BSD option; if compiled under the POSIX option cur-
rent is unchanged.
( . )kx
The mark command marks the addressed line with label
x, where x is a lowercase letter from the portable
character set (a-z). The address form `x will refer
to this line (address form 6 above). Current is
unchanged.
(.,.)l
The list command prints the addressed lines in an
unambiguous way: non-graphic characters are printed
in three-digit octal preceded by a \ unless they are
one of the following in which case they will be
printed as indicated in the brackets: backslash
(`\\'), horizontal tab (\t), form feed (\f). return
(\r), vertical tab (\v), and backspace (\b). Long
lines will be broken based on the type of terminal
currently in use and will likely be ragged at the
right side if text and octal are mixed on the same
line. Current is set to the last line printed. The
l command may be placed on the same line after any
command except (e, E, f, q, Q, r, w, W, or !).
(.,.)ma
The move command moves the addressed lines in the
buffer to after the address a. Line 0 is valid as
the address a for this command. Current is the loca-
tion in the buffer of the last line moved.
(.,.)n
The number command prints the addressed lines preced-
ing the text with the line number. The n command may
be placed on the same line after any command except
(e, E, f, q, Q, r, w, W, or !). Current is the last
line printed.
(.,.)p
The print command prints the addressed lines. The p
command may be placed on the same line after any com-
mand except (e, E, f, q, Q, r, w, W, or !). Current
is the last line printed.
(.,.)P
This command is a synonym for p if ed has been com-
piled under the BSD option. If ed has been compiled
under the POSIX option then the prompt is toggled on
or off. Current is unchanged when compiled under the
POSIX option. The default prompt is "*" if not spec-
ified with the -p option at startup. The prompt is
initially off unless the -p option is specified.
q The quit command causes ed to exit. If the entire
buffer (1,$) has not been written since the last mod-
ification ed will issue a warning once (`?'); a sec-
ond issuing of the command will be obeyed regardless.
Q Q works the same as q except if the buffer has been
modified no warning is issued.
($)r [filename]
The read command reads in the file `filename' after
the addressed line. If no `filename' is specified
then the remembered filename is used. Address 0 is
valid for this command. If read is successful then
the number of characters read is printed (unless the
-s option is specified). If `filename' is lead by !
then it shall be interpreted as a shell command to be
executed, from which the standard output will be
placed in the buffer; `filename' will be non-remem-
bered. When executing as red `filename' cannot start
with !. Current is the last line read.
( ., .)s/regular expression/replacement/flags
The substitute command searches for the regular
expression in the addressed lines. On each line in
which a match is found, matched strings are replaced
by the replacement as specified by the flags (see
below). If no flags appear, by default only the
first occurrence of the matched string in each line
is replaced. It is an error if no matches to the RE
occur.
The delimiters may be any character except or
. The delimiter lead by a \ will escape it
to be a literal in the RE or replacement.
An ampersand, `&', appearing in the replacement will
equal the string matching the RE. The `&'s special
meaning is supressable by leading it with a `\'.
When `%' is the only replacement character in
replacement the most recent replacement is used. The
`%'s special meaning is supressable by leading it
with a `\'.
The characters `\n' (where n is a digit 1-9) is
replaced by the text matching the RE subexpression n
(known as backreferencing). S may be used to break
lines by including a in replacement pre-
ceeded by a backslash (`\') to escape it. Replace-
ment can continue on the next line and can include
another escaped .
The following extention should not be included in
portable scripts. When spliting lines using s within
the global commands (g, G, v, or V) the in
the replacement string must be escaped by preceding
it with `\\\' (three adjacent `\'s - the first `\'
escapes the second `\' so that it is passed to s to
escape the passed by the global command;
the third `\' is to escape the so that the
global command list continues). [N.B. Other ed's do
not allow line splitting within the global commands].
The flags may be any combination of:
count in each addressed line replace the count-th
matching occurrence.
g in each addressed line replace all matching
occurrences. When count and g are specified
together inclusively replace in each addressed
line all matches from the count-th match to
the end of line.
l write the line after replacement in the manner
specified by the l command.
n write the line after replacement in the manner
specified by the n command.
p write the line after replacement in the manner
specified by the p command.
The following special form should not be included in
portable scripts. This form is maintained for back-
ward compatibility and is extended to dovetail into
the above forms of s. S followed by no delimiters
repeats the most recent substitute command on the
addressed lines. S may be suffixed with the letters
r (use the most recent RE rather than the last RE
used with s), p (complement the setting of the any
print command (l, n, p) suffix from the previous sub-
stitution), g (complement the setting of the g suf-
fix) or N (negate the previous count flag). These
modifying letters may be combined in any order (N.B.
multiple use of the modifying letters may cause them
to be interpreted as delimiters).
Current is set to the last line search (BSD) or where
the last replacement occurred (POSIX).
(.,.)ta
The transcribe command copies the addressed lines in
the buffer to after the address a. Address 0 is
valid as the address a for this command. Current is
the last line transcribed.
(.,.)u
The undo command nullifies the most recent buffer
modifying command. Buffer modifying commands undo
works on are a, c, d, g, G, i, j, m, r, s, t, u, v,
and V. Marks set by the k command will also be
restored. All commands (including nested g, G, v,
and V commands within the g or v) that undo works on
are treated as a single buffer modification. Current
is set to the line it addressed before the last
buffer modification.
(1, $)v/regular expression/command list
The global non-matching command performs as the g
command does except that the command list is executed
for every line that does not match the RE.
(1, $)V/regular expression/
The interactive global non-matching command is the
same as the G except that one command will be
accepted as input with current initially set to every
line that does not match the RE.
(1, $)w [filename]
The write command writes the addressed lines to the
file `filename'. If no `filename' is specified then
the remembered filename is used. If no addresses are
specified the whole buffer is written. If the com-
mand is successful, the number of characters written
is printed (unless the -s option is specified). If
`filename' is lead by ! then it shall be interpreted
as a shell command to be executed which will accept
on its standard input the section of the buffer spec-
ified for writting. When executing as red `filename'
cannot start with !. Current is unchanged.
(1, $)W [filename]
W works as the w command does except the addressed
contents of the buffer are appended to `filename' (or
the remembered filename if `filename' is not speci-
fied). If `filename' is lead by ! then W will act
exactly as the w command. When executing as red
`filename' cannot start with !. Current is
unchanged.
(1, $)wq [filename]
wq works as the w command does with the addition that
ed exits immediately after the write is complete.
Current is unchanged.
(1,$)Wq [filename]
Wq works as the W command does with the addition that
ed exits immediately after the appended write is com-
plete. Current is unchanged.
x Specifies that encryption/decryption is to be turned
on or off when read or writing a file. The user will
be prompted for a key (password) to be used by the
encryption/decryption algorithm(s). An empty key will
turn this command off. NOTE: The ed program itself
contains no encryption algorithms. The algorithms are
provided by an external process. This allows ed to be
less constrained by import or export regulations gov-
erning encryption technology for most countries
(there are always exceptions, so no guarantee made).
Depending on your site ed may, typically, be using
crypt(1) or bdes(1). The full path to the executable
providing encryption/decryption will appear with the
prompt for a key (e.g. "(/usr/bin/bdes) Enter Key:
"). You should check the integrity of the encryp-
tion/decryption program before using this command,
every time. It is arguable that is a safer method
over incorporating the technology directly into ed.
(.+1)z[c|+|-|^] or,
(.+1)z[c|+|-|^]n
Scroll through the buffer. Starting from the
addressed line (or current+1) print the next 22 (by
default or n) lines; similar to print the next page.
The n is a sticky value; it becomes the default num-
ber of lines printed for successive scrolls. Only one
of the optional modifiers 'c', '+', '-' and '^' may
be present. '+' is the same as no modifier. '-' and
'^' mean print the 22 (by default or n) lines start-
ing at the addressed line (or current) less 44 (by
default or 2 * n) lines; similar to print the previ-
ous page. 'c' means to print the 22 (by default or n)
lines starting at the addressed line (or current)
less 22 (by default or n) lines; similar to print the
current page. Current is the last line printed.
(.+1)Z[c|+|-|^] or,
(.+1)Z[c|+|-|^]n
The Z works as z command does with the addition that
addressed lines are preceded with the line number.
($)= Print the number of lines in the buffer. If an
address is provided (in the forms 1-8 above) then the
line number for that line will be printed. Current
is unchanged.
!
The command after the ! is executed by sh(1) and the
results are printed. A `!' is printed in the first
column when execution has completed (unless the -s
option has been specified). A `!' immediately after
! repeats the last shell command. An unescaped `%'
represents the remembered filename. Commands to
sh(1) can have several lines by escaping the with a `\' immediately before it. The line con-
tinuation character for sh(1), `\', can be included
on a line provided that it is escaped by a `\' imme-
diately before so that ed passes it literally to
sh(1): `\\'. It is implicit that for the command line
that the sh(1) line continuation character is on that
the will be escaped (e.g. `\\\').
This behavior can be used within global command
lists. However, an additional `\' must be added so
that the ! command continuor is passed to ! - it must
occur immediately before the global command's contin-
uor. Therefore, the ! command continuation sequence
in a global command list will appear as `\\\' (expla-
nation as with sfR). The line continuation character
for sh(1) needs no additional escaping (since it it
not dependant on being adjacent) - hence,
the sequence in a global command list with a line
continuation will appear as `\\\\\'. When
executing as red this command is not allowed.
Current is unchanged.
/regular expression/or,
?regular expression?
The search command searches forward, `/', (or back-
ward, `?') through the buffer attempting to find a
line that matches the RE. The search will wrap to the
top (or bottom) of the buffer if necessary. Search
returns the line number that the match occurs on -
combined with the null command (see below) this
causes the line to be printed. Current is the match-
ing line.
(.+1,.+1)
The null command is equivalent to asking for the line
current+1 to be printed according to the p command.
This is a useful command to quickly print the next
couple of lines. If more than a couple of lines are
needed the z command (see above) is much better to
use. Current is the last line printed.
OTHER
If an interrupt signal (SIGINT) is sent, ed prints `?'
and returns to command mode.
BSD command pairs (pp, ll, etc.) are permitted. Addition-
ally any single print command may follow any of the non-
I/O commands (I/O commands: e, E, f, r, w, W, wq, and !).
This will cause the current line to be printed in the
specified manner after the command has completed.
Previous limitations on the number of characters per line
and per command list have been lifted; there is now no
maximum. File name and path length is restricted to the
maximum length that the current file system supports. The
undo command now restores marks to affected lines. The
temporary buffer method will vary dependent on the method
selected at compile. Two methods work with a temporary
file (stdio and db), while the third uses memory. The
limit on the number of lines depends on the amount of mem-
ory.
FILES
/tmp/_bsd44_ed*
ed.hup: the buffer is written to this file in the current
directory if possible and in the HOME directory is not (if
the signal SIGHUP (hangup) is received).
SEE ALSO
B. W. Kernighan, A Tutorial Introduction to the ED Text
Editor
B. W. Kernighan, Advanced editing on UNIX
ex(1), learn(1), regex(3), regex(7), sed(1), vi(1), POSIX
1003.2 (4.20), crypt(1), bdes(1)
AUTHOR
Rodney Ruddock
(rodney@ruddock.org, http://www.cyg.net/~rod-
ney/ed/ed.html)
DIAGNOSTICS
`?name' for a file that is either inaccessible, does not
exist, or is a directory. `?' for all other errors unless
the help messages have been toggled on (with the H com-
mand) in which case a descriptive message will be printed.
EOF is treated as a newline during input so that charac-
ters after the last are included into the
buffer; the message " added at end of line" is
printed.
Ed Returns an exit status of 0 on successful completion. A
value >0 is returned to indicate an ed error: 1 for a com-
mand line error, 2 for HUP signal received, 4 for an ed
command error; these error values will be or'd together
when appropriate.
NOTES
Regular expressions are now described on regex(7). Ed
follows basic regular expressions (BRE's) as described on
regex(7). BRE's, for the most part, are the same as pre-
vious ed RE's. The changes to the RE's are extensions for
internationalization under POSIX 1003.2. Old scripts with
RE's should work without modification.
Regular expression logic is very tight. If you believe a
command with a regular expression in it has performed
erroneously then a close reading of regex(7) is likely
required.
Address `0' is legal only for those commands which explic-
itly state that it may be used; its use is illegal for all
other commands.
The special form of substitute has been maintained for
backward compatability and should not be used in scripts
if they are to portable.
Help messages may appear ambiguous to beginners - particu-
larly when BRE's form part of the command.
For backward compatability, when more addresses are pro-
vided than required by a command the one or two addresses
closest to the command are used (depending on how may
addresses the command accepts). Portable scripts should
not rely on this feature.
For backward compatibility the option `-' is equivalent to
the `-s' option at the startup of ed.
Jun 12, 2001 ED(1)