killing.texi 39.9 KB
Newer Older
Dave Love's avatar
#  
Dave Love committed
1
@c This is part of the Emacs manual.
Paul Eggert's avatar
Paul Eggert committed
2
@c Copyright (C) 1985-1987, 1993-1995, 1997, 2000-2017 Free Software
3
@c Foundation, Inc.
Dave Love's avatar
#  
Dave Love committed
4 5
@c See file emacs.texi for copying conditions.

6
@node Killing
7
@chapter Killing and Moving Text
Dave Love's avatar
#  
Dave Love committed
8

9 10 11 12 13 14 15 16 17 18
  In Emacs, @dfn{killing} means erasing text and copying it into the
@dfn{kill ring}.  @dfn{Yanking} means bringing text from the kill ring
back into the buffer.  (Some applications use the terms ``cutting''
and ``pasting'' for similar operations.)  The kill ring is so-named
because it can be visualized as a set of blocks of text arranged in a
ring, which you can access in cyclic order.  @xref{Kill Ring}.

  Killing and yanking are the most common way to move or copy text
within Emacs.  It is very versatile, because there are commands for
killing many different types of syntactic units.
19

20 21 22
@menu
* Deletion and Killing:: Commands that remove text.
* Yanking::              Commands that insert text.
23
* Cut and Paste::        Clipboard and selections on graphical displays.
24 25
* Accumulating Text::    Other methods to add text to the buffer.
* 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 28 29
@end menu

@node Deletion and Killing
Dave Love's avatar
#  
Dave Love committed
30 31 32 33 34
@section Deletion and Killing

@cindex killing text
@cindex cutting text
@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 39 40 41 42 43 44 45 46
kill ring stores several recent kills, not just the last one, so
killing is a very safe operation: you don't have to worry much about
losing text that you previously killed.  The kill ring is shared by
all buffers, so text that is killed in one buffer can be yanked into
another buffer.

  When you use @kbd{C-/} (@code{undo}) to undo a kill command
(@pxref{Undo}), that brings the killed text back into the buffer, but
does not remove it from the kill ring.
47

48 49
  On graphical displays, killing text also copies it to the system
clipboard.  @xref{Cut and Paste}.
50 51

  Commands that erase text but do not save it in the kill ring are
52 53 54 55 56 57
known as @dfn{delete} commands; their names usually contain the word
@samp{delete}.  These include @kbd{C-d} (@code{delete-char}) and
@key{DEL} (@code{delete-backward-char}), which delete only one
character at a time, and those commands that delete only spaces or
newlines.  Commands that can erase significant amounts of nontrivial
data generally do a kill operation instead.
Dave Love's avatar
#  
Dave Love committed
58

59 60
  You can also use the mouse to kill and yank.  @xref{Cut and Paste}.

Dave Love's avatar
#  
Dave Love committed
61 62 63 64 65
@menu
* Deletion::            Commands for deleting small amounts of text and
                          blank areas.
* Killing by Lines::    How to kill entire lines of text at one time.
* 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.
Dave Love's avatar
#  
Dave Love committed
68 69 70 71 72 73 74
@end menu

@node Deletion
@subsection Deletion
@findex delete-backward-char
@findex delete-char

75 76 77 78
  Deletion means erasing text and not saving it in the kill ring.  For
the most part, the Emacs commands that delete text are those that
erase just one character or only whitespace.

Dave Love's avatar
#  
Dave Love committed
79 80
@table @kbd
@item @key{DEL}
81
@itemx @key{BACKSPACE}
82 83 84 85 86 87 88 89 90 91
Delete the previous character, or the text in the region if it is
active (@code{delete-backward-char}).

@item @key{Delete}
Delete the next character, or the text in the region if it is active
(@code{delete-forward-char}).

@item C-d
Delete the next character (@code{delete-char}).

Dave Love's avatar
#  
Dave Love committed
92 93 94 95 96 97 98 99 100 101 102 103
@item M-\
Delete spaces and tabs around point (@code{delete-horizontal-space}).
@item M-@key{SPC}
Delete spaces and tabs around point, leaving one space
(@code{just-one-space}).
@item C-x C-o
Delete blank lines around the current line (@code{delete-blank-lines}).
@item M-^
Join two lines by deleting the intervening newline, along with any
indentation following it (@code{delete-indentation}).
@end table

104 105 106 107
  We have already described the basic deletion commands @key{DEL}
(@code{delete-backward-char}), @key{delete}
(@code{delete-forward-char}), and @kbd{C-d} (@code{delete-char}).
@xref{Erasing}.  With a numeric argument, they delete the specified
Xue Fuqiao's avatar
Xue Fuqiao committed
108 109 110
number of characters.  If the numeric argument is omitted or one,
@key{DEL} and @key{delete} delete all the text in the region if it is
active (@pxref{Using Region}).
111

Dave Love's avatar
#  
Dave Love committed
112 113 114 115
@kindex M-\
@findex delete-horizontal-space
@kindex M-SPC
@findex just-one-space
Glenn Morris's avatar
Glenn Morris committed
116
@findex cycle-spacing
117
  The other delete commands are those that delete only whitespace
