aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChong Yidong2008-10-22 19:11:14 +0000
committerChong Yidong2008-10-22 19:11:14 +0000
commitdc103cdc719c2006418bac0cce4b820fa861881b (patch)
tree51a8ff09c7d25bb6380a72fd3498495983d9ec18
parentab8fc9aa5bba5487159030c64d6473f75bfeb5f3 (diff)
downloademacs-dc103cdc719c2006418bac0cce4b820fa861881b.tar.gz
emacs-dc103cdc719c2006418bac0cce4b820fa861881b.zip
Use @kbd instead of @key for mouse commands throughout.
-rw-r--r--doc/emacs/frames.texi66
1 files changed, 33 insertions, 33 deletions
diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi
index 869ddec46a7..24c6a2ca662 100644
--- a/doc/emacs/frames.texi
+++ b/doc/emacs/frames.texi
@@ -76,7 +76,7 @@ yanking using the mouse.
76@kindex Mouse-1 76@kindex Mouse-1
77@kindex Mouse-2 77@kindex Mouse-2
78@kindex Mouse-3 78@kindex Mouse-3
79@table @key 79@table @kbd
80@item Mouse-1 80@item Mouse-1
81Move point to where you click (@code{mouse-set-point}). 81Move point to where you click (@code{mouse-set-point}).
82 82
@@ -97,7 +97,7 @@ ring; on a second click, kill it (@code{mouse-save-then-kill}).
97 97
98@findex mouse-set-point 98@findex mouse-set-point
99 The most basic mouse command is @code{mouse-set-point}, which is 99 The most basic mouse command is @code{mouse-set-point}, which is
100called by clicking with the left mouse button, @key{Mouse-1}, in the 100called by clicking with the left mouse button, @kbd{Mouse-1}, in the
101text area of a window. This moves point to the position where you 101text area of a window. This moves point to the position where you
102clicked. 102clicked.
103 103
@@ -115,7 +115,7 @@ position.
115 115
116@findex mouse-set-region 116@findex mouse-set-region
117@vindex mouse-drag-copy-region 117@vindex mouse-drag-copy-region
118 Holding down @key{Mouse-1} and ``dragging'' the mouse over a stretch 118 Holding down @kbd{Mouse-1} and ``dragging'' the mouse over a stretch
119of text activates the region around that text 119of text activates the region around that text
120(@code{mouse-set-region}). @xref{Mark}. Emacs places the mark where 120(@code{mouse-set-region}). @xref{Mark}. Emacs places the mark where
121you started holding down the mouse button, and point where you release 121you started holding down the mouse button, and point where you release
@@ -133,7 +133,7 @@ on how far away from the window edge the mouse has gone; the variable
133 133
134@findex mouse-yank-at-click 134@findex mouse-yank-at-click
135@vindex mouse-yank-at-point 135@vindex mouse-yank-at-point
136 Clicking with the middle mouse button, @key{Mouse-2}, moves point to 136 Clicking with the middle mouse button, @kbd{Mouse-2}, moves point to
137the position where you clicked and performs a yank 137the position where you clicked and performs a yank
138(@code{mouse-yank-at-click}). @xref{Yanking}. If you change the 138(@code{mouse-yank-at-click}). @xref{Yanking}. If you change the
139variable @code{mouse-yank-at-point} to a non-@code{nil} value, 139variable @code{mouse-yank-at-point} to a non-@code{nil} value,
@@ -143,35 +143,35 @@ occurs at the existing point. This variable also affects yanking the
143primary and secondary selections (@pxref{Cut/Paste Other App}). 143primary and secondary selections (@pxref{Cut/Paste Other App}).
144 144
145@findex mouse-save-then-kill 145@findex mouse-save-then-kill
146 Clicking with the right mouse button, @key{Mouse-3}, runs the 146 Clicking with the right mouse button, @kbd{Mouse-3}, runs the
147command @code{mouse-save-then-kill}. This performs several actions 147command @code{mouse-save-then-kill}. This performs several actions
148depending on where you click and the status of the region: 148depending on where you click and the status of the region:
149 149
150@itemize @bullet 150@itemize @bullet
151@item 151@item
152If no region is active, clicking @key{Mouse-3} activates the region, 152If no region is active, clicking @kbd{Mouse-3} activates the region,
153placing the mark where point was and point at the clicked position. 153placing the mark where point was and point at the clicked position.
154In addition, the text in the region is copied to the kill ring. 154In addition, the text in the region is copied to the kill ring.
155 155
156@item 156@item
157If a region is active, clicking @key{Mouse-3} adjusts the nearer end 157If a region is active, clicking @kbd{Mouse-3} adjusts the nearer end
158of the region by moving it to the clicked position. The adjusted 158of the region by moving it to the clicked position. The adjusted
159region's text is copied to the kill ring; if the text in the original 159region's text is copied to the kill ring; if the text in the original
160region was already on the kill ring, it replaces it there. 160region was already on the kill ring, it replaces it there.
161 161
162@item 162@item
163If you originally specified the region using a double or triple 163If you originally specified the region using a double or triple
164@key{Mouse-1}, so that the region is defined to consist of entire 164@kbd{Mouse-1}, so that the region is defined to consist of entire
165words or lines, then adjusting the region with @key{Mouse-3} also 165words or lines, then adjusting the region with @kbd{Mouse-3} also
166proceeds by entire words or lines. 166proceeds by entire words or lines.
167 167
168@item 168@item
169If you use @key{Mouse-3} a second time consecutively, at the same 169If you use @kbd{Mouse-3} a second time consecutively, at the same
170place, that kills the region already selected. Thus, the simplest way 170place, that kills the region already selected. Thus, the simplest way
171to kill text with the mouse is to click @key{Mouse-1} at one end, then 171to kill text with the mouse is to click @kbd{Mouse-1} at one end, then
172click @key{Mouse-3} twice at the other end. To copy the text into the 172click @kbd{Mouse-3} twice at the other end. To copy the text into the
173kill ring without deleting it from the buffer, press @key{Mouse-3} 173kill ring without deleting it from the buffer, press @kbd{Mouse-3}
174just once---or just drag across the text with @key{Mouse-1}. Then you 174just once---or just drag across the text with @kbd{Mouse-1}. Then you
175can copy it elsewhere by yanking it. 175can copy it elsewhere by yanking it.
176@end itemize 176@end itemize
177 177
@@ -202,7 +202,7 @@ always kill the region if one exists.
202time. Emacs activates the region around the selected text, which is 202time. Emacs activates the region around the selected text, which is
203also copied to the kill ring. 203also copied to the kill ring.
204 204
205@table @key 205@table @kbd
206@item Double-Mouse-1 206@item Double-Mouse-1
207Select the text around the word which you click on. 207Select the text around the word which you click on.
208 208
@@ -242,7 +242,7 @@ systems such as Microsoft Windows (@pxref{Clipboard}).
242 Under X, whenever you select some text in Emacs by dragging or 242 Under X, whenever you select some text in Emacs by dragging or
243clicking the mouse (@pxref{Mouse Commands}), it is also saved in the 243clicking the mouse (@pxref{Mouse Commands}), it is also saved in the
244primary selection. You can then @dfn{paste} that text into any other 244primary selection. You can then @dfn{paste} that text into any other
245X application, usually by clicking @key{Mouse-2} in that application. 245X application, usually by clicking @kbd{Mouse-2} in that application.
246Unlike the Emacs kill ring (@pxref{Kill Ring}), the primary selection 246Unlike the Emacs kill ring (@pxref{Kill Ring}), the primary selection
247has no ``memory'': each time you save something in the primary 247has no ``memory'': each time you save something in the primary
248selection, either in Emacs or in another X application, the previous 248selection, either in Emacs or in another X application, the previous
@@ -275,7 +275,7 @@ inefficient, Emacs only does it if the text is shorter than the value
275of @code{x-cut-buffer-max} (the default is 20000 characters). 275of @code{x-cut-buffer-max} (the default is 20000 characters).
276 276
277 You can yank the primary selection into Emacs using the usual yank 277 You can yank the primary selection into Emacs using the usual yank
278commands, such as @kbd{C-y} (@code{yank}) and @key{Mouse-2} 278commands, such as @kbd{C-y} (@code{yank}) and @kbd{Mouse-2}
279(@code{mouse-yank-at-click}). These commands actually check the 279(@code{mouse-yank-at-click}). These commands actually check the
280primary selection before referring to the kill ring; if no primary 280primary selection before referring to the kill ring; if no primary
281selection is available, the kill ring contents are used. To prevent 281selection is available, the kill ring contents are used. To prevent
@@ -299,7 +299,7 @@ second similar facility known as the @dfn{secondary selection}.
299Nowadays, few X applications make use of the secondary selection, but 299Nowadays, few X applications make use of the secondary selection, but
300you can access it using the following Emacs commands: 300you can access it using the following Emacs commands:
301 301
302@table @key 302@table @kbd
303@findex mouse-set-secondary 303@findex mouse-set-secondary
304@kindex M-Drag-Mouse-1 304@kindex M-Drag-Mouse-1
305@item M-Drag-Mouse-1 305@item M-Drag-Mouse-1
@@ -324,8 +324,8 @@ Set one endpoint for the @dfn{secondary selection}
324Set the secondary selection, with one end at the position clicked and 324Set the secondary selection, with one end at the position clicked and
325the other at the position specified with @kbd{M-Mouse-1} 325the other at the position specified with @kbd{M-Mouse-1}
326(@code{mouse-secondary-save-then-kill}). This also puts the selected 326(@code{mouse-secondary-save-then-kill}). This also puts the selected
327text in the kill ring. A second @kbd{M-@key{Mouse-3}} at the same 327text in the kill ring. A second @kbd{M-Mouse-3} at the same place
328place kills the secondary selection just made. 328kills the secondary selection just made.
329 329
330@findex mouse-yank-secondary 330@findex mouse-yank-secondary
331@kindex M-Mouse-2 331@kindex M-Mouse-2
@@ -334,10 +334,10 @@ Insert the secondary selection where you click, placing point at the
334end of the yanked text (@code{mouse-yank-secondary}). 334end of the yanked text (@code{mouse-yank-secondary}).
335@end table 335@end table
336 336
337Double or triple clicking of @key{M-Mouse-1} operates on words and 337Double or triple clicking of @kbd{M-Mouse-1} operates on words and
338lines, much like @key{Mouse-1}. 338lines, much like @kbd{Mouse-1}.
339 339
340If @code{mouse-yank-at-point} is non-@code{nil}, @key{M-Mouse-2} yanks 340If @code{mouse-yank-at-point} is non-@code{nil}, @kbd{M-Mouse-2} yanks
341at point. Then it does not matter precisely where you click, or even 341at point. Then it does not matter precisely where you click, or even
342which of the frame's windows you click on. @xref{Mouse Commands}. 342which of the frame's windows you click on. @xref{Mouse Commands}.
343 343
@@ -398,7 +398,7 @@ that error message (@pxref{Compilation}). Doing it on a completion in
398the @samp{*Completions*} buffer chooses that completion 398the @samp{*Completions*} buffer chooses that completion
399(@pxref{Completion}). 399(@pxref{Completion}).
400 400
401 Although clicking @key{Mouse-1} on a button usually activates that 401 Although clicking @kbd{Mouse-1} on a button usually activates that
402button, if you hold the mouse button down for a short period of time 402button, if you hold the mouse button down for a short period of time
403before releasing it (specifically, for more than 450 milliseconds), 403before releasing it (specifically, for more than 450 milliseconds),
404then Emacs moves point where you clicked instead. This behavior 404then Emacs moves point where you clicked instead. This behavior
@@ -408,10 +408,10 @@ its usual behavior of setting the region, even if you drag from or
408onto a button. 408onto a button.
409 409
410@vindex mouse-1-click-in-non-selected-windows 410@vindex mouse-1-click-in-non-selected-windows
411 Normally, clicking @key{Mouse-1} on a button activates the button 411 Normally, clicking @kbd{Mouse-1} on a button activates the button
412even if it is in a nonselected window. If you change the variable 412even if it is in a nonselected window. If you change the variable
413@code{mouse-1-click-in-non-selected-windows} to @code{nil}, clicking 413@code{mouse-1-click-in-non-selected-windows} to @code{nil}, clicking
414@key{Mouse-1} on a button in an un-selected window moves point to the 414@kbd{Mouse-1} on a button in an un-selected window moves point to the
415clicked position and selects that window, without activating the 415clicked position and selects that window, without activating the
416button. 416button.
417 417
@@ -429,7 +429,7 @@ mouse-1-click-follows-link @key{RET}} for more details.
429 Several mouse clicks with the @key{CTRL} and @key{SHIFT} modifiers 429 Several mouse clicks with the @key{CTRL} and @key{SHIFT} modifiers
430bring up menus. 430bring up menus.
431 431
432@table @key 432@table @kbd
433@item C-Mouse-1 433@item C-Mouse-1
434@kindex C-Mouse-1 434@kindex C-Mouse-1
435This menu is for selecting a buffer. 435This menu is for selecting a buffer.
@@ -846,20 +846,20 @@ overlapping frames with text starting at the left margin.}
846 When Emacs is compiled with GTK+ support on the X window system, or 846 When Emacs is compiled with GTK+ support on the X window system, or
847in operating systems such as Microsoft Windows or Mac OS, you can use 847in operating systems such as Microsoft Windows or Mac OS, you can use
848the scroll bar as you do in other graphical applications. If you 848the scroll bar as you do in other graphical applications. If you
849click @key{Mouse-1} on the scroll bar's up and down buttons, that 849click @kbd{Mouse-1} on the scroll bar's up and down buttons, that
850scrolls the window by one line at a time. Clicking @key{Mouse-1} 850scrolls the window by one line at a time. Clicking @kbd{Mouse-1}
851above or below the scroll bar's inner box scrolls the window by nearly 851above or below the scroll bar's inner box scrolls the window by nearly
852the entire height of the window, like @kbd{M-v} and @kbd{C-v} 852the entire height of the window, like @kbd{M-v} and @kbd{C-v}
853respectively (@pxref{Moving Point}). Dragging the inner box with 853respectively (@pxref{Moving Point}). Dragging the inner box with
854@key{Mouse-1} scrolls the window continuously. 854@kbd{Mouse-1} scrolls the window continuously.
855 855
856 If Emacs is compiled without GTK+ support on the X window system, 856 If Emacs is compiled without GTK+ support on the X window system,
857the scroll bar behaves differently. The scroll bar's inner box is 857the scroll bar behaves differently. The scroll bar's inner box is
858drawn to represent the portion of the buffer currently displayed, with 858drawn to represent the portion of the buffer currently displayed, with
859the entire height of the scroll bar representing the entire length of 859the entire height of the scroll bar representing the entire length of
860the buffer. @key{Mouse-1} anywhere on the scroll bar scrolls forward 860the buffer. @kbd{Mouse-1} anywhere on the scroll bar scrolls forward
861like @kbd{C-v}, and @key{Mouse-3} scrolls backward like @kbd{M-v}. 861like @kbd{C-v}, and @kbd{Mouse-3} scrolls backward like @kbd{M-v}.
862Clicking @key{Mouse-2} in the scroll bar lets you move or drag the 862Clicking @kbd{Mouse-2} in the scroll bar lets you move or drag the
863inner box up and down. 863inner box up and down.
864 864
865 You can also click @kbd{C-Mouse-2} in the scroll bar to split a 865 You can also click @kbd{C-Mouse-2} in the scroll bar to split a