Mercurial > emacs
annotate man/viper.texi @ 29157:f0754aea38e3
(iso-8859-8-e, iso-8859-8-i): For now, just
aliases for hebrew-iso-8bit.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Wed, 24 May 2000 16:03:39 +0000 |
parents | 6fb7a3864791 |
children | 641e43bad886 |
rev | line source |
---|---|
25829 | 1 % -*-texinfo-*- |
2 \input texinfo | |
3 | |
4 @comment Using viper.info instead of viper in setfilename breaks DOS. | |
5 @comment @setfilename viper | |
6 @comment @setfilename viper.info | |
7 @setfilename ../info/viper | |
8 | |
9 @dircategory Editors | |
10 @direntry | |
11 * VIPER: (viper). The newest Emacs VI-emulation mode. | |
12 (also, A VI Plan for Emacs Rescue | |
13 or the VI PERil.) | |
14 @end direntry | |
15 | |
16 @iftex | |
17 @finalout | |
18 @end iftex | |
19 | |
20 @titlepage | |
21 @title Viper Is a Package for Emacs Rebels | |
22 @subtitle a Vi emulator for Emacs | |
23 @subtitle March 1998, Viper Version 3.02 (Polyglot) | |
24 | |
25 @author Michael Kifer (Viper) | |
26 @author Aamod Sane (VIP 4.4) | |
27 @author Masahiko Sato (VIP 3.5) | |
28 | |
29 @page | |
30 @vskip 0pt plus 1fill | |
31 @end titlepage | |
32 | |
33 @unnumbered Distribution | |
34 | |
35 @noindent | |
36 Copyright @copyright{} 1995, 1996, 1997 Free Software Foundation, Inc. | |
37 | |
38 Permission is granted to make and distribute verbatim copies of | |
39 this manual provided the copyright notice and this permission notice | |
40 are preserved on all copies. | |
41 | |
42 @ignore | |
43 Permission is granted to process this file through TeX and print the | |
44 results, provided the printed document carries copying permission | |
45 notice identical to this one except for the removal of this paragraph | |
46 (this paragraph not being relevant to the printed manual). | |
47 | |
48 @end ignore | |
49 Permission is granted to copy and distribute modified versions of this | |
50 manual under the conditions for verbatim copying, provided that the entire | |
51 resulting derived work is distributed under the terms of a permission | |
52 notice identical to this one. | |
53 | |
54 Permission is granted to copy and distribute translations of this manual | |
55 into another language, under the same conditions as for modified versions. | |
56 | |
57 @ifinfo | |
58 @node Top, Overview,, (DIR) | |
59 | |
60 @unnumbered Viper | |
61 | |
62 We believe that one or more of the following statements are adequate | |
63 descriptions: | |
64 | |
65 @example | |
66 Viper Is a Package for Emacs Rebels; | |
67 it is a VI Plan for Emacs Rescue | |
68 and/or a venomous VI PERil. | |
69 @end example | |
70 | |
71 Technically speaking, Viper is a Vi emulation package for Emacs. It | |
72 implements all Vi and Ex commands, occasionally improving on them and | |
73 adding many new features. It gives the user the best of both worlds: Vi | |
74 keystrokes for editing combined with the power of the Emacs environment. | |
75 | |
76 Viper emulates Vi at several levels, from the one that closely follows Vi | |
77 conventions to the one that departs from many of them. It has many | |
78 customizable options, which can be used to tailor Viper to the work habits | |
79 of various users. | |
80 This manual describes Viper, concentrating on the differences from Vi and | |
81 new features of Viper. | |
82 | |
83 Viper, formerly known as VIP-19, was written by Michael Kifer. It is based | |
84 on VIP version 3.5 by Masahiko Sato and VIP version 4.4 by Aamod Sane. | |
85 Viper tries to be compatible with these packages. | |
86 | |
87 Viper is intended to be usable without reading this manual --- the defaults | |
88 are set to make Viper as close to Vi as possible. At startup, Viper will | |
89 try to set the most appropriate default environment for you, based on | |
90 your familiarity with Emacs. It will also tell you the basic GNU Emacs window | |
91 management commands to help you start immediately. | |
92 | |
93 Although this manual explains how to customize Viper, some basic | |
94 familiarity with Emacs Lisp would be a plus. | |
95 | |
96 It is recommended that you read the Overview node. The other nodes may | |
97 be visited as needed. | |
98 | |
99 Comments and bug reports are welcome. | |
100 @code{kifer@@cs.emacs.edu} is the current address for Viper bug reports. | |
101 Please use the Ex command @kbd{:submitReport} for this purpose.@refill | |
102 | |
103 @end ifinfo | |
104 | |
105 @menu | |
106 * Overview:: Must read to get started | |
107 * Improvements over Vi:: New features, Improvements | |
108 * Customization:: How to customize Viper | |
109 * Commands:: Vi and Ex Commands | |
110 | |
111 * Key Index:: Index of Vi and Ex Commands | |
112 * Function Index:: Index of Viper Functions | |
113 * Variable Index:: Index of Viper Variables | |
114 * Package Index:: Index of Packages Mentioned in this Document | |
115 * Concept Index:: Vi, Ex and Emacs concepts | |
116 | |
117 * Acknowledgments:: | |
118 @end menu | |
119 @iftex | |
120 @unnumbered Introduction | |
121 | |
122 We believe that one or more of the following statements are adequate | |
123 descriptions: | |
124 | |
125 @example | |
126 Viper Is a Package for Emacs Rebels; | |
127 it is a VI Plan for Emacs Rescue | |
128 and/or a venomous VI PERil. | |
129 @end example | |
130 | |
131 Viper is a Vi emulation package for Emacs. Viper contains virtually all | |
132 of Vi and Ex functionality and much more. It gives you the best of both | |
133 worlds: Vi keystrokes for editing combined with the GNU Emacs | |
134 environment. Viper also fixes some common complaints with Vi commands. | |
135 This manual describes Viper, concentrating on the differences from Vi | |
136 and on the new features of Viper. | |
137 | |
138 Viper was written by Michael Kifer. It is based on VIP version 3.5 by | |
139 Masahiko Sato and VIP version 4.4 by Aamod Sane. Viper tries to be | |
140 compatible with these packages. | |
141 | |
142 Viper is intended to be usable out of the box, without reading this manual | |
143 --- the defaults are set to make Viper as close to Vi as possible. At | |
144 startup, Viper will attempt to set the most appropriate default environment | |
145 for you, based on your familiarity with Emacs. It will also tell you the | |
146 basic GNU Emacs window management commands to help you start immediately. | |
147 | |
148 Although this manual explains how to customize Viper, some basic | |
149 familiarity with Emacs Lisp would be a plus. | |
150 | |
151 It is recommended that you read the chapter Overview. The other chapters | |
152 will be useful for customization and advanced usage. | |
153 | |
154 You should also learn to use the Info on-line hypertext manual system that | |
155 comes with Emacs. This manual can be read as an Info file. Try the command | |
156 @kbd{@key{ESC} x info} with vanilla Emacs sometime. | |
157 | |
158 Comments and bug reports are welcome. | |
159 @code{kifer@@cs.sunysb.edu} is the current address for Viper bug reports. | |
160 Please use the Ex command @kbd{:submitReport} for this purpose.@refill | |
161 | |
162 @end iftex | |
163 | |
164 @node Overview,Improvements over Vi,Top,Top | |
165 @chapter Overview of Viper | |
166 | |
167 Viper is a Vi emulation on top of Emacs. At the same time, Viper provides a | |
168 virtually unrestricted access to Emacs facilities. Perfect compatibility | |
169 with Vi is possible but not desirable. This chapter tells you about the | |
170 Emacs ideas that you should know about, how to use Viper within Emacs and | |
171 some incompatibilities. | |
172 | |
173 Viper was formerly known as VIP-19, which was | |
174 a descendant of VIP 3.5 by Masahiko Sato and VIP 4.4 by Aamod Sane. | |
175 | |
176 @menu | |
177 * Emacs Preliminaries:: Basic concepts in Emacs. | |
178 * Loading Viper:: Loading and Preliminary Configuration. | |
179 * States in Viper:: Viper has four states orthogonal to Emacs | |
180 modes. | |
181 * The Minibuffer:: Command line in Emacs. | |
182 * Multiple Files in Viper:: True multiple file handling. | |
183 * Unimplemented Features:: That are unlikely to be implemented. | |
184 @end menu | |
185 | |
186 @node Emacs Preliminaries, Loading Viper, Overview, Overview | |
187 @section Emacs Preliminaries | |
188 | |
189 @cindex buffer | |
190 @cindex point | |
191 @cindex mark | |
192 @cindex text | |
193 @cindex looking at | |
194 @cindex end (of buffer) | |
195 @cindex end (of line) | |
196 @cindex region | |
197 | |
198 Emacs can edit several files at once. A file in Emacs is placed in a | |
199 @dfn{buffer} that usually has the same name as the file. Buffers are also used | |
200 for other purposes, such as shell interfaces, directory editing, etc. | |
201 @xref{Dired,,Directory Editor,emacs,The | |
202 Gnu Emacs Manual}, for an example.@refill | |
203 | |
204 A buffer has a distinguished position called the @dfn{point}. | |
205 A @dfn{point} is always between 2 characters, and is @dfn{looking at} | |
206 the right hand character. The cursor is positioned on the right hand | |
207 character. Thus, when the @dfn{point} is looking at the end-of-line, | |
208 the cursor is on the end-of-line character, i.e.@: beyond the last | |
209 character on the line. This is the default Emacs behavior.@refill | |
210 | |
211 The default settings of Viper try to mimic the behavior of Vi, preventing | |
212 the cursor from going beyond the last character on the line. By using | |
213 Emacs commands directly (such as those bound to arrow keys), it is possible | |
214 to get the cursor beyond the end-of-line. However, this won't (or | |
215 shouldn't) happen if you restrict yourself to standard Vi keys, unless you | |
216 modify the default editing style. @xref{Customization}.@refill | |
217 | |
218 In addition to the @dfn{point}, there is another distinguished buffer | |
219 position called the @dfn{mark}. @xref{Mark,,Mark,emacs,The GNU Emacs | |
220 manual}, for more info on the mark. The text between the @dfn{point} and | |
221 the @dfn{mark} is called the @dfn{region} of the buffer. For the Viper | |
222 user, this simply means that in addition to the Vi textmarkers a--z, there | |
223 is another marker called @dfn{mark}. This is similar to the unnamed Vi | |
224 marker used by the jump commands @kbd{``} and @kbd{''}, which move the | |
225 cursor to the position of the last absolute jump. Viper provides access to | |
226 the region in most text manipulation commands as @kbd{r} and @kbd{R} suffix | |
227 to commands that operate on text regions, e.g., @kbd{dr} to delete region, | |
228 etc. | |
229 | |
230 Furthermore, Viper lets Ex-style commands to work on the current region. | |
231 This is done by typing a digit argument before @kbd{:}. For instance, | |
232 typing @kbd{1:} will propmt you with something like @emph{:123,135}, | |
233 assuming that the current region starts at line 123 and ends at line | |
234 135. There is no need to type the line numbers, since Viper inserts them | |
235 automatically in front of the Ex command. | |
236 | |
237 @xref{Basics}, for more info.@refill | |
238 | |
239 @cindex window | |
240 @cindex mode line | |
241 @cindex buffer information | |
242 @cindex Minibuffer | |
243 @cindex command line | |
244 @cindex buffer (modified) | |
245 | |
246 Emacs divides the screen into tiled @dfn{windows}. You can see the | |
247 contents of a buffer through the window associated with the buffer. The | |
248 cursor of the screen is positioned on the character after @dfn{point}. | |
249 Every window has a @dfn{mode line} that displays information about the buffer. | |
250 You can change the format of the mode | |
251 line, but normally if you see @samp{**} at the beginning of a mode line it | |
252 means that the buffer is @dfn{modified}. If you write out the contents of | |
253 a buffer to a file, then the buffer will become not modified. Also if | |
254 you see @samp{%%} at the beginning of the mode line, it means that the file | |
255 associated with the buffer is write protected. The mode line will also | |
256 show the buffer name and current major and minor modes (see below). | |
257 A special buffer called @dfn{Minibuffer} is displayed as the last line | |
258 in a Minibuffer window. The Minibuffer window is used for command input | |
259 output. Viper uses Minibuffer window for @kbd{/} and @kbd{:} | |
260 commands.@refill | |
261 | |
262 @cindex mode | |
263 @cindex keymap | |
264 @cindex local keymap | |
265 @cindex global keymap | |
266 @cindex major mode | |
267 @cindex minor mode | |
268 | |
269 An Emacs buffer can have a @dfn{major mode} that customizes Emacs for | |
270 editing text of a particular sort by changing the functionality of the keys. | |
271 Keys are defined using a @dfn{keymap} that records the bindings between | |
272 keystrokes and | |
273 functions. The @dfn{global keymap} is common to all the | |
274 buffers. Additionally, each buffer has its @dfn{local keymap} that determines the | |
275 @dfn{mode} of the buffer. If a function is bound to some key in the local | |
276 keymap then that function will be executed when you type the key. | |
277 If no function is bound to a key in the | |
278 local map, however, the function bound to the key in the global map | |
279 will be executed. @xref{Major Modes,Major Modes,Major Modes,emacs,The | |
280 GNU Emacs Manual}, for more information.@refill | |
281 | |
282 A buffer can also have a @dfn{minor mode}. Minor modes are options that | |
283 you can use or not. A buffer in @code{text-mode} can have | |
284 @code{auto-fill-mode} as minor mode, which can be turned off or on at | |
285 any time. In Emacs, a minor mode may have it own keymap, | |
286 which overrides the local keymap when the minor mode is turned on. For | |
287 more information, @pxref{Minor Modes,Minor Modes,Minor Modes,emacs,The | |
288 GNU Emacs Manual} @refill | |
289 | |
290 @cindex Viper as minor mode | |
291 @cindex Control keys | |
292 @cindex Meta key | |
293 | |
294 Viper is implemented as a collection of minor modes. Different minor modes | |
295 are involved when Viper emulates Vi command mode, Vi insert mode, etc. | |
296 You can also turn Viper on and off at any time while in Vi command mode. | |
297 @xref{States in Viper}, for | |
298 more information.@refill | |
299 | |
300 Emacs uses Control and Meta modifiers. These are denoted as C and M, | |
301 e.g.@: @kbd{^Z} as @kbd{C-z} and @kbd{Meta-x} as @kbd{M-x}. The Meta key is | |
302 usually located on each side of the Space bar; it is used in a manner | |
303 similar to the Control key, e.g., @kbd{M-x} means typing @kbd{x} while | |
304 holding the Meta key down. For keyboards that do not have a Meta key, | |
305 @key{ESC} is used as Meta. Thus @kbd{M-x} is typed as @kbd{@key{ESC} | |
306 x}. Viper uses @key{ESC} to switch from Insert state to Vi state. Therefore | |
307 Viper defines @kbd{C-\} as its Meta key in Vi state. @xref{Vi State}, for | |
308 more info.@refill | |
309 | |
310 Emacs is structured as a lisp interpreter around a C core. Emacs keys | |
311 cause lisp functions to be called. It is possible to call these | |
312 functions directly, by typing @kbd{M-x function-name}. | |
313 | |
314 @node Loading Viper, States in Viper, Emacs Preliminaries, Overview | |
315 @section Loading Viper | |
316 | |
317 The most common way to load it automatically is to include the following | |
318 lines (in the given order!): | |
319 | |
320 @lisp | |
321 (setq viper-mode t) | |
322 (require 'viper) | |
323 @end lisp | |
324 | |
325 @noindent | |
326 in your @file{~/.emacs} file. The @file{.emacs} file is placed in your | |
327 home directory and it is be executed every time you invoke Emacs. This is | |
328 the place where all general Emacs customization takes place. Beginning with | |
329 version 20.0, Emacsen have an interactive interface, which simplifies the | |
330 job of customization significantly. | |
331 | |
332 Viper also uses the file @file{~/.viper} for Viper-specific customization. | |
333 If you wish to be in Vi command state whenever this is deemed appropriate | |
334 by the author, you can include the following line in your @file{.viper}: | |
335 @lisp | |
336 (setq viper-always t) | |
337 @end lisp | |
338 @noindent | |
339 (@xref{Vi State}, for the explanation of Vi command state.) | |
340 | |
341 The location of Viper customization file can be changed by setting the | |
342 variable @code{viper-custom-file-name} in @file{.emacs} @emph{prior} to loading | |
343 Viper. | |
344 | |
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
345 The latest versions of Emacs have an interactive customization facility, |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
346 which allows you to (mostly) bypass the use of the @file{.emacs} and |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
347 @file{.viper} files. You can reach this customization |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
348 facility from within Viper's VI state by executing the Ex command |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
349 @kbd{:customize}. |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
350 |
25829 | 351 Once invoked, Viper will arrange to bring up Emacs buffers in Vi state |
352 whenever this makes sense. | |
353 @xref{Packages that Change Keymaps}, to find out when forcing Vi command state | |
354 on a buffer may be counter-productive. | |
355 | |
356 Even if your @file{.emacs} and @file{.viper} files do not contain any of the | |
357 above lines, you can still load Viper and enter Vi command state by typing the | |
358 following from within Emacs: | |
359 | |
360 @lisp | |
361 M-x viper-mode | |
362 @end lisp | |
363 | |
364 When Emacs first comes up, if you have not specified a file on the | |
365 command line, it will show the @samp{*scratch*} buffer, in the | |
366 @samp{Lisp Interaction} mode. After you invoke Viper, you can start | |
367 editing files by using @kbd{:e}, @kbd{:vi}, or @kbd{v} commands. | |
368 (@xref{File and Buffer Handling}, for more information on @kbd{v} and other | |
369 new commands that, in many cases, are more convenient than @kbd{:e}, | |
370 @kbd{:vi}, and similar old-style Vi commands.)@refill | |
371 | |
372 Finally, if at some point you would want to get de-Viperize your running | |
373 copy of Emacs after Viper has been loaded, the command @kbd{M-x | |
374 viper-go-away} will do it for you. The function @code{toggle-viper-mode} | |
375 toggles Viperization of Emacs on and off. | |
376 | |
377 @node States in Viper, The Minibuffer, Loading Viper,Overview | |
378 @section States in Viper | |
379 | |
380 @kindex @kbd{C-z} | |
381 @kindex @key{ESC} | |
382 @kindex @kbd{i} | |
383 @cindex Emacs state | |
384 @cindex Vi state | |
385 @cindex Insert state | |
386 @cindex Replace state | |
387 @cindex Ex commands | |
388 @findex @code{viper-go-away} | |
389 @findex @code{toggle-viper-mode} | |
390 | |
391 Viper has four states, Emacs, Vi, Insert, and Replace. | |
392 | |
393 @table @samp | |
394 @item Emacs state | |
395 This is the state plain vanilla Emacs is normally in. After you have loaded | |
396 Viper, @kbd{C-z} will normally take you to Vi command state. Another | |
397 @kbd{C-z} will take you back to Emacs state. This toggle key can be | |
398 changed, @pxref{Customization} You can also type @kbd{M-x viper-mode} to | |
399 change to Vi state.@refill | |
400 | |
401 | |
402 For users who chose to set their user level to 1 at Viper setup time, | |
403 switching to Emacs state is deliberately made harder in order to not | |
404 confuse the novice user. In this case, @kbd{C-z} will either iconify Emacs | |
405 (if Emacs runs as an application under X Windows) or it will stop Emacs (if | |
406 Emacs runs on a dumb terminal or in an Xterm window). | |
407 | |
408 @item Vi state | |
409 This is the Vi command mode. Any of the Vi commands, such as @kbd{i, o, a}, | |
410 @dots{}, will take you to Insert state. All Vi commands may | |
411 be used in this mode. Most Ex commands can also be used. | |
412 For a full list of Ex commands supported by Viper, type | |
413 @kbd{:} and then @key{TAB}. To get help on any issue, including the Ex | |
414 commands, type @kbd{:help}. This will invoke Viper Info | |
415 (if it is installed). Then typing @kbd{i} will prompt you for a topic to | |
416 search in the index. Note: to search for Ex commands in the index, you | |
417 should start them with a ``@kbd{:}'', e.g., @kbd{:WW}. | |
418 | |
419 In Viper, Ex commands can be made to work on the current Emacs region. | |
420 This is done by typing a digit argument before @kbd{:}. | |
421 For instance, typing @kbd{1:} will propmt you with something like | |
422 @emph{:123,135}, assuming that the current region starts at line 123 and | |
423 ends at line 135. There is no need to type the line numbers, since Viper | |
424 inserts them automatically in front of the Ex command. | |
425 | |
426 @item Insert state | |
427 Insert state is the Vi insertion mode. @key{ESC} will take you back to | |
428 Vi state. Insert state editing can be done, including auto-indentation. By | |
429 default, Viper disables Emacs keybindings in Insert state. | |
430 | |
431 @item Replace state | |
432 Commands like @kbd{cw} invoke the Replace state. When you cross the | |
433 boundary of a replacement region (usually designated via a @samp{$} sign), | |
434 it will automatically change to Insert state. You do not have to worry | |
435 about it. The key bindings remain practically the same as in Insert | |
436 state. If you type @key{ESC}, Viper will switch to Vi command mode, terminating the | |
437 replacement state.@refill | |
438 @end table | |
439 | |
440 @cindex mode line | |
441 | |
442 The modes are indicated on the @dfn{mode line} as <E>, <I>, <V>, and <R>, | |
443 so that the multiple modes do not confuse you. Most of your editing can be | |
444 done in Vi and Insert states. Viper will try to make all new buffers be in Vi | |
445 state, but sometimes they may come up in Emacs state. @kbd{C-z} | |
446 will take you to Vi state in such a case. In some major modes, like Dired, | |
447 Info, Gnus, etc., you should not switch to Vi state (and Viper will not | |
448 attempt to do so) because these modes are not intended for text editing and | |
449 many of the Vi keys have special meaning there. If you plan to read news, | |
450 browse directories, read mail, etc., from Emacs (which you should start | |
451 doing soon!), you should learn about the meaning of the various keys in | |
452 those special modes (typing @kbd{C-h m} in a buffer provides | |
453 help with key bindings for the major mode of that buffer). | |
454 | |
455 If you switch to Vi in Dired or similar modes---no harm is done. It is just | |
456 that the special keybindings provided by those modes will be temporarily | |
457 overshadowed by Viper's bindings. Switching back to Viper's Emacs state | |
458 will revive the environment provided by the current major mode. | |
459 | |
460 States in Viper are orthogonal to Emacs major modes, such as C mode or Dired | |
461 mode. You can turn Viper on and off for any Emacs state. When Viper is turned | |
462 on, Vi state can be used to move around. In Insert state, the bindings for | |
463 these modes can be accessed. For beginners (users at Viper levels 1 and 2), | |
464 these bindings are suppressed in Insert state, so that new users are not | |
465 confused by the Emacs states. Note that unless you allow Emacs bindings in | |
466 Insert state, you cannot do many interesting things, like language | |
467 sensitive editing. For the novice user (at Viper level 1), all major mode | |
468 bindings are turned off in Vi state as well. This includes the bindings for | |
469 key sequences that start with @kbd{C-c}, which practically means that all | |
470 major mode bindings are supported. @xref{Customization}, to find out how | |
471 to allow Emacs keys in Insert state. | |
472 | |
473 @menu | |
474 * Emacs State:: This is the state you should learn more about when | |
475 you get up to speed with Viper. | |
476 * Vi State:: Vi commands are executed in this state. | |
477 * Insert State:: You can enter text, and also can do sophisticated | |
478 editing if you know enough Emacs commands. | |
479 * Replace State:: Like Insert mode, but it is invoked via the | |
480 replacement commands, such as cw, C, R, etc. | |
481 @end menu | |
482 | |
483 @node Emacs State, Vi State, States in Viper, States in Viper | |
484 @subsection Emacs State | |
485 | |
486 @kindex @kbd{C-z} | |
487 @cindex Emacs state | |
488 | |
489 | |
490 You will be in this mode only by accident (hopefully). This is the state | |
491 Emacs is normally in (imagine!!). Now leave it as soon as possible by | |
492 typing @kbd{C-z}. Then you will be in Vi state (sigh of relief) :-). | |
493 | |
494 Emacs state is actually a Viperism to denote all the major and minor modes | |
495 (@pxref{Emacs Preliminaries}) other than Viper that Emacs can be in. Emacs | |
496 can have several modes, such as C mode for editing C programs, LaTeX mode | |
497 for editing LaTeX documents, Dired for directory editing, etc. These are | |
498 major modes, each with a different set of key-bindings. Viper states are | |
499 orthogonal to these Emacs major modes. The presence of these language | |
500 sensitive and other modes is a major win over Vi. @xref{Improvements over | |
501 Vi}, for more.@refill | |
502 | |
503 The bindings for these modes can be made available in the Viper Insert state | |
504 as well as in Emacs state. Unless you specify your user level as 1 (a | |
505 novice), all major mode key sequences that start with @kbd{C-x} and | |
506 @kbd{C-c} are also available in Vi state. This is important because major | |
507 modes designed for editing files, such as cc-mode or latex-mode, use key | |
508 sequences that begin with @kbd{C-x} and @kbd{C-c}. | |
509 | |
510 There is also a key that lets you temporarily escape to Vi command state | |
511 from Emacs or Insert states: typing @kbd{C-c \} will let you execute a | |
512 single Vi command while staying in Viper's Emacs or Insert state. | |
513 In Insert state, the same can also be achieved by typing @kbd{C-z}. | |
514 | |
515 | |
516 @node Vi State, Insert State, Emacs State, States in Viper | |
517 @subsection Vi State | |
518 | |
519 @cindex Vi state | |
520 | |
521 This is the Vi command mode. When Viper is in Vi state, you will see the sign | |
522 <V> in the mode line. Most keys will work as in Vi. The notable | |
523 exceptions are: | |
524 | |
525 @table @kbd | |
526 @item C-x | |
527 @kindex @kbd{C-x} | |
528 @kbd{C-x} is used to invoke Emacs commands, mainly those that do window | |
529 management. @kbd{C-x 2} will split a window, @kbd{C-x 0} will close a | |
530 window. @kbd{C-x 1} will close all other windows. @kbd{C-xb} is used to | |
531 switch buffers in a window, and @kbd{C-xo} to move through windows. | |
532 These are about the only necessary keystrokes. | |
533 For the rest, see the GNU Emacs Manual. | |
534 | |
535 @item C-c | |
536 @kindex @kbd{C-c} | |
537 For user levels 2 and higher, this key serves as a prefix key for the key | |
538 sequences used by various major modes. For users at Viper level 1, @kbd{C-c} | |
539 simply beeps. | |
540 | |
541 @item C-g and C-] | |
542 @kindex @kbd{C-g} | |
543 @kindex @kbd{C-]} | |
544 | |
545 These are the Emacs @samp{quit} keys. | |
546 There will be cases where you will have to | |
547 use @kbd{C-g} to quit. Similarly, @kbd{C-]} is used to exit | |
548 @samp{Recursive Edits} in Emacs for which there is no comparable Vi | |
549 functionality and no key-binding. Recursive edits are indicated by | |
550 @samp{[]} brackets framing the modes on the mode line. | |
551 @xref{Recursive Edit,Recursive | |
552 Edit,Recursive Edit,emacs,The GNU Emacs Manual}. | |
553 At user level 1, @kbd{C-g} is bound to @code{viper-info-on-file} | |
554 function instead. | |
555 @refill | |
556 @item C-\ | |
557 @kindex @kbd{C-\} | |
558 @cindex Meta key | |
559 | |
560 Viper uses @key{ESC} as a switch between Insert and Vi states. Emacs uses | |
561 @key{ESC} for Meta. The Meta key is very important in Emacs since many | |
562 finctions are accessible only via that key as @kbd{M-x function-name}. | |
563 Therefore, we need to simulate it somehow. In Viper's Vi, Insert, and | |
564 Replace states, the meta key is set to be @kbd{C-\}. Thus, to get | |
565 @kbd{M-x}, you should type @kbd{C-\ x} (if the keyboard has no Meta key). | |
566 This works both in the Vi command state and in the Insert and Replace | |
567 states. In Vi command state, you can also use @kbd{\ @key{ESC}} as the | |
568 meta key. | |
569 | |
570 Note: Emacs binds @kbd{C-\} to a function that offers to change the | |
571 keyboard input method in the multilingual environment. Viper overrides this | |
572 binding. However, it is still possible to switch the input method by typing | |
573 @kbd{\ C-\} in the Vi command state and @kbd{C-z \ C-\} in the Insert state. | |
574 Or you can use the MULE menu in the menubar. | |
575 @end table | |
576 @noindent | |
577 Other differences are mostly improvements. The ones you should know | |
578 about are: | |
579 | |
580 @table @samp | |
581 @item Undo | |
582 @kindex @kbd{u} | |
583 @kbd{u} will undo. Undo can be repeated by the @kbd{.} key. Undo itself | |
584 can be undone. Another @kbd{u} will change the direction. The presence | |
585 of repeatable undo means that @kbd{U}, undoing lines, is not very | |
586 important. Therefore, @kbd{U} also calls @code{viper-undo}. | |
587 @cindex multiple undo | |
588 @cindex undo | |
589 | |
590 | |
591 @item Counts | |
592 Most commands, @kbd{~}, @kbd{[[}, @kbd{p}, @kbd{/}, @dots{}, etc., take counts. | |
593 | |
594 @comment ]] Just to balance parens | |
595 @item Regexps | |
596 Viper uses Emacs Regular Expressions for searches. These are a superset of | |
597 Vi regular | |
598 expressions, excepting the change-of-case escapes @samp{\u}, @samp{\L}, | |
599 @dots{}, etc. @xref{Regular Expressions,,Regular Expressions,emacs,The | |
600 GNU Emacs Manual}, for details. | |
601 Files specified to @kbd{:e} use @code{csh} regular expressions | |
602 (globbing, wildcards, what have you). | |
603 However, the function @code{viper-toggle-search-style}, bound to @kbd{C-c /}, | |
604 lets the user switch from search with regular expressions to plain vanilla | |
605 search and vice versa. It also lets one switch from case-sensitive search | |
606 to case-insensitive and back. | |
607 @xref{Viper Specials}, for more details. | |
608 @cindex regular expressions | |
609 @cindex vanilla search | |
610 @cindex case-sensitive search | |
611 @cindex case-insensitive search | |
612 @kindex @kbd{C-c /} | |
613 | |
614 @item Ex commands | |
615 @cindex Ex commands | |
616 The current working directory of a buffer is automatically inserted in the | |
617 minibuffer if you type @kbd{:e} then space. Absolute filenames are | |
618 required less often in Viper. For path names, Emacs uses a convention that | |
619 is slightly different from that of Unix. It is designed to minimize the | |
620 need for deleting path names that Emacs provides in its prompts. (This is | |
621 usually convenient, but occasionally the prompt may suggest a wrong path | |
622 name for you.) If you see a prompt @kbd{/usr/foo/} and you wish to edit the | |
623 file @kbd{~/.viper}, you don't have to erase the prompt. Instead, simply | |
624 continue typing what you need. Emacs will interpret @kbd{/usr/foo/~/.viper} | |
625 correctly. Similarly, if the prompt is @kbd{~/foo/} and you need to get to | |
626 @kbd{/bar/file}, keep typing. Emacs interprets @kbd{~/foo//bar/} as | |
627 @kbd{/bar/file}, since when it sees @samp{//}, it understands that | |
628 @kbd{~/foo/} is to be discarded. | |
629 | |
630 The command @kbd{:cd} will change the default directory for the | |
631 current buffer. The command @kbd{:e} will interpret the | |
632 filename argument in @code{csh}. @xref{Customization}, if you | |
633 want to change the default shell. | |
634 The command @kbd{:next} takes counts from | |
635 @kbd{:args}, so that @kbd{:rew} is obsolete. Also, @kbd{:args} will show only | |
636 the invisible files (i.e., those that are not currently seen in Emacs | |
637 windows). | |
638 | |
639 When applicable, Ex commands support file completion and history. This | |
640 means that by typing a partial file name and then @key{TAB}, Emacs will try | |
641 to complete the name or it will offer a menu of possible completions. | |
642 This works similarly to Tcsh and extends the behavior of Csh. While Emacs | |
643 is waiting for a file name, you can type @kbd{M-p} to get the previous file | |
644 name you typed. Repeatedly typing @kbd{M-p} and @kbd{M-n} will let you | |
645 browse through the file history. | |
646 | |
647 Like file names, partially typed Ex commands can be completed by typing | |
648 @key{TAB}, and Viper keeps the history of Ex commands. After typing | |
649 @kbd{:}, you can browse through the previously entered Ex commands by | |
650 typing @kbd{M-p} and @kbd{M-n}. Viper tries to rationalize when it puts Ex | |
651 commands on the history list. For instance, if you typed @kbd{:w!@: foo}, | |
652 only @kbd{:w!} will be placed on the history list. This is because the | |
653 last history element is the default that can be invoked simply by typing | |
654 @kbd{: @key{RET}}. If @kbd{:w!@: foo} were placed on the list, it would be all to | |
655 easy to override valuable data in another file. Reconstructing the full | |
656 command, @kbd{:w!@: foo}, from the history is still not that hard, since Viper | |
657 has a separate history for file names. By typing @kbd{: M-p}, you will get | |
658 @kbd{:w!} in the Minibuffer. Then, repeated @kbd{M-p} will get you through | |
659 the file history, inserting one file name after another. | |
660 | |
661 In contrast to @kbd{:w!@: foo}, if the command were @kbd{:r foo}, the entire | |
662 command will appear in the history list. This is because having @kbd{:r} | |
663 alone as a default is meaningless, since this command requires a file | |
664 argument. | |
665 @refill | |
666 @end table | |
667 @noindent | |
668 As Vi, Viper's destructive commands can be re-executed by typing `@kbd{.}'. | |
669 However, in addition, Viper keeps track of the history of such commands. This | |
670 history can be perused by typing @kbd{C-c M-p} and @kbd{C-c M-n}. | |
671 Having found the appropriate command, it can be then executed by typing | |
672 `@kbd{.}'. | |
673 @xref{Improvements over Vi}, for more information. | |
674 | |
675 @node Insert State, Replace State, Vi State, States in Viper | |
676 @subsection Insert State | |
677 | |
678 @cindex Insert state | |
679 | |
680 To avoid confusing the beginner (at Viper level 1 and 2), Viper makes only the | |
681 standard Vi keys available in Insert state. The implication is that | |
682 Emacs major modes cannot be used Insert state. | |
683 It is strongly recommended that as soon as you are comfortable, make the | |
684 Emacs state bindings visible (by changing your user level to 3 or higher). | |
685 @xref{Customization}, | |
686 to see how to do this.@refill | |
687 | |
688 Once this is done, it is possible to do quite a bit of editing in | |
689 Insert state. For instance, Emacs has a @dfn{yank} command, @kbd{C-y}, | |
690 which is similar to Vi's @kbd{p}. However, unlike @kbd{p}, @kbd{C-y} can be | |
691 used in Insert state of Viper. Emacs also has a kill ring where it keeps | |
692 pieces of text you deleted while editing buffers. The command @kbd{M-y} is | |
693 used to delete the text previously put back by Emacs' @kbd{C-y} or by Vi's | |
694 @kbd{p} command and reinsert text that was placed on the kill-ring earlier. | |
695 | |
696 This works both in Vi and Insert states. | |
697 In Vi state, @kbd{M-y} is a much better alternative to the usual Vi's way | |
698 of recovering the 10 previously deleted chunks of text. In Insert state, | |
699 you can | |
700 use this as follows. Suppose you deleted a piece of text and now you need | |
701 to re-insert it while editing in Insert mode. The key @kbd{C-y} will put | |
702 back the most recently deleted chunk. If this is not what you want, type | |
703 @kbd{M-y} repeatedly and, hopefully, you will find the chunk you want. | |
704 | |
705 Finally, in Insert and Replace states, Viper provides the history of | |
706 pieces of text inserted in previous insert or replace commands. These | |
707 strings of text can be recovered by repeatedly typing @kbd{C-c M-p} or | |
708 @kbd{C-c M-n} while in Insert or Replace state. (This feature is disabled | |
709 in the minibuffer: the above keys are usually bound to other histories, | |
710 which are more appropriate in the minibuffer.) | |
711 | |
712 | |
713 @cindex Meta key | |
714 | |
715 You can call Meta functions from Insert state. As in Vi state, the Meta key | |
716 is @kbd{C-\}. Thus @kbd{M-x} is typed as @kbd{C-\ x}. | |
717 | |
718 Other Emacs commands that are useful in Insert state are @kbd{C-e} | |
719 and @kbd{C-a}, which move the cursor to the end and the beginning of the | |
720 current line, respectively. You can also use @kbd{M-f} and @kbd{M-b}, | |
721 which move the cursor forward (or backward) one word. | |
722 If your display has a Meta key, these functions are invoked by holding the | |
723 Meta key and then typing @kbd{f} and @kbd{b}, respectively. On displays | |
724 without the Meta key, these functions are invoked by typing | |
725 @kbd{C-\ f} and @kbd{C-\ b} (@kbd{C-\} simulates the Meta key in Insert | |
726 state, as explained above). | |
727 | |
728 The key @kbd{C-z} is sometimes also useful in Insert state: it allows you | |
729 to execute a single command in Vi state without leaving the Insert state! | |
730 For instance, @kbd{C-z d2w} will delete the next two words without leaving | |
731 the Insert state. | |
732 | |
733 When Viper is in Insert state, you will see <I> in the mode line. | |
734 | |
735 @node Replace State,, Insert State, States in Viper | |
736 @subsection Replace State | |
737 | |
738 @cindex Replace state | |
739 | |
740 This state is entered through Vi replacement commands, such as @kbd{C}, | |
741 @kbd{cw}, etc., or by typing @kbd{R}. In Replace state, Viper puts <R> in | |
742 the mode line to let you know which state is in effect. If Replace state is | |
743 entered through @kbd{R}, Viper stays in that state until the user hits | |
744 @key{ESC}. If this state is entered via the other replacement commands, | |
745 then Replace state is in effect until you hit @key{ESC} or until you cross | |
746 the rightmost boundary of the replacement region. In the latter case, Viper | |
747 changes its state from Replace to Insert (which you will notice by the | |
748 change in the mode line). | |
749 | |
750 Since Viper runs under Emacs, it is possible to switch between buffers | |
751 while in Replace state. You can also move the cursor using the arrow keys | |
752 (even on dumb terminals!)@: and the mouse. Because of this freedom (which is | |
753 unattainable in regular Vi), it is possible to take the cursor outside the | |
754 replacement region. (This may be necessary for several reasons, including | |
755 the need to enable text selection and region-setting with the mouse.) | |
756 | |
757 The issue then arises as to what to do when the user | |
758 hits the @key{ESC} key. In Vi, this would cause the text between cursor and | |
759 the end of the replacement region to be deleted. But what if, as is | |
760 possible in Viper, the cursor is not inside the replacement region? | |
761 | |
762 To solve the problem, Viper keeps track of the last cursor position while it | |
763 was still inside the replacement region. So, in the above situation, Viper | |
764 would delete text between this position and the end of the replacement | |
765 region. | |
766 | |
767 @node The Minibuffer,Multiple Files in Viper, States in Viper, Overview | |
768 @section The Minibuffer | |
769 | |
770 @cindex Minibuffer | |
771 | |
772 The Minibuffer is where commands are entered in. Editing can be done | |
773 by commands from Insert state, namely: | |
774 | |
775 @table @kbd | |
776 @item C-h | |
777 Backspace | |
778 @item C-w | |
779 Delete Word | |
780 @item C-u | |
781 Erase line | |
782 @item C-v | |
783 Quote the following character | |
784 @item @key{RET} | |
785 Execute command | |
786 @item C-g and C-] | |
787 Emacs quit and abort keys. These may be necessary. @xref{Vi State}, for an | |
788 explanation. | |
789 @item M-p and M-n | |
790 These keys are bound to functions that peruse minibuffer history. The | |
791 precise history to be perused depends on the context. It may be the history | |
792 of search strings, Ex commands, file names, etc. | |
793 @end table | |
794 | |
795 Most of the Emacs keys are functional in the Minibuffer. While in the | |
796 Minibuffer, Viper tries to make editing resemble Vi's behavior when the | |
797 latter is waiting for the user to type an Ex command. In particular, you | |
798 can use the regular Vi commands to edit the Minibuffer. You can switch | |
799 between the Vi state and Insert state at will, and even use the replace mode. | |
800 Initially, the Minibuffer comes up in Insert state. | |
801 | |
802 Some users prefer plain Emacs bindings in the Minibuffer. To this end, set | |
803 @code{viper-vi-style-in-minibuffer} to @code{nil} in @file{.viper}. | |
804 @xref{Customization}, to learn how to do this. | |
805 | |
806 When the Minibuffer changes Viper states, you will notice that the appearance | |
807 of the text there changes as well. This is useful because the Minibuffer | |
808 has no mode line to tell which Vi state it is in. | |
809 The appearance of the text in the Minibuffer can be changed. | |
810 @xref{Viper Specials}, for more details. | |
811 | |
812 @node Multiple Files in Viper,Unimplemented Features,The Minibuffer,Overview | |
813 @section Multiple Files in Viper | |
814 | |
815 @cindex multiple files | |
816 @cindex managing multiple files | |
817 | |
818 Viper can edit multiple files. This means, for example that you never need | |
819 to suffer through @code{No write since last change} errors. | |
820 Some Viper elements are common over all the files. | |
821 | |
822 @table @samp | |
823 @item Textmarkers | |
824 @cindex markers | |
825 @cindex textmarkers | |
826 Textmarkers remember @emph{files and positions}. | |
827 If you set marker @samp{a} in | |
828 file @file{foo}, start editing file @file{bar} and type @kbd{'a}, then | |
829 @emph{YOU WILL SWITCH TO FILE @file{foo}}. You can see the contents of a | |
830 textmarker using the Viper command @kbd{[<a-z>} where <a-z> are the | |
831 textmarkers, e.g., @kbd{[a} to view marker @samp{a} .@refill | |
832 @item Repeated Commands | |
833 Command repetitions are common over files. Typing @kbd{!!} will repeat the | |
834 last @kbd{!} command whichever file it was issued from. | |
835 Typing @kbd{.} will repeat the last command from any file, and | |
836 searches will repeat the last search. Ex commands can be repeated by typing | |
837 @kbd{: @key{RET}}.@refill | |
838 Note: in some rare cases, that @kbd{: @key{RET}} may do something dangerous. | |
839 However, usually its effect can be undone by typing @kbd{u}. | |
840 @item Registers | |
841 @cindex registers | |
842 Registers are common to files. Also, text yanked with @kbd{y} can be | |
843 put back (@kbd{p}) into any file. The Viper command @kbd{]<a-z>}, where <a-z> are | |
844 the registers, can be used to look at the contents of a register, e.g., | |
845 type @kbd{]a} to view register @samp{a}. | |
846 | |
847 There is one difference in text deletion that you should be | |
848 aware of. This difference comes from Emacs and was adopted in Viper | |
849 because we find it very useful. In Vi, if you delete a line, say, and then | |
850 another line, these two deletions are separated and are put back | |
851 separately if you use the @samp{p} command. In Emacs (and Viper), successive | |
852 series of deletions that are @emph{not interrupted} by other commands are | |
853 lumped together, so the deleted text gets accumulated and can be put back | |
854 as one chunk. If you want to break a sequence of deletions so that the | |
855 newly deleted text could be put back separately from the previously deleted | |
856 text, you should perform a non-deleting action, e.g., move the cursor one | |
857 character in any direction. | |
858 @item Absolute Filenames | |
859 @cindex absolute paths | |
860 The current directory name for a file is automatically prepended to the | |
861 file name in any | |
862 @kbd{:e}, @kbd{:r}, @kbd{:w}, etc., command (in Emacs, each buffer has a | |
863 current directory). | |
864 This directory is inserted in the Minibuffer once you type space after | |
865 @kbd{:e, r}, etc. Viper also supports completion of file names and Ex | |
866 commands (@key{TAB}), and it keeps track of | |
867 command and file history (@kbd{M-p}, @kbd{M-n}). | |
868 Absolute filenames are required less | |
869 often in Viper. | |
870 | |
871 You should be aware that Emacs interprets @kbd{/foo/bar//bla} as | |
872 @kbd{/bla} and @kbd{/foo/~/bar} as @kbd{~/bar}. This is designed to | |
873 minimize the need for erasing path names that Emacs suggests in its | |
874 prompts, if a suggested path name is not what you wanted. | |
875 | |
876 The command @kbd{:cd} will change the default directory for the | |
877 current Emacs buffer. The Ex command @kbd{:e} will interpret the | |
878 filename argument in @samp{csh}, by default. @xref{Customization}, if you | |
879 want to change this. | |
880 @end table | |
881 | |
882 @noindent | |
883 Currently undisplayed files can be listed using the @kbd{:ar} command. The | |
884 command @kbd{:n} can be given counts from the @kbd{:ar} list to switch to | |
885 other files. | |
886 | |
887 @node Unimplemented Features,,Multiple Files in Viper,Overview | |
888 @section Unimplemented Features | |
889 | |
890 Unimplemented features include: | |
891 | |
892 @itemize @bullet | |
893 @item | |
894 @kbd{:ab} and @kbd{:una} are not implemented. | |
895 Both @kbd{:map} and @kbd{:ab} are considered obsolete, since Emacs has much | |
896 more powerful facilities for defining keyboard macros and abbreviations. | |
897 @item | |
898 @kbd{:set option?} is not implemented. The current | |
899 @kbd{:set} can also be used to set Emacs variables. | |
900 @item | |
901 @kbd{:se list} requires modification of the display code for Emacs, so | |
902 it is not implemented. | |
903 A useful alternative is @code{cat -t -e file}. Unfortunately, it cannot | |
904 be used directly inside Emacs, since Emacs will obdurately change @samp{^I} | |
905 back to normal tabs.@refill | |
906 @end itemize | |
907 | |
908 @comment node-name, next, previous, up | |
909 @node Improvements over Vi, Customization, Overview, Top | |
910 @chapter Improvements over Vi | |
911 | |
912 Some common problems with Vi and Ex have been solved in Viper. This | |
913 includes better implementation of existing commands, new commands, and | |
914 the facilities provided by Emacs. | |
915 | |
916 @menu | |
917 * Basics:: Basic Viper differences, Multi-file effects. | |
918 * Undo and Backups:: Multiple undo, auto-save, backups and changes | |
919 * History:: History for Ex and Vi commands. | |
920 * Macros and Registers:: Keyboard Macros (extended ".")@: @@reg execution. | |
921 * Completion:: Filename and Command Completion for Ex. | |
922 * Improved Search:: Incremental Search and Buffer Content Search. | |
923 * Abbreviation Facilities:: Normal Abbrevs, Templates, and Dynamic Abbrevs. | |
924 * Movement and Markers:: Screen Editor movements, viewing textmarkers. | |
925 * New Commands:: Commands that do not exist in Vi. | |
926 * Useful Packages:: A Sampling of some Emacs packages, and things | |
927 you should know about. | |
928 @end menu | |
929 | |
930 @node Basics, Undo and Backups, Improvements over Vi, Improvements over Vi | |
931 @section Basics | |
932 | |
933 The Vi command set is based on the idea of combining motion commands | |
934 with other commands. The motion command is used as a text region | |
935 specifier for other commands. | |
936 We classify motion commands into @dfn{point commands} and | |
937 @dfn{line commands}.@refill | |
938 | |
939 @cindex point commands | |
940 | |
941 The point commands are: | |
942 | |
943 @quotation | |
944 @kbd{h}, @kbd{l}, @kbd{0}, @kbd{$}, @kbd{w}, @kbd{W}, @kbd{b}, @kbd{B}, | |
945 @kbd{e}, @kbd{E}, @kbd{(}, @kbd{)}, @kbd{/}, @kbd{?}, @kbd{`}, @kbd{f}, | |
946 @kbd{F}, @kbd{t}, @kbd{T}, @kbd{%}, @kbd{;}, @kbd{,}, @kbd{^} | |
947 @end quotation | |
948 | |
949 @cindex line commands | |
950 | |
951 The line commands are: | |
952 | |
953 @quotation | |
954 @kbd{j}, @kbd{k}, @kbd{+}, @kbd{-}, @kbd{H}, @kbd{M}, @kbd{L}, @kbd{@{}, | |
955 @kbd{@}}, @kbd{G}, @kbd{'}, @kbd{[[}, @kbd{]]}, @kbd{[]} | |
956 @end quotation | |
957 | |
958 @cindex region | |
959 @cindex region specification | |
960 @cindex expanding (region) | |
961 @cindex describing regions | |
962 @cindex movement commands | |
963 | |
964 @noindent | |
965 If a point command is given as an argument to a modifying command, the | |
966 region determined by the point command will be affected by the modifying | |
967 command. On the other hand, if a line command is given as an argument to a | |
968 modifying command, the region determined by the line command will be | |
969 enlarged so that it will become the smallest region properly containing the | |
970 region and consisting of whole lines (we call this process @dfn{expanding | |
971 the region}), and then the enlarged region will be affected by the modifying | |
972 command. | |
973 Text Deletion Commands (@pxref{Deleting Text}), Change commands | |
974 (@pxref{Changing Text}), even Shell Commands (@pxref{Shell Commands}) | |
975 use these commands to describe a region of text to operate on. | |
976 Thus, type @kbd{dw} to delete a word, @kbd{>@}} to shift a paragraph, or | |
977 @kbd{!'afmt} to format a region from @samp{point} to textmarker | |
978 @samp{a}. | |
979 | |
980 @cindex r and R region specifiers | |
981 | |
982 Viper adds the region specifiers @samp{r} and @samp{R}. Emacs has a | |
983 special marker called @dfn{mark}. The text-area between the current cursor | |
984 position @dfn{point} and the @dfn{mark} is called the @dfn{region}. | |
985 @samp{r} specifies the raw region and @samp{R} is the expanded region | |
986 (i.e., the minimal contiguous chunk of full lines that contains the raw | |
987 region). | |
988 @kbd{dr} will now delete the region, @kbd{>r} will shift it, etc. | |
989 @kbd{r,R} are not motion commands, however. The special mark is set by | |
990 @kbd{m.} and other commands. @xref{Marking}, for more info. | |
991 | |
992 Viper also adds counts to most commands for which it would make sense. | |
993 | |
994 In the Overview chapter, some Multiple File issues were discussed | |
995 (@pxref{Multiple Files in Viper}). In addition to the files, Emacs has | |
996 buffers. These can be seen in the @kbd{:args} list and switched using | |
997 @kbd{:next} if you type @kbd{:set ex-cycle-through-non-files t}, or | |
998 specify @code{(setq ex-cycle-through-non-files t)} in your @file{.viper} | |
999 file. @xref{Customization}, for details. | |
1000 | |
1001 @node Undo and Backups, History, Basics, Improvements over Vi | |
1002 @section Undo and Backups | |
1003 | |
1004 @cindex undo | |
1005 | |
1006 Viper provides multiple undo. The number of undo's and the size is limited | |
1007 by the machine. The Viper command @kbd{u} does an undo. Undo can be | |
1008 repeated by typing @kbd{.} (a period). Another @kbd{u} will undo the undo, | |
1009 and further | |
1010 @kbd{.} will repeat it. Typing @kbd{u} does the first undo, and changes the | |
1011 direction. | |
1012 | |
1013 @cindex backup files | |
1014 @cindex auto save | |
1015 | |
1016 Since the undo size is limited, Viper can create backup files and | |
1017 auto-save files. It will normally do this automatically. It is possible | |
1018 to have numbered backups, etc. For details, @pxref{Backup,,Backup and | |
1019 Auto-Save,emacs,The GNU Emacs Manual} @refill | |
1020 | |
1021 @comment [ balance parens | |
1022 @cindex viewing registers and markers | |
1023 @cindex registers | |
1024 @cindex markers | |
1025 @cindex textmarkers | |
1026 | |
1027 The results of the 9 previous changes are available in the 9 numeric | |
1028 registers, as in Vi. The extra goody is the ability to @emph{view} these | |
1029 registers, in addition to being able to access them through @kbd{p} and | |
1030 @kbd{M-y} (@xref{Insert State}, for details.) | |
1031 The Viper command @kbd{] register} will display the contents of any | |
1032 register, numeric or alphabetical. The related command @kbd{[ textmarker} | |
1033 will show the text around the textmarker. @samp{register} and @samp{textmarker} | |
1034 can be any letters from a through z. | |
1035 @comment ] balance parens | |
1036 | |
1037 @node History, Macros and Registers, Undo and Backups,Improvements over Vi | |
1038 @section History | |
1039 | |
1040 @cindex history | |
1041 @cindex Minibuffer | |
1042 | |
1043 History is provided for Ex commands, Vi searches, file names, pieces of | |
1044 text inserted in earlier commands that use Insert or Replace state, and for | |
1045 destructive commands in Vi state. These are | |
1046 useful for fixing those small typos that screw up searches and @kbd{:s}, | |
1047 and for eliminating routine associated with repeated typing of file names | |
1048 or pieces of text that need to be inserted frequently. | |
1049 At the @kbd{:} or @kbd{/} prompts in the Minibuffer, you can do the following: | |
1050 | |
1051 @table @kbd | |
1052 @item M-p and M-n | |
1053 To move to previous and next history items. This causes the history | |
1054 items to appear on the command line, where you can edit them, or | |
1055 simply type Return to execute. | |
1056 @item M-r and M-s | |
1057 To search backward and forward through the history. | |
1058 @item @key{RET} | |
1059 Type @key{RET} to accept a default (which is displayed in the prompt). | |
1060 @end table | |
1061 | |
1062 The history of insertions can be perused by | |
1063 typing @kbd{C-c M-p} and @kbd{C-c M-n} while in Insert or Replace state. | |
1064 The history of destructive Vi commands can be perused via the same keys | |
1065 when Viper is in Vi state. @xref{Viper Specials}, for details. | |
1066 | |
1067 All Ex commands have a file history. For instance, typing @kbd{:e}, space | |
1068 and then @kbd{M-p} will bring up the name of the previously typed file | |
1069 name. Repeatedly typing @kbd{M-p}, @kbd{M-n}, etc., will let you browse | |
1070 through the file history. | |
1071 | |
1072 Similarly, commands that have to do with switching buffers | |
1073 have a buffer history, and commands that expect strings or regular | |
1074 expressions keep a history on those items. | |
1075 | |
1076 @node Macros and Registers,Completion,History,Improvements over Vi | |
1077 @section Macros and Registers | |
1078 | |
1079 @cindex keyboard macros | |
1080 @cindex macros | |
1081 @cindex registers | |
1082 @cindex register execution | |
1083 | |
1084 Viper facilitates the use of Emacs-style keyboard macros. @kbd{@@#} will | |
1085 start a macro definition. As you type, the commands will be executed, and | |
1086 remembered (This is called ``learn mode'' in some editors.) | |
1087 @kbd{@@register} will complete the macro, putting it into @samp{register}, | |
1088 where @samp{register} is any character from @samp{a} through @samp{z}. Then | |
1089 you can execute this macro using @kbd{@@register}. It is, of course, | |
1090 possible to yank some text into a register and execute it using | |
1091 @kbd{@@register}. Typing @kbd{@@@@}, @kbd{@@RET}, or @kbd{@@C-j} will | |
1092 execute the last macro that was executed using @kbd{@@register}.@refill | |
1093 | |
1094 Viper will automatically lowercase the register, so that pressing the | |
1095 @kbd{SHIFT} key for @kbd{@@} will not create problems. This is for | |
1096 @kbd{@@} macros and @kbd{"p} @emph{only}. In the case of @kbd{y}, | |
1097 @kbd{"Ayy} will append to @emph{register a}. For @kbd{[,],',`}, it | |
1098 is an error to use a Uppercase register name. | |
1099 | |
1100 @comment [ balance parens | |
1101 @cindex viewing registers and markers | |
1102 | |
1103 The contents of a register can be seen by @kbd{]register}. (@kbd{[textmarker} | |
1104 will show the contents of a textmarker). | |
1105 @comment ] balance parens | |
1106 | |
1107 @cindex last keyboard macro | |
1108 | |
1109 The last keyboard macro can also be executed using | |
1110 @kbd{*}, and it can be yanked into a register using @kbd{@@!register}. | |
1111 This is useful for Emacs style keyboard macros defined using @kbd{C-x(} | |
1112 and @kbd{C-x)}. Emacs keyboard macros have more capabilities. | |
1113 @xref{Keyboard Macros,,Keyboard Macros,emacs, The GNU Emacs Manual}, for | |
1114 details.@refill | |
1115 | |
1116 Keyboard Macros allow an interesting form of Query-Replace: | |
1117 @kbd{/pattern} or @kbd{n} to go to the next pattern (the query), followed by a | |
1118 Keyboard Macro execution @kbd{@@@@} (the replace). | |
1119 | |
1120 Viper also provides Vi-style macros. @xref{Vi Macros}, for details. | |
1121 | |
1122 | |
1123 @node Completion, Improved Search, Macros and Registers, Improvements over Vi | |
1124 @section Completion | |
1125 | |
1126 @cindex completion | |
1127 | |
1128 Completion is done when you type @key{TAB}. The Emacs completer does not | |
1129 grok wildcards in filenames. Once you type a wildcard, the completer will | |
1130 no longer work for that path. Remember that Emacs interprets a file name | |
1131 of the form @kbd{/foo//bar} as @kbd{/bar} and @kbd{/foo/~/bar} as | |
1132 @kbd{~/bar}. | |
1133 | |
1134 @node Improved Search, Abbreviation Facilities, Completion, Improvements over Vi | |
1135 @section Improved Search | |
1136 | |
1137 @cindex buffer search | |
1138 @cindex word search | |
1139 | |
1140 Viper provides buffer search, the ability to search the buffer for a region | |
1141 under the cursor. You have to turn this on in @file{.viper} either by calling | |
1142 | |
1143 @example | |
1144 (viper-buffer-search-enable) | |
1145 @end example | |
1146 | |
1147 @noindent | |
1148 or by setting @code{viper-buffer-search-char} to, say, @kbd{f3}: | |
1149 @example | |
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1150 (setq viper-buffer-search-char ?g) |
25829 | 1151 @end example |
1152 | |
1153 @noindent | |
1154 If the user calls @code{viper-buffer-search-enable} explicitly (the first | |
1155 method), then @code{viper-buffer-search-char} will be set to @kbd{g}. | |
1156 Regardless of how this feature is enabled, the key | |
1157 @code{viper-buffer-search-char} will take movement commands, like | |
1158 @kbd{w,/,e}, to find a region and then search for the contents of that | |
1159 region. This command is very useful for searching for variable names, etc., | |
1160 in a program. The search can be repeated by @kbd{n} or reversed by @kbd{N}. | |
1161 | |
1162 @cindex incremental search | |
1163 | |
1164 Emacs provides incremental search. As you type the string in, the | |
1165 cursor will move to the next match. You can snarf words from the buffer | |
1166 as you go along. Incremental Search is normally bound to @kbd{C-s} and | |
1167 @kbd{C-r}. @xref{Customization}, to find out how to change the bindings | |
1168 of @kbd{C-r or C-s}. | |
1169 For details, @pxref{Incremental Search,,Incremental | |
1170 Search,emacs,The GNU Emacs Manual} @refill | |
1171 | |
1172 @cindex query replace | |
1173 | |
1174 Viper also provides a query replace function that prompts through the | |
1175 Minibuffer. It is invoked by the @kbd{Q} key in Vi state. | |
1176 | |
1177 @cindex mouse search | |
1178 | |
1179 On a window display, Viper supports mouse search, i.e., you can search for a | |
1180 word by clicking on it. @xref{Viper Specials}, for details. | |
1181 | |
1182 Finally, on a window display, Viper highlights search patterns as it finds | |
1183 them. This is done through what is known as @emph{faces} in Emacs. The | |
1184 variable that controls how search patterns are highlighted is | |
1185 @code{viper-search-face}. If you don't want any highlighting at all, put | |
1186 @example | |
1187 (copy-face 'default 'viper-search-face) | |
1188 @end example | |
1189 @vindex @code{viper-search-face} | |
1190 @noindent | |
1191 in @file{~/.viper}. If you want to change how patterns are highlighted, you | |
1192 will have to change @code{viper-search-face} to your liking. The easiest | |
1193 way to do this is to use Emacs customization widget, which is accessible | |
1194 from the menubar. Viper customization group is located under the | |
1195 @emph{Emulations} customization group, which in turn is under the | |
1196 @emph{Editing} group. All Viper faces are grouped together under Viper's | |
1197 @emph{Highlighting} group. | |
1198 | |
1199 Try it: it is really simple! | |
1200 | |
1201 @node Abbreviation Facilities,Movement and Markers,Improved Search,Improvements over Vi | |
1202 @section Abbreviation Facilities | |
1203 | |
1204 @cindex abbrevs | |
1205 | |
1206 It is possible in Emacs to define abbrevs based on the contents of the | |
1207 buffer. | |
1208 Sophisticated templates can be defined using the Emacs abbreviation | |
1209 facilities. @xref{Abbrevs,,Abbreviations,emacs,The GNU Emacs Manual}, for | |
1210 details. | |
1211 | |
1212 @cindex dynamic abbrevs | |
1213 | |
1214 Emacs also provides Dynamic Abbreviations. Given a partial word, Emacs | |
1215 will search the buffer to find an extension for this word. For instance, | |
1216 one can type @samp{Abbreviations} by typing @samp{A}, followed by a keystroke | |
1217 that completed the @samp{A} to @samp{Abbreviations}. Repeated typing | |
1218 will search further back in the buffer, so that one could get | |
1219 @samp{Abbrevs} by repeating the | |
1220 keystroke, which appears earlier in the text. Emacs binds this to | |
1221 @kbd{@key{ESC} /}, so you will have to find a key and bind the function | |
1222 @code{dabbrev-expand} to that key. | |
1223 Facilities like this make Vi's @kbd{:ab} command obsolete. | |
1224 | |
1225 @node Movement and Markers, New Commands, Abbreviation Facilities, Improvements over Vi | |
1226 @section Movement and Markers | |
1227 | |
1228 @cindex Ex style motion | |
1229 @cindex line editor motion | |
1230 | |
1231 Viper can be set free from the line--limited movements in Vi, such as @kbd{l} | |
1232 refusing to move beyond the line, @key{ESC} moving one character back, | |
1233 etc. These derive from Ex, which is a line editor. If your @file{.viper} | |
1234 contains | |
1235 | |
1236 @example | |
1237 @code{(setq viper-ex-style-motion nil)} | |
1238 @end example | |
1239 | |
1240 @noindent | |
1241 the motion will be a true screen editor motion. One thing you must then | |
1242 watch out for is that it is possible to be on the end-of-line character. | |
1243 The keys @kbd{x} and @kbd{%} will still work correctly, i.e., as if they | |
1244 were on the last character. | |
1245 | |
1246 @vindex @code{viper-syntax-preference} | |
1247 @cindex syntax table | |
1248 | |
1249 The word-movement commands @kbd{w}, @kbd{e}, etc., and the associated | |
1250 deletion/yanking commands, @kbd{dw}, @kbd{yw}, etc., can be made to | |
1251 understand Emacs syntax tables. If the variable | |
1252 @code{viper-syntax-preference} is set to @code{strict-vi} then | |
1253 the meaning of @emph{word} is the same as in | |
1254 Vi. However, if the value is @code{reformed-vi} (the default) then the | |
1255 alphanumeric symbols will be those specified by the current Emacs syntax | |
1256 table (which may be different for different major modes) plus the | |
1257 underscore symbol @kbd{_}, minus some non-word symbols, like '.;,|, etc. | |
1258 Both @code{strict-vi} and @code{reformed-vi} work close to Vi in | |
1259 traditional cases, but @code{reformed-vi} does a better job when editing | |
1260 text in non-Latin alphabets. | |
1261 | |
1262 The user can also specify the value @code{emacs}, which would | |
1263 make Viper use exactly the Emacs notion of word. In particular, the | |
1264 underscore may not be part of a word. Finally, if | |
1265 @code{viper-syntax-preference} is set to @code{extended}, Viper words would | |
1266 consist of characters that are classified as alphanumeric @emph{or} as | |
1267 parts of symbols. This is convenient for writing programs and in many other | |
1268 situations. | |
1269 | |
1270 @code{viper-syntax-preference} is a local variable, so it can have different | |
1271 values for different major modes. For instance, in programming modes it can | |
1272 have the value @code{extended}. In text modes where words contain special | |
1273 characters, such as European (non-English) letters, Cyrillic letters, etc., | |
1274 the value can be @code{reformed-vi} or @code{emacs}. | |
1275 | |
1276 Changes to @code{viper-syntax-preference} should be done in the hooks to | |
1277 various major modes by executing @code{viper-set-syntax-preference} as in | |
1278 the following example: | |
1279 | |
1280 @example | |
1281 (viper-set-syntax-preference nil "emacs") | |
1282 @end example | |
1283 | |
1284 @findex @code{viper-set-syntax-preference} | |
1285 | |
1286 The above discussion of the meaning of Viper's words concerns only Viper's | |
1287 movement commands. In regular expressions, words remain the same as in | |
1288 Emacs. That is, the expressions @code{\w}, @code{\>}, @code{\<}, etc., use | |
1289 Emacs' idea of what is a word, and they don't look into the value of | |
1290 variable @code{viper-syntax-preference}. This is because Viper doesn't change | |
1291 syntax tables in fear of upsetting the various major modes that set these | |
1292 tables. | |
1293 | |
1294 @cindex textmarkers | |
1295 | |
1296 Textmarkers in Viper remember the file and the position, so that you can | |
1297 switch files by simply doing @kbd{'a}. If you set up a regimen for using | |
1298 Textmarkers, this is very useful. Contents of textmarkers can be viewed | |
1299 by @kbd{[marker}. (Contents of registers can be viewed by @kbd{]register}). | |
1300 | |
1301 @node New Commands, Useful Packages, Movement and Markers, Improvements over Vi | |
1302 @section New Commands | |
1303 | |
1304 These commands have no Vi analogs. | |
1305 | |
1306 @table @kbd | |
1307 @item C-x, C-c | |
1308 @kindex @kbd{C-x} | |
1309 @kindex @kbd{C-c} | |
1310 These two keys invoke many important Emacs functions. For example, if you | |
1311 hit @kbd{C-x} followed by @kbd{2}, then the current window will be split | |
1312 into 2. Except for novice users, @kbd{C-c} is also set to execute an Emacs | |
1313 command from the current major mode. @key{ESC} will do the same, if you | |
1314 configure @key{ESC} as Meta by setting @code{viper-no-multiple-ESC} to nil | |
1315 in @file{.viper}. @xref{Customization}. @kbd{C-\} in Insert, Replace, or Vi | |
1316 states will make Emacs think @kbd{Meta} has been hit.@refill | |
1317 @item \ | |
1318 @kindex @kbd{\} | |
1319 Escape to Emacs to execute a single Emacs command. For instance, | |
1320 @kbd{\ @key{ESC}} will act like a Meta key. | |
1321 @item Q | |
1322 @kindex @kbd{Q} | |
1323 @cindex query replace | |
1324 @kbd{Q} is for query replace. By default, | |
1325 each string to be replaced is treated as a regular expression. You can use | |
1326 @code{(setq viper-re-query-replace nil)} in your @file{.emacs} file to | |
1327 turn this off. (For normal searches, @kbd{:se nomagic} will work. Note | |
1328 that @kbd{:se nomagic} turns Regexps off completely, unlike Vi). | |
1329 @item v | |
1330 @itemx V | |
1331 @itemx C-v | |
1332 @kindex @kbd{v} | |
1333 @kindex @kbd{V} | |
1334 @kindex @kbd{C-v} | |
1335 These keys are used to visit files. @kbd{v} will switch to a buffer | |
1336 visiting file whose name can be entered in the Minibuffer. @kbd{V} is | |
1337 similar, but will use a window different from the current window. | |
1338 @kbd{C-v} is like @kbd{V}, except that a new frame (X window) will be used | |
1339 instead of a new Emacs window. | |
1340 @item # | |
1341 @kindex @kbd{#} | |
1342 If followed by a certain character @var{ch}, it becomes an operator whose | |
1343 argument is the region determined by the motion command that follows | |
1344 (indicated as <move>). | |
1345 Currently, @var{ch} can be one of @kbd{c}, @kbd{C}, @kbd{g}, @kbd{q}, and | |
1346 @kbd{s}. For instance, @kbd{#qr} will prompt you for a string and then | |
1347 prepend this string to each line in the buffer.@refill | |
1348 @item # c | |
1349 @kindex @kbd{#c<move>} | |
1350 @cindex changing case | |
1351 Change upper-case characters in the region to lower-case | |
1352 (@code{downcase-region}). | |
1353 Emacs command @kbd{M-l} does the same for words. | |
1354 @item # C | |
1355 @kindex @kbd{#C<move>} | |
1356 Change lower-case characters in the region to upper-case. For instance, | |
1357 @kbd{# C 3 w} will capitalize 3 words from the current point | |
1358 (@code{upcase-region}). | |
1359 Emacs command @kbd{M-u} does the same for words. | |
1360 @item # g | |
1361 @kindex @kbd{#g<move>} | |
1362 Execute last keyboard macro for each line in the region | |
1363 (@code{viper-global-execute}).@refill | |
1364 @item # q | |
1365 @kindex @kbd{#q<move>} | |
1366 Insert specified string at the beginning of each line in the region | |
1367 (@code{viper-quote-region}). The default string is composed of the comment | |
1368 character(s) appropriate for the current major mode. | |
1369 @item # s | |
1370 @kindex @kbd{#s<move>} | |
1371 Check spelling of words in the region (@code{spell-region}). | |
1372 The function used for spelling is determined from the variable | |
1373 @code{viper-spell-function}. | |
1374 @vindex @code{viper-spell-function} | |
1375 @item * | |
1376 @kindex @kbd{*} | |
1377 Call last keyboard macro. | |
1378 @item m . | |
1379 Set mark at point and push old mark off the ring | |
1380 @item m< | |
1381 @item m> | |
1382 Set mark at beginning and end of buffer, respectively. | |
1383 @item m, | |
1384 Jump to mark and pop mark off the ring. @xref{Mark,,Mark,emacs,The GNU | |
1385 Emacs Manual}, for more info. | |
1386 @item ] register | |
1387 @kindex @kbd{]<a-z>} | |
1388 View contents of register | |
1389 @item [ textmarker | |
1390 @kindex @kbd{[<a-z>} | |
1391 View filename and position of textmarker | |
1392 @item @@# | |
1393 @item @@register | |
1394 @item @@! | |
1395 @kindex @kbd{@@#} | |
1396 @kindex @kbd{@@<a-z>} | |
1397 @kindex @kbd{@@!} | |
1398 @cindex keyboard macros | |
1399 @cindex register execution | |
1400 | |
1401 Begin/end keyboard macro. @@register has a different meaning when used after | |
1402 a @kbd{@@#}. @xref{Macros and Registers}, for details | |
1403 @item [] | |
1404 @kindex @kbd{[]} | |
1405 Go to end of heading. | |
1406 @item g <@emph{movement command}> | |
1407 Search buffer for text delimited by movement command. The canonical | |
1408 example is @kbd{gw} to search for the word under the cursor. | |
1409 @xref{Improved Search}, for details.@refill | |
1410 @item C-g and C-] | |
1411 @kindex @kbd{C-g} | |
1412 @kindex @kbd{C-]} | |
1413 Quit and Abort Recursive edit. These may be necessary on occasion. | |
1414 @xref{Vi State}, for a reason. | |
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1415 @item C-c C-g |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1416 @kindex @kbd{C-c C-g} |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1417 Hitting @kbd{C-c} followed by @kbd{C-g} will display the information on the |
25829 | 1418 current buffer. This is the same as hitting @kbd{C-g} in Vi, but, as |
1419 explained above, @kbd{C-g} is needed for other purposes in Emacs. | |
1420 @item C-c / | |
1421 @kindex @kbd{C-c /} | |
1422 Without a prefix argument, this command toggles | |
1423 case-sensitive/case-insensitive search modes and plain vanilla/regular | |
1424 expression search. With the prefix argument 1, i.e., | |
1425 @kbd{1 C-c /}, this toggles case-sensitivity; with the prefix argument 2, | |
1426 toggles plain vanilla search and search using | |
1427 regular expressions. @xref{Viper Specials}, for alternative ways to invoke | |
1428 this function. | |
1429 @cindex vanilla search | |
1430 @cindex case-sensitive search | |
1431 @cindex case-insensitive search | |
1432 | |
1433 @item M-p and M-n | |
1434 @kindex @kbd{M-p} | |
1435 @kindex @kbd{M-n} | |
1436 In the Minibuffer, these commands navigate through the minibuffer | |
1437 histories, such as the history of search strings, Ex commands, etc. | |
1438 | |
1439 @item C-c M-p and C-c M-n | |
1440 @kindex @kbd{C-c M-p} | |
1441 @kindex @kbd{C-c M-n} | |
1442 @cindex Insertion history | |
1443 @cindex Insertion ring | |
1444 @cindex Command history | |
1445 @cindex Command ring | |
1446 | |
1447 In Insert or Replace state, these commands let the user | |
1448 peruse the history of insertion strings used in previous insert or replace | |
1449 commands. Try to hit @kbd{C-c M-p} or @kbd{C-c M-n} repeatedly and see what | |
1450 happens. @xref{Viper Specials}, for more. | |
1451 | |
1452 In Vi state, these commands let the user peruse the history of Vi-style | |
1453 destructive commands, such as @kbd{dw}, @kbd{J}, @kbd{a}, etc. | |
1454 By repeatedly typing @kbd{C-c M-p} or @kbd{C-c M-n} you will cycle Viper | |
1455 through the recent history of Vi commands, displaying the commands one by | |
1456 one. Once | |
1457 an appropriate command is found, it can be executed by typing `@kbd{.}'. | |
1458 | |
1459 Since typing @kbd{C-c M-p} is tedious, it is more convenient to bind an | |
1460 appropriate function to a function key on the keyboard and use that key. | |
1461 @xref{Viper Specials}, for details. | |
1462 | |
1463 @item Ex commands | |
1464 @findex @kbd{:args} | |
1465 @findex @kbd{:n} | |
1466 @findex @kbd{:pwd} | |
1467 @findex @kbd{:pre} | |
1468 The commands @kbd{:args}, @kbd{:next}, @kbd{:pre} behave | |
1469 differently. @kbd{:pwd} exists to get current directory. | |
1470 The commands @kbd{:b} and @kbd{:B} switch buffers around. @xref{File and | |
1471 Buffer Handling}, for details. | |
1472 There are also the new commands @kbd{:RelatedFile} and | |
1473 @kbd{PreviousRelatedFile} (which abbreviate to @kbd{R} and @kbd{P}, | |
1474 respectively. @xref{Viper Specials}, for details. | |
1475 @findex @kbd{:RelatedFile} | |
1476 @findex @kbd{:PreviousRelatedFile} | |
1477 @end table | |
1478 | |
1479 Apart from the new commands, many old commands have been enhanced. Most | |
1480 notably, Vi style macros are much more powerful in Viper than in Vi. @xref{Vi | |
1481 Macros}, for details. | |
1482 | |
1483 @node Useful Packages, ,New Commands, Improvements over Vi | |
1484 @section Useful Packages | |
1485 | |
1486 Some Emacs packages are mentioned here as an aid to the new Viper user, to | |
1487 indicate what Viper is capable of. | |
1488 A vast number comes with the standard Emacs distribution, and many more exist | |
1489 on the net and on the archives. | |
1490 | |
1491 This manual also mentions some Emacs features a new user | |
1492 should know about. The details of these are found in the GNU Emacs | |
1493 Manual. | |
1494 | |
1495 The features first. For details, look up the Emacs Manual. | |
1496 | |
1497 @table @samp | |
1498 @item Make | |
1499 @cindex make | |
1500 @cindex compiling | |
1501 | |
1502 Makes and Compiles can be done from the editor. Error messages will be | |
1503 parsed and you can move to the error lines. | |
1504 @item Shell | |
1505 @cindex shell | |
1506 @cindex interactive shell | |
1507 You can talk to Shells from inside the editor. Your entire shell session | |
1508 can be treated as a file. | |
1509 @item Mail | |
1510 @cindex email | |
1511 @cindex mail | |
1512 Mail can be read from and sent within the editor. Several sophisticated | |
1513 packages exist. | |
1514 @item Language Sensitive Editing | |
1515 Editing modes are written for most computer languages in existence. By | |
1516 controlling indentation, they catch punctuation errors. | |
1517 @end table | |
1518 | |
1519 The packages, below, represents a drop in the sea of special-purpose | |
1520 packages that come with standard distribution of Emacs. | |
1521 | |
1522 @table @samp | |
1523 @item Transparent FTP | |
1524 @cindex transparent ftp | |
1525 @pindex ange-ftp.el | |
1526 @code{ange-ftp.el} can ftp from the editor to files on other machines | |
1527 transparent to the user. | |
1528 @item RCS Interfaces | |
1529 @cindex version maintenance | |
1530 @cindex RCS | |
1531 @pindex vc.el | |
1532 @code{vc.el} for doing RCS commands from inside the editor | |
1533 @item Directory Editor | |
1534 @cindex dired | |
1535 @pindex dired.el | |
1536 @code{dired.el} for editing contents of directories and for navigating in | |
1537 the file system. | |
1538 @item Syntactic Highlighting | |
1539 @cindex font-lock | |
1540 @pindex font-lock.el | |
1541 @code{font-lock.el} for automatic highlighting various parts of a buffer | |
1542 using different fonts and colors. | |
1543 @item Saving Emacs Configuration | |
1544 @cindex desktop | |
1545 @pindex desktop.el | |
1546 @code{desktop.el} for saving/restoring configuration on Emacs exit/startup. | |
1547 @item Spell Checker | |
1548 @cindex ispell | |
1549 @pindex ispell.el | |
1550 @code{ispell.el} for spell checking the buffer, words, regions, etc. | |
1551 @item File and Buffer Comparison | |
1552 @cindex ediff | |
1553 @pindex ediff.el | |
1554 @code{ediff.el} for finding differences between files and for applying | |
1555 patches. | |
1556 @end table | |
1557 | |
1558 @noindent | |
1559 Emacs Lisp archives exist on | |
1560 @samp{archive.cis.ohio-state.edu} | |
1561 and @samp{wuarchive.wustl.edu}@refill | |
1562 | |
1563 | |
1564 @node Customization,Commands,Improvements over Vi,Top | |
1565 @chapter Customization | |
1566 | |
1567 @cindex customization | |
1568 | |
1569 Customization can be done in 2 ways. | |
1570 | |
1571 @itemize @bullet | |
1572 @item | |
1573 @cindex initialization | |
1574 @cindex .viper | |
1575 Elisp code in a @file{.viper} file in your home directory. Viper | |
1576 loads @file{.viper} just before it does the binding for mode | |
1577 hooks. This is the recommended method. | |
1578 @item | |
1579 @cindex .emacs | |
1580 Elisp code in your @file{.emacs} file before and after the @code{(require | |
1581 'viper)} line. This method is not recommended, unless you know what you are | |
1582 doing. Only two variables, @code{viper-mode} and | |
1583 @code{viper-custom-file-name} are supposed to be customized in @file{.emacs}, | |
1584 prior to loading Viper.@refill | |
1585 @end itemize | |
1586 | |
1587 @noindent | |
1588 Most of Viper's behavior can be customized via the interactive Emacs user | |
1589 interface. Choose "Customize" from the menubar, click on "Editing", then on | |
1590 "Emulations". The customization widget is self-explanatory. Once you are | |
1591 satisfied with your changes, save them into a file and then include the | |
1592 contents of that file in the Viper customization repository, @file{.viper} | |
1593 (except for @code{viper-mode} and @code{viper-custom-file-name}, which are | |
1594 supposed to go into @code{.emacs}). | |
1595 | |
1596 Some advanced customization cannot be accomplished this way, however, and | |
1597 has to be done in Emacs Lisp. For the common cases, examples are provided | |
1598 that you can use directly. | |
1599 | |
1600 @menu | |
1601 * Rudimentary Changes:: Simple constant definitions. | |
1602 * Keybindings:: Enabling Emacs Keys, Rebinding keys, etc. | |
1603 * Packages that Change Keymaps:: How to deal with such beasts. | |
1604 * Viper Specials:: Special Viper commands. | |
1605 * Vi Macros:: How to do Vi style macros. | |
1606 @end menu | |
1607 | |
1608 @node Rudimentary Changes,Keybindings,Customization,Customization | |
1609 @section Rudimentary Changes | |
1610 | |
1611 @cindex setting variables | |
1612 @cindex variables for customization | |
1613 @findex @kbd{:set} | |
1614 | |
1615 An easy way to customize Viper is to change the values of constants used in | |
1616 Viper. Here is the list of the constants used in Viper and their default | |
1617 values. The corresponding :se command is also indicated. (The symbols | |
1618 @code{t} and @code{nil} represent ``true'' and ``false'' in Lisp). | |
1619 | |
1620 Viper supports both the abbreviated Vi variable names and their full | |
1621 names. Variable completion is done on full names only. @key{TAB} and | |
1622 @key{SPC} complete | |
1623 variable names. Typing `=' will complete the name and then will prompt for | |
1624 a value, if applicable. For instance, @kbd{:se au @key{SPC}} will complete the | |
1625 command to @kbd{:set autoindent}; @kbd{:se ta @key{SPC}} will complete the command | |
1626 and prompt further like this: @kbd{:set tabstop = }. | |
1627 However, typing @kbd{:se ts @key{SPC}} will produce a ``No match'' message | |
1628 because @kbd{ts} is an abbreviation for @kbd{tabstop} and Viper supports | |
1629 completion on full names only. However, you can still hit @key{RET} | |
1630 or @kbd{=}, which will complete the command like this: @kbd{:set ts = } and | |
1631 Viper will be waiting for you to type a value for the tabstop variable. | |
1632 To get the full list of Vi variables, type @kbd{:se @key{SPC} @key{TAB}}. | |
1633 | |
1634 @table @code | |
1635 @item viper-auto-indent nil | |
1636 @itemx :se ai (:se autoindent) | |
1637 @itemx :se ai-g (:se autoindent-global) | |
1638 If @code{t}, enable auto indentation. | |
1639 by @key{RET}, @kbd{o} or @kbd{O} command. | |
1640 | |
1641 @code{viper-auto-indent} is a local variable. To change the value globally, use | |
1642 @code{setq-default}. It may be useful for certain major modes to have their | |
1643 own values of @code{viper-auto-indent}. This can be achieved by using | |
1644 @code{setq} to change the local value of this variable in the hooks to the | |
1645 appropriate major modes. | |
1646 | |
1647 @kbd{:se ai} changes the value of @code{viper-auto-indent} in the current | |
1648 buffer only; @kbd{:se ai-g} does the same globally. | |
1649 @item viper-electric-mode t | |
1650 If not @code{nil}, auto-indentation becomes electric, which means that | |
1651 @key{RET}, @kbd{O}, and @kbd{o} indent cursor according to the current | |
1652 major mode. In the future, this variable may control additional electric | |
1653 features. | |
1654 | |
1655 This is a local variable: @code{setq} changes the value of this variable | |
1656 in the current buffer only. Use @code{setq-default} to change the value in | |
1657 all buffers. | |
1658 @item viper-case-fold-search nil | |
1659 @itemx :se ic (:se ignorecase) | |
1660 If not @code{nil}, search ignores cases. | |
1661 This can also be toggled by quickly hitting @kbd{/} twice. | |
1662 @item viper-re-search nil | |
1663 @itemx :se magic | |
1664 If not @code{nil}, search will use regular expressions; if @code{nil} then | |
1665 use vanilla search. | |
1666 This behavior can also be toggled by quickly hitting @kbd{/} trice. | |
1667 @item buffer-read-only | |
1668 @itemx :se ro (:se readonly) | |
1669 Set current buffer to read only. To change globally put | |
1670 @code{(setq-default buffer-read-only t)} in your @file{.emacs} file. | |
1671 @item blink-matching-paren t | |
1672 @itemx :se sm (:se showmatch) | |
1673 Show matching parens by blinking cursor. | |
1674 @item tab-width t (default setting via @code{setq-default}) | |
1675 @itemx :se ts=value (:se tabstop=value) | |
1676 @itemx :se ts-g=value (:se tabstop-global=value) | |
1677 @code{tab-width} is a local variable that controls the width of the tab stops. | |
1678 To change the value globally, use @code{setq-default}; for local settings, | |
1679 use @code{setq}. | |
1680 | |
1681 The command @kbd{:se ts} | |
1682 sets the tab width in the current | |
1683 buffer only; it has no effect on other buffers. | |
1684 | |
1685 The command @kbd{:se ts-g} sets tab width globally, | |
1686 for all buffers where the tab is not yet set locally, | |
1687 including the new buffers. | |
1688 | |
1689 Note that typing @key{TAB} normally | |
1690 doesn't insert the tab, since this key is usually bound to | |
1691 a text-formatting function, @code{indent-for-tab-command} (which facilitates | |
1692 programming and document writing). Instead, the tab is inserted via the | |
1693 command @code{viper-insert-tab}, which is bound to @kbd{S-tab} (shift + tab). | |
1694 | |
1695 On some non-windowing terminals, Shift doesn't modify the @key{TAB} key, so | |
1696 @kbd{S-tab} behaves as if it were @key{TAB}. In such a case, you will have | |
1697 to bind @code{viper-insert-tab} to some other convenient key. | |
1698 | |
1699 @item viper-shift-width 8 | |
1700 @itemx :se sw=value (:se shiftwidth=value) | |
1701 The number of columns shifted by @kbd{>} and @kbd{<} commands. | |
1702 @item viper-search-wrap-around t | |
1703 @itemx :se ws (:se wrapscan) | |
1704 If not @code{nil}, search wraps around the end/beginning of buffer. | |
1705 @item viper-search-scroll-threshold 2 | |
1706 If search lands within this many lines of the window top or bottom, the | |
1707 window will be scrolled up or down by about 1/7-th of its size, to reveal | |
1708 the context. If the value is negative---don't scroll. | |
1709 @item viper-tags-file-name "TAGS" | |
1710 The name of the file used as the tag table. | |
1711 @item viper-re-query-replace nil | |
1712 If not @code{nil}, use reg-exp replace in query replace. | |
1713 @item viper-want-ctl-h-help nil | |
1714 If not @code{nil}, @kbd{C-h} is bound to @code{help-command}; | |
1715 otherwise, @kbd{C-h} is bound as usual in Vi. | |
1716 @item viper-vi-style-in-minibuffer t | |
1717 If not @code{nil}, Viper provides a high degree of compatibility with Vi | |
1718 insert mode when you type text in the Minibuffer; if @code{nil}, typing in | |
1719 the Minibuffer feels like plain Emacs. | |
1720 @item viper-no-multiple-ESC t | |
1721 If you set this to @code{nil}, you can use @key{ESC} as Meta in Vi state. | |
1722 Normally, this is not necessary, since graphical displays have separate | |
1723 Meta keys (usually on each side of the space bar). On a dumb terminal, Viper | |
1724 sets this variable to @code{twice}, which is almost like @code{nil}, except | |
1725 that double @key{ESC} beeps. This, too, lets @key{ESC} to be used as a Meta. | |
1726 @item viper-ESC-keyseq-timeout 200 on tty, 0 on windowing display | |
1727 Escape key sequences separated by this much delay (in milliseconds) are | |
1728 interpreted as command, ignoring the special meaning of @key{ESC} in | |
1729 VI. The default is suitable for most terminals. However, if your terminal | |
1730 is extremely slow, you might want to increase this slightly. You will know | |
1731 if your terminal is slow if the @key{ESC} key sequences emitted by the | |
1732 arrow keys are interpreted as separately typed characters (and thus the | |
1733 arrow keys won't work). Making this value too large will slow you down, so | |
1734 exercise restraint. | |
1735 @item viper-fast-keyseq-timeout 200 | |
1736 Key sequences separated by this many milliseconds are treated as Vi-style | |
1737 keyboard macros. If the key sequence is defined as such a macro, it will be | |
1738 executed. Otherwise, it is processed as an ordinary sequence of typed keys. | |
1739 | |
1740 Setting this variable too high may slow down your typing. Setting it too | |
1741 low may make it hard to type macros quickly enough. | |
28510
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1742 @item viper-translate-all-ESC-keysequences t on tty, nil on windowing display |
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1743 Normally, Viper lets Emacs translate only those ESC key sequences that are |
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1744 defined in the low-level key-translation-map or function-key-map, such as those |
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1745 emitted by the arrow and function keys. Other sequences, e.g., @kbd{\\e/}, are |
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1746 treated as @kbd{ESC} command followed by a @kbd{/}. This is good for people |
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1747 who type fast and tend to hit other characters right after they hit |
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1748 ESC. Other people like Emacs to translate @kbd{ESC} sequences all the time. |
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1749 The default is to translate all sequences only when using a dumb terminal. |
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1750 This permits you to use @kbd{ESC} as a meta key in insert mode. For instance, |
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1751 hitting @kbd{ESC x} fast would have the effect of typing @kbd{M-x}. |
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1752 If your dumb terminal is not so dumb and understands the meta key, then you |
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1753 probably will be better off setting this variable to nil. Try and see which |
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1754 way suits you best. |
25829 | 1755 @item viper-ex-style-motion t |
1756 Set this to @code{nil}, if you want @kbd{l,h} to cross | |
1757 lines, etc. @xref{Movement and Markers}, for more info. | |
1758 @item viper-ex-style-editing t | |
1759 Set this to to @code{nil}, if you want | |
1760 @kbd{C-h} and @key{DEL} to not stop | |
1761 at the beginning of a line in Insert state, @key{X} and @key{x} to delete | |
1762 characters across lines in Vi command state, etc. | |
1763 @item viper-ESC-moves-cursor-back t | |
1764 It t, cursor moves back 1 character when switching from insert state to vi | |
1765 state. If nil, the cursor stays where it was before the switch. | |
1766 @item viper-always t | |
1767 @code{t} means: leave it to Viper to decide when a buffer must be brought | |
1768 up in Vi state, | |
1769 Insert state, or Emacs state. This heuristics works well in virtually all | |
1770 cases. @code{nil} means you either has to invoke @code{viper-mode} manually | |
1771 for each buffer (or you can add @code{viper-mode} to the appropriate major mode | |
1772 hooks using @code{viper-load-hook}). | |
1773 | |
1774 This option must be set in the file @file{~/.viper}. | |
1775 @item viper-custom-file-name "~/.viper" | |
1776 File used for Viper-specific customization. | |
1777 Change this setting, if you want. Must be set in @file{.emacs} (not @file{.viper}!) | |
1778 before Viper is loaded. Note that you | |
1779 have to set it as a string inside double quotes. | |
1780 @item viper-spell-function 'ispell-region | |
1781 Function used by the command @kbd{#c<move>} to spell. | |
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1782 @item viper-glob-function |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1783 The value of this variable is the function symbol used to expand wildcard |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1784 symbols. This is platform-dependent. The default tries to set this variable |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1785 to work with most Unix shells, MS Windows, OS/2, etc. However, if it |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1786 doesn't work the way you expect, you should write your own. |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1787 Use @code{viper-glob-unix-files} and @code{viper-glob-mswindows-files} in |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1788 @file{viper-util.el} as examples. |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1789 |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1790 This feature is used to expand wildcards in the Ex command @kbd{:e}. |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1791 Note that Viper doesn't support wildcards in the @kbd{:r} and @kbd{:w} |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1792 commands, because file completion is a better mechanism. |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1793 @findex @code{viper-glob-function} |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1794 |
25829 | 1795 @item ex-cycle-other-window t |
1796 If not @code{nil}, @kbd{:n} and @kbd{:b} will cycle through files in another | |
1797 window, if one exists. | |
1798 @item ex-cycle-through-non-files nil | |
1799 @kbd{:n} does not normally cycle through buffers. Set this to get | |
1800 buffers also. | |
1801 @item viper-want-emacs-keys-in-insert | |
1802 This is set to @code{nil} for user levels 1 and 2 and to @code{t} for user | |
1803 levels 3 and 4. Users who specify level 5 are allowed to set this variable | |
1804 as they please (the default for this level is @code{t}). If set to | |
1805 @code{nil}, complete Vi compatibility is provided in Insert state. This is | |
1806 really not recommended, as this precludes you from using language-specific | |
1807 features provided by the major modes. | |
1808 @item viper-want-emacs-keys-in-vi | |
1809 This is set to @code{nil} for user | |
1810 level 1 and to @code{t} for user levels 2--4. | |
1811 At level 5, users are allowed to set this variable as they please (the | |
1812 default for this level is @code{t}). | |
1813 If set to @code{nil}, complete Vi compatibility is provided | |
1814 in Vi command state. Setting this to @code{nil} is really a bad idea, | |
1815 unless you are a novice, as this precludes the use | |
1816 of language-specific features provided by the major modes. | |
1817 @item viper-keep-point-on-repeat t | |
1818 If not @code{nil}, point is not moved when the user repeats the previous | |
1819 command by typing `.' This is very useful for doing repeated changes with | |
1820 the @kbd{.} key. | |
1821 @item viper-repeat-from-history-key 'f12 | |
1822 Prefix key used to invoke the macros @kbd{f12 1} and @kbd{f12 2} that repeat | |
1823 the second-last and the third-last destructive command. | |
1824 Both these macros are bound (as Viper macros) to | |
1825 @code{viper-repeat-from-history}, | |
1826 which checks the second key by which it is invoked to see which of the | |
1827 previous commands to invoke. Viper binds @kbd{f12 1} and @kbd{f12 2} only, | |
1828 but the user can bind more in @file{~/.viper}. @xref{Vi Macros}, for how to do | |
1829 this. | |
1830 @item viper-keep-point-on-undo nil | |
1831 If not @code{nil}, Viper tries to not move point when undoing commands. | |
1832 Instead, it will briefly move the cursor to the place where change has | |
1833 taken place. However, if the undone piece of text is not seen in window, | |
1834 then point will be moved to the place where the change took place. | |
1835 Set it to @code{t} and see if you like it better. | |
1836 @item viper-delete-backwards-in-replace nil | |
1837 If not @code{nil}, @key{DEL} key will delete characters while moving the cursor | |
1838 backwards. If @code{nil}, the cursor will move backwards without deleting | |
1839 anything. | |
1840 @item viper-replace-overlay-face 'viper-replace-overlay-face | |
1841 On a graphical display, Viper highlights replacement regions instead of | |
1842 putting a @samp{$} at the end. This variable controls the so called | |
1843 @dfn{face} used to highlight the region. | |
1844 | |
1845 By default, @code{viper-replace-overlay-face} underlines the replacement on | |
1846 monochrome displays and also lays a stipple over them. On color displays, | |
1847 replacement regions are highlighted with color. | |
1848 | |
1849 If you know something about Emacs faces and don't like how Viper highlights | |
1850 replacement regions, you can change @code{viper-replace-overlay-face} by | |
1851 specifying a new face. (Emacs faces are described in the Emacs Lisp | |
1852 reference.) On a color display, the following customization method is | |
1853 usually most effective: | |
1854 @example | |
1855 (set-face-foreground viper-replace-overlay-face "DarkSlateBlue") | |
1856 (set-face-background viper-replace-overlay-face "yellow") | |
1857 @end example | |
1858 For a complete list of colors available to you, evaluate the expression | |
1859 @code{(x-defined-colors)}. (Type it in the buffer @code{*scratch*} and then | |
1860 hit the @kbd{C-j} key. | |
1861 | |
1862 @item viper-replace-overlay-cursor-color "Red" | |
1863 @vindex @code{viper-replace-overlay-cursor-color} | |
1864 Cursor color when it is inside the replacement region. | |
1865 This has effect only on color displays and only when Emacs runs as an X | |
1866 application. | |
1867 @item viper-insert-state-cursor-color nil | |
1868 @vindex @code{viper-insert-state-cursor-color} | |
1869 If set to a valid color, this will be the cursor color when Viper is in | |
1870 insert state. | |
1871 @item viper-replace-region-end-delimiter "$" | |
1872 A string used to mark the end of replacement regions. It is used only on | |
1873 TTYs or if @code{viper-use-replace-region-delimiters} is non-nil. | |
1874 @item viper-replace-region-start-delimiter "" | |
1875 A string used to mark the beginning of replacement regions. It is used | |
1876 only on TTYs or if @code{viper-use-replace-region-delimiters} is non-nil. | |
1877 @item viper-use-replace-region-delimiters | |
1878 If non-nil, Viper will always use @code{viper-replace-region-end-delimiter} and | |
1879 @code{viper-replace-region-start-delimiter} to delimit replacement regions, | |
1880 even on color displays (where this is unnecessary). By default, this | |
1881 variable is non-nil only on TTYs or monochrome displays. | |
1882 @item viper-allow-multiline-replace-regions t | |
1883 If non-nil, multi-line text replacement regions, such as those produced by | |
1884 commands @kbd{c55w}, @kbd{3C}, etc., will stay around until the user exits | |
1885 the replacement mode. In this variable is set to @code{nil}, Viper will | |
1886 emulate the standard Vi behavior, which supports only intra-line | |
1887 replacement regions (and multi-line replacement regions are deleted). | |
1888 @item viper-toggle-key "\C-z" | |
1889 Specifies the key used to switch from Emacs to Vi and back. | |
1890 Must be set in @file{.viper}. This variable can't be | |
1891 changed interactively after Viper is loaded. | |
1892 | |
1893 In Insert state, this key acts as a temporary escape to Vi state, i.e., it | |
1894 will set Viper up so that the very next command will be executed as if it | |
1895 were typed in Vi state. | |
1896 @item viper-ESC-key "\e" | |
1897 Specifies the key used to escape from Insert/Replace states to Vi. | |
1898 Must be set in @file{.viper}. This variable cannot be | |
1899 changed interactively after Viper is loaded. | |
1900 @item viper-buffer-search-char nil | |
1901 Key used for buffer search. @xref{Viper Specials}, for details. | |
1902 @item viper-surrounding-word-function 'viper-surrounding-word | |
1903 The value of this variable is a function name that is used to determine | |
1904 what constitutes a word clicked upon by the mouse. This is used by mouse | |
1905 search and insert. | |
1906 @item viper-search-face 'viper-search-face | |
1907 Variable that controls how search patterns are highlighted when they are | |
1908 found. | |
1909 @item viper-vi-state-hook nil | |
1910 List of parameterless functions to be run just after entering the Vi | |
1911 command state. | |
1912 @item viper-insert-state-hook nil | |
1913 Same for Insert state. This hook is also run after entering Replace state. | |
1914 @item viper-replace-state-hook nil | |
1915 List of (parameterless) functions called just after entering Replace state | |
1916 (and after all @code{viper-insert-state-hook}). | |
1917 @item viper-emacs-state-hook nil | |
1918 List of (parameterless) functions called just after switching from Vi state | |
1919 to Emacs state. | |
1920 @item viper-load-hook nil | |
1921 List of (parameterless) functions called just after loading Viper. This is | |
1922 the last chance to do customization before Viper is up and running. | |
1923 @end table | |
1924 @noindent | |
1925 You can reset some of these constants in Viper with the Ex command @kbd{:set} | |
1926 (when so indicated in the table). Or you | |
1927 can include a line like this in your @file{.viper} file: | |
1928 @example | |
1929 (setq viper-case-fold-search t) | |
1930 @end example | |
1931 @vindex @code{viper-auto-indent} | |
1932 @vindex @code{viper-electric-mode} | |
1933 @vindex @code{viper-case-fold-search} | |
1934 @vindex @code{viper-re-search} | |
1935 @vindex @code{viper-shift-width} | |
1936 @vindex @code{buffer-read-only} | |
1937 @vindex @code{viper-search-wrap-around} | |
1938 @vindex @code{viper-search-scroll-threshold} | |
1939 @vindex @code{viper-search-face} | |
1940 @vindex @code{viper-tags-file-name} | |
1941 @vindex @code{viper-re-query-replace} | |
1942 @vindex @code{viper-want-ctl-h-help} | |
1943 @vindex @code{viper-vi-style-in-minibuffer} | |
1944 @vindex @code{viper-no-multiple-ESC} | |
1945 @vindex @code{viper-always} | |
1946 @vindex @code{viper-ESC-keyseq-timeout} | |
1947 @vindex @code{viper-fast-keyseq-timeout} | |
1948 @vindex @code{viper-ex-style-motion} | |
1949 @vindex @code{viper-ex-style-editing} | |
1950 @vindex @code{viper-ESC-moves-cursor-back} | |
1951 @vindex @code{viper-custom-file-name} | |
1952 @vindex @code{viper-spell-function} | |
1953 @vindex @code{ex-cycle-other-window} | |
1954 @vindex @code{ex-cycle-through-non-files} | |
1955 @vindex @code{viper-want-emacs-keys-in-insert} | |
1956 @vindex @code{viper-want-emacs-keys-in-vi} | |
1957 @vindex @code{viper-keep-point-on-repeat} | |
1958 @vindex @code{viper-keep-point-on-undo} | |
1959 @vindex @code{viper-delete-backwards-in-replace} | |
1960 @vindex @code{viper-replace-overlay-face} | |
1961 @vindex @code{viper-replace-region-end-symbol} | |
1962 @vindex @code{viper-replace-region-start-symbol} | |
1963 @vindex @code{viper-allow-multiline-replace-regions} | |
1964 @vindex @code{viper-toggle-key} | |
1965 @vindex @code{viper-ESC-key} | |
1966 @vindex @code{viper-buffer-search-char} | |
1967 @vindex @code{viper-surrounding-word-function} | |
1968 @vindex @code{viper-vi-state-hook} | |
1969 @vindex @code{viper-insert-state-hook} | |
1970 @vindex @code{viper-replace-state-hook} | |
1971 @vindex @code{viper-emacs-state-hook} | |
1972 | |
1973 @node Keybindings, Packages that Change Keymaps, Rudimentary Changes,Customization | |
1974 @section Keybindings | |
1975 | |
1976 @cindex keybindings | |
1977 @cindex keymaps | |
1978 | |
1979 Viper lets you define hot keys, i.e., you can associate keyboard keys | |
1980 such as F1, Help, PgDn, etc., with Emacs Lisp functions (that may already | |
1981 exist or that you will write). Each key has a "preferred form" in | |
1982 Emacs. For instance, the Up key's preferred form is [up], the Help key's | |
1983 preferred form is [help], and the Undo key has the preferred form [f14]. | |
1984 You can find out the preferred form of a key by typing @kbd{M-x | |
1985 describe-key-briefly} and then typing the key you want to know about. | |
1986 | |
1987 Under X Windows, every keyboard key emits its preferred form, so you can | |
1988 just type | |
1989 | |
1990 @lisp | |
1991 (global-set-key [f11] 'calendar) ; L1, Stop | |
1992 (global-set-key [f14] 'undo) ; L4, Undo | |
1993 @end lisp | |
1994 | |
1995 @noindent | |
1996 to bind L1 so it will invoke the Emacs Calendar and to bind L4 so it will | |
1997 undo changes. | |
1998 However, on a dumb terminal or in an Xterm window, even the standard arrow | |
1999 keys may | |
2000 not emit the right signals for Emacs to understand. To let Emacs know about | |
2001 those keys, you will have to find out which key sequences they emit | |
2002 by typing @kbd{C-q} and then the key (you should switch to Emacs state | |
2003 first). Then you can bind those sequences to their preferred forms using | |
2004 @code{function-key-map} as follows: | |
2005 | |
2006 @lisp | |
2007 (cond ((string= (getenv "TERM") "xterm") | |
2008 (define-key function-key-map "\e[192z" [f11]) ; L1 | |
2009 (define-key function-key-map "\e[195z" [f14]) ; L4, Undo | |
2010 @end lisp | |
2011 | |
2012 The above illustrates how to do this for Xterm. On VT100, you would have to | |
2013 replace "xterm" with "vt100" and also change the key sequences (the same | |
2014 key may emit different sequences on different types of terminals). | |
2015 | |
2016 The above keys are global, so they are overwritten by the local maps | |
2017 defined by the major modes and by Viper itself. Therefore, if you wish to | |
2018 change a binding set by a major mode or by Viper, read this. | |
2019 | |
2020 Viper users who wish to specify their own key bindings should be concerned | |
2021 only with the following three keymaps: | |
2022 @code{viper-vi-global-user-map} for Vi state commands, | |
2023 @code{viper-insert-global-user-map} for Insert state commands, | |
2024 and @code{viper-emacs-global-user-map} for Emacs state commands (note: | |
2025 customized bindings for Emacs state made to @code{viper-emacs-global-user-map} | |
2026 are @emph{not} inherited by Insert state). | |
2027 | |
2028 For more information on Viper keymaps, see the header of the file | |
2029 @file{viper.el}. | |
2030 If you wish to change a Viper binding, you can use the | |
2031 @code{define-key} command, to modify @code{viper-vi-global-user-map}, | |
2032 @code{viper-insert-global-user-map}, and @code{viper-emacs-global-user-map}, as | |
2033 explained below. Each of these key maps affects the corresponding Viper state. | |
2034 The keymap @code{viper-vi-global-user-map} also affects Viper's Replace state. | |
2035 | |
2036 @noindent | |
2037 If you want to | |
2038 bind a key, say @kbd{C-v}, to the function that scrolls | |
2039 page down and to make @kbd{0} display information on the current buffer, | |
2040 putting this in @file{.viper} will do the trick in Vi state: | |
2041 @example | |
2042 (define-key viper-vi-global-user-map "\C-v" 'scroll-down) | |
2043 @end example | |
2044 @noindent | |
2045 To set a key globally, | |
2046 @example | |
2047 (define-key viper-emacs-global-user-map "\C-c m" 'smail) | |
2048 (define-key viper-vi-global-user-map "0" 'viper-info-on-file) | |
2049 @end example | |
2050 @noindent | |
2051 Note, however, that this binding may be overwritten by other keymaps, since | |
2052 the global keymap has the lowest priority. | |
2053 To make sure that nothing will override a binding in Emacs state, you | |
2054 can write this: | |
2055 @example | |
2056 (define-key viper-emacs-global-user-map "\C-c m" 'smail) | |
2057 @end example | |
2058 @noindent | |
2059 To customize the binding for @kbd{C-h} in Insert state: | |
2060 @example | |
2061 (define-key viper-insert-global-user-map "\C-h" 'my-del-backwards-function) | |
2062 @end example | |
2063 @noindent | |
2064 | |
2065 Each Emacs command key calls some lisp function. If you have enabled the | |
2066 Help, (@pxref{Rudimentary Changes}) @kbd{C-h k} will show you the function | |
2067 for each specific key; @kbd{C-h b} will show all bindings, and @kbd{C-h m} | |
2068 will provide information on the major mode in effect. If Help is not | |
2069 enabled, you can still get help in Vi state by prefixing the above commands | |
2070 with @kbd{\}, e.g., @kbd{\ C-h k} (or you can use the Help menu in the | |
2071 menu bar, if Emacs runs under X Windows). | |
2072 | |
2073 Viper users can also change bindings on a per major mode basis. As with | |
2074 global bindings, this can be done separately for each of the three main Viper | |
2075 states. To this end, Viper provides the function | |
2076 @code{viper-modify-major-mode}. | |
2077 @findex @code{viper-modify-major-mode} | |
2078 | |
2079 To modify keys in Emacs state for @code{my-favorite-major-mode}, the user | |
2080 needs to create a sparse keymap, say, @code{my-fancy-map}, bind whatever | |
2081 keys necessary in that keymap, and put | |
2082 | |
2083 @example | |
2084 (viper-modify-major-mode 'dired-mode 'emacs-state my-fancy-map) | |
2085 @end example | |
2086 | |
2087 @noindent | |
2088 in @file{~/.viper}. To do the same in Vi and Insert states, you should use | |
2089 @code{vi-state} and @code{insert-state}. Changes in Insert state are also | |
2090 in effect in Replace state. For instance, suppose that the user wants to | |
2091 use @kbd{dd} in Vi state under Dired mode to delete files, @kbd{u} to unmark | |
2092 files, etc. The following code in @file{~/.viper} will then do the job: | |
2093 | |
2094 @example | |
2095 (setq my-dired-modifier-map (make-sparse-keymap)) | |
2096 (define-key my-dired-modifier-map "dd" 'dired-flag-file-deletion) | |
2097 (define-key my-dired-modifier-map "u" 'dired-unmark) | |
2098 (viper-modify-major-mode 'dired-mode 'vi-state my-dired-modifier-map) | |
2099 @end example | |
2100 | |
2101 A Vi purist may want to modify Emacs state under Dired mode so that | |
2102 @kbd{k}, @kbd{l}, etc., will move around in directory buffers, as in | |
2103 Vi. Although this is not recommended, as these keys are bound to useful | |
2104 Dired functions, the trick can be accomplished via the following code: | |
2105 | |
2106 @example | |
2107 (setq my-dired-vi-purist-map (make-sparse-keymap)) | |
2108 (define-key my-dired-vi-purist-map "k" 'viper-previous-line) | |
2109 (define-key my-dired-vi-purist-map "l" 'viper-forward-char) | |
2110 (viper-modify-major-mode 'dired-mode 'emacs-state my-dired-vi-purist-map) | |
2111 @end example | |
2112 | |
2113 Yet another way to customize key bindings in a major mode is to edit the | |
2114 list @code{viper-major-mode-modifier-list} using the customization widget. | |
2115 @vindex @code{viper-major-mode-modifier-list} | |
2116 (This variable is in the Viper-misc customization group.) | |
2117 The elements of this list are triples of the form: (major-mode viper-state | |
2118 keymap), where the keymap contains bindings that are supposed to be active | |
2119 in the given major mode and the given viper-state. | |
2120 | |
2121 Effects similar to key binding changes can be achieved by defining Vi | |
2122 keyboard macros using the Ex commands @kbd{:map} and @kbd{:map!}. The | |
2123 difference is that multi-key Vi macros do not override the keys they are | |
2124 bound to, unless these keys are typed in quick succession. So, with macros, | |
2125 one can use the normal keys alongside with the macros. If per-mode | |
2126 modifications are needed, the user can try both ways and see which one is | |
2127 more convenient. | |
2128 @findex @kbd{:map} | |
2129 @xref{Vi Macros}, for details. | |
2130 | |
2131 Note: in major modes that come up in @emph{Emacs state} by default, the | |
2132 aforesaid modifications may not take place immediately (but only after the | |
2133 buffer switches to some other Viper state and then back to Emacs state). To | |
2134 avoid this, one should add @code{viper-change-state-to-emacs} to an | |
2135 appropriate hook of that major mode. (Check the function | |
2136 @code{viper-set-hooks} in @file{viper.el} for examples.) However, if you | |
2137 have set @code{viper-always} to @code{t}, chances are that you won't need to | |
2138 perform the above procedure, because Viper will take care of most useful | |
2139 defaults. | |
2140 | |
2141 | |
2142 Finally, Viper has a facility that lets the user define per-buffer | |
2143 bindings, i.e., bindings that are in effect in some specific buffers | |
2144 only. Unlike per-mode bindings described above, per-buffer bindings can be | |
2145 defined based on considerations other than the major mode. This is done | |
2146 via the function @code{viper-add-local-keys}, which lets one specify bindings | |
2147 that should be in effect in the current buffer only and for a specific Viper | |
2148 state. For instance, | |
2149 @lisp | |
2150 (viper-add-local-keys 'vi-state '(("ZZ" .@: TeX-command-master) | |
2151 ("ZQ" .@: viper-save-kill-buffer))) | |
2152 @end lisp | |
2153 @noindent | |
2154 redefines @kbd{ZZ} to invoke @code{TeX-command-master} in @code{vi-state} | |
2155 and @kbd{ZQ} to save-then-kill the current buffer. These bindings take | |
2156 effect only in the buffer where this command is executed. The typical use | |
2157 of this function is to execute the above expression from within a function | |
2158 that is included in a hook to some major mode. For instance, the above | |
2159 expression | |
2160 could be called from a function, @code{my-tex-init}, which may be added to | |
2161 @code{tex-mode-hook} as follows: | |
2162 @lisp | |
2163 (add-hook 'tex-mode-hook 'my-tex-init) | |
2164 @end lisp | |
2165 @noindent | |
2166 When TeX mode starts, the hook is executed and the above Lisp expression is | |
2167 evaluated. Then, the bindings for @kbd{ZZ} and @kbd{ZQ} are changed in Vi | |
2168 command mode for all buffers in TeX mode. | |
2169 | |
2170 Another useful application is to bind @kbd{ZZ} to @code{send-mail} | |
2171 in the Mail mode buffers (the specifics of this depend on which mail | |
2172 package you are using, @code{rmail}, @code{mh-e}, @code{vm}, etc. | |
2173 For instance, here is how to do this for @code{mh-e}, the Emacs interface | |
2174 to MH: | |
2175 @lisp | |
2176 (defun mh-add-vi-keys () | |
2177 "Set up ZZ for MH-e and XMH." | |
2178 (viper-add-local-keys 'vi-state '(("ZZ" .@: mh-send-letter)))) | |
2179 (add-hook 'mh-letter-mode-hook 'mh-add-vi-keys) | |
2180 @end lisp | |
2181 | |
2182 You can also use @code{viper-add-local-keys} to set per buffer | |
2183 bindings in Insert state and Emacs state by passing as a parameter the | |
2184 symbols @code{insert-state} and @code{emacs-state}, respectively. | |
2185 As with global bindings, customized local bindings done to Emacs state | |
2186 are not inherited by Insert state. | |
2187 | |
2188 On rare occasions, local keys may be added by mistake. Usually this is done | |
2189 indirectly, by invoking a major mode that adds local keys (e.g., | |
2190 @code{shell-mode} redefines @key{RET}). In such a case, exiting the wrong | |
2191 major mode won't rid you from unwanted local keys, since these keys are | |
2192 local to Viper state and the current buffer, not to the major mode. | |
2193 In such situations, the remedy is to type @kbd{M-x viper-zap-local-keys}. | |
2194 | |
2195 So much about Viper-specific bindings. | |
2196 @xref{Customization,,Customization,emacs,The GNU Emacs | |
2197 Manual}, and the Emacs quick reference card for the general info on key | |
2198 bindings in Emacs. | |
2199 | |
2200 @vindex @code{function-key-map} | |
2201 @vindex @code{viper-vi-global-user-map} | |
2202 @vindex @code{viper-insert-global-user-map} | |
2203 @vindex @code{viper-emacs-global-user-map} | |
2204 @findex @code{viper-add-local-keys} | |
2205 @findex @code{viper-zap-local-keys} | |
2206 | |
2207 @node Packages that Change Keymaps,Viper Specials,Keybindings,Customization | |
2208 @subsection Packages that Change Keymaps | |
2209 @cindex C-c and Viper | |
2210 @cindex Viper and C-c | |
2211 | |
2212 Viper is designed to coexist with all major and minor modes of Emacs. This | |
2213 means that bindings set by those modes are generally available with Viper | |
2214 (unless you explicitly prohibit them by setting | |
2215 @code{viper-want-emacs-keys-in-vi} and @code{viper-want-emacs-keys-in-insert} to | |
2216 @code{nil}). | |
2217 If @code{viper-always} is set to @code{t}, Viper will try to bring each buffer | |
2218 in the Viper state that is most appropriate for that buffer. | |
2219 Usually, this would be the Vi state, but sometimes it could be the Insert | |
2220 state or the Emacs state. | |
2221 | |
2222 Some major mode bindings will necessarily be overwritten by Viper. Indeed, in | |
2223 Vi state, most of the 1-character keys are used for Vi-style editing. This | |
2224 usually causes no problems because most packages designed for editing files | |
2225 typically do not bind such keys. Instead, they use key sequences that start | |
2226 with @kbd{C-x} and @kbd{C-c}. This is why it was so important for us to | |
2227 free up @kbd{C-x} and @kbd{C-c}. | |
2228 It is common for language-specific major modes to bind @key{TAB} and | |
2229 @kbd{C-j} (the line feed) keys to various formatting functions. This is | |
2230 extremely useful, but may require some getting used to for a Vi user. If you | |
2231 decide that this feature is not for you, you can re-bind these keys as | |
2232 explained earlier (@pxref{Customization}). | |
2233 | |
2234 Binding for @key{TAB} is one of the most unusual aspects of Viper for many | |
2235 novice users. In Emacs, @key{TAB} is used to format text and programs, and | |
2236 is extremely useful. For instance, hitting @key{TAB} causes the current | |
2237 line to be re-indented in accordance with the context. In programming, | |
2238 this is very important, since improper automatic indentation would | |
2239 immediately alert the programmer to a possible error. For instance, if a | |
2240 @kbd{)} or a @kbd{"} is missing somewhere above the current | |
2241 line, @key{TAB} is likely to mis-indent the line. | |
2242 | |
2243 For this reason, Viper doesn't change the standard Emacs binding of | |
2244 @key{TAB}, thereby sacrificing Vi compatibility | |
2245 (except for users at level 1). Instead, in Viper, the key | |
2246 @kbd{S-tab} (shift+ tab) is chosen to emulate Vi's @key{TAB}. | |
2247 | |
2248 We should note that on some non-windowing terminals, Shift doesn't modify | |
2249 the @key{TAB} key, so @kbd{S-tab} behaves as if it were @key{TAB}. In such | |
2250 a case, you will have to bind @code{viper-insert-tab} to some other | |
2251 convenient key. | |
2252 | |
2253 Some packages, notably Dired, Gnus, Info, etc., attach special meaning to | |
2254 common keys like @key{SPC}, @kbd{x}, @kbd{d}, @kbd{v}, and others. This | |
2255 means that Vi command state is inappropriate for working with these | |
2256 packages. Fortunately, these modes operate on read-only buffers and are | |
2257 designed not for editing files, but for special-purpose browsing, reading | |
2258 news, mail, etc., and Vi commands are meaningless in these situations. For | |
2259 this reason, Viper doesn't force Vi state on such major modes---it | |
2260 brings them in Emacs state. You can switch to Vi state by typing @kbd{C-z} | |
2261 if, for instance, you want to do Vi-style search in a buffer (although, | |
2262 usually, incremental search, which is bound to @kbd{C-s}, is sufficient in | |
2263 these situations). But you should then switch back to Emacs state if you | |
2264 plan to continue using these major modes productively. You can also switch | |
2265 to Vi temporarily, to execute just one command. This is done by typing | |
2266 @kbd{C-c \}. (In some of these modes, @kbd{/} and @kbd{:} are bound | |
2267 Vi-style, unless these keys perform essential duties.) | |
2268 | |
2269 If you would like certain major modes to come up in Emacs state rather than | |
2270 Vi state (but Viper thinks otherwise), you should put these major modes | |
2271 on the @code{viper-emacs-state-mode-list} list and delete them from | |
2272 @code{viper-vi-state-mode-list}. | |
2273 Likewise, you can force Viper's Insert state on a major mode by putting it | |
2274 in @code{viper-insert-state-mode-list}. | |
2275 @vindex @code{viper-emacs-state-mode-list} | |
2276 @vindex @code{viper-insert-state-mode-list} | |
2277 @vindex @code{viper-vi-state-mode-list} | |
2278 | |
2279 It is also possible to impose Vi on some major modes, even though they may | |
2280 bind common keys to specialized commands. This might make sense for modes | |
2281 that bind only a small number of common keys. For instance, Viper subverts | |
2282 the Shell mode by changing the bindings for @kbd{C-m} and @kbd{C-d} using | |
2283 @code{viper-add-local-keys} described in section on customization | |
2284 (@pxref{Customization}). | |
2285 | |
2286 In some cases, some @emph{minor} modes might override certain essential | |
2287 bindings in Vi command state. This is not a big priblem because this | |
2288 can happen only in the beginning, when the minor mode kicks in. Typing | |
2289 @code{M-x viper-mode} will correct the situation. Viper knows about | |
2290 several such minor modes and takes care of them, so the above trick | |
2291 is usually not necessary. If you find that some minor mode, e.g., | |
2292 @code{nasty-mode.el} interferes with Viper, putting the following in | |
2293 @file{.viper} should fix the problem: | |
2294 @lisp | |
2295 (viper-harness-minor-mode "nasty-mode") | |
2296 @end lisp | |
2297 @noindent | |
2298 The argument to @code{viper-harness-minor-mode} is the name of the file for the | |
2299 offending minor mode with the suffixes @file{.el} and @file{.elc} removed. | |
2300 | |
2301 It may not be always obvious which minor mode is at fault. The only | |
2302 guidance here is to look into the file that defines the minor mode you are | |
2303 suspecting, say @code{nasty-mode.el}, and see if it has a variable called | |
2304 @code{nasty-mode-map}. Then check if there is a statement of the form | |
2305 @lisp | |
2306 (define-key nasty-mode-map key function) | |
2307 @end lisp | |
2308 @noindent | |
2309 that binds the misbehaving | |
2310 keys. If so, use the above line to harness @code{nasty-mode}. If your | |
2311 suspicion is wrong, no harm is done if you harness a minor mode that | |
2312 doesn't need to be harnessed. | |
2313 | |
2314 @vindex @code{viper-want-emacs-keys-in-vi} | |
2315 @vindex @code{viper-want-emacs-keys-in-insert} | |
2316 @vindex @code{viper-always} | |
2317 @findex @code{viper-set-hooks} | |
2318 @findex @code{viper-mode} | |
2319 @findex @code{viper-harness-minor-mode} | |
2320 @findex @code{remove-hook} | |
2321 @findex @code{add-hook} | |
2322 | |
2323 @node Viper Specials,Vi Macros,Packages that Change Keymaps,Customization | |
2324 @section Viper Specials | |
2325 | |
2326 Viper extends Vi with a number of useful features. This includes various | |
2327 search functions, histories of search strings, Ex commands, insertions, and | |
2328 Vi's destructive commands. In addition, Viper supports file name completion | |
2329 and history, completion of Ex commands and variables, and many other | |
2330 features. Some of these features are explained in detail elsewhere in this | |
2331 document. Other features are explained here. | |
2332 | |
2333 @table @code | |
2334 @item (viper-buffer-search-enable) | |
2335 @item viper-buffer-search-char nil | |
2336 Enable buffer search. Explicit call to @code{viper-buffer-search-enable} | |
2337 sets @code{viper-buffer-search-char} to @kbd{g}. Alternatively, the user can | |
2338 set @code{viper-buffer-search-char} in @file{.viper} to a key sequence | |
2339 to be used for buffer search. There is no need to call | |
2340 @code{viper-buffer-search-enable} in that case. | |
2341 @findex @code{viper-buffer-search-enable} | |
2342 @vindex @code{viper-buffer-search-char} | |
2343 @item viper-toggle-search-style | |
2344 This function, bound to @kbd{C-c /}, lets one toggle case-sensitive and | |
2345 case-insensitive search, and also switch between plain vanilla search and | |
2346 search via regular expressions. Without the prefix argument, the user is | |
2347 asked which mode to toggle. With prefix argument 1, this toggles | |
2348 case-sensitivity. With prefix argument 2, regular expression/vanilla search | |
2349 will be toggled. | |
2350 | |
2351 However, we found that the most convenient way to toggle | |
2352 these options is to bind a Vi macro to | |
2353 bind @kbd{//} to toggles case sensitivity and to @kbd{///} to toggles | |
2354 vanilla search. Thus, quickly hitting @kbd{/} twice will switch Viper from | |
2355 case sensitive search to case-insensitive. Repeating this once again will | |
2356 restore the original state. Likewise, quickly hitting @kbd{/} three times | |
2357 will switch you from vanilla-style search to search via regular expressions. | |
2358 If you hit something other than @kbd{/} after the first @kbd{/} or if the | |
2359 second @kbd{/} doesn't follow quickly enough, then Viper will issue the | |
2360 usual prompt @kbd{/} and will wait for input, as usual in Vi. | |
2361 If you don't like this behavior, you can ``unrecord'' these macros in your | |
2362 @file{~/.viper} file. For instance, if you don't like the above feature, put | |
2363 this in @file{~/.viper}: | |
2364 @example | |
2365 (viper-set-searchstyle-toggling-macros 'undefine) | |
2366 @end example | |
2367 @findex @code{viper-set-searchstyle-toggling-macros} | |
2368 | |
2369 @item Vi-isms in Emacs state | |
2370 Some people find it useful to use the Vi-style search key, `/', to invoke | |
2371 search in modes which Viper leaves in emacs-state. These modes are: | |
2372 @code{dired-mode}, @code{mh-folder-mode}, @code{gnus-group-mode}, | |
2373 @code{gnus-summary-mode}, @code{Info-mode}, and @code{Buffer-menu-mode} | |
2374 (more may be added in the future). So, in the above modes, Viper binds `/' | |
2375 so that it will behave Vi-style. Furthermore, in those major modes, Viper | |
2376 binds `:' to invoke ex-style commands, like in vi-state. And, as described | |
2377 above, `//' and `///' get bound to Vi-style macros that toggle | |
2378 case-insensitivity and regexp-search. | |
2379 | |
2380 If you don't like these features---which I don't really understand---you | |
2381 can unbind `/' and `:' in @code{viper-dired-modifier-map} (for Dired) or in | |
2382 @code{viper-slash-and-colon-map}, for other modes. | |
2383 @vindex @code{viper-slash-and-colon-map} | |
2384 @vindex @code{viper-dired-modifier-map} | |
2385 | |
2386 To unbind the macros `//' and `///' for a major mode where you feel they | |
2387 are undesirable, execute @code{viper-set-emacs-state-searchstyle-macros} with a | |
2388 non-nil argument. This can be done either interactively, by supplying a | |
2389 prefix argument, or by placing | |
2390 @example | |
2391 (viper-set-emacs-state-searchstyle-macros 'undefine) | |
2392 @end example | |
2393 @findex @code{viper-set-emacs-state-searchstyle-macros} | |
2394 in the hook to the major mode (e.g., @code{dired-mode-hook}). | |
2395 @xref{Vi Macros}, for more information on Vi macros. | |
2396 | |
2397 @item viper-heading-start | |
2398 @item viper-heading-end | |
2399 @cindex headings | |
2400 @cindex sections | |
2401 @cindex paragraphs | |
2402 @cindex sentences | |
2403 Regular Expressions for @kbd{[[} and @kbd{]]}. Note that Emacs defines | |
2404 Regexps for paragraphs and sentences. @xref{Paragraphs,,Paragraphs and | |
2405 Sentences,emacs,The GNU Emacs Manual}, for details. | |
2406 @item M-x viper-set-expert-level | |
2407 @findex @code{viper-set-expert-level} | |
2408 Change your user level interactively. | |
2409 @item viper-smart-suffix-list '("" "tex" "c" "cc" "el" "p") | |
2410 @vindex @code{viper-smart-suffix-list} | |
2411 Viper supports Emacs-style file completion when it prompts the user for a | |
2412 file name. However, in many cases, the same directory may contain files | |
2413 with identical prefix but different suffixes, e.g., prog.c, prog.o, | |
2414 paper.tex, paper.dvi. In such cases, completion will stop at the `.'. | |
2415 If the above variable is a list of strings representing suffixes, Viper will | |
2416 try these suffixes | |
2417 in the order listed and will check if the corresponding file exists. | |
2418 | |
2419 For instance, if completion stopped at `paper.'@: and the user typed | |
2420 @key{RET}, | |
2421 then Viper will check if the files `paper.', `paper.tex', `paper.c', etc., exist. | |
2422 It will take the first such file. If no file exists, Viper will give a chance | |
2423 to complete the file name by typing the appropriate suffix. If `paper.'@: was | |
2424 the intended file name, hitting return will accept it. | |
2425 | |
2426 To turn this feature off, set the above variable to @code{nil}. | |
2427 | |
2428 @item viper-insertion-ring-size 14 | |
2429 @vindex @code{viper-insertion-ring-size} | |
2430 @cindex Insertion ring | |
2431 Viper remembers what was previously inserted in Insert and Replace states. | |
2432 Several such recent insertions are kept in a special ring of strings of size | |
2433 @code{viper-insertion-ring-size}. | |
2434 If you enter Insert or Replace state you can reinsert strings from this | |
2435 ring by typing @kbd{C-c M-p} or @kbd{C-c M-n}. The former will search the | |
2436 ring in | |
2437 the direction of older insertions, and the latter will search in | |
2438 the direction of newer insertions. Hitting @kbd{C-c M-p} or @kbd{C-c M-n} | |
2439 in succession | |
2440 will undo the previous insertion from the ring and insert the next item on | |
2441 the ring. If a larger ring size is needed, change the value of the above | |
2442 variable in the @file{~/.viper} file. | |
2443 | |
2444 Since typing these sequences of keys may be tedious, it is suggested that the | |
2445 user should bind a function key, such as @kbd{f31}, as follows: | |
2446 @example | |
2447 (define-key viper-insert-global-user-map [f31] | |
2448 'viper-insert-prev-from-insertion-ring) | |
2449 @end example | |
2450 This binds @kbd{f31} (which is usually @kbd{R11} on a Sun workstation) | |
2451 to the function that inserts the previous string in the insertion history. | |
2452 To rotate the history in the opposite | |
2453 direction, you can either bind an unused key to | |
2454 @code{viper-insert-next-from-insertion-ring} or hit any digit (1 to 9) then | |
2455 @kbd{f31}. | |
2456 | |
2457 One should not bind the above functions to @kbd{M-p} or @kbd{M-n}, since | |
2458 this will interfere with the Minibuffer histories and, possibly, other | |
2459 major modes. | |
2460 | |
2461 @item viper-command-ring-size 14 | |
2462 @vindex @code{viper-command-ring-size} | |
2463 @cindex Destructive command ring | |
2464 @cindex Destructive command history | |
2465 Viper keeps track of the recent history of destructive | |
2466 commands, such as @kbd{dw}, @kbd{i}, etc. | |
2467 In Vi state, | |
2468 the most recent command can be re-executed by hitting `@kbd{.}', as in Vi. | |
2469 However, repeated typing @kbd{C-c M-p} will cause Viper to show the | |
2470 previous destructive commands in the minibuffer. Subsequent hitting `@kbd{.}' | |
2471 will execute the command that was displayed last. | |
2472 The key @kbd{C-c M-n} will cycle through the command history in the | |
2473 opposite direction. | |
2474 Since typing @kbd{C-c M-p} may be tedious, it is more convenient to bind an | |
2475 appropriate function to an unused function key on the keyboard and use that | |
2476 key. For instance, the following | |
2477 @example | |
2478 (define-key viper-vi-global-user-map [f31] | |
2479 'viper-prev-destructive-command) | |
2480 @end example | |
2481 binds the key @kbd{f31} (which is usually @kbd{R11} on a Sun workstation) | |
2482 to the function that searches the command history in the direction of older | |
2483 commands. To search in the opposite | |
2484 direction, you can either bind an unused key to | |
2485 @code{viper-next-destructive-command} or hit any digit (1 to 9) then @kbd{f31}. | |
2486 | |
2487 One should not bind the above functions to @kbd{M-p} or @kbd{M-n}, since | |
2488 this will interfere with the Minibuffer histories and, possibly, other | |
2489 major modes. | |
2490 | |
2491 @item viper-minibuffer-vi-face 'viper-minibuffer-vi-face | |
2492 @item viper-minibuffer-insert-face 'viper-minibuffer-insert-face | |
2493 @item viper-minibuffer-emacs-face 'viper-minibuffer-emacs-face | |
2494 These faces control the appearance of the minibuffer text in the | |
2495 corresponding Viper states. You can change the appearance of these faces | |
2496 through Emacs' customization widget, which is accessible through the | |
2497 menubar. | |
2498 | |
2499 Viper is located in this widget under the @emph{Emulations} customization | |
2500 subgroup of the @emph{Editing} group. All Viper faces are grouped together | |
2501 in Viper's @emph{Highlighting} customization subgroup. | |
2502 | |
2503 Note that only the text you type in is affected by the above faces. | |
2504 Prompts and Minibuffer messages are not affected. | |
2505 | |
2506 Purists who do not like adornments in the minibuffer can always zap them by | |
2507 putting | |
2508 @example | |
2509 (copy-face 'default 'viper-minibuffer-vi-face) | |
2510 (copy-face 'default 'viper-minibuffer-insert-face) | |
2511 (copy-face 'default 'viper-minibuffer-emacs-face) | |
2512 @end example | |
2513 in the @file{~/.viper} file or through the customization widget, as | |
2514 described above. However, in that case, the user will not have any | |
2515 indication of the current Viper state in the minibuffer. (This is important | |
2516 if the user accidentally switches to another Viper state by typing @key{ESC} or | |
2517 @kbd{C-z}). | |
2518 @item M-x viper-go-away | |
2519 @findex @code{viper-go-away} | |
2520 Make Viper disappear from the face of your running Emacs instance. If your | |
2521 fingers start aching again, @kbd{M-x viper-mode} might save your day. | |
2522 @item M-x toggle-viper-mode | |
2523 @findex @code{toggle-viper-mode} | |
2524 Toggle Viperization of Emacs on and off. | |
2525 @end table | |
2526 | |
2527 @cindex Multifile documents and programs | |
2528 | |
2529 Viper provides some support for multi-file documents and programs. | |
2530 If a document consists of several files we can designate one of them as a | |
2531 master and put the following at the end of that file: | |
2532 @lisp | |
2533 ;;; Local Variables: | |
2534 ;;; eval: (viper-setup-master-buffer "file1" "file2" "file3" "file5" "file5") | |
2535 ;;; End: | |
2536 @end lisp | |
2537 @noindent | |
2538 where @code{file1} to @code{file5} are names of files related to the master | |
2539 file. Next time, when the master file is visited, the command | |
2540 @code{viper-setup-master-buffer} will be evaluated and the above files will | |
2541 be associated with the master file. Then, the new Ex command | |
2542 @kbd{:RelatedFile} (abbr.@: @kbd{:R}) will display files 1 to 5 one after | |
2543 another, so you can edit them. If a file is not in any Emacs buffer, it | |
2544 will be visited. The command @kbd{PreviousRelatedFile} (abbr., @kbd{:P}) | |
2545 goes through the file list in the opposite direction. | |
2546 @findex @kbd{:RelatedFile} | |
2547 @findex @kbd{:PreviousRelatedFile} | |
2548 | |
2549 These commands are akin to @kbd{:n} and @kbd{:N}, but they allow the user to | |
2550 focus on relevant files only. | |
2551 | |
2552 Note that only the master file needs to have the aforementioned block of | |
2553 commands. Also, ";;;" above can be replaced by some other | |
2554 markers. Semicolon is good for Lisp programs, since it is considered a | |
2555 comment designator there. For LaTeX, this could be "%%%", and for C the | |
2556 above block should be commented out. | |
2557 | |
2558 Even though these commands are sometimes useful, they are no substitute for | |
2559 the powerful @emph{tag table} facility of Emacs. Viper's @kbd{:tag} command | |
2560 in a primitive interface to Emacs tags. @xref{Tags,Tags,Tags,emacs, | |
2561 The Gnu Emacs Manual}, for more information on tags. | |
2562 | |
2563 The following two commands are normally bound to a mouse click and are part | |
2564 of Viper. They work only if Emacs runs as an application under X | |
2565 Windows (or under some other window system for which a port of GNU Emacs 20 | |
2566 is available). Clicking the mouse when Emacs is invoked in an Xterm window | |
2567 (using @code{emacs -nw}) will do no good. | |
2568 | |
2569 @table @code | |
2570 @cindex mouse | |
2571 @cindex mouse-search | |
2572 @item viper-mouse-search-key (meta shift 1) | |
2573 @vindex @code{viper-mouse-insert-key} | |
2574 This variable controls the @emph{mouse-search} feature of Viper. The | |
2575 default value | |
2576 states that holding Meta and Shift keys while clicking mouse button 1 | |
2577 should initiate search for a region under the mouse pointer (defined | |
2578 below). This command can take a prefix argument, which indicates the | |
2579 occurrence of the pattern to search for. | |
2580 | |
2581 Note: while loading initially, Viper binds this mouse action only if it is | |
2582 not already bound to something else. If you want to use the mouse-search | |
2583 feature and the Meta-Shift-button-1 mouse action is already bound to | |
2584 something else you can rebind the mouse-search feature by setting | |
2585 @code{viper-mouse-search-key} to something else in your @code{~/.viper} | |
2586 file: | |
2587 @lisp | |
2588 (setq viper-mouse-search-key '(meta 1)) | |
2589 @end lisp | |
2590 This would bind mouse search to the action invoked by pressing the | |
2591 Meta key and clicking mouse button 1. The allowed values of | |
2592 @code{viper-mouse-search-key} are lists that contain a mouse-button number | |
2593 (1,2, or 3) and any combination of the words `control', `meta', and | |
2594 `shift'. | |
2595 | |
2596 If the requested mouse action (e.g., (meta 1)) is already taken for other | |
2597 purposes then you have to confirm your intention by placing the following | |
2598 command in @code{~/.viper} after setting @code{viper-mouse-search-key}: | |
2599 @lisp | |
2600 (viper-bind-mouse-search-key 'force) | |
2601 @end lisp | |
2602 | |
2603 You can also change this setting interactively, through the customization | |
2604 widget of Emacs (choose option "Customize.Customize Group" from the | |
2605 menubar). | |
2606 | |
2607 The region that is chosen as a pattern to search for is determined as | |
2608 follows. If search is invoked via a single click, Viper chooses the region | |
2609 that lies between the beginning of the ``word'' under the pointer (``word'' | |
2610 is understood in Vi sense) and the end of that word. The only difference | |
2611 with Vi's words is that in Lisp major modes `-' is considered an | |
2612 alphanumeric symbol. This is done for the convenience of working with Lisp | |
2613 symbols, which often have an `-' in them. Also, if you click on a | |
2614 non-alphanumeric character that is not a word separator (in Vi sense) then | |
2615 this character will also be considered alphanumeric, provided that it is | |
2616 adjacent (from either side) to an alphanumeric character. This useful | |
2617 feature gives added control over the patterns selected by the mouse click. | |
2618 | |
2619 On a double-click, the region is determined by the beginning of the current | |
2620 Vi's ``Word'' (i.e., the largest non-separator chunk of text) and the End | |
2621 of that ``Word'' (as determined by the @kbd{E} command). | |
2622 | |
2623 On a triple-click, the region consists of the entire line where the click | |
2624 occurred with all leading and trailing spaces and tabs removed. | |
2625 | |
2626 @cindex mouse-insert | |
2627 @item viper-mouse-insert-key (meta shift 2) | |
2628 @vindex @code{viper-mouse-insert-key} | |
2629 This variable controls the @emph{mouse-insert} feature of Viper. | |
2630 The above default value states that | |
2631 holding Meta and Shift keys while clicking mouse button 2 | |
2632 should insert the region surrounding the | |
2633 mouse pointer. The rules defining this region are the same as for | |
2634 mouse-search. This command takes an optional prefix argument, which | |
2635 indicates how many such regions to snarf from the buffer and insert. (In | |
2636 case of a triple-click, the prefix argument is ignored.) | |
2637 | |
2638 Note: while loading initially, Viper binds this mouse action only if it not | |
2639 already bound to something else. If you want to use this feature and the | |
2640 default mouse action is already bound, you can rebind mouse-insert by | |
2641 placing this command in @code{~/.viper}: | |
2642 @lisp | |
2643 (setq viper-mouse-insert-key '(meta 2)) | |
2644 @end lisp | |
2645 If you want to bind mouse-insert to an action even if this action is | |
2646 already taked for other purposes in Emacs, then you should add this command | |
2647 to @code{~/.viper}, after setting @code{viper-mouse-insert-key}: | |
2648 @lisp | |
2649 (viper-bind-mouse-insert-key 'force) | |
2650 @end lisp | |
2651 | |
2652 This value can also be changed via the Emacs customization widget at the | |
2653 menubar. | |
2654 | |
2655 @item viper-multiclick-timeout | |
2656 This variable controls the rate at which double-clicking must occur for the | |
2657 purpose of mouse search and mouse insert. By default, this is set to | |
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
2658 @code{double-click-time} in Emacs and to |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
2659 @code{mouse-track-multi-click-time} milliseconds in XEmacs. |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
2660 @end table |
25829 | 2661 @kindex @kbd{S-mouse-1} |
2662 @kindex @kbd{S-mouse-2} | |
2663 @kindex @kbd{meta shift button1up} | |
2664 @kindex @kbd{meta shift button2up} | |
2665 @vindex @code{viper-multiclick-timeout} | |
2666 @findex @code{viper-mouse-click-insert-word} | |
2667 @findex @code{viper-mouse-click-search-word} | |
2668 | |
2669 Note: The above functions search and insert in the selected window of | |
2670 the latest active frame. This means that you can click in another window or | |
2671 another frame and have search or insertion done in the frame and window you | |
2672 just left. This lets one use these functions in a multi-frame | |
2673 configuration. However, this may require some getting used to. For | |
2674 instance, if you are typing in a frame, A, and then move the mouse to frame | |
2675 B and click to invoke mouse search, search (or insertion) will be performed | |
2676 in frame A. To perform search/insertion in frame B, you will first have to | |
2677 shift focus there, which doesn't happen until you type a character or | |
2678 perform some other action in frame B---mouse search doesn't shift focus. | |
2679 | |
2680 If you decide that you don't like the above feature and always want | |
2681 search/insertion be performed in the frame where the click occurs, don't | |
2682 bind (and unbind, if necessary) @code{viper-mouse-catch-frame-switch} from | |
2683 the mouse event it is bound to. | |
2684 | |
2685 Mouse search is integrated with Vi-style search, so you can | |
2686 repeat it with @kbd{n} and @kbd{N}. It should be also noted that, while | |
2687 case-sensitivity of search in Viper is controlled by the variable | |
2688 @code{viper-case-fold-search}, the case of mouse search is | |
2689 controlled by the Emacs variable @code{case-fold-search}, which may be set | |
2690 differently from @code{viper-case-fold-search}. Therefore, case-sensitivity | |
2691 of mouse search may be different from that of the usual Vi-style search. | |
2692 | |
2693 Finally, if the way Viper determines the word to be searched for or to be | |
2694 inserted is not what you want, there is a variable, | |
2695 @code{viper-surrounding-word-function}, which can be changed to indicate | |
2696 another function for snarfing words out of the buffer. The catch is that | |
2697 you will then have to write such a function and make it known to your | |
2698 Emacs. The function @code{viper-surrounding-word} in @file{viper.el} can be | |
2699 used as a guiding example. | |
2700 | |
2701 @node Vi Macros, ,Viper Specials,Customization | |
2702 @section Vi Macros | |
2703 | |
2704 @cindex Vi macros | |
2705 | |
2706 Viper supports much enhanced Vi-style macros and also facilitates the use | |
2707 of Emacs-style macros. To define a temporary macro, it is generally more | |
2708 convenient to use Emacs keyboard macro facility. Emacs keyboard macros are | |
2709 usually defined anonymously, and the latest macro can be executed by typing | |
2710 @kbd{C-x e} (or @kbd{*}, if Viper is in Vi state). If you need to use several | |
2711 temporary macros, Viper lets you save them to a | |
2712 register (a lowercase letter); such macros can then be executed by typing | |
2713 @kbd{@@a} in Vi state (if a macro was previously saved in register | |
2714 @kbd{a}). | |
2715 @xref{Macros and Registers}, for details. | |
2716 | |
2717 If, however, you need to use a macro regularly, it must be given a | |
2718 permanent name and saved. Emacs manual explains how to do this, but | |
2719 invocation of named Emacs macros is quite different from Vi's. First, | |
2720 invocation of permanent Emacs macros takes time because of the extra keys. | |
2721 Second, binding such macros to function keys, for | |
2722 fast access, hogs valuable real estate on the keyboard. | |
2723 | |
2724 Vi-style macros are better in that respect, since Vi lets the user overload | |
2725 the meaning of key sequences: keys typed in fast succession are treated | |
2726 specially, if this key sequence is bound to a macro. | |
2727 | |
2728 Viper provides keyboard macros through the usual Ex commands, @kbd{:map} and | |
2729 @kbd{:map!}. Vi-style macros are much more powerful in Viper than | |
2730 they are in the original Vi and in other emulators. This is because Viper | |
2731 implements an enhanced vi-style | |
2732 interface to the powerful Emacs keyboard macro facility. | |
2733 | |
2734 First, any Emacs | |
2735 command can be executed while defining a macro, not just the Vi | |
2736 commands. In particular, the user can invoke Emacs commands via @kbd{M-x | |
2737 command-name} or by pressing various function keys on the keyboard. One | |
2738 can even use the mouse, although this is usually not useful and is not | |
2739 recommended (and macros defined with the use of the mouse cannot be saved in | |
2740 command history and in the startup file, for future use). | |
2741 | |
2742 Macros defined by mixing Vi and Emacs commands are represented as | |
2743 vectors. So, don't be confused when you see one (usually through the | |
2744 history of Ex commands). For instance, if @kbd{gg} is defined by typing | |
2745 @kbd{l}, the up-arrow key and @kbd{M-x next-line}, its definition will look | |
2746 as follows in Emacs: | |
2747 | |
2748 @example | |
2749 [l up (meta x) n e x t - l i n e return] | |
2750 @end example | |
2751 | |
2752 Second, Viper macros are defined in a WYSIWYG style. This means that | |
2753 commands are executed as you type them, so you can see precisely what is | |
2754 being defined. Third, macros can be bound to arbitrary sequences of keys, | |
2755 not just to printable keys. For instance, one can define a macro that will | |
2756 be invoked by hitting @kbd{f3} then @kbd{f2} function keys. (The keys | |
2757 @kbd{delete} and @kbd{backspace} are excluded; also, a macro invocation | |
2758 sequence can't start with @key{ESC}. Some other keys, such as @kbd{f1} and | |
2759 @kbd{help}, can't be bound to macros under Emacs, since they | |
2760 are bound in @code{key-translation-map}, which overrides any other binding | |
2761 the user gives to keys. In general, keys that have a binding in | |
2762 @code{key-translation-map} can't be bound to a macro.) | |
2763 | |
2764 Fourth, in Viper, one can define macros that are specific to a given | |
2765 buffer, a given major mode, or macros that are defined for all buffers. In | |
2766 fact, the same macro name can have several different definitions: one | |
2767 global, several definitions for various major modes, and | |
2768 definitions for various specific buffers. Buffer-specific definitions | |
2769 override mode-specific definitions, which, in turn, override global | |
2770 definitions. | |
2771 | |
2772 As if all that is not enough, Viper (through its interface to Emacs | |
2773 macros) lets the user define keyboard macros that ask for confirmation or | |
2774 even prompt the user for input and then continue. To do this, one should | |
2775 type @kbd{C-x q} (for confirmation) or @kbd{C-u C-x q} (for prompt). | |
2776 For details, @pxref{Kbd Macro Query,,Customization,emacs,The GNU Emacs | |
2777 Manual} @refill | |
2778 | |
2779 When the user finishes defining a macro (which is done by typing @kbd{C-x)} --- | |
2780 a departure from Vi), you will be asked whether you want this | |
2781 macro to be global, mode-specific, or buffer-specific. You will also be | |
2782 given a chance to save the macro in your @file{~/.viper} file. | |
2783 This is the easiest way to save a macro and make | |
2784 it permanently available. If you work your startup files with bare hands, | |
2785 here is how Viper saves the above macro so that it will be | |
2786 available in Viper's Insert state (and Replace state) in buffer @code{my-buf} | |
2787 only: | |
2788 | |
2789 @example | |
2790 (viper-record-kbd-macro "gg" 'insert-state | |
2791 [l up (meta x) n e x t - l i n e return] | |
2792 "my-buf") | |
2793 @end example | |
2794 | |
2795 @noindent | |
2796 To do the same for Vi state and all buffers with the major mode | |
2797 @code{cc-mode}, use: | |
2798 | |
2799 @example | |
2800 (viper-record-kbd-macro "gg" 'vi-state | |
2801 [l up (meta x) n e x t - l i n e return] | |
2802 'cc-mode) | |
2803 @end example | |
2804 | |
2805 @noindent | |
2806 Both macro names and macro definitions are vectors of symbols that denote | |
2807 keys on the keyboard. Some keys, like @kbd{\}, @kbd{ }, or digit-keys must | |
2808 be escaped with a backslash. Modified keys are represented as lists. For | |
2809 instance, holding Meta and Control and pressing @kbd{f4} is represented as | |
2810 @kbd{(control meta f4)}. | |
2811 If all members of a vectors are printable characters (or sequences, such as | |
2812 @kbd{\e}, @kbd{\t}, for @key{ESC} and @key{TAB}), then they can also be represented as | |
2813 strings: | |
2814 | |
2815 @example | |
2816 (viper-record-kbd-macro "aa" 'vi-state "aaa\e" "my-buffer") | |
2817 @end example | |
2818 | |
2819 @noindent | |
2820 Thus, typing @kbd{aa} fast in Vi state will switch Viper to Insert state | |
2821 (due to the first @kbd{a}), insert @kbd{aa}, and then it will switch back to Vi | |
2822 state. All this will take effect only in the buffer named @code{my-buffer}. | |
2823 | |
2824 Note that the last argument to @code{viper-record-kbd-macro} must be either a | |
2825 string (a buffer name), a symbol representing a major mode, or @code{t}; | |
2826 the latter says that the macro is to be defined for all buffers | |
2827 (which is how macros are defined in original Vi). | |
2828 | |
2829 For convenience, Viper also lets you define Vi-style macros in its Emacs | |
2830 state. There is no Ex command, like @kbd{:map} and @kbd{:map!} for doing | |
2831 this, but the user can include such a macro in the @file{~/.viper} file. The | |
2832 only thing is that the @code{viper-record-kbd-macro} command should specify | |
2833 @code{emacs-state} instead of @code{vi-state} or @code{insert-state}. | |
2834 | |
2835 The user can get rid of a macro either by using the Ex commands @kbd{:unmap} | |
2836 and @kbd{:unmap!} or by issuing a call to @code{viper-unrecord-kbd-macro}. | |
2837 The latter is more powerful, since it can delete macros even in | |
2838 @code{emacs-state}. However, @code{viper-unrecord-kbd-macro} is usually | |
2839 needed only when the user needs to get rid of the macros that are already | |
2840 predefined in Viper. | |
2841 The syntax is: | |
2842 @findex @code{viper-unrecord-kbd-macro} | |
2843 @example | |
2844 (viper-unrecord-kbd-macro macro state) | |
2845 @end example | |
2846 @noindent | |
2847 The second argument must be @code{vi-state}, @code{insert-state}, or | |
2848 @code{emacs-state}. The first argument is a name of a macro. To avoid | |
2849 mistakes in specifying names of existing macros, type @kbd{M-x | |
2850 viper-describe-kbd-macros} and use a name from the list displayed by this | |
2851 command. | |
2852 | |
2853 If an error occurs during macro definition, Emacs | |
2854 aborts the process, and it must be repeated. This is analogous to Vi, | |
2855 except that in Vi the user doesn't know there is an error until the macro is | |
2856 actually run. All that means that in order for a definition to be | |
2857 successful, the user must do some simple planning of the process in | |
2858 advance, to avoid errors. For instance, if you want to map @kbd{gg} to | |
2859 @kbd{llll} in Vi state, you must make sure that there is enough room on the | |
2860 current line. Since @kbd{l} moves the cursor forward, it may signal an | |
2861 error on reaching the end of line, which will abort the definition. | |
2862 | |
2863 These precautions are necessary only when defining macros; they will help | |
2864 avoid the need to redo the job. When macros are actually run, an error | |
2865 during the execution will simply terminate the current execution | |
2866 (but the macro will remain mapped). | |
2867 | |
2868 A macro name can be a string of characters or a vector of keys. | |
2869 The latter makes it possible to define macros bound to, say, double-hits | |
2870 on a function key, such as @kbd{up} or @kbd{f13}. | |
2871 This is very useful if you run out of function keys on your keyboard; it | |
2872 makes Viper macro facility a @emph{keyboard doubler}, so to speak. | |
2873 | |
2874 Elsewhere (@xref{Keybindings}, for details), we review | |
2875 the standard Emacs mechanism for binding function keys to commands. | |
2876 For instance, | |
2877 | |
2878 @example | |
2879 (global-set-key [f13] 'repeat-complex-command) | |
2880 @end example | |
2881 | |
2882 @noindent | |
2883 binds the key f13 to the Emacs function that repeats the last minibuffer | |
2884 command. Under Viper, however, you may still use this key for additional | |
2885 purposes, if you bind, say, a double-hitting action for that key to some | |
2886 other function. Emacs doesn't allow the user to do that, but Viper does | |
2887 this through its keyboard macro facility. To do this, type @kbd{:map } | |
2888 first. When you are asked to enter a macro name, hit f13 twice, followed by | |
2889 @key{RET} or @key{SPC}. | |
2890 | |
2891 Emacs will now start the mapping process by actually executing | |
2892 Vi and Emacs commands, so that you could see what will happen each time the | |
2893 macro is executed. Suppose now we wanted to bind the key sequence | |
2894 @kbd{f13 f13} to the command @code{eval-last-sexp}. To accomplish this, we | |
2895 can type @kbd{M-x eval-last-sexp} followed by @kbd{C-x )}. | |
2896 If you answer positively to Viper's offer to save this macro in @file{~/.viper} | |
2897 for future uses, the following will be inserted in that file: | |
2898 | |
2899 @example | |
2900 (viper-record-kbd-macro [f16 f16] 'vi-state | |
2901 [(meta x) e v a l - l a s t - s e x p] | |
2902 'lisp-interaction-mode) | |
2903 @end example | |
2904 | |
2905 To illustrate the above point, Viper provides two canned macros, which, by | |
2906 default, are bound to @kbd{[f12 \1]} and @kbd{[f12 \2]} (invoked by typing | |
2907 @kbd{f12} then @kbd{1} and @kbd{2}, respectively). These macros are useful | |
2908 shortcuts to Viper's command ring history. The first macro will execute the | |
2909 second-last destructive command (the last one is executed by @kbd{.}, as | |
2910 usual). The second macro executes the third-last command. | |
2911 | |
2912 If you need to go deeper into the command history, you will have to use | |
2913 other commands, as described earlier in this section; or you can bind, | |
2914 say, @kbd{f12 \3} like this: | |
2915 | |
2916 @example | |
2917 (viper-record-kbd-macro [f12 \3] 'vi-state | |
2918 [(meta x) r e p e a t - f r o m - h i s t o r y] | |
2919 t) | |
2920 @end example | |
2921 | |
2922 | |
2923 Note that even though the macro uses the function key @kbd{f12}, the key is | |
2924 actually free and can still be bound to some Emacs function via | |
2925 @code{define-key} or @code{global-set-key}. | |
2926 | |
2927 | |
2928 Viper allows the user to define macro names that are prefixes of other macros. | |
2929 For instance, one can define @kbd{[[} and @kbd{[[[[} to be macros. | |
2930 If you type the exact sequence of such keys and then pause, Viper will | |
2931 execute the right macro. However, if you don't pause and, say, type | |
2932 @kbd{[[[[text} then the conflict is resolved as follows. If only one of the | |
2933 key sequences, @kbd{[[} or @kbd{[[[[} has a definition applicable to the | |
2934 current buffer, then, in fact, there is no conflict and the right macro | |
2935 will be chosen. If both have applicable definitions, then the first one | |
2936 found will be executed. Usually this is the macro with a shorter name. So, | |
2937 in our case, @kbd{[[[[text} will cause the macro @kbd{[[} to be executed | |
2938 twice and then the remaining keys, @kbd{t e x t}, will be processed. | |
2939 | |
2940 When defining macros using @kbd{:map} or @kbd{:map!}, the user enters the | |
2941 actually keys to be used to invoke the macro. For instance, you should hit | |
2942 the actual key @kbd{f6} if it is to be part of a macro name; you do | |
2943 @emph{not} write `f 6'. When entering keys, Viper displays them as strings or | |
2944 vectors (e.g., "abc" or [f6 f7 a]). The same holds for unmapping. Hitting | |
2945 @key{TAB} while typing a macro name in the @kbd{:unmap} or @kbd{:unmap!} command | |
2946 will cause name completion. Completions are displayed as strings or vectors. | |
2947 However, as before, you don't actually type ``"'', ``['', or ``]'' that | |
2948 appear in the completions. These are meta-symbols that indicate whether | |
2949 the corresponding macro name is a vector or a string. | |
2950 | |
2951 One last difference from Vi: Vi-style keyboard macros cannot be defined in | |
2952 terms of other Vi-style keyboard macros (but named Emacs macros are OK). | |
2953 More precisely, while defining or executing a macro, the special meaning | |
2954 of key sequences (as Vi macros) is ignored. | |
2955 This is because it is all too easy to create an infinite loop in this way. | |
2956 Since Viper macros are much more powerful than Vi's it is impossible to | |
2957 detect such loops. In practice, this is not really a limitation but, | |
2958 rather, a feature. | |
2959 | |
2960 We should also note that Vi macros are disabled in the Minibuffer, which | |
2961 helps keep some potential troubles away. | |
2962 | |
2963 The rate at which the user must type keys in order for them to be | |
2964 recognized as a timeout macro is controlled by the variable | |
2965 @code{viper-fast-keyseq-timeout}, which defaults to 200 milliseconds. | |
2966 | |
2967 For the most part, Viper macros defined in @file{~/.viper} can be shared | |
2968 between X and TTY modes. | |
2969 The problem with TTY may be that the function keys there generate sequences | |
2970 of events instead of a single event (as under a window system). | |
2971 Emacs maps some of these sequences back to the logical keys | |
2972 (e.g., the sequences generated by the arrow keys are mapped to @kbd{up}, | |
2973 @kbd{left}, etc.). However, not all function keys are mapped in this way. | |
2974 Macros that are bound to key sequences that contain such unmapped function | |
2975 keys have to be redefined for TTY's (and possibly for every type of TTY you | |
2976 may be using). To do this, start Emacs on an appropriate TTY device and | |
2977 define the macro using @kbd{:map}, as usual. | |
2978 | |
2979 @findex @code{viper-describe-kbd-macros} | |
2980 Finally, Viper provides a function that conveniently displays all macros | |
2981 currently defined. To see all macros along with their definitions, type | |
2982 @kbd{M-x viper-describe-kbd-macros}. | |
2983 | |
2984 @node Commands,,Customization,Top | |
2985 @chapter Commands | |
2986 | |
2987 This section is a semi-automatically bowdlerized version of the Vi | |
2988 reference created by @* @samp{maart@@cs.vu.nl} and others. It can be | |
2989 found on the Vi archives. This reference has been adapted for Viper.@refill | |
2990 | |
2991 @menu | |
2992 * Groundwork:: Textual Conventions and Viper basics | |
2993 * Text Handling:: Moving, Editing, Undoing. | |
2994 * Display:: Scrolling. | |
2995 * File and Buffer Handling:: Editing, Writing and Quitting. | |
2996 * Mapping:: Mapping Keys, Keyboard Macros | |
2997 * Shell Commands:: Accessing Shell Commands, Processing Text | |
2998 * Options:: Ex options, the @kbd{:set} commands | |
2999 * Emacs Related Commands:: Meta Keys, Windows | |
3000 * Mouse-bound Commands:: Search and insertion of text | |
3001 @end menu | |
3002 | |
3003 @node Groundwork, Text Handling, Commands, Commands | |
3004 @comment node-name, next, previous, up | |
3005 @section Groundwork | |
3006 | |
3007 The VI command set is based on the idea of combining motion commands | |
3008 with other commands. The motion command is used as a text region | |
3009 specifier for other commands. | |
3010 We classify motion commands into @dfn{point commands} and | |
3011 @dfn{line commands}.@refill | |
3012 | |
3013 @cindex point commands | |
3014 | |
3015 The point commands are: | |
3016 | |
3017 @quotation | |
3018 @kbd{h}, @kbd{l}, @kbd{0}, @kbd{$}, @kbd{w}, @kbd{W}, @kbd{b}, @kbd{B}, | |
3019 @kbd{e}, @kbd{E}, @kbd{(}, @kbd{)}, @kbd{/}, @kbd{?}, @kbd{`}, @kbd{f}, | |
3020 @kbd{F}, @kbd{t}, @kbd{T}, @kbd{%}, @kbd{;}, @kbd{,}, @kbd{^} | |
3021 @end quotation | |
3022 | |
3023 @cindex line commands | |
3024 | |
3025 The line commands are: | |
3026 | |
3027 @quotation | |
3028 @kbd{j}, @kbd{k}, @kbd{+}, @kbd{-}, @kbd{H}, @kbd{M}, @kbd{L}, @kbd{@{}, | |
3029 @kbd{@}}, @kbd{G}, @kbd{'}, @kbd{[[}, @kbd{]]}, @kbd{[]} | |
3030 @end quotation | |
3031 @noindent | |
3032 | |
3033 Text Deletion Commands (@pxref{Deleting Text}), Change commands | |
3034 (@pxref{Changing Text}), even Shell Commands (@pxref{Shell Commands}) | |
3035 use these commands to describe a region of text to operate on. | |
3036 | |
3037 @cindex r and R region specifiers | |
3038 | |
3039 Viper adds two region descriptors, @kbd{r} and @kbd{R}. These describe | |
3040 the Emacs regions (@pxref{Basics}), but they are not movement commands. | |
3041 | |
3042 The command description uses angle brackets @samp{<>} to indicate | |
3043 metasyntactic variables, since the normal conventions of using simple | |
3044 text can be confusing with Viper where the commands themselves are | |
3045 characters. Watch out where @kbd{<} shift commands and @kbd{<count>} are | |
3046 mentioned together!!! | |
3047 | |
3048 @kindex <move> | |
3049 @kindex <a-z> | |
3050 @kindex <address> | |
3051 @cindex <move> | |
3052 @cindex <a-z> | |
3053 @cindex <address> | |
3054 @cindex movements | |
3055 | |
3056 @samp{<move>} refers to the above movement commands, and @samp{<a-z>} | |
3057 refers to registers or textmarkers from @samp{a} to @samp{z}. Note | |
3058 that the @samp{<move>} is described by full move commands, that is to | |
3059 say they will take counts, and otherwise behave like normal move commands. | |
3060 @cindex Ex addresses | |
3061 @samp{<address>} refers to Ex line addresses, which include | |
3062 | |
3063 @table @kbd | |
3064 @item .@: <No address> | |
3065 Current line | |
3066 @item .+n .-n | |
3067 Add or subtract for current line | |
3068 @item number | |
3069 Actual line number, use @kbd{.=} to get the line number | |
3070 @item '<a-z> | |
3071 Textmarker | |
3072 @item $ | |
3073 Last line | |
3074 @item x,y | |
3075 Where x and y are one of the above | |
3076 @item % | |
3077 @cindex % (Ex address) | |
3078 For the whole file, same as (1,$). | |
3079 @item /<pat>/ | |
3080 @itemx ?<pat>? | |
3081 Next or previous line with pattern <pat>. | |
3082 | |
3083 Note that the pattern is allowed to contain newline character (inserted as | |
3084 @kbd{C-qC-j}). Therefore, one can search for patterns that span several | |
3085 lines. | |
3086 @end table | |
3087 | |
3088 @cindex % (Current file) | |
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3089 Note that @samp{%} is used in Ex commands @kbd{:e} and @kbd{:r <shell-cmd>} |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3090 to mean current file. If you want a @samp{%} in your command, it must be |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3091 escaped as @samp{\%}. Note that @kbd{:w} and the regular @kbd{:r <file>} |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3092 command doesn't support the meta symbols @samp{%} and @samp{#}, because |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3093 file history is a better mechanism. |
25829 | 3094 @cindex # (Previous file) |
3095 Similarly, @samp{#} expands to the previous file. The previous file is | |
3096 the first file in @kbd{:args} listing. This defaults to previous window | |
3097 in the VI sense if you have one window only. | |
3098 | |
3099 @kindex <args> | |
3100 @kindex <cmd> | |
3101 @cindex <args> | |
3102 @cindex <cmd> | |
3103 @noindent | |
3104 Others like @samp{<args> -- arguments}, @samp{<cmd> -- command} etc. | |
3105 should be fairly obvious. | |
3106 | |
3107 @noindent | |
3108 Common characters referred to include: | |
3109 | |
3110 @table @kbd | |
3111 @item <sp> | |
3112 Space | |
3113 @item <ht> | |
3114 Tab | |
3115 @item <lf> | |
3116 Linefeed | |
3117 @item <esc> | |
3118 Escape | |
3119 @item <cr> | |
3120 Return, Enter | |
3121 @end table | |
3122 @cindex <cr> | |
3123 @cindex <esc> | |
3124 @cindex <lf> | |
3125 @cindex <ht> | |
3126 @cindex <sp> | |
3127 | |
3128 @cindex words | |
3129 @cindex WORDS | |
3130 @cindex char | |
3131 @cindex CHAR | |
3132 | |
3133 We also use @samp{word} for alphanumeric/non-alphanumeric words, and | |
3134 @samp{WORD} for whitespace delimited words. @samp{char} refers to any | |
3135 ASCII character, @samp{CHAR} to non-whitespace character. | |
3136 Brackets @samp{[]} indicate optional parameters; @samp{<count>} also | |
3137 optional, usually defaulting to 1. Brackets are elided for | |
3138 @samp{<count>} to eschew obfuscation. | |
3139 | |
3140 Viper's idea of Vi's words is slightly different from Vi. First, Viper | |
3141 words understand Emacs symbol tables. Therefore, all symbols declared to be | |
3142 alphanumeric in a symbol table can automatically be made part of the Viper | |
3143 word. This is useful when, for instance, editing text containing European, | |
3144 Cyrillic, Japanese, etc., texts. | |
3145 | |
3146 Second, Viper lets you depart from Vi's idea of a word by changing the a | |
3147 syntax preference via the customization widget (the variable | |
3148 @code{viper-syntax-preference}) or by executing | |
3149 @code{viper-set-syntax-preference} interactively. | |
3150 | |
3151 By default, Viper syntax preference is @code{reformed-vi}, which means that | |
3152 Viper considers only those symbols to be part of a word that are specified | |
3153 as word-symbols by the current Emacs syntax table (which may be different | |
3154 for different major modes) plus the underscore symbol @kbd{_}, minus the | |
3155 symbols that are not considered words in Vi (e.g., `,',;, etc.), but may be | |
3156 considered as word-symbols by various Emacs major modes. Reformed-Vi works | |
3157 very close to Vi, and it also recognizes words in other | |
3158 alphabets. Therefore, this is the most appropriate mode for editing text | |
3159 and is likely to fit all your needs. | |
3160 | |
3161 You can also set Viper syntax preference to @code{strict-vi}, which would | |
3162 cause Viper to view all non-English letters as non-word-symbols. | |
3163 | |
3164 You can also specify @code{emacs} as your preference, which would | |
3165 make Viper use exactly the same notion of a word as Emacs does. In | |
3166 particular, the underscore may not be part of a word in some major modes. | |
3167 | |
3168 Finally, if @code{viper-syntax-preference} is set to @code{extended}, Viper | |
3169 words would consist of characters that are classified as alphanumeric | |
3170 @emph{or} as parts of symbols. This is convenient for editing programs. | |
3171 | |
3172 @code{viper-syntax-preference} is a local variable, so it can have different | |
3173 values for different major modes. For instance, in programming modes it can | |
3174 have the value @code{extended}. In text modes where words contain special | |
3175 characters, such as European (non-English) letters, Cyrillic letters, etc., | |
3176 the value can be @code{reformed-vi} or @code{emacs}. | |
3177 If you consider using different syntactic preferences for different major | |
3178 modes, you should execute, for example, | |
3179 | |
3180 @example | |
3181 (viper-set-syntax-preference nil "extended") | |
3182 @end example | |
3183 | |
3184 in the appropriate major mode hooks. | |
3185 | |
3186 @vindex @code{viper-syntax-preference} | |
3187 @findex @code{viper-set-syntax-preference} | |
3188 @cindex syntax table | |
3189 | |
3190 | |
3191 | |
3192 The above discussion concerns only the movement commands. In regular | |
3193 expressions, words remain the same as in Emacs. That is, the expressions | |
3194 @code{\w}, @code{\>}, @code{\<}, etc., use Emacs' idea of what is a word, | |
3195 and they don't look into the value of variable | |
3196 @code{viper-syntax-preference}. This is because Viper avoids changing | |
3197 syntax tables in order to not thwart the various major modes that set these | |
3198 tables. | |
3199 | |
3200 The usual Emacs convention is used to indicate Control Characters, i.e | |
3201 C-h for Control-h. @emph{Do not confuse this to mean the separate | |
3202 characters C - h!!!} The @kbd{^} is itself, never used to indicate a | |
3203 Control character. | |
3204 | |
3205 Finally, we note that Viper's Ex-style commands can be made to work on the | |
3206 current Emacs region. This is done by typing a digit argument before | |
3207 @kbd{:}. For instance, typing @kbd{1:} will propmt you with something like | |
3208 @emph{:123,135}, assuming that the current region starts at line 123 and | |
3209 ends at line 135. There is no need to type the line numbers, since Viper | |
3210 inserts them automatically in front of the Ex command. | |
3211 @cindex Ex commands | |
3212 | |
3213 @node Text Handling, Display, Groundwork, Commands | |
3214 @section Text Handling | |
3215 | |
3216 @menu | |
3217 * Move Commands:: Moving, Searching | |
3218 * Marking:: Textmarkers in Viper and the Emacs Mark. | |
3219 * Appending Text:: Text insertion, Shifting, Putting | |
3220 * Editing in Insert State:: Autoindent, Quoting etc. | |
3221 * Deleting Text:: Deleting | |
3222 * Changing Text:: Changing, Replacement, Joining | |
3223 * Search and Replace:: Searches, Query Replace, Pattern Commands | |
3224 * Yanking:: Yanking, Viewing Registers | |
3225 * Undoing:: Multiple Undo, Backups | |
3226 @end menu | |
3227 | |
3228 @node Move Commands,Marking,,Text Handling | |
3229 @subsection Move Commands | |
3230 | |
3231 @cindex movement commands | |
3232 @cindex searching | |
3233 @cindex textmarkers | |
3234 @cindex markers | |
3235 @cindex column movement | |
3236 @cindex paragraphs | |
3237 @cindex headings | |
3238 @cindex sections | |
3239 @cindex sentences | |
3240 @cindex matching parens | |
3241 @cindex paren matching | |
3242 | |
3243 @table @kbd | |
3244 @item <count> h C-h | |
3245 <count> chars to the left. | |
3246 @item <count> j <lf> C-n | |
3247 <count> lines downward. | |
3248 @item <count> l <sp> | |
3249 <count> chars to the right. | |
3250 @item <count> k C-p | |
3251 <count> lines upward. | |
3252 @item <count> $ | |
3253 To the end of line <count> from the cursor. | |
3254 @item <count> ^ | |
3255 To the first CHAR <count> - 1 lines lower. | |
3256 @item <count> - | |
3257 To the first CHAR <count> lines higher. | |
3258 @item <count> + <cr> | |
3259 To the first CHAR <count> lines lower. | |
3260 @item 0 | |
3261 To the first char of the line. | |
3262 @item <count> | | |
3263 To column <count> | |
3264 @item <count> f<char> | |
3265 <count> <char>s to the right (find). | |
3266 @item <count> t<char> | |
3267 Till before <count> <char>s to the right. | |
3268 @item <count> F<char> | |
3269 <count> <char>s to the left. | |
3270 @item <count> T<char> | |
3271 Till after <count> <char>s to the left. | |
3272 @item <count> ; | |
3273 Repeat latest @kbd{f t F T} <count> times. | |
3274 @item <count> , | |
3275 Repeat latest @kbd{f t F T} | |
3276 <count> times in opposite direction. | |
3277 @item <count> w | |
3278 <count> words forward. | |
3279 @item <count> W | |
3280 <count> WORDS forward. | |
3281 @item <count> b | |
3282 <count> words backward. | |
3283 @item <count> B | |
3284 <count> WORDS backward. | |
3285 @item <count> e | |
3286 To the end of word <count> forward. | |
3287 @item <count> E | |
3288 To the end of WORD <count> forward. | |
3289 @item <count> G | |
3290 Go to line <count> (default end-of-file). | |
3291 @item <count> H | |
3292 To line <count> from top of the screen (home). | |
3293 @item <count> L | |
3294 To line <count> from bottom of the screen (last). | |
3295 @item M | |
3296 To the middle line of the screen. | |
3297 @item <count> ) | |
3298 <count> sentences forward. | |
3299 @item <count> ( | |
3300 <count> sentences backward. | |
3301 @item <count> @} | |
3302 <count> paragraphs forward. | |
3303 @item <count> @{ | |
3304 <count> paragraphs backward. | |
3305 @item <count> ]] | |
3306 To the <count>th heading. | |
3307 @item <count> [[ | |
3308 To the <count>th previous heading. | |
3309 @item <count> [] | |
3310 To the end of <count>th heading. | |
3311 @item m<a-z> | |
3312 Mark the cursor position with a letter. | |
3313 @item `<a-z> | |
3314 To the mark. | |
3315 @item '<a-z> | |
3316 To the first CHAR of the line with the mark. | |
3317 @item [<a-z> | |
3318 Show contents of textmarker. | |
3319 @item ]<a-z> | |
3320 Show contents of register. | |
3321 @item `` | |
3322 To the cursor position before the latest absolute | |
3323 jump (of which are examples @kbd{/} and @kbd{G}). | |
3324 @item '' | |
3325 To the first CHAR of the line on which the cursor | |
3326 was placed before the latest absolute jump. | |
3327 @item <count> /<string> | |
3328 To the <count>th occurrence of <string>. | |
3329 @item <count> /<cr> | |
3330 To the <count>th occurrence of <string> from previous @kbd{/ or ?}. | |
3331 @item <count> ?<string> | |
3332 To the <count>th previous occurrence of <string>. | |
3333 @item <count> ?<cr> | |
3334 To the <count>th previous occurrence of <string> from previous @kbd{?@: or /}. | |
3335 @item n | |
3336 Repeat latest @kbd{/} @kbd{?} (next). | |
3337 @item N | |
3338 Repeat latest search in opposite direction. | |
3339 @item C-c / | |
3340 Without a prefix argument, this command toggles | |
3341 case-sensitive/case-insensitive search modes and plain vanilla/regular | |
3342 expression search. With the prefix argument 1, i.e., | |
3343 @kbd{1 C-c /}, this toggles case-sensitivity; with the prefix argument 2, | |
3344 toggles plain vanilla search and search using | |
3345 regular expressions. @xref{Viper Specials}, for alternative ways to invoke | |
3346 this function. | |
3347 @cindex vanilla search | |
3348 @cindex case-sensitive search | |
3349 @cindex case-insensitive search | |
3350 @item % | |
3351 Find the next bracket/parenthesis/brace and go to its match. | |
3352 By default, Viper ignores brackets/parentheses/braces that occur inside | |
3353 parentheses. You can change this by setting | |
3354 @code{viper-parse-sexp-ignore-comments} to nil in your @file{.viper} file. | |
3355 This option can also be toggled interactively if you quickly hit @kbd{%%%}. | |
3356 | |
3357 This latter feature is implemented as a vi-style keyboard macro. If you | |
3358 don't want this macro, put | |
3359 | |
3360 @example | |
3361 (viper-set-parsing-style-toggling-macro 'undefine) | |
3362 @end example | |
3363 @findex @code{viper-set-parsing-style-toggling-macro} | |
3364 | |
3365 in your @file{~/.viper} file. | |
3366 | |
3367 @end table | |
3368 @kindex @kbd{%} | |
3369 @kindex @kbd{C-c /} | |
3370 @kindex @kbd{N} | |
3371 @kindex @kbd{n} | |
3372 @kindex @kbd{?<cr>} | |
3373 @kindex @kbd{/<cr>} | |
3374 @kindex @kbd{?<string>} | |
3375 @kindex @kbd{/<string>} | |
3376 @kindex @kbd{''} | |
3377 @kindex @kbd{``} | |
3378 @kindex @kbd{]<a-z>} | |
3379 @kindex @kbd{[<a-z>} | |
3380 @kindex @kbd{'<a-z>} | |
3381 @kindex @kbd{`<a-z>} | |
3382 @kindex @kbd{m<a-z>} | |
3383 @kindex @kbd{[]} | |
3384 @kindex @kbd{[[} | |
3385 @kindex @kbd{]]} | |
3386 @kindex @kbd{@{} | |
3387 @kindex @kbd{@}} | |
3388 @kindex @kbd{(} | |
3389 @kindex @kbd{)} | |
3390 @kindex @kbd{M} | |
3391 @kindex @kbd{L} | |
3392 @kindex @kbd{H} | |
3393 @kindex @kbd{G} | |
3394 @kindex @kbd{E} | |
3395 @kindex @kbd{e} | |
3396 @kindex @kbd{B} | |
3397 @kindex @kbd{b} | |
3398 @kindex @kbd{W} | |
3399 @kindex @kbd{w} | |
3400 @kindex @kbd{,} | |
3401 @kindex @kbd{;} | |
3402 @kindex @kbd{T<char>} | |
3403 @kindex @kbd{F<char>} | |
3404 @kindex @kbd{t<char>} | |
3405 @kindex @kbd{f<char>} | |
3406 @kindex @kbd{|} | |
3407 @kindex @kbd{0} | |
3408 @kindex @kbd{<cr>} | |
3409 @kindex @kbd{+} | |
3410 @kindex @kbd{-} | |
3411 @kindex @kbd{^} | |
3412 @kindex @kbd{$} | |
3413 @kindex @kbd{C-p} | |
3414 @kindex @kbd{<lf>} | |
3415 @kindex @kbd{<sp>} | |
3416 @kindex @kbd{C-n} | |
3417 @kindex @kbd{C-h} | |
3418 @kindex @kbd{h} | |
3419 @kindex @kbd{j} | |
3420 @kindex @kbd{k} | |
3421 @kindex @kbd{l} | |
3422 @vindex @code{viper-parse-sexp-ignore-comments} | |
3423 | |
3424 @node Marking,Appending Text,Move Commands,Text Handling | |
3425 @subsection Marking | |
3426 | |
3427 Emacs mark is referred to in the region specifiers @kbd{r} and @kbd{R}. | |
3428 @xref{Emacs Preliminaries}, and @xref{Basics}, for explanation. Also | |
3429 see @ref{Mark,,Mark,emacs,The GNU Emacs manual}, for an explanation of | |
3430 the Emacs mark ring. | |
3431 | |
3432 @cindex marking | |
3433 | |
3434 @table @kbd | |
3435 @item m<a-z> | |
3436 Mark the current file and position with the specified letter. | |
3437 @item m . | |
3438 Set the Emacs mark (@pxref{Emacs Preliminaries}) at point. | |
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3439 @item m ^ |
26490
2b08d829af86
Fix complaints from makeinfo 4.0.
Eli Zaretskii <eliz@gnu.org>
parents:
26263
diff
changeset
|
3440 Set the Emacs mark (@pxref{Emacs Preliminaries}) back to where it was last |
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3441 set with the @kbd{m.} command. This is useful when you set the mark with |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3442 @kbd{m.}, but then some other command (such as @kbd{L} or @kbd{G}) changes |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3443 it in a way that you didn't like. |
25829 | 3444 @item m < |
3445 Set the Emacs mark at beginning of buffer. | |
3446 @item m > | |
3447 Set the Emacs mark at end of buffer. | |
3448 @item m , | |
3449 Jump to the Emacs mark. | |
3450 @item :mark <char> | |
3451 Mark position with text marker named <char>. This is an Ex command. | |
3452 @item :k <char> | |
3453 Same as @kbd{:mark}. | |
3454 @item `` | |
3455 Exchange point and mark. | |
3456 @item '' | |
3457 Exchange point and mark and go to the first CHAR on line. | |
3458 @item '<a-z> | |
3459 Go to specified Viper mark. | |
3460 @item | |
3461 Go to specified Viper mark and go to the first CHAR on line. | |
3462 @end table | |
3463 @kindex @kbd{m<a-z>} | |
3464 @kindex @kbd{m.} | |
3465 @kindex @kbd{m>} | |
3466 @kindex @kbd{m<} | |
3467 @kindex @kbd{m,} | |
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3468 @kindex @kbd{m^} |
25829 | 3469 @findex @kbd{:mark} |
3470 @findex @kbd{:k} | |
3471 @kindex @kbd{''} | |
3472 @kindex @kbd{``} | |
3473 @kindex @kbd{`<a-z>} | |
3474 @kindex @kbd{'<a-z>} | |
3475 | |
3476 @node Appending Text, Editing in Insert State, Marking,Text Handling | |
3477 @subsection Appending Text | |
3478 | |
3479 @xref{Options}, to see how to change tab and shiftwidth size. See the GNU | |
3480 Emacs manual, or try @kbd{C-ha tabs} (If you have turned Emacs help on). | |
3481 Check out the variable @code{indent-tabs-mode} to put in just spaces. | |
3482 Also see options for word-wrap. | |
3483 | |
3484 @cindex inserting | |
3485 @cindex appending | |
3486 @cindex paste | |
3487 @cindex put | |
3488 | |
3489 @table @kbd | |
3490 @item <count> a | |
3491 <count> times after the cursor. | |
3492 @item <count> A | |
3493 <count> times at the end of line. | |
3494 @item <count> i | |
3495 <count> times before the cursor (insert). | |
3496 @item <count> I | |
3497 <count> times before the first CHAR of the line | |
3498 @item <count> o | |
3499 On a new line below the current (open). | |
3500 The count is only useful on a slow terminal. | |
3501 @item <count> O | |
3502 On a new line above the current. | |
3503 The count is only useful on a slow terminal. | |
3504 @item <count> ><move> | |
3505 Shift the lines described by <count><move> one | |
3506 shiftwidth to the right (layout!). | |
3507 @item <count> >> | |
3508 Shift <count> lines one shiftwidth to the right. | |
3509 @item <count> ["<a-z1-9>]p | |
3510 Put the contents of the (default undo) buffer | |
3511 <count> times after the cursor. The register will | |
3512 be automatically down-cased. | |
3513 @item <count> ["<a-z1-9>]P | |
3514 Put the contents of the (default undo) buffer | |
3515 <count> times before the cursor. The register will | |
3516 @item [<a-z> | |
3517 Show contents of textmarker. | |
3518 @item ]<a-z> | |
3519 Show contents of register. | |
3520 @item <count> . | |
3521 Repeat previous command <count> times. For destructive | |
3522 commands as well as undo. | |
3523 @item f1 1 and f1 2 | |
3524 While @kbd{.} repeats the last destructive command, | |
3525 these two macros repeat the second-last and the third-last destructive | |
3526 commands. @xref{Vi Macros}, for more information on Vi macros. | |
3527 @item C-c M-p and C-c M-n | |
3528 In Vi state, | |
3529 these commands help peruse the history of Vi's destructive commands. | |
3530 Successive typing of @kbd{C-c M-p} causes Viper to search the history in | |
3531 the direction | |
3532 of older commands, while hitting @kbd{C-c M-n} does so in reverse | |
3533 order. Each command in the history is displayed in the Minibuffer. The | |
3534 displayed command can | |
3535 then be executed by typing `@kbd{.}'. | |
3536 | |
3537 Since typing the above sequences of keys may be tedious, the | |
3538 functions doing the perusing can be bound to unused keyboard keys in the | |
3539 @file{~/.viper} file. @xref{Viper Specials}, for details. | |
3540 @end table | |
3541 @kindex @kbd{C-c M-p} | |
3542 @kindex @kbd{C-c M-n} | |
3543 @kindex @kbd{.} | |
3544 @kindex @kbd{]<a-z>} | |
3545 @kindex @kbd{[<a-z>} | |
3546 @kindex @kbd{P} | |
3547 @kindex @kbd{p} | |
3548 @kindex @kbd{"<a-z1-9>p} | |
3549 @kindex @kbd{"<a-z1-9>P} | |
3550 @kindex @kbd{>>} | |
3551 @kindex @kbd{><move>} | |
3552 @kindex @kbd{O} | |
3553 @kindex @kbd{o} | |
3554 @kindex @kbd{i} | |
3555 @kindex @kbd{A} | |
3556 @kindex @kbd{a} | |
3557 | |
3558 @node Editing in Insert State, Deleting Text, Appending Text,Text Handling | |
3559 @subsection Editing in Insert State | |
3560 | |
3561 Minibuffer can be edited similarly to Insert state, and you can switch | |
3562 between Insert/Replace/Vi states at will. | |
3563 Some users prefer plain Emacs feel in the Minibuffer. To this end, set | |
3564 @var{viper-vi-style-in-minibuffer} to @code{nil}. | |
3565 | |
3566 @cindex Insert state | |
3567 | |
3568 @table @kbd | |
3569 @item C-v | |
3570 Deprive the next char of its special meaning (quoting). | |
3571 @item C-h | |
3572 One char back. | |
3573 @item C-w | |
3574 One word back. | |
3575 @item C-u | |
3576 Back to the begin of the change on the | |
3577 current line. | |
3578 | |
3579 @end table | |
3580 @kindex @kbd{C-u} | |
3581 @kindex @kbd{C-w} | |
3582 @kindex @kbd{C-v} | |
3583 | |
3584 @node Deleting Text, Changing Text, Editing in Insert State, Text Handling | |
3585 @subsection Deleting Text | |
3586 | |
3587 | |
3588 There is one difference in text deletion that you should be | |
3589 aware of. This difference comes from Emacs and was adopted in Viper | |
3590 because we find it very useful. In Vi, if you delete a line, say, and then | |
3591 another line, these two deletions are separated and are put back | |
3592 separately if you use the @samp{p} command. In Emacs (and Viper), successive | |
3593 series of deletions that are @emph{not interrupted} by other commands are | |
3594 lumped together, so the deleted text gets accumulated and can be put back | |
3595 as one chunk. If you want to break a sequence of deletions so that the | |
3596 newly deleted text could be put back separately from the previously deleted | |
3597 text, you should perform a non-deleting action, e.g., move the cursor one | |
3598 character in any direction. | |
3599 | |
3600 @cindex shifting text | |
3601 | |
3602 @table @kbd | |
3603 @item <count> x | |
3604 Delete <count> chars under and after the cursor. | |
3605 @item <count> X | |
3606 Delete <count> chars before the cursor. | |
3607 @item <count> d<move> | |
3608 Delete from point to endpoint of <count><move>. | |
3609 @item <count> dd | |
3610 Delete <count> lines. | |
3611 @item D | |
3612 The rest of the line. | |
3613 @item <count> <<move> | |
3614 Shift the lines described by <count><move> one | |
3615 shiftwidth to the left (layout!). | |
3616 @item <count> << | |
3617 Shift <count> lines one shiftwidth to the left. | |
3618 @end table | |
3619 @kindex @kbd{<<} | |
3620 @kindex @kbd{<<move>} | |
3621 @kindex @kbd{D} | |
3622 @kindex @kbd{dd} | |
3623 @kindex @kbd{d<move>} | |
3624 @kindex @kbd{X} | |
3625 @kindex @kbd{x} | |
3626 | |
3627 @node Changing Text, Search and Replace, Deleting Text,Text Handling | |
3628 @subsection Changing Text | |
3629 | |
3630 @cindex joining lines | |
3631 @cindex changing case | |
3632 @cindex quoting regions | |
3633 @cindex substitution | |
3634 | |
3635 @table @kbd | |
3636 @item <count> r<char> | |
3637 Replace <count> chars by <char> - no <esc>. | |
3638 @item <count> R | |
3639 Overwrite the rest of the line, | |
3640 appending change @var{count - 1} times. | |
3641 @item <count> s | |
3642 Substitute <count> chars. | |
3643 @item <count> S | |
3644 Change <count> lines. | |
3645 @item <count> c<move> | |
3646 Change from begin to endpoint of <count><move>. | |
3647 @item <count> cc | |
3648 Change <count> lines. | |
3649 @item <count> C | |
3650 The rest of the line and <count> - 1 next lines. | |
3651 @item <count> =<move> | |
3652 Reindent the region described by move. | |
3653 @item <count> ~ | |
3654 Switch lower and upper cases. | |
3655 @item <count> J | |
3656 Join <count> lines (default 2). | |
3657 @item :[x,y]s/<pat>/<repl>/<f> | |
3658 Substitute (on lines x through y) the pattern | |
3659 <pat> (default the last pattern) with <repl>. Useful | |
3660 flags <f> are @samp{g} for @samp{global} (i.e.@: change every | |
3661 non-overlapping occurrence of <pat>) and @samp{c} for | |
3662 @samp{confirm} (type @samp{y} to confirm a particular | |
3663 substitution, else @samp{n} ). Instead of @kbd{/} any | |
3664 punctuation CHAR unequal to <space> <tab> and <lf> can be used as | |
3665 delimiter. | |
3666 | |
3667 In Emacs, @samp{\&} stands for the last matched expression, so | |
3668 @kbd{s/[ab]+/\&\&/} will double the string matched by @kbd{[ab]}. | |
3669 Viper doesn't treat @samp{&} specially, unlike Vi: use @samp{\&} instead. | |
3670 | |
3671 Note: @emph{The newline character (inserted as @kbd{C-qC-j}) | |
3672 can be used in <repl>}. | |
3673 @item :[x,y]copy [z] | |
3674 Copy text between @kbd{x} and @kbd{y} to the position after @kbd{z}. | |
3675 @item :[x,y]t [z] | |
3676 Same as @kbd{:copy}. | |
3677 @item :[x,y]move [z] | |
3678 Move text between @kbd{x} and @kbd{y} to the position after @kbd{z}. | |
3679 @item & | |
3680 Repeat latest Ex substitute command, e.g. | |
3681 @kbd{:s/wrong/right}. | |
3682 @item C-c / | |
3683 Toggle case-sensitive search. With prefix argument, toggle vanilla/regular | |
3684 expression search. | |
3685 @item #c<move> | |
3686 Change upper-case characters in the region to lower-case. | |
3687 @item #C<move> | |
3688 Change lower-case characters in the region to upper-case. | |
3689 @item #q<move> | |
3690 Insert specified string at the beginning of each line in the region | |
3691 @item C-c M-p and C-c M-n | |
3692 In Insert and Replace states, these keys are bound to commands that peruse | |
3693 the history of the text | |
3694 previously inserted in other insert or replace commands. By repeatedly typing | |
3695 @kbd{C-c M-p} or @kbd{C-c M-n}, you will cause Viper to | |
3696 insert these previously used strings one by one. | |
3697 When a new string is inserted, the previous one is deleted. | |
3698 | |
3699 In Vi state, these keys are bound to functions that peruse the history of | |
3700 destructive Vi commands. | |
3701 @xref{Viper Specials}, for details. | |
3702 @end table | |
3703 @kindex @kbd{C-c M-p} | |
3704 @kindex @kbd{C-c M-n} | |
3705 @kindex @kbd{#q<move> } | |
3706 @kindex @kbd{#C<move>} | |
3707 @kindex @kbd{#c<move>} | |
3708 @kindex @kbd{&} | |
3709 @kindex @kbd{\&} | |
3710 @findex @kbd{:substitute/<pat>/<repl>/<f>} | |
3711 @findex @kbd{:s/<pat>/<repl>/<f>} | |
3712 @findex @kbd{:copy [z]} | |
3713 @findex @kbd{:t [z]} | |
3714 @findex @kbd{:move [z]} | |
3715 @kindex @kbd{J} | |
3716 @kindex @kbd{~} | |
3717 @kindex @kbd{=<move>} | |
3718 @kindex @kbd{C} | |
3719 @kindex @kbd{cc} | |
3720 @kindex @kbd{c<move>} | |
3721 @kindex @kbd{S} | |
3722 @kindex @kbd{s} | |
3723 @kindex @kbd{R} | |
3724 @kindex @kbd{r<char>} | |
3725 | |
3726 @node Search and Replace, Yanking, Changing Text,Text Handling | |
3727 @subsection Search and Replace | |
3728 | |
3729 @xref{Groundwork}, for Ex address syntax. @xref{Options}, to see how to | |
3730 get literal (non-regular-expression) search and how to stop search from | |
3731 wrapping around. | |
3732 | |
3733 @table @kbd | |
3734 @item <count> /<string> | |
3735 To the <count>th occurrence of <string>. | |
3736 @item <count> ?<string> | |
3737 To the <count>th previous occurrence of <string>. | |
3738 @item <count> g<move> | |
3739 Search for the text described by move. (off by default) | |
3740 @item n | |
3741 Repeat latest @kbd{/} @kbd{?} (next). | |
3742 @item N | |
3743 Idem in opposite direction. | |
3744 @item % | |
3745 Find the next bracket and go to its match | |
3746 @item :[x,y]g/<string>/<cmd> | |
3747 @cindex text processing | |
3748 Search globally [from line x to y] for <string> | |
3749 and execute the Ex <cmd> on each occurrence. | |
3750 @item :[x,y]v/<string>/<cmd> | |
3751 Execute <cmd> on the lines that don't match. | |
3752 @item #g<move> | |
3753 Execute the last keyboard macro for each line in the region. | |
3754 @xref{Macros and Registers}, for more info. | |
3755 @item Q | |
3756 Query Replace. | |
3757 @item :ta <name> | |
3758 Search in the tags file where <name> is defined (file, line), and go to it. | |
3759 @item :[x,y]s/<pat>/<repl>/<f> | |
3760 Substitute (on lines x through y) the pattern <pat> (default the last | |
3761 pattern) with <repl>. Useful | |
3762 flags <f> are @samp{g} for @samp{global} (i.e.@: change every | |
3763 non-overlapping occurrence of <pat>) and @samp{c} for | |
3764 @samp{confirm} (type @samp{y} to confirm a particular | |
3765 substitution, else @samp{n}). Instead of @kbd{/} any | |
3766 punctuation character other than <space> <tab> and <lf> can be used as | |
3767 delimiter. | |
3768 | |
3769 Note: @emph{The newline character (inserted as @kbd{C-qC-j}) | |
3770 can be used in <repl>}. | |
3771 @item & | |
3772 Repeat latest Ex substitute command, e.g.@: @kbd{:s/wrong/right}. | |
3773 @item :global /<pattern>/<ex-command> | |
3774 @itemx :g /<pattern>/<ex-command> | |
3775 Execute <ex-command> on all lines that match <pattern>. | |
3776 @item :vglobal /<pattern>/<ex-command> | |
3777 @itemx :v /<pattern>/<ex-command> | |
3778 Execute <ex-command> on all lines that do not match <pattern>. | |
3779 @end table | |
3780 @kindex @kbd{&} | |
3781 @findex @kbd{:substitute/<pat>/<repl>/<f>} | |
3782 @kindex @kbd{Q} | |
3783 @kindex @kbd{#g<move>} | |
3784 @findex @kbd{:v} | |
3785 @findex @kbd{:g} | |
3786 @findex @kbd{:global} | |
3787 @findex @kbd{:vglobal} | |
3788 @findex @kbd{:tag <name>} | |
3789 @kindex @kbd{%} | |
3790 @kindex @kbd{N} | |
3791 @kindex @kbd{n} | |
3792 @kindex @kbd{g<move>} | |
3793 @kindex @kbd{?<string>} | |
3794 @kindex @kbd{/<string>} | |
3795 | |
3796 @node Yanking,Undoing,Search and Replace,Text Handling | |
3797 @subsection Yanking | |
3798 | |
3799 @cindex cut and paste | |
3800 @cindex paste | |
3801 | |
3802 @table @kbd | |
3803 @item <count> y<move> | |
3804 Yank from begin to endpoint of <count><move>. | |
3805 @item <count> "<a-z>y<move> | |
3806 Yank from begin to endpoint of <count><move> to register. | |
3807 @item <count> "<A-Z>y<move> | |
3808 Yank from begin to endpoint of <count><move> and append | |
3809 to register. | |
3810 @item <count> yy | |
3811 <count> lines. | |
3812 @item <count> Y | |
3813 Idem (should be equivalent to @kbd{y$} though). | |
3814 @item m<a-z> | |
3815 Mark the cursor position with a letter. | |
3816 @item [<a-z> | |
3817 Show contents of textmarker. | |
3818 @item ]<a-z> | |
3819 Show contents of register. | |
3820 @item <count> ["<a-z1-9>]p | |
3821 Put the contents of the (default undo) buffer | |
3822 <count> times after the cursor. The register will | |
3823 be automatically down-cased. | |
3824 @item <count> ["<a-z1-9>]P | |
3825 Put the contents of the (default undo) buffer | |
3826 <count> times before the cursor. The register will | |
3827 @end table | |
3828 @kindex @kbd{P} | |
3829 @kindex @kbd{p} | |
3830 @kindex @kbd{"<a-z1-9>p} | |
3831 @kindex @kbd{"<a-z1-9>P} | |
3832 @kindex @kbd{]<a-z>} | |
3833 @kindex @kbd{[<a-z>} | |
3834 @kindex @kbd{m<a-z>} | |
3835 @kindex @kbd{Y} | |
3836 @kindex @kbd{yy} | |
3837 @kindex @kbd{"<A-Z>y<move>} | |
3838 @kindex @kbd{"<a-z>y<move>} | |
3839 @kindex @kbd{y<move>} | |
3840 @kindex @kbd{yank} | |
3841 @findex @kbd{:yank} | |
3842 | |
3843 @node Undoing,, Yanking,Text Handling | |
3844 @subsection Undoing | |
3845 | |
3846 @cindex undo | |
3847 @cindex backup files | |
3848 | |
3849 @table @kbd | |
3850 @item u U | |
3851 Undo the latest change. | |
3852 @item . | |
3853 Repeat undo. | |
3854 @item :q! | |
3855 Quit Vi without writing. | |
3856 @item :e! | |
3857 Re-edit a messed-up file. | |
3858 @item :rec | |
3859 Recover file from autosave. Viper also creates backup files | |
3860 that have a @samp{~} appended to them. | |
3861 @end table | |
3862 @findex @kbd{:rec} | |
3863 @findex @kbd{:e!} | |
3864 @findex @kbd{:q!} | |
3865 @kindex @kbd{.} | |
3866 @kindex @kbd{U} | |
3867 @kindex @kbd{u} | |
3868 | |
3869 @node Display, File and Buffer Handling, Text Handling, Commands | |
3870 @section Display | |
3871 | |
3872 @cindex scrolling | |
3873 | |
3874 @table @kbd | |
3875 @item C-g | |
3876 At user level 1, | |
3877 give file name, status, current line number | |
3878 and relative position.@* | |
3879 At user levels 2 and higher, abort the current command. | |
3880 @item C-c g | |
3881 Give file name, status, current line number and relative position -- all | |
3882 user levels. | |
3883 @item C-l | |
3884 Refresh the screen. | |
3885 @item <count> C-e | |
3886 Expose <count> more lines at bottom, cursor stays put (if possible). | |
3887 @item <count> C-y | |
3888 Expose <count> more lines at top, cursor stays put (if possible). | |
3889 @item <count> C-d | |
3890 Scroll <count> lines downward (default the number of the previous scroll; | |
3891 initialization: half a page). | |
3892 @item <count> C-u | |
3893 Scroll <count> lines upward (default the number of the previous scroll; | |
3894 initialization: half a page). | |
3895 @item <count> C-f | |
3896 <count> pages forward. | |
3897 @item <count> C-b | |
3898 <count> pages backward (in older versions @kbd{C-b} only works without count). | |
3899 @item <count> z<cr> | |
3900 @item zH | |
3901 Put line <count> at the top of the window (default the current line). | |
3902 @item <count> z- | |
3903 @item zL | |
3904 Put line <count> at the bottom of the window | |
3905 (default the current line). | |
3906 @item <count> z. | |
3907 @item zM | |
3908 Put line <count> in the center of the window | |
3909 (default the current line). | |
3910 @end table | |
3911 @kindex @kbd{zM} | |
3912 @kindex @kbd{zL} | |
3913 @kindex @kbd{zH} | |
3914 @kindex @kbd{z<cr>} | |
3915 @kindex @kbd{z.} | |
3916 @kindex @kbd{z-} | |
3917 @kindex @kbd{z<cr>} | |
3918 @kindex @kbd{C-b} | |
3919 @kindex @kbd{C-f} | |
3920 @kindex @kbd{C-u} | |
3921 @kindex @kbd{C-d} | |
3922 @kindex @kbd{C-y} | |
3923 @kindex @kbd{C-e} | |
3924 @kindex @kbd{C-l} | |
3925 @kindex @kbd{C-g} | |
3926 | |
3927 | |
3928 @node File and Buffer Handling, Mapping, Display,Commands | |
3929 @section File and Buffer Handling | |
3930 | |
3931 @cindex multiple files | |
3932 | |
3933 In all file handling commands, space should be typed before entering the file | |
3934 name. If you need to type a modifier, such as @kbd{>>} or @kbd{!}, don't | |
3935 put any space between the command and the modifier. | |
3936 | |
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3937 Note that many Ex commands, e.g., @kbd{:w}, accept command arguments. The |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3938 effect is that the command would start acting on the current region. For |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3939 instance, if the current region spans the lines 11 through 22, then if you |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3940 type @kbd{1:w} you would see @samp{:11,22w} in the minibuffer. |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3941 |
25829 | 3942 @table @kbd |
3943 @item :q | |
3944 Quit buffer except if modified. | |
3945 @item :q! | |
3946 Quit buffer without checking. In Viper, these two commands | |
3947 are identical. Confirmation is required if exiting modified buffers that | |
3948 visit files. | |
3949 @item :suspend | |
3950 @item :stop | |
3951 Suspend Viper | |
3952 @item :[x,y] w | |
3953 Write the file. Viper makes sure that a final newline is always added to | |
3954 any file where this newline is missing. This is done by setting Emacs | |
3955 variable @code{require-final-newline} to @code{t}. If you don't like this | |
3956 feature, use @code{setq-default} to set @code{require-final-newline} to | |
3957 @code{nil}. This must be done in @file{.viper} file. | |
3958 @item :[x,y] w <name> | |
3959 Write to the file <name>. | |
3960 @item :[x,y] w>> <name> | |
3961 Append the buffer to the file <name>. There should be no space between | |
3962 @kbd{w} and @kbd{>>}. Type space after the @kbd{>>} and see what happens. | |
3963 @item :w!@: <name> | |
3964 Overwrite the file <name>. In Viper, @kbd{:w} and @kbd{:w!} are identical. | |
3965 Confirmation is required for writing to an existing file (if this is not | |
3966 the file the buffer is visiting) or to a read-only file. | |
3967 @item :x,y w <name> | |
3968 Write lines x through y to the file <name>. | |
3969 @item :wq | |
3970 Write the file and kill buffer. | |
3971 @item :r <file> [<file> ...] | |
3972 Read file into a buffer, inserting its contents after the current line. | |
3973 @item :xit | |
3974 Same as @kbd{:wq}. | |
3975 @item :Write | |
3976 @itemx :W | |
3977 Save all unsaved buffers, asking for confirmation. | |
3978 @item :WWrite | |
3979 @itemx :WW | |
3980 Like @kbd{W}, but without asking for confirmation. | |
3981 @item ZZ | |
3982 Save current buffer and kill it. If user level is 1, then save all files | |
3983 and kill Emacs. Killing Emacs is the wrong way to use it, so you should | |
3984 switch to higher user levels as soon as possible. | |
3985 @item :x [<file>] | |
3986 Save and kill buffer. | |
3987 @item :x!@: [<file>] | |
3988 @kbd{:w![<file>]} and @kbd{:q}. | |
3989 @item :pre | |
3990 Preserve the file -- autosave buffers. | |
3991 @item :rec | |
3992 Recover file from autosave. | |
3993 @item :f | |
3994 Print file name and lines. | |
3995 @item :cd [<dir>] | |
3996 Set the working directory to <dir> (default home directory). | |
3997 @item :pwd | |
3998 Print present working directory. | |
3999 @item :e [+<cmd>] <files> | |
4000 Edit files. If no filename is given, edit the file visited by the current | |
4001 buffer. If buffer was modified or the file changed on disk, ask for | |
4002 confirmation. Unlike Vi, Viper allows @kbd{:e} to take multiple arguments. | |
4003 The first file is edited the same way as in Vi. The rest are visited | |
4004 in the usual Emacs way. | |
4005 @item :e!@: [+<cmd>] <files> | |
4006 Re-edit file. If no filename, re-edit current file. | |
4007 In Viper, unlike Vi, @kbd{e!} is identical to @kbd{:e}. In both cases, the | |
4008 user is asked to confirm if there is a danger of discarding changes to a | |
4009 buffer. | |
4010 @item :q! | |
4011 Quit Vi without writing. | |
4012 @item C-^ | |
4013 Edit the alternate (normally the previous) file. | |
4014 @item :rew | |
4015 Obsolete | |
4016 @item :args | |
4017 List files not shown anywhere with counts for next | |
4018 @item :n [count] [+<cmd>] [<files>] | |
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4019 Edit <count> file, or edit files. The count comes from @kbd{:args}. |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4020 @item :N [count] [+<cmd>] [<files>] |
25829 | 4021 Like @kbd{:n}, but the meaning of the variable |
4022 @var{ex-cycle-other-window} is reversed. | |
4023 @item :b | |
4024 Switch to another buffer. If @var{ex-cycle-other-window} is @code{t}, | |
4025 switch in another window. Buffer completion is supported. | |
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4026 The variable @var{viper-read-buffer-function} controls which function is |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4027 actually used to read the buffer name. The default is @code{read-buffer}, |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4028 but better alternatives are also available in Emacs (e.g., |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4029 @code{iswitchb-read-buffer}). |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4030 @vindex @var{viper-read-buffer-function} |
25829 | 4031 @item :B |
4032 Like @kbd{:b}, but the meaning of @var{ex-cycle-other-window} is reversed. | |
4033 @item :<address>r <name> | |
4034 Read the file <name> into the buffer after the line <address>. | |
4035 @item v, V, C-v | |
4036 Edit a file in current or another window, or in another frame. File name | |
4037 is typed in Minibuffer. File completion and history are supported. | |
4038 @end table | |
4039 @kindex @kbd{v} | |
4040 @kindex @kbd{V} | |
4041 @findex @kbd{:args} | |
4042 @findex @kbd{:rew} | |
4043 @kindex @kbd{C-^} | |
4044 @findex @kbd{:e!@: [<files>]} | |
4045 @findex @kbd{:e [<files>]} | |
4046 @findex @kbd{:edit [<files>]} | |
4047 @findex @kbd{:edit!@: [<files>]} | |
4048 @findex @kbd{:q!} | |
4049 @findex @kbd{:q} | |
4050 @findex @kbd{:quit} | |
4051 @findex @kbd{:quit!} | |
4052 @findex @kbd{:f} | |
4053 @findex @kbd{:rec} | |
4054 @findex @kbd{:r} | |
4055 @findex @kbd{:read} | |
4056 @findex @kbd{:pre} | |
4057 @kindex @kbd{ZZ} | |
4058 @findex @kbd{:wq} | |
4059 @findex @kbd{:w <file>} | |
4060 @findex @kbd{:w!@: <file>} | |
4061 @findex @kbd{:w >> <file>} | |
4062 @findex @kbd{:write <file>} | |
4063 @findex @kbd{:write!@: <file>} | |
4064 @findex @kbd{:write >> <file>} | |
4065 @findex @kbd{:W} | |
4066 @findex @kbd{:WW} | |
4067 @findex @kbd{:Write} | |
4068 @findex @kbd{:WWrite} | |
4069 @findex @kbd{:WWrite} | |
4070 @findex @kbd{:x} | |
4071 @findex @kbd{:x!} | |
4072 @findex @kbd{:suspend} | |
4073 @findex @kbd{:stop} | |
4074 @findex @kbd{:n [<count> | <file>]} | |
4075 @findex @kbd{:cd [<dir>]} | |
4076 @findex @kbd{:pwd} | |
4077 | |
4078 @node Mapping, Shell Commands, File and Buffer Handling, Commands | |
4079 @section Mapping | |
4080 | |
4081 @cindex keybindings | |
4082 @cindex key mapping | |
4083 | |
4084 @table @kbd | |
4085 @item :map <string> | |
4086 Start defining a Vi-style keyboard macro. | |
4087 For instance, typing | |
4088 @kbd{:map www} followed by @kbd{:!wc %} and then typing @kbd{C-x )} | |
4089 will cause @kbd{www} to run wc on | |
4090 current file (Vi replaces @samp{%} with the current file name). | |
4091 @item C-x ) | |
4092 Finish defining a keyboard macro. | |
4093 In Viper, this command completes the process of defining all keyboard | |
4094 macros, whether they are Emacs-style or Vi-style. | |
4095 This is a departure from Vi, needed to allow WYSIWYG mapping of | |
4096 keyboard macros and to permit the use of function keys and arbitrary Emacs | |
4097 functions in the macros. | |
4098 @item :unmap <string> | |
4099 Deprive <string> of its mappings in Vi state. | |
4100 @item :map!@: <string> | |
4101 Map a macro for Insert state. | |
4102 @item :unmap!@: <string> | |
4103 Deprive <string> of its mapping in Insert state (see @kbd{:unmap}). | |
4104 @item @@<a-z> | |
4105 In Vi state, | |
4106 execute the contents of register as a command. | |
4107 @item @@@@ | |
4108 In Vi state, | |
4109 repeat last register command. | |
4110 @item @@# | |
4111 In Vi state, | |
4112 begin keyboard macro. End with @@<a-z>. This will | |
4113 put the macro in the proper register. Register will | |
4114 be automatically down-cased. | |
4115 @xref{Macros and Registers}, for more info. | |
4116 @item @@!<a-z> | |
4117 In Vi state, | |
4118 yank anonymous macro to register | |
4119 @item * | |
4120 In Vi state, | |
4121 execute anonymous macro (defined by C-x( and C-x )). | |
4122 @item C-x e | |
4123 Like @kbd{*}, but works in all Viper states. | |
4124 @item #g<move> | |
4125 Execute the last keyboard macro for each line in the region. | |
4126 @xref{Macros and Registers}, for more info. | |
4127 @item [<a-z> | |
4128 Show contents of textmarker. | |
4129 @item ]<a-z> | |
4130 Show contents of register. | |
4131 @end table | |
4132 @kindex @kbd{]<a-z>} | |
4133 @kindex @kbd{[<a-z>} | |
4134 @kindex @kbd{#g<move>} | |
4135 @kindex @kbd{*} | |
4136 @kindex @kbd{@@!<a-z>} | |
4137 @kindex @kbd{@@#} | |
4138 @kindex @kbd{@@@@} | |
4139 @kindex @kbd{@@<a-z>} | |
4140 @findex @kbd{:unmap <char>} | |
4141 @findex @kbd{:map <char> <seq>} | |
4142 @findex @kbd{:unmap!@: <char>} | |
4143 @findex @kbd{:map!@: <char> <seq>} | |
4144 | |
4145 @node Shell Commands, Options, Mapping, Commands | |
4146 @section Shell Commands | |
4147 | |
4148 @cindex % (Current file) | |
4149 | |
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4150 The symbol @samp{%} is used in Ex shell commands to mean current file. If |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4151 you want a @samp{%} in your command, it must be escaped as @samp{\%}. |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4152 @cindex @samp{%} (Ex address) |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4153 However if @samp{%} is the first character, it stands as the address for |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4154 the whole file. |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4155 @cindex @samp{#} (Previous file) |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4156 Similarly, @samp{#} expands to the previous file. The previous file is the |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4157 first file in @kbd{:args} listing. This defaults to the previous file in |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4158 the VI sense if you have one window.@refill |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4159 |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4160 Symbols @samp{%} and @samp{#} are also used in the Ex commands @kbd{:e} and |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4161 @kbd{:r <shell-cmd>}. The commands @kbd{:w} and the regular @kbd{:r |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4162 <file>} command don't support these meta symbols, because file history is a |
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4163 better mechanism. |
25829 | 4164 |
4165 @cindex shell commands | |
4166 | |
4167 @table @kbd | |
4168 @item :sh | |
4169 Execute a subshell in another window | |
4170 @item :[x,y]!<cmd> | |
4171 Execute a shell <cmd> [on lines x through y; | |
4172 % is replace by current file, \% is changed to % | |
4173 @item :[x,y]!!@: [<args>] | |
4174 Repeat last shell command [and append <args>]. | |
4175 @item :!<cmd> | |
4176 Just execute command and display result in a buffer. | |
4177 @item :!!@: <args> | |
4178 Repeat last shell command and append <args> | |
4179 @item <count> !<move><cmd> | |
4180 The shell executes <cmd>, with standard | |
4181 input the lines described by <count><move>, | |
4182 next the standard output replaces those lines | |
4183 (think of @samp{cb}, @samp{sort}, @samp{nroff}, etc.). | |
4184 @item <count> !!<cmd> | |
4185 Give <count> lines as standard input to the | |
4186 shell <cmd>, next let the standard output | |
4187 replace those lines. | |
4188 @item :[x,y] w !<cmd> | |
4189 Let lines x to y be standard input for <cmd> | |
4190 (notice the <sp> between @kbd{w} and @kbd{!}). | |
4191 @item :<address>r !<cmd> | |
4192 Put the output of <cmd> after the line <address> (default current). | |
4193 @item :<address>r <name> | |
4194 Read the file <name> into the buffer after the line <address> (default | |
4195 current). | |
4196 @end table | |
4197 @findex @kbd{:<address>r <name>} | |
4198 @findex @kbd{:<address>r !<cmd>} | |
4199 @findex @kbd{!<cmd>} | |
4200 @findex @kbd{!!<cmd>} | |
4201 @findex @kbd{!<move><cmd>} | |
4202 @findex @kbd{:w !<cmd>} | |
4203 @findex @kbd{:x,y w !<cmd>} | |
4204 @findex @kbd{:!!@: <args>} | |
4205 @findex @kbd{:!<cmd>} | |
4206 @findex @kbd{:sh} | |
4207 | |
4208 @node Options,Emacs Related Commands,Shell Commands,Commands | |
4209 @section Options | |
4210 | |
4211 @cindex Vi options | |
4212 | |
4213 @table @kbd | |
4214 @item autoindent | |
4215 @itemx ai | |
4216 @cindex autoindent | |
4217 autoindent -- In append mode after a <cr> the | |
4218 cursor will move directly below the first | |
4219 character on the previous line. | |
4220 This setting affects the current buffer only. | |
4221 @item autoindent-global | |
4222 @itemx ai-global | |
4223 Same as `autoindent', but affects all buffers. | |
4224 @item noautoindent | |
4225 @itemx noai | |
4226 Cancel autoindent. | |
4227 @item noautoindent-global | |
4228 @itemx noai-g | |
4229 Cancel autoindent-global. | |
4230 @item ignorecase | |
4231 @itemx ic | |
4232 @cindex case and searching | |
4233 ignorecase -- No distinction between upper and lower cases when searching. | |
4234 @item noignorecase | |
4235 @itemx noic | |
4236 Cancel ignorecase. | |
4237 @item magic | |
4238 @itemx ma | |
4239 @cindex literal searching | |
4240 Regular expressions used in searches; nomagic means no regexps. | |
4241 @item nomagic | |
4242 @item noma | |
4243 Cancel magic. | |
4244 @item readonly | |
4245 @itemx ro | |
4246 @cindex readonly files | |
4247 readonly -- The file is not to be changed. | |
4248 If the user attempts to write to this file, confirmation will be requested. | |
4249 @item noreadonly | |
4250 @itemx noro | |
4251 Cancel readonly. | |
4252 @item shell=<string> | |
4253 @itemx sh=<string> | |
4254 @cindex shell | |
4255 shell -- The program to be used for shell escapes | |
4256 (default @samp{$SHELL} (default @file{/bin/sh})). | |
4257 @item shiftwidth=<count> | |
4258 @itemx sw=<count> | |
4259 @cindex layout | |
4260 @cindex shifting text | |
4261 shiftwidth -- Gives the shiftwidth (default 8 positions). | |
4262 @item showmatch | |
4263 @itemx sm | |
4264 @cindex paren matching | |
4265 @cindex matching parens | |
4266 showmatch -- Whenever you append a @kbd{)}, Vi shows | |
4267 its match if it's on the same page; also with | |
4268 @kbd{@{} and @kbd{@}}. If there's no match, Vi will beep. | |
4269 @item noshowmatch | |
4270 @itemx nosm | |
4271 Cancel showmatch. | |
4272 @item tabstop=<count> | |
4273 @itemx ts=<count> | |
4274 @cindex changing tab width | |
4275 @cindex tabbing | |
4276 tabstop -- The length of a <ht>; warning: this is | |
4277 only IN the editor, outside of it <ht>s have | |
4278 their normal length (default 8 positions). | |
4279 This setting affects the current buffer only. | |
4280 @item tabstop-global | |
4281 @itemx ts-g | |
4282 Same as `tabstop', but affects all buffers. | |
4283 @item wrapmargin=<count> | |
4284 @itemx wm=<count> | |
4285 @cindex auto fill | |
4286 @cindex word wrap | |
4287 wrapmargin -- In append mode Vi automatically | |
4288 puts a <lf> whenever there is a <sp> or <ht> | |
4289 within <wm> columns from the right margin. | |
4290 @item wrapscan | |
4291 @itemx ws | |
4292 @cindex searching | |
4293 wrapscan -- When searching, the end is | |
4294 considered @samp{stuck} to the begin of the file. | |
4295 @item nowrapscan | |
4296 @itemx nows | |
4297 Cancel wrapscan. | |
4298 @item :set <option> | |
4299 Turn <option> on. | |
4300 @item :set no<option> | |
4301 Turn <option> off. | |
4302 @item :set <option>=<value> | |
4303 Set <option> to <value>. | |
4304 @end table | |
4305 @findex @kbd{:set <option>=<value>} | |
4306 @findex @kbd{:set no<option>} | |
4307 @findex @kbd{:set <option>} | |
4308 @findex @kbd{:set ws} | |
4309 @findex @kbd{:set wrapscan} | |
4310 @findex @kbd{:set wm=<count>} | |
4311 @findex @kbd{:set wrapmargin=<count>} | |
4312 @findex @kbd{:set ts=<count>} | |
4313 @findex @kbd{:set tabstop=<count>} | |
4314 @findex @kbd{:set tab-stop-local=<count>} | |
4315 @findex @kbd{:set sm} | |
4316 @findex @kbd{:set showmatch} | |
4317 @findex @kbd{:set sw=<count>} | |
4318 @findex @kbd{:set shiftwidth=<count>} | |
4319 @findex @kbd{:set sh=<string>} | |
4320 @findex @kbd{:set shell=<string>} | |
4321 @findex @kbd{:set ro} | |
4322 @findex @kbd{:set readonly} | |
4323 @findex @kbd{:set magic} | |
4324 @findex @kbd{:set ic} | |
4325 @findex @kbd{:set ignorecase} | |
4326 @findex @kbd{:set ai} | |
4327 @findex @kbd{:set autoindent} | |
4328 | |
4329 @node Emacs Related Commands,,Options,Commands | |
4330 @section Emacs Related Commands | |
4331 | |
4332 @table @kbd | |
4333 @item C-\ | |
4334 Begin Meta command in Vi or Insert states. Most often used as C-\ x (M-x). | |
4335 | |
4336 Note: Emacs binds @kbd{C-\} to a function that offers to change the | |
4337 keyboard input method in the multilingual environment. Viper overrides this | |
4338 binding. However, it is still possible to switch the input method by typing | |
4339 @kbd{\ C-\} in the Vi command state and @kbd{C-z \ C-\} in the Insert state. | |
4340 Or you can use the MULE menu on the menubar. | |
4341 @item C-z | |
4342 In Insert and Replace states, prepare Viper to accept the next command and | |
4343 execute it as if Viper was in Vi state. Then return to Insert state. | |
4344 | |
4345 In Vi state, switch to Emacs state; in Emacs state, switch to Vi state. | |
4346 @item C-c \ | |
4347 Switches to Vi state for the duration of a single command. Then goes back | |
4348 to the original Viper state. Works from Vi, Insert, Replace, and Emacs states. | |
4349 @item C-x0 | |
4350 Close Window | |
4351 @item C-x1 | |
4352 Close Other Windows | |
4353 @item C-x2 | |
4354 Split Window | |
4355 @item C-xo | |
4356 Move among windows | |
4357 @item C-xC-f | |
4358 Emacs find-file, useful in Insert state | |
4359 @item C-y | |
4360 Put back the last killed text. Similar to Vi's @kbd{p}, but also works in | |
4361 Insert and Replace state. This command doesn't work in Vi command state, | |
4362 since this binding is taken for something else. | |
4363 @item M-y | |
4364 Undoes the last @kbd{C-y} and puts another kill from the kill ring. | |
4365 Using this command, you can try may different kills until you find the one | |
4366 you need. | |
4367 @end table | |
4368 @kindex @kbd{M-y} | |
4369 @kindex @kbd{C-y} | |
4370 @kindex @kbd{C-xC-f} | |
4371 @kindex @kbd{C-xo} | |
4372 @kindex @kbd{C-x2} | |
4373 @kindex @kbd{C-x1} | |
4374 @kindex @kbd{C-x0} | |
4375 @kindex @kbd{C-z} | |
4376 @kindex @kbd{C-\} | |
4377 @kindex @kbd{C-c\} | |
4378 | |
4379 @node Mouse-bound Commands,,,Commands | |
4380 @section Mouse-bound Commands | |
4381 | |
4382 The following two mouse actions are normally bound to to special search and | |
4383 insert commands in of Viper: | |
4384 | |
4385 @table @kbd | |
4386 @item S-mouse-1 | |
4387 Holding Shift and clicking mouse button 1 will | |
4388 initiate search for | |
4389 a region under the mouse pointer. | |
4390 This command can take a prefix argument. Note: Viper sets this | |
4391 binding only if this mouse action is not | |
4392 already bound to something else. | |
4393 @xref{Viper Specials}, for more information.@refill | |
4394 | |
4395 @item S-mouse-2 | |
4396 Holding Shift and clicking button 2 of the mouse will | |
4397 insert a region surrounding the mouse pointer. | |
4398 This command can also take a prefix argument. | |
4399 Note: Viper sets this binding only if this mouse action is not | |
4400 already bound to something else. | |
4401 @xref{Viper Specials}, for more details.@refill | |
4402 @end table | |
4403 @kindex @kbd{S-mouse-1} | |
4404 @kindex @kbd{S-mouse-2} | |
4405 @kindex @kbd{meta button1up} | |
4406 @kindex @kbd{meta button2up} | |
4407 | |
4408 @node Acknowledgments,,,Top | |
4409 @comment node-name, next, previous, up | |
4410 @unnumbered Acknowledgments | |
4411 | |
4412 Viper, formerly known as VIP-19, was written by Michael Kifer. Viper is | |
4413 based on the original VIP package by Masahiko Sato and on its enhancement, | |
4414 VIP 4.4, by Aamod Sane. This manual is an adaptation of the manual for VIP | |
4415 4.4, which, in turn, was based on Sato's manual for VIP 3.5. | |
4416 | |
4417 Many contributors on the net pointed out bugs and suggested a number of | |
4418 useful features. Here is a (hopefully) complete list of contributors: | |
4419 | |
4420 @example | |
4421 ahg@@panix.com (Al Gelders), | |
4422 amade@@diagram.fr (Paul-Bernard Amade), | |
4423 ascott@@fws214.intel.com (Andy Scott), | |
4424 cook@@biostat.wisc.edu (Tom Cook), | |
4425 csdayton@@midway.uchicago.edu (Soren Dayton), | |
4426 dave@@hellgate.utah.edu, | |
4427 dominik@@strw.LeidenUniv.nl (Carsten Dominik), | |
4428 dwallach@@cs.princeton.edu (Dan Wallach), | |
4429 dwight@@toolucky.llnl.gov (Dwight Shih), | |
4430 edmonds@@edmonds.home.cs.ubc.ca (Brian Edmonds), | |
4431 gviswana@@cs.wisc.edu (Guhan Viswanathan), | |
4432 gvr@@halcyon.com (George V.@: Reilly), | |
4433 hatazaki@@bach.convex.com (Takao Hatazaki), | |
4434 hpz@@ibmhpz.aug.ipp-garching.mpg.de (Hans-Peter Zehrfeld), | |
4435 jackr@@dblues.engr.sgi.com (Jack Repenning), | |
4436 jamesm@@bga.com (D.J.@: Miller II), | |
4437 jjm@@hplb.hpl.hp.com (Jean-Jacques Moreau), | |
4438 jl@@cse.ogi.edu (John Launchbury), | |
4439 jobrien@@hchp.org (John O'Brien), | |
4440 johnw@@borland.com (John Wiegley), | |
4441 kanze@@gabi-soft.fr (James Kanze), | |
4442 kin@@isi.com (Kin Cho), | |
4443 kwzh@@gnu.org (Karl Heuer), | |
4444 lindstro@@biostat.wisc.edu (Mary Lindstrom), | |
4445 Mark.Bordas@@East.Sun.COM (Mark Bordas), | |
4446 meyering@@comco.com (Jim Meyering), | |
4447 mrb@@Eng.Sun.COM (Martin Buchholz), | |
4448 mveiga@@dit.upm.es (Marcelino Veiga Tuimil), | |
4449 paulk@@summit.esg.apertus.com (Paul Keusemann), | |
4450 pfister@@cs.sunysb.edu (Hanspeter Pfister), | |
4451 phil_brooks@@MENTORG.COM (Phil Brooks), | |
4452 pogrell@@informatik.hu-berlin.de (Lutz Pogrell), | |
4453 pradyut@@cs.uchicago.edu (Pradyut Shah), | |
4454 roderick@@argon.org (Roderick Schertler), | |
4455 rxga@@ulysses.att.com, | |
4456 sawdey@@lcse.umn.edu (Aaron Sawdey), | |
4457 simonb@@prl.philips.co.uk (Simon Blanchard), | |
4458 stephen@@farrell.org (Stephen Farrell), | |
4459 sudish@@MindSpring.COM (Sudish Joseph), | |
4460 schwab@@issan.informatik.uni-dortmund.de (Andreas Schwab) | |
4461 terra@@diku.dk (Morten Welinder), | |
4462 thanh@@informatics.muni.cz (Han The Thanh), | |
4463 toma@@convex.convex.com, | |
4464 vrenjak@@sun1.racal.com (Milan Vrenjak), | |
4465 whicken@@dragon.parasoft.com (Wendell Hicken), | |
4466 zapman@@cc.gatech.edu (Jason Zapman II), | |
4467 @end example | |
4468 | |
4469 | |
4470 @node Key Index,Function Index,,Top | |
4471 @comment node-name, next, previous, up | |
4472 @unnumbered Key Index | |
4473 | |
4474 @printindex ky | |
4475 | |
4476 @node Function Index,Variable Index,Key Index,Top | |
4477 @comment node-name, next, previous, up | |
4478 @unnumbered Function Index | |
4479 | |
4480 @printindex fn | |
4481 | |
4482 @node Variable Index,Package Index,Function Index,Top | |
4483 @comment node-name, next, previous, up | |
4484 @unnumbered Variable Index | |
4485 | |
4486 @printindex vr | |
4487 | |
4488 @node Package Index,Concept Index,Variable Index,Top | |
4489 @comment node-name, next, previous, up | |
4490 @unnumbered Package Index | |
4491 | |
4492 @printindex pg | |
4493 | |
4494 @node Concept Index,,Package Index,Top | |
4495 @comment node-name, next, previous, up | |
4496 @unnumbered Concept Index | |
4497 | |
4498 @printindex cp | |
4499 | |
4500 @contents | |
4501 @bye |