Dave Love's avatar
#  
Dave Love committed
118 119
characters: spaces, tabs and newlines.  @kbd{M-\}
(@code{delete-horizontal-space}) deletes all the spaces and tab
120 121
characters before and after point.  With a prefix argument, this only
deletes spaces and tab characters before point.  @kbd{M-@key{SPC}}
Chong Yidong's avatar
Chong Yidong committed
122
(@code{just-one-space}) does likewise but leaves a single space before
123 124
point, regardless of the number of spaces that existed previously
(even if there were none before).  With a numeric argument @var{n}, it
Chong Yidong's avatar
Chong Yidong committed
125 126
leaves @var{n} spaces before point if @var{n} is positive; if @var{n}
is negative, it deletes newlines in addition to spaces and tabs,
Glenn Morris's avatar
Glenn Morris committed
127 128 129 130 131
leaving @var{-n} spaces before point.  The command @code{cycle-spacing}
acts like a more flexible version of @code{just-one-space}.  It
does different things if you call it repeatedly in succession.
The first call acts like @code{just-one-space}, the next removes
all whitespace, and a third call restores the original whitespace.
Dave Love's avatar
#  
Dave Love committed
132 133 134 135

  @kbd{C-x C-o} (@code{delete-blank-lines}) deletes all blank lines
after the current line.  If the current line is blank, it deletes all
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.
Dave Love's avatar
#  
Dave Love committed
137 138 139 140 141

  @kbd{M-^} (@code{delete-indentation}) joins the current line and the
previous line, by deleting a newline and all surrounding spaces, usually
leaving a single space.  @xref{Indentation,M-^}.

142 143 144 145 146 147 148 149 150 151 152
@c Not really sure where to put this...
@findex delete-duplicate-lines
  The command @code{delete-duplicate-lines} searches the region for
identical lines, and removes all but one copy of each.  Normally it
keeps the first instance of each repeated line, but with a @kbd{C-u}
prefix argument it keeps the last.  With a @kbd{C-u C-u} prefix
argument, it only searches for adjacent identical lines.  This is a
more efficient mode of operation, useful when the lines have already
been sorted.  With a @kbd{C-u C-u C-u} prefix argument, it retains
repeated blank lines.

Dave Love's avatar
#  
Dave Love committed
153 154 155 156 157 158
@node Killing by Lines
@subsection Killing by Lines

@table @kbd
@item C-k
Kill rest of line or one or more lines (@code{kill-line}).
159 160
@item C-S-backspace
Kill an entire line at once (@code{kill-whole-line})
Dave Love's avatar
#  
Dave Love committed
161 162 163 164
@end table

@kindex C-k
@findex kill-line
165 166 167 168 169 170 171 172 173
  The simplest kill command is @kbd{C-k} (@code{kill-line}).  If used
at the end of a line, it kills the line-ending newline character,
merging the next line into the current one (thus, a blank line is
entirely removed).  Otherwise, @kbd{C-k} kills all the text from point
up to the end of the line; if point was originally at the beginning of
the line, this leaves the line blank.

  Spaces and tabs at the end of the line are ignored when deciding
which case applies.  As long as point is after the last visible
174 175 176 177
character in the line, you can be sure that @kbd{C-k} will kill the
newline.  To kill an entire non-blank line, go to the beginning and
type @kbd{C-k} twice.

178 179 180
  In this context, ``line'' means a logical text line, not a screen
line (@pxref{Continuation Lines}).

181 182 183 184 185 186 187
  When @kbd{C-k} is given a positive argument @var{n}, it kills
@var{n} lines and the newlines that follow them (text on the current
line before point is not killed).  With a negative argument
@minus{}@var{n}, it kills @var{n} lines preceding the current line,
together with the text on the current line before point.  @kbd{C-k}
with an argument of zero kills the text before point on the current
line.
Dave Love's avatar
#  
Dave Love committed
188 189 190 191 192 193

@vindex kill-whole-line
  If the variable @code{kill-whole-line} is non-@code{nil}, @kbd{C-k} at
the very beginning of a line kills the entire line including the
following newline.  This variable is normally @code{nil}.

194 195
@kindex C-S-backspace
@findex kill-whole-line
196 197 198 199
  @kbd{C-S-backspace} (@code{kill-whole-line}) kills a whole line
including its newline, regardless of the position of point within the
line.  Note that many text terminals will prevent you from typing the
key sequence @kbd{C-S-backspace}.
200

Dave Love's avatar
#  
Dave Love committed
201 202 203 204 205 206 207
@node Other Kill Commands
@subsection Other Kill Commands
@findex kill-region
@kindex C-w

@table @kbd
@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}).
Dave Love's avatar
#  
Dave Love committed
211
@item M-d
212
Kill the next word (@code{kill-word}).  @xref{Words}.
Dave Love's avatar
#  
Dave Love committed
213
@item M-@key{DEL}
214
Kill one word backwards (@code{backward-kill-word}).
Dave Love's avatar
#  
Dave Love committed
215 216 217 218
@item C-x @key{DEL}
Kill back to beginning of sentence (@code{backward-kill-sentence}).
@xref{Sentences}.
@item M-k
219
Kill to the end of the sentence (@code{kill-sentence}).
Dave Love's avatar
#  
Dave Love committed
220
@item C-M-k
221
Kill the following balanced expression (@code{kill-sexp}).  @xref{Expressions}.
Dave Love's avatar
#  
Dave Love committed
222 223 224 225
@item M-z @var{char}
Kill through the next occurrence of @var{char} (@code{zap-to-char}).
@end table

226 227
@kindex C-w
@findex kill-region
228 229
@kindex M-w
@findex kill-ring-save
230 231 232 233 234 235 236
  One of the commonly-used kill commands is @kbd{C-w}
