*** empty log message ***
[bpt/emacs.git] / man / killing.texi
CommitLineData
6bf7aab6 1@c This is part of the Emacs manual.
28c53235
LT
2@c Copyright (C) 1985,86,87,93,94,95,97,2000,2001,2004
3@c Free Software Foundation, Inc.
6bf7aab6
DL
4@c See file emacs.texi for copying conditions.
5@iftex
6@chapter Killing and Moving Text
7
8 @dfn{Killing} means erasing text and copying it into the @dfn{kill
9ring}, from which it can be retrieved by @dfn{yanking} it. Some systems
10use the terms ``cutting'' and ``pasting'' for these operations.
11
0ec1f115 12 The most common way of moving or copying text within Emacs is to kill it
6bf7aab6
DL
13and later yank it elsewhere in one or more places. This is very safe
14because Emacs remembers several recent kills, not just the last one. It
15is versatile, because the many commands for killing syntactic units can
16also be used for moving those units. But there are other ways of
17copying text for special purposes.
18
7464a646
RS
19 On terminals that support multiple windows for multiple applications,
20the kill commands also provide a way to select text for other applications
21to copy, and the Emacs yank commands can access selections made by
22other programs.
23
6bf7aab6
DL
24 Emacs has only one kill ring for all buffers, so you can kill text in
25one buffer and yank it in another buffer.
26
27@end iftex
28
6cca5de0
LT
29@ifnottex
30@raisesections
31@end ifnottex
32
6bf7aab6
DL
33@node Killing, Yanking, Mark, Top
34@section Deletion and Killing
35
36@cindex killing text
37@cindex cutting text
38@cindex deletion
b3ada791
RS
39 Most commands which erase text from the buffer save it in the @dfn{kill
40ring} so that you can move or copy it to other parts of the buffer.
6bf7aab6
DL
41These commands are known as @dfn{kill} commands. The rest of the
42commands that erase text do not save it in the kill ring; they are known
43as @dfn{delete} commands. (This distinction is made only for erasure of
44text in the buffer.) If you do a kill or delete command by mistake, you
45can use the @kbd{C-x u} (@code{undo}) command to undo it
46(@pxref{Undo}).
47
8c1d7d60
EZ
48@vindex kill-read-only-ok
49@cindex read-only text, killing
bdb678d2
RS
50 You cannot kill read-only text, since such text does not allow any
51kind of modification. But some users like to use the kill commands to
52copy read-only text into the kill ring, without actually changing it.
28c53235
LT
53Therefore, the kill commands work specially in a read-only buffer:
54they move over text, and copy it to the kill ring, without actually
55deleting it from the buffer. Normally, Emacs beeps and prints an
56error message when this happens. But if you set the variable
57@code{kill-read-only-ok} to a non-@code{nil} value, it just prints a
58message in the echo area, telling you what is happening.
8b0645d6 59
6bf7aab6 60 The delete commands include @kbd{C-d} (@code{delete-char}) and
58fa012d
EZ
61@key{DEL} (@code{delete-backward-char}), which delete only one
62character at a time, and those commands that delete only spaces or
63newlines. Commands that can destroy significant amounts of nontrivial
64data generally do a kill operation instead. The commands' names and
65individual descriptions use the words @samp{kill} and @samp{delete} to
66say which kind of operation they perform.
6bf7aab6 67
7464a646
RS
68 On window systems, the most recent kill done in Emacs is also the
69primary selection, if it is more recent than any selection you made in
70another program. This means that the paste commands of other window
71applications copy the text that you killed in Emacs.
72
dd5c1ea9
DL
73@cindex Delete Selection mode
74@cindex mode, Delete Selection
75@findex delete-selection-mode
bdb678d2
RS
76 Many window systems follow the convention that insertion while text
77is selected deletes the selected text. You can make Emacs behave this
78way by enabling Delete Selection mode, with @kbd{M-x
79delete-selection-mode}, or using Custom. Another effect of this mode
80is that @key{DEL}, @kbd{C-d} and some other keys, when a selection
81exists, will kill the whole selection. It also enables Transient Mark
82mode (@pxref{Transient Mark}).
dd5c1ea9 83
6bf7aab6
DL
84@menu
85* Deletion:: Commands for deleting small amounts of text and
86 blank areas.
87* Killing by Lines:: How to kill entire lines of text at one time.
88* Other Kill Commands:: Commands to kill large regions of text and
177c0ea7 89 syntactic units such as words and sentences.
6bf7aab6
DL
90@end menu
91
c46cabfa 92@need 1500
6bf7aab6
DL
93@node Deletion
94@subsection Deletion
6bf7aab6
DL
95@findex delete-backward-char
96@findex delete-char
6bf7aab6 97
ba5d9bfd
RS
98 Deletion means erasing text and not saving it in the kill ring. For
99the most part, the Emacs commands that delete text are those that
100erase just one character or only whitespace.
101
6bf7aab6
DL
102@table @kbd
103@item C-d
4933bc02
EZ
104@itemx @key{Delete}
105Delete next character (@code{delete-char}). If your keyboard has a
106@key{Delete} function key (usually located in the edit keypad), Emacs
107binds it to @code{delete-char} as well.
6bf7aab6 108@item @key{DEL}
4933bc02
EZ
109@itemx @key{BS}
110Delete previous character (@code{delete-backward-char}). Some keyboards
c46cabfa 111refer to this key as a ``backspace key'' and label it with a left arrow.
6bf7aab6
DL
112@item M-\
113Delete spaces and tabs around point (@code{delete-horizontal-space}).
114@item M-@key{SPC}
115Delete spaces and tabs around point, leaving one space
116(@code{just-one-space}).
117@item C-x C-o
118Delete blank lines around the current line (@code{delete-blank-lines}).
119@item M-^
120Join two lines by deleting the intervening newline, along with any
121indentation following it (@code{delete-indentation}).
122@end table
123
2155102b
RS
124@kindex DEL
125@kindex C-d
6bf7aab6
DL
126 The most basic delete commands are @kbd{C-d} (@code{delete-char}) and
127@key{DEL} (@code{delete-backward-char}). @kbd{C-d} deletes the
128character after point, the one the cursor is ``on top of.'' This
129doesn't move point. @key{DEL} deletes the character before the cursor,
130and moves point back. You can delete newlines like any other characters
131in the buffer; deleting a newline joins two lines. Actually, @kbd{C-d}
132and @key{DEL} aren't always delete commands; when given arguments, they
133kill instead, since they can erase more than one character this way.
134
2155102b
RS
135@kindex BACKSPACE
136@kindex BS
137@kindex DELETE
138 Every keyboard has a large key, labeled @key{DEL}, @key{BACKSPACE},
139@key{BS} or @key{DELETE}, which is a short distance above the
140@key{RET} or @key{ENTER} key and is normally used for erasing what you
9ab48fa6 141have typed. Regardless of the actual name on the key, in Emacs it is
2155102b
RS
142equivalent to @key{DEL}---or it should be.
143
79ea1938
RS
144 Many keyboards (including standard PC keyboards) have a
145@key{BACKSPACE} key a short ways above @key{RET} or @key{ENTER}, and a
146@key{DELETE} key elsewhere. In that case, the @key{BACKSPACE} key is
147@key{DEL}, and the @key{DELETE} key is equivalent to @kbd{C-d}---or it
148should be.
2155102b 149
2155102b 150 Why do we say ``or it should be''? When Emacs starts up using a
9ab48fa6 151window system, it determines automatically which key or keys should be
58fa012d 152equivalent to @key{DEL}. As a result, @key{BACKSPACE} and/or @key{DELETE}
9ab48fa6
RS
153keys normally do the right things. But in some unusual cases Emacs
154gets the wrong information from the system. If these keys don't do
79ea1938 155what they ought to do, you need to tell Emacs which key to use for
82f6ab38 156@key{DEL}. @xref{DEL Does Not Delete}, for how to do this.
9ab48fa6
RS
157
158@findex normal-erase-is-backspace-mode
79ea1938
RS
159 On most text-only terminals, Emacs cannot tell which keys the
160keyboard really has, so it follows a uniform plan which may or may not
76dd3692
EZ
161fit your keyboard. The uniform plan is that the @acronym{ASCII} @key{DEL}
162character deletes, and the @acronym{ASCII} @key{BS} (backspace) character asks
79ea1938 163for help (it is the same as @kbd{C-h}). If this is not right for your
0ec1f115 164keyboard, such as if you find that the key which ought to delete backwards
82f6ab38 165enters Help instead, see @ref{DEL Does Not Delete}.
4933bc02 166
6bf7aab6
DL
167@kindex M-\
168@findex delete-horizontal-space
169@kindex M-SPC
170@findex just-one-space
171 The other delete commands are those which delete only whitespace
172characters: spaces, tabs and newlines. @kbd{M-\}
173(@code{delete-horizontal-space}) deletes all the spaces and tab
174characters before and after point. @kbd{M-@key{SPC}}
175(@code{just-one-space}) does likewise but leaves a single space after
176point, regardless of the number of spaces that existed previously (even
58fa012d 177if there were none before).
6bf7aab6
DL
178
179 @kbd{C-x C-o} (@code{delete-blank-lines}) deletes all blank lines
180after the current line. If the current line is blank, it deletes all
181blank lines preceding the current line as well (leaving one blank line,
182the current line).
183
184 @kbd{M-^} (@code{delete-indentation}) joins the current line and the
185previous line, by deleting a newline and all surrounding spaces, usually
186leaving a single space. @xref{Indentation,M-^}.
187
188@node Killing by Lines
189@subsection Killing by Lines
190
191@table @kbd
192@item C-k
193Kill rest of line or one or more lines (@code{kill-line}).
194@end table
195
196@kindex C-k
197@findex kill-line
198 The simplest kill command is @kbd{C-k}. If given at the beginning of
199a line, it kills all the text on the line, leaving it blank. When used
200on a blank line, it kills the whole line including its newline. To kill
201an entire non-blank line, go to the beginning and type @kbd{C-k} twice.
202
203 More generally, @kbd{C-k} kills from point up to the end of the line,
204unless it is at the end of a line. In that case it kills the newline
205following point, thus merging the next line into the current one.
206Spaces and tabs that you can't see at the end of the line are ignored
207when deciding which case applies, so if point appears to be at the end
208of the line, you can be sure @kbd{C-k} will kill the newline.
209
210 When @kbd{C-k} is given a positive argument, it kills that many lines
211and the newlines that follow them (however, text on the current line
58fa012d 212before point is not killed). With a negative argument @minus{}@var{n}, it
6bf7aab6
DL
213kills @var{n} lines preceding the current line (together with the text
214on the current line before point). Thus, @kbd{C-u - 2 C-k} at the front
215of a line kills the two previous lines.
216
217 @kbd{C-k} with an argument of zero kills the text before point on the
218current line.
219
220@vindex kill-whole-line
221 If the variable @code{kill-whole-line} is non-@code{nil}, @kbd{C-k} at
222the very beginning of a line kills the entire line including the
223following newline. This variable is normally @code{nil}.
224
225@node Other Kill Commands
226@subsection Other Kill Commands
227@findex kill-region
228@kindex C-w
229
6bf7aab6
DL
230@table @kbd
231@item C-w
232Kill region (from point to the mark) (@code{kill-region}).
233@item M-d
234Kill word (@code{kill-word}). @xref{Words}.
235@item M-@key{DEL}
236Kill word backwards (@code{backward-kill-word}).
237@item C-x @key{DEL}
238Kill back to beginning of sentence (@code{backward-kill-sentence}).
239@xref{Sentences}.
240@item M-k
241Kill to end of sentence (@code{kill-sentence}).
242@item C-M-k
46497336 243Kill the following balanced expression (@code{kill-sexp}). @xref{Expressions}.
6bf7aab6
DL
244@item M-z @var{char}
245Kill through the next occurrence of @var{char} (@code{zap-to-char}).
246@end table
247
248 A kill command which is very general is @kbd{C-w}
249(@code{kill-region}), which kills everything between point and the
250mark. With this command, you can kill any contiguous sequence of
251characters, if you first set the region around them.
252
253@kindex M-z
254@findex zap-to-char
255 A convenient way of killing is combined with searching: @kbd{M-z}
256(@code{zap-to-char}) reads a character and kills from point up to (and
257including) the next occurrence of that character in the buffer. A
258numeric argument acts as a repeat count. A negative argument means to
259search backward and kill text before point.
260
46497336
RS
261 Other syntactic units can be killed: words, with @kbd{M-@key{DEL}}
262and @kbd{M-d} (@pxref{Words}); balanced expressions, with @kbd{C-M-k}
263(@pxref{Expressions}); and sentences, with @kbd{C-x @key{DEL}} and
264@kbd{M-k} (@pxref{Sentences}).@refill
6bf7aab6
DL
265
266 You can use kill commands in read-only buffers. They don't actually
267change the buffer, and they beep to warn you of that, but they do copy
268the text you tried to kill into the kill ring, so you can yank it into
269other buffers. Most of the kill commands move point across the text
270they copy in this way, so that successive kill commands build up a
271single kill ring entry as usual.
272
273@node Yanking, Accumulating Text, Killing, Top
274@section Yanking
275@cindex moving text
276@cindex copying text
277@cindex kill ring
278@cindex yanking
279@cindex pasting
280
281 @dfn{Yanking} means reinserting text previously killed. This is what
282some systems call ``pasting.'' The usual way to move or copy text is to
b3ada791
RS
283kill it and then yank it elsewhere one or more times. This is very safe
284because Emacs remembers many recent kills, not just the last one.
6bf7aab6
DL
285
286@table @kbd
287@item C-y
288Yank last killed text (@code{yank}).
289@item M-y
290Replace text just yanked with an earlier batch of killed text
291(@code{yank-pop}).
292@item M-w
293Save region as last killed text without actually killing it
294(@code{kill-ring-save}).
295@item C-M-w
296Append next kill to last batch of killed text (@code{append-next-kill}).
297@end table
298
7464a646
RS
299 On window systems, if there is a current selection in some other
300application, and you selected it more recently than you killed any
301text in Emacs, @kbd{C-y} copies the selection instead of text
302killed within Emacs.
303
6bf7aab6
DL
304@menu
305* Kill Ring:: Where killed text is stored. Basic yanking.
306* Appending Kills:: Several kills in a row all yank together.
307* Earlier Kills:: Yanking something killed some time ago.
308@end menu
309
310@node Kill Ring
311@subsection The Kill Ring
312
313 All killed text is recorded in the @dfn{kill ring}, a list of blocks of
314text that have been killed. There is only one kill ring, shared by all
315buffers, so you can kill text in one buffer and yank it in another buffer.
316This is the usual way to move text from one file to another.
317(@xref{Accumulating Text}, for some other ways.)
318
319@kindex C-y
320@findex yank
321 The command @kbd{C-y} (@code{yank}) reinserts the text of the most recent
322kill. It leaves the cursor at the end of the text. It sets the mark at
323the beginning of the text. @xref{Mark}.
324
325 @kbd{C-u C-y} leaves the cursor in front of the text, and sets the
326mark after it. This happens only if the argument is specified with just
327a @kbd{C-u}, precisely. Any other sort of argument, including @kbd{C-u}
328and digits, specifies an earlier kill to yank (@pxref{Earlier Kills}).
329
c1a50bee
RS
330@cindex yanking and text properties
331@vindex yank-excluded-properties
332 The yank commands discard certain text properties from the text that
769508c9 333is yanked, those that might lead to annoying results. For instance,
c1a50bee
RS
334they discard text properties that respond to the mouse or specify key
335bindings. The variable @code{yank-excluded-properties} specifies the
336properties to discard. Yanking of register contents and rectangles
337also discard these properties.
338
6bf7aab6
DL
339@kindex M-w
340@findex kill-ring-save
341 To copy a block of text, you can use @kbd{M-w}
342(@code{kill-ring-save}), which copies the region into the kill ring
343without removing it from the buffer. This is approximately equivalent
344to @kbd{C-w} followed by @kbd{C-x u}, except that @kbd{M-w} does not
345alter the undo history and does not temporarily change the screen.
346
347@node Appending Kills
348@subsection Appending Kills
349
350@cindex appending kills in the ring
351@cindex television
352 Normally, each kill command pushes a new entry onto the kill ring.
353However, two or more kill commands in a row combine their text into a
354single entry, so that a single @kbd{C-y} yanks all the text as a unit,
355just as it was before it was killed.
356
357 Thus, if you want to yank text as a unit, you need not kill all of it
358with one command; you can keep killing line after line, or word after
359word, until you have killed it all, and you can still get it all back at
360once.
361
362 Commands that kill forward from point add onto the end of the previous
363killed text. Commands that kill backward from point add text onto the
364beginning. This way, any sequence of mixed forward and backward kill
365commands puts all the killed text into one entry without rearrangement.
366Numeric arguments do not break the sequence of appending kills. For
367example, suppose the buffer contains this text:
368
369@example
370This is a line @point{}of sample text.
371@end example
372
373@noindent
374with point shown by @point{}. If you type @kbd{M-d M-@key{DEL} M-d
375M-@key{DEL}}, killing alternately forward and backward, you end up with
376@samp{a line of sample} as one entry in the kill ring, and @samp{This
58fa012d
EZ
377is@ @ text.} in the buffer. (Note the double space between @samp{is}
378and @samp{text}, which you can clean up with @kbd{M-@key{SPC}} or
379@kbd{M-q}.)
6bf7aab6
DL
380
381 Another way to kill the same text is to move back two words with
382@kbd{M-b M-b}, then kill all four words forward with @kbd{C-u M-d}.
383This produces exactly the same results in the buffer and in the kill
384ring. @kbd{M-f M-f C-u M-@key{DEL}} kills the same text, all going
385backward; once again, the result is the same. The text in the kill ring
386entry always has the same order that it had in the buffer before you
387killed it.
388
389@kindex C-M-w
390@findex append-next-kill
391 If a kill command is separated from the last kill command by other
392commands (not just numeric arguments), it starts a new entry on the kill
393ring. But you can force it to append by first typing the command
394@kbd{C-M-w} (@code{append-next-kill}) right before it. The @kbd{C-M-w}
395tells the following command, if it is a kill command, to append the text
396it kills to the last killed text, instead of starting a new entry. With
397@kbd{C-M-w}, you can kill several separated pieces of text and
398accumulate them to be yanked back in one place.@refill
399
400 A kill command following @kbd{M-w} does not append to the text that
401@kbd{M-w} copied into the kill ring.
402
403@node Earlier Kills
404@subsection Yanking Earlier Kills
405
406@cindex yanking previous kills
407@kindex M-y
408@findex yank-pop
409 To recover killed text that is no longer the most recent kill, use the
410@kbd{M-y} command (@code{yank-pop}). It takes the text previously
411yanked and replaces it with the text from an earlier kill. So, to
412recover the text of the next-to-the-last kill, first use @kbd{C-y} to
413yank the last kill, and then use @kbd{M-y} to replace it with the
414previous kill. @kbd{M-y} is allowed only after a @kbd{C-y} or another
415@kbd{M-y}.
416
417 You can understand @kbd{M-y} in terms of a ``last yank'' pointer which
418points at an entry in the kill ring. Each time you kill, the ``last
419yank'' pointer moves to the newly made entry at the front of the ring.
420@kbd{C-y} yanks the entry which the ``last yank'' pointer points to.
421@kbd{M-y} moves the ``last yank'' pointer to a different entry, and the
422text in the buffer changes to match. Enough @kbd{M-y} commands can move
423the pointer to any entry in the ring, so you can get any entry into the
424buffer. Eventually the pointer reaches the end of the ring; the next
58fa012d 425@kbd{M-y} loops back around to the first entry again.
6bf7aab6
DL
426
427 @kbd{M-y} moves the ``last yank'' pointer around the ring, but it does
428not change the order of the entries in the ring, which always runs from
429the most recent kill at the front to the oldest one still remembered.
430
431 @kbd{M-y} can take a numeric argument, which tells it how many entries
432to advance the ``last yank'' pointer by. A negative argument moves the
433pointer toward the front of the ring; from the front of the ring, it
434moves ``around'' to the last entry and continues forward from there.
435
436 Once the text you are looking for is brought into the buffer, you can
437stop doing @kbd{M-y} commands and it will stay there. It's just a copy
438of the kill ring entry, so editing it in the buffer does not change
439what's in the ring. As long as no new killing is done, the ``last
440yank'' pointer remains at the same place in the kill ring, so repeating
441@kbd{C-y} will yank another copy of the same previous kill.
442
0ec1f115
RS
443 If you know how many @kbd{M-y} commands it would take to find the
444text you want, you can yank that text in one step using @kbd{C-y} with
445a numeric argument. @kbd{C-y} with an argument restores the text from
446the specified kill ring entry, counting back from the most recent as
4471. Thus, @kbd{C-u 2 C-y} gets the next-to-the-last block of killed
448text---it is equivalent to @kbd{C-y M-y}. @kbd{C-y} with a numeric
449argument starts counting from the ``last yank'' pointer, and sets the
450``last yank'' pointer to the entry that it yanks.
6bf7aab6
DL
451
452@vindex kill-ring-max
453 The length of the kill ring is controlled by the variable
454@code{kill-ring-max}; no more than that many blocks of killed text are
455saved.
456
457@vindex kill-ring
458 The actual contents of the kill ring are stored in a variable named
459@code{kill-ring}; you can view the entire contents of the kill ring with
460the command @kbd{C-h v kill-ring}.
461
462@node Accumulating Text, Rectangles, Yanking, Top
463@section Accumulating Text
464@findex append-to-buffer
465@findex prepend-to-buffer
466@findex copy-to-buffer
467@findex append-to-file
468
469@cindex accumulating scattered text
470 Usually we copy or move text by killing it and yanking it, but there
471are other methods convenient for copying one block of text in many
472places, or for copying many scattered blocks of text into one place. To
473copy one block to many places, store it in a register
474(@pxref{Registers}). Here we describe the commands to accumulate
475scattered pieces of text into a buffer or into a file.
476
477@table @kbd
478@item M-x append-to-buffer
0ec1f115 479Append region to the contents of a specified buffer.
6bf7aab6 480@item M-x prepend-to-buffer
0ec1f115 481Prepend region to the contents of a specified buffer.
6bf7aab6 482@item M-x copy-to-buffer
58fa012d 483Copy region into a specified buffer, deleting that buffer's old contents.
6bf7aab6 484@item M-x insert-buffer
0ec1f115 485Insert the contents of a specified buffer into current buffer at point.
6bf7aab6 486@item M-x append-to-file
0ec1f115 487Append region to the contents of a specified file, at the end.
6bf7aab6
DL
488@end table
489
490 To accumulate text into a buffer, use @kbd{M-x append-to-buffer}.
491This reads a buffer name, then inserts a copy of the region into the
492buffer specified. If you specify a nonexistent buffer,
493@code{append-to-buffer} creates the buffer. The text is inserted
494wherever point is in that buffer. If you have been using the buffer for
495editing, the copied text goes into the middle of the text of the buffer,
58fa012d 496starting from wherever point happens to be at that moment.
6bf7aab6
DL
497
498 Point in that buffer is left at the end of the copied text, so
499successive uses of @code{append-to-buffer} accumulate the text in the
500specified buffer in the same order as they were copied. Strictly
501speaking, @code{append-to-buffer} does not always append to the text
502already in the buffer---it appends only if point in that buffer is at the end.
503However, if @code{append-to-buffer} is the only command you use to alter
504a buffer, then point is always at the end.
505
506 @kbd{M-x prepend-to-buffer} is just like @code{append-to-buffer}
507except that point in the other buffer is left before the copied text, so
508successive prependings add text in reverse order. @kbd{M-x
58fa012d 509copy-to-buffer} is similar, except that any existing text in the other
6bf7aab6
DL
510buffer is deleted, so the buffer is left containing just the text newly
511copied into it.
512
33fa6691
RS
513 To retrieve the accumulated text from another buffer, use the
514command @kbd{M-x insert-buffer}; this too takes @var{buffername} as an
515argument. It inserts a copy of the whole text in buffer
0ec1f115 516@var{buffername} into the current buffer at point, and sets the mark
33fa6691
RS
517after the inserted text. Alternatively, you can select the other
518buffer for editing, then copy text from it by killing.
519@xref{Buffers}, for background information on buffers.
6bf7aab6
DL
520
521 Instead of accumulating text within Emacs, in a buffer, you can append
522text directly into a file with @kbd{M-x append-to-file}, which takes
523@var{filename} as an argument. It adds the text of the region to the end
524of the specified file. The file is changed immediately on disk.
525
526 You should use @code{append-to-file} only with files that are
527@emph{not} being visited in Emacs. Using it on a file that you are
528editing in Emacs would change the file behind Emacs's back, which
529can lead to losing some of your editing.
530
531@node Rectangles, Registers, Accumulating Text, Top
532@section Rectangles
533@cindex rectangle
534@cindex columns (and rectangles)
535@cindex killing rectangular areas of text
536
537 The rectangle commands operate on rectangular areas of the text: all
538the characters between a certain pair of columns, in a certain range of
539lines. Commands are provided to kill rectangles, yank killed rectangles,
540clear them out, fill them with blanks or text, or delete them. Rectangle
541commands are useful with text in multicolumn formats, and for changing
542text into or out of such formats.
543
544 When you must specify a rectangle for a command to work on, you do it
545by putting the mark at one corner and point at the opposite corner. The
546rectangle thus specified is called the @dfn{region-rectangle} because
58fa012d 547you control it in much the same way as the region is controlled. But
6bf7aab6
DL
548remember that a given combination of point and mark values can be
549interpreted either as a region or as a rectangle, depending on the
550command that uses them.
551
552 If point and the mark are in the same column, the rectangle they
553delimit is empty. If they are in the same line, the rectangle is one
554line high. This asymmetry between lines and columns comes about
555because point (and likewise the mark) is between two columns, but within
556a line.
557
558@table @kbd
559@item C-x r k
177c0ea7 560Kill the text of the region-rectangle, saving its contents as the
6bf7aab6
DL
561``last killed rectangle'' (@code{kill-rectangle}).
562@item C-x r d
563Delete the text of the region-rectangle (@code{delete-rectangle}).
564@item C-x r y
565Yank the last killed rectangle with its upper left corner at point
566(@code{yank-rectangle}).
567@item C-x r o
568Insert blank space to fill the space of the region-rectangle
569(@code{open-rectangle}). This pushes the previous contents of the
570region-rectangle rightward.
3b4d49d7
RS
571@item C-x r c
572Clear the region-rectangle by replacing its contents with spaces
573(@code{clear-rectangle}).
6bf7aab6
DL
574@item M-x delete-whitespace-rectangle
575Delete whitespace in each of the lines on the specified rectangle,
576starting from the left edge column of the rectangle.
d621caf7 577@item C-x r t @var{string} @key{RET}
1e1e6d52 578Replace rectangle contents with @var{string} on each line.
6bf7aab6 579(@code{string-rectangle}).
1e1e6d52 580@item M-x string-insert-rectangle @key{RET} @var{string} @key{RET}
e9db3bf2 581Insert @var{string} on each line of the rectangle.
6bf7aab6
DL
582@end table
583
58fa012d
EZ
584 The rectangle operations fall into two classes: commands for
585deleting and inserting rectangles, and commands for blank rectangles.
6bf7aab6
DL
586
587@kindex C-x r k
588@kindex C-x r d
589@findex kill-rectangle
590@findex delete-rectangle
591 There are two ways to get rid of the text in a rectangle: you can
592discard the text (delete it) or save it as the ``last killed''
593rectangle. The commands for these two ways are @kbd{C-x r d}
594(@code{delete-rectangle}) and @kbd{C-x r k} (@code{kill-rectangle}). In
595either case, the portion of each line that falls inside the rectangle's
58fa012d 596boundaries is deleted, causing any following text on the line to
6bf7aab6
DL
597move left into the gap.
598
599 Note that ``killing'' a rectangle is not killing in the usual sense; the
600rectangle is not stored in the kill ring, but in a special place that
601can only record the most recent rectangle killed. This is because yanking
602a rectangle is so different from yanking linear text that different yank
603commands have to be used and yank-popping is hard to make sense of.
604
605@kindex C-x r y
606@findex yank-rectangle
607 To yank the last killed rectangle, type @kbd{C-x r y}
608(@code{yank-rectangle}). Yanking a rectangle is the opposite of killing
609one. Point specifies where to put the rectangle's upper left corner.
610The rectangle's first line is inserted there, the rectangle's second
d7d7da37
EZ
611line is inserted at the same horizontal position, but one line
612vertically down, and so on. The number of lines affected is determined
613by the height of the saved rectangle.
6bf7aab6
DL
614
615 You can convert single-column lists into double-column lists using
616rectangle killing and yanking; kill the second half of the list as a
617rectangle and then yank it beside the first line of the list.
618@xref{Two-Column}, for another way to edit multi-column text.
619
620 You can also copy rectangles into and out of registers with @kbd{C-x r
621r @var{r}} and @kbd{C-x r i @var{r}}. @xref{RegRect,,Rectangle
622Registers}.
623
624@kindex C-x r o
625@findex open-rectangle
3b4d49d7 626@kindex C-x r c
6bf7aab6
DL
627@findex clear-rectangle
628 There are two commands you can use for making blank rectangles:
3b4d49d7
RS
629@kbd{C-x r c} (@code{clear-rectangle}) which blanks out existing text,
630and @kbd{C-x r o} (@code{open-rectangle}) which inserts a blank
631rectangle. Clearing a rectangle is equivalent to deleting it and then
632inserting a blank rectangle of the same size.
6bf7aab6
DL
633
634@findex delete-whitespace-rectangle
635 The command @kbd{M-x delete-whitespace-rectangle} deletes horizontal
636whitespace starting from a particular column. This applies to each of
637the lines in the rectangle, and the column is specified by the left
638edge of the rectangle. The right edge of the rectangle does not make
639any difference to this command.
640
641@kindex C-x r t
642@findex string-rectangle
d57211a3 643 The command @kbd{C-x r t} (@code{string-rectangle}) replaces the
1e1e6d52
GM
644contents of a region-rectangle with a string on each line. The
645string's width need not be the same as the width of the rectangle. If
646the string's width is less, the text after the rectangle shifts left;
647if the string is wider than the rectangle, the text after the
648rectangle shifts right.
649
650@findex string-insert-rectangle
177c0ea7
JB
651 The command @kbd{M-x string-insert-rectangle} is similar to
652@code{string-rectangle}, but inserts the string on each line,
1e1e6d52 653shifting the original text to the right.
ab5796a9 654
6cca5de0
LT
655@ifnottex
656@lowersections
657@end ifnottex
658
ab5796a9
MB
659@ignore
660 arch-tag: d8da8f96-0928-449a-816e-ff2d3497866c
661@end ignore