Add 2012 to FSF copyright years for Emacs files
[bpt/emacs.git] / doc / emacs / killing.texi
1 @c This is part of the Emacs manual.
2 @c Copyright (C) 1985-1987, 1993-1995, 1997, 2000-2012
3 @c Free Software Foundation, Inc.
4 @c See file emacs.texi for copying conditions.
5
6 @node Killing, Registers, Mark, Top
7 @chapter Killing and Moving Text
8
9 In Emacs, @dfn{killing} means erasing text and copying it into the
10 @dfn{kill ring}. @dfn{Yanking} means bringing text from the kill ring
11 back into the buffer. (Some applications use the terms ``cutting''
12 and ``pasting'' for similar operations.) The kill ring is so-named
13 because it can be visualized as a set of blocks of text arranged in a
14 ring, which you can access in cyclic order. @xref{Kill Ring}.
15
16 Killing and yanking are the most common way to move or copy text
17 within Emacs. It is very versatile, because there are commands for
18 killing many different types of syntactic units.
19
20 @menu
21 * Deletion and Killing:: Commands that remove text.
22 * Yanking:: Commands that insert text.
23 * Cut and Paste:: Clipboard and selections on graphical displays.
24 * Accumulating Text:: Other methods to add text to the buffer.
25 * Rectangles:: Operating on text in rectangular areas.
26 * CUA Bindings:: Using @kbd{C-x}/@kbd{C-c}/@kbd{C-v} to kill and yank.
27 @end menu
28
29 @node Deletion and Killing
30 @section Deletion and Killing
31
32 @cindex killing text
33 @cindex cutting text
34 @cindex deletion
35 Most commands which erase text from the buffer save it in the kill
36 ring. These are known as @dfn{kill} commands, and their names
37 normally contain the word @samp{kill} (e.g. @code{kill-line}). The
38 kill ring stores several recent kills, not just the last one, so
39 killing is a very safe operation: you don't have to worry much about
40 losing text that you previously killed. The kill ring is shared by
41 all buffers, so text that is killed in one buffer can be yanked into
42 another buffer.
43
44 When you use @kbd{C-/} (@code{undo}) to undo a kill command
45 (@pxref{Undo}), that brings the killed text back into the buffer, but
46 does not remove it from the kill ring.
47
48 On graphical displays, killing text also copies it to the system
49 clipboard. @xref{Cut and Paste}.
50
51 Commands that erase text but do not save it in the kill ring are
52 known as @dfn{delete} commands; their names usually contain the word
53 @samp{delete}. These include @kbd{C-d} (@code{delete-char}) and
54 @key{DEL} (@code{delete-backward-char}), which delete only one
55 character at a time, and those commands that delete only spaces or
56 newlines. Commands that can erase significant amounts of nontrivial
57 data generally do a kill operation instead.
58
59 You can also use the mouse to kill and yank. @xref{Cut and Paste}.
60
61 @menu
62 * Deletion:: Commands for deleting small amounts of text and
63 blank areas.
64 * Killing by Lines:: How to kill entire lines of text at one time.
65 * Other Kill Commands:: Commands to kill large regions of text and
66 syntactic units such as words and sentences.
67 * Kill Options:: Options that affect killing.
68 @end menu
69
70 @node Deletion
71 @subsection Deletion
72 @findex delete-backward-char
73 @findex delete-char
74
75 Deletion means erasing text and not saving it in the kill ring. For
76 the most part, the Emacs commands that delete text are those that
77 erase just one character or only whitespace.
78
79 @table @kbd
80 @item @key{DEL}
81 @itemx @key{Backspace}
82 Delete the previous character, or the text in the region if it is
83 active (@code{delete-backward-char}).
84
85 @item @key{Delete}
86 Delete the next character, or the text in the region if it is active
87 (@code{delete-forward-char}).
88
89 @item C-d
90 Delete the next character (@code{delete-char}).
91
92 @item M-\
93 Delete spaces and tabs around point (@code{delete-horizontal-space}).
94 @item M-@key{SPC}
95 Delete spaces and tabs around point, leaving one space
96 (@code{just-one-space}).
97 @item C-x C-o
98 Delete blank lines around the current line (@code{delete-blank-lines}).
99 @item M-^
100 Join two lines by deleting the intervening newline, along with any
101 indentation following it (@code{delete-indentation}).
102 @end table
103
104 We have already described the basic deletion commands @key{DEL}
105 (@code{delete-backward-char}), @key{delete}
106 (@code{delete-forward-char}), and @kbd{C-d} (@code{delete-char}).
107 @xref{Erasing}. With a numeric argument, they delete the specified
108 number of characters. If the numeric argument is omitted or one, they
109 delete all the text in the region if it is active (@pxref{Using
110 Region}).
111
112 @kindex M-\
113 @findex delete-horizontal-space
114 @kindex M-SPC
115 @findex just-one-space
116 The other delete commands are those that delete only whitespace
117 characters: spaces, tabs and newlines. @kbd{M-\}
118 (@code{delete-horizontal-space}) deletes all the spaces and tab
119 characters before and after point. With a prefix argument, this only
120 deletes spaces and tab characters before point. @kbd{M-@key{SPC}}
121 (@code{just-one-space}) does likewise but leaves a single space before
122 point, regardless of the number of spaces that existed previously
123 (even if there were none before). With a numeric argument @var{n}, it
124 leaves @var{n} spaces before point if @var{n} is positive; if @var{n}
125 is negative, it deletes newlines in addition to spaces and tabs,
126 leaving a single space before point.
127
128 @kbd{C-x C-o} (@code{delete-blank-lines}) deletes all blank lines
129 after the current line. If the current line is blank, it deletes all
130 blank lines preceding the current line as well (leaving one blank line,
131 the current line). On a solitary blank line, it deletes that line.
132
133 @kbd{M-^} (@code{delete-indentation}) joins the current line and the
134 previous line, by deleting a newline and all surrounding spaces, usually
135 leaving a single space. @xref{Indentation,M-^}.
136
137 @node Killing by Lines
138 @subsection Killing by Lines
139
140 @table @kbd
141 @item C-k
142 Kill rest of line or one or more lines (@code{kill-line}).
143 @item C-S-backspace
144 Kill an entire line at once (@code{kill-whole-line})
145 @end table
146
147 @kindex C-k
148 @findex kill-line
149 The simplest kill command is @kbd{C-k} (@code{kill-line}). If used
150 at the end of a line, it kills the line-ending newline character,
151 merging the next line into the current one (thus, a blank line is
152 entirely removed). Otherwise, @kbd{C-k} kills all the text from point
153 up to the end of the line; if point was originally at the beginning of
154 the line, this leaves the line blank.
155
156 Spaces and tabs at the end of the line are ignored when deciding
157 which case applies. As long as point is after the last visible
158 character in the line, you can be sure that @kbd{C-k} will kill the
159 newline. To kill an entire non-blank line, go to the beginning and
160 type @kbd{C-k} twice.
161
162 In this context, ``line'' means a logical text line, not a screen
163 line (@pxref{Continuation Lines}).
164
165 When @kbd{C-k} is given a positive argument @var{n}, it kills
166 @var{n} lines and the newlines that follow them (text on the current
167 line before point is not killed). With a negative argument
168 @minus{}@var{n}, it kills @var{n} lines preceding the current line,
169 together with the text on the current line before point. @kbd{C-k}
170 with an argument of zero kills the text before point on the current
171 line.
172
173 @vindex kill-whole-line
174 If the variable @code{kill-whole-line} is non-@code{nil}, @kbd{C-k} at
175 the very beginning of a line kills the entire line including the
176 following newline. This variable is normally @code{nil}.
177
178 @kindex C-S-backspace
179 @findex kill-whole-line
180 @kbd{C-S-backspace} (@code{kill-whole-line}) kills a whole line
181 including its newline, regardless of the position of point within the
182 line. Note that many text terminals will prevent you from typing the
183 key sequence @kbd{C-S-backspace}.
184
185 @node Other Kill Commands
186 @subsection Other Kill Commands
187 @findex kill-region
188 @kindex C-w
189
190 @table @kbd
191 @item C-w
192 Kill the region (@code{kill-region}).
193 @item M-w
194 Copy the region into the kill ring (@code{kill-ring-save}).
195 @item M-d
196 Kill the next word (@code{kill-word}). @xref{Words}.
197 @item M-@key{DEL}
198 Kill one word backwards (@code{backward-kill-word}).
199 @item C-x @key{DEL}
200 Kill back to beginning of sentence (@code{backward-kill-sentence}).
201 @xref{Sentences}.
202 @item M-k
203 Kill to the end of the sentence (@code{kill-sentence}).
204 @item C-M-k
205 Kill the following balanced expression (@code{kill-sexp}). @xref{Expressions}.
206 @item M-z @var{char}
207 Kill through the next occurrence of @var{char} (@code{zap-to-char}).
208 @end table
209
210 @kindex C-w
211 @findex kill-region
212 @kindex M-w
213 @findex kill-ring-save
214 One of the commonly-used kill commands is @kbd{C-w}
215 (@code{kill-region}), which kills the text in the region
216 (@pxref{Mark}). Similarly, @kbd{M-w} (@code{kill-ring-save}) copies
217 the text in the region into the kill ring without removing it from the
218 buffer. If the mark is inactive when you type @kbd{C-w} or @kbd{M-w},
219 the command acts on the text between point and where you last set the
220 mark (@pxref{Using Region}).
221
222 Emacs also provides commands to kill specific syntactic units:
223 words, with @kbd{M-@key{DEL}} and @kbd{M-d} (@pxref{Words}); balanced
224 expressions, with @kbd{C-M-k} (@pxref{Expressions}); and sentences,
225 with @kbd{C-x @key{DEL}} and @kbd{M-k} (@pxref{Sentences}).
226
227 @kindex M-z
228 @findex zap-to-char
229 The command @kbd{M-z} (@code{zap-to-char}) combines killing with
230 searching: it reads a character and kills from point up to (and
231 including) the next occurrence of that character in the buffer. A
232 numeric argument acts as a repeat count; a negative argument means to
233 search backward and kill text before point.
234
235 @node Kill Options
236 @subsection Options for Killing
237
238 @vindex kill-read-only-ok
239 @cindex read-only text, killing
240 Some specialized buffers contain @dfn{read-only text}, which cannot
241 be modified and therefore cannot be killed. The kill commands work
242 specially in a read-only buffer: they move over text and copy it to
243 the kill ring, without actually deleting it from the buffer.
244 Normally, they also beep and display an error message when this
245 happens. But if you set the variable @code{kill-read-only-ok} to a
246 non-@code{nil} value, they just print a message in the echo area to
247 explain why the text has not been erased.
248
249 @vindex kill-do-not-save-duplicates
250 If you change the variable @code{kill-do-not-save-duplicates} to a
251 non-@code{nil} value, identical subsequent kills yield a single
252 kill-ring entry, without duplication.
253
254 @node Yanking
255 @section Yanking
256 @cindex moving text
257 @cindex copying text
258 @cindex kill ring
259 @cindex yanking
260 @cindex pasting
261
262 @dfn{Yanking} means reinserting text previously killed. The usual
263 way to move or copy text is to kill it and then yank it elsewhere.
264
265 @table @kbd
266 @item C-y
267 Yank the last kill into the buffer, at point (@code{yank}).
268 @item M-y
269 Replace the text just yanked with an earlier batch of killed text
270 (@code{yank-pop}). @xref{Earlier Kills}.
271 @item C-M-w
272 Cause the following command, if it is a kill command, to append to the
273 previous kill (@code{append-next-kill}). @xref{Appending Kills}.
274 @end table
275
276 @kindex C-y
277 @findex yank
278 The basic yanking command is @kbd{C-y} (@code{yank}). It inserts
279 the most recent kill, leaving the cursor at the end of the inserted
280 text. It also sets the mark at the beginning of the inserted text,
281 without activating the mark; this lets you jump easily to that
282 position, if you wish, with @kbd{C-u C-@key{SPC}} (@pxref{Mark Ring}).
283
284 With a plain prefix argument (@kbd{C-u C-y}), the command instead
285 leaves the cursor in front of the inserted text, and sets the mark at
286 the end. Using any other prefix argument specifies an earlier kill;
287 e.g. @kbd{C-u 4 C-y} reinserts the fourth most recent kill.
288 @xref{Earlier Kills}.
289
290 On graphical displays, @kbd{C-y} first checks if another application
291 has placed any text in the system clipboard more recently than the
292 last Emacs kill. If so, it inserts the text in the clipboard instead.
293 Thus, Emacs effectively treats ``cut'' or ``copy'' clipboard
294 operations performed in other applications like Emacs kills, except
295 that they are not recorded in the kill ring. @xref{Cut and Paste},
296 for details.
297
298 @menu
299 * Kill Ring:: Where killed text is stored.
300 * Earlier Kills:: Yanking something killed some time ago.
301 * Appending Kills:: Several kills in a row all yank together.
302 @end menu
303
304 @node Kill Ring
305 @subsection The Kill Ring
306
307 The @dfn{kill ring} is a list of blocks of text that were previously
308 killed. There is only one kill ring, shared by all buffers, so you
309 can kill text in one buffer and yank it in another buffer. This is
310 the usual way to move text from one buffer to another. (There are
311 several other methods: for instance, you could store the text in a
312 register; see @ref{Registers}. @xref{Accumulating Text}, for some
313 other ways to move text around.)
314
315 @vindex kill-ring-max
316 The maximum number of entries in the kill ring is controlled by the
317 variable @code{kill-ring-max}. The default is 60. If you make a new
318 kill when this limit has been reached, Emacs makes room by deleting
319 the oldest entry in the kill ring.
320
321 @vindex kill-ring
322 The actual contents of the kill ring are stored in a variable named
323 @code{kill-ring}; you can view the entire contents of the kill ring
324 with @kbd{C-h v kill-ring}.
325
326 @node Earlier Kills
327 @subsection Yanking Earlier Kills
328 @cindex yanking previous kills
329
330 As explained in @ref{Yanking}, you can use a numeric argument to
331 @kbd{C-y} to yank text that is no longer the most recent kill. This
332 is useful if you remember which kill ring entry you want. If you
333 don't, you can use the @kbd{M-y} (@code{yank-pop}) command to cycle
334 through the possibilities.
335
336 @kindex M-y
337 @findex yank-pop
338 If the previous command was a yank command, @kbd{M-y} takes the text
339 that was yanked and replaces it with the text from an earlier kill.
340 So, to recover the text of the next-to-the-last kill, first use
341 @kbd{C-y} to yank the last kill, and then use @kbd{M-y} to replace it
342 with the previous kill. @kbd{M-y} is allowed only after a @kbd{C-y}
343 or another @kbd{M-y}.
344
345 You can understand @kbd{M-y} in terms of a ``last yank'' pointer which
346 points at an entry in the kill ring. Each time you kill, the ``last
347 yank'' pointer moves to the newly made entry at the front of the ring.
348 @kbd{C-y} yanks the entry which the ``last yank'' pointer points to.
349 @kbd{M-y} moves the ``last yank'' pointer to a different entry, and the
350 text in the buffer changes to match. Enough @kbd{M-y} commands can move
351 the pointer to any entry in the ring, so you can get any entry into the
352 buffer. Eventually the pointer reaches the end of the ring; the next
353 @kbd{M-y} loops back around to the first entry again.
354
355 @kbd{M-y} moves the ``last yank'' pointer around the ring, but it does
356 not change the order of the entries in the ring, which always runs from
357 the most recent kill at the front to the oldest one still remembered.
358
359 @kbd{M-y} can take a numeric argument, which tells it how many entries
360 to advance the ``last yank'' pointer by. A negative argument moves the
361 pointer toward the front of the ring; from the front of the ring, it
362 moves ``around'' to the last entry and continues forward from there.
363
364 Once the text you are looking for is brought into the buffer, you can
365 stop doing @kbd{M-y} commands and it will stay there. It's just a copy
366 of the kill ring entry, so editing it in the buffer does not change
367 what's in the ring. As long as no new killing is done, the ``last
368 yank'' pointer remains at the same place in the kill ring, so repeating
369 @kbd{C-y} will yank another copy of the same previous kill.
370
371 When you call @kbd{C-y} with a numeric argument, that also sets the
372 ``last yank'' pointer to the entry that it yanks.
373
374 @node Appending Kills
375 @subsection Appending Kills
376
377 @cindex appending kills in the ring
378 Normally, each kill command pushes a new entry onto the kill ring.
379 However, two or more kill commands in a row combine their text into a
380 single entry, so that a single @kbd{C-y} yanks all the text as a unit,
381 just as it was before it was killed.
382
383 Thus, if you want to yank text as a unit, you need not kill all of it
384 with one command; you can keep killing line after line, or word after
385 word, until you have killed it all, and you can still get it all back at
386 once.
387
388 Commands that kill forward from point add onto the end of the previous
389 killed text. Commands that kill backward from point add text onto the
390 beginning. This way, any sequence of mixed forward and backward kill
391 commands puts all the killed text into one entry without rearrangement.
392 Numeric arguments do not break the sequence of appending kills. For
393 example, suppose the buffer contains this text:
394
395 @example
396 This is a line @point{}of sample text.
397 @end example
398
399 @noindent
400 with point shown by @point{}. If you type @kbd{M-d M-@key{DEL} M-d
401 M-@key{DEL}}, killing alternately forward and backward, you end up with
402 @samp{a line of sample} as one entry in the kill ring, and @samp{This
403 is@ @ text.} in the buffer. (Note the double space between @samp{is}
404 and @samp{text}, which you can clean up with @kbd{M-@key{SPC}} or
405 @kbd{M-q}.)
406
407 Another way to kill the same text is to move back two words with
408 @kbd{M-b M-b}, then kill all four words forward with @kbd{C-u M-d}.
409 This produces exactly the same results in the buffer and in the kill
410 ring. @kbd{M-f M-f C-u M-@key{DEL}} kills the same text, all going
411 backward; once again, the result is the same. The text in the kill ring
412 entry always has the same order that it had in the buffer before you
413 killed it.
414
415 @kindex C-M-w
416 @findex append-next-kill
417 If a kill command is separated from the last kill command by other
418 commands (not just numeric arguments), it starts a new entry on the kill
419 ring. But you can force it to append by first typing the command
420 @kbd{C-M-w} (@code{append-next-kill}) right before it. The @kbd{C-M-w}
421 tells the following command, if it is a kill command, to append the text
422 it kills to the last killed text, instead of starting a new entry. With
423 @kbd{C-M-w}, you can kill several separated pieces of text and
424 accumulate them to be yanked back in one place.@refill
425
426 A kill command following @kbd{M-w} (@code{kill-ring-save}) does not
427 append to the text that @kbd{M-w} copied into the kill ring.
428
429 @node Cut and Paste
430 @section ``Cut and Paste'' Operations on Graphical Displays
431 @cindex cut
432 @cindex copy
433 @cindex paste
434
435 In most graphical desktop environments, you can transfer data
436 (usually text) between different applications using a system facility
437 called the @dfn{clipboard}. On X, two other similar facilities are
438 available: the primary selection and the secondary selection. When
439 Emacs is run on a graphical display, its kill and yank commands
440 integrate with these facilities, so that you can easily transfer text
441 between Emacs and other graphical applications.
442
443 By default, Emacs uses UTF-8 as the coding system for inter-program
444 text transfers. If you find that the pasted text is not what you
445 expected, you can specify another coding system by typing @kbd{C-x
446 @key{RET} x} or @kbd{C-x @key{RET} X}. You can also request a
447 different data type by customizing @code{x-select-request-type}.
448 @xref{Communication Coding}.
449
450 @menu
451 * Clipboard:: How Emacs uses the system clipboard.
452 * Primary Selection:: The temporarily selected text selection.
453 * Secondary Selection:: Cutting without altering point and mark.
454 @end menu
455
456 @node Clipboard
457 @subsection Using the Clipboard
458 @cindex clipboard
459
460 The @dfn{clipboard} is the facility that most graphical applications
461 use for ``cutting and pasting''. When the clipboard exists, the kill
462 and yank commands in Emacs make use of it.
463
464 When you kill some text with a command such as @kbd{C-w}
465 (@code{kill-region}), or copy it to the kill ring with a command such
466 as @kbd{M-w} (@code{kill-ring-save}), that text is also put in the
467 clipboard.
468
469 @vindex save-interprogram-paste-before-kill
470 When an Emacs kill command puts text in the clipboard, the existing
471 clipboard contents are normally lost. Optionally, you can change
472 @code{save-interprogram-paste-before-kill} to @code{t}. Then Emacs
473 will first save the clipboard to its kill ring, preventing you from
474 losing the old clipboard data---at the risk of high memory consumption
475 if that data turns out to be large.
476
477 Yank commands, such as @kbd{C-y} (@code{yank}), also use the
478 clipboard. If another application ``owns'' the clipboard---i.e., if
479 you cut or copied text there more recently than your last kill command
480 in Emacs---then Emacs yanks from the clipboard instead of the kill
481 ring.
482
483 @vindex yank-pop-change-selection
484 Normally, rotating the kill ring with @kbd{M-y} (@code{yank-pop})
485 does not alter the clipboard. However, if you change
486 @code{yank-pop-change-selection} to @code{t}, then @kbd{M-y} saves the
487 new yank to the clipboard.
488
489 @vindex x-select-enable-clipboard
490 To prevent kill and yank commands from accessing the clipboard,
491 change the variable @code{x-select-enable-clipboard} to @code{nil}.
492
493 @vindex x-select-enable-primary
494 @findex clipboard-kill-region
495 @findex clipboard-kill-ring-save
496 @findex clipboard-yank
497 Prior to Emacs 24, the kill and yank commands used the primary
498 selection (@pxref{Primary Selection}), not the clipboard. If you
499 prefer this behavior, change @code{x-select-enable-clipboard} to
500 @code{nil}, @code{x-select-enable-primary} to @code{t}, and
501 @code{mouse-drag-copy-region} to @code{t}. In this case, you can use
502 the following commands to act explicitly on the clipboard:
503 @code{clipboard-kill-region} kills the region and saves it to the
504 clipboard; @code{clipboard-kill-ring-save} copies the region to the
505 kill ring and saves it to the clipboard; and @code{clipboard-yank}
506 yanks the contents of the clipboard at point.
507
508 @node Primary Selection
509 @subsection Cut and Paste with Other Window Applications
510 @cindex X cutting and pasting
511 @cindex X selection
512 @cindex primary selection
513 @cindex selection, primary
514
515 Under the X Window System, there exists a @dfn{primary selection}
516 containing the last stretch of text selected in an X application
517 (usually by dragging the mouse). Typically, this text can be inserted
518 into other X applications by @kbd{mouse-2} clicks. The primary
519 selection is separate from the clipboard. Its contents are more
520 ``fragile''; they are overwritten each time you select text with the
521 mouse, whereas the clipboard is only overwritten by explicit ``cut''
522 or ``copy'' commands.
523
524 Under X, whenever the region is active (@pxref{Mark}), the text in
525 the region is saved in the primary selection. This applies regardless
526 of whether the region was made by dragging or clicking the mouse
527 (@pxref{Mouse Commands}), or by keyboard commands (e.g. by typing
528 @kbd{C-@key{SPC}} and moving point; @pxref{Setting Mark}).
529
530 @vindex select-active-regions
531 If you change the variable @code{select-active-regions} to
532 @code{only}, Emacs saves only temporarily active regions to the
533 primary selection, i.e. those made with the mouse or with shift
534 selection (@pxref{Shift Selection}). If you change
535 @code{select-active-regions} to @code{nil}, Emacs avoids saving active
536 regions to the primary selection entirely.
537
538 To insert the primary selection into an Emacs buffer, click
539 @kbd{mouse-2} (@code{mouse-yank-primary}) where you want to insert it.
540 @xref{Mouse Commands}.
541
542 @cindex MS-Windows, and primary selection
543 MS-Windows provides no primary selection, but Emacs emulates it
544 within a single Emacs session by storing the selected text internally.
545 Therefore, all the features and commands related to the primary
546 selection work on Windows as they do on X, for cutting and pasting
547 within the same session, but not across Emacs sessions or with other
548 applications.
549
550 @node Secondary Selection
551 @subsection Secondary Selection
552 @cindex secondary selection
553
554 In addition to the primary selection, the X Window System provides a
555 second similar facility known as the @dfn{secondary selection}.
556 Nowadays, few X applications make use of the secondary selection, but
557 you can access it using the following Emacs commands:
558
559 @table @kbd
560 @findex mouse-set-secondary
561 @kindex M-Drag-Mouse-1
562 @item M-Drag-Mouse-1
563 Set the secondary selection, with one end at the place where you press
564 down the button, and the other end at the place where you release it
565 (@code{mouse-set-secondary}). The selected text is highlighted, using
566 the @code{secondary-selection} face, as you drag. The window scrolls
567 automatically if you drag the mouse off the top or bottom of the
568 window, just like @code{mouse-set-region} (@pxref{Mouse Commands}).
569
570 This command does not alter the kill ring.
571
572 @findex mouse-start-secondary
573 @kindex M-Mouse-1
574 @item M-Mouse-1
575 Set one endpoint for the @dfn{secondary selection}
576 (@code{mouse-start-secondary}).
577
578 @findex mouse-secondary-save-then-kill
579 @kindex M-Mouse-3
580 @item M-Mouse-3
581 Set the secondary selection, with one end at the position clicked and
582 the other at the position specified with @kbd{M-Mouse-1}
583 (@code{mouse-secondary-save-then-kill}). This also puts the selected
584 text in the kill ring. A second @kbd{M-Mouse-3} at the same place
585 kills the secondary selection just made.
586
587 @findex mouse-yank-secondary
588 @kindex M-Mouse-2
589 @item M-Mouse-2
590 Insert the secondary selection where you click, placing point at the
591 end of the yanked text (@code{mouse-yank-secondary}).
592 @end table
593
594 Double or triple clicking of @kbd{M-Mouse-1} operates on words and
595 lines, much like @kbd{Mouse-1}.
596
597 If @code{mouse-yank-at-point} is non-@code{nil}, @kbd{M-Mouse-2} yanks
598 at point. Then it does not matter precisely where you click, or even
599 which of the frame's windows you click on. @xref{Mouse Commands}.
600
601 @node Accumulating Text
602 @section Accumulating Text
603 @findex append-to-buffer
604 @findex prepend-to-buffer
605 @findex copy-to-buffer
606 @findex append-to-file
607
608 @cindex accumulating scattered text
609 Usually we copy or move text by killing it and yanking it, but there
610 are other convenient methods for copying one block of text in many
611 places, or for copying many scattered blocks of text into one place.
612 Here we describe the commands to accumulate scattered pieces of text
613 into a buffer or into a file.
614
615 @table @kbd
616 @item M-x append-to-buffer
617 Append region to the contents of a specified buffer.
618 @item M-x prepend-to-buffer
619 Prepend region to the contents of a specified buffer.
620 @item M-x copy-to-buffer
621 Copy region into a specified buffer, deleting that buffer's old contents.
622 @item M-x insert-buffer
623 Insert the contents of a specified buffer into current buffer at point.
624 @item M-x append-to-file
625 Append region to the contents of a specified file, at the end.
626 @end table
627
628 To accumulate text into a buffer, use @kbd{M-x append-to-buffer}.
629 This reads a buffer name, then inserts a copy of the region into the
630 buffer specified. If you specify a nonexistent buffer,
631 @code{append-to-buffer} creates the buffer. The text is inserted
632 wherever point is in that buffer. If you have been using the buffer for
633 editing, the copied text goes into the middle of the text of the buffer,
634 starting from wherever point happens to be at that moment.
635
636 Point in that buffer is left at the end of the copied text, so
637 successive uses of @code{append-to-buffer} accumulate the text in the
638 specified buffer in the same order as they were copied. Strictly
639 speaking, @code{append-to-buffer} does not always append to the text
640 already in the buffer---it appends only if point in that buffer is at
641 the end. However, if @code{append-to-buffer} is the only command you
642 use to alter a buffer, then point is always at the end.
643
644 @kbd{M-x prepend-to-buffer} is just like @code{append-to-buffer}
645 except that point in the other buffer is left before the copied text, so
646 successive prependings add text in reverse order. @kbd{M-x
647 copy-to-buffer} is similar, except that any existing text in the other
648 buffer is deleted, so the buffer is left containing just the text newly
649 copied into it.
650
651 The command @kbd{M-x insert-buffer} can be used to retrieve the
652 accumulated text from another buffer. This prompts for the name of a
653 buffer, and inserts a copy of all the text in that buffer into the
654 current buffer at point, leaving point at the beginning of the
655 inserted text. It also adds the position of the end of the inserted
656 text to the mark ring, without activating the mark. @xref{Buffers},
657 for background information on buffers.
658
659 Instead of accumulating text in a buffer, you can append text
660 directly into a file with @kbd{M-x append-to-file}. This prompts for
661 a filename, and adds the text of the region to the end of the
662 specified file. The file is changed immediately on disk.
663
664 You should use @code{append-to-file} only with files that are
665 @emph{not} being visited in Emacs. Using it on a file that you are
666 editing in Emacs would change the file behind Emacs's back, which
667 can lead to losing some of your editing.
668
669 Another way to move text around is to store it in a register.
670 @xref{Registers}.
671
672 @node Rectangles
673 @section Rectangles
674 @cindex rectangle
675 @cindex columns (and rectangles)
676 @cindex killing rectangular areas of text
677
678 @dfn{Rectangle} commands operate on rectangular areas of the text:
679 all the characters between a certain pair of columns, in a certain
680 range of lines. Emacs has commands to kill rectangles, yank killed
681 rectangles, clear them out, fill them with blanks or text, or delete
682 them. Rectangle commands are useful with text in multicolumn formats,
683 and for changing text into or out of such formats.
684
685 @cindex mark rectangle
686 To specify a rectangle for a command to work on, set the mark at one
687 corner and point at the opposite corner. The rectangle thus specified
688 is called the @dfn{region-rectangle}. If point and the mark are in
689 the same column, the region-rectangle is empty. If they are in the
690 same line, the region-rectangle is one line high.
691
692 The region-rectangle is controlled in much the same way as the
693 region is controlled. But remember that a given combination of point
694 and mark values can be interpreted either as a region or as a
695 rectangle, depending on the command that uses them.
696
697 @table @kbd
698 @item C-x r k
699 Kill the text of the region-rectangle, saving its contents as the
700 ``last killed rectangle'' (@code{kill-rectangle}).
701 @item C-x r d
702 Delete the text of the region-rectangle (@code{delete-rectangle}).
703 @item C-x r y
704 Yank the last killed rectangle with its upper left corner at point
705 (@code{yank-rectangle}).
706 @item C-x r o
707 Insert blank space to fill the space of the region-rectangle
708 (@code{open-rectangle}). This pushes the previous contents of the
709 region-rectangle to the right.
710 @item C-x r N
711 Insert line numbers along the left edge of the region-rectangle
712 (@code{rectangle-number-lines}). This pushes the previous contents of
713 the region-rectangle to the right.
714 @item C-x r c
715 Clear the region-rectangle by replacing all of its contents with spaces
716 (@code{clear-rectangle}).
717 @item M-x delete-whitespace-rectangle
718 Delete whitespace in each of the lines on the specified rectangle,
719 starting from the left edge column of the rectangle.
720 @item C-x r t @var{string} @key{RET}
721 Replace rectangle contents with @var{string} on each line
722 (@code{string-rectangle}).
723 @item M-x string-insert-rectangle @key{RET} @var{string} @key{RET}
724 Insert @var{string} on each line of the rectangle.
725 @end table
726
727 The rectangle operations fall into two classes: commands to erase or
728 insert rectangles, and commands to make blank rectangles.
729
730 @kindex C-x r k
731 @kindex C-x r d
732 @findex kill-rectangle
733 @findex delete-rectangle
734 There are two ways to erase the text in a rectangle: @kbd{C-x r d}
735 (@code{delete-rectangle}) to delete the text outright, or @kbd{C-x r
736 k} (@code{kill-rectangle}) to remove the text and save it as the
737 @dfn{last killed rectangle}. In both cases, erasing the
738 region-rectangle is like erasing the specified text on each line of
739 the rectangle; if there is any following text on the line, it moves
740 backwards to fill the gap.
741
742 ``Killing'' a rectangle is not killing in the usual sense; the
743 rectangle is not stored in the kill ring, but in a special place that
744 only records the most recent rectangle killed. This is because
745 yanking a rectangle is so different from yanking linear text that
746 different yank commands have to be used. Yank-popping is not defined
747 for rectangles.
748
749 @kindex C-x r y
750 @findex yank-rectangle
751 To yank the last killed rectangle, type @kbd{C-x r y}
752 (@code{yank-rectangle}). The rectangle's first line is inserted at
753 point, the rectangle's second line is inserted at the same horizontal
754 position one line vertically below, and so on. The number of lines
755 affected is determined by the height of the saved rectangle.
756
757 For example, you can convert two single-column lists into a
758 double-column list by killing one of the single-column lists as a
759 rectangle, and then yanking it beside the other list.
760
761 You can also copy rectangles into and out of registers with @kbd{C-x r
762 r @var{r}} and @kbd{C-x r i @var{r}}. @xref{Rectangle Registers}.
763
764 @kindex C-x r o
765 @findex open-rectangle
766 @kindex C-x r c
767 @findex clear-rectangle
768 There are two commands you can use for making blank rectangles:
769 @kbd{C-x r c} (@code{clear-rectangle}) blanks out existing text in the
770 region-rectangle, and @kbd{C-x r o} (@code{open-rectangle}) inserts a
771 blank rectangle.
772
773 @findex delete-whitespace-rectangle
774 @kbd{M-x delete-whitespace-rectangle} deletes horizontal whitespace
775 starting from a particular column. This applies to each of the lines
776 in the rectangle, and the column is specified by the left edge of the
777 rectangle. The right edge of the rectangle does not make any
778 difference to this command.
779
780 @kindex C-x r N
781 @findex rectangle
782 The command @kbd{C-x r N} (@code{rectangle-number-lines}) inserts
783 line numbers along the left edge of the region-rectangle. Normally,
784 the numbering begins from 1 (for the first line of the rectangle).
785 With a prefix argument, the command prompts for a number to begin
786 from, and for a format string with which to print the numbers
787 (@pxref{Formatting Strings,,, elisp, The Emacs Lisp Reference
788 Manual}).
789
790 @kindex C-x r t
791 @findex string-rectangle
792 The command @kbd{C-x r t} (@code{string-rectangle}) replaces the
793 contents of a region-rectangle with a string on each line. The
794 string's width need not be the same as the width of the rectangle. If
795 the string's width is less, the text after the rectangle shifts left;
796 if the string is wider than the rectangle, the text after the
797 rectangle shifts right.
798
799 @findex string-insert-rectangle
800 The command @kbd{M-x string-insert-rectangle} is similar to
801 @code{string-rectangle}, but inserts the string on each line,
802 shifting the original text to the right.
803
804 @node CUA Bindings
805 @section CUA Bindings
806 @findex cua-mode
807 @vindex cua-mode
808 @cindex CUA key bindings
809 @vindex cua-enable-cua-keys
810 The command @kbd{M-x cua-mode} sets up key bindings that are
811 compatible with the Common User Access (CUA) system used in many other
812 applications.
813
814 When CUA mode is enabled, the keys @kbd{C-x}, @kbd{C-c}, @kbd{C-v},
815 and @kbd{C-z} invoke commands that cut (kill), copy, paste (yank), and
816 undo respectively. The @kbd{C-x} and @kbd{C-c} keys perform cut and
817 copy only if the region is active. Otherwise, they still act as
818 prefix keys, so that standard Emacs commands like @kbd{C-x C-c} still
819 work. Note that this means the variable @code{mark-even-if-inactive}
820 has no effect for @kbd{C-x} and @kbd{C-c} (@pxref{Using Region}).
821
822 To enter an Emacs command like @kbd{C-x C-f} while the mark is
823 active, use one of the following methods: either hold @kbd{Shift}
824 together with the prefix key, e.g. @kbd{S-C-x C-f}, or quickly type
825 the prefix key twice, e.g. @kbd{C-x C-x C-f}.
826
827 To disable the overriding of standard Emacs binding by CUA mode,
828 while retaining the other features of CUA mode described below, set
829 the variable @code{cua-enable-cua-keys} to @code{nil}.
830
831 In CUA mode, typed text replaces the active region as in
832 Delete-Selection mode (@pxref{Mouse Commands}).
833
834 @cindex rectangle highlighting
835 CUA mode provides enhanced rectangle support with visible
836 rectangle highlighting. Use @kbd{C-RET} to start a rectangle,
837 extend it using the movement commands, and cut or copy it using
838 @kbd{C-x} or @kbd{C-c}. @kbd{RET} moves the cursor to the next
839 (clockwise) corner of the rectangle, so you can easily expand it in
840 any direction. Normal text you type is inserted to the left or right
841 of each line in the rectangle (on the same side as the cursor).
842
843 With CUA you can easily copy text and rectangles into and out of
844 registers by providing a one-digit numeric prefix to the kill, copy,
845 and yank commands, e.g. @kbd{C-1 C-c} copies the region into register
846 @code{1}, and @kbd{C-2 C-v} yanks the contents of register @code{2}.
847
848 @cindex global mark
849 CUA mode also has a global mark feature which allows easy moving and
850 copying of text between buffers. Use @kbd{C-S-SPC} to toggle the
851 global mark on and off. When the global mark is on, all text that you
852 kill or copy is automatically inserted at the global mark, and text
853 you type is inserted at the global mark rather than at the current
854 position.
855
856 For example, to copy words from various buffers into a word list in
857 a given buffer, set the global mark in the target buffer, then
858 navigate to each of the words you want in the list, mark it (e.g. with
859 @kbd{S-M-f}), copy it to the list with @kbd{C-c} or @kbd{M-w}, and
860 insert a newline after the word in the target list by pressing
861 @key{RET}.