(@code{kill-region}), which kills the text in the region
(@pxref{Mark}).  Similarly, @kbd{M-w} (@code{kill-ring-save}) copies
the text in the region into the kill ring without removing it from the
buffer.  If the mark is inactive when you type @kbd{C-w} or @kbd{M-w},
the command acts on the text between point and where you last set the
mark (@pxref{Using Region}).
237 238 239 240 241

  Emacs also provides commands to kill specific syntactic units:
words, with @kbd{M-@key{DEL}} and @kbd{M-d} (@pxref{Words}); balanced
expressions, with @kbd{C-M-k} (@pxref{Expressions}); and sentences,
with @kbd{C-x @key{DEL}} and @kbd{M-k} (@pxref{Sentences}).
Dave Love's avatar
#  
Dave Love committed
242 243 244

@kindex M-z
@findex zap-to-char
245 246
  The command @kbd{M-z} (@code{zap-to-char}) combines killing with
searching: it reads a character and kills from point up to (and
Dave Love's avatar
#  
Dave Love committed
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
Dave Love's avatar
#  
Dave Love committed
249 250
search backward and kill text before point.

251 252 253 254 255 256
@node Kill Options
@subsection Options for Killing

@vindex kill-read-only-ok
@cindex read-only text, killing
  Some specialized buffers contain @dfn{read-only text}, which cannot
257 258
be modified and therefore cannot be killed.  The kill commands work
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 262 263 264 265 266 267 268 269
happens.  But if you set the variable @code{kill-read-only-ok} to a
non-@code{nil} value, they just print a message in the echo area to
explain why the text has not been erased.

@vindex kill-do-not-save-duplicates
  If you change the variable @code{kill-do-not-save-duplicates} to a
non-@code{nil} value, identical subsequent kills yield a single
kill-ring entry, without duplication.

270
@node Yanking
Dave Love's avatar
#  
Dave Love committed
271 272 273 274 275 276 277
@section Yanking
@cindex moving text
@cindex copying text
@cindex kill ring
@cindex yanking
@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.
Dave Love's avatar
#  
Dave Love committed
280 281 282

@table @kbd
@item C-y
283
Yank the last kill into the buffer, at point (@code{yank}).
Dave Love's avatar
#  
Dave Love committed
284
@item M-y
285 286
Replace the text just yanked with an earlier batch of killed text
(@code{yank-pop}).  @xref{Earlier Kills}.
Dave Love's avatar
#  
Dave Love committed
287
@item C-M-w
288 289
Cause the following command, if it is a kill command, to append to the
previous kill (@code{append-next-kill}).  @xref{Appending Kills}.
Dave Love's avatar
#  
Dave Love committed
290 291
@end table

292 293 294 295 296 297 298 299 300 301 302
@kindex C-y
@findex yank
  The basic yanking command is @kbd{C-y} (@code{yank}).  It inserts
the most recent kill, leaving the cursor at the end of the inserted
text.  It also sets the mark at the beginning of the inserted text,
without activating the mark; this lets you jump easily to that
position, if you wish, with @kbd{C-u C-@key{SPC}} (@pxref{Mark Ring}).

  With a plain prefix argument (@kbd{C-u C-y}), the command instead
leaves the cursor in front of the inserted text, and sets the mark at
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 305 306 307
@xref{Earlier Kills}.

  On graphical displays, @kbd{C-y} first checks if another application
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 311 312
operations performed in other applications like Emacs kills, except
that they are not recorded in the kill ring.  @xref{Cut and Paste},
for details.
313

Dave Love's avatar
#  
Dave Love committed
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.
Dave Love's avatar
#  
Dave Love committed
318 319 320 321 322
@end menu

@node Kill Ring
@subsection The Kill Ring

323 324 325
  The @dfn{kill ring} is a list of blocks of text that were previously
killed.  There is only one kill ring, shared by all buffers, so you
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 328 329
several other methods: for instance, you could store the text in a
register; see @ref{Registers}.  @xref{Accumulating Text}, for some
other ways to move text around.)
Dave Love's avatar
#  
Dave Love committed
330

331 332 333 334 335
@vindex kill-ring-max
  The maximum number of entries in the kill ring is controlled by the
variable @code{kill-ring-max}.  The default is 60.  If you make a new
kill when this limit has been reached, Emacs makes room by deleting
the oldest entry in the kill ring.
336

337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
@vindex kill-ring
  The actual contents of the kill ring are stored in a variable named
@code{kill-ring}; you can view the entire contents of the kill ring
with @kbd{C-h v kill-ring}.

@node Earlier Kills
@subsection Yanking Earlier Kills
@cindex yanking previous kills

  As explained in @ref{Yanking}, you can use a numeric argument to
@kbd{C-y} to yank text that is no longer the most recent kill.  This
is useful if you remember which kill ring entry you want.  If you
don't, you can use the @kbd{M-y} (@code{yank-pop}) command to cycle
through the possibilities.

@kindex M-y
@findex yank-pop
  If the previous command was a yank command, @kbd{M-y} takes the text
that was yanked and replaces it with the text from an earlier kill.
So, to recover the text of the next-to-the-last kill, first use
@kbd{C-y} to yank the last kill, and then use @kbd{M-y} to replace it
with the previous kill.  @kbd{M-y} is allowed only after a @kbd{C-y}
or another @kbd{M-y}.

Paul Eggert's avatar
Paul Eggert committed
361 362 363 364 365
  You can understand @kbd{M-y} in terms of a last-yank pointer which
