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