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
11 * VIPER: (viper). The newest Emacs VI-emulation mode.
12 (also, A VI Plan for Emacs Rescue
21 @title Viper Is a Package for Emacs Rebels
22 @subtitle a Vi emulator for Emacs
23 @subtitle October 2000, Viper Version 3.09
25 @author Michael Kifer (Viper)
26 @author Aamod Sane (VIP 4.4)
27 @author Masahiko Sato (VIP 3.5)
33 @unnumbered Distribution
36 Copyright @copyright{} 1995, 1996, 1997, 2001 Free Software Foundation, Inc.
38 Permission is granted to copy, distribute and/or modify this document
39 under the terms of the GNU Free Documentation License, Version 1.1 or
40 any later version published by the Free Software Foundation; with no
41 Invariant Sections, with the Front-Cover texts being ``A GNU
42 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
43 license is included in the section entitled ``GNU Free Documentation
44 License'' in the Emacs manual.
46 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
47 this GNU Manual, like GNU software. Copies published by the Free
48 Software Foundation raise funds for GNU development.''
50 This document is part of a collection distributed under the GNU Free
51 Documentation License. If you want to distribute this document
52 separately from the collection, you can do so by adding a copy of the
53 license to the document, as described in section 6 of the license.
56 @node Top, Overview,, (DIR)
60 We believe that one or more of the following statements are adequate
64 Viper Is a Package for Emacs Rebels;
65 it is a VI Plan for Emacs Rescue
66 and/or a venomous VI PERil.
69 Technically speaking, Viper is a Vi emulation package for Emacs. It
70 implements all Vi and Ex commands, occasionally improving on them and
71 adding many new features. It gives the user the best of both worlds: Vi
72 keystrokes for editing combined with the power of the Emacs environment.
74 Viper emulates Vi at several levels, from the one that closely follows Vi
75 conventions to the one that departs from many of them. It has many
76 customizable options, which can be used to tailor Viper to the work habits
78 This manual describes Viper, concentrating on the differences from Vi and
79 new features of Viper.
81 Viper, formerly known as VIP-19, was written by Michael Kifer. It is based
82 on VIP version 3.5 by Masahiko Sato and VIP version 4.4 by Aamod Sane.
83 Viper tries to be compatible with these packages.
85 Viper is intended to be usable without reading this manual --- the defaults
86 are set to make Viper as close to Vi as possible. At startup, Viper will
87 try to set the most appropriate default environment for you, based on
88 your familiarity with Emacs. It will also tell you the basic GNU Emacs window
89 management commands to help you start immediately.
91 Although this manual explains how to customize Viper, some basic
92 familiarity with Emacs Lisp would be a plus.
94 It is recommended that you read the Overview node. The other nodes may
97 Comments and bug reports are welcome.
98 @code{kifer@@cs.sunysb.edu} is the current address for Viper bug reports.
99 Please use the Ex command @kbd{:submitReport} for this purpose.@refill
104 * Overview:: Must read to get started
105 * Improvements over Vi:: New features, Improvements
106 * Customization:: How to customize Viper
107 * Commands:: Vi and Ex Commands
109 * Key Index:: Index of Vi and Ex Commands
110 * Function Index:: Index of Viper Functions
111 * Variable Index:: Index of Viper Variables
112 * Package Index:: Index of Packages Mentioned in this Document
113 * Concept Index:: Vi, Ex and Emacs concepts
118 @unnumbered Introduction
120 We believe that one or more of the following statements are adequate
124 Viper Is a Package for Emacs Rebels;
125 it is a VI Plan for Emacs Rescue
126 and/or a venomous VI PERil.
129 Viper is a Vi emulation package for Emacs. Viper contains virtually all
130 of Vi and Ex functionality and much more. It gives you the best of both
131 worlds: Vi keystrokes for editing combined with the GNU Emacs
132 environment. Viper also fixes some common complaints with Vi commands.
133 This manual describes Viper, concentrating on the differences from Vi
134 and on the new features of Viper.
136 Viper was written by Michael Kifer. It is based on VIP version 3.5 by
137 Masahiko Sato and VIP version 4.4 by Aamod Sane. Viper tries to be
138 compatible with these packages.
140 Viper is intended to be usable out of the box, without reading this manual
141 --- the defaults are set to make Viper as close to Vi as possible. At
142 startup, Viper will attempt to set the most appropriate default environment
143 for you, based on your familiarity with Emacs. It will also tell you the
144 basic GNU Emacs window management commands to help you start immediately.
146 Although this manual explains how to customize Viper, some basic
147 familiarity with Emacs Lisp would be a plus.
149 It is recommended that you read the chapter Overview. The other chapters
150 will be useful for customization and advanced usage.
152 You should also learn to use the Info on-line hypertext manual system that
153 comes with Emacs. This manual can be read as an Info file. Try the command
154 @kbd{@key{ESC} x info} with vanilla Emacs sometime.
156 Comments and bug reports are welcome.
157 @code{kifer@@cs.sunysb.edu} is the current address for Viper bug reports.
158 Please use the Ex command @kbd{:submitReport} for this purpose.@refill
162 @node Overview,Improvements over Vi,Top,Top
163 @chapter Overview of Viper
165 Viper is a Vi emulation on top of Emacs. At the same time, Viper provides a
166 virtually unrestricted access to Emacs facilities. Perfect compatibility
167 with Vi is possible but not desirable. This chapter tells you about the
168 Emacs ideas that you should know about, how to use Viper within Emacs and
169 some incompatibilities.
171 Viper was formerly known as VIP-19, which was
172 a descendant of VIP 3.5 by Masahiko Sato and VIP 4.4 by Aamod Sane.
175 * Emacs Preliminaries:: Basic concepts in Emacs.
176 * Loading Viper:: Loading and Preliminary Configuration.
177 * States in Viper:: Viper has four states orthogonal to Emacs
179 * The Minibuffer:: Command line in Emacs.
180 * Multiple Files in Viper:: True multiple file handling.
181 * Unimplemented Features:: That are unlikely to be implemented.
184 @node Emacs Preliminaries, Loading Viper, Overview, Overview
185 @section Emacs Preliminaries
192 @cindex end (of buffer)
193 @cindex end (of line)
196 Emacs can edit several files at once. A file in Emacs is placed in a
197 @dfn{buffer} that usually has the same name as the file. Buffers are also used
198 for other purposes, such as shell interfaces, directory editing, etc.
199 @xref{Dired,,Directory Editor,emacs,The
200 Gnu Emacs Manual}, for an example.@refill
202 A buffer has a distinguished position called the @dfn{point}.
203 A @dfn{point} is always between 2 characters, and is @dfn{looking at}
204 the right hand character. The cursor is positioned on the right hand
205 character. Thus, when the @dfn{point} is looking at the end-of-line,
206 the cursor is on the end-of-line character, i.e.@: beyond the last
207 character on the line. This is the default Emacs behavior.@refill
209 The default settings of Viper try to mimic the behavior of Vi, preventing
210 the cursor from going beyond the last character on the line. By using
211 Emacs commands directly (such as those bound to arrow keys), it is possible
212 to get the cursor beyond the end-of-line. However, this won't (or
213 shouldn't) happen if you restrict yourself to standard Vi keys, unless you
214 modify the default editing style. @xref{Customization}.@refill
216 In addition to the @dfn{point}, there is another distinguished buffer
217 position called the @dfn{mark}. @xref{Mark,,Mark,emacs,The GNU Emacs
218 manual}, for more info on the mark. The text between the @dfn{point} and
219 the @dfn{mark} is called the @dfn{region} of the buffer. For the Viper
220 user, this simply means that in addition to the Vi textmarkers a--z, there
221 is another marker called @dfn{mark}. This is similar to the unnamed Vi
222 marker used by the jump commands @kbd{``} and @kbd{''}, which move the
223 cursor to the position of the last absolute jump. Viper provides access to
224 the region in most text manipulation commands as @kbd{r} and @kbd{R} suffix
225 to commands that operate on text regions, e.g., @kbd{dr} to delete region,
228 Furthermore, Viper lets Ex-style commands to work on the current region.
229 This is done by typing a digit argument before @kbd{:}. For instance,
230 typing @kbd{1:} will propmt you with something like @emph{:123,135},
231 assuming that the current region starts at line 123 and ends at line
232 135. There is no need to type the line numbers, since Viper inserts them
233 automatically in front of the Ex command.
235 @xref{Basics}, for more info.@refill
239 @cindex buffer information
242 @cindex buffer (modified)
244 Emacs divides the screen into tiled @dfn{windows}. You can see the
245 contents of a buffer through the window associated with the buffer. The
246 cursor of the screen is positioned on the character after @dfn{point}.
247 Every window has a @dfn{mode line} that displays information about the buffer.
248 You can change the format of the mode
249 line, but normally if you see @samp{**} at the beginning of a mode line it
250 means that the buffer is @dfn{modified}. If you write out the contents of
251 a buffer to a file, then the buffer will become not modified. Also if
252 you see @samp{%%} at the beginning of the mode line, it means that the file
253 associated with the buffer is write protected. The mode line will also
254 show the buffer name and current major and minor modes (see below).
255 A special buffer called @dfn{Minibuffer} is displayed as the last line
256 in a Minibuffer window. The Minibuffer window is used for command input
257 output. Viper uses Minibuffer window for @kbd{/} and @kbd{:}
263 @cindex global keymap
267 An Emacs buffer can have a @dfn{major mode} that customizes Emacs for
268 editing text of a particular sort by changing the functionality of the keys.
269 Keys are defined using a @dfn{keymap} that records the bindings between
271 functions. The @dfn{global keymap} is common to all the
272 buffers. Additionally, each buffer has its @dfn{local keymap} that determines the
273 @dfn{mode} of the buffer. If a function is bound to some key in the local
274 keymap then that function will be executed when you type the key.
275 If no function is bound to a key in the
276 local map, however, the function bound to the key in the global map
277 will be executed. @xref{Major Modes,Major Modes,Major Modes,emacs,The
278 GNU Emacs Manual}, for more information.@refill
280 A buffer can also have a @dfn{minor mode}. Minor modes are options that
281 you can use or not. A buffer in @code{text-mode} can have
282 @code{auto-fill-mode} as minor mode, which can be turned off or on at
283 any time. In Emacs, a minor mode may have it own keymap,
284 which overrides the local keymap when the minor mode is turned on. For
285 more information, @pxref{Minor Modes,Minor Modes,Minor Modes,emacs,The
286 GNU Emacs Manual} @refill
288 @cindex Viper as minor mode
292 Viper is implemented as a collection of minor modes. Different minor modes
293 are involved when Viper emulates Vi command mode, Vi insert mode, etc.
294 You can also turn Viper on and off at any time while in Vi command mode.
295 @xref{States in Viper}, for
296 more information.@refill
298 Emacs uses Control and Meta modifiers. These are denoted as C and M,
299 e.g.@: @kbd{^Z} as @kbd{C-z} and @kbd{Meta-x} as @kbd{M-x}. The Meta key is
300 usually located on each side of the Space bar; it is used in a manner
301 similar to the Control key, e.g., @kbd{M-x} means typing @kbd{x} while
302 holding the Meta key down. For keyboards that do not have a Meta key,
303 @key{ESC} is used as Meta. Thus @kbd{M-x} is typed as @kbd{@key{ESC}
304 x}. Viper uses @key{ESC} to switch from Insert state to Vi state. Therefore
305 Viper defines @kbd{C-\} as its Meta key in Vi state. @xref{Vi State}, for
308 Emacs is structured as a lisp interpreter around a C core. Emacs keys
309 cause lisp functions to be called. It is possible to call these
310 functions directly, by typing @kbd{M-x function-name}.
312 @node Loading Viper, States in Viper, Emacs Preliminaries, Overview
313 @section Loading Viper
315 The most common way to load it automatically is to include the following
316 lines (in the given order!):
324 in your @file{~/.emacs} file. The @file{.emacs} file is placed in your
325 home directory and it is be executed every time you invoke Emacs. This is
326 the place where all general Emacs customization takes place. Beginning with
327 version 20.0, Emacsen have an interactive interface, which simplifies the
328 job of customization significantly.
330 Viper also uses the file @file{~/.viper} for Viper-specific customization.
331 If you wish to be in Vi command state whenever this is deemed appropriate
332 by the author, you can include the following line in your @file{.viper}:
334 (setq viper-always t)
337 (@xref{Vi State}, for the explanation of Vi command state.)
339 The location of Viper customization file can be changed by setting the
340 variable @code{viper-custom-file-name} in @file{.emacs} @emph{prior} to loading
343 The latest versions of Emacs have an interactive customization facility,
344 which allows you to (mostly) bypass the use of the @file{.emacs} and
345 @file{.viper} files. You can reach this customization
346 facility from within Viper's VI state by executing the Ex command
349 Once invoked, Viper will arrange to bring up Emacs buffers in Vi state
350 whenever this makes sense.
351 @xref{Packages that Change Keymaps}, to find out when forcing Vi command state
352 on a buffer may be counter-productive.
354 Even if your @file{.emacs} and @file{.viper} files do not contain any of the
355 above lines, you can still load Viper and enter Vi command state by typing the
356 following from within Emacs:
362 When Emacs first comes up, if you have not specified a file on the
363 command line, it will show the @samp{*scratch*} buffer, in the
364 @samp{Lisp Interaction} mode. After you invoke Viper, you can start
365 editing files by using @kbd{:e}, @kbd{:vi}, or @kbd{v} commands.
366 (@xref{File and Buffer Handling}, for more information on @kbd{v} and other
367 new commands that, in many cases, are more convenient than @kbd{:e},
368 @kbd{:vi}, and similar old-style Vi commands.)@refill
370 Finally, if at some point you would want to get de-Viperize your running
371 copy of Emacs after Viper has been loaded, the command @kbd{M-x
372 viper-go-away} will do it for you. The function @code{toggle-viper-mode}
373 toggles Viperization of Emacs on and off.
375 @node States in Viper, The Minibuffer, Loading Viper,Overview
376 @section States in Viper
384 @cindex Replace state
386 @findex @code{viper-go-away}
387 @findex @code{toggle-viper-mode}
389 Viper has four states, Emacs, Vi, Insert, and Replace.
393 This is the state plain vanilla Emacs is normally in. After you have loaded
394 Viper, @kbd{C-z} will normally take you to Vi command state. Another
395 @kbd{C-z} will take you back to Emacs state. This toggle key can be
396 changed, @pxref{Customization} You can also type @kbd{M-x viper-mode} to
397 change to Vi state.@refill
400 For users who chose to set their user level to 1 at Viper setup time,
401 switching to Emacs state is deliberately made harder in order to not
402 confuse the novice user. In this case, @kbd{C-z} will either iconify Emacs
403 (if Emacs runs as an application under X) or it will stop Emacs (if
404 Emacs runs on a dumb terminal or in an Xterm window).
407 This is the Vi command mode. Any of the Vi commands, such as @kbd{i, o, a},
408 @dots{}, will take you to Insert state. All Vi commands may
409 be used in this mode. Most Ex commands can also be used.
410 For a full list of Ex commands supported by Viper, type
411 @kbd{:} and then @key{TAB}. To get help on any issue, including the Ex
412 commands, type @kbd{:help}. This will invoke Viper Info
413 (if it is installed). Then typing @kbd{i} will prompt you for a topic to
414 search in the index. Note: to search for Ex commands in the index, you
415 should start them with a @kbd{:}, e.g., @kbd{:WW}.
417 In Viper, Ex commands can be made to work on the current Emacs region.
418 This is done by typing a digit argument before @kbd{:}.
419 For instance, typing @kbd{1:} will propmt you with something like
420 @emph{:123,135}, assuming that the current region starts at line 123 and
421 ends at line 135. There is no need to type the line numbers, since Viper
422 inserts them automatically in front of the Ex command.
425 Insert state is the Vi insertion mode. @key{ESC} will take you back to
426 Vi state. Insert state editing can be done, including auto-indentation. By
427 default, Viper disables Emacs keybindings in Insert state.
430 Commands like @kbd{cw} invoke the Replace state. When you cross the
431 boundary of a replacement region (usually designated via a @samp{$} sign),
432 it will automatically change to Insert state. You do not have to worry
433 about it. The key bindings remain practically the same as in Insert
434 state. If you type @key{ESC}, Viper will switch to Vi command mode, terminating the
435 replacement state.@refill
440 The modes are indicated on the @dfn{mode line} as <E>, <I>, <V>, and <R>,
441 so that the multiple modes do not confuse you. Most of your editing can be
442 done in Vi and Insert states. Viper will try to make all new buffers be in Vi
443 state, but sometimes they may come up in Emacs state. @kbd{C-z}
444 will take you to Vi state in such a case. In some major modes, like Dired,
445 Info, Gnus, etc., you should not switch to Vi state (and Viper will not
446 attempt to do so) because these modes are not intended for text editing and
447 many of the Vi keys have special meaning there. If you plan to read news,
448 browse directories, read mail, etc., from Emacs (which you should start
449 doing soon!), you should learn about the meaning of the various keys in
450 those special modes (typing @kbd{C-h m} in a buffer provides
451 help with key bindings for the major mode of that buffer).
453 If you switch to Vi in Dired or similar modes---no harm is done. It is just
454 that the special keybindings provided by those modes will be temporarily
455 overshadowed by Viper's bindings. Switching back to Viper's Emacs state
456 will revive the environment provided by the current major mode.
458 States in Viper are orthogonal to Emacs major modes, such as C mode or Dired
459 mode. You can turn Viper on and off for any Emacs state. When Viper is turned
460 on, Vi state can be used to move around. In Insert state, the bindings for
461 these modes can be accessed. For beginners (users at Viper levels 1 and 2),
462 these bindings are suppressed in Insert state, so that new users are not
463 confused by the Emacs states. Note that unless you allow Emacs bindings in
464 Insert state, you cannot do many interesting things, like language
465 sensitive editing. For the novice user (at Viper level 1), all major mode
466 bindings are turned off in Vi state as well. This includes the bindings for
467 key sequences that start with @kbd{C-c}, which practically means that all
468 major mode bindings are supported. @xref{Customization}, to find out how
469 to allow Emacs keys in Insert state.
472 * Emacs State:: This is the state you should learn more about when
473 you get up to speed with Viper.
474 * Vi State:: Vi commands are executed in this state.
475 * Insert State:: You can enter text, and also can do sophisticated
476 editing if you know enough Emacs commands.
477 * Replace State:: Like Insert mode, but it is invoked via the
478 replacement commands, such as cw, C, R, etc.
481 @node Emacs State, Vi State, States in Viper, States in Viper
482 @subsection Emacs State
488 You will be in this mode only by accident (hopefully). This is the state
489 Emacs is normally in (imagine!!). Now leave it as soon as possible by
490 typing @kbd{C-z}. Then you will be in Vi state (sigh of relief) :-).
492 Emacs state is actually a Viperism to denote all the major and minor modes
493 (@pxref{Emacs Preliminaries}) other than Viper that Emacs can be in. Emacs
494 can have several modes, such as C mode for editing C programs, LaTeX mode
495 for editing LaTeX documents, Dired for directory editing, etc. These are
496 major modes, each with a different set of key-bindings. Viper states are
497 orthogonal to these Emacs major modes. The presence of these language
498 sensitive and other modes is a major win over Vi. @xref{Improvements over
499 Vi}, for more.@refill
501 The bindings for these modes can be made available in the Viper Insert state
502 as well as in Emacs state. Unless you specify your user level as 1 (a
503 novice), all major mode key sequences that start with @kbd{C-x} and
504 @kbd{C-c} are also available in Vi state. This is important because major
505 modes designed for editing files, such as cc-mode or latex-mode, use key
506 sequences that begin with @kbd{C-x} and @kbd{C-c}.
508 There is also a key that lets you temporarily escape to Vi command state
509 from Emacs or Insert states: typing @kbd{C-c \} will let you execute a
510 single Vi command while staying in Viper's Emacs or Insert state.
511 In Insert state, the same can also be achieved by typing @kbd{C-z}.
514 @node Vi State, Insert State, Emacs State, States in Viper
519 This is the Vi command mode. When Viper is in Vi state, you will see the sign
520 <V> in the mode line. Most keys will work as in Vi. The notable
526 @kbd{C-x} is used to invoke Emacs commands, mainly those that do window
527 management. @kbd{C-x 2} will split a window, @kbd{C-x 0} will close a
528 window. @kbd{C-x 1} will close all other windows. @kbd{C-xb} is used to
529 switch buffers in a window, and @kbd{C-xo} to move through windows.
530 These are about the only necessary keystrokes.
531 For the rest, see the GNU Emacs Manual.
535 For user levels 2 and higher, this key serves as a prefix key for the key
536 sequences used by various major modes. For users at Viper level 1, @kbd{C-c}
543 These are the Emacs @samp{quit} keys.
544 There will be cases where you will have to
545 use @kbd{C-g} to quit. Similarly, @kbd{C-]} is used to exit
546 @samp{Recursive Edits} in Emacs for which there is no comparable Vi
547 functionality and no key-binding. Recursive edits are indicated by
548 @samp{[]} brackets framing the modes on the mode line.
549 @xref{Recursive Edit,Recursive
550 Edit,Recursive Edit,emacs,The GNU Emacs Manual}.
551 At user level 1, @kbd{C-g} is bound to @code{viper-info-on-file}
558 Viper uses @key{ESC} as a switch between Insert and Vi states. Emacs uses
559 @key{ESC} for Meta. The Meta key is very important in Emacs since many
560 functions are accessible only via that key as @kbd{M-x function-name}.
561 Therefore, we need to simulate it somehow. In Viper's Vi, Insert, and
562 Replace states, the meta key is set to be @kbd{C-\}. Thus, to get
563 @kbd{M-x}, you should type @kbd{C-\ x} (if the keyboard has no Meta key).
564 This works both in the Vi command state and in the Insert and Replace
565 states. In Vi command state, you can also use @kbd{\ @key{ESC}} as the
568 Note: Emacs binds @kbd{C-\} to a function that offers to change the
569 keyboard input method in the multilingual environment. Viper overrides this
570 binding. However, it is still possible to switch the input method by typing
571 @kbd{\ C-\} in the Vi command state and @kbd{C-z \ C-\} in the Insert state.
572 Or you can use the MULE menu in the menubar.
575 Other differences are mostly improvements. The ones you should know
581 @kbd{u} will undo. Undo can be repeated by the @kbd{.} key. Undo itself
582 can be undone. Another @kbd{u} will change the direction. The presence
583 of repeatable undo means that @kbd{U}, undoing lines, is not very
584 important. Therefore, @kbd{U} also calls @code{viper-undo}.
585 @cindex multiple undo
590 Most commands, @kbd{~}, @kbd{[[}, @kbd{p}, @kbd{/}, @dots{}, etc., take counts.
592 @comment ]] Just to balance parens
594 Viper uses Emacs Regular Expressions for searches. These are a superset of
596 expressions, excepting the change-of-case escapes @samp{\u}, @samp{\L},
597 @dots{}, etc. @xref{Regular Expressions,,Regular Expressions,emacs,The
598 GNU Emacs Manual}, for details.
599 Files specified to @kbd{:e} use @code{csh} regular expressions
600 (globbing, wildcards, what have you).
601 However, the function @code{viper-toggle-search-style}, bound to @kbd{C-c /},
602 lets the user switch from search with regular expressions to plain vanilla
603 search and vice versa. It also lets one switch from case-sensitive search
604 to case-insensitive and back.
605 @xref{Viper Specials}, for more details.
606 @cindex regular expressions
607 @cindex vanilla search
608 @cindex case-sensitive search
609 @cindex case-insensitive search
614 The current working directory of a buffer is automatically inserted in the
615 minibuffer if you type @kbd{:e} then space. Absolute filenames are
616 required less often in Viper. For path names, Emacs uses a convention that
617 is slightly different from that of Unix. It is designed to minimize the
618 need for deleting path names that Emacs provides in its prompts. (This is
619 usually convenient, but occasionally the prompt may suggest a wrong path
620 name for you.) If you see a prompt @kbd{/usr/foo/} and you wish to edit the
621 file @kbd{~/.viper}, you don't have to erase the prompt. Instead, simply
622 continue typing what you need. Emacs will interpret @kbd{/usr/foo/~/.viper}
623 correctly. Similarly, if the prompt is @kbd{~/foo/} and you need to get to
624 @kbd{/bar/file}, keep typing. Emacs interprets @kbd{~/foo//bar/} as
625 @kbd{/bar/file}, since when it sees @samp{//}, it understands that
626 @kbd{~/foo/} is to be discarded.
628 The command @kbd{:cd} will change the default directory for the
629 current buffer. The command @kbd{:e} will interpret the
630 filename argument in @code{csh}. @xref{Customization}, if you
631 want to change the default shell.
632 The command @kbd{:next} takes counts from
633 @kbd{:args}, so that @kbd{:rew} is obsolete. Also, @kbd{:args} will show only
634 the invisible files (i.e., those that are not currently seen in Emacs
637 When applicable, Ex commands support file completion and history. This
638 means that by typing a partial file name and then @key{TAB}, Emacs will try
639 to complete the name or it will offer a menu of possible completions.
640 This works similarly to Tcsh and extends the behavior of Csh. While Emacs
641 is waiting for a file name, you can type @kbd{M-p} to get the previous file
642 name you typed. Repeatedly typing @kbd{M-p} and @kbd{M-n} will let you
643 browse through the file history.
645 Like file names, partially typed Ex commands can be completed by typing
646 @key{TAB}, and Viper keeps the history of Ex commands. After typing
647 @kbd{:}, you can browse through the previously entered Ex commands by
648 typing @kbd{M-p} and @kbd{M-n}. Viper tries to rationalize when it puts Ex
649 commands on the history list. For instance, if you typed @kbd{:w!@: foo},
650 only @kbd{:w!} will be placed on the history list. This is because the
651 last history element is the default that can be invoked simply by typing
652 @kbd{: @key{RET}}. If @kbd{:w!@: foo} were placed on the list, it would be all to
653 easy to override valuable data in another file. Reconstructing the full
654 command, @kbd{:w!@: foo}, from the history is still not that hard, since Viper
655 has a separate history for file names. By typing @kbd{: M-p}, you will get
656 @kbd{:w!} in the Minibuffer. Then, repeated @kbd{M-p} will get you through
657 the file history, inserting one file name after another.
659 In contrast to @kbd{:w!@: foo}, if the command were @kbd{:r foo}, the entire
660 command will appear in the history list. This is because having @kbd{:r}
661 alone as a default is meaningless, since this command requires a file
666 As Vi, Viper's destructive commands can be re-executed by typing `@kbd{.}'.
667 However, in addition, Viper keeps track of the history of such commands. This
668 history can be perused by typing @kbd{C-c M-p} and @kbd{C-c M-n}.
669 Having found the appropriate command, it can be then executed by typing
671 @xref{Improvements over Vi}, for more information.
673 @node Insert State, Replace State, Vi State, States in Viper
674 @subsection Insert State
678 To avoid confusing the beginner (at Viper level 1 and 2), Viper makes only the
679 standard Vi keys available in Insert state. The implication is that
680 Emacs major modes cannot be used in Insert state.
681 It is strongly recommended that as soon as you are comfortable, make the
682 Emacs state bindings visible (by changing your user level to 3 or higher).
683 @xref{Customization},
684 to see how to do this.@refill
686 Once this is done, it is possible to do quite a bit of editing in
687 Insert state. For instance, Emacs has a @dfn{yank} command, @kbd{C-y},
688 which is similar to Vi's @kbd{p}. However, unlike @kbd{p}, @kbd{C-y} can be
689 used in Insert state of Viper. Emacs also has a kill ring where it keeps
690 pieces of text you deleted while editing buffers. The command @kbd{M-y} is
691 used to delete the text previously put back by Emacs' @kbd{C-y} or by Vi's
692 @kbd{p} command and reinsert text that was placed on the kill-ring earlier.
694 This works both in Vi and Insert states.
695 In Vi state, @kbd{M-y} is a much better alternative to the usual Vi's way
696 of recovering the 10 previously deleted chunks of text. In Insert state,
698 use this as follows. Suppose you deleted a piece of text and now you need
699 to re-insert it while editing in Insert mode. The key @kbd{C-y} will put
700 back the most recently deleted chunk. If this is not what you want, type
701 @kbd{M-y} repeatedly and, hopefully, you will find the chunk you want.
703 Finally, in Insert and Replace states, Viper provides the history of
704 pieces of text inserted in previous insert or replace commands. These
705 strings of text can be recovered by repeatedly typing @kbd{C-c M-p} or
706 @kbd{C-c M-n} while in Insert or Replace state. (This feature is disabled
707 in the minibuffer: the above keys are usually bound to other histories,
708 which are more appropriate in the minibuffer.)
713 You can call Meta functions from Insert state. As in Vi state, the Meta key
714 is @kbd{C-\}. Thus @kbd{M-x} is typed as @kbd{C-\ x}.
716 Other Emacs commands that are useful in Insert state are @kbd{C-e}
717 and @kbd{C-a}, which move the cursor to the end and the beginning of the
718 current line, respectively. You can also use @kbd{M-f} and @kbd{M-b},
719 which move the cursor forward (or backward) one word.
720 If your display has a Meta key, these functions are invoked by holding the
721 Meta key and then typing @kbd{f} and @kbd{b}, respectively. On displays
722 without the Meta key, these functions are invoked by typing
723 @kbd{C-\ f} and @kbd{C-\ b} (@kbd{C-\} simulates the Meta key in Insert
724 state, as explained above).
726 The key @kbd{C-z} is sometimes also useful in Insert state: it allows you
727 to execute a single command in Vi state without leaving the Insert state!
728 For instance, @kbd{C-z d2w} will delete the next two words without leaving
731 When Viper is in Insert state, you will see <I> in the mode line.
733 @node Replace State,, Insert State, States in Viper
734 @subsection Replace State
736 @cindex Replace state
738 This state is entered through Vi replacement commands, such as @kbd{C},
739 @kbd{cw}, etc., or by typing @kbd{R}. In Replace state, Viper puts <R> in
740 the mode line to let you know which state is in effect. If Replace state is
741 entered through @kbd{R}, Viper stays in that state until the user hits
742 @key{ESC}. If this state is entered via the other replacement commands,
743 then Replace state is in effect until you hit @key{ESC} or until you cross
744 the rightmost boundary of the replacement region. In the latter case, Viper
745 changes its state from Replace to Insert (which you will notice by the
746 change in the mode line).
748 Since Viper runs under Emacs, it is possible to switch between buffers
749 while in Replace state. You can also move the cursor using the arrow keys
750 (even on dumb terminals!)@: and the mouse. Because of this freedom (which is
751 unattainable in regular Vi), it is possible to take the cursor outside the
752 replacement region. (This may be necessary for several reasons, including
753 the need to enable text selection and region-setting with the mouse.)
755 The issue then arises as to what to do when the user
756 hits the @key{ESC} key. In Vi, this would cause the text between cursor and
757 the end of the replacement region to be deleted. But what if, as is
758 possible in Viper, the cursor is not inside the replacement region?
760 To solve the problem, Viper keeps track of the last cursor position while it
761 was still inside the replacement region. So, in the above situation, Viper
762 would delete text between this position and the end of the replacement
765 @node The Minibuffer,Multiple Files in Viper, States in Viper, Overview
766 @section The Minibuffer
770 The Minibuffer is where commands are entered in. Editing can be done
771 by commands from Insert state, namely:
781 Quote the following character
785 Emacs quit and abort keys. These may be necessary. @xref{Vi State}, for an
788 These keys are bound to functions that peruse minibuffer history. The
789 precise history to be perused depends on the context. It may be the history
790 of search strings, Ex commands, file names, etc.
793 Most of the Emacs keys are functional in the Minibuffer. While in the
794 Minibuffer, Viper tries to make editing resemble Vi's behavior when the
795 latter is waiting for the user to type an Ex command. In particular, you
796 can use the regular Vi commands to edit the Minibuffer. You can switch
797 between the Vi state and Insert state at will, and even use the replace mode.
798 Initially, the Minibuffer comes up in Insert state.
800 Some users prefer plain Emacs bindings in the Minibuffer. To this end, set
801 @code{viper-vi-style-in-minibuffer} to @code{nil} in @file{.viper}.
802 @xref{Customization}, to learn how to do this.
804 When the Minibuffer changes Viper states, you will notice that the appearance
805 of the text there changes as well. This is useful because the Minibuffer
806 has no mode line to tell which Vi state it is in.
807 The appearance of the text in the Minibuffer can be changed.
808 @xref{Viper Specials}, for more details.
810 @node Multiple Files in Viper,Unimplemented Features,The Minibuffer,Overview
811 @section Multiple Files in Viper
813 @cindex multiple files
814 @cindex managing multiple files
816 Viper can edit multiple files. This means, for example that you never need
817 to suffer through @code{No write since last change} errors.
818 Some Viper elements are common over all the files.
824 Textmarkers remember @emph{files and positions}.
825 If you set marker @samp{a} in
826 file @file{foo}, start editing file @file{bar} and type @kbd{'a}, then
827 @emph{YOU WILL SWITCH TO FILE @file{foo}}. You can see the contents of a
828 textmarker using the Viper command @kbd{[<a-z>} where <a-z> are the
829 textmarkers, e.g., @kbd{[a} to view marker @samp{a} .@refill
830 @item Repeated Commands
831 Command repetitions are common over files. Typing @kbd{!!} will repeat the
832 last @kbd{!} command whichever file it was issued from.
833 Typing @kbd{.} will repeat the last command from any file, and
834 searches will repeat the last search. Ex commands can be repeated by typing
835 @kbd{: @key{RET}}.@refill
836 Note: in some rare cases, that @kbd{: @key{RET}} may do something dangerous.
837 However, usually its effect can be undone by typing @kbd{u}.
840 Registers are common to files. Also, text yanked with @kbd{y} can be
841 put back (@kbd{p}) into any file. The Viper command @kbd{]<a-z>}, where <a-z> are
842 the registers, can be used to look at the contents of a register, e.g.,
843 type @kbd{]a} to view register @samp{a}.
845 There is one difference in text deletion that you should be
846 aware of. This difference comes from Emacs and was adopted in Viper
847 because we find it very useful. In Vi, if you delete a line, say, and then
848 another line, these two deletions are separated and are put back
849 separately if you use the @samp{p} command. In Emacs (and Viper), successive
850 series of deletions that are @emph{not interrupted} by other commands are
851 lumped together, so the deleted text gets accumulated and can be put back
852 as one chunk. If you want to break a sequence of deletions so that the
853 newly deleted text could be put back separately from the previously deleted
854 text, you should perform a non-deleting action, e.g., move the cursor one
855 character in any direction.
856 @item Absolute Filenames
857 @cindex absolute paths
858 The current directory name for a file is automatically prepended to the
860 @kbd{:e}, @kbd{:r}, @kbd{:w}, etc., command (in Emacs, each buffer has a
862 This directory is inserted in the Minibuffer once you type space after
863 @kbd{:e, r}, etc. Viper also supports completion of file names and Ex
864 commands (@key{TAB}), and it keeps track of
865 command and file history (@kbd{M-p}, @kbd{M-n}).
866 Absolute filenames are required less
869 You should be aware that Emacs interprets @kbd{/foo/bar//bla} as
870 @kbd{/bla} and @kbd{/foo/~/bar} as @kbd{~/bar}. This is designed to
871 minimize the need for erasing path names that Emacs suggests in its
872 prompts, if a suggested path name is not what you wanted.
874 The command @kbd{:cd} will change the default directory for the
875 current Emacs buffer. The Ex command @kbd{:e} will interpret the
876 filename argument in @samp{csh}, by default. @xref{Customization}, if you
881 Currently undisplayed files can be listed using the @kbd{:ar} command. The
882 command @kbd{:n} can be given counts from the @kbd{:ar} list to switch to
885 @node Unimplemented Features,,Multiple Files in Viper,Overview
886 @section Unimplemented Features
888 Unimplemented features include:
892 @kbd{:ab} and @kbd{:una} are not implemented.
893 Both @kbd{:map} and @kbd{:ab} are considered obsolete, since Emacs has much
894 more powerful facilities for defining keyboard macros and abbreviations.
896 @kbd{:set option?} is not implemented. The current
897 @kbd{:set} can also be used to set Emacs variables.
899 @kbd{:se list} requires modification of the display code for Emacs, so
900 it is not implemented.
901 A useful alternative is @code{cat -t -e file}. Unfortunately, it cannot
902 be used directly inside Emacs, since Emacs will obdurately change @samp{^I}
903 back to normal tabs.@refill
906 @comment node-name, next, previous, up
907 @node Improvements over Vi, Customization, Overview, Top
908 @chapter Improvements over Vi
910 Some common problems with Vi and Ex have been solved in Viper. This
911 includes better implementation of existing commands, new commands, and
912 the facilities provided by Emacs.
915 * Basics:: Basic Viper differences, Multi-file effects.
916 * Undo and Backups:: Multiple undo, auto-save, backups and changes
917 * History:: History for Ex and Vi commands.
918 * Macros and Registers:: Keyboard Macros (extended ".")@: @@reg execution.
919 * Completion:: Filename and Command Completion for Ex.
920 * Improved Search:: Incremental Search and Buffer Content Search.
921 * Abbreviation Facilities:: Normal Abbrevs, Templates, and Dynamic Abbrevs.
922 * Movement and Markers:: Screen Editor movements, viewing textmarkers.
923 * New Commands:: Commands that do not exist in Vi.
924 * Useful Packages:: A Sampling of some Emacs packages, and things
925 you should know about.
928 @node Basics, Undo and Backups, Improvements over Vi, Improvements over Vi
931 The Vi command set is based on the idea of combining motion commands
932 with other commands. The motion command is used as a text region
933 specifier for other commands.
934 We classify motion commands into @dfn{point commands} and
935 @dfn{line commands}.@refill
937 @cindex point commands
939 The point commands are:
942 @kbd{h}, @kbd{l}, @kbd{0}, @kbd{$}, @kbd{w}, @kbd{W}, @kbd{b}, @kbd{B},
943 @kbd{e}, @kbd{E}, @kbd{(}, @kbd{)}, @kbd{/}, @kbd{?}, @kbd{`}, @kbd{f},
944 @kbd{F}, @kbd{t}, @kbd{T}, @kbd{%}, @kbd{;}, @kbd{,}, @kbd{^}
947 @cindex line commands
949 The line commands are:
952 @kbd{j}, @kbd{k}, @kbd{+}, @kbd{-}, @kbd{H}, @kbd{M}, @kbd{L}, @kbd{@{},
953 @kbd{@}}, @kbd{G}, @kbd{'}, @kbd{[[}, @kbd{]]}, @kbd{[]}
957 @cindex region specification
958 @cindex expanding (region)
959 @cindex describing regions
960 @cindex movement commands
963 If a point command is given as an argument to a modifying command, the
964 region determined by the point command will be affected by the modifying
965 command. On the other hand, if a line command is given as an argument to a
966 modifying command, the region determined by the line command will be
967 enlarged so that it will become the smallest region properly containing the
968 region and consisting of whole lines (we call this process @dfn{expanding
969 the region}), and then the enlarged region will be affected by the modifying
971 Text Deletion Commands (@pxref{Deleting Text}), Change commands
972 (@pxref{Changing Text}), even Shell Commands (@pxref{Shell Commands})
973 use these commands to describe a region of text to operate on.
974 Thus, type @kbd{dw} to delete a word, @kbd{>@}} to shift a paragraph, or
975 @kbd{!'afmt} to format a region from @samp{point} to textmarker
978 @cindex r and R region specifiers
980 Viper adds the region specifiers @samp{r} and @samp{R}. Emacs has a
981 special marker called @dfn{mark}. The text-area between the current cursor
982 position @dfn{point} and the @dfn{mark} is called the @dfn{region}.
983 @samp{r} specifies the raw region and @samp{R} is the expanded region
984 (i.e., the minimal contiguous chunk of full lines that contains the raw
986 @kbd{dr} will now delete the region, @kbd{>r} will shift it, etc.
987 @kbd{r,R} are not motion commands, however. The special mark is set by
988 @kbd{m.} and other commands. @xref{Marking}, for more info.
990 Viper also adds counts to most commands for which it would make sense.
992 In the Overview chapter, some Multiple File issues were discussed
993 (@pxref{Multiple Files in Viper}). In addition to the files, Emacs has
994 buffers. These can be seen in the @kbd{:args} list and switched using
995 @kbd{:next} if you type @kbd{:set ex-cycle-through-non-files t}, or
996 specify @code{(setq ex-cycle-through-non-files t)} in your @file{.viper}
997 file. @xref{Customization}, for details.
999 @node Undo and Backups, History, Basics, Improvements over Vi
1000 @section Undo and Backups
1004 Viper provides multiple undo. The number of undo's and the size is limited
1005 by the machine. The Viper command @kbd{u} does an undo. Undo can be
1006 repeated by typing @kbd{.} (a period). Another @kbd{u} will undo the undo,
1008 @kbd{.} will repeat it. Typing @kbd{u} does the first undo, and changes the
1011 @cindex backup files
1014 Since the undo size is limited, Viper can create backup files and
1015 auto-save files. It will normally do this automatically. It is possible
1016 to have numbered backups, etc. For details, @pxref{Backup,,Backup and
1017 Auto-Save,emacs,The GNU Emacs Manual} @refill
1019 @comment [ balance parens
1020 @cindex viewing registers and markers
1025 The results of the 9 previous changes are available in the 9 numeric
1026 registers, as in Vi. The extra goody is the ability to @emph{view} these
1027 registers, in addition to being able to access them through @kbd{p} and
1028 @kbd{M-y} (@xref{Insert State}, for details.)
1029 The Viper command @kbd{] register} will display the contents of any
1030 register, numeric or alphabetical. The related command @kbd{[ textmarker}
1031 will show the text around the textmarker. @samp{register} and @samp{textmarker}
1032 can be any letters from a through z.
1033 @comment ] balance parens
1035 @node History, Macros and Registers, Undo and Backups,Improvements over Vi
1041 History is provided for Ex commands, Vi searches, file names, pieces of
1042 text inserted in earlier commands that use Insert or Replace state, and for
1043 destructive commands in Vi state. These are
1044 useful for fixing those small typos that screw up searches and @kbd{:s},
1045 and for eliminating routine associated with repeated typing of file names
1046 or pieces of text that need to be inserted frequently.
1047 At the @kbd{:} or @kbd{/} prompts in the Minibuffer, you can do the following:
1051 To move to previous and next history items. This causes the history
1052 items to appear on the command line, where you can edit them, or
1053 simply type Return to execute.
1055 To search backward and forward through the history.
1057 Type @key{RET} to accept a default (which is displayed in the prompt).
1060 The history of insertions can be perused by
1061 typing @kbd{C-c M-p} and @kbd{C-c M-n} while in Insert or Replace state.
1062 The history of destructive Vi commands can be perused via the same keys
1063 when Viper is in Vi state. @xref{Viper Specials}, for details.
1065 All Ex commands have a file history. For instance, typing @kbd{:e}, space
1066 and then @kbd{M-p} will bring up the name of the previously typed file
1067 name. Repeatedly typing @kbd{M-p}, @kbd{M-n}, etc., will let you browse
1068 through the file history.
1070 Similarly, commands that have to do with switching buffers
1071 have a buffer history, and commands that expect strings or regular
1072 expressions keep a history on those items.
1074 @node Macros and Registers,Completion,History,Improvements over Vi
1075 @section Macros and Registers
1077 @cindex keyboard macros
1080 @cindex register execution
1082 Viper facilitates the use of Emacs-style keyboard macros. @kbd{@@#} will
1083 start a macro definition. As you type, the commands will be executed, and
1084 remembered (This is called ``learn mode'' in some editors.)
1085 @kbd{@@register} will complete the macro, putting it into @samp{register},
1086 where @samp{register} is any character from @samp{a} through @samp{z}. Then
1087 you can execute this macro using @kbd{@@register}. It is, of course,
1088 possible to yank some text into a register and execute it using
1089 @kbd{@@register}. Typing @kbd{@@@@}, @kbd{@@RET}, or @kbd{@@C-j} will
1090 execute the last macro that was executed using @kbd{@@register}.@refill
1092 Viper will automatically lowercase the register, so that pressing the
1093 @kbd{SHIFT} key for @kbd{@@} will not create problems. This is for
1094 @kbd{@@} macros and @kbd{"p} @emph{only}. In the case of @kbd{y},
1095 @kbd{"Ayy} will append to @emph{register a}. For @kbd{[,],',`}, it
1096 is an error to use a Uppercase register name.
1098 @comment [ balance parens
1099 @cindex viewing registers and markers
1101 The contents of a register can be seen by @kbd{]register}. (@kbd{[textmarker}
1102 will show the contents of a textmarker).
1103 @comment ] balance parens
1105 @cindex last keyboard macro
1107 The last keyboard macro can also be executed using
1108 @kbd{*}, and it can be yanked into a register using @kbd{@@!register}.
1109 This is useful for Emacs style keyboard macros defined using @kbd{C-x(}
1110 and @kbd{C-x)}. Emacs keyboard macros have more capabilities.
1111 @xref{Keyboard Macros,,Keyboard Macros,emacs, The GNU Emacs Manual}, for
1114 Keyboard Macros allow an interesting form of Query-Replace:
1115 @kbd{/pattern} or @kbd{n} to go to the next pattern (the query), followed by a
1116 Keyboard Macro execution @kbd{@@@@} (the replace).
1118 Viper also provides Vi-style macros. @xref{Vi Macros}, for details.
1121 @node Completion, Improved Search, Macros and Registers, Improvements over Vi
1126 Completion is done when you type @key{TAB}. The Emacs completer does not
1127 grok wildcards in filenames. Once you type a wildcard, the completer will
1128 no longer work for that path. Remember that Emacs interprets a file name
1129 of the form @kbd{/foo//bar} as @kbd{/bar} and @kbd{/foo/~/bar} as
1132 @node Improved Search, Abbreviation Facilities, Completion, Improvements over Vi
1133 @section Improved Search
1135 @cindex buffer search
1138 Viper provides buffer search, the ability to search the buffer for a region
1139 under the cursor. You have to turn this on in @file{.viper} either by calling
1142 (viper-buffer-search-enable)
1146 or by setting @code{viper-buffer-search-char} to, say, @kbd{f3}:
1148 (setq viper-buffer-search-char ?g)
1152 If the user calls @code{viper-buffer-search-enable} explicitly (the first
1153 method), then @code{viper-buffer-search-char} will be set to @kbd{g}.
1154 Regardless of how this feature is enabled, the key
1155 @code{viper-buffer-search-char} will take movement commands, like
1156 @kbd{w,/,e}, to find a region and then search for the contents of that
1157 region. This command is very useful for searching for variable names, etc.,
1158 in a program. The search can be repeated by @kbd{n} or reversed by @kbd{N}.
1160 @cindex incremental search
1162 Emacs provides incremental search. As you type the string in, the
1163 cursor will move to the next match. You can snarf words from the buffer
1164 as you go along. Incremental Search is normally bound to @kbd{C-s} and
1165 @kbd{C-r}. @xref{Customization}, to find out how to change the bindings
1166 of @kbd{C-r or C-s}.
1167 For details, @pxref{Incremental Search,,Incremental
1168 Search,emacs,The GNU Emacs Manual} @refill
1170 @cindex query replace
1172 Viper also provides a query replace function that prompts through the
1173 Minibuffer. It is invoked by the @kbd{Q} key in Vi state.
1175 @cindex mouse search
1177 On a window display, Viper supports mouse search, i.e., you can search for a
1178 word by clicking on it. @xref{Viper Specials}, for details.
1180 Finally, on a window display, Viper highlights search patterns as it finds
1181 them. This is done through what is known as @emph{faces} in Emacs. The
1182 variable that controls how search patterns are highlighted is
1183 @code{viper-search-face}. If you don't want any highlighting at all, put
1185 (copy-face 'default 'viper-search-face)
1187 @vindex @code{viper-search-face}
1189 in @file{~/.viper}. If you want to change how patterns are highlighted, you
1190 will have to change @code{viper-search-face} to your liking. The easiest
1191 way to do this is to use Emacs customization widget, which is accessible
1192 from the menubar. Viper customization group is located under the
1193 @emph{Emulations} customization group, which in turn is under the
1194 @emph{Editing} group. All Viper faces are grouped together under Viper's
1195 @emph{Highlighting} group.
1197 Try it: it is really simple!
1199 @node Abbreviation Facilities,Movement and Markers,Improved Search,Improvements over Vi
1200 @section Abbreviation Facilities
1204 It is possible in Emacs to define abbrevs based on the contents of the
1206 Sophisticated templates can be defined using the Emacs abbreviation
1207 facilities. @xref{Abbrevs,,Abbreviations,emacs,The GNU Emacs Manual}, for
1210 @cindex dynamic abbrevs
1212 Emacs also provides Dynamic Abbreviations. Given a partial word, Emacs
1213 will search the buffer to find an extension for this word. For instance,
1214 one can type @samp{Abbreviations} by typing @samp{A}, followed by a keystroke
1215 that completed the @samp{A} to @samp{Abbreviations}. Repeated typing
1216 will search further back in the buffer, so that one could get
1217 @samp{Abbrevs} by repeating the
1218 keystroke, which appears earlier in the text. Emacs binds this to
1219 @kbd{@key{ESC} /}, so you will have to find a key and bind the function
1220 @code{dabbrev-expand} to that key.
1221 Facilities like this make Vi's @kbd{:ab} command obsolete.
1223 @node Movement and Markers, New Commands, Abbreviation Facilities, Improvements over Vi
1224 @section Movement and Markers
1226 @cindex Ex style motion
1227 @cindex line editor motion
1229 Viper can be set free from the line--limited movements in Vi, such as @kbd{l}
1230 refusing to move beyond the line, @key{ESC} moving one character back,
1231 etc. These derive from Ex, which is a line editor. If your @file{.viper}
1235 @code{(setq viper-ex-style-motion nil)}
1239 the motion will be a true screen editor motion. One thing you must then
1240 watch out for is that it is possible to be on the end-of-line character.
1241 The keys @kbd{x} and @kbd{%} will still work correctly, i.e., as if they
1242 were on the last character.
1244 @vindex @code{viper-syntax-preference}
1245 @cindex syntax table
1247 The word-movement commands @kbd{w}, @kbd{e}, etc., and the associated
1248 deletion/yanking commands, @kbd{dw}, @kbd{yw}, etc., can be made to
1249 understand Emacs syntax tables. If the variable
1250 @code{viper-syntax-preference} is set to @code{strict-vi} then
1251 the meaning of @emph{word} is the same as in
1252 Vi. However, if the value is @code{reformed-vi} (the default) then the
1253 alphanumeric symbols will be those specified by the current Emacs syntax
1254 table (which may be different for different major modes) plus the
1255 underscore symbol @kbd{_}, minus some non-word symbols, like '.;,|, etc.
1256 Both @code{strict-vi} and @code{reformed-vi} work close to Vi in
1257 traditional cases, but @code{reformed-vi} does a better job when editing
1258 text in non-Latin alphabets.
1260 The user can also specify the value @code{emacs}, which would
1261 make Viper use exactly the Emacs notion of word. In particular, the
1262 underscore may not be part of a word. Finally, if
1263 @code{viper-syntax-preference} is set to @code{extended}, Viper words would
1264 consist of characters that are classified as alphanumeric @emph{or} as
1265 parts of symbols. This is convenient for writing programs and in many other
1268 @code{viper-syntax-preference} is a local variable, so it can have different
1269 values for different major modes. For instance, in programming modes it can
1270 have the value @code{extended}. In text modes where words contain special
1271 characters, such as European (non-English) letters, Cyrillic letters, etc.,
1272 the value can be @code{reformed-vi} or @code{emacs}.
1274 Changes to @code{viper-syntax-preference} should be done in the hooks to
1275 various major modes by executing @code{viper-set-syntax-preference} as in
1276 the following example:
1279 (viper-set-syntax-preference nil "emacs")
1282 @findex @code{viper-set-syntax-preference}
1284 The above discussion of the meaning of Viper's words concerns only Viper's
1285 movement commands. In regular expressions, words remain the same as in
1286 Emacs. That is, the expressions @code{\w}, @code{\>}, @code{\<}, etc., use
1287 Emacs' idea of what is a word, and they don't look into the value of
1288 variable @code{viper-syntax-preference}. This is because Viper doesn't change
1289 syntax tables in fear of upsetting the various major modes that set these
1294 Textmarkers in Viper remember the file and the position, so that you can
1295 switch files by simply doing @kbd{'a}. If you set up a regimen for using
1296 Textmarkers, this is very useful. Contents of textmarkers can be viewed
1297 by @kbd{[marker}. (Contents of registers can be viewed by @kbd{]register}).
1299 @node New Commands, Useful Packages, Movement and Markers, Improvements over Vi
1300 @section New Commands
1302 These commands have no Vi analogs.
1308 These two keys invoke many important Emacs functions. For example, if you
1309 hit @kbd{C-x} followed by @kbd{2}, then the current window will be split
1310 into 2. Except for novice users, @kbd{C-c} is also set to execute an Emacs
1311 command from the current major mode. @key{ESC} will do the same, if you
1312 configure @key{ESC} as Meta by setting @code{viper-no-multiple-ESC} to nil
1313 in @file{.viper}. @xref{Customization}. @kbd{C-\} in Insert, Replace, or Vi
1314 states will make Emacs think @kbd{Meta} has been hit.@refill
1317 Escape to Emacs to execute a single Emacs command. For instance,
1318 @kbd{\ @key{ESC}} will act like a Meta key.
1321 @cindex query replace
1322 @kbd{Q} is for query replace. By default,
1323 each string to be replaced is treated as a regular expression. You can use
1324 @code{(setq viper-re-query-replace nil)} in your @file{.emacs} file to
1325 turn this off. (For normal searches, @kbd{:se nomagic} will work. Note
1326 that @kbd{:se nomagic} turns Regexps off completely, unlike Vi).
1333 These keys are used to visit files. @kbd{v} will switch to a buffer
1334 visiting file whose name can be entered in the Minibuffer. @kbd{V} is
1335 similar, but will use a window different from the current window.
1336 @kbd{C-v} is like @kbd{V}, except that a new frame (X window) will be used
1337 instead of a new Emacs window.
1340 If followed by a certain character @var{ch}, it becomes an operator whose
1341 argument is the region determined by the motion command that follows
1342 (indicated as <move>).
1343 Currently, @var{ch} can be one of @kbd{c}, @kbd{C}, @kbd{g}, @kbd{q}, and
1344 @kbd{s}. For instance, @kbd{#qr} will prompt you for a string and then
1345 prepend this string to each line in the buffer.@refill
1347 @kindex @kbd{#c<move>}
1348 @cindex changing case
1349 Change upper-case characters in the region to lower-case
1350 (@code{downcase-region}).
1351 Emacs command @kbd{M-l} does the same for words.
1353 @kindex @kbd{#C<move>}
1354 Change lower-case characters in the region to upper-case. For instance,
1355 @kbd{# C 3 w} will capitalize 3 words from the current point
1356 (@code{upcase-region}).
1357 Emacs command @kbd{M-u} does the same for words.
1359 @kindex @kbd{#g<move>}
1360 Execute last keyboard macro for each line in the region
1361 (@code{viper-global-execute}).@refill
1363 @kindex @kbd{#q<move>}
1364 Insert specified string at the beginning of each line in the region
1365 (@code{viper-quote-region}). The default string is composed of the comment
1366 character(s) appropriate for the current major mode.
1368 @kindex @kbd{#s<move>}
1369 Check spelling of words in the region (@code{spell-region}).
1370 The function used for spelling is determined from the variable
1371 @code{viper-spell-function}.
1372 @vindex @code{viper-spell-function}
1375 Call last keyboard macro.
1377 Set mark at point and push old mark off the ring
1380 Set mark at beginning and end of buffer, respectively.
1382 Jump to mark and pop mark off the ring. @xref{Mark,,Mark,emacs,The GNU
1383 Emacs Manual}, for more info.
1385 @kindex @kbd{]<a-z>}
1386 View contents of register
1388 @kindex @kbd{[<a-z>}
1389 View filename and position of textmarker
1394 @kindex @kbd{@@<a-z>}
1396 @cindex keyboard macros
1397 @cindex register execution
1399 Begin/end keyboard macro. @@register has a different meaning when used after
1400 a @kbd{@@#}. @xref{Macros and Registers}, for details
1403 Go to end of heading.
1404 @item g <@emph{movement command}>
1405 Search buffer for text delimited by movement command. The canonical
1406 example is @kbd{gw} to search for the word under the cursor.
1407 @xref{Improved Search}, for details.@refill
1411 Quit and Abort Recursive edit. These may be necessary on occasion.
1412 @xref{Vi State}, for a reason.
1414 @kindex @kbd{C-c C-g}
1415 Hitting @kbd{C-c} followed by @kbd{C-g} will display the information on the
1416 current buffer. This is the same as hitting @kbd{C-g} in Vi, but, as
1417 explained above, @kbd{C-g} is needed for other purposes in Emacs.
1420 Without a prefix argument, this command toggles
1421 case-sensitive/case-insensitive search modes and plain vanilla/regular
1422 expression search. With the prefix argument 1, i.e.,
1423 @kbd{1 C-c /}, this toggles case-sensitivity; with the prefix argument 2,
1424 toggles plain vanilla search and search using
1425 regular expressions. @xref{Viper Specials}, for alternative ways to invoke
1427 @cindex vanilla search
1428 @cindex case-sensitive search
1429 @cindex case-insensitive search
1434 In the Minibuffer, these commands navigate through the minibuffer
1435 histories, such as the history of search strings, Ex commands, etc.
1437 @item C-c M-p and C-c M-n
1438 @kindex @kbd{C-c M-p}
1439 @kindex @kbd{C-c M-n}
1440 @cindex Insertion history
1441 @cindex Insertion ring
1442 @cindex Command history
1443 @cindex Command ring
1445 In Insert or Replace state, these commands let the user
1446 peruse the history of insertion strings used in previous insert or replace
1447 commands. Try to hit @kbd{C-c M-p} or @kbd{C-c M-n} repeatedly and see what
1448 happens. @xref{Viper Specials}, for more.
1450 In Vi state, these commands let the user peruse the history of Vi-style
1451 destructive commands, such as @kbd{dw}, @kbd{J}, @kbd{a}, etc.
1452 By repeatedly typing @kbd{C-c M-p} or @kbd{C-c M-n} you will cycle Viper
1453 through the recent history of Vi commands, displaying the commands one by
1455 an appropriate command is found, it can be executed by typing `@kbd{.}'.
1457 Since typing @kbd{C-c M-p} is tedious, it is more convenient to bind an
1458 appropriate function to a function key on the keyboard and use that key.
1459 @xref{Viper Specials}, for details.
1466 The commands @kbd{:args}, @kbd{:next}, @kbd{:pre} behave
1467 differently. @kbd{:pwd} exists to get current directory.
1468 The commands @kbd{:b} and @kbd{:B} switch buffers around. @xref{File and
1469 Buffer Handling}, for details.
1470 There are also the new commands @kbd{:RelatedFile} and
1471 @kbd{PreviousRelatedFile} (which abbreviate to @kbd{R} and @kbd{P},
1472 respectively. @xref{Viper Specials}, for details.
1473 @findex @kbd{:RelatedFile}
1474 @findex @kbd{:PreviousRelatedFile}
1477 Apart from the new commands, many old commands have been enhanced. Most
1478 notably, Vi style macros are much more powerful in Viper than in Vi. @xref{Vi
1479 Macros}, for details.
1481 @node Useful Packages, ,New Commands, Improvements over Vi
1482 @section Useful Packages
1484 Some Emacs packages are mentioned here as an aid to the new Viper user, to
1485 indicate what Viper is capable of.
1486 A vast number comes with the standard Emacs distribution, and many more exist
1487 on the net and on the archives.
1489 This manual also mentions some Emacs features a new user
1490 should know about. The details of these are found in the GNU Emacs
1493 The features first. For details, look up the Emacs Manual.
1500 Makes and Compiles can be done from the editor. Error messages will be
1501 parsed and you can move to the error lines.
1504 @cindex interactive shell
1505 You can talk to Shells from inside the editor. Your entire shell session
1506 can be treated as a file.
1510 Mail can be read from and sent within the editor. Several sophisticated
1512 @item Language Sensitive Editing
1513 Editing modes are written for most computer languages in existence. By
1514 controlling indentation, they catch punctuation errors.
1517 The packages, below, represents a drop in the sea of special-purpose
1518 packages that come with standard distribution of Emacs.
1521 @item Transparent FTP
1522 @cindex transparent ftp
1524 @code{ange-ftp.el} can ftp from the editor to files on other machines
1525 transparent to the user.
1526 @item RCS Interfaces
1527 @cindex version maintenance
1530 @code{vc.el} for doing RCS commands from inside the editor
1531 @item Directory Editor
1534 @code{dired.el} for editing contents of directories and for navigating in
1536 @item Syntactic Highlighting
1538 @pindex font-lock.el
1539 @code{font-lock.el} for automatic highlighting various parts of a buffer
1540 using different fonts and colors.
1541 @item Saving Emacs Configuration
1544 @code{desktop.el} for saving/restoring configuration on Emacs exit/startup.
1548 @code{ispell.el} for spell checking the buffer, words, regions, etc.
1549 @item File and Buffer Comparison
1552 @code{ediff.el} for finding differences between files and for applying
1557 Emacs Lisp archives exist on
1558 @samp{archive.cis.ohio-state.edu}
1559 and @samp{wuarchive.wustl.edu}@refill
1562 @node Customization,Commands,Improvements over Vi,Top
1563 @chapter Customization
1565 @cindex customization
1567 Customization can be done in 2 ways.
1571 @cindex initialization
1573 Elisp code in a @file{.viper} file in your home directory. Viper
1574 loads @file{.viper} just before it does the binding for mode
1575 hooks. This is the recommended method.
1578 Elisp code in your @file{.emacs} file before and after the @code{(require
1579 'viper)} line. This method is not recommended, unless you know what you are
1580 doing. Only two variables, @code{viper-mode} and
1581 @code{viper-custom-file-name} are supposed to be customized in @file{.emacs},
1582 prior to loading Viper.@refill
1586 Most of Viper's behavior can be customized via the interactive Emacs user
1587 interface. Choose "Customize" from the menubar, click on "Editing", then on
1588 "Emulations". The customization widget is self-explanatory. Once you are
1589 satisfied with your changes, save them into a file and then include the
1590 contents of that file in the Viper customization repository, @file{.viper}
1591 (except for @code{viper-mode} and @code{viper-custom-file-name}, which are
1592 supposed to go into @code{.emacs}).
1594 Some advanced customization cannot be accomplished this way, however, and
1595 has to be done in Emacs Lisp. For the common cases, examples are provided
1596 that you can use directly.
1599 * Rudimentary Changes:: Simple constant definitions.
1600 * Keybindings:: Enabling Emacs Keys, Rebinding keys, etc.
1601 * Packages that Change Keymaps:: How to deal with such beasts.
1602 * Viper Specials:: Special Viper commands.
1603 * Vi Macros:: How to do Vi style macros.
1606 @node Rudimentary Changes,Keybindings,Customization,Customization
1607 @section Rudimentary Changes
1609 @cindex setting variables
1610 @cindex variables for customization
1613 An easy way to customize Viper is to change the values of constants used in
1614 Viper. Here is the list of the constants used in Viper and their default
1615 values. The corresponding :se command is also indicated. (The symbols
1616 @code{t} and @code{nil} represent ``true'' and ``false'' in Lisp).
1618 Viper supports both the abbreviated Vi variable names and their full
1619 names. Variable completion is done on full names only. @key{TAB} and
1621 variable names. Typing `=' will complete the name and then will prompt for
1622 a value, if applicable. For instance, @kbd{:se au @key{SPC}} will complete the
1623 command to @kbd{:set autoindent}; @kbd{:se ta @key{SPC}} will complete the command
1624 and prompt further like this: @kbd{:set tabstop = }.
1625 However, typing @kbd{:se ts @key{SPC}} will produce a ``No match'' message
1626 because @kbd{ts} is an abbreviation for @kbd{tabstop} and Viper supports
1627 completion on full names only. However, you can still hit @key{RET}
1628 or @kbd{=}, which will complete the command like this: @kbd{:set ts = } and
1629 Viper will be waiting for you to type a value for the tabstop variable.
1630 To get the full list of Vi variables, type @kbd{:se @key{SPC} @key{TAB}}.
1633 @item viper-auto-indent nil
1634 @itemx :se ai (:se autoindent)
1635 @itemx :se ai-g (:se autoindent-global)
1636 If @code{t}, enable auto indentation.
1637 by @key{RET}, @kbd{o} or @kbd{O} command.
1639 @code{viper-auto-indent} is a local variable. To change the value globally, use
1640 @code{setq-default}. It may be useful for certain major modes to have their
1641 own values of @code{viper-auto-indent}. This can be achieved by using
1642 @code{setq} to change the local value of this variable in the hooks to the
1643 appropriate major modes.
1645 @kbd{:se ai} changes the value of @code{viper-auto-indent} in the current
1646 buffer only; @kbd{:se ai-g} does the same globally.
1647 @item viper-electric-mode t
1648 If not @code{nil}, auto-indentation becomes electric, which means that
1649 @key{RET}, @kbd{O}, and @kbd{o} indent cursor according to the current
1650 major mode. In the future, this variable may control additional electric
1653 This is a local variable: @code{setq} changes the value of this variable
1654 in the current buffer only. Use @code{setq-default} to change the value in
1656 @item viper-case-fold-search nil
1657 @itemx :se ic (:se ignorecase)
1658 If not @code{nil}, search ignores cases.
1659 This can also be toggled by quickly hitting @kbd{/} twice.
1660 @item viper-re-search nil
1662 If not @code{nil}, search will use regular expressions; if @code{nil} then
1664 This behavior can also be toggled by quickly hitting @kbd{/} trice.
1665 @item buffer-read-only
1666 @itemx :se ro (:se readonly)
1667 Set current buffer to read only. To change globally put
1668 @code{(setq-default buffer-read-only t)} in your @file{.emacs} file.
1669 @item blink-matching-paren t
1670 @itemx :se sm (:se showmatch)
1671 Show matching parens by blinking cursor.
1672 @item tab-width t (default setting via @code{setq-default})
1673 @itemx :se ts=value (:se tabstop=value)
1674 @itemx :se ts-g=value (:se tabstop-global=value)
1675 @code{tab-width} is a local variable that controls the width of the tab stops.
1676 To change the value globally, use @code{setq-default}; for local settings,
1679 The command @kbd{:se ts}
1680 sets the tab width in the current
1681 buffer only; it has no effect on other buffers.
1683 The command @kbd{:se ts-g} sets tab width globally,
1684 for all buffers where the tab is not yet set locally,
1685 including the new buffers.
1687 Note that typing @key{TAB} normally
1688 doesn't insert the tab, since this key is usually bound to
1689 a text-formatting function, @code{indent-for-tab-command} (which facilitates
1690 programming and document writing). Instead, the tab is inserted via the
1691 command @code{viper-insert-tab}, which is bound to @kbd{S-tab} (shift + tab).
1693 On some non-windowing terminals, Shift doesn't modify the @key{TAB} key, so
1694 @kbd{S-tab} behaves as if it were @key{TAB}. In such a case, you will have
1695 to bind @code{viper-insert-tab} to some other convenient key.
1697 @item viper-shift-width 8
1698 @itemx :se sw=value (:se shiftwidth=value)
1699 The number of columns shifted by @kbd{>} and @kbd{<} commands.
1700 @item viper-search-wrap-around t
1701 @itemx :se ws (:se wrapscan)
1702 If not @code{nil}, search wraps around the end/beginning of buffer.
1703 @item viper-search-scroll-threshold 2
1704 If search lands within this many lines of the window top or bottom, the
1705 window will be scrolled up or down by about 1/7-th of its size, to reveal
1706 the context. If the value is negative---don't scroll.
1707 @item viper-tags-file-name "TAGS"
1708 The name of the file used as the tag table.
1709 @item viper-re-query-replace nil
1710 If not @code{nil}, use reg-exp replace in query replace.
1711 @item viper-want-ctl-h-help nil
1712 If not @code{nil}, @kbd{C-h} is bound to @code{help-command};
1713 otherwise, @kbd{C-h} is bound as usual in Vi.
1714 @item viper-vi-style-in-minibuffer t
1715 If not @code{nil}, Viper provides a high degree of compatibility with Vi
1716 insert mode when you type text in the Minibuffer; if @code{nil}, typing in
1717 the Minibuffer feels like plain Emacs.
1718 @item viper-no-multiple-ESC t
1719 If you set this to @code{nil}, you can use @key{ESC} as Meta in Vi state.
1720 Normally, this is not necessary, since graphical displays have separate
1721 Meta keys (usually on each side of the space bar). On a dumb terminal, Viper
1722 sets this variable to @code{twice}, which is almost like @code{nil}, except
1723 that double @key{ESC} beeps. This, too, lets @key{ESC} to be used as a Meta.
1724 @item viper-ESC-keyseq-timeout 200 on tty, 0 on windowing display
1725 Escape key sequences separated by this much delay (in milliseconds) are
1726 interpreted as command, ignoring the special meaning of @key{ESC} in
1727 VI. The default is suitable for most terminals. However, if your terminal
1728 is extremely slow, you might want to increase this slightly. You will know
1729 if your terminal is slow if the @key{ESC} key sequences emitted by the
1730 arrow keys are interpreted as separately typed characters (and thus the
1731 arrow keys won't work). Making this value too large will slow you down, so
1733 @item viper-fast-keyseq-timeout 200
1734 Key sequences separated by this many milliseconds are treated as Vi-style
1735 keyboard macros. If the key sequence is defined as such a macro, it will be
1736 executed. Otherwise, it is processed as an ordinary sequence of typed keys.
1738 Setting this variable too high may slow down your typing. Setting it too
1739 low may make it hard to type macros quickly enough.
1740 @item viper-translate-all-ESC-keysequences t on tty, nil on windowing display
1741 Normally, Viper lets Emacs translate only those ESC key sequences that are
1742 defined in the low-level key-translation-map or function-key-map, such as those
1743 emitted by the arrow and function keys. Other sequences, e.g., @kbd{\\e/}, are
1744 treated as @kbd{ESC} command followed by a @kbd{/}. This is good for people
1745 who type fast and tend to hit other characters right after they hit
1746 ESC. Other people like Emacs to translate @kbd{ESC} sequences all the time.
1747 The default is to translate all sequences only when using a dumb terminal.
1748 This permits you to use @kbd{ESC} as a meta key in insert mode. For instance,
1749 hitting @kbd{ESC x} fast would have the effect of typing @kbd{M-x}.
1750 If your dumb terminal is not so dumb and understands the meta key, then you
1751 probably will be better off setting this variable to nil. Try and see which
1753 @item viper-ex-style-motion t
1754 Set this to @code{nil}, if you want @kbd{l,h} to cross
1755 lines, etc. @xref{Movement and Markers}, for more info.
1756 @item viper-ex-style-editing t
1757 Set this to @code{nil}, if you want
1758 @kbd{C-h} and @key{DEL} to not stop
1759 at the beginning of a line in Insert state, @key{X} and @key{x} to delete
1760 characters across lines in Vi command state, etc.
1761 @item viper-ESC-moves-cursor-back t
1762 It t, cursor moves back 1 character when switching from insert state to vi
1763 state. If nil, the cursor stays where it was before the switch.
1764 @item viper-always t
1765 @code{t} means: leave it to Viper to decide when a buffer must be brought
1767 Insert state, or Emacs state. This heuristics works well in virtually all
1768 cases. @code{nil} means you either has to invoke @code{viper-mode} manually
1769 for each buffer (or you can add @code{viper-mode} to the appropriate major mode
1770 hooks using @code{viper-load-hook}).
1772 This option must be set in the file @file{~/.viper}.
1773 @item viper-custom-file-name "~/.viper"
1774 File used for Viper-specific customization.
1775 Change this setting, if you want. Must be set in @file{.emacs} (not @file{.viper}!)
1776 before Viper is loaded. Note that you
1777 have to set it as a string inside double quotes.
1778 @item viper-spell-function 'ispell-region
1779 Function used by the command @kbd{#c<move>} to spell.
1780 @item viper-glob-function
1781 The value of this variable is the function symbol used to expand wildcard
1782 symbols. This is platform-dependent. The default tries to set this variable
1783 to work with most Unix shells, MS Windows, OS/2, etc. However, if it
1784 doesn't work the way you expect, you should write your own.
1785 Use @code{viper-glob-unix-files} and @code{viper-glob-mswindows-files} in
1786 @file{viper-util.el} as examples.
1788 This feature is used to expand wildcards in the Ex command @kbd{:e}.
1789 Note that Viper doesn't support wildcards in the @kbd{:r} and @kbd{:w}
1790 commands, because file completion is a better mechanism.
1791 @findex @code{viper-glob-function}
1793 @item ex-cycle-other-window t
1794 If not @code{nil}, @kbd{:n} and @kbd{:b} will cycle through files in another
1795 window, if one exists.
1796 @item ex-cycle-through-non-files nil
1797 @kbd{:n} does not normally cycle through buffers. Set this to get
1799 @item viper-want-emacs-keys-in-insert
1800 This is set to @code{nil} for user levels 1 and 2 and to @code{t} for user
1801 levels 3 and 4. Users who specify level 5 are allowed to set this variable
1802 as they please (the default for this level is @code{t}). If set to
1803 @code{nil}, complete Vi compatibility is provided in Insert state. This is
1804 really not recommended, as this precludes you from using language-specific
1805 features provided by the major modes.
1806 @item viper-want-emacs-keys-in-vi
1807 This is set to @code{nil} for user
1808 level 1 and to @code{t} for user levels 2--4.
1809 At level 5, users are allowed to set this variable as they please (the
1810 default for this level is @code{t}).
1811 If set to @code{nil}, complete Vi compatibility is provided
1812 in Vi command state. Setting this to @code{nil} is really a bad idea,
1813 unless you are a novice, as this precludes the use
1814 of language-specific features provided by the major modes.
1815 @item viper-keep-point-on-repeat t
1816 If not @code{nil}, point is not moved when the user repeats the previous
1817 command by typing `.' This is very useful for doing repeated changes with
1819 @item viper-repeat-from-history-key 'f12
1820 Prefix key used to invoke the macros @kbd{f12 1} and @kbd{f12 2} that repeat
1821 the second-last and the third-last destructive command.
1822 Both these macros are bound (as Viper macros) to
1823 @code{viper-repeat-from-history},
1824 which checks the second key by which it is invoked to see which of the
1825 previous commands to invoke. Viper binds @kbd{f12 1} and @kbd{f12 2} only,
1826 but the user can bind more in @file{~/.viper}. @xref{Vi Macros}, for how to do
1828 @item viper-keep-point-on-undo nil
1829 If not @code{nil}, Viper tries to not move point when undoing commands.
1830 Instead, it will briefly move the cursor to the place where change has
1831 taken place. However, if the undone piece of text is not seen in window,
1832 then point will be moved to the place where the change took place.
1833 Set it to @code{t} and see if you like it better.
1834 @item viper-delete-backwards-in-replace nil
1835 If not @code{nil}, @key{DEL} key will delete characters while moving the cursor
1836 backwards. If @code{nil}, the cursor will move backwards without deleting
1838 @item viper-replace-overlay-face 'viper-replace-overlay-face
1839 On a graphical display, Viper highlights replacement regions instead of
1840 putting a @samp{$} at the end. This variable controls the so called
1841 @dfn{face} used to highlight the region.
1843 By default, @code{viper-replace-overlay-face} underlines the replacement on
1844 monochrome displays and also lays a stipple over them. On color displays,
1845 replacement regions are highlighted with color.
1847 If you know something about Emacs faces and don't like how Viper highlights
1848 replacement regions, you can change @code{viper-replace-overlay-face} by
1849 specifying a new face. (Emacs faces are described in the Emacs Lisp
1850 reference.) On a color display, the following customization method is
1851 usually most effective:
1853 (set-face-foreground viper-replace-overlay-face
1855 (set-face-background viper-replace-overlay-face
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.
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
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
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.
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
1906 @item viper-search-face 'viper-search-face
1907 Variable that controls how search patterns are highlighted when they are
1909 @item viper-vi-state-hook nil
1910 List of parameterless functions to be run just after entering the Vi
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
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.
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:
1929 (setq viper-case-fold-search t)
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}
1973 @node Keybindings, Packages that Change Keymaps, Rudimentary Changes,Customization
1974 @section Keybindings
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.
1987 Under the X Window System, every keyboard key emits its preferred form,
1988 so you can just type
1991 (global-set-key [f11] 'calendar) ; L1, Stop
1992 (global-set-key [f14] 'undo) ; L4, Undo
1996 to bind L1 so it will invoke the Emacs Calendar and to bind L4 so it will
1998 However, on a dumb terminal or in an Xterm window, even the standard arrow
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:
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
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).
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.
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).
2028 For more information on Viper keymaps, see the header of the file
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-insert-global-user-map} also affects Viper's Replace
2039 bind a key, say @kbd{C-v}, to the function that scrolls
2040 page down and to make @kbd{0} display information on the current buffer,
2041 putting this in @file{.viper} will do the trick in Vi state:
2043 (define-key viper-vi-global-user-map "\C-v" 'scroll-down)
2046 To set a key globally,
2048 (define-key viper-emacs-global-user-map "\C-c m" 'smail)
2049 (define-key viper-vi-global-user-map "0" 'viper-info-on-file)
2052 Note, however, that this binding may be overwritten by other keymaps, since
2053 the global keymap has the lowest priority.
2054 To make sure that nothing will override a binding in Emacs state, you
2057 (define-key viper-emacs-global-user-map "\C-c m" 'smail)
2060 To customize the binding for @kbd{C-h} in Insert state:
2062 (define-key viper-insert-global-user-map
2063 "\C-h" 'my-del-backwards-function)
2067 Each Emacs command key calls some lisp function. If you have enabled the
2068 Help, (@pxref{Rudimentary Changes}) @kbd{C-h k} will show you the function
2069 for each specific key; @kbd{C-h b} will show all bindings, and @kbd{C-h m}
2070 will provide information on the major mode in effect. If Help is not
2071 enabled, you can still get help in Vi state by prefixing the above commands
2072 with @kbd{\}, e.g., @kbd{\ C-h k} (or you can use the Help menu in the
2073 menu bar, if Emacs runs under X).
2075 Viper users can also change bindings on a per major mode basis. As with
2076 global bindings, this can be done separately for each of the three main Viper
2077 states. To this end, Viper provides the function
2078 @code{viper-modify-major-mode}.
2079 @findex @code{viper-modify-major-mode}
2081 To modify keys in Emacs state for @code{my-favorite-major-mode}, the user
2082 needs to create a sparse keymap, say, @code{my-fancy-map}, bind whatever
2083 keys necessary in that keymap, and put
2086 (viper-modify-major-mode 'dired-mode 'emacs-state my-fancy-map)
2090 in @file{~/.viper}. To do the same in Vi and Insert states, you should use
2091 @code{vi-state} and @code{insert-state}. Changes in Insert state are also
2092 in effect in Replace state. For instance, suppose that the user wants to
2093 use @kbd{dd} in Vi state under Dired mode to delete files, @kbd{u} to unmark
2094 files, etc. The following code in @file{~/.viper} will then do the job:
2097 (setq my-dired-modifier-map (make-sparse-keymap))
2098 (define-key my-dired-modifier-map "dd" 'dired-flag-file-deletion)
2099 (define-key my-dired-modifier-map "u" 'dired-unmark)
2100 (viper-modify-major-mode 'dired-mode 'vi-state my-dired-modifier-map)
2103 A Vi purist may want to modify Emacs state under Dired mode so that
2104 @kbd{k}, @kbd{l}, etc., will move around in directory buffers, as in
2105 Vi. Although this is not recommended, as these keys are bound to useful
2106 Dired functions, the trick can be accomplished via the following code:
2109 (setq my-dired-vi-purist-map (make-sparse-keymap))
2110 (define-key my-dired-vi-purist-map "k" 'viper-previous-line)
2111 (define-key my-dired-vi-purist-map "l" 'viper-forward-char)
2112 (viper-modify-major-mode 'dired-mode
2113 'emacs-state my-dired-vi-purist-map)
2116 Yet another way to customize key bindings in a major mode is to edit the
2117 list @code{viper-major-mode-modifier-list} using the customization widget.
2118 @vindex @code{viper-major-mode-modifier-list}
2119 (This variable is in the Viper-misc customization group.)
2120 The elements of this list are triples of the form: (major-mode viper-state
2121 keymap), where the keymap contains bindings that are supposed to be active
2122 in the given major mode and the given viper-state.
2124 Effects similar to key binding changes can be achieved by defining Vi
2125 keyboard macros using the Ex commands @kbd{:map} and @kbd{:map!}. The
2126 difference is that multi-key Vi macros do not override the keys they are
2127 bound to, unless these keys are typed in quick succession. So, with macros,
2128 one can use the normal keys alongside with the macros. If per-mode
2129 modifications are needed, the user can try both ways and see which one is
2132 @xref{Vi Macros}, for details.
2134 Note: in major modes that come up in @emph{Emacs state} by default, the
2135 aforesaid modifications may not take place immediately (but only after the
2136 buffer switches to some other Viper state and then back to Emacs state). To
2137 avoid this, one should add @code{viper-change-state-to-emacs} to an
2138 appropriate hook of that major mode. (Check the function
2139 @code{viper-set-hooks} in @file{viper.el} for examples.) However, if you
2140 have set @code{viper-always} to @code{t}, chances are that you won't need to
2141 perform the above procedure, because Viper will take care of most useful
2145 Finally, Viper has a facility that lets the user define per-buffer
2146 bindings, i.e., bindings that are in effect in some specific buffers
2147 only. Unlike per-mode bindings described above, per-buffer bindings can be
2148 defined based on considerations other than the major mode. This is done
2149 via the function @code{viper-add-local-keys}, which lets one specify bindings
2150 that should be in effect in the current buffer only and for a specific Viper
2151 state. For instance,
2153 (viper-add-local-keys 'vi-state '(("ZZ" .@: TeX-command-master)
2154 ("ZQ" .@: viper-save-kill-buffer)))
2157 redefines @kbd{ZZ} to invoke @code{TeX-command-master} in @code{vi-state}
2158 and @kbd{ZQ} to save-then-kill the current buffer. These bindings take
2159 effect only in the buffer where this command is executed. The typical use
2160 of this function is to execute the above expression from within a function
2161 that is included in a hook to some major mode. For instance, the above
2163 could be called from a function, @code{my-tex-init}, which may be added to
2164 @code{tex-mode-hook} as follows:
2166 (add-hook 'tex-mode-hook 'my-tex-init)
2169 When TeX mode starts, the hook is executed and the above Lisp expression is
2170 evaluated. Then, the bindings for @kbd{ZZ} and @kbd{ZQ} are changed in Vi
2171 command mode for all buffers in TeX mode.
2173 Another useful application is to bind @kbd{ZZ} to @code{send-mail}
2174 in the Mail mode buffers (the specifics of this depend on which mail
2175 package you are using, @code{rmail}, @code{mh-e}, @code{vm}, etc.
2176 For instance, here is how to do this for @code{mh-e}, the Emacs interface
2179 (defun mh-add-vi-keys ()
2180 "Set up ZZ for MH-e and XMH."
2181 (viper-add-local-keys 'vi-state '(("ZZ" .@: mh-send-letter))))
2182 (add-hook 'mh-letter-mode-hook 'mh-add-vi-keys)
2185 You can also use @code{viper-add-local-keys} to set per buffer
2186 bindings in Insert state and Emacs state by passing as a parameter the
2187 symbols @code{insert-state} and @code{emacs-state}, respectively.
2188 As with global bindings, customized local bindings done to Emacs state
2189 are not inherited by Insert state.
2191 On rare occasions, local keys may be added by mistake. Usually this is done
2192 indirectly, by invoking a major mode that adds local keys (e.g.,
2193 @code{shell-mode} redefines @key{RET}). In such a case, exiting the wrong
2194 major mode won't rid you from unwanted local keys, since these keys are
2195 local to Viper state and the current buffer, not to the major mode.
2196 In such situations, the remedy is to type @kbd{M-x viper-zap-local-keys}.
2198 So much about Viper-specific bindings.
2199 @xref{Customization,,Customization,emacs,The GNU Emacs
2200 Manual}, and the Emacs quick reference card for the general info on key
2203 @vindex @code{function-key-map}
2204 @vindex @code{viper-vi-global-user-map}
2205 @vindex @code{viper-insert-global-user-map}
2206 @vindex @code{viper-emacs-global-user-map}
2207 @findex @code{viper-add-local-keys}
2208 @findex @code{viper-zap-local-keys}
2210 @node Packages that Change Keymaps,Viper Specials,Keybindings,Customization
2211 @subsection Packages that Change Keymaps
2212 @cindex C-c and Viper
2213 @cindex Viper and C-c
2215 Viper is designed to coexist with all major and minor modes of Emacs. This
2216 means that bindings set by those modes are generally available with Viper
2217 (unless you explicitly prohibit them by setting
2218 @code{viper-want-emacs-keys-in-vi} and @code{viper-want-emacs-keys-in-insert} to
2220 If @code{viper-always} is set to @code{t}, Viper will try to bring each buffer
2221 in the Viper state that is most appropriate for that buffer.
2222 Usually, this would be the Vi state, but sometimes it could be the Insert
2223 state or the Emacs state.
2225 Some major mode bindings will necessarily be overwritten by Viper. Indeed, in
2226 Vi state, most of the 1-character keys are used for Vi-style editing. This
2227 usually causes no problems because most packages designed for editing files
2228 typically do not bind such keys. Instead, they use key sequences that start
2229 with @kbd{C-x} and @kbd{C-c}. This is why it was so important for us to
2230 free up @kbd{C-x} and @kbd{C-c}.
2231 It is common for language-specific major modes to bind @key{TAB} and
2232 @kbd{C-j} (the line feed) keys to various formatting functions. This is
2233 extremely useful, but may require some getting used to for a Vi user. If you
2234 decide that this feature is not for you, you can re-bind these keys as
2235 explained earlier (@pxref{Customization}).
2237 Binding for @key{TAB} is one of the most unusual aspects of Viper for many
2238 novice users. In Emacs, @key{TAB} is used to format text and programs, and
2239 is extremely useful. For instance, hitting @key{TAB} causes the current
2240 line to be re-indented in accordance with the context. In programming,
2241 this is very important, since improper automatic indentation would
2242 immediately alert the programmer to a possible error. For instance, if a
2243 @kbd{)} or a @kbd{"} is missing somewhere above the current
2244 line, @key{TAB} is likely to mis-indent the line.
2246 For this reason, Viper doesn't change the standard Emacs binding of
2247 @key{TAB}, thereby sacrificing Vi compatibility
2248 (except for users at level 1). Instead, in Viper, the key
2249 @kbd{S-tab} (shift+ tab) is chosen to emulate Vi's @key{TAB}.
2251 We should note that on some non-windowing terminals, Shift doesn't modify
2252 the @key{TAB} key, so @kbd{S-tab} behaves as if it were @key{TAB}. In such
2253 a case, you will have to bind @code{viper-insert-tab} to some other
2256 Some packages, notably Dired, Gnus, Info, etc., attach special meaning to
2257 common keys like @key{SPC}, @kbd{x}, @kbd{d}, @kbd{v}, and others. This
2258 means that Vi command state is inappropriate for working with these
2259 packages. Fortunately, these modes operate on read-only buffers and are
2260 designed not for editing files, but for special-purpose browsing, reading
2261 news, mail, etc., and Vi commands are meaningless in these situations. For
2262 this reason, Viper doesn't force Vi state on such major modes---it
2263 brings them in Emacs state. You can switch to Vi state by typing @kbd{C-z}
2264 if, for instance, you want to do Vi-style search in a buffer (although,
2265 usually, incremental search, which is bound to @kbd{C-s}, is sufficient in
2266 these situations). But you should then switch back to Emacs state if you
2267 plan to continue using these major modes productively. You can also switch
2268 to Vi temporarily, to execute just one command. This is done by typing
2269 @kbd{C-c \}. (In some of these modes, @kbd{/} and @kbd{:} are bound
2270 Vi-style, unless these keys perform essential duties.)
2272 If you would like certain major modes to come up in Emacs state rather than
2273 Vi state (but Viper thinks otherwise), you should put these major modes
2274 on the @code{viper-emacs-state-mode-list} list and delete them from
2275 @code{viper-vi-state-mode-list}.
2276 Likewise, you can force Viper's Insert state on a major mode by putting it
2277 in @code{viper-insert-state-mode-list}.
2278 @vindex @code{viper-emacs-state-mode-list}
2279 @vindex @code{viper-insert-state-mode-list}
2280 @vindex @code{viper-vi-state-mode-list}
2282 It is also possible to impose Vi on some major modes, even though they may
2283 bind common keys to specialized commands. This might make sense for modes
2284 that bind only a small number of common keys. For instance, Viper subverts
2285 the Shell mode by changing the bindings for @kbd{C-m} and @kbd{C-d} using
2286 @code{viper-add-local-keys} described in section on customization
2287 (@pxref{Customization}).
2289 In some cases, some @emph{minor} modes might override certain essential
2290 bindings in Vi command state. This is not a big priblem because this
2291 can happen only in the beginning, when the minor mode kicks in. Typing
2292 @code{M-x viper-mode} will correct the situation. Viper knows about
2293 several such minor modes and takes care of them, so the above trick
2294 is usually not necessary. If you find that some minor mode, e.g.,
2295 @code{nasty-mode.el} interferes with Viper, putting the following in
2296 @file{.viper} should fix the problem:
2298 (viper-harness-minor-mode "nasty-mode")
2301 The argument to @code{viper-harness-minor-mode} is the name of the file for the
2302 offending minor mode with the suffixes @file{.el} and @file{.elc} removed.
2304 It may not be always obvious which minor mode is at fault. The only
2305 guidance here is to look into the file that defines the minor mode you are
2306 suspecting, say @code{nasty-mode.el}, and see if it has a variable called
2307 @code{nasty-mode-map}. Then check if there is a statement of the form
2309 (define-key nasty-mode-map key function)
2312 that binds the misbehaving
2313 keys. If so, use the above line to harness @code{nasty-mode}. If your
2314 suspicion is wrong, no harm is done if you harness a minor mode that
2315 doesn't need to be harnessed.
2317 @vindex @code{viper-want-emacs-keys-in-vi}
2318 @vindex @code{viper-want-emacs-keys-in-insert}
2319 @vindex @code{viper-always}
2320 @findex @code{viper-set-hooks}
2321 @findex @code{viper-mode}
2322 @findex @code{viper-harness-minor-mode}
2323 @findex @code{remove-hook}
2324 @findex @code{add-hook}
2326 @node Viper Specials,Vi Macros,Packages that Change Keymaps,Customization
2327 @section Viper Specials
2329 Viper extends Vi with a number of useful features. This includes various
2330 search functions, histories of search strings, Ex commands, insertions, and
2331 Vi's destructive commands. In addition, Viper supports file name completion
2332 and history, completion of Ex commands and variables, and many other
2333 features. Some of these features are explained in detail elsewhere in this
2334 document. Other features are explained here.
2337 @item (viper-buffer-search-enable)
2338 @item viper-buffer-search-char nil
2339 Enable buffer search. Explicit call to @code{viper-buffer-search-enable}
2340 sets @code{viper-buffer-search-char} to @kbd{g}. Alternatively, the user can
2341 set @code{viper-buffer-search-char} in @file{.viper} to a key sequence
2342 to be used for buffer search. There is no need to call
2343 @code{viper-buffer-search-enable} in that case.
2344 @findex @code{viper-buffer-search-enable}
2345 @vindex @code{viper-buffer-search-char}
2346 @item viper-toggle-search-style
2347 This function, bound to @kbd{C-c /}, lets one toggle case-sensitive and
2348 case-insensitive search, and also switch between plain vanilla search and
2349 search via regular expressions. Without the prefix argument, the user is
2350 asked which mode to toggle. With prefix argument 1, this toggles
2351 case-sensitivity. With prefix argument 2, regular expression/vanilla search
2354 However, we found that the most convenient way to toggle
2355 these options is to bind a Vi macro to
2356 bind @kbd{//} to toggles case sensitivity and to @kbd{///} to toggles
2357 vanilla search. Thus, quickly hitting @kbd{/} twice will switch Viper from
2358 case sensitive search to case-insensitive. Repeating this once again will
2359 restore the original state. Likewise, quickly hitting @kbd{/} three times
2360 will switch you from vanilla-style search to search via regular expressions.
2361 If you hit something other than @kbd{/} after the first @kbd{/} or if the
2362 second @kbd{/} doesn't follow quickly enough, then Viper will issue the
2363 usual prompt @kbd{/} and will wait for input, as usual in Vi.
2364 If you don't like this behavior, you can ``unrecord'' these macros in your
2365 @file{~/.viper} file. For instance, if you don't like the above feature, put
2366 this in @file{~/.viper}:
2368 (viper-set-searchstyle-toggling-macros 'undefine)
2370 @findex @code{viper-set-searchstyle-toggling-macros}
2372 @item Vi-isms in Emacs state
2373 Some people find it useful to use the Vi-style search key, `/', to invoke
2374 search in modes which Viper leaves in emacs-state. These modes are:
2375 @code{dired-mode}, @code{mh-folder-mode}, @code{gnus-group-mode},
2376 @code{gnus-summary-mode}, @code{Info-mode}, and @code{Buffer-menu-mode}
2377 (more may be added in the future). So, in the above modes, Viper binds `/'
2378 so that it will behave Vi-style. Furthermore, in those major modes, Viper
2379 binds `:' to invoke ex-style commands, like in vi-state. And, as described
2380 above, `//' and `///' get bound to Vi-style macros that toggle
2381 case-insensitivity and regexp-search.
2383 If you don't like these features---which I don't really understand---you
2384 can unbind `/' and `:' in @code{viper-dired-modifier-map} (for Dired) or in
2385 @code{viper-slash-and-colon-map}, for other modes.
2386 @vindex @code{viper-slash-and-colon-map}
2387 @vindex @code{viper-dired-modifier-map}
2389 To unbind the macros `//' and `///' for a major mode where you feel they
2390 are undesirable, execute @code{viper-set-emacs-state-searchstyle-macros} with a
2391 non-nil argument. This can be done either interactively, by supplying a
2392 prefix argument, or by placing
2394 (viper-set-emacs-state-searchstyle-macros 'undefine)
2396 @findex @code{viper-set-emacs-state-searchstyle-macros}
2397 in the hook to the major mode (e.g., @code{dired-mode-hook}).
2398 @xref{Vi Macros}, for more information on Vi macros.
2400 @item viper-heading-start
2401 @item viper-heading-end
2406 Regular Expressions for @kbd{[[} and @kbd{]]}. Note that Emacs defines
2407 Regexps for paragraphs and sentences. @xref{Paragraphs,,Paragraphs and
2408 Sentences,emacs,The GNU Emacs Manual}, for details.
2409 @item M-x viper-set-expert-level
2410 @findex @code{viper-set-expert-level}
2411 Change your user level interactively.
2412 @item viper-smart-suffix-list '("" "tex" "c" "cc" "el" "p")
2413 @vindex @code{viper-smart-suffix-list}
2414 Viper supports Emacs-style file completion when it prompts the user for a
2415 file name. However, in many cases, the same directory may contain files
2416 with identical prefix but different suffixes, e.g., prog.c, prog.o,
2417 paper.tex, paper.dvi. In such cases, completion will stop at the `.'.
2418 If the above variable is a list of strings representing suffixes, Viper will
2420 in the order listed and will check if the corresponding file exists.
2422 For instance, if completion stopped at `paper.'@: and the user typed
2424 then Viper will check if the files `paper.', `paper.tex', `paper.c', etc., exist.
2425 It will take the first such file. If no file exists, Viper will give a chance
2426 to complete the file name by typing the appropriate suffix. If `paper.'@: was
2427 the intended file name, hitting return will accept it.
2429 To turn this feature off, set the above variable to @code{nil}.
2431 @item viper-insertion-ring-size 14
2432 @vindex @code{viper-insertion-ring-size}
2433 @cindex Insertion ring
2434 Viper remembers what was previously inserted in Insert and Replace states.
2435 Several such recent insertions are kept in a special ring of strings of size
2436 @code{viper-insertion-ring-size}.
2437 If you enter Insert or Replace state you can reinsert strings from this
2438 ring by typing @kbd{C-c M-p} or @kbd{C-c M-n}. The former will search the
2440 the direction of older insertions, and the latter will search in
2441 the direction of newer insertions. Hitting @kbd{C-c M-p} or @kbd{C-c M-n}
2443 will undo the previous insertion from the ring and insert the next item on
2444 the ring. If a larger ring size is needed, change the value of the above
2445 variable in the @file{~/.viper} file.
2447 Since typing these sequences of keys may be tedious, it is suggested that the
2448 user should bind a function key, such as @kbd{f31}, as follows:
2450 (define-key viper-insert-global-user-map [f31]
2451 'viper-insert-prev-from-insertion-ring)
2453 This binds @kbd{f31} (which is usually @kbd{R11} on a Sun workstation)
2454 to the function that inserts the previous string in the insertion history.
2455 To rotate the history in the opposite
2456 direction, you can either bind an unused key to
2457 @code{viper-insert-next-from-insertion-ring} or hit any digit (1 to 9) then
2460 One should not bind the above functions to @kbd{M-p} or @kbd{M-n}, since
2461 this will interfere with the Minibuffer histories and, possibly, other
2464 @item viper-command-ring-size 14
2465 @vindex @code{viper-command-ring-size}
2466 @cindex Destructive command ring
2467 @cindex Destructive command history
2468 Viper keeps track of the recent history of destructive
2469 commands, such as @kbd{dw}, @kbd{i}, etc.
2471 the most recent command can be re-executed by hitting `@kbd{.}', as in Vi.
2472 However, repeated typing @kbd{C-c M-p} will cause Viper to show the
2473 previous destructive commands in the minibuffer. Subsequent hitting `@kbd{.}'
2474 will execute the command that was displayed last.
2475 The key @kbd{C-c M-n} will cycle through the command history in the
2477 Since typing @kbd{C-c M-p} may be tedious, it is more convenient to bind an
2478 appropriate function to an unused function key on the keyboard and use that
2479 key. For instance, the following
2481 (define-key viper-vi-global-user-map [f31]
2482 'viper-prev-destructive-command)
2484 binds the key @kbd{f31} (which is usually @kbd{R11} on a Sun workstation)
2485 to the function that searches the command history in the direction of older
2486 commands. To search in the opposite
2487 direction, you can either bind an unused key to
2488 @code{viper-next-destructive-command} or hit any digit (1 to 9) then @kbd{f31}.
2490 One should not bind the above functions to @kbd{M-p} or @kbd{M-n}, since
2491 this will interfere with the Minibuffer histories and, possibly, other
2494 @item viper-minibuffer-vi-face 'viper-minibuffer-vi-face
2495 @item viper-minibuffer-insert-face 'viper-minibuffer-insert-face
2496 @item viper-minibuffer-emacs-face 'viper-minibuffer-emacs-face
2497 These faces control the appearance of the minibuffer text in the
2498 corresponding Viper states. You can change the appearance of these faces
2499 through Emacs' customization widget, which is accessible through the
2502 Viper is located in this widget under the @emph{Emulations} customization
2503 subgroup of the @emph{Editing} group. All Viper faces are grouped together
2504 in Viper's @emph{Highlighting} customization subgroup.
2506 Note that only the text you type in is affected by the above faces.
2507 Prompts and Minibuffer messages are not affected.
2509 Purists who do not like adornments in the minibuffer can always zap them by
2512 (copy-face 'default 'viper-minibuffer-vi-face)
2513 (copy-face 'default 'viper-minibuffer-insert-face)
2514 (copy-face 'default 'viper-minibuffer-emacs-face)
2516 in the @file{~/.viper} file or through the customization widget, as
2517 described above. However, in that case, the user will not have any
2518 indication of the current Viper state in the minibuffer. (This is important
2519 if the user accidentally switches to another Viper state by typing @key{ESC} or
2521 @item M-x viper-go-away
2522 @findex @code{viper-go-away}
2523 Make Viper disappear from the face of your running Emacs instance. If your
2524 fingers start aching again, @kbd{M-x viper-mode} might save your day.
2525 @item M-x toggle-viper-mode
2526 @findex @code{toggle-viper-mode}
2527 Toggle Viperization of Emacs on and off.
2530 @cindex Multifile documents and programs
2532 Viper provides some support for multi-file documents and programs.
2533 If a document consists of several files we can designate one of them as a
2534 master and put the following at the end of that file:
2536 ;;; Local Variables:
2537 ;;; eval: (viper-setup-master-buffer "file1" "file2" "file3" "file4")
2541 where @code{file1} to @code{file4} are names of files related to the master
2542 file. Next time, when the master file is visited, the command
2543 @code{viper-setup-master-buffer} will be evaluated and the above files will
2544 be associated with the master file. Then, the new Ex command
2545 @kbd{:RelatedFile} (abbr.@: @kbd{:R}) will display files 1 to 4 one after
2546 another, so you can edit them. If a file is not in any Emacs buffer, it
2547 will be visited. The command @kbd{PreviousRelatedFile} (abbr., @kbd{:P})
2548 goes through the file list in the opposite direction.
2549 @findex @kbd{:RelatedFile}
2550 @findex @kbd{:PreviousRelatedFile}
2552 These commands are akin to @kbd{:n} and @kbd{:N}, but they allow the user to
2553 focus on relevant files only.
2555 Note that only the master file needs to have the aforementioned block of
2556 commands. Also, ";;;" above can be replaced by some other
2557 markers. Semicolon is good for Lisp programs, since it is considered a
2558 comment designator there. For LaTeX, this could be "%%%", and for C the
2559 above block should be commented out.
2561 Even though these commands are sometimes useful, they are no substitute for
2562 the powerful @emph{tag table} facility of Emacs. Viper's @kbd{:tag} command
2563 in a primitive interface to Emacs tags. @xref{Tags,Tags,Tags,emacs,
2564 The Gnu Emacs Manual}, for more information on tags.
2566 The following two commands are normally bound to a mouse click and are part
2567 of Viper. They work only if Emacs runs as an application under X
2568 Windows (or under some other window system for which a port of GNU Emacs 20
2569 is available). Clicking the mouse when Emacs is invoked in an Xterm window
2570 (using @code{emacs -nw}) will do no good.
2574 @cindex mouse-search
2575 @item viper-mouse-search-key (meta shift 1)
2576 @vindex @code{viper-mouse-insert-key}
2577 This variable controls the @emph{mouse-search} feature of Viper. The
2579 states that holding Meta and Shift keys while clicking mouse button 1
2580 should initiate search for a region under the mouse pointer (defined
2581 below). This command can take a prefix argument, which indicates the
2582 occurrence of the pattern to search for.
2584 Note: while loading initially, Viper binds this mouse action only if it is
2585 not already bound to something else. If you want to use the mouse-search
2586 feature, and the @kbd{Meta-Shift-Mouse-1} mouse action is already bound to
2587 something else, you can rebind the mouse-search feature by setting
2588 @code{viper-mouse-search-key} to something else in your @code{~/.viper}
2591 (setq viper-mouse-search-key '(meta 1))
2593 This would bind mouse search to the action invoked by pressing the
2594 Meta key and clicking mouse button 1. The allowed values of
2595 @code{viper-mouse-search-key} are lists that contain a mouse-button number
2596 (1,2, or 3) and any combination of the words `control', `meta', and
2599 If the requested mouse action (e.g., (meta 1)) is already taken for other
2600 purposes then you have to confirm your intention by placing the following
2601 command in @code{~/.viper} after setting @code{viper-mouse-search-key}:
2603 (viper-bind-mouse-search-key 'force)
2606 You can also change this setting interactively, through the customization
2607 widget of Emacs (choose option "Customize.Customize Group" from the
2610 The region that is chosen as a pattern to search for is determined as
2611 follows. If search is invoked via a single click, Viper chooses the region
2612 that lies between the beginning of the ``word'' under the pointer (``word''
2613 is understood in Vi sense) and the end of that word. The only difference
2614 with Vi's words is that in Lisp major modes `-' is considered an
2615 alphanumeric symbol. This is done for the convenience of working with Lisp
2616 symbols, which often have an `-' in them. Also, if you click on a
2617 non-alphanumeric character that is not a word separator (in Vi sense) then
2618 this character will also be considered alphanumeric, provided that it is
2619 adjacent (from either side) to an alphanumeric character. This useful
2620 feature gives added control over the patterns selected by the mouse click.
2622 On a double-click, the region is determined by the beginning of the current
2623 Vi's ``Word'' (i.e., the largest non-separator chunk of text) and the End
2624 of that ``Word'' (as determined by the @kbd{E} command).
2626 On a triple-click, the region consists of the entire line where the click
2627 occurred with all leading and trailing spaces and tabs removed.
2629 @cindex mouse-insert
2630 @item viper-mouse-insert-key (meta shift 2)
2631 @vindex @code{viper-mouse-insert-key}
2632 This variable controls the @emph{mouse-insert} feature of Viper.
2633 The above default value states that
2634 holding Meta and Shift keys while clicking mouse button 2
2635 should insert the region surrounding the
2636 mouse pointer. The rules defining this region are the same as for
2637 mouse-search. This command takes an optional prefix argument, which
2638 indicates how many such regions to snarf from the buffer and insert. (In
2639 case of a triple-click, the prefix argument is ignored.)
2641 Note: while loading initially, Viper binds this mouse action only if it not
2642 already bound to something else. If you want to use this feature and the
2643 default mouse action is already bound, you can rebind mouse-insert by
2644 placing this command in @code{~/.viper}:
2646 (setq viper-mouse-insert-key '(meta 2))
2648 If you want to bind mouse-insert to an action even if this action is
2649 already taked for other purposes in Emacs, then you should add this command
2650 to @code{~/.viper}, after setting @code{viper-mouse-insert-key}:
2652 (viper-bind-mouse-insert-key 'force)
2655 This value can also be changed via the Emacs customization widget at the
2658 @item viper-multiclick-timeout
2659 This variable controls the rate at which double-clicking must occur for the
2660 purpose of mouse search and mouse insert. By default, this is set to
2661 @code{double-click-time} in Emacs and to
2662 @code{mouse-track-multi-click-time} milliseconds in XEmacs.
2664 @kindex @kbd{S-Mouse-1}
2665 @kindex @kbd{S-Mouse-2}
2666 @kindex @kbd{meta shift button1up}
2667 @kindex @kbd{meta shift button2up}
2668 @vindex @code{viper-multiclick-timeout}
2669 @findex @code{viper-mouse-click-insert-word}
2670 @findex @code{viper-mouse-click-search-word}
2672 Note: The above functions search and insert in the selected window of
2673 the latest active frame. This means that you can click in another window or
2674 another frame and have search or insertion done in the frame and window you
2675 just left. This lets one use these functions in a multi-frame
2676 configuration. However, this may require some getting used to. For
2677 instance, if you are typing in a frame, A, and then move the mouse to frame
2678 B and click to invoke mouse search, search (or insertion) will be performed
2679 in frame A. To perform search/insertion in frame B, you will first have to
2680 shift focus there, which doesn't happen until you type a character or
2681 perform some other action in frame B---mouse search doesn't shift focus.
2683 If you decide that you don't like the above feature and always want
2684 search/insertion be performed in the frame where the click occurs, don't
2685 bind (and unbind, if necessary) @code{viper-mouse-catch-frame-switch} from
2686 the mouse event it is bound to.
2688 Mouse search is integrated with Vi-style search, so you can
2689 repeat it with @kbd{n} and @kbd{N}. It should be also noted that, while
2690 case-sensitivity of search in Viper is controlled by the variable
2691 @code{viper-case-fold-search}, the case of mouse search is
2692 controlled by the Emacs variable @code{case-fold-search}, which may be set
2693 differently from @code{viper-case-fold-search}. Therefore, case-sensitivity
2694 of mouse search may be different from that of the usual Vi-style search.
2696 Finally, if the way Viper determines the word to be searched for or to be
2697 inserted is not what you want, there is a variable,
2698 @code{viper-surrounding-word-function}, which can be changed to indicate
2699 another function for snarfing words out of the buffer. The catch is that
2700 you will then have to write such a function and make it known to your
2701 Emacs. The function @code{viper-surrounding-word} in @file{viper.el} can be
2702 used as a guiding example.
2704 @node Vi Macros, ,Viper Specials,Customization
2709 Viper supports much enhanced Vi-style macros and also facilitates the use
2710 of Emacs-style macros. To define a temporary macro, it is generally more
2711 convenient to use Emacs keyboard macro facility. Emacs keyboard macros are
2712 usually defined anonymously, and the latest macro can be executed by typing
2713 @kbd{C-x e} (or @kbd{*}, if Viper is in Vi state). If you need to use several
2714 temporary macros, Viper lets you save them to a
2715 register (a lowercase letter); such macros can then be executed by typing
2716 @kbd{@@a} in Vi state (if a macro was previously saved in register
2718 @xref{Macros and Registers}, for details.
2720 If, however, you need to use a macro regularly, it must be given a
2721 permanent name and saved. Emacs manual explains how to do this, but
2722 invocation of named Emacs macros is quite different from Vi's. First,
2723 invocation of permanent Emacs macros takes time because of the extra keys.
2724 Second, binding such macros to function keys, for
2725 fast access, hogs valuable real estate on the keyboard.
2727 Vi-style macros are better in that respect, since Vi lets the user overload
2728 the meaning of key sequences: keys typed in fast succession are treated
2729 specially, if this key sequence is bound to a macro.
2731 Viper provides keyboard macros through the usual Ex commands, @kbd{:map} and
2732 @kbd{:map!}. Vi-style macros are much more powerful in Viper than
2733 they are in the original Vi and in other emulators. This is because Viper
2734 implements an enhanced vi-style
2735 interface to the powerful Emacs keyboard macro facility.
2738 command can be executed while defining a macro, not just the Vi
2739 commands. In particular, the user can invoke Emacs commands via @kbd{M-x
2740 command-name} or by pressing various function keys on the keyboard. One
2741 can even use the mouse, although this is usually not useful and is not
2742 recommended (and macros defined with the use of the mouse cannot be saved in
2743 command history and in the startup file, for future use).
2745 Macros defined by mixing Vi and Emacs commands are represented as
2746 vectors. So, don't be confused when you see one (usually through the
2747 history of Ex commands). For instance, if @kbd{gg} is defined by typing
2748 @kbd{l}, the up-arrow key and @kbd{M-x next-line}, its definition will look
2749 as follows in Emacs:
2752 [l up (meta x) n e x t - l i n e return]
2755 Second, Viper macros are defined in a WYSIWYG style. This means that
2756 commands are executed as you type them, so you can see precisely what is
2757 being defined. Third, macros can be bound to arbitrary sequences of keys,
2758 not just to printable keys. For instance, one can define a macro that will
2759 be invoked by hitting @kbd{f3} then @kbd{f2} function keys. (The keys
2760 @kbd{delete} and @kbd{backspace} are excluded; also, a macro invocation
2761 sequence can't start with @key{ESC}. Some other keys, such as @kbd{f1} and
2762 @kbd{help}, can't be bound to macros under Emacs, since they
2763 are bound in @code{key-translation-map}, which overrides any other binding
2764 the user gives to keys. In general, keys that have a binding in
2765 @code{key-translation-map} can't be bound to a macro.)
2767 Fourth, in Viper, one can define macros that are specific to a given
2768 buffer, a given major mode, or macros that are defined for all buffers. In
2769 fact, the same macro name can have several different definitions: one
2770 global, several definitions for various major modes, and
2771 definitions for various specific buffers. Buffer-specific definitions
2772 override mode-specific definitions, which, in turn, override global
2775 As if all that is not enough, Viper (through its interface to Emacs
2776 macros) lets the user define keyboard macros that ask for confirmation or
2777 even prompt the user for input and then continue. To do this, one should
2778 type @kbd{C-x q} (for confirmation) or @kbd{C-u C-x q} (for prompt).
2779 For details, @pxref{Kbd Macro Query,,Customization,emacs,The GNU Emacs
2782 When the user finishes defining a macro (which is done by typing @kbd{C-x)} ---
2783 a departure from Vi), you will be asked whether you want this
2784 macro to be global, mode-specific, or buffer-specific. You will also be
2785 given a chance to save the macro in your @file{~/.viper} file.
2786 This is the easiest way to save a macro and make
2787 it permanently available. If you work your startup files with bare hands,
2788 here is how Viper saves the above macro so that it will be
2789 available in Viper's Insert state (and Replace state) in buffer @code{my-buf}
2793 (viper-record-kbd-macro "gg" 'insert-state
2794 [l up (meta x) n e x t - l i n e return]
2799 To do the same for Vi state and all buffers with the major mode
2800 @code{cc-mode}, use:
2803 (viper-record-kbd-macro "gg" 'vi-state
2804 [l up (meta x) n e x t - l i n e return]
2809 Both macro names and macro definitions are vectors of symbols that denote
2810 keys on the keyboard. Some keys, like @kbd{\}, @kbd{ }, or digit-keys must
2811 be escaped with a backslash. Modified keys are represented as lists. For
2812 instance, holding Meta and Control and pressing @kbd{f4} is represented as
2813 @kbd{(control meta f4)}.
2814 If all members of a vectors are printable characters (or sequences, such as
2815 @kbd{\e}, @kbd{\t}, for @key{ESC} and @key{TAB}), then they can also be represented as
2819 (viper-record-kbd-macro "aa" 'vi-state "aaa\e" "my-buffer")
2823 Thus, typing @kbd{aa} fast in Vi state will switch Viper to Insert state
2824 (due to the first @kbd{a}), insert @kbd{aa}, and then it will switch back to Vi
2825 state. All this will take effect only in the buffer named @code{my-buffer}.
2827 Note that the last argument to @code{viper-record-kbd-macro} must be either a
2828 string (a buffer name), a symbol representing a major mode, or @code{t};
2829 the latter says that the macro is to be defined for all buffers
2830 (which is how macros are defined in original Vi).
2832 For convenience, Viper also lets you define Vi-style macros in its Emacs
2833 state. There is no Ex command, like @kbd{:map} and @kbd{:map!} for doing
2834 this, but the user can include such a macro in the @file{~/.viper} file. The
2835 only thing is that the @code{viper-record-kbd-macro} command should specify
2836 @code{emacs-state} instead of @code{vi-state} or @code{insert-state}.
2838 The user can get rid of a macro either by using the Ex commands @kbd{:unmap}
2839 and @kbd{:unmap!} or by issuing a call to @code{viper-unrecord-kbd-macro}.
2840 The latter is more powerful, since it can delete macros even in
2841 @code{emacs-state}. However, @code{viper-unrecord-kbd-macro} is usually
2842 needed only when the user needs to get rid of the macros that are already
2843 predefined in Viper.
2845 @findex @code{viper-unrecord-kbd-macro}
2847 (viper-unrecord-kbd-macro macro state)
2850 The second argument must be @code{vi-state}, @code{insert-state}, or
2851 @code{emacs-state}. The first argument is a name of a macro. To avoid
2852 mistakes in specifying names of existing macros, type @kbd{M-x
2853 viper-describe-kbd-macros} and use a name from the list displayed by this
2856 If an error occurs during macro definition, Emacs
2857 aborts the process, and it must be repeated. This is analogous to Vi,
2858 except that in Vi the user doesn't know there is an error until the macro is
2859 actually run. All that means that in order for a definition to be
2860 successful, the user must do some simple planning of the process in
2861 advance, to avoid errors. For instance, if you want to map @kbd{gg} to
2862 @kbd{llll} in Vi state, you must make sure that there is enough room on the
2863 current line. Since @kbd{l} moves the cursor forward, it may signal an
2864 error on reaching the end of line, which will abort the definition.
2866 These precautions are necessary only when defining macros; they will help
2867 avoid the need to redo the job. When macros are actually run, an error
2868 during the execution will simply terminate the current execution
2869 (but the macro will remain mapped).
2871 A macro name can be a string of characters or a vector of keys.
2872 The latter makes it possible to define macros bound to, say, double-hits
2873 on a function key, such as @kbd{up} or @kbd{f13}.
2874 This is very useful if you run out of function keys on your keyboard; it
2875 makes Viper macro facility a @emph{keyboard doubler}, so to speak.
2877 Elsewhere (@xref{Keybindings}, for details), we review
2878 the standard Emacs mechanism for binding function keys to commands.
2882 (global-set-key [f13] 'repeat-complex-command)
2886 binds the key f13 to the Emacs function that repeats the last minibuffer
2887 command. Under Viper, however, you may still use this key for additional
2888 purposes, if you bind, say, a double-hitting action for that key to some
2889 other function. Emacs doesn't allow the user to do that, but Viper does
2890 this through its keyboard macro facility. To do this, type @kbd{:map }
2891 first. When you are asked to enter a macro name, hit f13 twice, followed by
2892 @key{RET} or @key{SPC}.
2894 Emacs will now start the mapping process by actually executing
2895 Vi and Emacs commands, so that you could see what will happen each time the
2896 macro is executed. Suppose now we wanted to bind the key sequence
2897 @kbd{f13 f13} to the command @code{eval-last-sexp}. To accomplish this, we
2898 can type @kbd{M-x eval-last-sexp} followed by @kbd{C-x )}.
2899 If you answer positively to Viper's offer to save this macro in @file{~/.viper}
2900 for future uses, the following will be inserted in that file:
2903 (viper-record-kbd-macro [f16 f16] 'vi-state
2904 [(meta x) e v a l - l a s t - s e x p]
2905 'lisp-interaction-mode)
2908 To illustrate the above point, Viper provides two canned macros, which, by
2909 default, are bound to @kbd{[f12 \1]} and @kbd{[f12 \2]} (invoked by typing
2910 @kbd{f12} then @kbd{1} and @kbd{2}, respectively). These macros are useful
2911 shortcuts to Viper's command ring history. The first macro will execute the
2912 second-last destructive command (the last one is executed by @kbd{.}, as
2913 usual). The second macro executes the third-last command.
2915 If you need to go deeper into the command history, you will have to use
2916 other commands, as described earlier in this section; or you can bind,
2917 say, @kbd{f12 \3} like this:
2920 (viper-record-kbd-macro [f12 \3] 'vi-state
2921 [(meta x) r e p e a t - f r o m - h i s t o r y]
2926 Note that even though the macro uses the function key @kbd{f12}, the key is
2927 actually free and can still be bound to some Emacs function via
2928 @code{define-key} or @code{global-set-key}.
2931 Viper allows the user to define macro names that are prefixes of other macros.
2932 For instance, one can define @kbd{[[} and @kbd{[[[[} to be macros.
2933 If you type the exact sequence of such keys and then pause, Viper will
2934 execute the right macro. However, if you don't pause and, say, type
2935 @kbd{[[[[text} then the conflict is resolved as follows. If only one of the
2936 key sequences, @kbd{[[} or @kbd{[[[[} has a definition applicable to the
2937 current buffer, then, in fact, there is no conflict and the right macro
2938 will be chosen. If both have applicable definitions, then the first one
2939 found will be executed. Usually this is the macro with a shorter name. So,
2940 in our case, @kbd{[[[[text} will cause the macro @kbd{[[} to be executed
2941 twice and then the remaining keys, @kbd{t e x t}, will be processed.
2943 When defining macros using @kbd{:map} or @kbd{:map!}, the user enters
2944 the actually keys to be used to invoke the macro. For instance, you
2945 should hit the actual key @kbd{f6} if it is to be part of a macro
2946 name; you do @emph{not} write @kbd{f 6}. When entering keys, Viper
2947 displays them as strings or vectors (e.g., @code{"abc"} or @code{[f6
2948 f7 a]}). The same holds for unmapping. Hitting @key{TAB} while
2949 typing a macro name in the @kbd{:unmap} or @kbd{:unmap!} command will
2950 cause name completion. Completions are displayed as strings or
2951 vectors. However, as before, you don't actually type @samp{"},
2952 @samp{[}, or @samp{]} that appear in the completions. These are
2953 meta-symbols that indicate whether the corresponding macro name is a
2956 One last difference from Vi: Vi-style keyboard macros cannot be defined in
2957 terms of other Vi-style keyboard macros (but named Emacs macros are OK).
2958 More precisely, while defining or executing a macro, the special meaning
2959 of key sequences (as Vi macros) is ignored.
2960 This is because it is all too easy to create an infinite loop in this way.
2961 Since Viper macros are much more powerful than Vi's it is impossible to
2962 detect such loops. In practice, this is not really a limitation but,
2965 We should also note that Vi macros are disabled in the Minibuffer, which
2966 helps keep some potential troubles away.
2968 The rate at which the user must type keys in order for them to be
2969 recognized as a timeout macro is controlled by the variable
2970 @code{viper-fast-keyseq-timeout}, which defaults to 200 milliseconds.
2972 For the most part, Viper macros defined in @file{~/.viper} can be shared
2973 between X and TTY modes.
2974 The problem with TTY may be that the function keys there generate sequences
2975 of events instead of a single event (as under a window system).
2976 Emacs maps some of these sequences back to the logical keys
2977 (e.g., the sequences generated by the arrow keys are mapped to @kbd{up},
2978 @kbd{left}, etc.). However, not all function keys are mapped in this way.
2979 Macros that are bound to key sequences that contain such unmapped function
2980 keys have to be redefined for TTY's (and possibly for every type of TTY you
2981 may be using). To do this, start Emacs on an appropriate TTY device and
2982 define the macro using @kbd{:map}, as usual.
2984 @findex @code{viper-describe-kbd-macros}
2985 Finally, Viper provides a function that conveniently displays all macros
2986 currently defined. To see all macros along with their definitions, type
2987 @kbd{M-x viper-describe-kbd-macros}.
2989 @node Commands,,Customization,Top
2992 This section is a semi-automatically bowdlerized version of the Vi
2993 reference created by @* @samp{maart@@cs.vu.nl} and others. It can be
2994 found on the Vi archives. This reference has been adapted for Viper.@refill
2997 * Groundwork:: Textual Conventions and Viper basics
2998 * Text Handling:: Moving, Editing, Undoing.
2999 * Display:: Scrolling.
3000 * File and Buffer Handling:: Editing, Writing and Quitting.
3001 * Mapping:: Mapping Keys, Keyboard Macros
3002 * Shell Commands:: Accessing Shell Commands, Processing Text
3003 * Options:: Ex options, the @kbd{:set} commands
3004 * Emacs Related Commands:: Meta Keys, Windows
3005 * Mouse-bound Commands:: Search and insertion of text
3008 @node Groundwork, Text Handling, Commands, Commands
3009 @comment node-name, next, previous, up
3012 The VI command set is based on the idea of combining motion commands
3013 with other commands. The motion command is used as a text region
3014 specifier for other commands.
3015 We classify motion commands into @dfn{point commands} and
3016 @dfn{line commands}.@refill
3018 @cindex point commands
3020 The point commands are:
3023 @kbd{h}, @kbd{l}, @kbd{0}, @kbd{$}, @kbd{w}, @kbd{W}, @kbd{b}, @kbd{B},
3024 @kbd{e}, @kbd{E}, @kbd{(}, @kbd{)}, @kbd{/}, @kbd{?}, @kbd{`}, @kbd{f},
3025 @kbd{F}, @kbd{t}, @kbd{T}, @kbd{%}, @kbd{;}, @kbd{,}, @kbd{^}
3028 @cindex line commands
3030 The line commands are:
3033 @kbd{j}, @kbd{k}, @kbd{+}, @kbd{-}, @kbd{H}, @kbd{M}, @kbd{L}, @kbd{@{},
3034 @kbd{@}}, @kbd{G}, @kbd{'}, @kbd{[[}, @kbd{]]}, @kbd{[]}
3038 Text Deletion Commands (@pxref{Deleting Text}), Change commands
3039 (@pxref{Changing Text}), even Shell Commands (@pxref{Shell Commands})
3040 use these commands to describe a region of text to operate on.
3042 @cindex r and R region specifiers
3044 Viper adds two region descriptors, @kbd{r} and @kbd{R}. These describe
3045 the Emacs regions (@pxref{Basics}), but they are not movement commands.
3047 The command description uses angle brackets @samp{<>} to indicate
3048 metasyntactic variables, since the normal conventions of using simple
3049 text can be confusing with Viper where the commands themselves are
3050 characters. Watch out where @kbd{<} shift commands and @kbd{<count>} are
3051 mentioned together!!!
3061 @samp{<move>} refers to the above movement commands, and @samp{<a-z>}
3062 refers to registers or textmarkers from @samp{a} to @samp{z}. Note
3063 that the @samp{<move>} is described by full move commands, that is to
3064 say they will take counts, and otherwise behave like normal move commands.
3065 @cindex Ex addresses
3066 @samp{<address>} refers to Ex line addresses, which include
3069 @item .@: <No address>
3072 Add or subtract for current line
3074 Actual line number, use @kbd{.=} to get the line number
3080 Where x and y are one of the above
3082 @cindex % (Ex address)
3083 For the whole file, same as (1,$).
3086 Next or previous line with pattern <pat>.
3088 Note that the pattern is allowed to contain newline character (inserted as
3089 @kbd{C-qC-j}). Therefore, one can search for patterns that span several
3093 @cindex % (Current file)
3094 Note that @samp{%} is used in Ex commands @kbd{:e} and @kbd{:r <shell-cmd>}
3095 to mean current file. If you want a @samp{%} in your command, it must be
3096 escaped as @samp{\%}. Note that @kbd{:w} and the regular @kbd{:r <file>}
3097 command doesn't support the meta symbols @samp{%} and @samp{#}, because
3098 file history is a better mechanism.
3099 @cindex # (Previous file)
3100 Similarly, @samp{#} expands to the previous file. The previous file is
3101 the first file in @kbd{:args} listing. This defaults to previous window
3102 in the VI sense if you have one window only.
3109 Others like @samp{<args> -- arguments}, @samp{<cmd> -- command} etc.
3110 should be fairly obvious.
3113 Common characters referred to include:
3138 We also use @samp{word} for alphanumeric/non-alphanumeric words, and
3139 @samp{WORD} for whitespace delimited words. @samp{char} refers to any
3140 ASCII character, @samp{CHAR} to non-whitespace character.
3141 Brackets @samp{[]} indicate optional parameters; @samp{<count>} also
3142 optional, usually defaulting to 1. Brackets are elided for
3143 @samp{<count>} to eschew obfuscation.
3145 Viper's idea of Vi's words is slightly different from Vi. First, Viper
3146 words understand Emacs symbol tables. Therefore, all symbols declared to be
3147 alphanumeric in a symbol table can automatically be made part of the Viper
3148 word. This is useful when, for instance, editing text containing European,
3149 Cyrillic, Japanese, etc., texts.
3151 Second, Viper lets you depart from Vi's idea of a word by changing the a
3152 syntax preference via the customization widget (the variable
3153 @code{viper-syntax-preference}) or by executing
3154 @code{viper-set-syntax-preference} interactively.
3156 By default, Viper syntax preference is @code{reformed-vi}, which means that
3157 Viper considers only those symbols to be part of a word that are specified
3158 as word-symbols by the current Emacs syntax table (which may be different
3159 for different major modes) plus the underscore symbol @kbd{_}, minus the
3160 symbols that are not considered words in Vi (e.g., `,',;, etc.), but may be
3161 considered as word-symbols by various Emacs major modes. Reformed-Vi works
3162 very close to Vi, and it also recognizes words in other
3163 alphabets. Therefore, this is the most appropriate mode for editing text
3164 and is likely to fit all your needs.
3166 You can also set Viper syntax preference to @code{strict-vi}, which would
3167 cause Viper to view all non-English letters as non-word-symbols.
3169 You can also specify @code{emacs} as your preference, which would
3170 make Viper use exactly the same notion of a word as Emacs does. In
3171 particular, the underscore may not be part of a word in some major modes.
3173 Finally, if @code{viper-syntax-preference} is set to @code{extended}, Viper
3174 words would consist of characters that are classified as alphanumeric
3175 @emph{or} as parts of symbols. This is convenient for editing programs.
3177 @code{viper-syntax-preference} is a local variable, so it can have different
3178 values for different major modes. For instance, in programming modes it can
3179 have the value @code{extended}. In text modes where words contain special
3180 characters, such as European (non-English) letters, Cyrillic letters, etc.,
3181 the value can be @code{reformed-vi} or @code{emacs}.
3182 If you consider using different syntactic preferences for different major
3183 modes, you should execute, for example,
3186 (viper-set-syntax-preference nil "extended")
3189 in the appropriate major mode hooks.
3191 @vindex @code{viper-syntax-preference}
3192 @findex @code{viper-set-syntax-preference}
3193 @cindex syntax table
3197 The above discussion concerns only the movement commands. In regular
3198 expressions, words remain the same as in Emacs. That is, the expressions
3199 @code{\w}, @code{\>}, @code{\<}, etc., use Emacs' idea of what is a word,
3200 and they don't look into the value of variable
3201 @code{viper-syntax-preference}. This is because Viper avoids changing
3202 syntax tables in order to not thwart the various major modes that set these
3205 The usual Emacs convention is used to indicate Control Characters, i.e
3206 C-h for Control-h. @emph{Do not confuse this to mean the separate
3207 characters C - h!!!} The @kbd{^} is itself, never used to indicate a
3210 Finally, we note that Viper's Ex-style commands can be made to work on the
3211 current Emacs region. This is done by typing a digit argument before
3212 @kbd{:}. For instance, typing @kbd{1:} will propmt you with something like
3213 @emph{:123,135}, assuming that the current region starts at line 123 and
3214 ends at line 135. There is no need to type the line numbers, since Viper
3215 inserts them automatically in front of the Ex command.
3218 @node Text Handling, Display, Groundwork, Commands
3219 @section Text Handling
3222 * Move Commands:: Moving, Searching
3223 * Marking:: Textmarkers in Viper and the Emacs Mark.
3224 * Appending Text:: Text insertion, Shifting, Putting
3225 * Editing in Insert State:: Autoindent, Quoting etc.
3226 * Deleting Text:: Deleting
3227 * Changing Text:: Changing, Replacement, Joining
3228 * Search and Replace:: Searches, Query Replace, Pattern Commands
3229 * Yanking:: Yanking, Viewing Registers
3230 * Undoing:: Multiple Undo, Backups
3233 @node Move Commands,Marking,,Text Handling
3234 @subsection Move Commands
3236 @cindex movement commands
3240 @cindex column movement
3245 @cindex matching parens
3246 @cindex paren matching
3250 <count> chars to the left.
3251 @item <count> j <lf> C-n
3252 <count> lines downward.
3253 @item <count> l <sp>
3254 <count> chars to the right.
3256 <count> lines upward.
3258 To the end of line <count> from the cursor.
3260 To the first CHAR <count> - 1 lines lower.
3262 To the first CHAR <count> lines higher.
3263 @item <count> + <cr>
3264 To the first CHAR <count> lines lower.
3266 To the first char of the line.
3269 @item <count> f<char>
3270 <count> <char>s to the right (find).
3271 @item <count> t<char>
3272 Till before <count> <char>s to the right.
3273 @item <count> F<char>
3274 <count> <char>s to the left.
3275 @item <count> T<char>
3276 Till after <count> <char>s to the left.
3278 Repeat latest @kbd{f t F T} <count> times.
3280 Repeat latest @kbd{f t F T}
3281 <count> times in opposite direction.
3283 <count> words forward.
3285 <count> WORDS forward.
3287 <count> words backward.
3289 <count> WORDS backward.
3291 To the end of word <count> forward.
3293 To the end of WORD <count> forward.
3295 Go to line <count> (default end-of-file).
3297 To line <count> from top of the screen (home).
3299 To line <count> from bottom of the screen (last).
3301 To the middle line of the screen.
3303 <count> sentences forward.
3305 <count> sentences backward.
3307 <count> paragraphs forward.
3309 <count> paragraphs backward.
3311 To the <count>th heading.
3313 To the <count>th previous heading.
3315 To the end of <count>th heading.
3317 Mark the cursor position with a letter.
3321 To the first CHAR of the line with the mark.
3323 Show contents of textmarker.
3325 Show contents of register.
3327 To the cursor position before the latest absolute
3328 jump (of which are examples @kbd{/} and @kbd{G}).
3330 To the first CHAR of the line on which the cursor
3331 was placed before the latest absolute jump.
3332 @item <count> /<string>
3333 To the <count>th occurrence of <string>.
3335 To the <count>th occurrence of <string> from previous @kbd{/ or ?}.
3336 @item <count> ?<string>
3337 To the <count>th previous occurrence of <string>.
3339 To the <count>th previous occurrence of <string> from previous @kbd{?@: or /}.
3341 Repeat latest @kbd{/} @kbd{?} (next).
3343 Repeat latest search in opposite direction.
3345 Without a prefix argument, this command toggles
3346 case-sensitive/case-insensitive search modes and plain vanilla/regular
3347 expression search. With the prefix argument 1, i.e.,
3348 @kbd{1 C-c /}, this toggles case-sensitivity; with the prefix argument 2,
3349 toggles plain vanilla search and search using
3350 regular expressions. @xref{Viper Specials}, for alternative ways to invoke
3352 @cindex vanilla search
3353 @cindex case-sensitive search
3354 @cindex case-insensitive search
3356 Find the next bracket/parenthesis/brace and go to its match.
3357 By default, Viper ignores brackets/parentheses/braces that occur inside
3358 parentheses. You can change this by setting
3359 @code{viper-parse-sexp-ignore-comments} to nil in your @file{.viper} file.
3360 This option can also be toggled interactively if you quickly hit @kbd{%%%}.
3362 This latter feature is implemented as a vi-style keyboard macro. If you
3363 don't want this macro, put
3366 (viper-set-parsing-style-toggling-macro 'undefine)
3368 @findex @code{viper-set-parsing-style-toggling-macro}
3370 in your @file{~/.viper} file.
3379 @kindex @kbd{?<string>}
3380 @kindex @kbd{/<string>}
3383 @kindex @kbd{]<a-z>}
3384 @kindex @kbd{[<a-z>}
3385 @kindex @kbd{'<a-z>}
3386 @kindex @kbd{`<a-z>}
3387 @kindex @kbd{m<a-z>}
3407 @kindex @kbd{T<char>}
3408 @kindex @kbd{F<char>}
3409 @kindex @kbd{t<char>}
3410 @kindex @kbd{f<char>}
3427 @vindex @code{viper-parse-sexp-ignore-comments}
3429 @node Marking,Appending Text,Move Commands,Text Handling
3432 Emacs mark is referred to in the region specifiers @kbd{r} and @kbd{R}.
3433 @xref{Emacs Preliminaries}, and @xref{Basics}, for explanation. Also
3434 see @ref{Mark,,Mark,emacs,The GNU Emacs manual}, for an explanation of
3435 the Emacs mark ring.
3441 Mark the current file and position with the specified letter.
3443 Set the Emacs mark (@pxref{Emacs Preliminaries}) at point.
3445 Set the Emacs mark (@pxref{Emacs Preliminaries}) back to where it was last
3446 set with the @kbd{m.} command. This is useful when you set the mark with
3447 @kbd{m.}, but then some other command (such as @kbd{L} or @kbd{G}) changes
3448 it in a way that you didn't like.
3450 Set the Emacs mark at beginning of buffer.
3452 Set the Emacs mark at end of buffer.
3454 Jump to the Emacs mark.
3456 Mark position with text marker named <char>. This is an Ex command.
3458 Same as @kbd{:mark}.
3460 Exchange point and mark.
3462 Exchange point and mark and go to the first CHAR on line.
3464 Go to specified Viper mark.
3466 Go to specified Viper mark and go to the first CHAR on line.
3468 @kindex @kbd{m<a-z>}
3478 @kindex @kbd{`<a-z>}
3479 @kindex @kbd{'<a-z>}
3481 @node Appending Text, Editing in Insert State, Marking,Text Handling
3482 @subsection Appending Text
3484 @xref{Options}, to see how to change tab and shiftwidth size. See the GNU
3485 Emacs manual, or try @kbd{C-ha tabs} (If you have turned Emacs help on).
3486 Check out the variable @code{indent-tabs-mode} to put in just spaces.
3487 Also see options for word-wrap.
3496 <count> times after the cursor.
3498 <count> times at the end of line.
3500 <count> times before the cursor (insert).
3502 <count> times before the first CHAR of the line
3504 On a new line below the current (open).
3505 The count is only useful on a slow terminal.
3507 On a new line above the current.
3508 The count is only useful on a slow terminal.
3509 @item <count> ><move>
3510 Shift the lines described by <count><move> one
3511 shiftwidth to the right (layout!).
3513 Shift <count> lines one shiftwidth to the right.
3514 @item <count> ["<a-z1-9>]p
3515 Put the contents of the (default undo) buffer
3516 <count> times after the cursor. The register will
3517 be automatically down-cased.
3518 @item <count> ["<a-z1-9>]P
3519 Put the contents of the (default undo) buffer
3520 <count> times before the cursor. The register will
3522 Show contents of textmarker.
3524 Show contents of register.
3526 Repeat previous command <count> times. For destructive
3527 commands as well as undo.
3529 While @kbd{.} repeats the last destructive command,
3530 these two macros repeat the second-last and the third-last destructive
3531 commands. @xref{Vi Macros}, for more information on Vi macros.
3532 @item C-c M-p and C-c M-n
3534 these commands help peruse the history of Vi's destructive commands.
3535 Successive typing of @kbd{C-c M-p} causes Viper to search the history in
3537 of older commands, while hitting @kbd{C-c M-n} does so in reverse
3538 order. Each command in the history is displayed in the Minibuffer. The
3539 displayed command can
3540 then be executed by typing `@kbd{.}'.
3542 Since typing the above sequences of keys may be tedious, the
3543 functions doing the perusing can be bound to unused keyboard keys in the
3544 @file{~/.viper} file. @xref{Viper Specials}, for details.
3546 @kindex @kbd{C-c M-p}
3547 @kindex @kbd{C-c M-n}
3549 @kindex @kbd{]<a-z>}
3550 @kindex @kbd{[<a-z>}
3553 @kindex @kbd{"<a-z1-9>p}
3554 @kindex @kbd{"<a-z1-9>P}
3556 @kindex @kbd{><move>}
3563 @node Editing in Insert State, Deleting Text, Appending Text,Text Handling
3564 @subsection Editing in Insert State
3566 Minibuffer can be edited similarly to Insert state, and you can switch
3567 between Insert/Replace/Vi states at will.
3568 Some users prefer plain Emacs feel in the Minibuffer. To this end, set
3569 @var{viper-vi-style-in-minibuffer} to @code{nil}.
3571 @cindex Insert state
3575 Deprive the next char of its special meaning (quoting).
3581 Back to the begin of the change on the
3589 @node Deleting Text, Changing Text, Editing in Insert State, Text Handling
3590 @subsection Deleting Text
3593 There is one difference in text deletion that you should be
3594 aware of. This difference comes from Emacs and was adopted in Viper
3595 because we find it very useful. In Vi, if you delete a line, say, and then
3596 another line, these two deletions are separated and are put back
3597 separately if you use the @samp{p} command. In Emacs (and Viper), successive
3598 series of deletions that are @emph{not interrupted} by other commands are
3599 lumped together, so the deleted text gets accumulated and can be put back
3600 as one chunk. If you want to break a sequence of deletions so that the
3601 newly deleted text could be put back separately from the previously deleted
3602 text, you should perform a non-deleting action, e.g., move the cursor one
3603 character in any direction.
3605 @cindex shifting text
3609 Delete <count> chars under and after the cursor.
3611 Delete <count> chars before the cursor.
3612 @item <count> d<move>
3613 Delete from point to endpoint of <count><move>.
3615 Delete <count> lines.
3617 The rest of the line.
3618 @item <count> <<move>
3619 Shift the lines described by <count><move> one
3620 shiftwidth to the left (layout!).
3622 Shift <count> lines one shiftwidth to the left.
3625 @kindex @kbd{<<move>}
3628 @kindex @kbd{d<move>}
3632 @node Changing Text, Search and Replace, Deleting Text,Text Handling
3633 @subsection Changing Text
3635 @cindex joining lines
3636 @cindex changing case
3637 @cindex quoting regions
3638 @cindex substitution
3641 @item <count> r<char>
3642 Replace <count> chars by <char> - no <esc>.
3644 Overwrite the rest of the line,
3645 appending change @var{count - 1} times.
3647 Substitute <count> chars.
3649 Change <count> lines.
3650 @item <count> c<move>
3651 Change from begin to endpoint of <count><move>.
3653 Change <count> lines.
3655 The rest of the line and <count> - 1 next lines.
3656 @item <count> =<move>
3657 Reindent the region described by move.
3659 Switch lower and upper cases.
3661 Join <count> lines (default 2).
3662 @item :[x,y]s/<pat>/<repl>/<f>
3663 Substitute (on lines x through y) the pattern
3664 <pat> (default the last pattern) with <repl>. Useful
3665 flags <f> are @samp{g} for @samp{global} (i.e.@: change every
3666 non-overlapping occurrence of <pat>) and @samp{c} for
3667 @samp{confirm} (type @samp{y} to confirm a particular
3668 substitution, else @samp{n} ). Instead of @kbd{/} any
3669 punctuation CHAR unequal to <space> <tab> and <lf> can be used as
3672 In Emacs, @samp{\&} stands for the last matched expression, so
3673 @kbd{s/[ab]+/\&\&/} will double the string matched by @kbd{[ab]}.
3674 Viper doesn't treat @samp{&} specially, unlike Vi: use @samp{\&} instead.
3676 Note: @emph{The newline character (inserted as @kbd{C-qC-j})
3677 can be used in <repl>}.
3678 @item :[x,y]copy [z]
3679 Copy text between @kbd{x} and @kbd{y} to the position after @kbd{z}.
3681 Same as @kbd{:copy}.
3682 @item :[x,y]move [z]
3683 Move text between @kbd{x} and @kbd{y} to the position after @kbd{z}.
3685 Repeat latest Ex substitute command, e.g.
3686 @kbd{:s/wrong/right}.
3688 Toggle case-sensitive search. With prefix argument, toggle vanilla/regular
3691 Change upper-case characters in the region to lower-case.
3693 Change lower-case characters in the region to upper-case.
3695 Insert specified string at the beginning of each line in the region
3696 @item C-c M-p and C-c M-n
3697 In Insert and Replace states, these keys are bound to commands that peruse
3698 the history of the text
3699 previously inserted in other insert or replace commands. By repeatedly typing
3700 @kbd{C-c M-p} or @kbd{C-c M-n}, you will cause Viper to
3701 insert these previously used strings one by one.
3702 When a new string is inserted, the previous one is deleted.
3704 In Vi state, these keys are bound to functions that peruse the history of
3705 destructive Vi commands.
3706 @xref{Viper Specials}, for details.
3708 @kindex @kbd{C-c M-p}
3709 @kindex @kbd{C-c M-n}
3710 @kindex @kbd{#q<move> }
3711 @kindex @kbd{#C<move>}
3712 @kindex @kbd{#c<move>}
3715 @findex @kbd{:substitute/<pat>/<repl>/<f>}
3716 @findex @kbd{:s/<pat>/<repl>/<f>}
3717 @findex @kbd{:copy [z]}
3718 @findex @kbd{:t [z]}
3719 @findex @kbd{:move [z]}
3722 @kindex @kbd{=<move>}
3725 @kindex @kbd{c<move>}
3729 @kindex @kbd{r<char>}
3731 @node Search and Replace, Yanking, Changing Text,Text Handling
3732 @subsection Search and Replace
3734 @xref{Groundwork}, for Ex address syntax. @xref{Options}, to see how to
3735 get literal (non-regular-expression) search and how to stop search from
3739 @item <count> /<string>
3740 To the <count>th occurrence of <string>.
3741 @item <count> ?<string>
3742 To the <count>th previous occurrence of <string>.
3743 @item <count> g<move>
3744 Search for the text described by move. (off by default)
3746 Repeat latest @kbd{/} @kbd{?} (next).
3748 Idem in opposite direction.
3750 Find the next bracket and go to its match
3751 @item :[x,y]g/<string>/<cmd>
3752 @cindex text processing
3753 Search globally [from line x to y] for <string>
3754 and execute the Ex <cmd> on each occurrence.
3755 @item :[x,y]v/<string>/<cmd>
3756 Execute <cmd> on the lines that don't match.
3758 Execute the last keyboard macro for each line in the region.
3759 @xref{Macros and Registers}, for more info.
3763 Search in the tags file where <name> is defined (file, line), and go to it.
3764 @item :[x,y]s/<pat>/<repl>/<f>
3765 Substitute (on lines x through y) the pattern <pat> (default the last
3766 pattern) with <repl>. Useful
3767 flags <f> are @samp{g} for @samp{global} (i.e.@: change every
3768 non-overlapping occurrence of <pat>) and @samp{c} for
3769 @samp{confirm} (type @samp{y} to confirm a particular
3770 substitution, else @samp{n}). Instead of @kbd{/} any
3771 punctuation character other than <space> <tab> and <lf> can be used as
3774 Note: @emph{The newline character (inserted as @kbd{C-qC-j})
3775 can be used in <repl>}.
3777 Repeat latest Ex substitute command, e.g.@: @kbd{:s/wrong/right}.
3778 @item :global /<pattern>/<ex-command>
3779 @itemx :g /<pattern>/<ex-command>
3780 Execute <ex-command> on all lines that match <pattern>.
3781 @item :vglobal /<pattern>/<ex-command>
3782 @itemx :v /<pattern>/<ex-command>
3783 Execute <ex-command> on all lines that do not match <pattern>.
3786 @findex @kbd{:substitute/<pat>/<repl>/<f>}
3788 @kindex @kbd{#g<move>}
3791 @findex @kbd{:global}
3792 @findex @kbd{:vglobal}
3793 @findex @kbd{:tag <name>}
3797 @kindex @kbd{g<move>}
3798 @kindex @kbd{?<string>}
3799 @kindex @kbd{/<string>}
3801 @node Yanking,Undoing,Search and Replace,Text Handling
3804 @cindex cut and paste
3808 @item <count> y<move>
3809 Yank from begin to endpoint of <count><move>.
3810 @item <count> "<a-z>y<move>
3811 Yank from begin to endpoint of <count><move> to register.
3812 @item <count> "<A-Z>y<move>
3813 Yank from begin to endpoint of <count><move> and append
3818 Idem (should be equivalent to @kbd{y$} though).
3820 Mark the cursor position with a letter.
3822 Show contents of textmarker.
3824 Show contents of register.
3825 @item <count> ["<a-z1-9>]p
3826 Put the contents of the (default undo) buffer
3827 <count> times after the cursor. The register will
3828 be automatically down-cased.
3829 @item <count> ["<a-z1-9>]P
3830 Put the contents of the (default undo) buffer
3831 <count> times before the cursor. The register will
3835 @kindex @kbd{"<a-z1-9>p}
3836 @kindex @kbd{"<a-z1-9>P}
3837 @kindex @kbd{]<a-z>}
3838 @kindex @kbd{[<a-z>}
3839 @kindex @kbd{m<a-z>}
3842 @kindex @kbd{"<A-Z>y<move>}
3843 @kindex @kbd{"<a-z>y<move>}
3844 @kindex @kbd{y<move>}
3848 @node Undoing,, Yanking,Text Handling
3852 @cindex backup files
3856 Undo the latest change.
3860 Quit Vi without writing.
3862 Re-edit a messed-up file.
3864 Recover file from autosave. Viper also creates backup files
3865 that have a @samp{~} appended to them.
3874 @node Display, File and Buffer Handling, Text Handling, Commands
3882 give file name, status, current line number
3883 and relative position.@*
3884 At user levels 2 and higher, abort the current command.
3886 Give file name, status, current line number and relative position -- all
3891 Expose <count> more lines at bottom, cursor stays put (if possible).
3893 Expose <count> more lines at top, cursor stays put (if possible).
3895 Scroll <count> lines downward (default the number of the previous scroll;
3896 initialization: half a page).
3898 Scroll <count> lines upward (default the number of the previous scroll;
3899 initialization: half a page).
3901 <count> pages forward.
3903 <count> pages backward (in older versions @kbd{C-b} only works without count).
3906 Put line <count> at the top of the window (default the current line).
3909 Put line <count> at the bottom of the window
3910 (default the current line).
3913 Put line <count> in the center of the window
3914 (default the current line).
3933 @node File and Buffer Handling, Mapping, Display,Commands
3934 @section File and Buffer Handling
3936 @cindex multiple files
3938 In all file handling commands, space should be typed before entering the file
3939 name. If you need to type a modifier, such as @kbd{>>} or @kbd{!}, don't
3940 put any space between the command and the modifier.
3942 Note that many Ex commands, e.g., @kbd{:w}, accept command arguments. The
3943 effect is that the command would start acting on the current region. For
3944 instance, if the current region spans the lines 11 through 22, then if you
3945 type @kbd{1:w} you would see @samp{:11,22w} in the minibuffer.
3949 Quit buffer except if modified.
3951 Quit buffer without checking. In Viper, these two commands
3952 are identical. Confirmation is required if exiting modified buffers that
3958 Write the file. Viper makes sure that a final newline is always added to
3959 any file where this newline is missing. This is done by setting Emacs
3960 variable @code{require-final-newline} to @code{t}. If you don't like this
3961 feature, use @code{setq-default} to set @code{require-final-newline} to
3962 @code{nil}. This must be done in @file{.viper} file.
3963 @item :[x,y] w <name>
3964 Write to the file <name>.
3965 @item :[x,y] w>> <name>
3966 Append the buffer to the file <name>. There should be no space between
3967 @kbd{w} and @kbd{>>}. Type space after the @kbd{>>} and see what happens.
3969 Overwrite the file <name>. In Viper, @kbd{:w} and @kbd{:w!} are identical.
3970 Confirmation is required for writing to an existing file (if this is not
3971 the file the buffer is visiting) or to a read-only file.
3973 Write lines x through y to the file <name>.
3975 Write the file and kill buffer.
3976 @item :r <file> [<file> ...]
3977 Read file into a buffer, inserting its contents after the current line.
3982 Save all unsaved buffers, asking for confirmation.
3985 Like @kbd{W}, but without asking for confirmation.
3987 Save current buffer and kill it. If user level is 1, then save all files
3988 and kill Emacs. Killing Emacs is the wrong way to use it, so you should
3989 switch to higher user levels as soon as possible.
3991 Save and kill buffer.
3992 @item :x!@: [<file>]
3993 @kbd{:w![<file>]} and @kbd{:q}.
3995 Preserve the file -- autosave buffers.
3997 Recover file from autosave.
3999 Print file name and lines.
4001 Set the working directory to <dir> (default home directory).
4003 Print present working directory.
4004 @item :e [+<cmd>] <files>
4005 Edit files. If no filename is given, edit the file visited by the current
4006 buffer. If buffer was modified or the file changed on disk, ask for
4007 confirmation. Unlike Vi, Viper allows @kbd{:e} to take multiple arguments.
4008 The first file is edited the same way as in Vi. The rest are visited
4009 in the usual Emacs way.
4010 @item :e!@: [+<cmd>] <files>
4011 Re-edit file. If no filename, re-edit current file.
4012 In Viper, unlike Vi, @kbd{e!} is identical to @kbd{:e}. In both cases, the
4013 user is asked to confirm if there is a danger of discarding changes to a
4016 Quit Vi without writing.
4018 Edit the alternate (normally the previous) file.
4022 List files not shown anywhere with counts for next
4023 @item :n [count] [+<cmd>] [<files>]
4024 Edit <count> file, or edit files. The count comes from @kbd{:args}.
4025 @item :N [count] [+<cmd>] [<files>]
4026 Like @kbd{:n}, but the meaning of the variable
4027 @var{ex-cycle-other-window} is reversed.
4029 Switch to another buffer. If @var{ex-cycle-other-window} is @code{t},
4030 switch in another window. Buffer completion is supported.
4031 The variable @var{viper-read-buffer-function} controls which function is
4032 actually used to read the buffer name. The default is @code{read-buffer},
4033 but better alternatives are also available in Emacs (e.g.,
4034 @code{iswitchb-read-buffer}).
4035 @vindex @var{viper-read-buffer-function}
4037 Like @kbd{:b}, but the meaning of @var{ex-cycle-other-window} is reversed.
4038 @item :<address>r <name>
4039 Read the file <name> into the buffer after the line <address>.
4041 Edit a file in current or another window, or in another frame. File name
4042 is typed in Minibuffer. File completion and history are supported.
4049 @findex @kbd{:e!@: [<files>]}
4050 @findex @kbd{:e [<files>]}
4051 @findex @kbd{:edit [<files>]}
4052 @findex @kbd{:edit!@: [<files>]}
4056 @findex @kbd{:quit!}
4064 @findex @kbd{:w <file>}
4065 @findex @kbd{:w!@: <file>}
4066 @findex @kbd{:w >> <file>}
4067 @findex @kbd{:write <file>}
4068 @findex @kbd{:write!@: <file>}
4069 @findex @kbd{:write >> <file>}
4072 @findex @kbd{:Write}
4073 @findex @kbd{:WWrite}
4074 @findex @kbd{:WWrite}
4077 @findex @kbd{:suspend}
4079 @findex @kbd{:n [<count> | <file>]}
4080 @findex @kbd{:cd [<dir>]}
4083 @node Mapping, Shell Commands, File and Buffer Handling, Commands
4091 Start defining a Vi-style keyboard macro.
4092 For instance, typing
4093 @kbd{:map www} followed by @kbd{:!wc %} and then typing @kbd{C-x )}
4094 will cause @kbd{www} to run wc on
4095 current file (Vi replaces @samp{%} with the current file name).
4097 Finish defining a keyboard macro.
4098 In Viper, this command completes the process of defining all keyboard
4099 macros, whether they are Emacs-style or Vi-style.
4100 This is a departure from Vi, needed to allow WYSIWYG mapping of
4101 keyboard macros and to permit the use of function keys and arbitrary Emacs
4102 functions in the macros.
4103 @item :unmap <string>
4104 Deprive <string> of its mappings in Vi state.
4105 @item :map!@: <string>
4106 Map a macro for Insert state.
4107 @item :unmap!@: <string>
4108 Deprive <string> of its mapping in Insert state (see @kbd{:unmap}).
4111 execute the contents of register as a command.
4114 repeat last register command.
4117 begin keyboard macro. End with @@<a-z>. This will
4118 put the macro in the proper register. Register will
4119 be automatically down-cased.
4120 @xref{Macros and Registers}, for more info.
4123 yank anonymous macro to register
4126 execute anonymous macro (defined by C-x( and C-x )).
4128 Like @kbd{*}, but works in all Viper states.
4130 Execute the last keyboard macro for each line in the region.
4131 @xref{Macros and Registers}, for more info.
4133 Show contents of textmarker.
4135 Show contents of register.
4137 @kindex @kbd{]<a-z>}
4138 @kindex @kbd{[<a-z>}
4139 @kindex @kbd{#g<move>}
4141 @kindex @kbd{@@!<a-z>}
4144 @kindex @kbd{@@<a-z>}
4145 @findex @kbd{:unmap <char>}
4146 @findex @kbd{:map <char> <seq>}
4147 @findex @kbd{:unmap!@: <char>}
4148 @findex @kbd{:map!@: <char> <seq>}
4150 @node Shell Commands, Options, Mapping, Commands
4151 @section Shell Commands
4153 @cindex % (Current file)
4155 The symbol @samp{%} is used in Ex shell commands to mean current file. If
4156 you want a @samp{%} in your command, it must be escaped as @samp{\%}.
4157 @cindex @samp{%} (Ex address)
4158 However if @samp{%} is the first character, it stands as the address for
4160 @cindex @samp{#} (Previous file)
4161 Similarly, @samp{#} expands to the previous file. The previous file is the
4162 first file in @kbd{:args} listing. This defaults to the previous file in
4163 the VI sense if you have one window.@refill
4165 Symbols @samp{%} and @samp{#} are also used in the Ex commands @kbd{:e} and
4166 @kbd{:r <shell-cmd>}. The commands @kbd{:w} and the regular @kbd{:r
4167 <file>} command don't support these meta symbols, because file history is a
4170 @cindex shell commands
4174 Execute a subshell in another window
4176 Execute a shell <cmd> [on lines x through y;
4177 % is replace by current file, \% is changed to %
4178 @item :[x,y]!!@: [<args>]
4179 Repeat last shell command [and append <args>].
4181 Just execute command and display result in a buffer.
4183 Repeat last shell command and append <args>
4184 @item <count> !<move><cmd>
4185 The shell executes <cmd>, with standard
4186 input the lines described by <count><move>,
4187 next the standard output replaces those lines
4188 (think of @samp{cb}, @samp{sort}, @samp{nroff}, etc.).
4189 @item <count> !!<cmd>
4190 Give <count> lines as standard input to the
4191 shell <cmd>, next let the standard output
4192 replace those lines.
4193 @item :[x,y] w !<cmd>
4194 Let lines x to y be standard input for <cmd>
4195 (notice the <sp> between @kbd{w} and @kbd{!}).
4196 @item :<address>r !<cmd>
4197 Put the output of <cmd> after the line <address> (default current).
4198 @item :<address>r <name>
4199 Read the file <name> into the buffer after the line <address> (default
4202 @findex @kbd{:<address>r <name>}
4203 @findex @kbd{:<address>r !<cmd>}
4204 @findex @kbd{!<cmd>}
4205 @findex @kbd{!!<cmd>}
4206 @findex @kbd{!<move><cmd>}
4207 @findex @kbd{:w !<cmd>}
4208 @findex @kbd{:x,y w !<cmd>}
4209 @findex @kbd{:!!@: <args>}
4210 @findex @kbd{:!<cmd>}
4213 @node Options,Emacs Related Commands,Shell Commands,Commands
4222 autoindent -- In append mode after a <cr> the
4223 cursor will move directly below the first
4224 character on the previous line.
4225 This setting affects the current buffer only.
4226 @item autoindent-global
4228 Same as `autoindent', but affects all buffers.
4232 @item noautoindent-global
4234 Cancel autoindent-global.
4237 @cindex case and searching
4238 ignorecase -- No distinction between upper and lower cases when searching.
4244 @cindex literal searching
4245 Regular expressions used in searches; nomagic means no regexps.
4251 @cindex readonly files
4252 readonly -- The file is not to be changed.
4253 If the user attempts to write to this file, confirmation will be requested.
4257 @item shell=<string>
4260 shell -- The program to be used for shell escapes
4261 (default @samp{$SHELL} (default @file{/bin/sh})).
4262 @item shiftwidth=<count>
4265 @cindex shifting text
4266 shiftwidth -- Gives the shiftwidth (default 8 positions).
4269 @cindex paren matching
4270 @cindex matching parens
4271 showmatch -- Whenever you append a @kbd{)}, Vi shows
4272 its match if it's on the same page; also with
4273 @kbd{@{} and @kbd{@}}. If there's no match, Vi will beep.
4277 @item tabstop=<count>
4279 @cindex changing tab width
4281 tabstop -- The length of a <ht>; warning: this is
4282 only IN the editor, outside of it <ht>s have
4283 their normal length (default 8 positions).
4284 This setting affects the current buffer only.
4285 @item tabstop-global
4287 Same as `tabstop', but affects all buffers.
4288 @item wrapmargin=<count>
4292 wrapmargin -- In append mode Vi automatically
4293 puts a <lf> whenever there is a <sp> or <ht>
4294 within <wm> columns from the right margin.
4298 wrapscan -- When searching, the end is
4299 considered @samp{stuck} to the begin of the file.
4305 @item :set no<option>
4307 @item :set <option>=<value>
4308 Set <option> to <value>.
4310 @findex @kbd{:set <option>=<value>}
4311 @findex @kbd{:set no<option>}
4312 @findex @kbd{:set <option>}
4313 @findex @kbd{:set ws}
4314 @findex @kbd{:set wrapscan}
4315 @findex @kbd{:set wm=<count>}
4316 @findex @kbd{:set wrapmargin=<count>}
4317 @findex @kbd{:set ts=<count>}
4318 @findex @kbd{:set tabstop=<count>}
4319 @findex @kbd{:set tab-stop-local=<count>}
4320 @findex @kbd{:set sm}
4321 @findex @kbd{:set showmatch}
4322 @findex @kbd{:set sw=<count>}
4323 @findex @kbd{:set shiftwidth=<count>}
4324 @findex @kbd{:set sh=<string>}
4325 @findex @kbd{:set shell=<string>}
4326 @findex @kbd{:set ro}
4327 @findex @kbd{:set readonly}
4328 @findex @kbd{:set magic}
4329 @findex @kbd{:set ic}
4330 @findex @kbd{:set ignorecase}
4331 @findex @kbd{:set ai}
4332 @findex @kbd{:set autoindent}
4334 @node Emacs Related Commands,,Options,Commands
4335 @section Emacs Related Commands
4339 Begin Meta command in Vi or Insert states. Most often used as C-\ x (M-x).
4341 Note: Emacs binds @kbd{C-\} to a function that offers to change the
4342 keyboard input method in the multilingual environment. Viper overrides this
4343 binding. However, it is still possible to switch the input method by typing
4344 @kbd{\ C-\} in the Vi command state and @kbd{C-z \ C-\} in the Insert state.
4345 Or you can use the MULE menu on the menubar.
4347 In Insert and Replace states, prepare Viper to accept the next command and
4348 execute it as if Viper was in Vi state. Then return to Insert state.
4350 In Vi state, switch to Emacs state; in Emacs state, switch to Vi state.
4352 Switches to Vi state for the duration of a single command. Then goes back
4353 to the original Viper state. Works from Vi, Insert, Replace, and Emacs states.
4363 Emacs find-file, useful in Insert state
4365 Put back the last killed text. Similar to Vi's @kbd{p}, but also works in
4366 Insert and Replace state. This command doesn't work in Vi command state,
4367 since this binding is taken for something else.
4369 Undoes the last @kbd{C-y} and puts another kill from the kill ring.
4370 Using this command, you can try may different kills until you find the one
4375 @kindex @kbd{C-xC-f}
4384 @node Mouse-bound Commands,,,Commands
4385 @section Mouse-bound Commands
4387 The following two mouse actions are normally bound to special search and
4388 insert commands in of Viper:
4392 Holding Shift and clicking mouse button 1 will
4394 a region under the mouse pointer.
4395 This command can take a prefix argument. Note: Viper sets this
4396 binding only if this mouse action is not
4397 already bound to something else.
4398 @xref{Viper Specials}, for more information.@refill
4401 Holding Shift and clicking button 2 of the mouse will
4402 insert a region surrounding the mouse pointer.
4403 This command can also take a prefix argument.
4404 Note: Viper sets this binding only if this mouse action is not
4405 already bound to something else.
4406 @xref{Viper Specials}, for more details.@refill
4408 @kindex @kbd{S-Mouse-1}
4409 @kindex @kbd{S-Mouse-2}
4410 @kindex @kbd{meta button1up}
4411 @kindex @kbd{meta button2up}
4413 @node Acknowledgments,,,Top
4414 @comment node-name, next, previous, up
4415 @unnumbered Acknowledgments
4417 Viper, formerly known as VIP-19, was written by Michael Kifer. Viper is
4418 based on the original VIP package by Masahiko Sato and on its enhancement,
4419 VIP 4.4, by Aamod Sane. This manual is an adaptation of the manual for VIP
4420 4.4, which, in turn, was based on Sato's manual for VIP 3.5.
4422 Many contributors on the net pointed out bugs and suggested a number of
4423 useful features. Here is a (hopefully) complete list of contributors:
4426 aaronl@@vitelus.com (Aaron Lehmann),
4427 ahg@@panix.com (Al Gelders),
4428 amade@@diagram.fr (Paul-Bernard Amade),
4429 ascott@@fws214.intel.com (Andy Scott),
4430 bronson@@trestle.com (Scott Bronson),
4431 cook@@biostat.wisc.edu (Tom Cook),
4432 csdayton@@midway.uchicago.edu (Soren Dayton),
4433 dave@@hellgate.utah.edu,
4434 dominik@@strw.LeidenUniv.nl (Carsten Dominik),
4435 dwallach@@cs.princeton.edu (Dan Wallach),
4436 dwight@@toolucky.llnl.gov (Dwight Shih),
4437 dxc@@xprt.net (David X. Callaway),
4438 edmonds@@edmonds.home.cs.ubc.ca (Brian Edmonds),
4439 gin@@mo.msk.ru (Golubev I.N.),
4440 gviswana@@cs.wisc.edu (Guhan Viswanathan),
4441 gvr@@halcyon.com (George V.@: Reilly),
4442 hatazaki@@bach.convex.com (Takao Hatazaki),
4443 hpz@@ibmhpz.aug.ipp-garching.mpg.de (Hans-Peter Zehrfeld),
4444 jackr@@dblues.engr.sgi.com (Jack Repenning),
4445 jamesm@@bga.com (D.J.@: Miller II),
4446 jjm@@hplb.hpl.hp.com (Jean-Jacques Moreau),
4447 jl@@cse.ogi.edu (John Launchbury),
4448 jobrien@@hchp.org (John O'Brien),
4449 johnw@@borland.com (John Wiegley),
4450 kanze@@gabi-soft.fr (James Kanze),
4451 kin@@isi.com (Kin Cho),
4452 kwzh@@gnu.org (Karl Heuer),
4453 lindstro@@biostat.wisc.edu (Mary Lindstrom),
4454 minakaji@@osaka.email.ne.jp (Mikio Nakajima),
4455 Mark.Bordas@@East.Sun.COM (Mark Bordas),
4456 meyering@@comco.com (Jim Meyering),
4457 martin@@xemacs.org (Martin Buchholz),
4458 mveiga@@dit.upm.es (Marcelino Veiga Tuimil),
4459 paulk@@summit.esg.apertus.com (Paul Keusemann),
4460 pfister@@cs.sunysb.edu (Hanspeter Pfister),
4461 phil_brooks@@MENTORG.COM (Phil Brooks),
4462 pogrell@@informatik.hu-berlin.de (Lutz Pogrell),
4463 pradyut@@cs.uchicago.edu (Pradyut Shah),
4464 roderick@@argon.org (Roderick Schertler),
4465 rxga@@ulysses.att.com,
4466 sawdey@@lcse.umn.edu (Aaron Sawdey),
4467 simonb@@prl.philips.co.uk (Simon Blanchard),
4468 stephen@@farrell.org (Stephen Farrell),
4469 sudish@@MindSpring.COM (Sudish Joseph),
4470 schwab@@issan.informatik.uni-dortmund.de (Andreas Schwab)
4471 terra@@diku.dk (Morten Welinder),
4472 thanh@@informatics.muni.cz (Han The Thanh),
4473 toma@@convex.convex.com,
4474 vrenjak@@sun1.racal.com (Milan Vrenjak),
4475 whicken@@dragon.parasoft.com (Wendell Hicken),
4476 zapman@@cc.gatech.edu (Jason Zapman II),
4480 @node Key Index,Function Index,,Top
4481 @comment node-name, next, previous, up
4482 @unnumbered Key Index
4486 @node Function Index,Variable Index,Key Index,Top
4487 @comment node-name, next, previous, up
4488 @unnumbered Function Index
4492 @node Variable Index,Package Index,Function Index,Top
4493 @comment node-name, next, previous, up
4494 @unnumbered Variable Index
4498 @node Package Index,Concept Index,Variable Index,Top
4499 @comment node-name, next, previous, up
4500 @unnumbered Package Index
4504 @node Concept Index,,Package Index,Top
4505 @comment node-name, next, previous, up
4506 @unnumbered Concept Index
4510 @setchapternewpage odd