points at an entry in the kill ring.  Each time you kill, the last-yank
pointer moves to the newly made entry at the front of the ring.
@kbd{C-y} yanks the entry which the last-yank pointer points to.
@kbd{M-y} moves the last-yank pointer to a different entry, and the
366 367 368 369 370
text in the buffer changes to match.  Enough @kbd{M-y} commands can move
the pointer to any entry in the ring, so you can get any entry into the
buffer.  Eventually the pointer reaches the end of the ring; the next
@kbd{M-y} loops back around to the first entry again.

Paul Eggert's avatar
Paul Eggert committed
371
  @kbd{M-y} moves the last-yank pointer around the ring, but it does
372 373 374 375
not change the order of the entries in the ring, which always runs from
the most recent kill at the front to the oldest one still remembered.

  @kbd{M-y} can take a numeric argument, which tells it how many entries
Paul Eggert's avatar
Paul Eggert committed
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
Paul Eggert's avatar
Paul Eggert committed
378
moves around to the last entry and continues forward from there.
379 380 381 382

  Once the text you are looking for is brought into the buffer, you can
stop doing @kbd{M-y} commands and it will stay there.  It's just a copy
of the kill ring entry, so editing it in the buffer does not change
Paul Eggert's avatar
Paul Eggert committed
383 384
what's in the ring.  As long as no new killing is done, the last-yank
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.
386

387
  When you call @kbd{C-y} with a numeric argument, that also sets the
Paul Eggert's avatar
Paul Eggert committed
388
last-yank pointer to the entry that it yanks.
Dave Love's avatar
#  
Dave Love committed
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417

@node Appending Kills
@subsection Appending Kills

@cindex appending kills in the ring
  Normally, each kill command pushes a new entry onto the kill ring.
However, two or more kill commands in a row combine their text into a
single entry, so that a single @kbd{C-y} yanks all the text as a unit,
just as it was before it was killed.

  Thus, if you want to yank text as a unit, you need not kill all of it
with one command; you can keep killing line after line, or word after
word, until you have killed it all, and you can still get it all back at
once.

  Commands that kill forward from point add onto the end of the previous
killed text.  Commands that kill backward from point add text onto the
beginning.  This way, any sequence of mixed forward and backward kill
commands puts all the killed text into one entry without rearrangement.
Numeric arguments do not break the sequence of appending kills.  For
example, suppose the buffer contains this text:

@example
This is a line @point{}of sample text.
@end example

@noindent
with point shown by @point{}.  If you type @kbd{M-d M-@key{DEL} M-d
M-@key{DEL}}, killing alternately forward and backward, you end up with
418 419 420 421
@samp{a line of sample} as one entry in the kill ring, and
@w{@samp{This is@ @ text.}} in the buffer.  (Note the double space
between @samp{is} and @samp{text}, which you can clean up with
@kbd{M-@key{SPC}} or @kbd{M-q}.)
Dave Love's avatar
#  
Dave Love committed
422 423 424 425 426 427 428 429 430 431 432 433

  Another way to kill the same text is to move back two words with
@kbd{M-b M-b}, then kill all four words forward with @kbd{C-u M-d}.
This produces exactly the same results in the buffer and in the kill
ring.  @kbd{M-f M-f C-u M-@key{DEL}} kills the same text, all going
backward; once again, the result is the same.  The text in the kill ring
entry always has the same order that it had in the buffer before you
killed it.

@kindex C-M-w
@findex append-next-kill
  If a kill command is separated from the last kill command by other
434 435 436 437 438 439 440 441 442
commands (not just numeric arguments), it starts a new entry on the
kill ring.  But you can force it to combine with the last killed text,
by typing @kbd{C-M-w} (@code{append-next-kill}) right beforehand.  The
@kbd{C-M-w} tells its following command, if it is a kill command, to
treat the kill as part of the sequence of previous kills.  As usual,
the kill is appended to the previous killed text if the command kills
forward, and prepended if the command kills backward.  In this way,
you can kill several separated pieces of text and accumulate them to
be yanked back in one place.
Dave Love's avatar
#  
Dave Love committed
443

444 445
  A kill command following @kbd{M-w} (@code{kill-ring-save}) does not
append to the text that @kbd{M-w} copied into the kill ring.
Dave Love's avatar
#  
Dave Love committed
446

447
@node Cut and Paste
448
@section ``Cut and Paste'' Operations on Graphical Displays
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
@cindex cut
@cindex copy
@cindex paste

  In most graphical desktop environments, you can transfer data
(usually text) between different applications using a system facility
called the @dfn{clipboard}.  On X, two other similar facilities are
available: the primary selection and the secondary selection.  When
Emacs is run on a graphical display, its kill and yank commands
integrate with these facilities, so that you can easily transfer text
between Emacs and other graphical applications.

  By default, Emacs uses UTF-8 as the coding system for inter-program
text transfers.  If you find that the pasted text is not what you
expected, you can specify another coding system by typing @kbd{C-x
@key{RET} x} or @kbd{C-x @key{RET} X}.  You can also request a
different data type by customizing @code{x-select-request-type}.
@xref{Communication Coding}.

@menu
* Clipboard::           How Emacs uses the system clipboard.
* Primary Selection::   The temporarily selected text selection.
* Secondary Selection:: Cutting without altering point and mark.
@end menu

@node Clipboard
@subsection Using the Clipboard
@cindex clipboard

  The @dfn{clipboard} is the facility that most graphical applications
