Mercurial > emacs
annotate man/viper.texi @ 37678:ebec0594dece
(compile-files): Redirect output of chmod to
/dev/null.
| author | Gerd Moellmann <gerd@gnu.org> |
|---|---|
| date | Fri, 11 May 2001 10:53:56 +0000 |
| parents | 730f77edf073 |
| children | 8da84c32ff29 |
| rev | line source |
|---|---|
| 25829 | 1 % -*-texinfo-*- |
| 2 \input texinfo | |
| 3 | |
| 4 @comment Using viper.info instead of viper in setfilename breaks DOS. | |
| 5 @comment @setfilename viper | |
| 6 @comment @setfilename viper.info | |
| 7 @setfilename ../info/viper | |
| 8 | |
| 33679 | 9 @dircategory Emacs |
| 25829 | 10 @direntry |
| 11 * VIPER: (viper). The newest Emacs VI-emulation mode. | |
| 12 (also, A VI Plan for Emacs Rescue | |
| 13 or the VI PERil.) | |
| 14 @end direntry | |
| 15 | |
| 16 @iftex | |
| 17 @finalout | |
| 18 @end iftex | |
| 19 | |
| 20 @titlepage | |
| 21 @title Viper Is a Package for Emacs Rebels | |
| 22 @subtitle a Vi emulator for Emacs | |
|
33019
6306740f6938
2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
30009
diff
changeset
|
23 @subtitle October 2000, Viper Version 3.09 |
| 25829 | 24 |
| 25 @author Michael Kifer (Viper) | |
| 26 @author Aamod Sane (VIP 4.4) | |
| 27 @author Masahiko Sato (VIP 3.5) | |
| 28 | |
| 29 @page | |
| 30 @vskip 0pt plus 1fill | |
| 31 @end titlepage | |
| 32 | |
| 33 @unnumbered Distribution | |
| 34 | |
| 35 @noindent | |
|
37404
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
36857
diff
changeset
|
36 Copyright @copyright{} 1995, 1996, 1997, 2001 Free Software Foundation, Inc. |
|
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
36857
diff
changeset
|
37 |
|
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
36857
diff
changeset
|
38 Permission is granted to copy, distribute and/or modify this document |
|
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
36857
diff
changeset
|
39 under the terms of the GNU Free Documentation License, Version 1.1 or |
|
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
36857
diff
changeset
|
40 any later version published by the Free Software Foundation; with no |
|
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
36857
diff
changeset
|
41 Invariant Sections, with the Front-Cover texts being ``A GNU |
|
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
36857
diff
changeset
|
42 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the |
|
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
36857
diff
changeset
|
43 license is included in the section entitled ``GNU Free Documentation |
|
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
36857
diff
changeset
|
44 License'' in the Emacs manual. |
|
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
36857
diff
changeset
|
45 |
|
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
36857
diff
changeset
|
46 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify |
|
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
36857
diff
changeset
|
47 this GNU Manual, like GNU software. Copies published by the Free |
|
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
36857
diff
changeset
|
48 Software Foundation raise funds for GNU development.'' |
|
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
36857
diff
changeset
|
49 |
|
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
36857
diff
changeset
|
50 This document is part of a collection distributed under the GNU Free |
|
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
36857
diff
changeset
|
51 Documentation License. If you want to distribute this document |
|
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
36857
diff
changeset
|
52 separately from the collection, you can do so by adding a copy of the |
|
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
36857
diff
changeset
|
53 license to the document, as described in section 6 of the license. |
| 25829 | 54 |
| 55 @ifinfo | |
| 56 @node Top, Overview,, (DIR) | |
| 57 | |
| 58 @unnumbered Viper | |
| 59 | |
| 60 We believe that one or more of the following statements are adequate | |
| 61 descriptions: | |
| 62 | |
| 63 @example | |
| 64 Viper Is a Package for Emacs Rebels; | |
| 65 it is a VI Plan for Emacs Rescue | |
| 66 and/or a venomous VI PERil. | |
| 67 @end example | |
| 68 | |
| 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. | |
| 73 | |
| 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 | |
| 77 of various users. | |
| 78 This manual describes Viper, concentrating on the differences from Vi and | |
| 79 new features of Viper. | |
| 80 | |
| 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. | |
| 84 | |
| 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. | |
| 90 | |
| 91 Although this manual explains how to customize Viper, some basic | |
| 92 familiarity with Emacs Lisp would be a plus. | |
| 93 | |
| 94 It is recommended that you read the Overview node. The other nodes may | |
| 95 be visited as needed. | |
| 96 | |
| 97 Comments and bug reports are welcome. | |
|
33019
6306740f6938
2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
30009
diff
changeset
|
98 @code{kifer@@cs.sunysb.edu} is the current address for Viper bug reports. |
| 25829 | 99 Please use the Ex command @kbd{:submitReport} for this purpose.@refill |
| 100 | |
| 101 @end ifinfo | |
| 102 | |
| 103 @menu | |
| 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 | |
| 108 | |
| 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 | |
| 114 | |
| 115 * Acknowledgments:: | |
| 116 @end menu | |
| 117 @iftex | |
| 118 @unnumbered Introduction | |
| 119 | |
| 120 We believe that one or more of the following statements are adequate | |
| 121 descriptions: | |
| 122 | |
| 123 @example | |
| 124 Viper Is a Package for Emacs Rebels; | |
| 125 it is a VI Plan for Emacs Rescue | |
| 126 and/or a venomous VI PERil. | |
| 127 @end example | |
| 128 | |
| 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. | |
| 135 | |
| 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. | |
| 139 | |
| 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. | |
| 145 | |
| 146 Although this manual explains how to customize Viper, some basic | |
| 147 familiarity with Emacs Lisp would be a plus. | |
| 148 | |
| 149 It is recommended that you read the chapter Overview. The other chapters | |
| 150 will be useful for customization and advanced usage. | |
| 151 | |
| 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. | |
| 155 | |
| 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 | |
| 159 | |
| 160 @end iftex | |
| 161 | |
| 162 @node Overview,Improvements over Vi,Top,Top | |
| 163 @chapter Overview of Viper | |
| 164 | |
| 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. | |
| 170 | |
| 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. | |
| 173 | |
| 174 @menu | |
| 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 | |
| 178 modes. | |
| 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. | |
| 182 @end menu | |
| 183 | |
| 184 @node Emacs Preliminaries, Loading Viper, Overview, Overview | |
| 185 @section Emacs Preliminaries | |
| 186 | |
| 187 @cindex buffer | |
| 188 @cindex point | |
| 189 @cindex mark | |
| 190 @cindex text | |
| 191 @cindex looking at | |
| 192 @cindex end (of buffer) | |
| 193 @cindex end (of line) | |
| 194 @cindex region | |
| 195 | |
| 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 | |
| 201 | |
| 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 | |
| 208 | |
| 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 | |
| 215 | |
| 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, | |
| 226 etc. | |
| 227 | |
| 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. | |
| 234 | |
| 235 @xref{Basics}, for more info.@refill | |
| 236 | |
| 237 @cindex window | |
| 238 @cindex mode line | |
| 239 @cindex buffer information | |
| 240 @cindex Minibuffer | |
| 241 @cindex command line | |
| 242 @cindex buffer (modified) | |
| 243 | |
| 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{:} | |
| 258 commands.@refill | |
| 259 | |
| 260 @cindex mode | |
| 261 @cindex keymap | |
| 262 @cindex local keymap | |
| 263 @cindex global keymap | |
| 264 @cindex major mode | |
| 265 @cindex minor mode | |
| 266 | |
| 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 | |
| 270 keystrokes and | |
| 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 | |
| 279 | |
| 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 | |
| 287 | |
| 288 @cindex Viper as minor mode | |
| 289 @cindex Control keys | |
| 290 @cindex Meta key | |
| 291 | |
| 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 | |
| 297 | |
| 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 | |
| 306 more info.@refill | |
| 307 | |
| 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}. | |
| 311 | |
| 312 @node Loading Viper, States in Viper, Emacs Preliminaries, Overview | |
| 313 @section Loading Viper | |
| 314 | |
| 315 The most common way to load it automatically is to include the following | |
| 316 lines (in the given order!): | |
| 317 | |
| 318 @lisp | |
| 319 (setq viper-mode t) | |
| 320 (require 'viper) | |
| 321 @end lisp | |
| 322 | |
| 323 @noindent | |
| 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. | |
| 329 | |
| 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}: | |
| 333 @lisp | |
| 334 (setq viper-always t) | |
| 335 @end lisp | |
| 336 @noindent | |
| 337 (@xref{Vi State}, for the explanation of Vi command state.) | |
| 338 | |
| 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 | |
| 341 Viper. | |
| 342 | |
|
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
343 The latest versions of Emacs have an interactive customization facility, |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
344 which allows you to (mostly) bypass the use of the @file{.emacs} and |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
345 @file{.viper} files. You can reach this customization |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
346 facility from within Viper's VI state by executing the Ex command |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
347 @kbd{:customize}. |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
348 |
| 25829 | 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. | |
| 353 | |
| 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: | |
| 357 | |
| 358 @lisp | |
| 359 M-x viper-mode | |
| 360 @end lisp | |
| 361 | |
| 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 | |
| 369 | |
| 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. | |
| 374 | |
| 375 @node States in Viper, The Minibuffer, Loading Viper,Overview | |
| 376 @section States in Viper | |
| 377 | |
| 378 @kindex @kbd{C-z} | |
| 379 @kindex @key{ESC} | |
| 380 @kindex @kbd{i} | |
| 381 @cindex Emacs state | |
| 382 @cindex Vi state | |
| 383 @cindex Insert state | |
| 384 @cindex Replace state | |
| 385 @cindex Ex commands | |
| 386 @findex @code{viper-go-away} | |
| 387 @findex @code{toggle-viper-mode} | |
| 388 | |
| 389 Viper has four states, Emacs, Vi, Insert, and Replace. | |
| 390 | |
| 391 @table @samp | |
| 392 @item Emacs state | |
| 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 | |
| 398 | |
| 399 | |
| 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 | |
|
35411
be20c22dc16d
2001-01-19 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
35188
diff
changeset
|
402 confuse the novice user. In this case, @kbd{C-z} will either iconify Emacs |
|
be20c22dc16d
2001-01-19 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
35188
diff
changeset
|
403 (if Emacs runs as an application under X) or it will stop Emacs (if |
|
be20c22dc16d
2001-01-19 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
35188
diff
changeset
|
404 Emacs runs on a dumb terminal or in an Xterm window). |
| 25829 | 405 |
| 406 @item Vi state | |
| 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 | |
|
36155
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
415 should start them with a @kbd{:}, e.g., @kbd{:WW}. |
| 25829 | 416 |
| 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. | |
| 423 | |
| 424 @item Insert state | |
| 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. | |
| 428 | |
| 429 @item Replace 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 | |
| 436 @end table | |
| 437 | |
| 438 @cindex mode line | |
| 439 | |
| 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). | |
| 452 | |
| 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. | |
| 457 | |
| 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. | |
| 470 | |
| 471 @menu | |
| 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. | |
| 479 @end menu | |
| 480 | |
| 481 @node Emacs State, Vi State, States in Viper, States in Viper | |
| 482 @subsection Emacs State | |
| 483 | |
| 484 @kindex @kbd{C-z} | |
| 485 @cindex Emacs state | |
| 486 | |
| 487 | |
| 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) :-). | |
| 491 | |
| 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 | |
| 500 | |
| 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}. | |
| 507 | |
| 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}. | |
| 512 | |
| 513 | |
| 514 @node Vi State, Insert State, Emacs State, States in Viper | |
| 515 @subsection Vi State | |
| 516 | |
| 517 @cindex Vi state | |
| 518 | |
| 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 | |
| 521 exceptions are: | |
| 522 | |
| 523 @table @kbd | |
| 524 @item C-x | |
| 525 @kindex @kbd{C-x} | |
| 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. | |
| 532 | |
| 533 @item C-c | |
| 534 @kindex @kbd{C-c} | |
| 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} | |
| 537 simply beeps. | |
| 538 | |
| 539 @item C-g and C-] | |
| 540 @kindex @kbd{C-g} | |
| 541 @kindex @kbd{C-]} | |
| 542 | |
| 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} | |
| 552 function instead. | |
| 553 @refill | |
| 554 @item C-\ | |
| 555 @kindex @kbd{C-\} | |
| 556 @cindex Meta key | |
| 557 | |
| 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 | |
|
36043
5d6b76d28b83
2001-02-12 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
35411
diff
changeset
|
560 functions are accessible only via that key as @kbd{M-x function-name}. |
| 25829 | 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 | |
| 566 meta key. | |
| 567 | |
| 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. | |
| 573 @end table | |
| 574 @noindent | |
| 575 Other differences are mostly improvements. The ones you should know | |
| 576 about are: | |
| 577 | |
| 578 @table @samp | |
| 579 @item Undo | |
| 580 @kindex @kbd{u} | |
| 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 | |
| 586 @cindex undo | |
| 587 | |
| 588 | |
| 589 @item Counts | |
| 590 Most commands, @kbd{~}, @kbd{[[}, @kbd{p}, @kbd{/}, @dots{}, etc., take counts. | |
| 591 | |
| 592 @comment ]] Just to balance parens | |
| 593 @item Regexps | |
| 594 Viper uses Emacs Regular Expressions for searches. These are a superset of | |
| 595 Vi regular | |
| 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 | |
| 610 @kindex @kbd{C-c /} | |
| 611 | |
| 612 @item Ex commands | |
| 613 @cindex Ex commands | |
| 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. | |
| 627 | |
| 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 | |
| 635 windows). | |
| 636 | |
| 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. | |
| 644 | |
| 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. | |
| 658 | |
| 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 | |
| 662 argument. | |
| 663 @refill | |
| 664 @end table | |
| 665 @noindent | |
| 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 | |
| 670 `@kbd{.}'. | |
| 671 @xref{Improvements over Vi}, for more information. | |
| 672 | |
| 673 @node Insert State, Replace State, Vi State, States in Viper | |
| 674 @subsection Insert State | |
| 675 | |
| 676 @cindex Insert state | |
| 677 | |
| 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 | |
|
36043
5d6b76d28b83
2001-02-12 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
35411
diff
changeset
|
680 Emacs major modes cannot be used in Insert state. |
| 25829 | 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 | |
| 685 | |
| 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. | |
| 693 | |
| 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, | |
| 697 you can | |
| 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. | |
| 702 | |
| 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.) | |
| 709 | |
| 710 | |
| 711 @cindex Meta key | |
| 712 | |
| 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}. | |
| 715 | |
| 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). | |
| 725 | |
| 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 | |
| 729 the Insert state. | |
| 730 | |
| 731 When Viper is in Insert state, you will see <I> in the mode line. | |
| 732 | |
| 733 @node Replace State,, Insert State, States in Viper | |
| 734 @subsection Replace State | |
| 735 | |
| 736 @cindex Replace state | |
| 737 | |
| 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). | |
| 747 | |
| 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.) | |
| 754 | |
| 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? | |
| 759 | |
| 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 | |
| 763 region. | |
| 764 | |
| 765 @node The Minibuffer,Multiple Files in Viper, States in Viper, Overview | |
| 766 @section The Minibuffer | |
| 767 | |
| 768 @cindex Minibuffer | |
| 769 | |
| 770 The Minibuffer is where commands are entered in. Editing can be done | |
| 771 by commands from Insert state, namely: | |
| 772 | |
| 773 @table @kbd | |
| 774 @item C-h | |
| 775 Backspace | |
| 776 @item C-w | |
| 777 Delete Word | |
| 778 @item C-u | |
| 779 Erase line | |
| 780 @item C-v | |
| 781 Quote the following character | |
| 782 @item @key{RET} | |
| 783 Execute command | |
| 784 @item C-g and C-] | |
| 785 Emacs quit and abort keys. These may be necessary. @xref{Vi State}, for an | |
| 786 explanation. | |
| 787 @item M-p and M-n | |
| 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. | |
| 791 @end table | |
| 792 | |
| 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. | |
| 799 | |
| 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. | |
| 803 | |
| 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. | |
| 809 | |
| 810 @node Multiple Files in Viper,Unimplemented Features,The Minibuffer,Overview | |
| 811 @section Multiple Files in Viper | |
| 812 | |
| 813 @cindex multiple files | |
| 814 @cindex managing multiple files | |
| 815 | |
| 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. | |
| 819 | |
| 820 @table @samp | |
| 821 @item Textmarkers | |
| 822 @cindex markers | |
| 823 @cindex textmarkers | |
| 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}. | |
| 838 @item Registers | |
| 839 @cindex registers | |
| 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}. | |
| 844 | |
| 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 | |
| 859 file name in any | |
| 860 @kbd{:e}, @kbd{:r}, @kbd{:w}, etc., command (in Emacs, each buffer has a | |
| 861 current directory). | |
| 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 | |
| 867 often in Viper. | |
| 868 | |
| 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. | |
| 873 | |
| 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 | |
| 877 want to change this. | |
| 878 @end table | |
| 879 | |
| 880 @noindent | |
| 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 | |
| 883 other files. | |
| 884 | |
| 885 @node Unimplemented Features,,Multiple Files in Viper,Overview | |
| 886 @section Unimplemented Features | |
| 887 | |
| 888 Unimplemented features include: | |
| 889 | |
| 890 @itemize @bullet | |
| 891 @item | |
| 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. | |
| 895 @item | |
| 896 @kbd{:set option?} is not implemented. The current | |
| 897 @kbd{:set} can also be used to set Emacs variables. | |
| 898 @item | |
| 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 | |
| 904 @end itemize | |
| 905 | |
| 906 @comment node-name, next, previous, up | |
| 907 @node Improvements over Vi, Customization, Overview, Top | |
| 908 @chapter Improvements over Vi | |
| 909 | |
| 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. | |
| 913 | |
| 914 @menu | |
| 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. | |
| 926 @end menu | |
| 927 | |
| 928 @node Basics, Undo and Backups, Improvements over Vi, Improvements over Vi | |
| 929 @section Basics | |
| 930 | |
| 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 | |
| 936 | |
| 937 @cindex point commands | |
| 938 | |
| 939 The point commands are: | |
| 940 | |
| 941 @quotation | |
| 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{^} | |
| 945 @end quotation | |
| 946 | |
| 947 @cindex line commands | |
| 948 | |
| 949 The line commands are: | |
| 950 | |
| 951 @quotation | |
| 952 @kbd{j}, @kbd{k}, @kbd{+}, @kbd{-}, @kbd{H}, @kbd{M}, @kbd{L}, @kbd{@{}, | |
| 953 @kbd{@}}, @kbd{G}, @kbd{'}, @kbd{[[}, @kbd{]]}, @kbd{[]} | |
| 954 @end quotation | |
| 955 | |
| 956 @cindex region | |
| 957 @cindex region specification | |
| 958 @cindex expanding (region) | |
| 959 @cindex describing regions | |
| 960 @cindex movement commands | |
| 961 | |
| 962 @noindent | |
| 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 | |
| 970 command. | |
| 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 | |
| 976 @samp{a}. | |
| 977 | |
| 978 @cindex r and R region specifiers | |
| 979 | |
| 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 | |
| 985 region). | |
| 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. | |
| 989 | |
| 990 Viper also adds counts to most commands for which it would make sense. | |
| 991 | |
| 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. | |
| 998 | |
| 999 @node Undo and Backups, History, Basics, Improvements over Vi | |
| 1000 @section Undo and Backups | |
| 1001 | |
| 1002 @cindex undo | |
| 1003 | |
| 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, | |
| 1007 and further | |
| 1008 @kbd{.} will repeat it. Typing @kbd{u} does the first undo, and changes the | |
| 1009 direction. | |
| 1010 | |
| 1011 @cindex backup files | |
| 1012 @cindex auto save | |
| 1013 | |
| 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 | |
| 1018 | |
| 1019 @comment [ balance parens | |
| 1020 @cindex viewing registers and markers | |
| 1021 @cindex registers | |
| 1022 @cindex markers | |
| 1023 @cindex textmarkers | |
| 1024 | |
| 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 | |
| 1034 | |
| 1035 @node History, Macros and Registers, Undo and Backups,Improvements over Vi | |
| 1036 @section History | |
| 1037 | |
| 1038 @cindex history | |
| 1039 @cindex Minibuffer | |
| 1040 | |
| 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: | |
| 1048 | |
| 1049 @table @kbd | |
| 1050 @item M-p and M-n | |
| 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. | |
| 1054 @item M-r and M-s | |
| 1055 To search backward and forward through the history. | |
| 1056 @item @key{RET} | |
| 1057 Type @key{RET} to accept a default (which is displayed in the prompt). | |
| 1058 @end table | |
| 1059 | |
| 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. | |
| 1064 | |
| 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. | |
| 1069 | |
| 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. | |
| 1073 | |
| 1074 @node Macros and Registers,Completion,History,Improvements over Vi | |
| 1075 @section Macros and Registers | |
| 1076 | |
| 1077 @cindex keyboard macros | |
| 1078 @cindex macros | |
| 1079 @cindex registers | |
| 1080 @cindex register execution | |
| 1081 | |
| 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 | |
| 1091 | |
| 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. | |
| 1097 | |
| 1098 @comment [ balance parens | |
| 1099 @cindex viewing registers and markers | |
| 1100 | |
| 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 | |
| 1104 | |
| 1105 @cindex last keyboard macro | |
| 1106 | |
| 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 | |
| 1112 details.@refill | |
| 1113 | |
| 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). | |
| 1117 | |
| 1118 Viper also provides Vi-style macros. @xref{Vi Macros}, for details. | |
| 1119 | |
| 1120 | |
| 1121 @node Completion, Improved Search, Macros and Registers, Improvements over Vi | |
| 1122 @section Completion | |
| 1123 | |
| 1124 @cindex completion | |
| 1125 | |
| 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 | |
| 1130 @kbd{~/bar}. | |
| 1131 | |
| 1132 @node Improved Search, Abbreviation Facilities, Completion, Improvements over Vi | |
| 1133 @section Improved Search | |
| 1134 | |
| 1135 @cindex buffer search | |
| 1136 @cindex word search | |
| 1137 | |
| 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 | |
| 1140 | |
| 1141 @example | |
| 1142 (viper-buffer-search-enable) | |
| 1143 @end example | |
| 1144 | |
| 1145 @noindent | |
| 1146 or by setting @code{viper-buffer-search-char} to, say, @kbd{f3}: | |
| 1147 @example | |
|
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1148 (setq viper-buffer-search-char ?g) |
| 25829 | 1149 @end example |
| 1150 | |
| 1151 @noindent | |
| 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}. | |
| 1159 | |
| 1160 @cindex incremental search | |
| 1161 | |
| 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 | |
| 1169 | |
| 1170 @cindex query replace | |
| 1171 | |
| 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. | |
| 1174 | |
| 1175 @cindex mouse search | |
| 1176 | |
| 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. | |
| 1179 | |
| 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 | |
| 1184 @example | |
| 1185 (copy-face 'default 'viper-search-face) | |
| 1186 @end example | |
| 1187 @vindex @code{viper-search-face} | |
| 1188 @noindent | |
| 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. | |
| 1196 | |
| 1197 Try it: it is really simple! | |
| 1198 | |
| 1199 @node Abbreviation Facilities,Movement and Markers,Improved Search,Improvements over Vi | |
| 1200 @section Abbreviation Facilities | |
| 1201 | |
| 1202 @cindex abbrevs | |
| 1203 | |
| 1204 It is possible in Emacs to define abbrevs based on the contents of the | |
| 1205 buffer. | |
| 1206 Sophisticated templates can be defined using the Emacs abbreviation | |
| 1207 facilities. @xref{Abbrevs,,Abbreviations,emacs,The GNU Emacs Manual}, for | |
| 1208 details. | |
| 1209 | |
| 1210 @cindex dynamic abbrevs | |
| 1211 | |
| 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. | |
| 1222 | |
| 1223 @node Movement and Markers, New Commands, Abbreviation Facilities, Improvements over Vi | |
| 1224 @section Movement and Markers | |
| 1225 | |
| 1226 @cindex Ex style motion | |
| 1227 @cindex line editor motion | |
| 1228 | |
| 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} | |
| 1232 contains | |
| 1233 | |
| 1234 @example | |
| 1235 @code{(setq viper-ex-style-motion nil)} | |
| 1236 @end example | |
| 1237 | |
| 1238 @noindent | |
| 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. | |
| 1243 | |
| 1244 @vindex @code{viper-syntax-preference} | |
| 1245 @cindex syntax table | |
| 1246 | |
| 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. | |
| 1259 | |
| 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 | |
| 1266 situations. | |
| 1267 | |
| 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}. | |
| 1273 | |
| 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: | |
| 1277 | |
| 1278 @example | |
| 1279 (viper-set-syntax-preference nil "emacs") | |
| 1280 @end example | |
| 1281 | |
| 1282 @findex @code{viper-set-syntax-preference} | |
| 1283 | |
| 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 | |
| 1290 tables. | |
| 1291 | |
| 1292 @cindex textmarkers | |
| 1293 | |
| 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}). | |
| 1298 | |
| 1299 @node New Commands, Useful Packages, Movement and Markers, Improvements over Vi | |
| 1300 @section New Commands | |
| 1301 | |
| 1302 These commands have no Vi analogs. | |
| 1303 | |
| 1304 @table @kbd | |
| 1305 @item C-x, C-c | |
| 1306 @kindex @kbd{C-x} | |
| 1307 @kindex @kbd{C-c} | |
| 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 | |
| 1315 @item \ | |
| 1316 @kindex @kbd{\} | |
| 1317 Escape to Emacs to execute a single Emacs command. For instance, | |
| 1318 @kbd{\ @key{ESC}} will act like a Meta key. | |
| 1319 @item Q | |
| 1320 @kindex @kbd{Q} | |
| 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). | |
| 1327 @item v | |
| 1328 @itemx V | |
| 1329 @itemx C-v | |
| 1330 @kindex @kbd{v} | |
| 1331 @kindex @kbd{V} | |
| 1332 @kindex @kbd{C-v} | |
| 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. | |
| 1338 @item # | |
| 1339 @kindex @kbd{#} | |
| 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 | |
| 1346 @item # c | |
| 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. | |
| 1352 @item # C | |
| 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. | |
| 1358 @item # g | |
| 1359 @kindex @kbd{#g<move>} | |
| 1360 Execute last keyboard macro for each line in the region | |
| 1361 (@code{viper-global-execute}).@refill | |
| 1362 @item # q | |
| 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. | |
| 1367 @item # s | |
| 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} | |
| 1373 @item * | |
| 1374 @kindex @kbd{*} | |
| 1375 Call last keyboard macro. | |
| 1376 @item m . | |
| 1377 Set mark at point and push old mark off the ring | |
| 1378 @item m< | |
| 1379 @item m> | |
| 1380 Set mark at beginning and end of buffer, respectively. | |
| 1381 @item m, | |
| 1382 Jump to mark and pop mark off the ring. @xref{Mark,,Mark,emacs,The GNU | |
| 1383 Emacs Manual}, for more info. | |
| 1384 @item ] register | |
| 1385 @kindex @kbd{]<a-z>} | |
| 1386 View contents of register | |
| 1387 @item [ textmarker | |
| 1388 @kindex @kbd{[<a-z>} | |
| 1389 View filename and position of textmarker | |
| 1390 @item @@# | |
| 1391 @item @@register | |
| 1392 @item @@! | |
| 1393 @kindex @kbd{@@#} | |
| 1394 @kindex @kbd{@@<a-z>} | |
| 1395 @kindex @kbd{@@!} | |
| 1396 @cindex keyboard macros | |
| 1397 @cindex register execution | |
| 1398 | |
| 1399 Begin/end keyboard macro. @@register has a different meaning when used after | |
| 1400 a @kbd{@@#}. @xref{Macros and Registers}, for details | |
| 1401 @item [] | |
| 1402 @kindex @kbd{[]} | |
| 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 | |
| 1408 @item C-g and C-] | |
| 1409 @kindex @kbd{C-g} | |
| 1410 @kindex @kbd{C-]} | |
| 1411 Quit and Abort Recursive edit. These may be necessary on occasion. | |
| 1412 @xref{Vi State}, for a reason. | |
|
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1413 @item C-c C-g |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1414 @kindex @kbd{C-c C-g} |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1415 Hitting @kbd{C-c} followed by @kbd{C-g} will display the information on the |
| 25829 | 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. | |
| 1418 @item C-c / | |
| 1419 @kindex @kbd{C-c /} | |
| 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 | |
| 1426 this function. | |
| 1427 @cindex vanilla search | |
| 1428 @cindex case-sensitive search | |
| 1429 @cindex case-insensitive search | |
| 1430 | |
| 1431 @item M-p and M-n | |
| 1432 @kindex @kbd{M-p} | |
| 1433 @kindex @kbd{M-n} | |
| 1434 In the Minibuffer, these commands navigate through the minibuffer | |
| 1435 histories, such as the history of search strings, Ex commands, etc. | |
| 1436 | |
| 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 | |
| 1444 | |
| 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. | |
| 1449 | |
| 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 | |
| 1454 one. Once | |
| 1455 an appropriate command is found, it can be executed by typing `@kbd{.}'. | |
| 1456 | |
| 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. | |
| 1460 | |
| 1461 @item Ex commands | |
| 1462 @findex @kbd{:args} | |
| 1463 @findex @kbd{:n} | |
| 1464 @findex @kbd{:pwd} | |
| 1465 @findex @kbd{:pre} | |
| 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} | |
| 1475 @end table | |
| 1476 | |
| 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. | |
| 1480 | |
| 1481 @node Useful Packages, ,New Commands, Improvements over Vi | |
| 1482 @section Useful Packages | |
| 1483 | |
| 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. | |
| 1488 | |
| 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 | |
| 1491 Manual. | |
| 1492 | |
| 1493 The features first. For details, look up the Emacs Manual. | |
| 1494 | |
| 1495 @table @samp | |
| 1496 @item Make | |
| 1497 @cindex make | |
| 1498 @cindex compiling | |
| 1499 | |
| 1500 Makes and Compiles can be done from the editor. Error messages will be | |
| 1501 parsed and you can move to the error lines. | |
| 1502 @item Shell | |
| 1503 @cindex shell | |
| 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. | |
| 1507 @item Mail | |
| 1508 @cindex email | |
| 1509 @cindex mail | |
| 1510 Mail can be read from and sent within the editor. Several sophisticated | |
| 1511 packages exist. | |
| 1512 @item Language Sensitive Editing | |
| 1513 Editing modes are written for most computer languages in existence. By | |
| 1514 controlling indentation, they catch punctuation errors. | |
| 1515 @end table | |
| 1516 | |
| 1517 The packages, below, represents a drop in the sea of special-purpose | |
| 1518 packages that come with standard distribution of Emacs. | |
| 1519 | |
| 1520 @table @samp | |
| 1521 @item Transparent FTP | |
| 1522 @cindex transparent ftp | |
| 1523 @pindex ange-ftp.el | |
| 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 | |
| 1528 @cindex RCS | |
| 1529 @pindex vc.el | |
| 1530 @code{vc.el} for doing RCS commands from inside the editor | |
| 1531 @item Directory Editor | |
| 1532 @cindex dired | |
| 1533 @pindex dired.el | |
| 1534 @code{dired.el} for editing contents of directories and for navigating in | |
| 1535 the file system. | |
| 1536 @item Syntactic Highlighting | |
| 1537 @cindex font-lock | |
| 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 | |
| 1542 @cindex desktop | |
| 1543 @pindex desktop.el | |
| 1544 @code{desktop.el} for saving/restoring configuration on Emacs exit/startup. | |
| 1545 @item Spell Checker | |
| 1546 @cindex ispell | |
| 1547 @pindex ispell.el | |
| 1548 @code{ispell.el} for spell checking the buffer, words, regions, etc. | |
| 1549 @item File and Buffer Comparison | |
| 1550 @cindex ediff | |
| 1551 @pindex ediff.el | |
| 1552 @code{ediff.el} for finding differences between files and for applying | |
| 1553 patches. | |
| 1554 @end table | |
| 1555 | |
| 1556 @noindent | |
| 1557 Emacs Lisp archives exist on | |
| 1558 @samp{archive.cis.ohio-state.edu} | |
| 1559 and @samp{wuarchive.wustl.edu}@refill | |
| 1560 | |
| 1561 | |
| 1562 @node Customization,Commands,Improvements over Vi,Top | |
| 1563 @chapter Customization | |
| 1564 | |
| 1565 @cindex customization | |
| 1566 | |
| 1567 Customization can be done in 2 ways. | |
| 1568 | |
| 1569 @itemize @bullet | |
| 1570 @item | |
| 1571 @cindex initialization | |
| 1572 @cindex .viper | |
| 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. | |
| 1576 @item | |
| 1577 @cindex .emacs | |
| 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 | |
| 1583 @end itemize | |
| 1584 | |
| 1585 @noindent | |
| 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}). | |
| 1593 | |
| 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. | |
| 1597 | |
| 1598 @menu | |
| 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. | |
| 1604 @end menu | |
| 1605 | |
| 1606 @node Rudimentary Changes,Keybindings,Customization,Customization | |
| 1607 @section Rudimentary Changes | |
| 1608 | |
| 1609 @cindex setting variables | |
| 1610 @cindex variables for customization | |
| 1611 @findex @kbd{:set} | |
| 1612 | |
| 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). | |
| 1617 | |
| 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 | |
| 1620 @key{SPC} complete | |
| 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}}. | |
| 1631 | |
| 1632 @table @code | |
| 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. | |
| 1638 | |
| 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. | |
| 1644 | |
| 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 | |
| 1651 features. | |
| 1652 | |
| 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 | |
| 1655 all buffers. | |
| 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 | |
| 1661 @itemx :se magic | |
| 1662 If not @code{nil}, search will use regular expressions; if @code{nil} then | |
| 1663 use vanilla search. | |
| 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, | |
| 1677 use @code{setq}. | |
| 1678 | |
| 1679 The command @kbd{:se ts} | |
| 1680 sets the tab width in the current | |
| 1681 buffer only; it has no effect on other buffers. | |
| 1682 | |
| 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. | |
| 1686 | |
| 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). | |
| 1692 | |
| 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. | |
| 1696 | |
| 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 | |
| 1732 exercise restraint. | |
| 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. | |
| 1737 | |
| 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. | |
|
28510
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1740 @item viper-translate-all-ESC-keysequences t on tty, nil on windowing display |
|
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1741 Normally, Viper lets Emacs translate only those ESC key sequences that are |
|
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1742 defined in the low-level key-translation-map or function-key-map, such as those |
|
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1743 emitted by the arrow and function keys. Other sequences, e.g., @kbd{\\e/}, are |
|
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1744 treated as @kbd{ESC} command followed by a @kbd{/}. This is good for people |
|
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1745 who type fast and tend to hit other characters right after they hit |
|
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1746 ESC. Other people like Emacs to translate @kbd{ESC} sequences all the time. |
|
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1747 The default is to translate all sequences only when using a dumb terminal. |
|
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1748 This permits you to use @kbd{ESC} as a meta key in insert mode. For instance, |
|
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1749 hitting @kbd{ESC x} fast would have the effect of typing @kbd{M-x}. |
|
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1750 If your dumb terminal is not so dumb and understands the meta key, then you |
|
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1751 probably will be better off setting this variable to nil. Try and see which |
|
6fb7a3864791
2000-04-07 Mikio Nakajima <minakaji@osaka.email.ne.jp>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
26490
diff
changeset
|
1752 way suits you best. |
| 25829 | 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 | |
|
36340
1ca425b36c74
(Rudimentary Changes): Remove doubled `to'.
Gerd Moellmann <gerd@gnu.org>
parents:
36155
diff
changeset
|
1757 Set this to @code{nil}, if you want |
| 25829 | 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 | |
| 1766 up in Vi state, | |
| 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}). | |
| 1771 | |
| 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. | |
|
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1780 @item viper-glob-function |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1781 The value of this variable is the function symbol used to expand wildcard |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1782 symbols. This is platform-dependent. The default tries to set this variable |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1783 to work with most Unix shells, MS Windows, OS/2, etc. However, if it |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1784 doesn't work the way you expect, you should write your own. |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1785 Use @code{viper-glob-unix-files} and @code{viper-glob-mswindows-files} in |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1786 @file{viper-util.el} as examples. |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1787 |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1788 This feature is used to expand wildcards in the Ex command @kbd{:e}. |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1789 Note that Viper doesn't support wildcards in the @kbd{:r} and @kbd{:w} |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1790 commands, because file completion is a better mechanism. |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1791 @findex @code{viper-glob-function} |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
1792 |
| 25829 | 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 | |
| 1798 buffers also. | |
| 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 | |
| 1818 the @kbd{.} key. | |
| 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 | |
| 1827 this. | |
| 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 | |
| 1837 anything. | |
| 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. | |
| 1842 | |
| 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. | |
| 1846 | |
| 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: | |
| 1852 @example | |
| 1853 (set-face-foreground viper-replace-overlay-face "DarkSlateBlue") | |
| 1854 (set-face-background viper-replace-overlay-face "yellow") | |
| 1855 @end example | |
| 1856 For a complete list of colors available to you, evaluate the expression | |
| 1857 @code{(x-defined-colors)}. (Type it in the buffer @code{*scratch*} and then | |
| 1858 hit the @kbd{C-j} key. | |
| 1859 | |
| 1860 @item viper-replace-overlay-cursor-color "Red" | |
| 1861 @vindex @code{viper-replace-overlay-cursor-color} | |
| 1862 Cursor color when it is inside the replacement region. | |
| 1863 This has effect only on color displays and only when Emacs runs as an X | |
| 1864 application. | |
| 1865 @item viper-insert-state-cursor-color nil | |
| 1866 @vindex @code{viper-insert-state-cursor-color} | |
| 1867 If set to a valid color, this will be the cursor color when Viper is in | |
| 1868 insert state. | |
| 1869 @item viper-replace-region-end-delimiter "$" | |
| 1870 A string used to mark the end of replacement regions. It is used only on | |
| 1871 TTYs or if @code{viper-use-replace-region-delimiters} is non-nil. | |
| 1872 @item viper-replace-region-start-delimiter "" | |
| 1873 A string used to mark the beginning of replacement regions. It is used | |
| 1874 only on TTYs or if @code{viper-use-replace-region-delimiters} is non-nil. | |
| 1875 @item viper-use-replace-region-delimiters | |
| 1876 If non-nil, Viper will always use @code{viper-replace-region-end-delimiter} and | |
| 1877 @code{viper-replace-region-start-delimiter} to delimit replacement regions, | |
| 1878 even on color displays (where this is unnecessary). By default, this | |
| 1879 variable is non-nil only on TTYs or monochrome displays. | |
| 1880 @item viper-allow-multiline-replace-regions t | |
| 1881 If non-nil, multi-line text replacement regions, such as those produced by | |
| 1882 commands @kbd{c55w}, @kbd{3C}, etc., will stay around until the user exits | |
| 1883 the replacement mode. In this variable is set to @code{nil}, Viper will | |
| 1884 emulate the standard Vi behavior, which supports only intra-line | |
| 1885 replacement regions (and multi-line replacement regions are deleted). | |
| 1886 @item viper-toggle-key "\C-z" | |
| 1887 Specifies the key used to switch from Emacs to Vi and back. | |
| 1888 Must be set in @file{.viper}. This variable can't be | |
| 1889 changed interactively after Viper is loaded. | |
| 1890 | |
| 1891 In Insert state, this key acts as a temporary escape to Vi state, i.e., it | |
| 1892 will set Viper up so that the very next command will be executed as if it | |
| 1893 were typed in Vi state. | |
| 1894 @item viper-ESC-key "\e" | |
| 1895 Specifies the key used to escape from Insert/Replace states to Vi. | |
| 1896 Must be set in @file{.viper}. This variable cannot be | |
| 1897 changed interactively after Viper is loaded. | |
| 1898 @item viper-buffer-search-char nil | |
| 1899 Key used for buffer search. @xref{Viper Specials}, for details. | |
| 1900 @item viper-surrounding-word-function 'viper-surrounding-word | |
| 1901 The value of this variable is a function name that is used to determine | |
| 1902 what constitutes a word clicked upon by the mouse. This is used by mouse | |
| 1903 search and insert. | |
| 1904 @item viper-search-face 'viper-search-face | |
| 1905 Variable that controls how search patterns are highlighted when they are | |
| 1906 found. | |
| 1907 @item viper-vi-state-hook nil | |
| 1908 List of parameterless functions to be run just after entering the Vi | |
| 1909 command state. | |
| 1910 @item viper-insert-state-hook nil | |
| 1911 Same for Insert state. This hook is also run after entering Replace state. | |
| 1912 @item viper-replace-state-hook nil | |
| 1913 List of (parameterless) functions called just after entering Replace state | |
| 1914 (and after all @code{viper-insert-state-hook}). | |
| 1915 @item viper-emacs-state-hook nil | |
| 1916 List of (parameterless) functions called just after switching from Vi state | |
| 1917 to Emacs state. | |
| 1918 @item viper-load-hook nil | |
| 1919 List of (parameterless) functions called just after loading Viper. This is | |
| 1920 the last chance to do customization before Viper is up and running. | |
| 1921 @end table | |
| 1922 @noindent | |
| 1923 You can reset some of these constants in Viper with the Ex command @kbd{:set} | |
| 1924 (when so indicated in the table). Or you | |
| 1925 can include a line like this in your @file{.viper} file: | |
| 1926 @example | |
| 1927 (setq viper-case-fold-search t) | |
| 1928 @end example | |
| 1929 @vindex @code{viper-auto-indent} | |
| 1930 @vindex @code{viper-electric-mode} | |
| 1931 @vindex @code{viper-case-fold-search} | |
| 1932 @vindex @code{viper-re-search} | |
| 1933 @vindex @code{viper-shift-width} | |
| 1934 @vindex @code{buffer-read-only} | |
| 1935 @vindex @code{viper-search-wrap-around} | |
| 1936 @vindex @code{viper-search-scroll-threshold} | |
| 1937 @vindex @code{viper-search-face} | |
| 1938 @vindex @code{viper-tags-file-name} | |
| 1939 @vindex @code{viper-re-query-replace} | |
| 1940 @vindex @code{viper-want-ctl-h-help} | |
| 1941 @vindex @code{viper-vi-style-in-minibuffer} | |
| 1942 @vindex @code{viper-no-multiple-ESC} | |
| 1943 @vindex @code{viper-always} | |
| 1944 @vindex @code{viper-ESC-keyseq-timeout} | |
| 1945 @vindex @code{viper-fast-keyseq-timeout} | |
| 1946 @vindex @code{viper-ex-style-motion} | |
| 1947 @vindex @code{viper-ex-style-editing} | |
| 1948 @vindex @code{viper-ESC-moves-cursor-back} | |
| 1949 @vindex @code{viper-custom-file-name} | |
| 1950 @vindex @code{viper-spell-function} | |
| 1951 @vindex @code{ex-cycle-other-window} | |
| 1952 @vindex @code{ex-cycle-through-non-files} | |
| 1953 @vindex @code{viper-want-emacs-keys-in-insert} | |
| 1954 @vindex @code{viper-want-emacs-keys-in-vi} | |
| 1955 @vindex @code{viper-keep-point-on-repeat} | |
| 1956 @vindex @code{viper-keep-point-on-undo} | |
| 1957 @vindex @code{viper-delete-backwards-in-replace} | |
| 1958 @vindex @code{viper-replace-overlay-face} | |
| 1959 @vindex @code{viper-replace-region-end-symbol} | |
| 1960 @vindex @code{viper-replace-region-start-symbol} | |
| 1961 @vindex @code{viper-allow-multiline-replace-regions} | |
| 1962 @vindex @code{viper-toggle-key} | |
| 1963 @vindex @code{viper-ESC-key} | |
| 1964 @vindex @code{viper-buffer-search-char} | |
| 1965 @vindex @code{viper-surrounding-word-function} | |
| 1966 @vindex @code{viper-vi-state-hook} | |
| 1967 @vindex @code{viper-insert-state-hook} | |
| 1968 @vindex @code{viper-replace-state-hook} | |
| 1969 @vindex @code{viper-emacs-state-hook} | |
| 1970 | |
| 1971 @node Keybindings, Packages that Change Keymaps, Rudimentary Changes,Customization | |
| 1972 @section Keybindings | |
| 1973 | |
| 1974 @cindex keybindings | |
| 1975 @cindex keymaps | |
| 1976 | |
| 1977 Viper lets you define hot keys, i.e., you can associate keyboard keys | |
| 1978 such as F1, Help, PgDn, etc., with Emacs Lisp functions (that may already | |
| 1979 exist or that you will write). Each key has a "preferred form" in | |
| 1980 Emacs. For instance, the Up key's preferred form is [up], the Help key's | |
| 1981 preferred form is [help], and the Undo key has the preferred form [f14]. | |
| 1982 You can find out the preferred form of a key by typing @kbd{M-x | |
| 1983 describe-key-briefly} and then typing the key you want to know about. | |
| 1984 | |
|
35188
94d46968a93f
Don't say "X Windows". From Colin Walters <walters@cis.ohio-state.edu>.
Eli Zaretskii <eliz@gnu.org>
parents:
33679
diff
changeset
|
1985 Under the X Window System, every keyboard key emits its preferred form, |
|
94d46968a93f
Don't say "X Windows". From Colin Walters <walters@cis.ohio-state.edu>.
Eli Zaretskii <eliz@gnu.org>
parents:
33679
diff
changeset
|
1986 so you can just type |
| 25829 | 1987 |
| 1988 @lisp | |
| 1989 (global-set-key [f11] 'calendar) ; L1, Stop | |
| 1990 (global-set-key [f14] 'undo) ; L4, Undo | |
| 1991 @end lisp | |
| 1992 | |
| 1993 @noindent | |
| 1994 to bind L1 so it will invoke the Emacs Calendar and to bind L4 so it will | |
| 1995 undo changes. | |
| 1996 However, on a dumb terminal or in an Xterm window, even the standard arrow | |
| 1997 keys may | |
| 1998 not emit the right signals for Emacs to understand. To let Emacs know about | |
| 1999 those keys, you will have to find out which key sequences they emit | |
| 2000 by typing @kbd{C-q} and then the key (you should switch to Emacs state | |
| 2001 first). Then you can bind those sequences to their preferred forms using | |
| 2002 @code{function-key-map} as follows: | |
| 2003 | |
| 2004 @lisp | |
| 2005 (cond ((string= (getenv "TERM") "xterm") | |
| 2006 (define-key function-key-map "\e[192z" [f11]) ; L1 | |
| 2007 (define-key function-key-map "\e[195z" [f14]) ; L4, Undo | |
| 2008 @end lisp | |
| 2009 | |
| 2010 The above illustrates how to do this for Xterm. On VT100, you would have to | |
| 2011 replace "xterm" with "vt100" and also change the key sequences (the same | |
| 2012 key may emit different sequences on different types of terminals). | |
| 2013 | |
| 2014 The above keys are global, so they are overwritten by the local maps | |
| 2015 defined by the major modes and by Viper itself. Therefore, if you wish to | |
| 2016 change a binding set by a major mode or by Viper, read this. | |
| 2017 | |
| 2018 Viper users who wish to specify their own key bindings should be concerned | |
| 2019 only with the following three keymaps: | |
| 2020 @code{viper-vi-global-user-map} for Vi state commands, | |
| 2021 @code{viper-insert-global-user-map} for Insert state commands, | |
| 2022 and @code{viper-emacs-global-user-map} for Emacs state commands (note: | |
| 2023 customized bindings for Emacs state made to @code{viper-emacs-global-user-map} | |
| 2024 are @emph{not} inherited by Insert state). | |
| 2025 | |
| 2026 For more information on Viper keymaps, see the header of the file | |
| 2027 @file{viper.el}. | |
| 2028 If you wish to change a Viper binding, you can use the | |
| 2029 @code{define-key} command, to modify @code{viper-vi-global-user-map}, | |
| 2030 @code{viper-insert-global-user-map}, and @code{viper-emacs-global-user-map}, as | |
| 2031 explained below. Each of these key maps affects the corresponding Viper state. | |
|
29165
641e43bad886
2000-05-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
28510
diff
changeset
|
2032 The keymap @code{viper-insert-global-user-map} also affects Viper's Replace |
|
641e43bad886
2000-05-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
28510
diff
changeset
|
2033 state. |
| 25829 | 2034 |
| 2035 @noindent | |
| 2036 If you want to | |
| 2037 bind a key, say @kbd{C-v}, to the function that scrolls | |
| 2038 page down and to make @kbd{0} display information on the current buffer, | |
| 2039 putting this in @file{.viper} will do the trick in Vi state: | |
| 2040 @example | |
| 2041 (define-key viper-vi-global-user-map "\C-v" 'scroll-down) | |
| 2042 @end example | |
| 2043 @noindent | |
| 2044 To set a key globally, | |
| 2045 @example | |
| 2046 (define-key viper-emacs-global-user-map "\C-c m" 'smail) | |
| 2047 (define-key viper-vi-global-user-map "0" 'viper-info-on-file) | |
| 2048 @end example | |
| 2049 @noindent | |
| 2050 Note, however, that this binding may be overwritten by other keymaps, since | |
| 2051 the global keymap has the lowest priority. | |
| 2052 To make sure that nothing will override a binding in Emacs state, you | |
| 2053 can write this: | |
| 2054 @example | |
| 2055 (define-key viper-emacs-global-user-map "\C-c m" 'smail) | |
| 2056 @end example | |
| 2057 @noindent | |
| 2058 To customize the binding for @kbd{C-h} in Insert state: | |
| 2059 @example | |
| 2060 (define-key viper-insert-global-user-map "\C-h" 'my-del-backwards-function) | |
| 2061 @end example | |
| 2062 @noindent | |
| 2063 | |
| 2064 Each Emacs command key calls some lisp function. If you have enabled the | |
| 2065 Help, (@pxref{Rudimentary Changes}) @kbd{C-h k} will show you the function | |
| 2066 for each specific key; @kbd{C-h b} will show all bindings, and @kbd{C-h m} | |
| 2067 will provide information on the major mode in effect. If Help is not | |
| 2068 enabled, you can still get help in Vi state by prefixing the above commands | |
| 2069 with @kbd{\}, e.g., @kbd{\ C-h k} (or you can use the Help menu in the | |
|
35188
94d46968a93f
Don't say "X Windows". From Colin Walters <walters@cis.ohio-state.edu>.
Eli Zaretskii <eliz@gnu.org>
parents:
33679
diff
changeset
|
2070 menu bar, if Emacs runs under X). |
| 25829 | 2071 |
| 2072 Viper users can also change bindings on a per major mode basis. As with | |
| 2073 global bindings, this can be done separately for each of the three main Viper | |
| 2074 states. To this end, Viper provides the function | |
| 2075 @code{viper-modify-major-mode}. | |
| 2076 @findex @code{viper-modify-major-mode} | |
| 2077 | |
| 2078 To modify keys in Emacs state for @code{my-favorite-major-mode}, the user | |
| 2079 needs to create a sparse keymap, say, @code{my-fancy-map}, bind whatever | |
| 2080 keys necessary in that keymap, and put | |
| 2081 | |
| 2082 @example | |
| 2083 (viper-modify-major-mode 'dired-mode 'emacs-state my-fancy-map) | |
| 2084 @end example | |
| 2085 | |
| 2086 @noindent | |
| 2087 in @file{~/.viper}. To do the same in Vi and Insert states, you should use | |
| 2088 @code{vi-state} and @code{insert-state}. Changes in Insert state are also | |
| 2089 in effect in Replace state. For instance, suppose that the user wants to | |
| 2090 use @kbd{dd} in Vi state under Dired mode to delete files, @kbd{u} to unmark | |
| 2091 files, etc. The following code in @file{~/.viper} will then do the job: | |
| 2092 | |
| 2093 @example | |
| 2094 (setq my-dired-modifier-map (make-sparse-keymap)) | |
| 2095 (define-key my-dired-modifier-map "dd" 'dired-flag-file-deletion) | |
| 2096 (define-key my-dired-modifier-map "u" 'dired-unmark) | |
| 2097 (viper-modify-major-mode 'dired-mode 'vi-state my-dired-modifier-map) | |
| 2098 @end example | |
| 2099 | |
| 2100 A Vi purist may want to modify Emacs state under Dired mode so that | |
| 2101 @kbd{k}, @kbd{l}, etc., will move around in directory buffers, as in | |
| 2102 Vi. Although this is not recommended, as these keys are bound to useful | |
| 2103 Dired functions, the trick can be accomplished via the following code: | |
| 2104 | |
| 2105 @example | |
| 2106 (setq my-dired-vi-purist-map (make-sparse-keymap)) | |
| 2107 (define-key my-dired-vi-purist-map "k" 'viper-previous-line) | |
| 2108 (define-key my-dired-vi-purist-map "l" 'viper-forward-char) | |
| 2109 (viper-modify-major-mode 'dired-mode 'emacs-state my-dired-vi-purist-map) | |
| 2110 @end example | |
| 2111 | |
| 2112 Yet another way to customize key bindings in a major mode is to edit the | |
| 2113 list @code{viper-major-mode-modifier-list} using the customization widget. | |
| 2114 @vindex @code{viper-major-mode-modifier-list} | |
| 2115 (This variable is in the Viper-misc customization group.) | |
| 2116 The elements of this list are triples of the form: (major-mode viper-state | |
| 2117 keymap), where the keymap contains bindings that are supposed to be active | |
| 2118 in the given major mode and the given viper-state. | |
| 2119 | |
| 2120 Effects similar to key binding changes can be achieved by defining Vi | |
| 2121 keyboard macros using the Ex commands @kbd{:map} and @kbd{:map!}. The | |
| 2122 difference is that multi-key Vi macros do not override the keys they are | |
| 2123 bound to, unless these keys are typed in quick succession. So, with macros, | |
| 2124 one can use the normal keys alongside with the macros. If per-mode | |
| 2125 modifications are needed, the user can try both ways and see which one is | |
| 2126 more convenient. | |
| 2127 @findex @kbd{:map} | |
| 2128 @xref{Vi Macros}, for details. | |
| 2129 | |
| 2130 Note: in major modes that come up in @emph{Emacs state} by default, the | |
| 2131 aforesaid modifications may not take place immediately (but only after the | |
| 2132 buffer switches to some other Viper state and then back to Emacs state). To | |
| 2133 avoid this, one should add @code{viper-change-state-to-emacs} to an | |
| 2134 appropriate hook of that major mode. (Check the function | |
| 2135 @code{viper-set-hooks} in @file{viper.el} for examples.) However, if you | |
| 2136 have set @code{viper-always} to @code{t}, chances are that you won't need to | |
| 2137 perform the above procedure, because Viper will take care of most useful | |
| 2138 defaults. | |
| 2139 | |
| 2140 | |
| 2141 Finally, Viper has a facility that lets the user define per-buffer | |
| 2142 bindings, i.e., bindings that are in effect in some specific buffers | |
| 2143 only. Unlike per-mode bindings described above, per-buffer bindings can be | |
| 2144 defined based on considerations other than the major mode. This is done | |
| 2145 via the function @code{viper-add-local-keys}, which lets one specify bindings | |
| 2146 that should be in effect in the current buffer only and for a specific Viper | |
| 2147 state. For instance, | |
| 2148 @lisp | |
| 2149 (viper-add-local-keys 'vi-state '(("ZZ" .@: TeX-command-master) | |
| 2150 ("ZQ" .@: viper-save-kill-buffer))) | |
| 2151 @end lisp | |
| 2152 @noindent | |
| 2153 redefines @kbd{ZZ} to invoke @code{TeX-command-master} in @code{vi-state} | |
| 2154 and @kbd{ZQ} to save-then-kill the current buffer. These bindings take | |
| 2155 effect only in the buffer where this command is executed. The typical use | |
| 2156 of this function is to execute the above expression from within a function | |
| 2157 that is included in a hook to some major mode. For instance, the above | |
| 2158 expression | |
| 2159 could be called from a function, @code{my-tex-init}, which may be added to | |
| 2160 @code{tex-mode-hook} as follows: | |
| 2161 @lisp | |
| 2162 (add-hook 'tex-mode-hook 'my-tex-init) | |
| 2163 @end lisp | |
| 2164 @noindent | |
| 2165 When TeX mode starts, the hook is executed and the above Lisp expression is | |
| 2166 evaluated. Then, the bindings for @kbd{ZZ} and @kbd{ZQ} are changed in Vi | |
| 2167 command mode for all buffers in TeX mode. | |
| 2168 | |
| 2169 Another useful application is to bind @kbd{ZZ} to @code{send-mail} | |
| 2170 in the Mail mode buffers (the specifics of this depend on which mail | |
| 2171 package you are using, @code{rmail}, @code{mh-e}, @code{vm}, etc. | |
| 2172 For instance, here is how to do this for @code{mh-e}, the Emacs interface | |
| 2173 to MH: | |
| 2174 @lisp | |
| 2175 (defun mh-add-vi-keys () | |
| 2176 "Set up ZZ for MH-e and XMH." | |
| 2177 (viper-add-local-keys 'vi-state '(("ZZ" .@: mh-send-letter)))) | |
| 2178 (add-hook 'mh-letter-mode-hook 'mh-add-vi-keys) | |
| 2179 @end lisp | |
| 2180 | |
| 2181 You can also use @code{viper-add-local-keys} to set per buffer | |
| 2182 bindings in Insert state and Emacs state by passing as a parameter the | |
| 2183 symbols @code{insert-state} and @code{emacs-state}, respectively. | |
| 2184 As with global bindings, customized local bindings done to Emacs state | |
| 2185 are not inherited by Insert state. | |
| 2186 | |
| 2187 On rare occasions, local keys may be added by mistake. Usually this is done | |
| 2188 indirectly, by invoking a major mode that adds local keys (e.g., | |
| 2189 @code{shell-mode} redefines @key{RET}). In such a case, exiting the wrong | |
| 2190 major mode won't rid you from unwanted local keys, since these keys are | |
| 2191 local to Viper state and the current buffer, not to the major mode. | |
| 2192 In such situations, the remedy is to type @kbd{M-x viper-zap-local-keys}. | |
| 2193 | |
| 2194 So much about Viper-specific bindings. | |
| 2195 @xref{Customization,,Customization,emacs,The GNU Emacs | |
| 2196 Manual}, and the Emacs quick reference card for the general info on key | |
| 2197 bindings in Emacs. | |
| 2198 | |
| 2199 @vindex @code{function-key-map} | |
| 2200 @vindex @code{viper-vi-global-user-map} | |
| 2201 @vindex @code{viper-insert-global-user-map} | |
| 2202 @vindex @code{viper-emacs-global-user-map} | |
| 2203 @findex @code{viper-add-local-keys} | |
| 2204 @findex @code{viper-zap-local-keys} | |
| 2205 | |
| 2206 @node Packages that Change Keymaps,Viper Specials,Keybindings,Customization | |
| 2207 @subsection Packages that Change Keymaps | |
| 2208 @cindex C-c and Viper | |
| 2209 @cindex Viper and C-c | |
| 2210 | |
| 2211 Viper is designed to coexist with all major and minor modes of Emacs. This | |
| 2212 means that bindings set by those modes are generally available with Viper | |
| 2213 (unless you explicitly prohibit them by setting | |
| 2214 @code{viper-want-emacs-keys-in-vi} and @code{viper-want-emacs-keys-in-insert} to | |
| 2215 @code{nil}). | |
| 2216 If @code{viper-always} is set to @code{t}, Viper will try to bring each buffer | |
| 2217 in the Viper state that is most appropriate for that buffer. | |
| 2218 Usually, this would be the Vi state, but sometimes it could be the Insert | |
| 2219 state or the Emacs state. | |
| 2220 | |
| 2221 Some major mode bindings will necessarily be overwritten by Viper. Indeed, in | |
| 2222 Vi state, most of the 1-character keys are used for Vi-style editing. This | |
| 2223 usually causes no problems because most packages designed for editing files | |
| 2224 typically do not bind such keys. Instead, they use key sequences that start | |
| 2225 with @kbd{C-x} and @kbd{C-c}. This is why it was so important for us to | |
| 2226 free up @kbd{C-x} and @kbd{C-c}. | |
| 2227 It is common for language-specific major modes to bind @key{TAB} and | |
| 2228 @kbd{C-j} (the line feed) keys to various formatting functions. This is | |
| 2229 extremely useful, but may require some getting used to for a Vi user. If you | |
| 2230 decide that this feature is not for you, you can re-bind these keys as | |
| 2231 explained earlier (@pxref{Customization}). | |
| 2232 | |
| 2233 Binding for @key{TAB} is one of the most unusual aspects of Viper for many | |
| 2234 novice users. In Emacs, @key{TAB} is used to format text and programs, and | |
| 2235 is extremely useful. For instance, hitting @key{TAB} causes the current | |
| 2236 line to be re-indented in accordance with the context. In programming, | |
| 2237 this is very important, since improper automatic indentation would | |
| 2238 immediately alert the programmer to a possible error. For instance, if a | |
| 2239 @kbd{)} or a @kbd{"} is missing somewhere above the current | |
| 2240 line, @key{TAB} is likely to mis-indent the line. | |
| 2241 | |
| 2242 For this reason, Viper doesn't change the standard Emacs binding of | |
| 2243 @key{TAB}, thereby sacrificing Vi compatibility | |
| 2244 (except for users at level 1). Instead, in Viper, the key | |
| 2245 @kbd{S-tab} (shift+ tab) is chosen to emulate Vi's @key{TAB}. | |
| 2246 | |
| 2247 We should note that on some non-windowing terminals, Shift doesn't modify | |
| 2248 the @key{TAB} key, so @kbd{S-tab} behaves as if it were @key{TAB}. In such | |
| 2249 a case, you will have to bind @code{viper-insert-tab} to some other | |
| 2250 convenient key. | |
| 2251 | |
| 2252 Some packages, notably Dired, Gnus, Info, etc., attach special meaning to | |
| 2253 common keys like @key{SPC}, @kbd{x}, @kbd{d}, @kbd{v}, and others. This | |
| 2254 means that Vi command state is inappropriate for working with these | |
| 2255 packages. Fortunately, these modes operate on read-only buffers and are | |
| 2256 designed not for editing files, but for special-purpose browsing, reading | |
| 2257 news, mail, etc., and Vi commands are meaningless in these situations. For | |
| 2258 this reason, Viper doesn't force Vi state on such major modes---it | |
| 2259 brings them in Emacs state. You can switch to Vi state by typing @kbd{C-z} | |
| 2260 if, for instance, you want to do Vi-style search in a buffer (although, | |
| 2261 usually, incremental search, which is bound to @kbd{C-s}, is sufficient in | |
| 2262 these situations). But you should then switch back to Emacs state if you | |
| 2263 plan to continue using these major modes productively. You can also switch | |
| 2264 to Vi temporarily, to execute just one command. This is done by typing | |
| 2265 @kbd{C-c \}. (In some of these modes, @kbd{/} and @kbd{:} are bound | |
| 2266 Vi-style, unless these keys perform essential duties.) | |
| 2267 | |
| 2268 If you would like certain major modes to come up in Emacs state rather than | |
| 2269 Vi state (but Viper thinks otherwise), you should put these major modes | |
| 2270 on the @code{viper-emacs-state-mode-list} list and delete them from | |
| 2271 @code{viper-vi-state-mode-list}. | |
| 2272 Likewise, you can force Viper's Insert state on a major mode by putting it | |
| 2273 in @code{viper-insert-state-mode-list}. | |
| 2274 @vindex @code{viper-emacs-state-mode-list} | |
| 2275 @vindex @code{viper-insert-state-mode-list} | |
| 2276 @vindex @code{viper-vi-state-mode-list} | |
| 2277 | |
| 2278 It is also possible to impose Vi on some major modes, even though they may | |
| 2279 bind common keys to specialized commands. This might make sense for modes | |
| 2280 that bind only a small number of common keys. For instance, Viper subverts | |
| 2281 the Shell mode by changing the bindings for @kbd{C-m} and @kbd{C-d} using | |
| 2282 @code{viper-add-local-keys} described in section on customization | |
| 2283 (@pxref{Customization}). | |
| 2284 | |
| 2285 In some cases, some @emph{minor} modes might override certain essential | |
| 2286 bindings in Vi command state. This is not a big priblem because this | |
| 2287 can happen only in the beginning, when the minor mode kicks in. Typing | |
| 2288 @code{M-x viper-mode} will correct the situation. Viper knows about | |
| 2289 several such minor modes and takes care of them, so the above trick | |
| 2290 is usually not necessary. If you find that some minor mode, e.g., | |
| 2291 @code{nasty-mode.el} interferes with Viper, putting the following in | |
| 2292 @file{.viper} should fix the problem: | |
| 2293 @lisp | |
| 2294 (viper-harness-minor-mode "nasty-mode") | |
| 2295 @end lisp | |
| 2296 @noindent | |
| 2297 The argument to @code{viper-harness-minor-mode} is the name of the file for the | |
| 2298 offending minor mode with the suffixes @file{.el} and @file{.elc} removed. | |
| 2299 | |
| 2300 It may not be always obvious which minor mode is at fault. The only | |
| 2301 guidance here is to look into the file that defines the minor mode you are | |
| 2302 suspecting, say @code{nasty-mode.el}, and see if it has a variable called | |
| 2303 @code{nasty-mode-map}. Then check if there is a statement of the form | |
| 2304 @lisp | |
| 2305 (define-key nasty-mode-map key function) | |
| 2306 @end lisp | |
| 2307 @noindent | |
| 2308 that binds the misbehaving | |
| 2309 keys. If so, use the above line to harness @code{nasty-mode}. If your | |
| 2310 suspicion is wrong, no harm is done if you harness a minor mode that | |
| 2311 doesn't need to be harnessed. | |
| 2312 | |
| 2313 @vindex @code{viper-want-emacs-keys-in-vi} | |
| 2314 @vindex @code{viper-want-emacs-keys-in-insert} | |
| 2315 @vindex @code{viper-always} | |
| 2316 @findex @code{viper-set-hooks} | |
| 2317 @findex @code{viper-mode} | |
| 2318 @findex @code{viper-harness-minor-mode} | |
| 2319 @findex @code{remove-hook} | |
| 2320 @findex @code{add-hook} | |
| 2321 | |
| 2322 @node Viper Specials,Vi Macros,Packages that Change Keymaps,Customization | |
| 2323 @section Viper Specials | |
| 2324 | |
| 2325 Viper extends Vi with a number of useful features. This includes various | |
| 2326 search functions, histories of search strings, Ex commands, insertions, and | |
| 2327 Vi's destructive commands. In addition, Viper supports file name completion | |
| 2328 and history, completion of Ex commands and variables, and many other | |
| 2329 features. Some of these features are explained in detail elsewhere in this | |
| 2330 document. Other features are explained here. | |
| 2331 | |
| 2332 @table @code | |
| 2333 @item (viper-buffer-search-enable) | |
| 2334 @item viper-buffer-search-char nil | |
| 2335 Enable buffer search. Explicit call to @code{viper-buffer-search-enable} | |
| 2336 sets @code{viper-buffer-search-char} to @kbd{g}. Alternatively, the user can | |
| 2337 set @code{viper-buffer-search-char} in @file{.viper} to a key sequence | |
| 2338 to be used for buffer search. There is no need to call | |
| 2339 @code{viper-buffer-search-enable} in that case. | |
| 2340 @findex @code{viper-buffer-search-enable} | |
| 2341 @vindex @code{viper-buffer-search-char} | |
| 2342 @item viper-toggle-search-style | |
| 2343 This function, bound to @kbd{C-c /}, lets one toggle case-sensitive and | |
| 2344 case-insensitive search, and also switch between plain vanilla search and | |
| 2345 search via regular expressions. Without the prefix argument, the user is | |
| 2346 asked which mode to toggle. With prefix argument 1, this toggles | |
| 2347 case-sensitivity. With prefix argument 2, regular expression/vanilla search | |
| 2348 will be toggled. | |
| 2349 | |
| 2350 However, we found that the most convenient way to toggle | |
| 2351 these options is to bind a Vi macro to | |
| 2352 bind @kbd{//} to toggles case sensitivity and to @kbd{///} to toggles | |
| 2353 vanilla search. Thus, quickly hitting @kbd{/} twice will switch Viper from | |
| 2354 case sensitive search to case-insensitive. Repeating this once again will | |
| 2355 restore the original state. Likewise, quickly hitting @kbd{/} three times | |
| 2356 will switch you from vanilla-style search to search via regular expressions. | |
| 2357 If you hit something other than @kbd{/} after the first @kbd{/} or if the | |
| 2358 second @kbd{/} doesn't follow quickly enough, then Viper will issue the | |
| 2359 usual prompt @kbd{/} and will wait for input, as usual in Vi. | |
| 2360 If you don't like this behavior, you can ``unrecord'' these macros in your | |
| 2361 @file{~/.viper} file. For instance, if you don't like the above feature, put | |
| 2362 this in @file{~/.viper}: | |
| 2363 @example | |
| 2364 (viper-set-searchstyle-toggling-macros 'undefine) | |
| 2365 @end example | |
| 2366 @findex @code{viper-set-searchstyle-toggling-macros} | |
| 2367 | |
| 2368 @item Vi-isms in Emacs state | |
| 2369 Some people find it useful to use the Vi-style search key, `/', to invoke | |
| 2370 search in modes which Viper leaves in emacs-state. These modes are: | |
| 2371 @code{dired-mode}, @code{mh-folder-mode}, @code{gnus-group-mode}, | |
| 2372 @code{gnus-summary-mode}, @code{Info-mode}, and @code{Buffer-menu-mode} | |
| 2373 (more may be added in the future). So, in the above modes, Viper binds `/' | |
| 2374 so that it will behave Vi-style. Furthermore, in those major modes, Viper | |
| 2375 binds `:' to invoke ex-style commands, like in vi-state. And, as described | |
| 2376 above, `//' and `///' get bound to Vi-style macros that toggle | |
| 2377 case-insensitivity and regexp-search. | |
| 2378 | |
| 2379 If you don't like these features---which I don't really understand---you | |
| 2380 can unbind `/' and `:' in @code{viper-dired-modifier-map} (for Dired) or in | |
| 2381 @code{viper-slash-and-colon-map}, for other modes. | |
| 2382 @vindex @code{viper-slash-and-colon-map} | |
| 2383 @vindex @code{viper-dired-modifier-map} | |
| 2384 | |
| 2385 To unbind the macros `//' and `///' for a major mode where you feel they | |
| 2386 are undesirable, execute @code{viper-set-emacs-state-searchstyle-macros} with a | |
| 2387 non-nil argument. This can be done either interactively, by supplying a | |
| 2388 prefix argument, or by placing | |
| 2389 @example | |
| 2390 (viper-set-emacs-state-searchstyle-macros 'undefine) | |
| 2391 @end example | |
| 2392 @findex @code{viper-set-emacs-state-searchstyle-macros} | |
| 2393 in the hook to the major mode (e.g., @code{dired-mode-hook}). | |
| 2394 @xref{Vi Macros}, for more information on Vi macros. | |
| 2395 | |
| 2396 @item viper-heading-start | |
| 2397 @item viper-heading-end | |
| 2398 @cindex headings | |
| 2399 @cindex sections | |
| 2400 @cindex paragraphs | |
| 2401 @cindex sentences | |
| 2402 Regular Expressions for @kbd{[[} and @kbd{]]}. Note that Emacs defines | |
| 2403 Regexps for paragraphs and sentences. @xref{Paragraphs,,Paragraphs and | |
| 2404 Sentences,emacs,The GNU Emacs Manual}, for details. | |
| 2405 @item M-x viper-set-expert-level | |
| 2406 @findex @code{viper-set-expert-level} | |
| 2407 Change your user level interactively. | |
| 2408 @item viper-smart-suffix-list '("" "tex" "c" "cc" "el" "p") | |
| 2409 @vindex @code{viper-smart-suffix-list} | |
| 2410 Viper supports Emacs-style file completion when it prompts the user for a | |
| 2411 file name. However, in many cases, the same directory may contain files | |
| 2412 with identical prefix but different suffixes, e.g., prog.c, prog.o, | |
| 2413 paper.tex, paper.dvi. In such cases, completion will stop at the `.'. | |
| 2414 If the above variable is a list of strings representing suffixes, Viper will | |
| 2415 try these suffixes | |
| 2416 in the order listed and will check if the corresponding file exists. | |
| 2417 | |
| 2418 For instance, if completion stopped at `paper.'@: and the user typed | |
| 2419 @key{RET}, | |
| 2420 then Viper will check if the files `paper.', `paper.tex', `paper.c', etc., exist. | |
| 2421 It will take the first such file. If no file exists, Viper will give a chance | |
| 2422 to complete the file name by typing the appropriate suffix. If `paper.'@: was | |
| 2423 the intended file name, hitting return will accept it. | |
| 2424 | |
| 2425 To turn this feature off, set the above variable to @code{nil}. | |
| 2426 | |
| 2427 @item viper-insertion-ring-size 14 | |
| 2428 @vindex @code{viper-insertion-ring-size} | |
| 2429 @cindex Insertion ring | |
| 2430 Viper remembers what was previously inserted in Insert and Replace states. | |
| 2431 Several such recent insertions are kept in a special ring of strings of size | |
| 2432 @code{viper-insertion-ring-size}. | |
| 2433 If you enter Insert or Replace state you can reinsert strings from this | |
| 2434 ring by typing @kbd{C-c M-p} or @kbd{C-c M-n}. The former will search the | |
| 2435 ring in | |
| 2436 the direction of older insertions, and the latter will search in | |
| 2437 the direction of newer insertions. Hitting @kbd{C-c M-p} or @kbd{C-c M-n} | |
| 2438 in succession | |
| 2439 will undo the previous insertion from the ring and insert the next item on | |
| 2440 the ring. If a larger ring size is needed, change the value of the above | |
| 2441 variable in the @file{~/.viper} file. | |
| 2442 | |
| 2443 Since typing these sequences of keys may be tedious, it is suggested that the | |
| 2444 user should bind a function key, such as @kbd{f31}, as follows: | |
| 2445 @example | |
| 2446 (define-key viper-insert-global-user-map [f31] | |
| 2447 'viper-insert-prev-from-insertion-ring) | |
| 2448 @end example | |
| 2449 This binds @kbd{f31} (which is usually @kbd{R11} on a Sun workstation) | |
| 2450 to the function that inserts the previous string in the insertion history. | |
| 2451 To rotate the history in the opposite | |
| 2452 direction, you can either bind an unused key to | |
| 2453 @code{viper-insert-next-from-insertion-ring} or hit any digit (1 to 9) then | |
| 2454 @kbd{f31}. | |
| 2455 | |
| 2456 One should not bind the above functions to @kbd{M-p} or @kbd{M-n}, since | |
| 2457 this will interfere with the Minibuffer histories and, possibly, other | |
| 2458 major modes. | |
| 2459 | |
| 2460 @item viper-command-ring-size 14 | |
| 2461 @vindex @code{viper-command-ring-size} | |
| 2462 @cindex Destructive command ring | |
| 2463 @cindex Destructive command history | |
| 2464 Viper keeps track of the recent history of destructive | |
| 2465 commands, such as @kbd{dw}, @kbd{i}, etc. | |
| 2466 In Vi state, | |
| 2467 the most recent command can be re-executed by hitting `@kbd{.}', as in Vi. | |
| 2468 However, repeated typing @kbd{C-c M-p} will cause Viper to show the | |
| 2469 previous destructive commands in the minibuffer. Subsequent hitting `@kbd{.}' | |
| 2470 will execute the command that was displayed last. | |
| 2471 The key @kbd{C-c M-n} will cycle through the command history in the | |
| 2472 opposite direction. | |
| 2473 Since typing @kbd{C-c M-p} may be tedious, it is more convenient to bind an | |
| 2474 appropriate function to an unused function key on the keyboard and use that | |
| 2475 key. For instance, the following | |
| 2476 @example | |
| 2477 (define-key viper-vi-global-user-map [f31] | |
| 2478 'viper-prev-destructive-command) | |
| 2479 @end example | |
| 2480 binds the key @kbd{f31} (which is usually @kbd{R11} on a Sun workstation) | |
| 2481 to the function that searches the command history in the direction of older | |
| 2482 commands. To search in the opposite | |
| 2483 direction, you can either bind an unused key to | |
| 2484 @code{viper-next-destructive-command} or hit any digit (1 to 9) then @kbd{f31}. | |
| 2485 | |
| 2486 One should not bind the above functions to @kbd{M-p} or @kbd{M-n}, since | |
| 2487 this will interfere with the Minibuffer histories and, possibly, other | |
| 2488 major modes. | |
| 2489 | |
| 2490 @item viper-minibuffer-vi-face 'viper-minibuffer-vi-face | |
| 2491 @item viper-minibuffer-insert-face 'viper-minibuffer-insert-face | |
| 2492 @item viper-minibuffer-emacs-face 'viper-minibuffer-emacs-face | |
| 2493 These faces control the appearance of the minibuffer text in the | |
| 2494 corresponding Viper states. You can change the appearance of these faces | |
| 2495 through Emacs' customization widget, which is accessible through the | |
| 2496 menubar. | |
| 2497 | |
| 2498 Viper is located in this widget under the @emph{Emulations} customization | |
| 2499 subgroup of the @emph{Editing} group. All Viper faces are grouped together | |
| 2500 in Viper's @emph{Highlighting} customization subgroup. | |
| 2501 | |
| 2502 Note that only the text you type in is affected by the above faces. | |
| 2503 Prompts and Minibuffer messages are not affected. | |
| 2504 | |
| 2505 Purists who do not like adornments in the minibuffer can always zap them by | |
| 2506 putting | |
| 2507 @example | |
| 2508 (copy-face 'default 'viper-minibuffer-vi-face) | |
| 2509 (copy-face 'default 'viper-minibuffer-insert-face) | |
| 2510 (copy-face 'default 'viper-minibuffer-emacs-face) | |
| 2511 @end example | |
| 2512 in the @file{~/.viper} file or through the customization widget, as | |
| 2513 described above. However, in that case, the user will not have any | |
| 2514 indication of the current Viper state in the minibuffer. (This is important | |
| 2515 if the user accidentally switches to another Viper state by typing @key{ESC} or | |
| 2516 @kbd{C-z}). | |
| 2517 @item M-x viper-go-away | |
| 2518 @findex @code{viper-go-away} | |
| 2519 Make Viper disappear from the face of your running Emacs instance. If your | |
| 2520 fingers start aching again, @kbd{M-x viper-mode} might save your day. | |
| 2521 @item M-x toggle-viper-mode | |
| 2522 @findex @code{toggle-viper-mode} | |
| 2523 Toggle Viperization of Emacs on and off. | |
| 2524 @end table | |
| 2525 | |
| 2526 @cindex Multifile documents and programs | |
| 2527 | |
| 2528 Viper provides some support for multi-file documents and programs. | |
| 2529 If a document consists of several files we can designate one of them as a | |
| 2530 master and put the following at the end of that file: | |
| 2531 @lisp | |
| 2532 ;;; Local Variables: | |
| 2533 ;;; eval: (viper-setup-master-buffer "file1" "file2" "file3" "file5" "file5") | |
| 2534 ;;; End: | |
| 2535 @end lisp | |
| 2536 @noindent | |
| 2537 where @code{file1} to @code{file5} are names of files related to the master | |
| 2538 file. Next time, when the master file is visited, the command | |
| 2539 @code{viper-setup-master-buffer} will be evaluated and the above files will | |
| 2540 be associated with the master file. Then, the new Ex command | |
| 2541 @kbd{:RelatedFile} (abbr.@: @kbd{:R}) will display files 1 to 5 one after | |
| 2542 another, so you can edit them. If a file is not in any Emacs buffer, it | |
| 2543 will be visited. The command @kbd{PreviousRelatedFile} (abbr., @kbd{:P}) | |
| 2544 goes through the file list in the opposite direction. | |
| 2545 @findex @kbd{:RelatedFile} | |
| 2546 @findex @kbd{:PreviousRelatedFile} | |
| 2547 | |
| 2548 These commands are akin to @kbd{:n} and @kbd{:N}, but they allow the user to | |
| 2549 focus on relevant files only. | |
| 2550 | |
| 2551 Note that only the master file needs to have the aforementioned block of | |
| 2552 commands. Also, ";;;" above can be replaced by some other | |
| 2553 markers. Semicolon is good for Lisp programs, since it is considered a | |
| 2554 comment designator there. For LaTeX, this could be "%%%", and for C the | |
| 2555 above block should be commented out. | |
| 2556 | |
| 2557 Even though these commands are sometimes useful, they are no substitute for | |
| 2558 the powerful @emph{tag table} facility of Emacs. Viper's @kbd{:tag} command | |
| 2559 in a primitive interface to Emacs tags. @xref{Tags,Tags,Tags,emacs, | |
| 2560 The Gnu Emacs Manual}, for more information on tags. | |
| 2561 | |
| 2562 The following two commands are normally bound to a mouse click and are part | |
| 2563 of Viper. They work only if Emacs runs as an application under X | |
| 2564 Windows (or under some other window system for which a port of GNU Emacs 20 | |
| 2565 is available). Clicking the mouse when Emacs is invoked in an Xterm window | |
| 2566 (using @code{emacs -nw}) will do no good. | |
| 2567 | |
| 2568 @table @code | |
| 2569 @cindex mouse | |
| 2570 @cindex mouse-search | |
| 2571 @item viper-mouse-search-key (meta shift 1) | |
| 2572 @vindex @code{viper-mouse-insert-key} | |
| 2573 This variable controls the @emph{mouse-search} feature of Viper. The | |
| 2574 default value | |
| 2575 states that holding Meta and Shift keys while clicking mouse button 1 | |
| 2576 should initiate search for a region under the mouse pointer (defined | |
| 2577 below). This command can take a prefix argument, which indicates the | |
| 2578 occurrence of the pattern to search for. | |
| 2579 | |
| 2580 Note: while loading initially, Viper binds this mouse action only if it is | |
| 2581 not already bound to something else. If you want to use the mouse-search | |
|
36155
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
2582 feature, and the @kbd{Meta-Shift-Mouse-1} mouse action is already bound to |
|
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
2583 something else, you can rebind the mouse-search feature by setting |
| 25829 | 2584 @code{viper-mouse-search-key} to something else in your @code{~/.viper} |
| 2585 file: | |
| 2586 @lisp | |
| 2587 (setq viper-mouse-search-key '(meta 1)) | |
| 2588 @end lisp | |
| 2589 This would bind mouse search to the action invoked by pressing the | |
| 2590 Meta key and clicking mouse button 1. The allowed values of | |
| 2591 @code{viper-mouse-search-key} are lists that contain a mouse-button number | |
| 2592 (1,2, or 3) and any combination of the words `control', `meta', and | |
| 2593 `shift'. | |
| 2594 | |
| 2595 If the requested mouse action (e.g., (meta 1)) is already taken for other | |
| 2596 purposes then you have to confirm your intention by placing the following | |
| 2597 command in @code{~/.viper} after setting @code{viper-mouse-search-key}: | |
| 2598 @lisp | |
| 2599 (viper-bind-mouse-search-key 'force) | |
| 2600 @end lisp | |
| 2601 | |
| 2602 You can also change this setting interactively, through the customization | |
| 2603 widget of Emacs (choose option "Customize.Customize Group" from the | |
| 2604 menubar). | |
| 2605 | |
| 2606 The region that is chosen as a pattern to search for is determined as | |
| 2607 follows. If search is invoked via a single click, Viper chooses the region | |
| 2608 that lies between the beginning of the ``word'' under the pointer (``word'' | |
| 2609 is understood in Vi sense) and the end of that word. The only difference | |
| 2610 with Vi's words is that in Lisp major modes `-' is considered an | |
| 2611 alphanumeric symbol. This is done for the convenience of working with Lisp | |
| 2612 symbols, which often have an `-' in them. Also, if you click on a | |
| 2613 non-alphanumeric character that is not a word separator (in Vi sense) then | |
| 2614 this character will also be considered alphanumeric, provided that it is | |
| 2615 adjacent (from either side) to an alphanumeric character. This useful | |
| 2616 feature gives added control over the patterns selected by the mouse click. | |
| 2617 | |
| 2618 On a double-click, the region is determined by the beginning of the current | |
| 2619 Vi's ``Word'' (i.e., the largest non-separator chunk of text) and the End | |
| 2620 of that ``Word'' (as determined by the @kbd{E} command). | |
| 2621 | |
| 2622 On a triple-click, the region consists of the entire line where the click | |
| 2623 occurred with all leading and trailing spaces and tabs removed. | |
| 2624 | |
| 2625 @cindex mouse-insert | |
| 2626 @item viper-mouse-insert-key (meta shift 2) | |
| 2627 @vindex @code{viper-mouse-insert-key} | |
| 2628 This variable controls the @emph{mouse-insert} feature of Viper. | |
| 2629 The above default value states that | |
| 2630 holding Meta and Shift keys while clicking mouse button 2 | |
| 2631 should insert the region surrounding the | |
| 2632 mouse pointer. The rules defining this region are the same as for | |
| 2633 mouse-search. This command takes an optional prefix argument, which | |
| 2634 indicates how many such regions to snarf from the buffer and insert. (In | |
| 2635 case of a triple-click, the prefix argument is ignored.) | |
| 2636 | |
| 2637 Note: while loading initially, Viper binds this mouse action only if it not | |
| 2638 already bound to something else. If you want to use this feature and the | |
| 2639 default mouse action is already bound, you can rebind mouse-insert by | |
| 2640 placing this command in @code{~/.viper}: | |
| 2641 @lisp | |
| 2642 (setq viper-mouse-insert-key '(meta 2)) | |
| 2643 @end lisp | |
| 2644 If you want to bind mouse-insert to an action even if this action is | |
| 2645 already taked for other purposes in Emacs, then you should add this command | |
| 2646 to @code{~/.viper}, after setting @code{viper-mouse-insert-key}: | |
| 2647 @lisp | |
| 2648 (viper-bind-mouse-insert-key 'force) | |
| 2649 @end lisp | |
| 2650 | |
| 2651 This value can also be changed via the Emacs customization widget at the | |
| 2652 menubar. | |
| 2653 | |
| 2654 @item viper-multiclick-timeout | |
| 2655 This variable controls the rate at which double-clicking must occur for the | |
| 2656 purpose of mouse search and mouse insert. By default, this is set to | |
|
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
2657 @code{double-click-time} in Emacs and to |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
2658 @code{mouse-track-multi-click-time} milliseconds in XEmacs. |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
2659 @end table |
|
36155
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
2660 @kindex @kbd{S-Mouse-1} |
|
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
2661 @kindex @kbd{S-Mouse-2} |
| 25829 | 2662 @kindex @kbd{meta shift button1up} |
| 2663 @kindex @kbd{meta shift button2up} | |
| 2664 @vindex @code{viper-multiclick-timeout} | |
| 2665 @findex @code{viper-mouse-click-insert-word} | |
| 2666 @findex @code{viper-mouse-click-search-word} | |
| 2667 | |
| 2668 Note: The above functions search and insert in the selected window of | |
| 2669 the latest active frame. This means that you can click in another window or | |
| 2670 another frame and have search or insertion done in the frame and window you | |
| 2671 just left. This lets one use these functions in a multi-frame | |
| 2672 configuration. However, this may require some getting used to. For | |
| 2673 instance, if you are typing in a frame, A, and then move the mouse to frame | |
| 2674 B and click to invoke mouse search, search (or insertion) will be performed | |
| 2675 in frame A. To perform search/insertion in frame B, you will first have to | |
| 2676 shift focus there, which doesn't happen until you type a character or | |
| 2677 perform some other action in frame B---mouse search doesn't shift focus. | |
| 2678 | |
| 2679 If you decide that you don't like the above feature and always want | |
| 2680 search/insertion be performed in the frame where the click occurs, don't | |
| 2681 bind (and unbind, if necessary) @code{viper-mouse-catch-frame-switch} from | |
| 2682 the mouse event it is bound to. | |
| 2683 | |
| 2684 Mouse search is integrated with Vi-style search, so you can | |
| 2685 repeat it with @kbd{n} and @kbd{N}. It should be also noted that, while | |
| 2686 case-sensitivity of search in Viper is controlled by the variable | |
| 2687 @code{viper-case-fold-search}, the case of mouse search is | |
| 2688 controlled by the Emacs variable @code{case-fold-search}, which may be set | |
| 2689 differently from @code{viper-case-fold-search}. Therefore, case-sensitivity | |
| 2690 of mouse search may be different from that of the usual Vi-style search. | |
| 2691 | |
| 2692 Finally, if the way Viper determines the word to be searched for or to be | |
| 2693 inserted is not what you want, there is a variable, | |
| 2694 @code{viper-surrounding-word-function}, which can be changed to indicate | |
| 2695 another function for snarfing words out of the buffer. The catch is that | |
| 2696 you will then have to write such a function and make it known to your | |
| 2697 Emacs. The function @code{viper-surrounding-word} in @file{viper.el} can be | |
| 2698 used as a guiding example. | |
| 2699 | |
| 2700 @node Vi Macros, ,Viper Specials,Customization | |
| 2701 @section Vi Macros | |
| 2702 | |
| 2703 @cindex Vi macros | |
| 2704 | |
| 2705 Viper supports much enhanced Vi-style macros and also facilitates the use | |
| 2706 of Emacs-style macros. To define a temporary macro, it is generally more | |
| 2707 convenient to use Emacs keyboard macro facility. Emacs keyboard macros are | |
| 2708 usually defined anonymously, and the latest macro can be executed by typing | |
| 2709 @kbd{C-x e} (or @kbd{*}, if Viper is in Vi state). If you need to use several | |
| 2710 temporary macros, Viper lets you save them to a | |
| 2711 register (a lowercase letter); such macros can then be executed by typing | |
| 2712 @kbd{@@a} in Vi state (if a macro was previously saved in register | |
| 2713 @kbd{a}). | |
| 2714 @xref{Macros and Registers}, for details. | |
| 2715 | |
| 2716 If, however, you need to use a macro regularly, it must be given a | |
| 2717 permanent name and saved. Emacs manual explains how to do this, but | |
| 2718 invocation of named Emacs macros is quite different from Vi's. First, | |
| 2719 invocation of permanent Emacs macros takes time because of the extra keys. | |
| 2720 Second, binding such macros to function keys, for | |
| 2721 fast access, hogs valuable real estate on the keyboard. | |
| 2722 | |
| 2723 Vi-style macros are better in that respect, since Vi lets the user overload | |
| 2724 the meaning of key sequences: keys typed in fast succession are treated | |
| 2725 specially, if this key sequence is bound to a macro. | |
| 2726 | |
| 2727 Viper provides keyboard macros through the usual Ex commands, @kbd{:map} and | |
| 2728 @kbd{:map!}. Vi-style macros are much more powerful in Viper than | |
| 2729 they are in the original Vi and in other emulators. This is because Viper | |
| 2730 implements an enhanced vi-style | |
| 2731 interface to the powerful Emacs keyboard macro facility. | |
| 2732 | |
| 2733 First, any Emacs | |
| 2734 command can be executed while defining a macro, not just the Vi | |
| 2735 commands. In particular, the user can invoke Emacs commands via @kbd{M-x | |
| 2736 command-name} or by pressing various function keys on the keyboard. One | |
| 2737 can even use the mouse, although this is usually not useful and is not | |
| 2738 recommended (and macros defined with the use of the mouse cannot be saved in | |
| 2739 command history and in the startup file, for future use). | |
| 2740 | |
| 2741 Macros defined by mixing Vi and Emacs commands are represented as | |
| 2742 vectors. So, don't be confused when you see one (usually through the | |
| 2743 history of Ex commands). For instance, if @kbd{gg} is defined by typing | |
| 2744 @kbd{l}, the up-arrow key and @kbd{M-x next-line}, its definition will look | |
| 2745 as follows in Emacs: | |
| 2746 | |
| 2747 @example | |
| 2748 [l up (meta x) n e x t - l i n e return] | |
| 2749 @end example | |
| 2750 | |
| 2751 Second, Viper macros are defined in a WYSIWYG style. This means that | |
| 2752 commands are executed as you type them, so you can see precisely what is | |
| 2753 being defined. Third, macros can be bound to arbitrary sequences of keys, | |
| 2754 not just to printable keys. For instance, one can define a macro that will | |
| 2755 be invoked by hitting @kbd{f3} then @kbd{f2} function keys. (The keys | |
| 2756 @kbd{delete} and @kbd{backspace} are excluded; also, a macro invocation | |
| 2757 sequence can't start with @key{ESC}. Some other keys, such as @kbd{f1} and | |
| 2758 @kbd{help}, can't be bound to macros under Emacs, since they | |
| 2759 are bound in @code{key-translation-map}, which overrides any other binding | |
| 2760 the user gives to keys. In general, keys that have a binding in | |
| 2761 @code{key-translation-map} can't be bound to a macro.) | |
| 2762 | |
| 2763 Fourth, in Viper, one can define macros that are specific to a given | |
| 2764 buffer, a given major mode, or macros that are defined for all buffers. In | |
| 2765 fact, the same macro name can have several different definitions: one | |
| 2766 global, several definitions for various major modes, and | |
| 2767 definitions for various specific buffers. Buffer-specific definitions | |
| 2768 override mode-specific definitions, which, in turn, override global | |
| 2769 definitions. | |
| 2770 | |
| 2771 As if all that is not enough, Viper (through its interface to Emacs | |
| 2772 macros) lets the user define keyboard macros that ask for confirmation or | |
| 2773 even prompt the user for input and then continue. To do this, one should | |
| 2774 type @kbd{C-x q} (for confirmation) or @kbd{C-u C-x q} (for prompt). | |
| 2775 For details, @pxref{Kbd Macro Query,,Customization,emacs,The GNU Emacs | |
| 2776 Manual} @refill | |
| 2777 | |
| 2778 When the user finishes defining a macro (which is done by typing @kbd{C-x)} --- | |
| 2779 a departure from Vi), you will be asked whether you want this | |
| 2780 macro to be global, mode-specific, or buffer-specific. You will also be | |
| 2781 given a chance to save the macro in your @file{~/.viper} file. | |
| 2782 This is the easiest way to save a macro and make | |
| 2783 it permanently available. If you work your startup files with bare hands, | |
| 2784 here is how Viper saves the above macro so that it will be | |
| 2785 available in Viper's Insert state (and Replace state) in buffer @code{my-buf} | |
| 2786 only: | |
| 2787 | |
| 2788 @example | |
| 2789 (viper-record-kbd-macro "gg" 'insert-state | |
| 2790 [l up (meta x) n e x t - l i n e return] | |
| 2791 "my-buf") | |
| 2792 @end example | |
| 2793 | |
| 2794 @noindent | |
| 2795 To do the same for Vi state and all buffers with the major mode | |
| 2796 @code{cc-mode}, use: | |
| 2797 | |
| 2798 @example | |
| 2799 (viper-record-kbd-macro "gg" 'vi-state | |
| 2800 [l up (meta x) n e x t - l i n e return] | |
| 2801 'cc-mode) | |
| 2802 @end example | |
| 2803 | |
| 2804 @noindent | |
| 2805 Both macro names and macro definitions are vectors of symbols that denote | |
| 2806 keys on the keyboard. Some keys, like @kbd{\}, @kbd{ }, or digit-keys must | |
| 2807 be escaped with a backslash. Modified keys are represented as lists. For | |
| 2808 instance, holding Meta and Control and pressing @kbd{f4} is represented as | |
| 2809 @kbd{(control meta f4)}. | |
| 2810 If all members of a vectors are printable characters (or sequences, such as | |
| 2811 @kbd{\e}, @kbd{\t}, for @key{ESC} and @key{TAB}), then they can also be represented as | |
| 2812 strings: | |
| 2813 | |
| 2814 @example | |
| 2815 (viper-record-kbd-macro "aa" 'vi-state "aaa\e" "my-buffer") | |
| 2816 @end example | |
| 2817 | |
| 2818 @noindent | |
| 2819 Thus, typing @kbd{aa} fast in Vi state will switch Viper to Insert state | |
| 2820 (due to the first @kbd{a}), insert @kbd{aa}, and then it will switch back to Vi | |
| 2821 state. All this will take effect only in the buffer named @code{my-buffer}. | |
| 2822 | |
| 2823 Note that the last argument to @code{viper-record-kbd-macro} must be either a | |
| 2824 string (a buffer name), a symbol representing a major mode, or @code{t}; | |
| 2825 the latter says that the macro is to be defined for all buffers | |
| 2826 (which is how macros are defined in original Vi). | |
| 2827 | |
| 2828 For convenience, Viper also lets you define Vi-style macros in its Emacs | |
| 2829 state. There is no Ex command, like @kbd{:map} and @kbd{:map!} for doing | |
| 2830 this, but the user can include such a macro in the @file{~/.viper} file. The | |
| 2831 only thing is that the @code{viper-record-kbd-macro} command should specify | |
| 2832 @code{emacs-state} instead of @code{vi-state} or @code{insert-state}. | |
| 2833 | |
| 2834 The user can get rid of a macro either by using the Ex commands @kbd{:unmap} | |
| 2835 and @kbd{:unmap!} or by issuing a call to @code{viper-unrecord-kbd-macro}. | |
| 2836 The latter is more powerful, since it can delete macros even in | |
| 2837 @code{emacs-state}. However, @code{viper-unrecord-kbd-macro} is usually | |
| 2838 needed only when the user needs to get rid of the macros that are already | |
| 2839 predefined in Viper. | |
| 2840 The syntax is: | |
| 2841 @findex @code{viper-unrecord-kbd-macro} | |
| 2842 @example | |
| 2843 (viper-unrecord-kbd-macro macro state) | |
| 2844 @end example | |
| 2845 @noindent | |
| 2846 The second argument must be @code{vi-state}, @code{insert-state}, or | |
| 2847 @code{emacs-state}. The first argument is a name of a macro. To avoid | |
| 2848 mistakes in specifying names of existing macros, type @kbd{M-x | |
| 2849 viper-describe-kbd-macros} and use a name from the list displayed by this | |
| 2850 command. | |
| 2851 | |
| 2852 If an error occurs during macro definition, Emacs | |
| 2853 aborts the process, and it must be repeated. This is analogous to Vi, | |
| 2854 except that in Vi the user doesn't know there is an error until the macro is | |
| 2855 actually run. All that means that in order for a definition to be | |
| 2856 successful, the user must do some simple planning of the process in | |
| 2857 advance, to avoid errors. For instance, if you want to map @kbd{gg} to | |
| 2858 @kbd{llll} in Vi state, you must make sure that there is enough room on the | |
| 2859 current line. Since @kbd{l} moves the cursor forward, it may signal an | |
| 2860 error on reaching the end of line, which will abort the definition. | |
| 2861 | |
| 2862 These precautions are necessary only when defining macros; they will help | |
| 2863 avoid the need to redo the job. When macros are actually run, an error | |
| 2864 during the execution will simply terminate the current execution | |
| 2865 (but the macro will remain mapped). | |
| 2866 | |
| 2867 A macro name can be a string of characters or a vector of keys. | |
| 2868 The latter makes it possible to define macros bound to, say, double-hits | |
| 2869 on a function key, such as @kbd{up} or @kbd{f13}. | |
| 2870 This is very useful if you run out of function keys on your keyboard; it | |
| 2871 makes Viper macro facility a @emph{keyboard doubler}, so to speak. | |
| 2872 | |
| 2873 Elsewhere (@xref{Keybindings}, for details), we review | |
| 2874 the standard Emacs mechanism for binding function keys to commands. | |
| 2875 For instance, | |
| 2876 | |
| 2877 @example | |
| 2878 (global-set-key [f13] 'repeat-complex-command) | |
| 2879 @end example | |
| 2880 | |
| 2881 @noindent | |
| 2882 binds the key f13 to the Emacs function that repeats the last minibuffer | |
| 2883 command. Under Viper, however, you may still use this key for additional | |
| 2884 purposes, if you bind, say, a double-hitting action for that key to some | |
| 2885 other function. Emacs doesn't allow the user to do that, but Viper does | |
| 2886 this through its keyboard macro facility. To do this, type @kbd{:map } | |
| 2887 first. When you are asked to enter a macro name, hit f13 twice, followed by | |
| 2888 @key{RET} or @key{SPC}. | |
| 2889 | |
| 2890 Emacs will now start the mapping process by actually executing | |
| 2891 Vi and Emacs commands, so that you could see what will happen each time the | |
| 2892 macro is executed. Suppose now we wanted to bind the key sequence | |
| 2893 @kbd{f13 f13} to the command @code{eval-last-sexp}. To accomplish this, we | |
| 2894 can type @kbd{M-x eval-last-sexp} followed by @kbd{C-x )}. | |
| 2895 If you answer positively to Viper's offer to save this macro in @file{~/.viper} | |
| 2896 for future uses, the following will be inserted in that file: | |
| 2897 | |
| 2898 @example | |
| 2899 (viper-record-kbd-macro [f16 f16] 'vi-state | |
| 2900 [(meta x) e v a l - l a s t - s e x p] | |
| 2901 'lisp-interaction-mode) | |
| 2902 @end example | |
| 2903 | |
| 2904 To illustrate the above point, Viper provides two canned macros, which, by | |
| 2905 default, are bound to @kbd{[f12 \1]} and @kbd{[f12 \2]} (invoked by typing | |
| 2906 @kbd{f12} then @kbd{1} and @kbd{2}, respectively). These macros are useful | |
| 2907 shortcuts to Viper's command ring history. The first macro will execute the | |
| 2908 second-last destructive command (the last one is executed by @kbd{.}, as | |
| 2909 usual). The second macro executes the third-last command. | |
| 2910 | |
| 2911 If you need to go deeper into the command history, you will have to use | |
| 2912 other commands, as described earlier in this section; or you can bind, | |
| 2913 say, @kbd{f12 \3} like this: | |
| 2914 | |
| 2915 @example | |
| 2916 (viper-record-kbd-macro [f12 \3] 'vi-state | |
| 2917 [(meta x) r e p e a t - f r o m - h i s t o r y] | |
| 2918 t) | |
| 2919 @end example | |
| 2920 | |
| 2921 | |
| 2922 Note that even though the macro uses the function key @kbd{f12}, the key is | |
| 2923 actually free and can still be bound to some Emacs function via | |
| 2924 @code{define-key} or @code{global-set-key}. | |
| 2925 | |
| 2926 | |
| 2927 Viper allows the user to define macro names that are prefixes of other macros. | |
| 2928 For instance, one can define @kbd{[[} and @kbd{[[[[} to be macros. | |
| 2929 If you type the exact sequence of such keys and then pause, Viper will | |
| 2930 execute the right macro. However, if you don't pause and, say, type | |
| 2931 @kbd{[[[[text} then the conflict is resolved as follows. If only one of the | |
| 2932 key sequences, @kbd{[[} or @kbd{[[[[} has a definition applicable to the | |
| 2933 current buffer, then, in fact, there is no conflict and the right macro | |
| 2934 will be chosen. If both have applicable definitions, then the first one | |
| 2935 found will be executed. Usually this is the macro with a shorter name. So, | |
| 2936 in our case, @kbd{[[[[text} will cause the macro @kbd{[[} to be executed | |
| 2937 twice and then the remaining keys, @kbd{t e x t}, will be processed. | |
| 2938 | |
|
36155
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
2939 When defining macros using @kbd{:map} or @kbd{:map!}, the user enters |
|
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
2940 the actually keys to be used to invoke the macro. For instance, you |
|
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
2941 should hit the actual key @kbd{f6} if it is to be part of a macro |
|
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
2942 name; you do @emph{not} write @kbd{f 6}. When entering keys, Viper |
|
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
2943 displays them as strings or vectors (e.g., @code{"abc"} or @code{[f6 |
|
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
2944 f7 a]}). The same holds for unmapping. Hitting @key{TAB} while |
|
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
2945 typing a macro name in the @kbd{:unmap} or @kbd{:unmap!} command will |
|
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
2946 cause name completion. Completions are displayed as strings or |
|
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
2947 vectors. However, as before, you don't actually type @samp{"}, |
|
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
2948 @samp{[}, or @samp{]} that appear in the completions. These are |
|
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
2949 meta-symbols that indicate whether the corresponding macro name is a |
|
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
2950 vector or a string. |
| 25829 | 2951 |
| 2952 One last difference from Vi: Vi-style keyboard macros cannot be defined in | |
| 2953 terms of other Vi-style keyboard macros (but named Emacs macros are OK). | |
| 2954 More precisely, while defining or executing a macro, the special meaning | |
| 2955 of key sequences (as Vi macros) is ignored. | |
| 2956 This is because it is all too easy to create an infinite loop in this way. | |
| 2957 Since Viper macros are much more powerful than Vi's it is impossible to | |
| 2958 detect such loops. In practice, this is not really a limitation but, | |
| 2959 rather, a feature. | |
| 2960 | |
| 2961 We should also note that Vi macros are disabled in the Minibuffer, which | |
| 2962 helps keep some potential troubles away. | |
| 2963 | |
| 2964 The rate at which the user must type keys in order for them to be | |
| 2965 recognized as a timeout macro is controlled by the variable | |
| 2966 @code{viper-fast-keyseq-timeout}, which defaults to 200 milliseconds. | |
| 2967 | |
| 2968 For the most part, Viper macros defined in @file{~/.viper} can be shared | |
| 2969 between X and TTY modes. | |
| 2970 The problem with TTY may be that the function keys there generate sequences | |
| 2971 of events instead of a single event (as under a window system). | |
| 2972 Emacs maps some of these sequences back to the logical keys | |
| 2973 (e.g., the sequences generated by the arrow keys are mapped to @kbd{up}, | |
| 2974 @kbd{left}, etc.). However, not all function keys are mapped in this way. | |
| 2975 Macros that are bound to key sequences that contain such unmapped function | |
| 2976 keys have to be redefined for TTY's (and possibly for every type of TTY you | |
| 2977 may be using). To do this, start Emacs on an appropriate TTY device and | |
| 2978 define the macro using @kbd{:map}, as usual. | |
| 2979 | |
| 2980 @findex @code{viper-describe-kbd-macros} | |
| 2981 Finally, Viper provides a function that conveniently displays all macros | |
| 2982 currently defined. To see all macros along with their definitions, type | |
| 2983 @kbd{M-x viper-describe-kbd-macros}. | |
| 2984 | |
| 2985 @node Commands,,Customization,Top | |
| 2986 @chapter Commands | |
| 2987 | |
| 2988 This section is a semi-automatically bowdlerized version of the Vi | |
| 2989 reference created by @* @samp{maart@@cs.vu.nl} and others. It can be | |
| 2990 found on the Vi archives. This reference has been adapted for Viper.@refill | |
| 2991 | |
| 2992 @menu | |
| 2993 * Groundwork:: Textual Conventions and Viper basics | |
| 2994 * Text Handling:: Moving, Editing, Undoing. | |
| 2995 * Display:: Scrolling. | |
| 2996 * File and Buffer Handling:: Editing, Writing and Quitting. | |
| 2997 * Mapping:: Mapping Keys, Keyboard Macros | |
| 2998 * Shell Commands:: Accessing Shell Commands, Processing Text | |
| 2999 * Options:: Ex options, the @kbd{:set} commands | |
| 3000 * Emacs Related Commands:: Meta Keys, Windows | |
| 3001 * Mouse-bound Commands:: Search and insertion of text | |
| 3002 @end menu | |
| 3003 | |
| 3004 @node Groundwork, Text Handling, Commands, Commands | |
| 3005 @comment node-name, next, previous, up | |
| 3006 @section Groundwork | |
| 3007 | |
| 3008 The VI command set is based on the idea of combining motion commands | |
| 3009 with other commands. The motion command is used as a text region | |
| 3010 specifier for other commands. | |
| 3011 We classify motion commands into @dfn{point commands} and | |
| 3012 @dfn{line commands}.@refill | |
| 3013 | |
| 3014 @cindex point commands | |
| 3015 | |
| 3016 The point commands are: | |
| 3017 | |
| 3018 @quotation | |
| 3019 @kbd{h}, @kbd{l}, @kbd{0}, @kbd{$}, @kbd{w}, @kbd{W}, @kbd{b}, @kbd{B}, | |
| 3020 @kbd{e}, @kbd{E}, @kbd{(}, @kbd{)}, @kbd{/}, @kbd{?}, @kbd{`}, @kbd{f}, | |
| 3021 @kbd{F}, @kbd{t}, @kbd{T}, @kbd{%}, @kbd{;}, @kbd{,}, @kbd{^} | |
| 3022 @end quotation | |
| 3023 | |
| 3024 @cindex line commands | |
| 3025 | |
| 3026 The line commands are: | |
| 3027 | |
| 3028 @quotation | |
| 3029 @kbd{j}, @kbd{k}, @kbd{+}, @kbd{-}, @kbd{H}, @kbd{M}, @kbd{L}, @kbd{@{}, | |
| 3030 @kbd{@}}, @kbd{G}, @kbd{'}, @kbd{[[}, @kbd{]]}, @kbd{[]} | |
| 3031 @end quotation | |
| 3032 @noindent | |
| 3033 | |
| 3034 Text Deletion Commands (@pxref{Deleting Text}), Change commands | |
| 3035 (@pxref{Changing Text}), even Shell Commands (@pxref{Shell Commands}) | |
| 3036 use these commands to describe a region of text to operate on. | |
| 3037 | |
| 3038 @cindex r and R region specifiers | |
| 3039 | |
| 3040 Viper adds two region descriptors, @kbd{r} and @kbd{R}. These describe | |
| 3041 the Emacs regions (@pxref{Basics}), but they are not movement commands. | |
| 3042 | |
| 3043 The command description uses angle brackets @samp{<>} to indicate | |
| 3044 metasyntactic variables, since the normal conventions of using simple | |
| 3045 text can be confusing with Viper where the commands themselves are | |
| 3046 characters. Watch out where @kbd{<} shift commands and @kbd{<count>} are | |
| 3047 mentioned together!!! | |
| 3048 | |
| 3049 @kindex <move> | |
| 3050 @kindex <a-z> | |
| 3051 @kindex <address> | |
| 3052 @cindex <move> | |
| 3053 @cindex <a-z> | |
| 3054 @cindex <address> | |
| 3055 @cindex movements | |
| 3056 | |
| 3057 @samp{<move>} refers to the above movement commands, and @samp{<a-z>} | |
| 3058 refers to registers or textmarkers from @samp{a} to @samp{z}. Note | |
| 3059 that the @samp{<move>} is described by full move commands, that is to | |
| 3060 say they will take counts, and otherwise behave like normal move commands. | |
| 3061 @cindex Ex addresses | |
| 3062 @samp{<address>} refers to Ex line addresses, which include | |
| 3063 | |
| 3064 @table @kbd | |
| 3065 @item .@: <No address> | |
| 3066 Current line | |
| 3067 @item .+n .-n | |
| 3068 Add or subtract for current line | |
| 3069 @item number | |
| 3070 Actual line number, use @kbd{.=} to get the line number | |
| 3071 @item '<a-z> | |
| 3072 Textmarker | |
| 3073 @item $ | |
| 3074 Last line | |
| 3075 @item x,y | |
| 3076 Where x and y are one of the above | |
| 3077 @item % | |
| 3078 @cindex % (Ex address) | |
| 3079 For the whole file, same as (1,$). | |
| 3080 @item /<pat>/ | |
| 3081 @itemx ?<pat>? | |
| 3082 Next or previous line with pattern <pat>. | |
| 3083 | |
| 3084 Note that the pattern is allowed to contain newline character (inserted as | |
| 3085 @kbd{C-qC-j}). Therefore, one can search for patterns that span several | |
| 3086 lines. | |
| 3087 @end table | |
| 3088 | |
| 3089 @cindex % (Current file) | |
|
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3090 Note that @samp{%} is used in Ex commands @kbd{:e} and @kbd{:r <shell-cmd>} |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3091 to mean current file. If you want a @samp{%} in your command, it must be |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3092 escaped as @samp{\%}. Note that @kbd{:w} and the regular @kbd{:r <file>} |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3093 command doesn't support the meta symbols @samp{%} and @samp{#}, because |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3094 file history is a better mechanism. |
| 25829 | 3095 @cindex # (Previous file) |
| 3096 Similarly, @samp{#} expands to the previous file. The previous file is | |
| 3097 the first file in @kbd{:args} listing. This defaults to previous window | |
| 3098 in the VI sense if you have one window only. | |
| 3099 | |
| 3100 @kindex <args> | |
| 3101 @kindex <cmd> | |
| 3102 @cindex <args> | |
| 3103 @cindex <cmd> | |
| 3104 @noindent | |
| 3105 Others like @samp{<args> -- arguments}, @samp{<cmd> -- command} etc. | |
| 3106 should be fairly obvious. | |
| 3107 | |
| 3108 @noindent | |
| 3109 Common characters referred to include: | |
| 3110 | |
| 3111 @table @kbd | |
| 3112 @item <sp> | |
| 3113 Space | |
| 3114 @item <ht> | |
| 3115 Tab | |
| 3116 @item <lf> | |
| 3117 Linefeed | |
| 3118 @item <esc> | |
| 3119 Escape | |
| 3120 @item <cr> | |
| 3121 Return, Enter | |
| 3122 @end table | |
| 3123 @cindex <cr> | |
| 3124 @cindex <esc> | |
| 3125 @cindex <lf> | |
| 3126 @cindex <ht> | |
| 3127 @cindex <sp> | |
| 3128 | |
| 3129 @cindex words | |
| 3130 @cindex WORDS | |
| 3131 @cindex char | |
| 3132 @cindex CHAR | |
| 3133 | |
| 3134 We also use @samp{word} for alphanumeric/non-alphanumeric words, and | |
| 3135 @samp{WORD} for whitespace delimited words. @samp{char} refers to any | |
| 3136 ASCII character, @samp{CHAR} to non-whitespace character. | |
| 3137 Brackets @samp{[]} indicate optional parameters; @samp{<count>} also | |
| 3138 optional, usually defaulting to 1. Brackets are elided for | |
| 3139 @samp{<count>} to eschew obfuscation. | |
| 3140 | |
| 3141 Viper's idea of Vi's words is slightly different from Vi. First, Viper | |
| 3142 words understand Emacs symbol tables. Therefore, all symbols declared to be | |
| 3143 alphanumeric in a symbol table can automatically be made part of the Viper | |
| 3144 word. This is useful when, for instance, editing text containing European, | |
| 3145 Cyrillic, Japanese, etc., texts. | |
| 3146 | |
| 3147 Second, Viper lets you depart from Vi's idea of a word by changing the a | |
| 3148 syntax preference via the customization widget (the variable | |
| 3149 @code{viper-syntax-preference}) or by executing | |
| 3150 @code{viper-set-syntax-preference} interactively. | |
| 3151 | |
| 3152 By default, Viper syntax preference is @code{reformed-vi}, which means that | |
| 3153 Viper considers only those symbols to be part of a word that are specified | |
| 3154 as word-symbols by the current Emacs syntax table (which may be different | |
| 3155 for different major modes) plus the underscore symbol @kbd{_}, minus the | |
| 3156 symbols that are not considered words in Vi (e.g., `,',;, etc.), but may be | |
| 3157 considered as word-symbols by various Emacs major modes. Reformed-Vi works | |
| 3158 very close to Vi, and it also recognizes words in other | |
| 3159 alphabets. Therefore, this is the most appropriate mode for editing text | |
| 3160 and is likely to fit all your needs. | |
| 3161 | |
| 3162 You can also set Viper syntax preference to @code{strict-vi}, which would | |
| 3163 cause Viper to view all non-English letters as non-word-symbols. | |
| 3164 | |
| 3165 You can also specify @code{emacs} as your preference, which would | |
| 3166 make Viper use exactly the same notion of a word as Emacs does. In | |
| 3167 particular, the underscore may not be part of a word in some major modes. | |
| 3168 | |
| 3169 Finally, if @code{viper-syntax-preference} is set to @code{extended}, Viper | |
| 3170 words would consist of characters that are classified as alphanumeric | |
| 3171 @emph{or} as parts of symbols. This is convenient for editing programs. | |
| 3172 | |
| 3173 @code{viper-syntax-preference} is a local variable, so it can have different | |
| 3174 values for different major modes. For instance, in programming modes it can | |
| 3175 have the value @code{extended}. In text modes where words contain special | |
| 3176 characters, such as European (non-English) letters, Cyrillic letters, etc., | |
| 3177 the value can be @code{reformed-vi} or @code{emacs}. | |
| 3178 If you consider using different syntactic preferences for different major | |
| 3179 modes, you should execute, for example, | |
| 3180 | |
| 3181 @example | |
| 3182 (viper-set-syntax-preference nil "extended") | |
| 3183 @end example | |
| 3184 | |
| 3185 in the appropriate major mode hooks. | |
| 3186 | |
| 3187 @vindex @code{viper-syntax-preference} | |
| 3188 @findex @code{viper-set-syntax-preference} | |
| 3189 @cindex syntax table | |
| 3190 | |
| 3191 | |
| 3192 | |
| 3193 The above discussion concerns only the movement commands. In regular | |
| 3194 expressions, words remain the same as in Emacs. That is, the expressions | |
| 3195 @code{\w}, @code{\>}, @code{\<}, etc., use Emacs' idea of what is a word, | |
| 3196 and they don't look into the value of variable | |
| 3197 @code{viper-syntax-preference}. This is because Viper avoids changing | |
| 3198 syntax tables in order to not thwart the various major modes that set these | |
| 3199 tables. | |
| 3200 | |
| 3201 The usual Emacs convention is used to indicate Control Characters, i.e | |
| 3202 C-h for Control-h. @emph{Do not confuse this to mean the separate | |
| 3203 characters C - h!!!} The @kbd{^} is itself, never used to indicate a | |
| 3204 Control character. | |
| 3205 | |
| 3206 Finally, we note that Viper's Ex-style commands can be made to work on the | |
| 3207 current Emacs region. This is done by typing a digit argument before | |
| 3208 @kbd{:}. For instance, typing @kbd{1:} will propmt you with something like | |
| 3209 @emph{:123,135}, assuming that the current region starts at line 123 and | |
| 3210 ends at line 135. There is no need to type the line numbers, since Viper | |
| 3211 inserts them automatically in front of the Ex command. | |
| 3212 @cindex Ex commands | |
| 3213 | |
| 3214 @node Text Handling, Display, Groundwork, Commands | |
| 3215 @section Text Handling | |
| 3216 | |
| 3217 @menu | |
| 3218 * Move Commands:: Moving, Searching | |
| 3219 * Marking:: Textmarkers in Viper and the Emacs Mark. | |
| 3220 * Appending Text:: Text insertion, Shifting, Putting | |
| 3221 * Editing in Insert State:: Autoindent, Quoting etc. | |
| 3222 * Deleting Text:: Deleting | |
| 3223 * Changing Text:: Changing, Replacement, Joining | |
| 3224 * Search and Replace:: Searches, Query Replace, Pattern Commands | |
| 3225 * Yanking:: Yanking, Viewing Registers | |
| 3226 * Undoing:: Multiple Undo, Backups | |
| 3227 @end menu | |
| 3228 | |
| 3229 @node Move Commands,Marking,,Text Handling | |
| 3230 @subsection Move Commands | |
| 3231 | |
| 3232 @cindex movement commands | |
| 3233 @cindex searching | |
| 3234 @cindex textmarkers | |
| 3235 @cindex markers | |
| 3236 @cindex column movement | |
| 3237 @cindex paragraphs | |
| 3238 @cindex headings | |
| 3239 @cindex sections | |
| 3240 @cindex sentences | |
| 3241 @cindex matching parens | |
| 3242 @cindex paren matching | |
| 3243 | |
| 3244 @table @kbd | |
| 3245 @item <count> h C-h | |
| 3246 <count> chars to the left. | |
| 3247 @item <count> j <lf> C-n | |
| 3248 <count> lines downward. | |
| 3249 @item <count> l <sp> | |
| 3250 <count> chars to the right. | |
| 3251 @item <count> k C-p | |
| 3252 <count> lines upward. | |
| 3253 @item <count> $ | |
| 3254 To the end of line <count> from the cursor. | |
| 3255 @item <count> ^ | |
| 3256 To the first CHAR <count> - 1 lines lower. | |
| 3257 @item <count> - | |
| 3258 To the first CHAR <count> lines higher. | |
| 3259 @item <count> + <cr> | |
| 3260 To the first CHAR <count> lines lower. | |
| 3261 @item 0 | |
| 3262 To the first char of the line. | |
| 3263 @item <count> | | |
| 3264 To column <count> | |
| 3265 @item <count> f<char> | |
| 3266 <count> <char>s to the right (find). | |
| 3267 @item <count> t<char> | |
| 3268 Till before <count> <char>s to the right. | |
| 3269 @item <count> F<char> | |
| 3270 <count> <char>s to the left. | |
| 3271 @item <count> T<char> | |
| 3272 Till after <count> <char>s to the left. | |
| 3273 @item <count> ; | |
| 3274 Repeat latest @kbd{f t F T} <count> times. | |
| 3275 @item <count> , | |
| 3276 Repeat latest @kbd{f t F T} | |
| 3277 <count> times in opposite direction. | |
| 3278 @item <count> w | |
| 3279 <count> words forward. | |
| 3280 @item <count> W | |
| 3281 <count> WORDS forward. | |
| 3282 @item <count> b | |
| 3283 <count> words backward. | |
| 3284 @item <count> B | |
| 3285 <count> WORDS backward. | |
| 3286 @item <count> e | |
| 3287 To the end of word <count> forward. | |
| 3288 @item <count> E | |
| 3289 To the end of WORD <count> forward. | |
| 3290 @item <count> G | |
| 3291 Go to line <count> (default end-of-file). | |
| 3292 @item <count> H | |
| 3293 To line <count> from top of the screen (home). | |
| 3294 @item <count> L | |
| 3295 To line <count> from bottom of the screen (last). | |
| 3296 @item M | |
| 3297 To the middle line of the screen. | |
| 3298 @item <count> ) | |
| 3299 <count> sentences forward. | |
| 3300 @item <count> ( | |
| 3301 <count> sentences backward. | |
| 3302 @item <count> @} | |
| 3303 <count> paragraphs forward. | |
| 3304 @item <count> @{ | |
| 3305 <count> paragraphs backward. | |
| 3306 @item <count> ]] | |
| 3307 To the <count>th heading. | |
| 3308 @item <count> [[ | |
| 3309 To the <count>th previous heading. | |
| 3310 @item <count> [] | |
| 3311 To the end of <count>th heading. | |
| 3312 @item m<a-z> | |
| 3313 Mark the cursor position with a letter. | |
| 3314 @item `<a-z> | |
| 3315 To the mark. | |
| 3316 @item '<a-z> | |
| 3317 To the first CHAR of the line with the mark. | |
| 3318 @item [<a-z> | |
| 3319 Show contents of textmarker. | |
| 3320 @item ]<a-z> | |
| 3321 Show contents of register. | |
| 3322 @item `` | |
| 3323 To the cursor position before the latest absolute | |
| 3324 jump (of which are examples @kbd{/} and @kbd{G}). | |
| 3325 @item '' | |
| 3326 To the first CHAR of the line on which the cursor | |
| 3327 was placed before the latest absolute jump. | |
| 3328 @item <count> /<string> | |
| 3329 To the <count>th occurrence of <string>. | |
| 3330 @item <count> /<cr> | |
| 3331 To the <count>th occurrence of <string> from previous @kbd{/ or ?}. | |
| 3332 @item <count> ?<string> | |
| 3333 To the <count>th previous occurrence of <string>. | |
| 3334 @item <count> ?<cr> | |
| 3335 To the <count>th previous occurrence of <string> from previous @kbd{?@: or /}. | |
| 3336 @item n | |
| 3337 Repeat latest @kbd{/} @kbd{?} (next). | |
| 3338 @item N | |
| 3339 Repeat latest search in opposite direction. | |
| 3340 @item C-c / | |
| 3341 Without a prefix argument, this command toggles | |
| 3342 case-sensitive/case-insensitive search modes and plain vanilla/regular | |
| 3343 expression search. With the prefix argument 1, i.e., | |
| 3344 @kbd{1 C-c /}, this toggles case-sensitivity; with the prefix argument 2, | |
| 3345 toggles plain vanilla search and search using | |
| 3346 regular expressions. @xref{Viper Specials}, for alternative ways to invoke | |
| 3347 this function. | |
| 3348 @cindex vanilla search | |
| 3349 @cindex case-sensitive search | |
| 3350 @cindex case-insensitive search | |
| 3351 @item % | |
| 3352 Find the next bracket/parenthesis/brace and go to its match. | |
| 3353 By default, Viper ignores brackets/parentheses/braces that occur inside | |
| 3354 parentheses. You can change this by setting | |
| 3355 @code{viper-parse-sexp-ignore-comments} to nil in your @file{.viper} file. | |
| 3356 This option can also be toggled interactively if you quickly hit @kbd{%%%}. | |
| 3357 | |
| 3358 This latter feature is implemented as a vi-style keyboard macro. If you | |
| 3359 don't want this macro, put | |
| 3360 | |
| 3361 @example | |
| 3362 (viper-set-parsing-style-toggling-macro 'undefine) | |
| 3363 @end example | |
| 3364 @findex @code{viper-set-parsing-style-toggling-macro} | |
| 3365 | |
| 3366 in your @file{~/.viper} file. | |
| 3367 | |
| 3368 @end table | |
| 3369 @kindex @kbd{%} | |
| 3370 @kindex @kbd{C-c /} | |
| 3371 @kindex @kbd{N} | |
| 3372 @kindex @kbd{n} | |
| 3373 @kindex @kbd{?<cr>} | |
| 3374 @kindex @kbd{/<cr>} | |
| 3375 @kindex @kbd{?<string>} | |
| 3376 @kindex @kbd{/<string>} | |
| 3377 @kindex @kbd{''} | |
| 3378 @kindex @kbd{``} | |
| 3379 @kindex @kbd{]<a-z>} | |
| 3380 @kindex @kbd{[<a-z>} | |
| 3381 @kindex @kbd{'<a-z>} | |
| 3382 @kindex @kbd{`<a-z>} | |
| 3383 @kindex @kbd{m<a-z>} | |
| 3384 @kindex @kbd{[]} | |
| 3385 @kindex @kbd{[[} | |
| 3386 @kindex @kbd{]]} | |
| 3387 @kindex @kbd{@{} | |
| 3388 @kindex @kbd{@}} | |
| 3389 @kindex @kbd{(} | |
| 3390 @kindex @kbd{)} | |
| 3391 @kindex @kbd{M} | |
| 3392 @kindex @kbd{L} | |
| 3393 @kindex @kbd{H} | |
| 3394 @kindex @kbd{G} | |
| 3395 @kindex @kbd{E} | |
| 3396 @kindex @kbd{e} | |
| 3397 @kindex @kbd{B} | |
| 3398 @kindex @kbd{b} | |
| 3399 @kindex @kbd{W} | |
| 3400 @kindex @kbd{w} | |
| 3401 @kindex @kbd{,} | |
| 3402 @kindex @kbd{;} | |
| 3403 @kindex @kbd{T<char>} | |
| 3404 @kindex @kbd{F<char>} | |
| 3405 @kindex @kbd{t<char>} | |
| 3406 @kindex @kbd{f<char>} | |
| 3407 @kindex @kbd{|} | |
| 3408 @kindex @kbd{0} | |
| 3409 @kindex @kbd{<cr>} | |
| 3410 @kindex @kbd{+} | |
| 3411 @kindex @kbd{-} | |
| 3412 @kindex @kbd{^} | |
| 3413 @kindex @kbd{$} | |
| 3414 @kindex @kbd{C-p} | |
| 3415 @kindex @kbd{<lf>} | |
| 3416 @kindex @kbd{<sp>} | |
| 3417 @kindex @kbd{C-n} | |
| 3418 @kindex @kbd{C-h} | |
| 3419 @kindex @kbd{h} | |
| 3420 @kindex @kbd{j} | |
| 3421 @kindex @kbd{k} | |
| 3422 @kindex @kbd{l} | |
| 3423 @vindex @code{viper-parse-sexp-ignore-comments} | |
| 3424 | |
| 3425 @node Marking,Appending Text,Move Commands,Text Handling | |
| 3426 @subsection Marking | |
| 3427 | |
| 3428 Emacs mark is referred to in the region specifiers @kbd{r} and @kbd{R}. | |
| 3429 @xref{Emacs Preliminaries}, and @xref{Basics}, for explanation. Also | |
| 3430 see @ref{Mark,,Mark,emacs,The GNU Emacs manual}, for an explanation of | |
| 3431 the Emacs mark ring. | |
| 3432 | |
| 3433 @cindex marking | |
| 3434 | |
| 3435 @table @kbd | |
| 3436 @item m<a-z> | |
| 3437 Mark the current file and position with the specified letter. | |
| 3438 @item m . | |
| 3439 Set the Emacs mark (@pxref{Emacs Preliminaries}) at point. | |
|
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3440 @item m ^ |
|
26490
2b08d829af86
Fix complaints from makeinfo 4.0.
Eli Zaretskii <eliz@gnu.org>
parents:
26263
diff
changeset
|
3441 Set the Emacs mark (@pxref{Emacs Preliminaries}) back to where it was last |
|
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3442 set with the @kbd{m.} command. This is useful when you set the mark with |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3443 @kbd{m.}, but then some other command (such as @kbd{L} or @kbd{G}) changes |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3444 it in a way that you didn't like. |
| 25829 | 3445 @item m < |
| 3446 Set the Emacs mark at beginning of buffer. | |
| 3447 @item m > | |
| 3448 Set the Emacs mark at end of buffer. | |
| 3449 @item m , | |
| 3450 Jump to the Emacs mark. | |
| 3451 @item :mark <char> | |
| 3452 Mark position with text marker named <char>. This is an Ex command. | |
| 3453 @item :k <char> | |
| 3454 Same as @kbd{:mark}. | |
| 3455 @item `` | |
| 3456 Exchange point and mark. | |
| 3457 @item '' | |
| 3458 Exchange point and mark and go to the first CHAR on line. | |
| 3459 @item '<a-z> | |
| 3460 Go to specified Viper mark. | |
| 3461 @item | |
| 3462 Go to specified Viper mark and go to the first CHAR on line. | |
| 3463 @end table | |
| 3464 @kindex @kbd{m<a-z>} | |
| 3465 @kindex @kbd{m.} | |
| 3466 @kindex @kbd{m>} | |
| 3467 @kindex @kbd{m<} | |
| 3468 @kindex @kbd{m,} | |
|
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3469 @kindex @kbd{m^} |
| 25829 | 3470 @findex @kbd{:mark} |
| 3471 @findex @kbd{:k} | |
| 3472 @kindex @kbd{''} | |
| 3473 @kindex @kbd{``} | |
| 3474 @kindex @kbd{`<a-z>} | |
| 3475 @kindex @kbd{'<a-z>} | |
| 3476 | |
| 3477 @node Appending Text, Editing in Insert State, Marking,Text Handling | |
| 3478 @subsection Appending Text | |
| 3479 | |
| 3480 @xref{Options}, to see how to change tab and shiftwidth size. See the GNU | |
| 3481 Emacs manual, or try @kbd{C-ha tabs} (If you have turned Emacs help on). | |
| 3482 Check out the variable @code{indent-tabs-mode} to put in just spaces. | |
| 3483 Also see options for word-wrap. | |
| 3484 | |
| 3485 @cindex inserting | |
| 3486 @cindex appending | |
| 3487 @cindex paste | |
| 3488 @cindex put | |
| 3489 | |
| 3490 @table @kbd | |
| 3491 @item <count> a | |
| 3492 <count> times after the cursor. | |
| 3493 @item <count> A | |
| 3494 <count> times at the end of line. | |
| 3495 @item <count> i | |
| 3496 <count> times before the cursor (insert). | |
| 3497 @item <count> I | |
| 3498 <count> times before the first CHAR of the line | |
| 3499 @item <count> o | |
| 3500 On a new line below the current (open). | |
| 3501 The count is only useful on a slow terminal. | |
| 3502 @item <count> O | |
| 3503 On a new line above the current. | |
| 3504 The count is only useful on a slow terminal. | |
| 3505 @item <count> ><move> | |
| 3506 Shift the lines described by <count><move> one | |
| 3507 shiftwidth to the right (layout!). | |
| 3508 @item <count> >> | |
| 3509 Shift <count> lines one shiftwidth to the right. | |
| 3510 @item <count> ["<a-z1-9>]p | |
| 3511 Put the contents of the (default undo) buffer | |
| 3512 <count> times after the cursor. The register will | |
| 3513 be automatically down-cased. | |
| 3514 @item <count> ["<a-z1-9>]P | |
| 3515 Put the contents of the (default undo) buffer | |
| 3516 <count> times before the cursor. The register will | |
| 3517 @item [<a-z> | |
| 3518 Show contents of textmarker. | |
| 3519 @item ]<a-z> | |
| 3520 Show contents of register. | |
| 3521 @item <count> . | |
| 3522 Repeat previous command <count> times. For destructive | |
| 3523 commands as well as undo. | |
| 3524 @item f1 1 and f1 2 | |
| 3525 While @kbd{.} repeats the last destructive command, | |
| 3526 these two macros repeat the second-last and the third-last destructive | |
| 3527 commands. @xref{Vi Macros}, for more information on Vi macros. | |
| 3528 @item C-c M-p and C-c M-n | |
| 3529 In Vi state, | |
| 3530 these commands help peruse the history of Vi's destructive commands. | |
| 3531 Successive typing of @kbd{C-c M-p} causes Viper to search the history in | |
| 3532 the direction | |
| 3533 of older commands, while hitting @kbd{C-c M-n} does so in reverse | |
| 3534 order. Each command in the history is displayed in the Minibuffer. The | |
| 3535 displayed command can | |
| 3536 then be executed by typing `@kbd{.}'. | |
| 3537 | |
| 3538 Since typing the above sequences of keys may be tedious, the | |
| 3539 functions doing the perusing can be bound to unused keyboard keys in the | |
| 3540 @file{~/.viper} file. @xref{Viper Specials}, for details. | |
| 3541 @end table | |
| 3542 @kindex @kbd{C-c M-p} | |
| 3543 @kindex @kbd{C-c M-n} | |
| 3544 @kindex @kbd{.} | |
| 3545 @kindex @kbd{]<a-z>} | |
| 3546 @kindex @kbd{[<a-z>} | |
| 3547 @kindex @kbd{P} | |
| 3548 @kindex @kbd{p} | |
| 3549 @kindex @kbd{"<a-z1-9>p} | |
| 3550 @kindex @kbd{"<a-z1-9>P} | |
| 3551 @kindex @kbd{>>} | |
| 3552 @kindex @kbd{><move>} | |
| 3553 @kindex @kbd{O} | |
| 3554 @kindex @kbd{o} | |
| 3555 @kindex @kbd{i} | |
| 3556 @kindex @kbd{A} | |
| 3557 @kindex @kbd{a} | |
| 3558 | |
| 3559 @node Editing in Insert State, Deleting Text, Appending Text,Text Handling | |
| 3560 @subsection Editing in Insert State | |
| 3561 | |
| 3562 Minibuffer can be edited similarly to Insert state, and you can switch | |
| 3563 between Insert/Replace/Vi states at will. | |
| 3564 Some users prefer plain Emacs feel in the Minibuffer. To this end, set | |
| 3565 @var{viper-vi-style-in-minibuffer} to @code{nil}. | |
| 3566 | |
| 3567 @cindex Insert state | |
| 3568 | |
| 3569 @table @kbd | |
| 3570 @item C-v | |
| 3571 Deprive the next char of its special meaning (quoting). | |
| 3572 @item C-h | |
| 3573 One char back. | |
| 3574 @item C-w | |
| 3575 One word back. | |
| 3576 @item C-u | |
| 3577 Back to the begin of the change on the | |
| 3578 current line. | |
| 3579 | |
| 3580 @end table | |
| 3581 @kindex @kbd{C-u} | |
| 3582 @kindex @kbd{C-w} | |
| 3583 @kindex @kbd{C-v} | |
| 3584 | |
| 3585 @node Deleting Text, Changing Text, Editing in Insert State, Text Handling | |
| 3586 @subsection Deleting Text | |
| 3587 | |
| 3588 | |
| 3589 There is one difference in text deletion that you should be | |
| 3590 aware of. This difference comes from Emacs and was adopted in Viper | |
| 3591 because we find it very useful. In Vi, if you delete a line, say, and then | |
| 3592 another line, these two deletions are separated and are put back | |
| 3593 separately if you use the @samp{p} command. In Emacs (and Viper), successive | |
| 3594 series of deletions that are @emph{not interrupted} by other commands are | |
| 3595 lumped together, so the deleted text gets accumulated and can be put back | |
| 3596 as one chunk. If you want to break a sequence of deletions so that the | |
| 3597 newly deleted text could be put back separately from the previously deleted | |
| 3598 text, you should perform a non-deleting action, e.g., move the cursor one | |
| 3599 character in any direction. | |
| 3600 | |
| 3601 @cindex shifting text | |
| 3602 | |
| 3603 @table @kbd | |
| 3604 @item <count> x | |
| 3605 Delete <count> chars under and after the cursor. | |
| 3606 @item <count> X | |
| 3607 Delete <count> chars before the cursor. | |
| 3608 @item <count> d<move> | |
| 3609 Delete from point to endpoint of <count><move>. | |
| 3610 @item <count> dd | |
| 3611 Delete <count> lines. | |
| 3612 @item D | |
| 3613 The rest of the line. | |
| 3614 @item <count> <<move> | |
| 3615 Shift the lines described by <count><move> one | |
| 3616 shiftwidth to the left (layout!). | |
| 3617 @item <count> << | |
| 3618 Shift <count> lines one shiftwidth to the left. | |
| 3619 @end table | |
| 3620 @kindex @kbd{<<} | |
| 3621 @kindex @kbd{<<move>} | |
| 3622 @kindex @kbd{D} | |
| 3623 @kindex @kbd{dd} | |
| 3624 @kindex @kbd{d<move>} | |
| 3625 @kindex @kbd{X} | |
| 3626 @kindex @kbd{x} | |
| 3627 | |
| 3628 @node Changing Text, Search and Replace, Deleting Text,Text Handling | |
| 3629 @subsection Changing Text | |
| 3630 | |
| 3631 @cindex joining lines | |
| 3632 @cindex changing case | |
| 3633 @cindex quoting regions | |
| 3634 @cindex substitution | |
| 3635 | |
| 3636 @table @kbd | |
| 3637 @item <count> r<char> | |
| 3638 Replace <count> chars by <char> - no <esc>. | |
| 3639 @item <count> R | |
| 3640 Overwrite the rest of the line, | |
| 3641 appending change @var{count - 1} times. | |
| 3642 @item <count> s | |
| 3643 Substitute <count> chars. | |
| 3644 @item <count> S | |
| 3645 Change <count> lines. | |
| 3646 @item <count> c<move> | |
| 3647 Change from begin to endpoint of <count><move>. | |
| 3648 @item <count> cc | |
| 3649 Change <count> lines. | |
| 3650 @item <count> C | |
| 3651 The rest of the line and <count> - 1 next lines. | |
| 3652 @item <count> =<move> | |
| 3653 Reindent the region described by move. | |
| 3654 @item <count> ~ | |
| 3655 Switch lower and upper cases. | |
| 3656 @item <count> J | |
| 3657 Join <count> lines (default 2). | |
| 3658 @item :[x,y]s/<pat>/<repl>/<f> | |
| 3659 Substitute (on lines x through y) the pattern | |
| 3660 <pat> (default the last pattern) with <repl>. Useful | |
| 3661 flags <f> are @samp{g} for @samp{global} (i.e.@: change every | |
| 3662 non-overlapping occurrence of <pat>) and @samp{c} for | |
| 3663 @samp{confirm} (type @samp{y} to confirm a particular | |
| 3664 substitution, else @samp{n} ). Instead of @kbd{/} any | |
| 3665 punctuation CHAR unequal to <space> <tab> and <lf> can be used as | |
| 3666 delimiter. | |
| 3667 | |
| 3668 In Emacs, @samp{\&} stands for the last matched expression, so | |
| 3669 @kbd{s/[ab]+/\&\&/} will double the string matched by @kbd{[ab]}. | |
| 3670 Viper doesn't treat @samp{&} specially, unlike Vi: use @samp{\&} instead. | |
| 3671 | |
| 3672 Note: @emph{The newline character (inserted as @kbd{C-qC-j}) | |
| 3673 can be used in <repl>}. | |
| 3674 @item :[x,y]copy [z] | |
| 3675 Copy text between @kbd{x} and @kbd{y} to the position after @kbd{z}. | |
| 3676 @item :[x,y]t [z] | |
| 3677 Same as @kbd{:copy}. | |
| 3678 @item :[x,y]move [z] | |
| 3679 Move text between @kbd{x} and @kbd{y} to the position after @kbd{z}. | |
| 3680 @item & | |
| 3681 Repeat latest Ex substitute command, e.g. | |
| 3682 @kbd{:s/wrong/right}. | |
| 3683 @item C-c / | |
| 3684 Toggle case-sensitive search. With prefix argument, toggle vanilla/regular | |
| 3685 expression search. | |
| 3686 @item #c<move> | |
| 3687 Change upper-case characters in the region to lower-case. | |
| 3688 @item #C<move> | |
| 3689 Change lower-case characters in the region to upper-case. | |
| 3690 @item #q<move> | |
| 3691 Insert specified string at the beginning of each line in the region | |
| 3692 @item C-c M-p and C-c M-n | |
| 3693 In Insert and Replace states, these keys are bound to commands that peruse | |
| 3694 the history of the text | |
| 3695 previously inserted in other insert or replace commands. By repeatedly typing | |
| 3696 @kbd{C-c M-p} or @kbd{C-c M-n}, you will cause Viper to | |
| 3697 insert these previously used strings one by one. | |
| 3698 When a new string is inserted, the previous one is deleted. | |
| 3699 | |
| 3700 In Vi state, these keys are bound to functions that peruse the history of | |
| 3701 destructive Vi commands. | |
| 3702 @xref{Viper Specials}, for details. | |
| 3703 @end table | |
| 3704 @kindex @kbd{C-c M-p} | |
| 3705 @kindex @kbd{C-c M-n} | |
| 3706 @kindex @kbd{#q<move> } | |
| 3707 @kindex @kbd{#C<move>} | |
| 3708 @kindex @kbd{#c<move>} | |
| 3709 @kindex @kbd{&} | |
| 3710 @kindex @kbd{\&} | |
| 3711 @findex @kbd{:substitute/<pat>/<repl>/<f>} | |
| 3712 @findex @kbd{:s/<pat>/<repl>/<f>} | |
| 3713 @findex @kbd{:copy [z]} | |
| 3714 @findex @kbd{:t [z]} | |
| 3715 @findex @kbd{:move [z]} | |
| 3716 @kindex @kbd{J} | |
| 3717 @kindex @kbd{~} | |
| 3718 @kindex @kbd{=<move>} | |
| 3719 @kindex @kbd{C} | |
| 3720 @kindex @kbd{cc} | |
| 3721 @kindex @kbd{c<move>} | |
| 3722 @kindex @kbd{S} | |
| 3723 @kindex @kbd{s} | |
| 3724 @kindex @kbd{R} | |
| 3725 @kindex @kbd{r<char>} | |
| 3726 | |
| 3727 @node Search and Replace, Yanking, Changing Text,Text Handling | |
| 3728 @subsection Search and Replace | |
| 3729 | |
| 3730 @xref{Groundwork}, for Ex address syntax. @xref{Options}, to see how to | |
| 3731 get literal (non-regular-expression) search and how to stop search from | |
| 3732 wrapping around. | |
| 3733 | |
| 3734 @table @kbd | |
| 3735 @item <count> /<string> | |
| 3736 To the <count>th occurrence of <string>. | |
| 3737 @item <count> ?<string> | |
| 3738 To the <count>th previous occurrence of <string>. | |
| 3739 @item <count> g<move> | |
| 3740 Search for the text described by move. (off by default) | |
| 3741 @item n | |
| 3742 Repeat latest @kbd{/} @kbd{?} (next). | |
| 3743 @item N | |
| 3744 Idem in opposite direction. | |
| 3745 @item % | |
| 3746 Find the next bracket and go to its match | |
| 3747 @item :[x,y]g/<string>/<cmd> | |
| 3748 @cindex text processing | |
| 3749 Search globally [from line x to y] for <string> | |
| 3750 and execute the Ex <cmd> on each occurrence. | |
| 3751 @item :[x,y]v/<string>/<cmd> | |
| 3752 Execute <cmd> on the lines that don't match. | |
| 3753 @item #g<move> | |
| 3754 Execute the last keyboard macro for each line in the region. | |
| 3755 @xref{Macros and Registers}, for more info. | |
| 3756 @item Q | |
| 3757 Query Replace. | |
| 3758 @item :ta <name> | |
| 3759 Search in the tags file where <name> is defined (file, line), and go to it. | |
| 3760 @item :[x,y]s/<pat>/<repl>/<f> | |
| 3761 Substitute (on lines x through y) the pattern <pat> (default the last | |
| 3762 pattern) with <repl>. Useful | |
| 3763 flags <f> are @samp{g} for @samp{global} (i.e.@: change every | |
| 3764 non-overlapping occurrence of <pat>) and @samp{c} for | |
| 3765 @samp{confirm} (type @samp{y} to confirm a particular | |
| 3766 substitution, else @samp{n}). Instead of @kbd{/} any | |
| 3767 punctuation character other than <space> <tab> and <lf> can be used as | |
| 3768 delimiter. | |
| 3769 | |
| 3770 Note: @emph{The newline character (inserted as @kbd{C-qC-j}) | |
| 3771 can be used in <repl>}. | |
| 3772 @item & | |
| 3773 Repeat latest Ex substitute command, e.g.@: @kbd{:s/wrong/right}. | |
| 3774 @item :global /<pattern>/<ex-command> | |
| 3775 @itemx :g /<pattern>/<ex-command> | |
| 3776 Execute <ex-command> on all lines that match <pattern>. | |
| 3777 @item :vglobal /<pattern>/<ex-command> | |
| 3778 @itemx :v /<pattern>/<ex-command> | |
| 3779 Execute <ex-command> on all lines that do not match <pattern>. | |
| 3780 @end table | |
| 3781 @kindex @kbd{&} | |
| 3782 @findex @kbd{:substitute/<pat>/<repl>/<f>} | |
| 3783 @kindex @kbd{Q} | |
| 3784 @kindex @kbd{#g<move>} | |
| 3785 @findex @kbd{:v} | |
| 3786 @findex @kbd{:g} | |
| 3787 @findex @kbd{:global} | |
| 3788 @findex @kbd{:vglobal} | |
| 3789 @findex @kbd{:tag <name>} | |
| 3790 @kindex @kbd{%} | |
| 3791 @kindex @kbd{N} | |
| 3792 @kindex @kbd{n} | |
| 3793 @kindex @kbd{g<move>} | |
| 3794 @kindex @kbd{?<string>} | |
| 3795 @kindex @kbd{/<string>} | |
| 3796 | |
| 3797 @node Yanking,Undoing,Search and Replace,Text Handling | |
| 3798 @subsection Yanking | |
| 3799 | |
| 3800 @cindex cut and paste | |
| 3801 @cindex paste | |
| 3802 | |
| 3803 @table @kbd | |
| 3804 @item <count> y<move> | |
| 3805 Yank from begin to endpoint of <count><move>. | |
| 3806 @item <count> "<a-z>y<move> | |
| 3807 Yank from begin to endpoint of <count><move> to register. | |
| 3808 @item <count> "<A-Z>y<move> | |
| 3809 Yank from begin to endpoint of <count><move> and append | |
| 3810 to register. | |
| 3811 @item <count> yy | |
| 3812 <count> lines. | |
| 3813 @item <count> Y | |
| 3814 Idem (should be equivalent to @kbd{y$} though). | |
| 3815 @item m<a-z> | |
| 3816 Mark the cursor position with a letter. | |
| 3817 @item [<a-z> | |
| 3818 Show contents of textmarker. | |
| 3819 @item ]<a-z> | |
| 3820 Show contents of register. | |
| 3821 @item <count> ["<a-z1-9>]p | |
| 3822 Put the contents of the (default undo) buffer | |
| 3823 <count> times after the cursor. The register will | |
| 3824 be automatically down-cased. | |
| 3825 @item <count> ["<a-z1-9>]P | |
| 3826 Put the contents of the (default undo) buffer | |
| 3827 <count> times before the cursor. The register will | |
| 3828 @end table | |
| 3829 @kindex @kbd{P} | |
| 3830 @kindex @kbd{p} | |
| 3831 @kindex @kbd{"<a-z1-9>p} | |
| 3832 @kindex @kbd{"<a-z1-9>P} | |
| 3833 @kindex @kbd{]<a-z>} | |
| 3834 @kindex @kbd{[<a-z>} | |
| 3835 @kindex @kbd{m<a-z>} | |
| 3836 @kindex @kbd{Y} | |
| 3837 @kindex @kbd{yy} | |
| 3838 @kindex @kbd{"<A-Z>y<move>} | |
| 3839 @kindex @kbd{"<a-z>y<move>} | |
| 3840 @kindex @kbd{y<move>} | |
| 3841 @kindex @kbd{yank} | |
| 3842 @findex @kbd{:yank} | |
| 3843 | |
| 3844 @node Undoing,, Yanking,Text Handling | |
| 3845 @subsection Undoing | |
| 3846 | |
| 3847 @cindex undo | |
| 3848 @cindex backup files | |
| 3849 | |
| 3850 @table @kbd | |
| 3851 @item u U | |
| 3852 Undo the latest change. | |
| 3853 @item . | |
| 3854 Repeat undo. | |
| 3855 @item :q! | |
| 3856 Quit Vi without writing. | |
| 3857 @item :e! | |
| 3858 Re-edit a messed-up file. | |
| 3859 @item :rec | |
| 3860 Recover file from autosave. Viper also creates backup files | |
| 3861 that have a @samp{~} appended to them. | |
| 3862 @end table | |
| 3863 @findex @kbd{:rec} | |
| 3864 @findex @kbd{:e!} | |
| 3865 @findex @kbd{:q!} | |
| 3866 @kindex @kbd{.} | |
| 3867 @kindex @kbd{U} | |
| 3868 @kindex @kbd{u} | |
| 3869 | |
| 3870 @node Display, File and Buffer Handling, Text Handling, Commands | |
| 3871 @section Display | |
| 3872 | |
| 3873 @cindex scrolling | |
| 3874 | |
| 3875 @table @kbd | |
| 3876 @item C-g | |
| 3877 At user level 1, | |
| 3878 give file name, status, current line number | |
| 3879 and relative position.@* | |
| 3880 At user levels 2 and higher, abort the current command. | |
| 3881 @item C-c g | |
| 3882 Give file name, status, current line number and relative position -- all | |
| 3883 user levels. | |
| 3884 @item C-l | |
| 3885 Refresh the screen. | |
| 3886 @item <count> C-e | |
| 3887 Expose <count> more lines at bottom, cursor stays put (if possible). | |
| 3888 @item <count> C-y | |
| 3889 Expose <count> more lines at top, cursor stays put (if possible). | |
| 3890 @item <count> C-d | |
| 3891 Scroll <count> lines downward (default the number of the previous scroll; | |
| 3892 initialization: half a page). | |
| 3893 @item <count> C-u | |
| 3894 Scroll <count> lines upward (default the number of the previous scroll; | |
| 3895 initialization: half a page). | |
| 3896 @item <count> C-f | |
| 3897 <count> pages forward. | |
| 3898 @item <count> C-b | |
| 3899 <count> pages backward (in older versions @kbd{C-b} only works without count). | |
| 3900 @item <count> z<cr> | |
| 3901 @item zH | |
| 3902 Put line <count> at the top of the window (default the current line). | |
| 3903 @item <count> z- | |
| 3904 @item zL | |
| 3905 Put line <count> at the bottom of the window | |
| 3906 (default the current line). | |
| 3907 @item <count> z. | |
| 3908 @item zM | |
| 3909 Put line <count> in the center of the window | |
| 3910 (default the current line). | |
| 3911 @end table | |
| 3912 @kindex @kbd{zM} | |
| 3913 @kindex @kbd{zL} | |
| 3914 @kindex @kbd{zH} | |
| 3915 @kindex @kbd{z<cr>} | |
| 3916 @kindex @kbd{z.} | |
| 3917 @kindex @kbd{z-} | |
| 3918 @kindex @kbd{z<cr>} | |
| 3919 @kindex @kbd{C-b} | |
| 3920 @kindex @kbd{C-f} | |
| 3921 @kindex @kbd{C-u} | |
| 3922 @kindex @kbd{C-d} | |
| 3923 @kindex @kbd{C-y} | |
| 3924 @kindex @kbd{C-e} | |
| 3925 @kindex @kbd{C-l} | |
| 3926 @kindex @kbd{C-g} | |
| 3927 | |
| 3928 | |
| 3929 @node File and Buffer Handling, Mapping, Display,Commands | |
| 3930 @section File and Buffer Handling | |
| 3931 | |
| 3932 @cindex multiple files | |
| 3933 | |
| 3934 In all file handling commands, space should be typed before entering the file | |
| 3935 name. If you need to type a modifier, such as @kbd{>>} or @kbd{!}, don't | |
| 3936 put any space between the command and the modifier. | |
| 3937 | |
|
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3938 Note that many Ex commands, e.g., @kbd{:w}, accept command arguments. The |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3939 effect is that the command would start acting on the current region. For |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3940 instance, if the current region spans the lines 11 through 22, then if you |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3941 type @kbd{1:w} you would see @samp{:11,22w} in the minibuffer. |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
3942 |
| 25829 | 3943 @table @kbd |
| 3944 @item :q | |
| 3945 Quit buffer except if modified. | |
| 3946 @item :q! | |
| 3947 Quit buffer without checking. In Viper, these two commands | |
| 3948 are identical. Confirmation is required if exiting modified buffers that | |
| 3949 visit files. | |
| 3950 @item :suspend | |
| 3951 @item :stop | |
| 3952 Suspend Viper | |
| 3953 @item :[x,y] w | |
| 3954 Write the file. Viper makes sure that a final newline is always added to | |
| 3955 any file where this newline is missing. This is done by setting Emacs | |
| 3956 variable @code{require-final-newline} to @code{t}. If you don't like this | |
| 3957 feature, use @code{setq-default} to set @code{require-final-newline} to | |
| 3958 @code{nil}. This must be done in @file{.viper} file. | |
| 3959 @item :[x,y] w <name> | |
| 3960 Write to the file <name>. | |
| 3961 @item :[x,y] w>> <name> | |
| 3962 Append the buffer to the file <name>. There should be no space between | |
| 3963 @kbd{w} and @kbd{>>}. Type space after the @kbd{>>} and see what happens. | |
| 3964 @item :w!@: <name> | |
| 3965 Overwrite the file <name>. In Viper, @kbd{:w} and @kbd{:w!} are identical. | |
| 3966 Confirmation is required for writing to an existing file (if this is not | |
| 3967 the file the buffer is visiting) or to a read-only file. | |
| 3968 @item :x,y w <name> | |
| 3969 Write lines x through y to the file <name>. | |
| 3970 @item :wq | |
| 3971 Write the file and kill buffer. | |
| 3972 @item :r <file> [<file> ...] | |
| 3973 Read file into a buffer, inserting its contents after the current line. | |
| 3974 @item :xit | |
| 3975 Same as @kbd{:wq}. | |
| 3976 @item :Write | |
| 3977 @itemx :W | |
| 3978 Save all unsaved buffers, asking for confirmation. | |
| 3979 @item :WWrite | |
| 3980 @itemx :WW | |
| 3981 Like @kbd{W}, but without asking for confirmation. | |
| 3982 @item ZZ | |
| 3983 Save current buffer and kill it. If user level is 1, then save all files | |
| 3984 and kill Emacs. Killing Emacs is the wrong way to use it, so you should | |
| 3985 switch to higher user levels as soon as possible. | |
| 3986 @item :x [<file>] | |
| 3987 Save and kill buffer. | |
| 3988 @item :x!@: [<file>] | |
| 3989 @kbd{:w![<file>]} and @kbd{:q}. | |
| 3990 @item :pre | |
| 3991 Preserve the file -- autosave buffers. | |
| 3992 @item :rec | |
| 3993 Recover file from autosave. | |
| 3994 @item :f | |
| 3995 Print file name and lines. | |
| 3996 @item :cd [<dir>] | |
| 3997 Set the working directory to <dir> (default home directory). | |
| 3998 @item :pwd | |
| 3999 Print present working directory. | |
| 4000 @item :e [+<cmd>] <files> | |
| 4001 Edit files. If no filename is given, edit the file visited by the current | |
| 4002 buffer. If buffer was modified or the file changed on disk, ask for | |
| 4003 confirmation. Unlike Vi, Viper allows @kbd{:e} to take multiple arguments. | |
| 4004 The first file is edited the same way as in Vi. The rest are visited | |
| 4005 in the usual Emacs way. | |
| 4006 @item :e!@: [+<cmd>] <files> | |
| 4007 Re-edit file. If no filename, re-edit current file. | |
| 4008 In Viper, unlike Vi, @kbd{e!} is identical to @kbd{:e}. In both cases, the | |
| 4009 user is asked to confirm if there is a danger of discarding changes to a | |
| 4010 buffer. | |
| 4011 @item :q! | |
| 4012 Quit Vi without writing. | |
| 4013 @item C-^ | |
| 4014 Edit the alternate (normally the previous) file. | |
| 4015 @item :rew | |
| 4016 Obsolete | |
| 4017 @item :args | |
| 4018 List files not shown anywhere with counts for next | |
| 4019 @item :n [count] [+<cmd>] [<files>] | |
|
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4020 Edit <count> file, or edit files. The count comes from @kbd{:args}. |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4021 @item :N [count] [+<cmd>] [<files>] |
| 25829 | 4022 Like @kbd{:n}, but the meaning of the variable |
| 4023 @var{ex-cycle-other-window} is reversed. | |
| 4024 @item :b | |
| 4025 Switch to another buffer. If @var{ex-cycle-other-window} is @code{t}, | |
| 4026 switch in another window. Buffer completion is supported. | |
|
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4027 The variable @var{viper-read-buffer-function} controls which function is |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4028 actually used to read the buffer name. The default is @code{read-buffer}, |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4029 but better alternatives are also available in Emacs (e.g., |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4030 @code{iswitchb-read-buffer}). |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4031 @vindex @var{viper-read-buffer-function} |
| 25829 | 4032 @item :B |
| 4033 Like @kbd{:b}, but the meaning of @var{ex-cycle-other-window} is reversed. | |
| 4034 @item :<address>r <name> | |
| 4035 Read the file <name> into the buffer after the line <address>. | |
| 4036 @item v, V, C-v | |
| 4037 Edit a file in current or another window, or in another frame. File name | |
| 4038 is typed in Minibuffer. File completion and history are supported. | |
| 4039 @end table | |
| 4040 @kindex @kbd{v} | |
| 4041 @kindex @kbd{V} | |
| 4042 @findex @kbd{:args} | |
| 4043 @findex @kbd{:rew} | |
| 4044 @kindex @kbd{C-^} | |
| 4045 @findex @kbd{:e!@: [<files>]} | |
| 4046 @findex @kbd{:e [<files>]} | |
| 4047 @findex @kbd{:edit [<files>]} | |
| 4048 @findex @kbd{:edit!@: [<files>]} | |
| 4049 @findex @kbd{:q!} | |
| 4050 @findex @kbd{:q} | |
| 4051 @findex @kbd{:quit} | |
| 4052 @findex @kbd{:quit!} | |
| 4053 @findex @kbd{:f} | |
| 4054 @findex @kbd{:rec} | |
| 4055 @findex @kbd{:r} | |
| 4056 @findex @kbd{:read} | |
| 4057 @findex @kbd{:pre} | |
| 4058 @kindex @kbd{ZZ} | |
| 4059 @findex @kbd{:wq} | |
| 4060 @findex @kbd{:w <file>} | |
| 4061 @findex @kbd{:w!@: <file>} | |
| 4062 @findex @kbd{:w >> <file>} | |
| 4063 @findex @kbd{:write <file>} | |
| 4064 @findex @kbd{:write!@: <file>} | |
| 4065 @findex @kbd{:write >> <file>} | |
| 4066 @findex @kbd{:W} | |
| 4067 @findex @kbd{:WW} | |
| 4068 @findex @kbd{:Write} | |
| 4069 @findex @kbd{:WWrite} | |
| 4070 @findex @kbd{:WWrite} | |
| 4071 @findex @kbd{:x} | |
| 4072 @findex @kbd{:x!} | |
| 4073 @findex @kbd{:suspend} | |
| 4074 @findex @kbd{:stop} | |
| 4075 @findex @kbd{:n [<count> | <file>]} | |
| 4076 @findex @kbd{:cd [<dir>]} | |
| 4077 @findex @kbd{:pwd} | |
| 4078 | |
| 4079 @node Mapping, Shell Commands, File and Buffer Handling, Commands | |
| 4080 @section Mapping | |
| 4081 | |
| 4082 @cindex keybindings | |
| 4083 @cindex key mapping | |
| 4084 | |
| 4085 @table @kbd | |
| 4086 @item :map <string> | |
| 4087 Start defining a Vi-style keyboard macro. | |
| 4088 For instance, typing | |
| 4089 @kbd{:map www} followed by @kbd{:!wc %} and then typing @kbd{C-x )} | |
| 4090 will cause @kbd{www} to run wc on | |
| 4091 current file (Vi replaces @samp{%} with the current file name). | |
| 4092 @item C-x ) | |
| 4093 Finish defining a keyboard macro. | |
| 4094 In Viper, this command completes the process of defining all keyboard | |
| 4095 macros, whether they are Emacs-style or Vi-style. | |
| 4096 This is a departure from Vi, needed to allow WYSIWYG mapping of | |
| 4097 keyboard macros and to permit the use of function keys and arbitrary Emacs | |
| 4098 functions in the macros. | |
| 4099 @item :unmap <string> | |
| 4100 Deprive <string> of its mappings in Vi state. | |
| 4101 @item :map!@: <string> | |
| 4102 Map a macro for Insert state. | |
| 4103 @item :unmap!@: <string> | |
| 4104 Deprive <string> of its mapping in Insert state (see @kbd{:unmap}). | |
| 4105 @item @@<a-z> | |
| 4106 In Vi state, | |
| 4107 execute the contents of register as a command. | |
| 4108 @item @@@@ | |
| 4109 In Vi state, | |
| 4110 repeat last register command. | |
| 4111 @item @@# | |
| 4112 In Vi state, | |
| 4113 begin keyboard macro. End with @@<a-z>. This will | |
| 4114 put the macro in the proper register. Register will | |
| 4115 be automatically down-cased. | |
| 4116 @xref{Macros and Registers}, for more info. | |
| 4117 @item @@!<a-z> | |
| 4118 In Vi state, | |
| 4119 yank anonymous macro to register | |
| 4120 @item * | |
| 4121 In Vi state, | |
| 4122 execute anonymous macro (defined by C-x( and C-x )). | |
| 4123 @item C-x e | |
| 4124 Like @kbd{*}, but works in all Viper states. | |
| 4125 @item #g<move> | |
| 4126 Execute the last keyboard macro for each line in the region. | |
| 4127 @xref{Macros and Registers}, for more info. | |
| 4128 @item [<a-z> | |
| 4129 Show contents of textmarker. | |
| 4130 @item ]<a-z> | |
| 4131 Show contents of register. | |
| 4132 @end table | |
| 4133 @kindex @kbd{]<a-z>} | |
| 4134 @kindex @kbd{[<a-z>} | |
| 4135 @kindex @kbd{#g<move>} | |
| 4136 @kindex @kbd{*} | |
| 4137 @kindex @kbd{@@!<a-z>} | |
| 4138 @kindex @kbd{@@#} | |
| 4139 @kindex @kbd{@@@@} | |
| 4140 @kindex @kbd{@@<a-z>} | |
| 4141 @findex @kbd{:unmap <char>} | |
| 4142 @findex @kbd{:map <char> <seq>} | |
| 4143 @findex @kbd{:unmap!@: <char>} | |
| 4144 @findex @kbd{:map!@: <char> <seq>} | |
| 4145 | |
| 4146 @node Shell Commands, Options, Mapping, Commands | |
| 4147 @section Shell Commands | |
| 4148 | |
| 4149 @cindex % (Current file) | |
| 4150 | |
|
26263
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4151 The symbol @samp{%} is used in Ex shell commands to mean current file. If |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4152 you want a @samp{%} in your command, it must be escaped as @samp{\%}. |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4153 @cindex @samp{%} (Ex address) |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4154 However if @samp{%} is the first character, it stands as the address for |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4155 the whole file. |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4156 @cindex @samp{#} (Previous file) |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4157 Similarly, @samp{#} expands to the previous file. The previous file is the |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4158 first file in @kbd{:args} listing. This defaults to the previous file in |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4159 the VI sense if you have one window.@refill |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4160 |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4161 Symbols @samp{%} and @samp{#} are also used in the Ex commands @kbd{:e} and |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4162 @kbd{:r <shell-cmd>}. The commands @kbd{:w} and the regular @kbd{:r |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4163 <file>} command don't support these meta symbols, because file history is a |
|
4f315ca65976
*** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
25829
diff
changeset
|
4164 better mechanism. |
| 25829 | 4165 |
| 4166 @cindex shell commands | |
| 4167 | |
| 4168 @table @kbd | |
| 4169 @item :sh | |
| 4170 Execute a subshell in another window | |
| 4171 @item :[x,y]!<cmd> | |
| 4172 Execute a shell <cmd> [on lines x through y; | |
| 4173 % is replace by current file, \% is changed to % | |
| 4174 @item :[x,y]!!@: [<args>] | |
| 4175 Repeat last shell command [and append <args>]. | |
| 4176 @item :!<cmd> | |
| 4177 Just execute command and display result in a buffer. | |
| 4178 @item :!!@: <args> | |
| 4179 Repeat last shell command and append <args> | |
| 4180 @item <count> !<move><cmd> | |
| 4181 The shell executes <cmd>, with standard | |
| 4182 input the lines described by <count><move>, | |
| 4183 next the standard output replaces those lines | |
| 4184 (think of @samp{cb}, @samp{sort}, @samp{nroff}, etc.). | |
| 4185 @item <count> !!<cmd> | |
| 4186 Give <count> lines as standard input to the | |
| 4187 shell <cmd>, next let the standard output | |
| 4188 replace those lines. | |
| 4189 @item :[x,y] w !<cmd> | |
| 4190 Let lines x to y be standard input for <cmd> | |
| 4191 (notice the <sp> between @kbd{w} and @kbd{!}). | |
| 4192 @item :<address>r !<cmd> | |
| 4193 Put the output of <cmd> after the line <address> (default current). | |
| 4194 @item :<address>r <name> | |
| 4195 Read the file <name> into the buffer after the line <address> (default | |
| 4196 current). | |
| 4197 @end table | |
| 4198 @findex @kbd{:<address>r <name>} | |
| 4199 @findex @kbd{:<address>r !<cmd>} | |
| 4200 @findex @kbd{!<cmd>} | |
| 4201 @findex @kbd{!!<cmd>} | |
| 4202 @findex @kbd{!<move><cmd>} | |
| 4203 @findex @kbd{:w !<cmd>} | |
| 4204 @findex @kbd{:x,y w !<cmd>} | |
| 4205 @findex @kbd{:!!@: <args>} | |
| 4206 @findex @kbd{:!<cmd>} | |
| 4207 @findex @kbd{:sh} | |
| 4208 | |
| 4209 @node Options,Emacs Related Commands,Shell Commands,Commands | |
| 4210 @section Options | |
| 4211 | |
| 4212 @cindex Vi options | |
| 4213 | |
| 4214 @table @kbd | |
| 4215 @item autoindent | |
| 4216 @itemx ai | |
| 4217 @cindex autoindent | |
| 4218 autoindent -- In append mode after a <cr> the | |
| 4219 cursor will move directly below the first | |
| 4220 character on the previous line. | |
| 4221 This setting affects the current buffer only. | |
| 4222 @item autoindent-global | |
| 4223 @itemx ai-global | |
| 4224 Same as `autoindent', but affects all buffers. | |
| 4225 @item noautoindent | |
| 4226 @itemx noai | |
| 4227 Cancel autoindent. | |
| 4228 @item noautoindent-global | |
| 4229 @itemx noai-g | |
| 4230 Cancel autoindent-global. | |
| 4231 @item ignorecase | |
| 4232 @itemx ic | |
| 4233 @cindex case and searching | |
| 4234 ignorecase -- No distinction between upper and lower cases when searching. | |
| 4235 @item noignorecase | |
| 4236 @itemx noic | |
| 4237 Cancel ignorecase. | |
| 4238 @item magic | |
| 4239 @itemx ma | |
| 4240 @cindex literal searching | |
| 4241 Regular expressions used in searches; nomagic means no regexps. | |
| 4242 @item nomagic | |
| 4243 @item noma | |
| 4244 Cancel magic. | |
| 4245 @item readonly | |
| 4246 @itemx ro | |
| 4247 @cindex readonly files | |
| 4248 readonly -- The file is not to be changed. | |
| 4249 If the user attempts to write to this file, confirmation will be requested. | |
| 4250 @item noreadonly | |
| 4251 @itemx noro | |
| 4252 Cancel readonly. | |
| 4253 @item shell=<string> | |
| 4254 @itemx sh=<string> | |
| 4255 @cindex shell | |
| 4256 shell -- The program to be used for shell escapes | |
| 4257 (default @samp{$SHELL} (default @file{/bin/sh})). | |
| 4258 @item shiftwidth=<count> | |
| 4259 @itemx sw=<count> | |
| 4260 @cindex layout | |
| 4261 @cindex shifting text | |
| 4262 shiftwidth -- Gives the shiftwidth (default 8 positions). | |
| 4263 @item showmatch | |
| 4264 @itemx sm | |
| 4265 @cindex paren matching | |
| 4266 @cindex matching parens | |
| 4267 showmatch -- Whenever you append a @kbd{)}, Vi shows | |
| 4268 its match if it's on the same page; also with | |
| 4269 @kbd{@{} and @kbd{@}}. If there's no match, Vi will beep. | |
| 4270 @item noshowmatch | |
| 4271 @itemx nosm | |
| 4272 Cancel showmatch. | |
| 4273 @item tabstop=<count> | |
| 4274 @itemx ts=<count> | |
| 4275 @cindex changing tab width | |
| 4276 @cindex tabbing | |
| 4277 tabstop -- The length of a <ht>; warning: this is | |
| 4278 only IN the editor, outside of it <ht>s have | |
| 4279 their normal length (default 8 positions). | |
| 4280 This setting affects the current buffer only. | |
| 4281 @item tabstop-global | |
| 4282 @itemx ts-g | |
| 4283 Same as `tabstop', but affects all buffers. | |
| 4284 @item wrapmargin=<count> | |
| 4285 @itemx wm=<count> | |
| 4286 @cindex auto fill | |
| 4287 @cindex word wrap | |
| 4288 wrapmargin -- In append mode Vi automatically | |
| 4289 puts a <lf> whenever there is a <sp> or <ht> | |
| 4290 within <wm> columns from the right margin. | |
| 4291 @item wrapscan | |
| 4292 @itemx ws | |
| 4293 @cindex searching | |
| 4294 wrapscan -- When searching, the end is | |
| 4295 considered @samp{stuck} to the begin of the file. | |
| 4296 @item nowrapscan | |
| 4297 @itemx nows | |
| 4298 Cancel wrapscan. | |
| 4299 @item :set <option> | |
| 4300 Turn <option> on. | |
| 4301 @item :set no<option> | |
| 4302 Turn <option> off. | |
| 4303 @item :set <option>=<value> | |
| 4304 Set <option> to <value>. | |
| 4305 @end table | |
| 4306 @findex @kbd{:set <option>=<value>} | |
| 4307 @findex @kbd{:set no<option>} | |
| 4308 @findex @kbd{:set <option>} | |
| 4309 @findex @kbd{:set ws} | |
| 4310 @findex @kbd{:set wrapscan} | |
| 4311 @findex @kbd{:set wm=<count>} | |
| 4312 @findex @kbd{:set wrapmargin=<count>} | |
| 4313 @findex @kbd{:set ts=<count>} | |
| 4314 @findex @kbd{:set tabstop=<count>} | |
| 4315 @findex @kbd{:set tab-stop-local=<count>} | |
| 4316 @findex @kbd{:set sm} | |
| 4317 @findex @kbd{:set showmatch} | |
| 4318 @findex @kbd{:set sw=<count>} | |
| 4319 @findex @kbd{:set shiftwidth=<count>} | |
| 4320 @findex @kbd{:set sh=<string>} | |
| 4321 @findex @kbd{:set shell=<string>} | |
| 4322 @findex @kbd{:set ro} | |
| 4323 @findex @kbd{:set readonly} | |
| 4324 @findex @kbd{:set magic} | |
| 4325 @findex @kbd{:set ic} | |
| 4326 @findex @kbd{:set ignorecase} | |
| 4327 @findex @kbd{:set ai} | |
| 4328 @findex @kbd{:set autoindent} | |
| 4329 | |
| 4330 @node Emacs Related Commands,,Options,Commands | |
| 4331 @section Emacs Related Commands | |
| 4332 | |
| 4333 @table @kbd | |
| 4334 @item C-\ | |
| 4335 Begin Meta command in Vi or Insert states. Most often used as C-\ x (M-x). | |
| 4336 | |
| 4337 Note: Emacs binds @kbd{C-\} to a function that offers to change the | |
| 4338 keyboard input method in the multilingual environment. Viper overrides this | |
| 4339 binding. However, it is still possible to switch the input method by typing | |
| 4340 @kbd{\ C-\} in the Vi command state and @kbd{C-z \ C-\} in the Insert state. | |
| 4341 Or you can use the MULE menu on the menubar. | |
| 4342 @item C-z | |
| 4343 In Insert and Replace states, prepare Viper to accept the next command and | |
| 4344 execute it as if Viper was in Vi state. Then return to Insert state. | |
| 4345 | |
| 4346 In Vi state, switch to Emacs state; in Emacs state, switch to Vi state. | |
| 4347 @item C-c \ | |
| 4348 Switches to Vi state for the duration of a single command. Then goes back | |
| 4349 to the original Viper state. Works from Vi, Insert, Replace, and Emacs states. | |
| 4350 @item C-x0 | |
| 4351 Close Window | |
| 4352 @item C-x1 | |
| 4353 Close Other Windows | |
| 4354 @item C-x2 | |
| 4355 Split Window | |
| 4356 @item C-xo | |
| 4357 Move among windows | |
| 4358 @item C-xC-f | |
| 4359 Emacs find-file, useful in Insert state | |
| 4360 @item C-y | |
| 4361 Put back the last killed text. Similar to Vi's @kbd{p}, but also works in | |
| 4362 Insert and Replace state. This command doesn't work in Vi command state, | |
| 4363 since this binding is taken for something else. | |
| 4364 @item M-y | |
| 4365 Undoes the last @kbd{C-y} and puts another kill from the kill ring. | |
| 4366 Using this command, you can try may different kills until you find the one | |
| 4367 you need. | |
| 4368 @end table | |
| 4369 @kindex @kbd{M-y} | |
| 4370 @kindex @kbd{C-y} | |
| 4371 @kindex @kbd{C-xC-f} | |
| 4372 @kindex @kbd{C-xo} | |
| 4373 @kindex @kbd{C-x2} | |
| 4374 @kindex @kbd{C-x1} | |
| 4375 @kindex @kbd{C-x0} | |
| 4376 @kindex @kbd{C-z} | |
| 4377 @kindex @kbd{C-\} | |
| 4378 @kindex @kbd{C-c\} | |
| 4379 | |
| 4380 @node Mouse-bound Commands,,,Commands | |
| 4381 @section Mouse-bound Commands | |
| 4382 | |
|
36340
1ca425b36c74
(Rudimentary Changes): Remove doubled `to'.
Gerd Moellmann <gerd@gnu.org>
parents:
36155
diff
changeset
|
4383 The following two mouse actions are normally bound to special search and |
| 25829 | 4384 insert commands in of Viper: |
| 4385 | |
| 4386 @table @kbd | |
|
36155
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
4387 @item S-Mouse-1 |
| 25829 | 4388 Holding Shift and clicking mouse button 1 will |
| 4389 initiate search for | |
| 4390 a region under the mouse pointer. | |
| 4391 This command can take a prefix argument. Note: Viper sets this | |
| 4392 binding only if this mouse action is not | |
| 4393 already bound to something else. | |
| 4394 @xref{Viper Specials}, for more information.@refill | |
| 4395 | |
|
36155
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
4396 @item S-Mouse-2 |
| 25829 | 4397 Holding Shift and clicking button 2 of the mouse will |
| 4398 insert a region surrounding the mouse pointer. | |
| 4399 This command can also take a prefix argument. | |
| 4400 Note: Viper sets this binding only if this mouse action is not | |
| 4401 already bound to something else. | |
| 4402 @xref{Viper Specials}, for more details.@refill | |
| 4403 @end table | |
|
36155
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
4404 @kindex @kbd{S-Mouse-1} |
|
3594ca3f5f64
Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents:
36043
diff
changeset
|
4405 @kindex @kbd{S-Mouse-2} |
| 25829 | 4406 @kindex @kbd{meta button1up} |
| 4407 @kindex @kbd{meta button2up} | |
| 4408 | |
| 4409 @node Acknowledgments,,,Top | |
| 4410 @comment node-name, next, previous, up | |
| 4411 @unnumbered Acknowledgments | |
| 4412 | |
| 4413 Viper, formerly known as VIP-19, was written by Michael Kifer. Viper is | |
| 4414 based on the original VIP package by Masahiko Sato and on its enhancement, | |
| 4415 VIP 4.4, by Aamod Sane. This manual is an adaptation of the manual for VIP | |
| 4416 4.4, which, in turn, was based on Sato's manual for VIP 3.5. | |
| 4417 | |
| 4418 Many contributors on the net pointed out bugs and suggested a number of | |
| 4419 useful features. Here is a (hopefully) complete list of contributors: | |
| 4420 | |
| 4421 @example | |
|
33019
6306740f6938
2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
30009
diff
changeset
|
4422 aaronl@@vitelus.com (Aaron Lehmann), |
| 25829 | 4423 ahg@@panix.com (Al Gelders), |
| 4424 amade@@diagram.fr (Paul-Bernard Amade), | |
| 4425 ascott@@fws214.intel.com (Andy Scott), | |
|
36857
f6386773ce30
2001-03-17 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
36340
diff
changeset
|
4426 bronson@@trestle.com (Scott Bronson), |
| 25829 | 4427 cook@@biostat.wisc.edu (Tom Cook), |
| 4428 csdayton@@midway.uchicago.edu (Soren Dayton), | |
| 4429 dave@@hellgate.utah.edu, | |
| 4430 dominik@@strw.LeidenUniv.nl (Carsten Dominik), | |
| 4431 dwallach@@cs.princeton.edu (Dan Wallach), | |
| 4432 dwight@@toolucky.llnl.gov (Dwight Shih), | |
|
33019
6306740f6938
2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
30009
diff
changeset
|
4433 dxc@@xprt.net (David X. Callaway), |
| 25829 | 4434 edmonds@@edmonds.home.cs.ubc.ca (Brian Edmonds), |
|
35411
be20c22dc16d
2001-01-19 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
35188
diff
changeset
|
4435 gin@@mo.msk.ru (Golubev I.N.), |
| 25829 | 4436 gviswana@@cs.wisc.edu (Guhan Viswanathan), |
| 4437 gvr@@halcyon.com (George V.@: Reilly), | |
| 4438 hatazaki@@bach.convex.com (Takao Hatazaki), | |
| 4439 hpz@@ibmhpz.aug.ipp-garching.mpg.de (Hans-Peter Zehrfeld), | |
| 4440 jackr@@dblues.engr.sgi.com (Jack Repenning), | |
| 4441 jamesm@@bga.com (D.J.@: Miller II), | |
| 4442 jjm@@hplb.hpl.hp.com (Jean-Jacques Moreau), | |
| 4443 jl@@cse.ogi.edu (John Launchbury), | |
| 4444 jobrien@@hchp.org (John O'Brien), | |
| 4445 johnw@@borland.com (John Wiegley), | |
| 4446 kanze@@gabi-soft.fr (James Kanze), | |
| 4447 kin@@isi.com (Kin Cho), | |
| 4448 kwzh@@gnu.org (Karl Heuer), | |
| 4449 lindstro@@biostat.wisc.edu (Mary Lindstrom), | |
|
29165
641e43bad886
2000-05-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
28510
diff
changeset
|
4450 minakaji@@osaka.email.ne.jp (Mikio Nakajima), |
| 25829 | 4451 Mark.Bordas@@East.Sun.COM (Mark Bordas), |
| 4452 meyering@@comco.com (Jim Meyering), | |
|
36043
5d6b76d28b83
2001-02-12 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents:
35411
diff
changeset
|
4453 martin@@xemacs.org (Martin Buchholz), |
| 25829 | 4454 mveiga@@dit.upm.es (Marcelino Veiga Tuimil), |
| 4455 paulk@@summit.esg.apertus.com (Paul Keusemann), | |
| 4456 pfister@@cs.sunysb.edu (Hanspeter Pfister), | |
| 4457 phil_brooks@@MENTORG.COM (Phil Brooks), | |
| 4458 pogrell@@informatik.hu-berlin.de (Lutz Pogrell), | |
| 4459 pradyut@@cs.uchicago.edu (Pradyut Shah), | |
| 4460 roderick@@argon.org (Roderick Schertler), | |
| 4461 rxga@@ulysses.att.com, | |
| 4462 sawdey@@lcse.umn.edu (Aaron Sawdey), | |
| 4463 simonb@@prl.philips.co.uk (Simon Blanchard), | |
| 4464 stephen@@farrell.org (Stephen Farrell), | |
| 4465 sudish@@MindSpring.COM (Sudish Joseph), | |
| 4466 schwab@@issan.informatik.uni-dortmund.de (Andreas Schwab) | |
| 4467 terra@@diku.dk (Morten Welinder), | |
| 4468 thanh@@informatics.muni.cz (Han The Thanh), | |
| 4469 toma@@convex.convex.com, | |
| 4470 vrenjak@@sun1.racal.com (Milan Vrenjak), | |
| 4471 whicken@@dragon.parasoft.com (Wendell Hicken), | |
| 4472 zapman@@cc.gatech.edu (Jason Zapman II), | |
| 4473 @end example | |
| 4474 | |
| 4475 | |
| 4476 @node Key Index,Function Index,,Top | |
| 4477 @comment node-name, next, previous, up | |
| 4478 @unnumbered Key Index | |
| 4479 | |
| 4480 @printindex ky | |
| 4481 | |
| 4482 @node Function Index,Variable Index,Key Index,Top | |
| 4483 @comment node-name, next, previous, up | |
| 4484 @unnumbered Function Index | |
| 4485 | |
| 4486 @printindex fn | |
| 4487 | |
| 4488 @node Variable Index,Package Index,Function Index,Top | |
| 4489 @comment node-name, next, previous, up | |
| 4490 @unnumbered Variable Index | |
| 4491 | |
| 4492 @printindex vr | |
| 4493 | |
| 4494 @node Package Index,Concept Index,Variable Index,Top | |
| 4495 @comment node-name, next, previous, up | |
| 4496 @unnumbered Package Index | |
| 4497 | |
| 4498 @printindex pg | |
| 4499 | |
| 4500 @node Concept Index,,Package Index,Top | |
| 4501 @comment node-name, next, previous, up | |
| 4502 @unnumbered Concept Index | |
| 4503 | |
| 4504 @printindex cp | |
| 4505 | |
| 29713 | 4506 @setchapternewpage odd |
| 25829 | 4507 @contents |
| 4508 @bye |