479
use for ``cutting and pasting''.  When the clipboard exists, the kill
480 481 482 483 484
and yank commands in Emacs make use of it.

  When you kill some text with a command such as @kbd{C-w}
(@code{kill-region}), or copy it to the kill ring with a command such
as @kbd{M-w} (@code{kill-ring-save}), that text is also put in the
485
clipboard.
486 487 488 489 490 491 492 493 494

@vindex save-interprogram-paste-before-kill
  When an Emacs kill command puts text in the clipboard, the existing
clipboard contents are normally lost.  Optionally, you can change
@code{save-interprogram-paste-before-kill} to @code{t}.  Then Emacs
will first save the clipboard to its kill ring, preventing you from
losing the old clipboard data---at the risk of high memory consumption
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 498 499
you cut or copied text there more recently than your last kill command
in Emacs---then Emacs yanks from the clipboard instead of the kill
ring.
500 501 502 503 504 505 506

@vindex yank-pop-change-selection
  Normally, rotating the kill ring with @kbd{M-y} (@code{yank-pop})
does not alter the clipboard.  However, if you change
@code{yank-pop-change-selection} to @code{t}, then @kbd{M-y} saves the
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}.
510 511 512 513 514

@cindex clipboard manager
@vindex x-select-enable-clipboard-manager
  Many X desktop environments support a feature called the
@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 517 518 519 520
running, Emacs transfers the clipboard data to the clipboard manager
so that it is not lost.  In some circumstances, this may cause a delay
when exiting Emacs; if you wish to prevent Emacs from transferring
data to the clipboard manager, change the variable
@code{x-select-enable-clipboard-manager} to @code{nil}.
521

522 523
  Since strings containing NUL bytes are usually truncated when passed
through the clipboard, Emacs replaces such characters with ``\0''
Paul Eggert's avatar
Paul Eggert committed
524
before transferring them to the system's clipboard.
525

526
@vindex select-enable-primary
527 528 529 530 531
@findex clipboard-kill-region
@findex clipboard-kill-ring-save
@findex clipboard-yank
  Prior to Emacs 24, the kill and yank commands used the primary
selection (@pxref{Primary Selection}), not the clipboard.  If you
532 533
prefer this behavior, change @code{select-enable-clipboard} to
@code{nil}, @code{select-enable-primary} to @code{t}, and
534 535 536 537 538 539 540 541 542 543 544 545 546 547
@code{mouse-drag-copy-region} to @code{t}.  In this case, you can use
the following commands to act explicitly on the clipboard:
@code{clipboard-kill-region} kills the region and saves it to the
clipboard; @code{clipboard-kill-ring-save} copies the region to the
kill ring and saves it to the clipboard; and @code{clipboard-yank}
yanks the contents of the clipboard at point.

@node Primary Selection
@subsection Cut and Paste with Other Window Applications
@cindex X cutting and pasting
@cindex X selection
@cindex primary selection
@cindex selection, primary

548
  Under the X Window System, there exists a @dfn{primary selection}
549 550 551
containing the last stretch of text selected in an X application
(usually by dragging the mouse).  Typically, this text can be inserted
into other X applications by @kbd{mouse-2} clicks.  The primary
552
selection is separate from the clipboard.  Its contents are more
Paul Eggert's avatar
Paul Eggert committed
553 554 555
fragile; they are overwritten each time you select text with the
mouse, whereas the clipboard is only overwritten by explicit cut
or copy commands.
556

557 558 559
  Under X, whenever the region is active (@pxref{Mark}), the text in
the region is saved in the primary selection.  This applies regardless
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}).
562 563

@vindex select-active-regions
564 565
  If you change the variable @code{select-active-regions} to
@code{only}, Emacs saves only temporarily active regions to the
566
primary selection, i.e., those made with the mouse or with shift
567 568 569
selection (@pxref{Shift Selection}).  If you change
@code{select-active-regions} to @code{nil}, Emacs avoids saving active
regions to the primary selection entirely.
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593

  To insert the primary selection into an Emacs buffer, click
@kbd{mouse-2} (@code{mouse-yank-primary}) where you want to insert it.
@xref{Mouse Commands}.

@cindex MS-Windows, and primary selection
  MS-Windows provides no primary selection, but Emacs emulates it
within a single Emacs session by storing the selected text internally.
Therefore, all the features and commands related to the primary
selection work on Windows as they do on X, for cutting and pasting
within the same session, but not across Emacs sessions or with other
applications.

@node Secondary Selection
@subsection Secondary Selection
@cindex secondary selection

  In addition to the primary selection, the X Window System provides a
second similar facility known as the @dfn{secondary selection}.
Nowadays, few X applications make use of the secondary selection, but
you can access it using the following Emacs commands:

@table @kbd
@findex mouse-set-secondary
594
@kindex M-Drag-mouse-1
595
@cindex secondary-selection face
596
@item M-Drag-mouse-1
597 598 599 600 601 602 603 604 605 606
Set the secondary selection, with one end at the place where you press
down the button, and the other end at the place where you release it
(@code{mouse-set-secondary}).  The selected text is highlighted, using
the @code{secondary-selection} face, as you drag.  The window scrolls
automatically if you drag the mouse off the top or bottom of the
window, just like @code{mouse-set-region} (@pxref{Mouse Commands}).

This command does not alter the kill ring.

@findex mouse-start-secondary
607 608
@kindex M-mouse-1
@item M-mouse-1
609 610 611 612
Set one endpoint for the @dfn{secondary selection}
(@code{mouse-start-secondary}).

@findex mouse-secondary-save-then-kill
613 614
@kindex M-mouse-3
@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 620 621
kills the secondary selection just made.

@findex mouse-yank-secondary
622 623
@kindex M-mouse-2
@item M-mouse-2
624 625 626 627
Insert the secondary selection where you click, placing point at the
end of the yanked text (@code{mouse-yank-secondary}).
@end table

628 629
Double or triple clicking of @kbd{M-mouse-1} operates on words and
lines, much like @kbd{mouse-1}.
630

631
If @code{mouse-yank-at-point} is non-@code{nil}, @kbd{M-mouse-2} yanks
632 633 634
at point.  Then it does not matter precisely where you click, or even
which of the frame's windows you click on.  @xref{Mouse Commands}.

635
@node Accumulating Text
Dave Love's avatar
#  
Dave Love committed
636 637 638 639 640 641 642 643
@section Accumulating Text
@findex append-to-buffer
@findex prepend-to-buffer
@findex copy-to-buffer
@findex append-to-file

@cindex accumulating scattered text
  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 646 647
places, or for copying many scattered blocks of text into one place.
Here we describe the commands to accumulate scattered pieces of text
into a buffer or into a file.
Dave Love's avatar
#  
Dave Love committed
648 649 650

@table @kbd
@item M-x append-to-buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
651
Append region to the contents of a specified buffer.
Dave Love's avatar
#  
Dave Love committed
652
@item M-x prepend-to-buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
653
Prepend region to the contents of a specified buffer.
Dave Love's avatar
#  
Dave Love committed
654
@item M-x copy-to-buffer
655
Copy region into a specified buffer, deleting that buffer's old contents.
Dave Love's avatar
#  
Dave Love committed
656
@item M-x insert-buffer
Richard M. Stallman's avatar
Richard M. Stallman committed
657
Insert the contents of a specified buffer into current buffer at point.
Dave Love's avatar
#  
Dave Love committed
658
@item M-x append-to-file
Richard M. Stallman's avatar
Richard M. Stallman committed
659
Append region to the contents of a specified file, at the end.
Dave Love's avatar
#  
Dave Love committed
660 661 662 663 664 665 666 667
@end table

  To accumulate text into a buffer, use @kbd{M-x append-to-buffer}.
This reads a buffer name, then inserts a copy of the region into the
buffer specified.  If you specify a nonexistent buffer,
@code{append-to-buffer} creates the buffer.  The text is inserted
wherever point is in that buffer.  If you have been using the buffer for
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.
Dave Love's avatar
#  
Dave Love committed
669 670 671 672 673

  Point in that buffer is left at the end of the copied text, so
successive uses of @code{append-to-buffer} accumulate the text in the
specified buffer in the same order as they were copied.  Strictly
speaking, @code{append-to-buffer} does not always append to the text
674 675 676
already in the buffer---it appends only if point in that buffer is at
the end.  However, if @code{append-to-buffer} is the only command you
use to alter a buffer, then point is always at the end.
Dave Love's avatar
#  
Dave Love committed
677 678 679 680

  @kbd{M-x prepend-to-buffer} is just like @code{append-to-buffer}
except that point in the other buffer is left before the copied text, so
successive prependings add text in reverse order.  @kbd{M-x
681
copy-to-buffer} is similar, except that any existing text in the other
Dave Love's avatar
#  
Dave Love committed
682 683 684
buffer is deleted, so the buffer is left containing just the text newly
copied into it.

685 686 687 688 689 690 691
  The command @kbd{M-x insert-buffer} can be used to retrieve the
accumulated text from another buffer.  This prompts for the name of a
buffer, and inserts a copy of all the text in that buffer into the
current buffer at point, leaving point at the beginning of the
inserted text.  It also adds the position of the end of the inserted
text to the mark ring, without activating the mark.  @xref{Buffers},
for background information on buffers.
Dave Love's avatar
#  
Dave Love committed
692

693 694 695 696
  Instead of accumulating text in a buffer, you can append text
directly into a file with @kbd{M-x append-to-file}.  This prompts for
a filename, and adds the text of the region to the end of the
specified file.  The file is changed immediately on disk.
Dave Love's avatar
#  
Dave Love committed
697 698 699 700 701 702

  You should use @code{append-to-file} only with files that are
@emph{not} being visited in Emacs.  Using it on a file that you are
editing in Emacs would change the file behind Emacs's back, which
can lead to losing some of your editing.

703 704 705
  Another way to move text around is to store it in a register.
@xref{Registers}.

706
@node Rectangles
Dave Love's avatar
#  
Dave Love committed
707 708 709 710 711
@section Rectangles
@cindex rectangle
@cindex columns (and rectangles)
@cindex killing rectangular areas of text

712 713 714 715 716 717
  @dfn{Rectangle} commands operate on rectangular areas of the text:
all the characters between a certain pair of columns, in a certain
range of lines.  Emacs has commands to kill rectangles, yank killed
rectangles, clear them out, fill them with blanks or text, or delete
them.  Rectangle commands are useful with text in multicolumn formats,
and for changing text into or out of such formats.
Dave Love's avatar
#  
Dave Love committed
718

719
@cindex mark rectangle
720 721 722 723 724 725 726 727 728 729
  To specify a rectangle for a command to work on, set the mark at one
corner and point at the opposite corner.  The rectangle thus specified
is called the @dfn{region-rectangle}.  If point and the mark are in
the same column, the region-rectangle is empty.  If they are in the
same line, the region-rectangle is one line high.

  The region-rectangle is controlled in much the same way as the
region is controlled.  But remember that a given combination of point
and mark values can be interpreted either as a region or as a
rectangle, depending on the command that uses them.
Dave Love's avatar
#  
Dave Love committed
730 731 732

@table @kbd
@item C-x r k
733
Kill the text of the region-rectangle, saving its contents as the
Paul Eggert's avatar
Paul Eggert committed
734
last killed rectangle (@code{kill-rectangle}).
735
@item C-x r M-w
Paul Eggert's avatar
Paul Eggert committed
736
Save the text of the region-rectangle as the last killed rectangle
737
(@code{copy-rectangle-as-kill}).
Dave Love's avatar
#  
Dave Love committed
738 739 740 741 742 743 744 745
@item C-x r d
Delete the text of the region-rectangle (@code{delete-rectangle}).
@item C-x r y
Yank the last killed rectangle with its upper left corner at point
(@code{yank-rectangle}).
@item C-x r o
Insert blank space to fill the space of the region-rectangle
(@code{open-rectangle}).  This pushes the previous contents of the
746 747 748 749 750
region-rectangle to the right.
@item C-x r N
Insert line numbers along the left edge of the region-rectangle
(@code{rectangle-number-lines}).  This pushes the previous contents of
the region-rectangle to the right.
751
@item C-x r c
Karl Berry's avatar
Karl Berry committed
752
Clear the region-rectangle by replacing all of its contents with spaces
753
(@code{clear-rectangle}).
Dave Love's avatar
#  
Dave Love committed
754 755 756
@item M-x delete-whitespace-rectangle
Delete whitespace in each of the lines on the specified rectangle,
starting from the left edge column of the rectangle.
Gerd Moellmann's avatar
Gerd Moellmann committed
757
@item C-x r t @var{string} @key{RET}
Karl Berry's avatar
Karl Berry committed
758
Replace rectangle contents with @var{string} on each line
Dave Love's avatar
#  
Dave Love committed
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 763 764 765
@item C-x @key{SPC}
Toggle Rectangle Mark mode (@code{rectangle-mark-mode}).
When this mode is active, the region-rectangle is highlighted and can
be shrunk/grown, and the standard kill and yank commands operate on it.
Dave Love's avatar
#  
Dave Love committed
766 767
@end table

768 769
  The rectangle operations fall into two classes: commands to erase or
insert rectangles, and commands to make blank rectangles.
Dave Love's avatar
#  
Dave Love committed
770 771 772 773 774

@kindex C-x r k
@kindex C-x r d
@findex kill-rectangle
@findex delete-rectangle
775 776
  There are two ways to erase the text in a rectangle: @kbd{C-x r d}
(@code{delete-rectangle}) to delete the text outright, or @kbd{C-x r
Juanma Barranquero's avatar
Juanma Barranquero committed
777
k} (@code{kill-rectangle}) to remove the text and save it as the
778 779
@dfn{last killed rectangle}.  In both cases, erasing the
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 782
backwards to fill the gap.

Paul Eggert's avatar
Paul Eggert committed
783
  Killing a rectangle is not killing in the usual sense; the
Dave Love's avatar
#  
Dave Love committed
784
rectangle is not stored in the kill ring, but in a special place that
785 786 787 788
only records the most recent rectangle killed.  This is because
yanking a rectangle is so different from yanking linear text that
different yank commands have to be used.  Yank-popping is not defined
for rectangles.
Dave Love's avatar
#  
Dave Love committed
789

790 791 792
@kindex C-x r M-w
@findex copy-rectangle-as-kill
  @kbd{C-x r M-w} (@code{copy-rectangle-as-kill}) is the equivalent of
Paul Eggert's avatar
Paul Eggert committed
793 794
@kbd{M-w} for rectangles: it records the rectangle as the last
killed rectangle, without deleting the text from the buffer.
795

Dave Love's avatar
#  
Dave Love committed
796 797 798
@kindex C-x r y
@findex yank-rectangle
  To yank the last killed rectangle, type @kbd{C-x r y}
799 800 801 802 803 804 805 806
(@code{yank-rectangle}).  The rectangle's first line is inserted at
point, the rectangle's second line is inserted at the same horizontal
position one line vertically below, and so on.  The number of lines
affected is determined by the height of the saved rectangle.

  For example, you can convert two single-column lists into a
double-column list by killing one of the single-column lists as a
rectangle, and then yanking it beside the other list.
Dave Love's avatar
#  
Dave Love committed
807 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}.
Dave Love's avatar
#  
Dave Love committed
810 811 812

@kindex C-x r o
@findex open-rectangle
813
@kindex C-x r c
Dave Love's avatar
#  
Dave Love committed
814 815
@findex clear-rectangle
  There are two commands you can use for making blank rectangles:
816 817 818
@kbd{C-x r c} (@code{clear-rectangle}) blanks out existing text in the
region-rectangle, and @kbd{C-x r o} (@code{open-rectangle}) inserts a
blank rectangle.
Dave Love's avatar
#  
Dave Love committed
819 820

@findex delete-whitespace-rectangle
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
  @kbd{M-x delete-whitespace-rectangle} deletes horizontal whitespace
starting from a particular column.  This applies to each of the lines
in the rectangle, and the column is specified by the left edge of the
rectangle.  The right edge of the rectangle does not make any
difference to this command.

@kindex C-x r N
@findex rectangle
  The command @kbd{C-x r N} (@code{rectangle-number-lines}) inserts
line numbers along the left edge of the region-rectangle.  Normally,
the numbering begins from 1 (for the first line of the rectangle).
With a prefix argument, the command prompts for a number to begin
from, and for a format string with which to print the numbers
(@pxref{Formatting Strings,,, elisp, The Emacs Lisp Reference
Manual}).
Dave Love's avatar
#  
Dave Love committed
836 837 838

@kindex C-x r t
@findex string-rectangle
839
  The command @kbd{C-x r t} (@code{string-rectangle}) replaces the
840 841 842 843 844 845 846
contents of a region-rectangle with a string on each line.  The
string's width need not be the same as the width of the rectangle.  If
the string's width is less, the text after the rectangle shifts left;
if the string is wider than the rectangle, the text after the
rectangle shifts right.

@findex string-insert-rectangle
847 848
  The command @kbd{M-x string-insert-rectangle} is similar to
@code{string-rectangle}, but inserts the string on each line,
849
shifting the original text to the right.
Miles Bader's avatar
Miles Bader committed
850

Xue Fuqiao's avatar
Xue Fuqiao committed
851
@findex rectangle-mark-mode
852 853 854
  The command @kbd{C-x @key{SPC}} (@code{rectangle-mark-mode}) toggles
whether the region-rectangle or the standard region is highlighted
(first activating the region if necessary).  When this mode is enabled,
Paul Eggert's avatar
Paul Eggert committed
855
commands that resize the region (@kbd{C-f}, @kbd{C-n} etc.)@: do
856 857 858
so in a rectangular fashion, and killing and yanking operate on the
rectangle.  @xref{Killing}.  The mode persists only as long as the
region is active.
Xue Fuqiao's avatar
Xue Fuqiao committed
859

860 861 862 863 864 865 866 867 868 869 870 871 872
Unlike the standard region, the region-rectangle can have its corners
extended past the end of buffer, or inside stretches of white space
that point normally cannot enter, like the TAB.

@findex rectangle-exchange-point-and-mark
@findex exchange-point-and-mark@r{, in rectangle-mark-mode}
@kindex C-x C-x@r{, in rectangle-mark-mode}
When the region is in rectangle-mark-mode, @kbd{C-x C-x} runs the
command @code{rectangle-exchange-point-and-mark}, which cycles between
the four corners of the region-rectangle.  This comes in handy if you
want to modify the dimensions of the region-rectangle before invoking
an operation on the marked text.

873
@node CUA Bindings
Luc Teirlinck's avatar
Luc Teirlinck committed
874
@section CUA Bindings
875 876 877 878 879 880
@findex cua-mode
@vindex cua-mode
@cindex CUA key bindings
@vindex cua-enable-cua-keys
  The command @kbd{M-x cua-mode} sets up key bindings that are
compatible with the Common User Access (CUA) system used in many other
881 882 883 884 885 886 887 888 889
applications.

  When CUA mode is enabled, the keys @kbd{C-x}, @kbd{C-c}, @kbd{C-v},
and @kbd{C-z} invoke commands that cut (kill), copy, paste (yank), and
undo respectively.  The @kbd{C-x} and @kbd{C-c} keys perform cut and
copy only if the region is active.  Otherwise, they still act as
prefix keys, so that standard Emacs commands like @kbd{C-x C-c} still
work.  Note that this means the variable @code{mark-even-if-inactive}
has no effect for @kbd{C-x} and @kbd{C-c} (@pxref{Using Region}).
890

Richard M. Stallman's avatar
Richard M. Stallman committed
891 892
  To enter an Emacs command like @kbd{C-x C-f} while the mark is
active, use one of the following methods: either hold @kbd{Shift}
893 894
together with the prefix key, e.g., @kbd{S-C-x C-f}, or quickly type
the prefix key twice, e.g., @kbd{C-x C-x C-f}.
895

896 897 898 899
  To disable the overriding of standard Emacs binding by CUA mode,
while retaining the other features of CUA mode described below, set
the variable @code{cua-enable-cua-keys} to @code{nil}.

900 901 902
  CUA mode by default activates Delete-Selection mode (@pxref{Mouse Commands})
so that typed text replaces the active region.  To use CUA without this
behavior, set the variable @code{cua-delete-selection} to @code{nil}.
903

904 905
@cindex rectangle highlighting
  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 910 911
(clockwise) corner of the rectangle, so you can easily expand it in
any direction.  Normal text you type is inserted to the left or right
of each line in the rectangle (on the same side as the cursor).
912

913
  You can use this rectangle support without activating CUA by calling the
914 915
@code{cua-rectangle-mark-mode} command.  But see also the standard
@code{rectangle-mark-mode}.  @xref{Rectangles}.
916

917
  With CUA you can easily copy text and rectangles into and out of
Nick Roberts's avatar
Nick Roberts committed
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 921 922 923
@code{1}, and @kbd{C-2 C-v} yanks the contents of register @code{2}.

@cindex global mark
  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 926 927 928 929 930 931
global mark on and off.  When the global mark is on, all text that you
kill or copy is automatically inserted at the global mark, and text
you type is inserted at the global mark rather than at the current
position.

  For example, to copy words from various buffers into a word list in
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 934 935
@kbd{S-M-f}), copy it to the list with @kbd{C-c} or @kbd{M-w}, and
insert a newline after the word in the target list by pressing
@key{RET}.