annotate man/viper.texi @ 42353:06cba78a5cdd

Fix the doc string of "Latin-5" language environment.
author Eli Zaretskii <eliz@gnu.org>
date Thu, 27 Dec 2001 11:26:56 +0000
parents 3ce98f3e0608
children 633233bf2bbf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1 % -*-texinfo-*-
Dave Love <fx@gnu.org>
parents:
diff changeset
2 \input texinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
3
Dave Love <fx@gnu.org>
parents:
diff changeset
4 @comment Using viper.info instead of viper in setfilename breaks DOS.
Dave Love <fx@gnu.org>
parents:
diff changeset
5 @comment @setfilename viper
Dave Love <fx@gnu.org>
parents:
diff changeset
6 @comment @setfilename viper.info
Dave Love <fx@gnu.org>
parents:
diff changeset
7 @setfilename ../info/viper
Dave Love <fx@gnu.org>
parents:
diff changeset
8
33679
e12097493607 Change @dircategory.
Dave Love <fx@gnu.org>
parents: 33019
diff changeset
9 @dircategory Emacs
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
10 @direntry
Dave Love <fx@gnu.org>
parents:
diff changeset
11 * VIPER: (viper). The newest Emacs VI-emulation mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
12 (also, A VI Plan for Emacs Rescue
Dave Love <fx@gnu.org>
parents:
diff changeset
13 or the VI PERil.)
Dave Love <fx@gnu.org>
parents:
diff changeset
14 @end direntry
Dave Love <fx@gnu.org>
parents:
diff changeset
15
Dave Love <fx@gnu.org>
parents:
diff changeset
16 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
17 @finalout
Dave Love <fx@gnu.org>
parents:
diff changeset
18 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
19
Dave Love <fx@gnu.org>
parents:
diff changeset
20 @titlepage
Dave Love <fx@gnu.org>
parents:
diff changeset
21 @title Viper Is a Package for Emacs Rebels
Dave Love <fx@gnu.org>
parents:
diff changeset
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
Dave Love <fx@gnu.org>
parents:
diff changeset
24
Dave Love <fx@gnu.org>
parents:
diff changeset
25 @author Michael Kifer (Viper)
Dave Love <fx@gnu.org>
parents:
diff changeset
26 @author Aamod Sane (VIP 4.4)
Dave Love <fx@gnu.org>
parents:
diff changeset
27 @author Masahiko Sato (VIP 3.5)
Dave Love <fx@gnu.org>
parents:
diff changeset
28
Dave Love <fx@gnu.org>
parents:
diff changeset
29 @page
Dave Love <fx@gnu.org>
parents:
diff changeset
30 @vskip 0pt plus 1fill
Dave Love <fx@gnu.org>
parents:
diff changeset
31 @end titlepage
Dave Love <fx@gnu.org>
parents:
diff changeset
32
Dave Love <fx@gnu.org>
parents:
diff changeset
33 @unnumbered Distribution
Dave Love <fx@gnu.org>
parents:
diff changeset
34
Dave Love <fx@gnu.org>
parents:
diff changeset
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
Dave Love <fx@gnu.org>
parents:
diff changeset
54
Dave Love <fx@gnu.org>
parents:
diff changeset
55 @ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
56 @node Top, Overview,, (DIR)
Dave Love <fx@gnu.org>
parents:
diff changeset
57
Dave Love <fx@gnu.org>
parents:
diff changeset
58 @unnumbered Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
59
Dave Love <fx@gnu.org>
parents:
diff changeset
60 We believe that one or more of the following statements are adequate
Dave Love <fx@gnu.org>
parents:
diff changeset
61 descriptions:
Dave Love <fx@gnu.org>
parents:
diff changeset
62
Dave Love <fx@gnu.org>
parents:
diff changeset
63 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
64 Viper Is a Package for Emacs Rebels;
Dave Love <fx@gnu.org>
parents:
diff changeset
65 it is a VI Plan for Emacs Rescue
Dave Love <fx@gnu.org>
parents:
diff changeset
66 and/or a venomous VI PERil.
Dave Love <fx@gnu.org>
parents:
diff changeset
67 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
68
Dave Love <fx@gnu.org>
parents:
diff changeset
69 Technically speaking, Viper is a Vi emulation package for Emacs. It
Dave Love <fx@gnu.org>
parents:
diff changeset
70 implements all Vi and Ex commands, occasionally improving on them and
Dave Love <fx@gnu.org>
parents:
diff changeset
71 adding many new features. It gives the user the best of both worlds: Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
72 keystrokes for editing combined with the power of the Emacs environment.
Dave Love <fx@gnu.org>
parents:
diff changeset
73
Dave Love <fx@gnu.org>
parents:
diff changeset
74 Viper emulates Vi at several levels, from the one that closely follows Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
75 conventions to the one that departs from many of them. It has many
Dave Love <fx@gnu.org>
parents:
diff changeset
76 customizable options, which can be used to tailor Viper to the work habits
Dave Love <fx@gnu.org>
parents:
diff changeset
77 of various users.
Dave Love <fx@gnu.org>
parents:
diff changeset
78 This manual describes Viper, concentrating on the differences from Vi and
Dave Love <fx@gnu.org>
parents:
diff changeset
79 new features of Viper.
Dave Love <fx@gnu.org>
parents:
diff changeset
80
Dave Love <fx@gnu.org>
parents:
diff changeset
81 Viper, formerly known as VIP-19, was written by Michael Kifer. It is based
Dave Love <fx@gnu.org>
parents:
diff changeset
82 on VIP version 3.5 by Masahiko Sato and VIP version 4.4 by Aamod Sane.
Dave Love <fx@gnu.org>
parents:
diff changeset
83 Viper tries to be compatible with these packages.
Dave Love <fx@gnu.org>
parents:
diff changeset
84
Dave Love <fx@gnu.org>
parents:
diff changeset
85 Viper is intended to be usable without reading this manual --- the defaults
Dave Love <fx@gnu.org>
parents:
diff changeset
86 are set to make Viper as close to Vi as possible. At startup, Viper will
Dave Love <fx@gnu.org>
parents:
diff changeset
87 try to set the most appropriate default environment for you, based on
Dave Love <fx@gnu.org>
parents:
diff changeset
88 your familiarity with Emacs. It will also tell you the basic GNU Emacs window
Dave Love <fx@gnu.org>
parents:
diff changeset
89 management commands to help you start immediately.
Dave Love <fx@gnu.org>
parents:
diff changeset
90
Dave Love <fx@gnu.org>
parents:
diff changeset
91 Although this manual explains how to customize Viper, some basic
Dave Love <fx@gnu.org>
parents:
diff changeset
92 familiarity with Emacs Lisp would be a plus.
Dave Love <fx@gnu.org>
parents:
diff changeset
93
Dave Love <fx@gnu.org>
parents:
diff changeset
94 It is recommended that you read the Overview node. The other nodes may
Dave Love <fx@gnu.org>
parents:
diff changeset
95 be visited as needed.
Dave Love <fx@gnu.org>
parents:
diff changeset
96
Dave Love <fx@gnu.org>
parents:
diff changeset
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
Dave Love <fx@gnu.org>
parents:
diff changeset
99 Please use the Ex command @kbd{:submitReport} for this purpose.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
100
Dave Love <fx@gnu.org>
parents:
diff changeset
101 @end ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
102
Dave Love <fx@gnu.org>
parents:
diff changeset
103 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
104 * Overview:: Must read to get started
Dave Love <fx@gnu.org>
parents:
diff changeset
105 * Improvements over Vi:: New features, Improvements
Dave Love <fx@gnu.org>
parents:
diff changeset
106 * Customization:: How to customize Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
107 * Commands:: Vi and Ex Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
108
Dave Love <fx@gnu.org>
parents:
diff changeset
109 * Key Index:: Index of Vi and Ex Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
110 * Function Index:: Index of Viper Functions
Dave Love <fx@gnu.org>
parents:
diff changeset
111 * Variable Index:: Index of Viper Variables
Dave Love <fx@gnu.org>
parents:
diff changeset
112 * Package Index:: Index of Packages Mentioned in this Document
Dave Love <fx@gnu.org>
parents:
diff changeset
113 * Concept Index:: Vi, Ex and Emacs concepts
Dave Love <fx@gnu.org>
parents:
diff changeset
114
Dave Love <fx@gnu.org>
parents:
diff changeset
115 * Acknowledgments::
Dave Love <fx@gnu.org>
parents:
diff changeset
116 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
117 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
118 @unnumbered Introduction
Dave Love <fx@gnu.org>
parents:
diff changeset
119
Dave Love <fx@gnu.org>
parents:
diff changeset
120 We believe that one or more of the following statements are adequate
Dave Love <fx@gnu.org>
parents:
diff changeset
121 descriptions:
Dave Love <fx@gnu.org>
parents:
diff changeset
122
Dave Love <fx@gnu.org>
parents:
diff changeset
123 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
124 Viper Is a Package for Emacs Rebels;
Dave Love <fx@gnu.org>
parents:
diff changeset
125 it is a VI Plan for Emacs Rescue
Dave Love <fx@gnu.org>
parents:
diff changeset
126 and/or a venomous VI PERil.
Dave Love <fx@gnu.org>
parents:
diff changeset
127 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
128
Dave Love <fx@gnu.org>
parents:
diff changeset
129 Viper is a Vi emulation package for Emacs. Viper contains virtually all
Dave Love <fx@gnu.org>
parents:
diff changeset
130 of Vi and Ex functionality and much more. It gives you the best of both
Dave Love <fx@gnu.org>
parents:
diff changeset
131 worlds: Vi keystrokes for editing combined with the GNU Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
132 environment. Viper also fixes some common complaints with Vi commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
133 This manual describes Viper, concentrating on the differences from Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
134 and on the new features of Viper.
Dave Love <fx@gnu.org>
parents:
diff changeset
135
Dave Love <fx@gnu.org>
parents:
diff changeset
136 Viper was written by Michael Kifer. It is based on VIP version 3.5 by
Dave Love <fx@gnu.org>
parents:
diff changeset
137 Masahiko Sato and VIP version 4.4 by Aamod Sane. Viper tries to be
Dave Love <fx@gnu.org>
parents:
diff changeset
138 compatible with these packages.
Dave Love <fx@gnu.org>
parents:
diff changeset
139
Dave Love <fx@gnu.org>
parents:
diff changeset
140 Viper is intended to be usable out of the box, without reading this manual
Dave Love <fx@gnu.org>
parents:
diff changeset
141 --- the defaults are set to make Viper as close to Vi as possible. At
Dave Love <fx@gnu.org>
parents:
diff changeset
142 startup, Viper will attempt to set the most appropriate default environment
Dave Love <fx@gnu.org>
parents:
diff changeset
143 for you, based on your familiarity with Emacs. It will also tell you the
Dave Love <fx@gnu.org>
parents:
diff changeset
144 basic GNU Emacs window management commands to help you start immediately.
Dave Love <fx@gnu.org>
parents:
diff changeset
145
Dave Love <fx@gnu.org>
parents:
diff changeset
146 Although this manual explains how to customize Viper, some basic
Dave Love <fx@gnu.org>
parents:
diff changeset
147 familiarity with Emacs Lisp would be a plus.
Dave Love <fx@gnu.org>
parents:
diff changeset
148
Dave Love <fx@gnu.org>
parents:
diff changeset
149 It is recommended that you read the chapter Overview. The other chapters
Dave Love <fx@gnu.org>
parents:
diff changeset
150 will be useful for customization and advanced usage.
Dave Love <fx@gnu.org>
parents:
diff changeset
151
Dave Love <fx@gnu.org>
parents:
diff changeset
152 You should also learn to use the Info on-line hypertext manual system that
Dave Love <fx@gnu.org>
parents:
diff changeset
153 comes with Emacs. This manual can be read as an Info file. Try the command
Dave Love <fx@gnu.org>
parents:
diff changeset
154 @kbd{@key{ESC} x info} with vanilla Emacs sometime.
Dave Love <fx@gnu.org>
parents:
diff changeset
155
Dave Love <fx@gnu.org>
parents:
diff changeset
156 Comments and bug reports are welcome.
Dave Love <fx@gnu.org>
parents:
diff changeset
157 @code{kifer@@cs.sunysb.edu} is the current address for Viper bug reports.
Dave Love <fx@gnu.org>
parents:
diff changeset
158 Please use the Ex command @kbd{:submitReport} for this purpose.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
159
Dave Love <fx@gnu.org>
parents:
diff changeset
160 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
161
Dave Love <fx@gnu.org>
parents:
diff changeset
162 @node Overview,Improvements over Vi,Top,Top
Dave Love <fx@gnu.org>
parents:
diff changeset
163 @chapter Overview of Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
164
Dave Love <fx@gnu.org>
parents:
diff changeset
165 Viper is a Vi emulation on top of Emacs. At the same time, Viper provides a
Dave Love <fx@gnu.org>
parents:
diff changeset
166 virtually unrestricted access to Emacs facilities. Perfect compatibility
Dave Love <fx@gnu.org>
parents:
diff changeset
167 with Vi is possible but not desirable. This chapter tells you about the
Dave Love <fx@gnu.org>
parents:
diff changeset
168 Emacs ideas that you should know about, how to use Viper within Emacs and
Dave Love <fx@gnu.org>
parents:
diff changeset
169 some incompatibilities.
Dave Love <fx@gnu.org>
parents:
diff changeset
170
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
171 This manual is written with the assumption that you are an experienced Vi
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
172 user who wants to switch to Emacs while retaining the ability to edit files
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
173 Vi style. Incredible as it might seem, there are experienced Emacs users
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
174 who use Viper as a backdoor into the superior (as every Vi user already knows)
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
175 world of Vi! These users are well familiar with Emacs bindings and prefer them
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
176 in some cases, especially in the Vi Insert state. John Hawkins
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
177 <jshawkin@@eecs.umich.edu> has provided a set of customizations, which
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
178 enables additional Emacs bindings under Viper. These customizations can be
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
179 included in your @file{~/.viper} file and are found at the following URL:
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
180 @file{http://www.eecs.umich.edu/~jshawkin/viper-sample}.
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
181
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
182 Viper was formerly known as VIP-19, which was
Dave Love <fx@gnu.org>
parents:
diff changeset
183 a descendant of VIP 3.5 by Masahiko Sato and VIP 4.4 by Aamod Sane.
Dave Love <fx@gnu.org>
parents:
diff changeset
184
Dave Love <fx@gnu.org>
parents:
diff changeset
185 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
186 * Emacs Preliminaries:: Basic concepts in Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
187 * Loading Viper:: Loading and Preliminary Configuration.
Dave Love <fx@gnu.org>
parents:
diff changeset
188 * States in Viper:: Viper has four states orthogonal to Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
189 modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
190 * The Minibuffer:: Command line in Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
191 * Multiple Files in Viper:: True multiple file handling.
Dave Love <fx@gnu.org>
parents:
diff changeset
192 * Unimplemented Features:: That are unlikely to be implemented.
Dave Love <fx@gnu.org>
parents:
diff changeset
193 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
194
Dave Love <fx@gnu.org>
parents:
diff changeset
195 @node Emacs Preliminaries, Loading Viper, Overview, Overview
Dave Love <fx@gnu.org>
parents:
diff changeset
196 @section Emacs Preliminaries
Dave Love <fx@gnu.org>
parents:
diff changeset
197
Dave Love <fx@gnu.org>
parents:
diff changeset
198 @cindex buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
199 @cindex point
Dave Love <fx@gnu.org>
parents:
diff changeset
200 @cindex mark
Dave Love <fx@gnu.org>
parents:
diff changeset
201 @cindex text
Dave Love <fx@gnu.org>
parents:
diff changeset
202 @cindex looking at
Dave Love <fx@gnu.org>
parents:
diff changeset
203 @cindex end (of buffer)
Dave Love <fx@gnu.org>
parents:
diff changeset
204 @cindex end (of line)
Dave Love <fx@gnu.org>
parents:
diff changeset
205 @cindex region
Dave Love <fx@gnu.org>
parents:
diff changeset
206
Dave Love <fx@gnu.org>
parents:
diff changeset
207 Emacs can edit several files at once. A file in Emacs is placed in a
Dave Love <fx@gnu.org>
parents:
diff changeset
208 @dfn{buffer} that usually has the same name as the file. Buffers are also used
Dave Love <fx@gnu.org>
parents:
diff changeset
209 for other purposes, such as shell interfaces, directory editing, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
210 @xref{Dired,,Directory Editor,emacs,The
Dave Love <fx@gnu.org>
parents:
diff changeset
211 Gnu Emacs Manual}, for an example.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
212
Dave Love <fx@gnu.org>
parents:
diff changeset
213 A buffer has a distinguished position called the @dfn{point}.
Dave Love <fx@gnu.org>
parents:
diff changeset
214 A @dfn{point} is always between 2 characters, and is @dfn{looking at}
Dave Love <fx@gnu.org>
parents:
diff changeset
215 the right hand character. The cursor is positioned on the right hand
Dave Love <fx@gnu.org>
parents:
diff changeset
216 character. Thus, when the @dfn{point} is looking at the end-of-line,
Dave Love <fx@gnu.org>
parents:
diff changeset
217 the cursor is on the end-of-line character, i.e.@: beyond the last
Dave Love <fx@gnu.org>
parents:
diff changeset
218 character on the line. This is the default Emacs behavior.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
219
Dave Love <fx@gnu.org>
parents:
diff changeset
220 The default settings of Viper try to mimic the behavior of Vi, preventing
Dave Love <fx@gnu.org>
parents:
diff changeset
221 the cursor from going beyond the last character on the line. By using
Dave Love <fx@gnu.org>
parents:
diff changeset
222 Emacs commands directly (such as those bound to arrow keys), it is possible
Dave Love <fx@gnu.org>
parents:
diff changeset
223 to get the cursor beyond the end-of-line. However, this won't (or
Dave Love <fx@gnu.org>
parents:
diff changeset
224 shouldn't) happen if you restrict yourself to standard Vi keys, unless you
Dave Love <fx@gnu.org>
parents:
diff changeset
225 modify the default editing style. @xref{Customization}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
226
Dave Love <fx@gnu.org>
parents:
diff changeset
227 In addition to the @dfn{point}, there is another distinguished buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
228 position called the @dfn{mark}. @xref{Mark,,Mark,emacs,The GNU Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
229 manual}, for more info on the mark. The text between the @dfn{point} and
Dave Love <fx@gnu.org>
parents:
diff changeset
230 the @dfn{mark} is called the @dfn{region} of the buffer. For the Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
231 user, this simply means that in addition to the Vi textmarkers a--z, there
Dave Love <fx@gnu.org>
parents:
diff changeset
232 is another marker called @dfn{mark}. This is similar to the unnamed Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
233 marker used by the jump commands @kbd{``} and @kbd{''}, which move the
Dave Love <fx@gnu.org>
parents:
diff changeset
234 cursor to the position of the last absolute jump. Viper provides access to
Dave Love <fx@gnu.org>
parents:
diff changeset
235 the region in most text manipulation commands as @kbd{r} and @kbd{R} suffix
Dave Love <fx@gnu.org>
parents:
diff changeset
236 to commands that operate on text regions, e.g., @kbd{dr} to delete region,
Dave Love <fx@gnu.org>
parents:
diff changeset
237 etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
238
Dave Love <fx@gnu.org>
parents:
diff changeset
239 Furthermore, Viper lets Ex-style commands to work on the current region.
Dave Love <fx@gnu.org>
parents:
diff changeset
240 This is done by typing a digit argument before @kbd{:}. For instance,
Dave Love <fx@gnu.org>
parents:
diff changeset
241 typing @kbd{1:} will propmt you with something like @emph{:123,135},
Dave Love <fx@gnu.org>
parents:
diff changeset
242 assuming that the current region starts at line 123 and ends at line
Dave Love <fx@gnu.org>
parents:
diff changeset
243 135. There is no need to type the line numbers, since Viper inserts them
Dave Love <fx@gnu.org>
parents:
diff changeset
244 automatically in front of the Ex command.
Dave Love <fx@gnu.org>
parents:
diff changeset
245
Dave Love <fx@gnu.org>
parents:
diff changeset
246 @xref{Basics}, for more info.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
247
Dave Love <fx@gnu.org>
parents:
diff changeset
248 @cindex window
Dave Love <fx@gnu.org>
parents:
diff changeset
249 @cindex mode line
Dave Love <fx@gnu.org>
parents:
diff changeset
250 @cindex buffer information
Dave Love <fx@gnu.org>
parents:
diff changeset
251 @cindex Minibuffer
Dave Love <fx@gnu.org>
parents:
diff changeset
252 @cindex command line
Dave Love <fx@gnu.org>
parents:
diff changeset
253 @cindex buffer (modified)
Dave Love <fx@gnu.org>
parents:
diff changeset
254
Dave Love <fx@gnu.org>
parents:
diff changeset
255 Emacs divides the screen into tiled @dfn{windows}. You can see the
Dave Love <fx@gnu.org>
parents:
diff changeset
256 contents of a buffer through the window associated with the buffer. The
Dave Love <fx@gnu.org>
parents:
diff changeset
257 cursor of the screen is positioned on the character after @dfn{point}.
Dave Love <fx@gnu.org>
parents:
diff changeset
258 Every window has a @dfn{mode line} that displays information about the buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
259 You can change the format of the mode
Dave Love <fx@gnu.org>
parents:
diff changeset
260 line, but normally if you see @samp{**} at the beginning of a mode line it
Dave Love <fx@gnu.org>
parents:
diff changeset
261 means that the buffer is @dfn{modified}. If you write out the contents of
Dave Love <fx@gnu.org>
parents:
diff changeset
262 a buffer to a file, then the buffer will become not modified. Also if
Dave Love <fx@gnu.org>
parents:
diff changeset
263 you see @samp{%%} at the beginning of the mode line, it means that the file
Dave Love <fx@gnu.org>
parents:
diff changeset
264 associated with the buffer is write protected. The mode line will also
Dave Love <fx@gnu.org>
parents:
diff changeset
265 show the buffer name and current major and minor modes (see below).
Dave Love <fx@gnu.org>
parents:
diff changeset
266 A special buffer called @dfn{Minibuffer} is displayed as the last line
Dave Love <fx@gnu.org>
parents:
diff changeset
267 in a Minibuffer window. The Minibuffer window is used for command input
Dave Love <fx@gnu.org>
parents:
diff changeset
268 output. Viper uses Minibuffer window for @kbd{/} and @kbd{:}
Dave Love <fx@gnu.org>
parents:
diff changeset
269 commands.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
270
Dave Love <fx@gnu.org>
parents:
diff changeset
271 @cindex mode
Dave Love <fx@gnu.org>
parents:
diff changeset
272 @cindex keymap
Dave Love <fx@gnu.org>
parents:
diff changeset
273 @cindex local keymap
Dave Love <fx@gnu.org>
parents:
diff changeset
274 @cindex global keymap
Dave Love <fx@gnu.org>
parents:
diff changeset
275 @cindex major mode
Dave Love <fx@gnu.org>
parents:
diff changeset
276 @cindex minor mode
Dave Love <fx@gnu.org>
parents:
diff changeset
277
Dave Love <fx@gnu.org>
parents:
diff changeset
278 An Emacs buffer can have a @dfn{major mode} that customizes Emacs for
Dave Love <fx@gnu.org>
parents:
diff changeset
279 editing text of a particular sort by changing the functionality of the keys.
Dave Love <fx@gnu.org>
parents:
diff changeset
280 Keys are defined using a @dfn{keymap} that records the bindings between
Dave Love <fx@gnu.org>
parents:
diff changeset
281 keystrokes and
Dave Love <fx@gnu.org>
parents:
diff changeset
282 functions. The @dfn{global keymap} is common to all the
Dave Love <fx@gnu.org>
parents:
diff changeset
283 buffers. Additionally, each buffer has its @dfn{local keymap} that determines the
Dave Love <fx@gnu.org>
parents:
diff changeset
284 @dfn{mode} of the buffer. If a function is bound to some key in the local
Dave Love <fx@gnu.org>
parents:
diff changeset
285 keymap then that function will be executed when you type the key.
Dave Love <fx@gnu.org>
parents:
diff changeset
286 If no function is bound to a key in the
Dave Love <fx@gnu.org>
parents:
diff changeset
287 local map, however, the function bound to the key in the global map
Dave Love <fx@gnu.org>
parents:
diff changeset
288 will be executed. @xref{Major Modes,Major Modes,Major Modes,emacs,The
Dave Love <fx@gnu.org>
parents:
diff changeset
289 GNU Emacs Manual}, for more information.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
290
Dave Love <fx@gnu.org>
parents:
diff changeset
291 A buffer can also have a @dfn{minor mode}. Minor modes are options that
Dave Love <fx@gnu.org>
parents:
diff changeset
292 you can use or not. A buffer in @code{text-mode} can have
Dave Love <fx@gnu.org>
parents:
diff changeset
293 @code{auto-fill-mode} as minor mode, which can be turned off or on at
Dave Love <fx@gnu.org>
parents:
diff changeset
294 any time. In Emacs, a minor mode may have it own keymap,
Dave Love <fx@gnu.org>
parents:
diff changeset
295 which overrides the local keymap when the minor mode is turned on. For
Dave Love <fx@gnu.org>
parents:
diff changeset
296 more information, @pxref{Minor Modes,Minor Modes,Minor Modes,emacs,The
Dave Love <fx@gnu.org>
parents:
diff changeset
297 GNU Emacs Manual} @refill
Dave Love <fx@gnu.org>
parents:
diff changeset
298
Dave Love <fx@gnu.org>
parents:
diff changeset
299 @cindex Viper as minor mode
Dave Love <fx@gnu.org>
parents:
diff changeset
300 @cindex Control keys
Dave Love <fx@gnu.org>
parents:
diff changeset
301 @cindex Meta key
Dave Love <fx@gnu.org>
parents:
diff changeset
302
Dave Love <fx@gnu.org>
parents:
diff changeset
303 Viper is implemented as a collection of minor modes. Different minor modes
Dave Love <fx@gnu.org>
parents:
diff changeset
304 are involved when Viper emulates Vi command mode, Vi insert mode, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
305 You can also turn Viper on and off at any time while in Vi command mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
306 @xref{States in Viper}, for
Dave Love <fx@gnu.org>
parents:
diff changeset
307 more information.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
308
Dave Love <fx@gnu.org>
parents:
diff changeset
309 Emacs uses Control and Meta modifiers. These are denoted as C and M,
Dave Love <fx@gnu.org>
parents:
diff changeset
310 e.g.@: @kbd{^Z} as @kbd{C-z} and @kbd{Meta-x} as @kbd{M-x}. The Meta key is
Dave Love <fx@gnu.org>
parents:
diff changeset
311 usually located on each side of the Space bar; it is used in a manner
Dave Love <fx@gnu.org>
parents:
diff changeset
312 similar to the Control key, e.g., @kbd{M-x} means typing @kbd{x} while
Dave Love <fx@gnu.org>
parents:
diff changeset
313 holding the Meta key down. For keyboards that do not have a Meta key,
Dave Love <fx@gnu.org>
parents:
diff changeset
314 @key{ESC} is used as Meta. Thus @kbd{M-x} is typed as @kbd{@key{ESC}
Dave Love <fx@gnu.org>
parents:
diff changeset
315 x}. Viper uses @key{ESC} to switch from Insert state to Vi state. Therefore
Dave Love <fx@gnu.org>
parents:
diff changeset
316 Viper defines @kbd{C-\} as its Meta key in Vi state. @xref{Vi State}, for
Dave Love <fx@gnu.org>
parents:
diff changeset
317 more info.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
318
Dave Love <fx@gnu.org>
parents:
diff changeset
319 Emacs is structured as a lisp interpreter around a C core. Emacs keys
Dave Love <fx@gnu.org>
parents:
diff changeset
320 cause lisp functions to be called. It is possible to call these
Dave Love <fx@gnu.org>
parents:
diff changeset
321 functions directly, by typing @kbd{M-x function-name}.
Dave Love <fx@gnu.org>
parents:
diff changeset
322
Dave Love <fx@gnu.org>
parents:
diff changeset
323 @node Loading Viper, States in Viper, Emacs Preliminaries, Overview
Dave Love <fx@gnu.org>
parents:
diff changeset
324 @section Loading Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
325
Dave Love <fx@gnu.org>
parents:
diff changeset
326 The most common way to load it automatically is to include the following
Dave Love <fx@gnu.org>
parents:
diff changeset
327 lines (in the given order!):
Dave Love <fx@gnu.org>
parents:
diff changeset
328
Dave Love <fx@gnu.org>
parents:
diff changeset
329 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
330 (setq viper-mode t)
Dave Love <fx@gnu.org>
parents:
diff changeset
331 (require 'viper)
Dave Love <fx@gnu.org>
parents:
diff changeset
332 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
333
Dave Love <fx@gnu.org>
parents:
diff changeset
334 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
335 in your @file{~/.emacs} file. The @file{.emacs} file is placed in your
Dave Love <fx@gnu.org>
parents:
diff changeset
336 home directory and it is be executed every time you invoke Emacs. This is
Dave Love <fx@gnu.org>
parents:
diff changeset
337 the place where all general Emacs customization takes place. Beginning with
Dave Love <fx@gnu.org>
parents:
diff changeset
338 version 20.0, Emacsen have an interactive interface, which simplifies the
Dave Love <fx@gnu.org>
parents:
diff changeset
339 job of customization significantly.
Dave Love <fx@gnu.org>
parents:
diff changeset
340
Dave Love <fx@gnu.org>
parents:
diff changeset
341 Viper also uses the file @file{~/.viper} for Viper-specific customization.
Dave Love <fx@gnu.org>
parents:
diff changeset
342 If you wish to be in Vi command state whenever this is deemed appropriate
Dave Love <fx@gnu.org>
parents:
diff changeset
343 by the author, you can include the following line in your @file{.viper}:
Dave Love <fx@gnu.org>
parents:
diff changeset
344 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
345 (setq viper-always t)
Dave Love <fx@gnu.org>
parents:
diff changeset
346 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
347 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
348 (@xref{Vi State}, for the explanation of Vi command state.)
Dave Love <fx@gnu.org>
parents:
diff changeset
349
Dave Love <fx@gnu.org>
parents:
diff changeset
350 The location of Viper customization file can be changed by setting the
Dave Love <fx@gnu.org>
parents:
diff changeset
351 variable @code{viper-custom-file-name} in @file{.emacs} @emph{prior} to loading
Dave Love <fx@gnu.org>
parents:
diff changeset
352 Viper.
Dave Love <fx@gnu.org>
parents:
diff changeset
353
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
354 The latest versions of Emacs have an interactive customization facility,
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
355 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
356 @file{.viper} files. You can reach this customization
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
357 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
358 @kbd{:customize}.
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
359
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
360 Once invoked, Viper will arrange to bring up Emacs buffers in Vi state
Dave Love <fx@gnu.org>
parents:
diff changeset
361 whenever this makes sense.
Dave Love <fx@gnu.org>
parents:
diff changeset
362 @xref{Packages that Change Keymaps}, to find out when forcing Vi command state
Dave Love <fx@gnu.org>
parents:
diff changeset
363 on a buffer may be counter-productive.
Dave Love <fx@gnu.org>
parents:
diff changeset
364
Dave Love <fx@gnu.org>
parents:
diff changeset
365 Even if your @file{.emacs} and @file{.viper} files do not contain any of the
Dave Love <fx@gnu.org>
parents:
diff changeset
366 above lines, you can still load Viper and enter Vi command state by typing the
Dave Love <fx@gnu.org>
parents:
diff changeset
367 following from within Emacs:
Dave Love <fx@gnu.org>
parents:
diff changeset
368
Dave Love <fx@gnu.org>
parents:
diff changeset
369 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
370 M-x viper-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
371 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
372
Dave Love <fx@gnu.org>
parents:
diff changeset
373 When Emacs first comes up, if you have not specified a file on the
Dave Love <fx@gnu.org>
parents:
diff changeset
374 command line, it will show the @samp{*scratch*} buffer, in the
Dave Love <fx@gnu.org>
parents:
diff changeset
375 @samp{Lisp Interaction} mode. After you invoke Viper, you can start
Dave Love <fx@gnu.org>
parents:
diff changeset
376 editing files by using @kbd{:e}, @kbd{:vi}, or @kbd{v} commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
377 (@xref{File and Buffer Handling}, for more information on @kbd{v} and other
Dave Love <fx@gnu.org>
parents:
diff changeset
378 new commands that, in many cases, are more convenient than @kbd{:e},
Dave Love <fx@gnu.org>
parents:
diff changeset
379 @kbd{:vi}, and similar old-style Vi commands.)@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
380
Dave Love <fx@gnu.org>
parents:
diff changeset
381 Finally, if at some point you would want to get de-Viperize your running
Dave Love <fx@gnu.org>
parents:
diff changeset
382 copy of Emacs after Viper has been loaded, the command @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
383 viper-go-away} will do it for you. The function @code{toggle-viper-mode}
Dave Love <fx@gnu.org>
parents:
diff changeset
384 toggles Viperization of Emacs on and off.
Dave Love <fx@gnu.org>
parents:
diff changeset
385
Dave Love <fx@gnu.org>
parents:
diff changeset
386 @node States in Viper, The Minibuffer, Loading Viper,Overview
Dave Love <fx@gnu.org>
parents:
diff changeset
387 @section States in Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
388
Dave Love <fx@gnu.org>
parents:
diff changeset
389 @kindex @kbd{C-z}
Dave Love <fx@gnu.org>
parents:
diff changeset
390 @kindex @key{ESC}
Dave Love <fx@gnu.org>
parents:
diff changeset
391 @kindex @kbd{i}
Dave Love <fx@gnu.org>
parents:
diff changeset
392 @cindex Emacs state
Dave Love <fx@gnu.org>
parents:
diff changeset
393 @cindex Vi state
Dave Love <fx@gnu.org>
parents:
diff changeset
394 @cindex Insert state
Dave Love <fx@gnu.org>
parents:
diff changeset
395 @cindex Replace state
Dave Love <fx@gnu.org>
parents:
diff changeset
396 @cindex Ex commands
Dave Love <fx@gnu.org>
parents:
diff changeset
397 @findex @code{viper-go-away}
Dave Love <fx@gnu.org>
parents:
diff changeset
398 @findex @code{toggle-viper-mode}
Dave Love <fx@gnu.org>
parents:
diff changeset
399
Dave Love <fx@gnu.org>
parents:
diff changeset
400 Viper has four states, Emacs, Vi, Insert, and Replace.
Dave Love <fx@gnu.org>
parents:
diff changeset
401
Dave Love <fx@gnu.org>
parents:
diff changeset
402 @table @samp
Dave Love <fx@gnu.org>
parents:
diff changeset
403 @item Emacs state
Dave Love <fx@gnu.org>
parents:
diff changeset
404 This is the state plain vanilla Emacs is normally in. After you have loaded
Dave Love <fx@gnu.org>
parents:
diff changeset
405 Viper, @kbd{C-z} will normally take you to Vi command state. Another
Dave Love <fx@gnu.org>
parents:
diff changeset
406 @kbd{C-z} will take you back to Emacs state. This toggle key can be
Dave Love <fx@gnu.org>
parents:
diff changeset
407 changed, @pxref{Customization} You can also type @kbd{M-x viper-mode} to
Dave Love <fx@gnu.org>
parents:
diff changeset
408 change to Vi state.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
409
Dave Love <fx@gnu.org>
parents:
diff changeset
410
Dave Love <fx@gnu.org>
parents:
diff changeset
411 For users who chose to set their user level to 1 at Viper setup time,
Dave Love <fx@gnu.org>
parents:
diff changeset
412 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
413 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
414 (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
415 Emacs runs on a dumb terminal or in an Xterm window).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
416
Dave Love <fx@gnu.org>
parents:
diff changeset
417 @item Vi state
Dave Love <fx@gnu.org>
parents:
diff changeset
418 This is the Vi command mode. Any of the Vi commands, such as @kbd{i, o, a},
Dave Love <fx@gnu.org>
parents:
diff changeset
419 @dots{}, will take you to Insert state. All Vi commands may
Dave Love <fx@gnu.org>
parents:
diff changeset
420 be used in this mode. Most Ex commands can also be used.
Dave Love <fx@gnu.org>
parents:
diff changeset
421 For a full list of Ex commands supported by Viper, type
Dave Love <fx@gnu.org>
parents:
diff changeset
422 @kbd{:} and then @key{TAB}. To get help on any issue, including the Ex
Dave Love <fx@gnu.org>
parents:
diff changeset
423 commands, type @kbd{:help}. This will invoke Viper Info
Dave Love <fx@gnu.org>
parents:
diff changeset
424 (if it is installed). Then typing @kbd{i} will prompt you for a topic to
Dave Love <fx@gnu.org>
parents:
diff changeset
425 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
426 should start them with a @kbd{:}, e.g., @kbd{:WW}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
427
Dave Love <fx@gnu.org>
parents:
diff changeset
428 In Viper, Ex commands can be made to work on the current Emacs region.
Dave Love <fx@gnu.org>
parents:
diff changeset
429 This is done by typing a digit argument before @kbd{:}.
Dave Love <fx@gnu.org>
parents:
diff changeset
430 For instance, typing @kbd{1:} will propmt you with something like
Dave Love <fx@gnu.org>
parents:
diff changeset
431 @emph{:123,135}, assuming that the current region starts at line 123 and
Dave Love <fx@gnu.org>
parents:
diff changeset
432 ends at line 135. There is no need to type the line numbers, since Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
433 inserts them automatically in front of the Ex command.
Dave Love <fx@gnu.org>
parents:
diff changeset
434
Dave Love <fx@gnu.org>
parents:
diff changeset
435 @item Insert state
Dave Love <fx@gnu.org>
parents:
diff changeset
436 Insert state is the Vi insertion mode. @key{ESC} will take you back to
Dave Love <fx@gnu.org>
parents:
diff changeset
437 Vi state. Insert state editing can be done, including auto-indentation. By
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38866
diff changeset
438 default, Viper disables Emacs key bindings in Insert state.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
439
Dave Love <fx@gnu.org>
parents:
diff changeset
440 @item Replace state
Dave Love <fx@gnu.org>
parents:
diff changeset
441 Commands like @kbd{cw} invoke the Replace state. When you cross the
Dave Love <fx@gnu.org>
parents:
diff changeset
442 boundary of a replacement region (usually designated via a @samp{$} sign),
Dave Love <fx@gnu.org>
parents:
diff changeset
443 it will automatically change to Insert state. You do not have to worry
Dave Love <fx@gnu.org>
parents:
diff changeset
444 about it. The key bindings remain practically the same as in Insert
Dave Love <fx@gnu.org>
parents:
diff changeset
445 state. If you type @key{ESC}, Viper will switch to Vi command mode, terminating the
Dave Love <fx@gnu.org>
parents:
diff changeset
446 replacement state.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
447 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
448
Dave Love <fx@gnu.org>
parents:
diff changeset
449 @cindex mode line
Dave Love <fx@gnu.org>
parents:
diff changeset
450
Dave Love <fx@gnu.org>
parents:
diff changeset
451 The modes are indicated on the @dfn{mode line} as <E>, <I>, <V>, and <R>,
Dave Love <fx@gnu.org>
parents:
diff changeset
452 so that the multiple modes do not confuse you. Most of your editing can be
Dave Love <fx@gnu.org>
parents:
diff changeset
453 done in Vi and Insert states. Viper will try to make all new buffers be in Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
454 state, but sometimes they may come up in Emacs state. @kbd{C-z}
Dave Love <fx@gnu.org>
parents:
diff changeset
455 will take you to Vi state in such a case. In some major modes, like Dired,
Dave Love <fx@gnu.org>
parents:
diff changeset
456 Info, Gnus, etc., you should not switch to Vi state (and Viper will not
Dave Love <fx@gnu.org>
parents:
diff changeset
457 attempt to do so) because these modes are not intended for text editing and
Dave Love <fx@gnu.org>
parents:
diff changeset
458 many of the Vi keys have special meaning there. If you plan to read news,
Dave Love <fx@gnu.org>
parents:
diff changeset
459 browse directories, read mail, etc., from Emacs (which you should start
Dave Love <fx@gnu.org>
parents:
diff changeset
460 doing soon!), you should learn about the meaning of the various keys in
Dave Love <fx@gnu.org>
parents:
diff changeset
461 those special modes (typing @kbd{C-h m} in a buffer provides
Dave Love <fx@gnu.org>
parents:
diff changeset
462 help with key bindings for the major mode of that buffer).
Dave Love <fx@gnu.org>
parents:
diff changeset
463
Dave Love <fx@gnu.org>
parents:
diff changeset
464 If you switch to Vi in Dired or similar modes---no harm is done. It is just
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38866
diff changeset
465 that the special key bindings provided by those modes will be temporarily
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
466 overshadowed by Viper's bindings. Switching back to Viper's Emacs state
Dave Love <fx@gnu.org>
parents:
diff changeset
467 will revive the environment provided by the current major mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
468
Dave Love <fx@gnu.org>
parents:
diff changeset
469 States in Viper are orthogonal to Emacs major modes, such as C mode or Dired
Dave Love <fx@gnu.org>
parents:
diff changeset
470 mode. You can turn Viper on and off for any Emacs state. When Viper is turned
Dave Love <fx@gnu.org>
parents:
diff changeset
471 on, Vi state can be used to move around. In Insert state, the bindings for
Dave Love <fx@gnu.org>
parents:
diff changeset
472 these modes can be accessed. For beginners (users at Viper levels 1 and 2),
Dave Love <fx@gnu.org>
parents:
diff changeset
473 these bindings are suppressed in Insert state, so that new users are not
Dave Love <fx@gnu.org>
parents:
diff changeset
474 confused by the Emacs states. Note that unless you allow Emacs bindings in
Dave Love <fx@gnu.org>
parents:
diff changeset
475 Insert state, you cannot do many interesting things, like language
Dave Love <fx@gnu.org>
parents:
diff changeset
476 sensitive editing. For the novice user (at Viper level 1), all major mode
Dave Love <fx@gnu.org>
parents:
diff changeset
477 bindings are turned off in Vi state as well. This includes the bindings for
Dave Love <fx@gnu.org>
parents:
diff changeset
478 key sequences that start with @kbd{C-c}, which practically means that all
Dave Love <fx@gnu.org>
parents:
diff changeset
479 major mode bindings are supported. @xref{Customization}, to find out how
Dave Love <fx@gnu.org>
parents:
diff changeset
480 to allow Emacs keys in Insert state.
Dave Love <fx@gnu.org>
parents:
diff changeset
481
Dave Love <fx@gnu.org>
parents:
diff changeset
482 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
483 * Emacs State:: This is the state you should learn more about when
Dave Love <fx@gnu.org>
parents:
diff changeset
484 you get up to speed with Viper.
Dave Love <fx@gnu.org>
parents:
diff changeset
485 * Vi State:: Vi commands are executed in this state.
Dave Love <fx@gnu.org>
parents:
diff changeset
486 * Insert State:: You can enter text, and also can do sophisticated
Dave Love <fx@gnu.org>
parents:
diff changeset
487 editing if you know enough Emacs commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
488 * Replace State:: Like Insert mode, but it is invoked via the
Dave Love <fx@gnu.org>
parents:
diff changeset
489 replacement commands, such as cw, C, R, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
490 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
491
Dave Love <fx@gnu.org>
parents:
diff changeset
492 @node Emacs State, Vi State, States in Viper, States in Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
493 @subsection Emacs State
Dave Love <fx@gnu.org>
parents:
diff changeset
494
Dave Love <fx@gnu.org>
parents:
diff changeset
495 @kindex @kbd{C-z}
Dave Love <fx@gnu.org>
parents:
diff changeset
496 @cindex Emacs state
Dave Love <fx@gnu.org>
parents:
diff changeset
497
Dave Love <fx@gnu.org>
parents:
diff changeset
498
Dave Love <fx@gnu.org>
parents:
diff changeset
499 You will be in this mode only by accident (hopefully). This is the state
Dave Love <fx@gnu.org>
parents:
diff changeset
500 Emacs is normally in (imagine!!). Now leave it as soon as possible by
Dave Love <fx@gnu.org>
parents:
diff changeset
501 typing @kbd{C-z}. Then you will be in Vi state (sigh of relief) :-).
Dave Love <fx@gnu.org>
parents:
diff changeset
502
Dave Love <fx@gnu.org>
parents:
diff changeset
503 Emacs state is actually a Viperism to denote all the major and minor modes
Dave Love <fx@gnu.org>
parents:
diff changeset
504 (@pxref{Emacs Preliminaries}) other than Viper that Emacs can be in. Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
505 can have several modes, such as C mode for editing C programs, LaTeX mode
Dave Love <fx@gnu.org>
parents:
diff changeset
506 for editing LaTeX documents, Dired for directory editing, etc. These are
Dave Love <fx@gnu.org>
parents:
diff changeset
507 major modes, each with a different set of key-bindings. Viper states are
Dave Love <fx@gnu.org>
parents:
diff changeset
508 orthogonal to these Emacs major modes. The presence of these language
Dave Love <fx@gnu.org>
parents:
diff changeset
509 sensitive and other modes is a major win over Vi. @xref{Improvements over
Dave Love <fx@gnu.org>
parents:
diff changeset
510 Vi}, for more.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
511
Dave Love <fx@gnu.org>
parents:
diff changeset
512 The bindings for these modes can be made available in the Viper Insert state
Dave Love <fx@gnu.org>
parents:
diff changeset
513 as well as in Emacs state. Unless you specify your user level as 1 (a
Dave Love <fx@gnu.org>
parents:
diff changeset
514 novice), all major mode key sequences that start with @kbd{C-x} and
Dave Love <fx@gnu.org>
parents:
diff changeset
515 @kbd{C-c} are also available in Vi state. This is important because major
Dave Love <fx@gnu.org>
parents:
diff changeset
516 modes designed for editing files, such as cc-mode or latex-mode, use key
Dave Love <fx@gnu.org>
parents:
diff changeset
517 sequences that begin with @kbd{C-x} and @kbd{C-c}.
Dave Love <fx@gnu.org>
parents:
diff changeset
518
Dave Love <fx@gnu.org>
parents:
diff changeset
519 There is also a key that lets you temporarily escape to Vi command state
Dave Love <fx@gnu.org>
parents:
diff changeset
520 from Emacs or Insert states: typing @kbd{C-c \} will let you execute a
Dave Love <fx@gnu.org>
parents:
diff changeset
521 single Vi command while staying in Viper's Emacs or Insert state.
Dave Love <fx@gnu.org>
parents:
diff changeset
522 In Insert state, the same can also be achieved by typing @kbd{C-z}.
Dave Love <fx@gnu.org>
parents:
diff changeset
523
Dave Love <fx@gnu.org>
parents:
diff changeset
524
Dave Love <fx@gnu.org>
parents:
diff changeset
525 @node Vi State, Insert State, Emacs State, States in Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
526 @subsection Vi State
Dave Love <fx@gnu.org>
parents:
diff changeset
527
Dave Love <fx@gnu.org>
parents:
diff changeset
528 @cindex Vi state
Dave Love <fx@gnu.org>
parents:
diff changeset
529
Dave Love <fx@gnu.org>
parents:
diff changeset
530 This is the Vi command mode. When Viper is in Vi state, you will see the sign
Dave Love <fx@gnu.org>
parents:
diff changeset
531 <V> in the mode line. Most keys will work as in Vi. The notable
Dave Love <fx@gnu.org>
parents:
diff changeset
532 exceptions are:
Dave Love <fx@gnu.org>
parents:
diff changeset
533
Dave Love <fx@gnu.org>
parents:
diff changeset
534 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
535 @item C-x
Dave Love <fx@gnu.org>
parents:
diff changeset
536 @kindex @kbd{C-x}
Dave Love <fx@gnu.org>
parents:
diff changeset
537 @kbd{C-x} is used to invoke Emacs commands, mainly those that do window
Dave Love <fx@gnu.org>
parents:
diff changeset
538 management. @kbd{C-x 2} will split a window, @kbd{C-x 0} will close a
Dave Love <fx@gnu.org>
parents:
diff changeset
539 window. @kbd{C-x 1} will close all other windows. @kbd{C-xb} is used to
Dave Love <fx@gnu.org>
parents:
diff changeset
540 switch buffers in a window, and @kbd{C-xo} to move through windows.
Dave Love <fx@gnu.org>
parents:
diff changeset
541 These are about the only necessary keystrokes.
Dave Love <fx@gnu.org>
parents:
diff changeset
542 For the rest, see the GNU Emacs Manual.
Dave Love <fx@gnu.org>
parents:
diff changeset
543
Dave Love <fx@gnu.org>
parents:
diff changeset
544 @item C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
545 @kindex @kbd{C-c}
Dave Love <fx@gnu.org>
parents:
diff changeset
546 For user levels 2 and higher, this key serves as a prefix key for the key
Dave Love <fx@gnu.org>
parents:
diff changeset
547 sequences used by various major modes. For users at Viper level 1, @kbd{C-c}
Dave Love <fx@gnu.org>
parents:
diff changeset
548 simply beeps.
Dave Love <fx@gnu.org>
parents:
diff changeset
549
Dave Love <fx@gnu.org>
parents:
diff changeset
550 @item C-g and C-]
Dave Love <fx@gnu.org>
parents:
diff changeset
551 @kindex @kbd{C-g}
Dave Love <fx@gnu.org>
parents:
diff changeset
552 @kindex @kbd{C-]}
Dave Love <fx@gnu.org>
parents:
diff changeset
553
Dave Love <fx@gnu.org>
parents:
diff changeset
554 These are the Emacs @samp{quit} keys.
Dave Love <fx@gnu.org>
parents:
diff changeset
555 There will be cases where you will have to
Dave Love <fx@gnu.org>
parents:
diff changeset
556 use @kbd{C-g} to quit. Similarly, @kbd{C-]} is used to exit
Dave Love <fx@gnu.org>
parents:
diff changeset
557 @samp{Recursive Edits} in Emacs for which there is no comparable Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
558 functionality and no key-binding. Recursive edits are indicated by
Dave Love <fx@gnu.org>
parents:
diff changeset
559 @samp{[]} brackets framing the modes on the mode line.
Dave Love <fx@gnu.org>
parents:
diff changeset
560 @xref{Recursive Edit,Recursive
Dave Love <fx@gnu.org>
parents:
diff changeset
561 Edit,Recursive Edit,emacs,The GNU Emacs Manual}.
Dave Love <fx@gnu.org>
parents:
diff changeset
562 At user level 1, @kbd{C-g} is bound to @code{viper-info-on-file}
Dave Love <fx@gnu.org>
parents:
diff changeset
563 function instead.
Dave Love <fx@gnu.org>
parents:
diff changeset
564 @refill
Dave Love <fx@gnu.org>
parents:
diff changeset
565 @item C-\
Dave Love <fx@gnu.org>
parents:
diff changeset
566 @kindex @kbd{C-\}
Dave Love <fx@gnu.org>
parents:
diff changeset
567 @cindex Meta key
Dave Love <fx@gnu.org>
parents:
diff changeset
568
Dave Love <fx@gnu.org>
parents:
diff changeset
569 Viper uses @key{ESC} as a switch between Insert and Vi states. Emacs uses
Dave Love <fx@gnu.org>
parents:
diff changeset
570 @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
571 functions are accessible only via that key as @kbd{M-x function-name}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
572 Therefore, we need to simulate it somehow. In Viper's Vi, Insert, and
Dave Love <fx@gnu.org>
parents:
diff changeset
573 Replace states, the meta key is set to be @kbd{C-\}. Thus, to get
Dave Love <fx@gnu.org>
parents:
diff changeset
574 @kbd{M-x}, you should type @kbd{C-\ x} (if the keyboard has no Meta key).
Dave Love <fx@gnu.org>
parents:
diff changeset
575 This works both in the Vi command state and in the Insert and Replace
Dave Love <fx@gnu.org>
parents:
diff changeset
576 states. In Vi command state, you can also use @kbd{\ @key{ESC}} as the
Dave Love <fx@gnu.org>
parents:
diff changeset
577 meta key.
Dave Love <fx@gnu.org>
parents:
diff changeset
578
Dave Love <fx@gnu.org>
parents:
diff changeset
579 Note: Emacs binds @kbd{C-\} to a function that offers to change the
Dave Love <fx@gnu.org>
parents:
diff changeset
580 keyboard input method in the multilingual environment. Viper overrides this
Dave Love <fx@gnu.org>
parents:
diff changeset
581 binding. However, it is still possible to switch the input method by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
582 @kbd{\ C-\} in the Vi command state and @kbd{C-z \ C-\} in the Insert state.
Dave Love <fx@gnu.org>
parents:
diff changeset
583 Or you can use the MULE menu in the menubar.
Dave Love <fx@gnu.org>
parents:
diff changeset
584 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
585 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
586 Other differences are mostly improvements. The ones you should know
Dave Love <fx@gnu.org>
parents:
diff changeset
587 about are:
Dave Love <fx@gnu.org>
parents:
diff changeset
588
Dave Love <fx@gnu.org>
parents:
diff changeset
589 @table @samp
Dave Love <fx@gnu.org>
parents:
diff changeset
590 @item Undo
Dave Love <fx@gnu.org>
parents:
diff changeset
591 @kindex @kbd{u}
Dave Love <fx@gnu.org>
parents:
diff changeset
592 @kbd{u} will undo. Undo can be repeated by the @kbd{.} key. Undo itself
Dave Love <fx@gnu.org>
parents:
diff changeset
593 can be undone. Another @kbd{u} will change the direction. The presence
Dave Love <fx@gnu.org>
parents:
diff changeset
594 of repeatable undo means that @kbd{U}, undoing lines, is not very
Dave Love <fx@gnu.org>
parents:
diff changeset
595 important. Therefore, @kbd{U} also calls @code{viper-undo}.
Dave Love <fx@gnu.org>
parents:
diff changeset
596 @cindex multiple undo
Dave Love <fx@gnu.org>
parents:
diff changeset
597 @cindex undo
Dave Love <fx@gnu.org>
parents:
diff changeset
598
Dave Love <fx@gnu.org>
parents:
diff changeset
599
Dave Love <fx@gnu.org>
parents:
diff changeset
600 @item Counts
Dave Love <fx@gnu.org>
parents:
diff changeset
601 Most commands, @kbd{~}, @kbd{[[}, @kbd{p}, @kbd{/}, @dots{}, etc., take counts.
Dave Love <fx@gnu.org>
parents:
diff changeset
602
Dave Love <fx@gnu.org>
parents:
diff changeset
603 @comment ]] Just to balance parens
Dave Love <fx@gnu.org>
parents:
diff changeset
604 @item Regexps
Dave Love <fx@gnu.org>
parents:
diff changeset
605 Viper uses Emacs Regular Expressions for searches. These are a superset of
Dave Love <fx@gnu.org>
parents:
diff changeset
606 Vi regular
Dave Love <fx@gnu.org>
parents:
diff changeset
607 expressions, excepting the change-of-case escapes @samp{\u}, @samp{\L},
Dave Love <fx@gnu.org>
parents:
diff changeset
608 @dots{}, etc. @xref{Regular Expressions,,Regular Expressions,emacs,The
Dave Love <fx@gnu.org>
parents:
diff changeset
609 GNU Emacs Manual}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
610 Files specified to @kbd{:e} use @code{csh} regular expressions
Dave Love <fx@gnu.org>
parents:
diff changeset
611 (globbing, wildcards, what have you).
Dave Love <fx@gnu.org>
parents:
diff changeset
612 However, the function @code{viper-toggle-search-style}, bound to @kbd{C-c /},
Dave Love <fx@gnu.org>
parents:
diff changeset
613 lets the user switch from search with regular expressions to plain vanilla
Dave Love <fx@gnu.org>
parents:
diff changeset
614 search and vice versa. It also lets one switch from case-sensitive search
Dave Love <fx@gnu.org>
parents:
diff changeset
615 to case-insensitive and back.
Dave Love <fx@gnu.org>
parents:
diff changeset
616 @xref{Viper Specials}, for more details.
Dave Love <fx@gnu.org>
parents:
diff changeset
617 @cindex regular expressions
Dave Love <fx@gnu.org>
parents:
diff changeset
618 @cindex vanilla search
Dave Love <fx@gnu.org>
parents:
diff changeset
619 @cindex case-sensitive search
Dave Love <fx@gnu.org>
parents:
diff changeset
620 @cindex case-insensitive search
Dave Love <fx@gnu.org>
parents:
diff changeset
621 @kindex @kbd{C-c /}
Dave Love <fx@gnu.org>
parents:
diff changeset
622
Dave Love <fx@gnu.org>
parents:
diff changeset
623 @item Ex commands
Dave Love <fx@gnu.org>
parents:
diff changeset
624 @cindex Ex commands
Dave Love <fx@gnu.org>
parents:
diff changeset
625 The current working directory of a buffer is automatically inserted in the
Dave Love <fx@gnu.org>
parents:
diff changeset
626 minibuffer if you type @kbd{:e} then space. Absolute filenames are
38866
662d4bf4871a Avoid saying "Unix" in a way that includes GNU.
Richard M. Stallman <rms@gnu.org>
parents: 38514
diff changeset
627 required less often in Viper. For file names, Emacs uses a convention that
662d4bf4871a Avoid saying "Unix" in a way that includes GNU.
Richard M. Stallman <rms@gnu.org>
parents: 38514
diff changeset
628 is slightly different from other programs. It is designed to minimize the
662d4bf4871a Avoid saying "Unix" in a way that includes GNU.
Richard M. Stallman <rms@gnu.org>
parents: 38514
diff changeset
629 need for deleting file names that Emacs provides in its prompts. (This is
662d4bf4871a Avoid saying "Unix" in a way that includes GNU.
Richard M. Stallman <rms@gnu.org>
parents: 38514
diff changeset
630 usually convenient, but occasionally the prompt may suggest a wrong file
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
631 name for you.) If you see a prompt @kbd{/usr/foo/} and you wish to edit the
Dave Love <fx@gnu.org>
parents:
diff changeset
632 file @kbd{~/.viper}, you don't have to erase the prompt. Instead, simply
Dave Love <fx@gnu.org>
parents:
diff changeset
633 continue typing what you need. Emacs will interpret @kbd{/usr/foo/~/.viper}
Dave Love <fx@gnu.org>
parents:
diff changeset
634 correctly. Similarly, if the prompt is @kbd{~/foo/} and you need to get to
Dave Love <fx@gnu.org>
parents:
diff changeset
635 @kbd{/bar/file}, keep typing. Emacs interprets @kbd{~/foo//bar/} as
Dave Love <fx@gnu.org>
parents:
diff changeset
636 @kbd{/bar/file}, since when it sees @samp{//}, it understands that
Dave Love <fx@gnu.org>
parents:
diff changeset
637 @kbd{~/foo/} is to be discarded.
Dave Love <fx@gnu.org>
parents:
diff changeset
638
Dave Love <fx@gnu.org>
parents:
diff changeset
639 The command @kbd{:cd} will change the default directory for the
Dave Love <fx@gnu.org>
parents:
diff changeset
640 current buffer. The command @kbd{:e} will interpret the
Dave Love <fx@gnu.org>
parents:
diff changeset
641 filename argument in @code{csh}. @xref{Customization}, if you
Dave Love <fx@gnu.org>
parents:
diff changeset
642 want to change the default shell.
Dave Love <fx@gnu.org>
parents:
diff changeset
643 The command @kbd{:next} takes counts from
Dave Love <fx@gnu.org>
parents:
diff changeset
644 @kbd{:args}, so that @kbd{:rew} is obsolete. Also, @kbd{:args} will show only
Dave Love <fx@gnu.org>
parents:
diff changeset
645 the invisible files (i.e., those that are not currently seen in Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
646 windows).
Dave Love <fx@gnu.org>
parents:
diff changeset
647
Dave Love <fx@gnu.org>
parents:
diff changeset
648 When applicable, Ex commands support file completion and history. This
Dave Love <fx@gnu.org>
parents:
diff changeset
649 means that by typing a partial file name and then @key{TAB}, Emacs will try
Dave Love <fx@gnu.org>
parents:
diff changeset
650 to complete the name or it will offer a menu of possible completions.
Dave Love <fx@gnu.org>
parents:
diff changeset
651 This works similarly to Tcsh and extends the behavior of Csh. While Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
652 is waiting for a file name, you can type @kbd{M-p} to get the previous file
Dave Love <fx@gnu.org>
parents:
diff changeset
653 name you typed. Repeatedly typing @kbd{M-p} and @kbd{M-n} will let you
Dave Love <fx@gnu.org>
parents:
diff changeset
654 browse through the file history.
Dave Love <fx@gnu.org>
parents:
diff changeset
655
Dave Love <fx@gnu.org>
parents:
diff changeset
656 Like file names, partially typed Ex commands can be completed by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
657 @key{TAB}, and Viper keeps the history of Ex commands. After typing
Dave Love <fx@gnu.org>
parents:
diff changeset
658 @kbd{:}, you can browse through the previously entered Ex commands by
Dave Love <fx@gnu.org>
parents:
diff changeset
659 typing @kbd{M-p} and @kbd{M-n}. Viper tries to rationalize when it puts Ex
Dave Love <fx@gnu.org>
parents:
diff changeset
660 commands on the history list. For instance, if you typed @kbd{:w!@: foo},
Dave Love <fx@gnu.org>
parents:
diff changeset
661 only @kbd{:w!} will be placed on the history list. This is because the
Dave Love <fx@gnu.org>
parents:
diff changeset
662 last history element is the default that can be invoked simply by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
663 @kbd{: @key{RET}}. If @kbd{:w!@: foo} were placed on the list, it would be all to
Dave Love <fx@gnu.org>
parents:
diff changeset
664 easy to override valuable data in another file. Reconstructing the full
Dave Love <fx@gnu.org>
parents:
diff changeset
665 command, @kbd{:w!@: foo}, from the history is still not that hard, since Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
666 has a separate history for file names. By typing @kbd{: M-p}, you will get
Dave Love <fx@gnu.org>
parents:
diff changeset
667 @kbd{:w!} in the Minibuffer. Then, repeated @kbd{M-p} will get you through
Dave Love <fx@gnu.org>
parents:
diff changeset
668 the file history, inserting one file name after another.
Dave Love <fx@gnu.org>
parents:
diff changeset
669
Dave Love <fx@gnu.org>
parents:
diff changeset
670 In contrast to @kbd{:w!@: foo}, if the command were @kbd{:r foo}, the entire
Dave Love <fx@gnu.org>
parents:
diff changeset
671 command will appear in the history list. This is because having @kbd{:r}
Dave Love <fx@gnu.org>
parents:
diff changeset
672 alone as a default is meaningless, since this command requires a file
Dave Love <fx@gnu.org>
parents:
diff changeset
673 argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
674 @refill
Dave Love <fx@gnu.org>
parents:
diff changeset
675 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
676 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
677 As Vi, Viper's destructive commands can be re-executed by typing `@kbd{.}'.
Dave Love <fx@gnu.org>
parents:
diff changeset
678 However, in addition, Viper keeps track of the history of such commands. This
Dave Love <fx@gnu.org>
parents:
diff changeset
679 history can be perused by typing @kbd{C-c M-p} and @kbd{C-c M-n}.
Dave Love <fx@gnu.org>
parents:
diff changeset
680 Having found the appropriate command, it can be then executed by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
681 `@kbd{.}'.
Dave Love <fx@gnu.org>
parents:
diff changeset
682 @xref{Improvements over Vi}, for more information.
Dave Love <fx@gnu.org>
parents:
diff changeset
683
Dave Love <fx@gnu.org>
parents:
diff changeset
684 @node Insert State, Replace State, Vi State, States in Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
685 @subsection Insert State
Dave Love <fx@gnu.org>
parents:
diff changeset
686
Dave Love <fx@gnu.org>
parents:
diff changeset
687 @cindex Insert state
Dave Love <fx@gnu.org>
parents:
diff changeset
688
Dave Love <fx@gnu.org>
parents:
diff changeset
689 To avoid confusing the beginner (at Viper level 1 and 2), Viper makes only the
Dave Love <fx@gnu.org>
parents:
diff changeset
690 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
691 Emacs major modes cannot be used in Insert state.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
692 It is strongly recommended that as soon as you are comfortable, make the
Dave Love <fx@gnu.org>
parents:
diff changeset
693 Emacs state bindings visible (by changing your user level to 3 or higher).
Dave Love <fx@gnu.org>
parents:
diff changeset
694 @xref{Customization},
Dave Love <fx@gnu.org>
parents:
diff changeset
695 to see how to do this.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
696
Dave Love <fx@gnu.org>
parents:
diff changeset
697 Once this is done, it is possible to do quite a bit of editing in
Dave Love <fx@gnu.org>
parents:
diff changeset
698 Insert state. For instance, Emacs has a @dfn{yank} command, @kbd{C-y},
Dave Love <fx@gnu.org>
parents:
diff changeset
699 which is similar to Vi's @kbd{p}. However, unlike @kbd{p}, @kbd{C-y} can be
Dave Love <fx@gnu.org>
parents:
diff changeset
700 used in Insert state of Viper. Emacs also has a kill ring where it keeps
Dave Love <fx@gnu.org>
parents:
diff changeset
701 pieces of text you deleted while editing buffers. The command @kbd{M-y} is
Dave Love <fx@gnu.org>
parents:
diff changeset
702 used to delete the text previously put back by Emacs' @kbd{C-y} or by Vi's
Dave Love <fx@gnu.org>
parents:
diff changeset
703 @kbd{p} command and reinsert text that was placed on the kill-ring earlier.
Dave Love <fx@gnu.org>
parents:
diff changeset
704
Dave Love <fx@gnu.org>
parents:
diff changeset
705 This works both in Vi and Insert states.
Dave Love <fx@gnu.org>
parents:
diff changeset
706 In Vi state, @kbd{M-y} is a much better alternative to the usual Vi's way
Dave Love <fx@gnu.org>
parents:
diff changeset
707 of recovering the 10 previously deleted chunks of text. In Insert state,
Dave Love <fx@gnu.org>
parents:
diff changeset
708 you can
Dave Love <fx@gnu.org>
parents:
diff changeset
709 use this as follows. Suppose you deleted a piece of text and now you need
Dave Love <fx@gnu.org>
parents:
diff changeset
710 to re-insert it while editing in Insert mode. The key @kbd{C-y} will put
Dave Love <fx@gnu.org>
parents:
diff changeset
711 back the most recently deleted chunk. If this is not what you want, type
Dave Love <fx@gnu.org>
parents:
diff changeset
712 @kbd{M-y} repeatedly and, hopefully, you will find the chunk you want.
Dave Love <fx@gnu.org>
parents:
diff changeset
713
Dave Love <fx@gnu.org>
parents:
diff changeset
714 Finally, in Insert and Replace states, Viper provides the history of
Dave Love <fx@gnu.org>
parents:
diff changeset
715 pieces of text inserted in previous insert or replace commands. These
Dave Love <fx@gnu.org>
parents:
diff changeset
716 strings of text can be recovered by repeatedly typing @kbd{C-c M-p} or
Dave Love <fx@gnu.org>
parents:
diff changeset
717 @kbd{C-c M-n} while in Insert or Replace state. (This feature is disabled
Dave Love <fx@gnu.org>
parents:
diff changeset
718 in the minibuffer: the above keys are usually bound to other histories,
Dave Love <fx@gnu.org>
parents:
diff changeset
719 which are more appropriate in the minibuffer.)
Dave Love <fx@gnu.org>
parents:
diff changeset
720
Dave Love <fx@gnu.org>
parents:
diff changeset
721
Dave Love <fx@gnu.org>
parents:
diff changeset
722 @cindex Meta key
Dave Love <fx@gnu.org>
parents:
diff changeset
723
Dave Love <fx@gnu.org>
parents:
diff changeset
724 You can call Meta functions from Insert state. As in Vi state, the Meta key
Dave Love <fx@gnu.org>
parents:
diff changeset
725 is @kbd{C-\}. Thus @kbd{M-x} is typed as @kbd{C-\ x}.
Dave Love <fx@gnu.org>
parents:
diff changeset
726
Dave Love <fx@gnu.org>
parents:
diff changeset
727 Other Emacs commands that are useful in Insert state are @kbd{C-e}
Dave Love <fx@gnu.org>
parents:
diff changeset
728 and @kbd{C-a}, which move the cursor to the end and the beginning of the
Dave Love <fx@gnu.org>
parents:
diff changeset
729 current line, respectively. You can also use @kbd{M-f} and @kbd{M-b},
Dave Love <fx@gnu.org>
parents:
diff changeset
730 which move the cursor forward (or backward) one word.
Dave Love <fx@gnu.org>
parents:
diff changeset
731 If your display has a Meta key, these functions are invoked by holding the
Dave Love <fx@gnu.org>
parents:
diff changeset
732 Meta key and then typing @kbd{f} and @kbd{b}, respectively. On displays
Dave Love <fx@gnu.org>
parents:
diff changeset
733 without the Meta key, these functions are invoked by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
734 @kbd{C-\ f} and @kbd{C-\ b} (@kbd{C-\} simulates the Meta key in Insert
Dave Love <fx@gnu.org>
parents:
diff changeset
735 state, as explained above).
Dave Love <fx@gnu.org>
parents:
diff changeset
736
Dave Love <fx@gnu.org>
parents:
diff changeset
737 The key @kbd{C-z} is sometimes also useful in Insert state: it allows you
Dave Love <fx@gnu.org>
parents:
diff changeset
738 to execute a single command in Vi state without leaving the Insert state!
Dave Love <fx@gnu.org>
parents:
diff changeset
739 For instance, @kbd{C-z d2w} will delete the next two words without leaving
Dave Love <fx@gnu.org>
parents:
diff changeset
740 the Insert state.
Dave Love <fx@gnu.org>
parents:
diff changeset
741
Dave Love <fx@gnu.org>
parents:
diff changeset
742 When Viper is in Insert state, you will see <I> in the mode line.
Dave Love <fx@gnu.org>
parents:
diff changeset
743
Dave Love <fx@gnu.org>
parents:
diff changeset
744 @node Replace State,, Insert State, States in Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
745 @subsection Replace State
Dave Love <fx@gnu.org>
parents:
diff changeset
746
Dave Love <fx@gnu.org>
parents:
diff changeset
747 @cindex Replace state
Dave Love <fx@gnu.org>
parents:
diff changeset
748
Dave Love <fx@gnu.org>
parents:
diff changeset
749 This state is entered through Vi replacement commands, such as @kbd{C},
Dave Love <fx@gnu.org>
parents:
diff changeset
750 @kbd{cw}, etc., or by typing @kbd{R}. In Replace state, Viper puts <R> in
Dave Love <fx@gnu.org>
parents:
diff changeset
751 the mode line to let you know which state is in effect. If Replace state is
Dave Love <fx@gnu.org>
parents:
diff changeset
752 entered through @kbd{R}, Viper stays in that state until the user hits
Dave Love <fx@gnu.org>
parents:
diff changeset
753 @key{ESC}. If this state is entered via the other replacement commands,
Dave Love <fx@gnu.org>
parents:
diff changeset
754 then Replace state is in effect until you hit @key{ESC} or until you cross
Dave Love <fx@gnu.org>
parents:
diff changeset
755 the rightmost boundary of the replacement region. In the latter case, Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
756 changes its state from Replace to Insert (which you will notice by the
Dave Love <fx@gnu.org>
parents:
diff changeset
757 change in the mode line).
Dave Love <fx@gnu.org>
parents:
diff changeset
758
Dave Love <fx@gnu.org>
parents:
diff changeset
759 Since Viper runs under Emacs, it is possible to switch between buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
760 while in Replace state. You can also move the cursor using the arrow keys
Dave Love <fx@gnu.org>
parents:
diff changeset
761 (even on dumb terminals!)@: and the mouse. Because of this freedom (which is
Dave Love <fx@gnu.org>
parents:
diff changeset
762 unattainable in regular Vi), it is possible to take the cursor outside the
Dave Love <fx@gnu.org>
parents:
diff changeset
763 replacement region. (This may be necessary for several reasons, including
Dave Love <fx@gnu.org>
parents:
diff changeset
764 the need to enable text selection and region-setting with the mouse.)
Dave Love <fx@gnu.org>
parents:
diff changeset
765
Dave Love <fx@gnu.org>
parents:
diff changeset
766 The issue then arises as to what to do when the user
Dave Love <fx@gnu.org>
parents:
diff changeset
767 hits the @key{ESC} key. In Vi, this would cause the text between cursor and
Dave Love <fx@gnu.org>
parents:
diff changeset
768 the end of the replacement region to be deleted. But what if, as is
Dave Love <fx@gnu.org>
parents:
diff changeset
769 possible in Viper, the cursor is not inside the replacement region?
Dave Love <fx@gnu.org>
parents:
diff changeset
770
Dave Love <fx@gnu.org>
parents:
diff changeset
771 To solve the problem, Viper keeps track of the last cursor position while it
Dave Love <fx@gnu.org>
parents:
diff changeset
772 was still inside the replacement region. So, in the above situation, Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
773 would delete text between this position and the end of the replacement
Dave Love <fx@gnu.org>
parents:
diff changeset
774 region.
Dave Love <fx@gnu.org>
parents:
diff changeset
775
Dave Love <fx@gnu.org>
parents:
diff changeset
776 @node The Minibuffer,Multiple Files in Viper, States in Viper, Overview
Dave Love <fx@gnu.org>
parents:
diff changeset
777 @section The Minibuffer
Dave Love <fx@gnu.org>
parents:
diff changeset
778
Dave Love <fx@gnu.org>
parents:
diff changeset
779 @cindex Minibuffer
Dave Love <fx@gnu.org>
parents:
diff changeset
780
Dave Love <fx@gnu.org>
parents:
diff changeset
781 The Minibuffer is where commands are entered in. Editing can be done
Dave Love <fx@gnu.org>
parents:
diff changeset
782 by commands from Insert state, namely:
Dave Love <fx@gnu.org>
parents:
diff changeset
783
Dave Love <fx@gnu.org>
parents:
diff changeset
784 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
785 @item C-h
Dave Love <fx@gnu.org>
parents:
diff changeset
786 Backspace
Dave Love <fx@gnu.org>
parents:
diff changeset
787 @item C-w
Dave Love <fx@gnu.org>
parents:
diff changeset
788 Delete Word
Dave Love <fx@gnu.org>
parents:
diff changeset
789 @item C-u
Dave Love <fx@gnu.org>
parents:
diff changeset
790 Erase line
Dave Love <fx@gnu.org>
parents:
diff changeset
791 @item C-v
Dave Love <fx@gnu.org>
parents:
diff changeset
792 Quote the following character
Dave Love <fx@gnu.org>
parents:
diff changeset
793 @item @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
794 Execute command
Dave Love <fx@gnu.org>
parents:
diff changeset
795 @item C-g and C-]
Dave Love <fx@gnu.org>
parents:
diff changeset
796 Emacs quit and abort keys. These may be necessary. @xref{Vi State}, for an
Dave Love <fx@gnu.org>
parents:
diff changeset
797 explanation.
Dave Love <fx@gnu.org>
parents:
diff changeset
798 @item M-p and M-n
Dave Love <fx@gnu.org>
parents:
diff changeset
799 These keys are bound to functions that peruse minibuffer history. The
Dave Love <fx@gnu.org>
parents:
diff changeset
800 precise history to be perused depends on the context. It may be the history
Dave Love <fx@gnu.org>
parents:
diff changeset
801 of search strings, Ex commands, file names, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
802 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
803
Dave Love <fx@gnu.org>
parents:
diff changeset
804 Most of the Emacs keys are functional in the Minibuffer. While in the
Dave Love <fx@gnu.org>
parents:
diff changeset
805 Minibuffer, Viper tries to make editing resemble Vi's behavior when the
Dave Love <fx@gnu.org>
parents:
diff changeset
806 latter is waiting for the user to type an Ex command. In particular, you
Dave Love <fx@gnu.org>
parents:
diff changeset
807 can use the regular Vi commands to edit the Minibuffer. You can switch
Dave Love <fx@gnu.org>
parents:
diff changeset
808 between the Vi state and Insert state at will, and even use the replace mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
809 Initially, the Minibuffer comes up in Insert state.
Dave Love <fx@gnu.org>
parents:
diff changeset
810
Dave Love <fx@gnu.org>
parents:
diff changeset
811 Some users prefer plain Emacs bindings in the Minibuffer. To this end, set
Dave Love <fx@gnu.org>
parents:
diff changeset
812 @code{viper-vi-style-in-minibuffer} to @code{nil} in @file{.viper}.
Dave Love <fx@gnu.org>
parents:
diff changeset
813 @xref{Customization}, to learn how to do this.
Dave Love <fx@gnu.org>
parents:
diff changeset
814
Dave Love <fx@gnu.org>
parents:
diff changeset
815 When the Minibuffer changes Viper states, you will notice that the appearance
Dave Love <fx@gnu.org>
parents:
diff changeset
816 of the text there changes as well. This is useful because the Minibuffer
Dave Love <fx@gnu.org>
parents:
diff changeset
817 has no mode line to tell which Vi state it is in.
Dave Love <fx@gnu.org>
parents:
diff changeset
818 The appearance of the text in the Minibuffer can be changed.
Dave Love <fx@gnu.org>
parents:
diff changeset
819 @xref{Viper Specials}, for more details.
Dave Love <fx@gnu.org>
parents:
diff changeset
820
Dave Love <fx@gnu.org>
parents:
diff changeset
821 @node Multiple Files in Viper,Unimplemented Features,The Minibuffer,Overview
Dave Love <fx@gnu.org>
parents:
diff changeset
822 @section Multiple Files in Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
823
Dave Love <fx@gnu.org>
parents:
diff changeset
824 @cindex multiple files
Dave Love <fx@gnu.org>
parents:
diff changeset
825 @cindex managing multiple files
Dave Love <fx@gnu.org>
parents:
diff changeset
826
Dave Love <fx@gnu.org>
parents:
diff changeset
827 Viper can edit multiple files. This means, for example that you never need
Dave Love <fx@gnu.org>
parents:
diff changeset
828 to suffer through @code{No write since last change} errors.
Dave Love <fx@gnu.org>
parents:
diff changeset
829 Some Viper elements are common over all the files.
Dave Love <fx@gnu.org>
parents:
diff changeset
830
Dave Love <fx@gnu.org>
parents:
diff changeset
831 @table @samp
Dave Love <fx@gnu.org>
parents:
diff changeset
832 @item Textmarkers
Dave Love <fx@gnu.org>
parents:
diff changeset
833 @cindex markers
Dave Love <fx@gnu.org>
parents:
diff changeset
834 @cindex textmarkers
Dave Love <fx@gnu.org>
parents:
diff changeset
835 Textmarkers remember @emph{files and positions}.
Dave Love <fx@gnu.org>
parents:
diff changeset
836 If you set marker @samp{a} in
Dave Love <fx@gnu.org>
parents:
diff changeset
837 file @file{foo}, start editing file @file{bar} and type @kbd{'a}, then
Dave Love <fx@gnu.org>
parents:
diff changeset
838 @emph{YOU WILL SWITCH TO FILE @file{foo}}. You can see the contents of a
Dave Love <fx@gnu.org>
parents:
diff changeset
839 textmarker using the Viper command @kbd{[<a-z>} where <a-z> are the
Dave Love <fx@gnu.org>
parents:
diff changeset
840 textmarkers, e.g., @kbd{[a} to view marker @samp{a} .@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
841 @item Repeated Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
842 Command repetitions are common over files. Typing @kbd{!!} will repeat the
Dave Love <fx@gnu.org>
parents:
diff changeset
843 last @kbd{!} command whichever file it was issued from.
Dave Love <fx@gnu.org>
parents:
diff changeset
844 Typing @kbd{.} will repeat the last command from any file, and
Dave Love <fx@gnu.org>
parents:
diff changeset
845 searches will repeat the last search. Ex commands can be repeated by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
846 @kbd{: @key{RET}}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
847 Note: in some rare cases, that @kbd{: @key{RET}} may do something dangerous.
Dave Love <fx@gnu.org>
parents:
diff changeset
848 However, usually its effect can be undone by typing @kbd{u}.
Dave Love <fx@gnu.org>
parents:
diff changeset
849 @item Registers
Dave Love <fx@gnu.org>
parents:
diff changeset
850 @cindex registers
Dave Love <fx@gnu.org>
parents:
diff changeset
851 Registers are common to files. Also, text yanked with @kbd{y} can be
Dave Love <fx@gnu.org>
parents:
diff changeset
852 put back (@kbd{p}) into any file. The Viper command @kbd{]<a-z>}, where <a-z> are
Dave Love <fx@gnu.org>
parents:
diff changeset
853 the registers, can be used to look at the contents of a register, e.g.,
Dave Love <fx@gnu.org>
parents:
diff changeset
854 type @kbd{]a} to view register @samp{a}.
Dave Love <fx@gnu.org>
parents:
diff changeset
855
Dave Love <fx@gnu.org>
parents:
diff changeset
856 There is one difference in text deletion that you should be
Dave Love <fx@gnu.org>
parents:
diff changeset
857 aware of. This difference comes from Emacs and was adopted in Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
858 because we find it very useful. In Vi, if you delete a line, say, and then
Dave Love <fx@gnu.org>
parents:
diff changeset
859 another line, these two deletions are separated and are put back
Dave Love <fx@gnu.org>
parents:
diff changeset
860 separately if you use the @samp{p} command. In Emacs (and Viper), successive
Dave Love <fx@gnu.org>
parents:
diff changeset
861 series of deletions that are @emph{not interrupted} by other commands are
Dave Love <fx@gnu.org>
parents:
diff changeset
862 lumped together, so the deleted text gets accumulated and can be put back
Dave Love <fx@gnu.org>
parents:
diff changeset
863 as one chunk. If you want to break a sequence of deletions so that the
Dave Love <fx@gnu.org>
parents:
diff changeset
864 newly deleted text could be put back separately from the previously deleted
Dave Love <fx@gnu.org>
parents:
diff changeset
865 text, you should perform a non-deleting action, e.g., move the cursor one
Dave Love <fx@gnu.org>
parents:
diff changeset
866 character in any direction.
Dave Love <fx@gnu.org>
parents:
diff changeset
867 @item Absolute Filenames
38866
662d4bf4871a Avoid saying "Unix" in a way that includes GNU.
Richard M. Stallman <rms@gnu.org>
parents: 38514
diff changeset
868 @cindex absolute file names
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
869 The current directory name for a file is automatically prepended to the
Dave Love <fx@gnu.org>
parents:
diff changeset
870 file name in any
Dave Love <fx@gnu.org>
parents:
diff changeset
871 @kbd{:e}, @kbd{:r}, @kbd{:w}, etc., command (in Emacs, each buffer has a
Dave Love <fx@gnu.org>
parents:
diff changeset
872 current directory).
Dave Love <fx@gnu.org>
parents:
diff changeset
873 This directory is inserted in the Minibuffer once you type space after
Dave Love <fx@gnu.org>
parents:
diff changeset
874 @kbd{:e, r}, etc. Viper also supports completion of file names and Ex
Dave Love <fx@gnu.org>
parents:
diff changeset
875 commands (@key{TAB}), and it keeps track of
Dave Love <fx@gnu.org>
parents:
diff changeset
876 command and file history (@kbd{M-p}, @kbd{M-n}).
Dave Love <fx@gnu.org>
parents:
diff changeset
877 Absolute filenames are required less
Dave Love <fx@gnu.org>
parents:
diff changeset
878 often in Viper.
Dave Love <fx@gnu.org>
parents:
diff changeset
879
Dave Love <fx@gnu.org>
parents:
diff changeset
880 You should be aware that Emacs interprets @kbd{/foo/bar//bla} as
Dave Love <fx@gnu.org>
parents:
diff changeset
881 @kbd{/bla} and @kbd{/foo/~/bar} as @kbd{~/bar}. This is designed to
38866
662d4bf4871a Avoid saying "Unix" in a way that includes GNU.
Richard M. Stallman <rms@gnu.org>
parents: 38514
diff changeset
882 minimize the need for erasing file names that Emacs suggests in its
662d4bf4871a Avoid saying "Unix" in a way that includes GNU.
Richard M. Stallman <rms@gnu.org>
parents: 38514
diff changeset
883 prompts, if a suggested file name is not what you wanted.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
884
Dave Love <fx@gnu.org>
parents:
diff changeset
885 The command @kbd{:cd} will change the default directory for the
Dave Love <fx@gnu.org>
parents:
diff changeset
886 current Emacs buffer. The Ex command @kbd{:e} will interpret the
Dave Love <fx@gnu.org>
parents:
diff changeset
887 filename argument in @samp{csh}, by default. @xref{Customization}, if you
Dave Love <fx@gnu.org>
parents:
diff changeset
888 want to change this.
Dave Love <fx@gnu.org>
parents:
diff changeset
889 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
890
Dave Love <fx@gnu.org>
parents:
diff changeset
891 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
892 Currently undisplayed files can be listed using the @kbd{:ar} command. The
Dave Love <fx@gnu.org>
parents:
diff changeset
893 command @kbd{:n} can be given counts from the @kbd{:ar} list to switch to
Dave Love <fx@gnu.org>
parents:
diff changeset
894 other files.
Dave Love <fx@gnu.org>
parents:
diff changeset
895
Dave Love <fx@gnu.org>
parents:
diff changeset
896 @node Unimplemented Features,,Multiple Files in Viper,Overview
Dave Love <fx@gnu.org>
parents:
diff changeset
897 @section Unimplemented Features
Dave Love <fx@gnu.org>
parents:
diff changeset
898
Dave Love <fx@gnu.org>
parents:
diff changeset
899 Unimplemented features include:
Dave Love <fx@gnu.org>
parents:
diff changeset
900
Dave Love <fx@gnu.org>
parents:
diff changeset
901 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
902 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
903 @kbd{:ab} and @kbd{:una} are not implemented.
Dave Love <fx@gnu.org>
parents:
diff changeset
904 Both @kbd{:map} and @kbd{:ab} are considered obsolete, since Emacs has much
Dave Love <fx@gnu.org>
parents:
diff changeset
905 more powerful facilities for defining keyboard macros and abbreviations.
Dave Love <fx@gnu.org>
parents:
diff changeset
906 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
907 @kbd{:set option?} is not implemented. The current
Dave Love <fx@gnu.org>
parents:
diff changeset
908 @kbd{:set} can also be used to set Emacs variables.
Dave Love <fx@gnu.org>
parents:
diff changeset
909 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
910 @kbd{:se list} requires modification of the display code for Emacs, so
Dave Love <fx@gnu.org>
parents:
diff changeset
911 it is not implemented.
Dave Love <fx@gnu.org>
parents:
diff changeset
912 A useful alternative is @code{cat -t -e file}. Unfortunately, it cannot
Dave Love <fx@gnu.org>
parents:
diff changeset
913 be used directly inside Emacs, since Emacs will obdurately change @samp{^I}
Dave Love <fx@gnu.org>
parents:
diff changeset
914 back to normal tabs.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
915 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
916
Dave Love <fx@gnu.org>
parents:
diff changeset
917 @comment node-name, next, previous, up
Dave Love <fx@gnu.org>
parents:
diff changeset
918 @node Improvements over Vi, Customization, Overview, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
919 @chapter Improvements over Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
920
Dave Love <fx@gnu.org>
parents:
diff changeset
921 Some common problems with Vi and Ex have been solved in Viper. This
Dave Love <fx@gnu.org>
parents:
diff changeset
922 includes better implementation of existing commands, new commands, and
Dave Love <fx@gnu.org>
parents:
diff changeset
923 the facilities provided by Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
924
Dave Love <fx@gnu.org>
parents:
diff changeset
925 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
926 * Basics:: Basic Viper differences, Multi-file effects.
Dave Love <fx@gnu.org>
parents:
diff changeset
927 * Undo and Backups:: Multiple undo, auto-save, backups and changes
Dave Love <fx@gnu.org>
parents:
diff changeset
928 * History:: History for Ex and Vi commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
929 * Macros and Registers:: Keyboard Macros (extended ".")@: @@reg execution.
Dave Love <fx@gnu.org>
parents:
diff changeset
930 * Completion:: Filename and Command Completion for Ex.
Dave Love <fx@gnu.org>
parents:
diff changeset
931 * Improved Search:: Incremental Search and Buffer Content Search.
Dave Love <fx@gnu.org>
parents:
diff changeset
932 * Abbreviation Facilities:: Normal Abbrevs, Templates, and Dynamic Abbrevs.
Dave Love <fx@gnu.org>
parents:
diff changeset
933 * Movement and Markers:: Screen Editor movements, viewing textmarkers.
Dave Love <fx@gnu.org>
parents:
diff changeset
934 * New Commands:: Commands that do not exist in Vi.
Dave Love <fx@gnu.org>
parents:
diff changeset
935 * Useful Packages:: A Sampling of some Emacs packages, and things
Dave Love <fx@gnu.org>
parents:
diff changeset
936 you should know about.
Dave Love <fx@gnu.org>
parents:
diff changeset
937 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
938
Dave Love <fx@gnu.org>
parents:
diff changeset
939 @node Basics, Undo and Backups, Improvements over Vi, Improvements over Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
940 @section Basics
Dave Love <fx@gnu.org>
parents:
diff changeset
941
Dave Love <fx@gnu.org>
parents:
diff changeset
942 The Vi command set is based on the idea of combining motion commands
Dave Love <fx@gnu.org>
parents:
diff changeset
943 with other commands. The motion command is used as a text region
Dave Love <fx@gnu.org>
parents:
diff changeset
944 specifier for other commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
945 We classify motion commands into @dfn{point commands} and
Dave Love <fx@gnu.org>
parents:
diff changeset
946 @dfn{line commands}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
947
Dave Love <fx@gnu.org>
parents:
diff changeset
948 @cindex point commands
Dave Love <fx@gnu.org>
parents:
diff changeset
949
Dave Love <fx@gnu.org>
parents:
diff changeset
950 The point commands are:
Dave Love <fx@gnu.org>
parents:
diff changeset
951
Dave Love <fx@gnu.org>
parents:
diff changeset
952 @quotation
Dave Love <fx@gnu.org>
parents:
diff changeset
953 @kbd{h}, @kbd{l}, @kbd{0}, @kbd{$}, @kbd{w}, @kbd{W}, @kbd{b}, @kbd{B},
Dave Love <fx@gnu.org>
parents:
diff changeset
954 @kbd{e}, @kbd{E}, @kbd{(}, @kbd{)}, @kbd{/}, @kbd{?}, @kbd{`}, @kbd{f},
Dave Love <fx@gnu.org>
parents:
diff changeset
955 @kbd{F}, @kbd{t}, @kbd{T}, @kbd{%}, @kbd{;}, @kbd{,}, @kbd{^}
Dave Love <fx@gnu.org>
parents:
diff changeset
956 @end quotation
Dave Love <fx@gnu.org>
parents:
diff changeset
957
Dave Love <fx@gnu.org>
parents:
diff changeset
958 @cindex line commands
Dave Love <fx@gnu.org>
parents:
diff changeset
959
Dave Love <fx@gnu.org>
parents:
diff changeset
960 The line commands are:
Dave Love <fx@gnu.org>
parents:
diff changeset
961
Dave Love <fx@gnu.org>
parents:
diff changeset
962 @quotation
Dave Love <fx@gnu.org>
parents:
diff changeset
963 @kbd{j}, @kbd{k}, @kbd{+}, @kbd{-}, @kbd{H}, @kbd{M}, @kbd{L}, @kbd{@{},
Dave Love <fx@gnu.org>
parents:
diff changeset
964 @kbd{@}}, @kbd{G}, @kbd{'}, @kbd{[[}, @kbd{]]}, @kbd{[]}
Dave Love <fx@gnu.org>
parents:
diff changeset
965 @end quotation
Dave Love <fx@gnu.org>
parents:
diff changeset
966
Dave Love <fx@gnu.org>
parents:
diff changeset
967 @cindex region
Dave Love <fx@gnu.org>
parents:
diff changeset
968 @cindex region specification
Dave Love <fx@gnu.org>
parents:
diff changeset
969 @cindex expanding (region)
Dave Love <fx@gnu.org>
parents:
diff changeset
970 @cindex describing regions
Dave Love <fx@gnu.org>
parents:
diff changeset
971 @cindex movement commands
Dave Love <fx@gnu.org>
parents:
diff changeset
972
Dave Love <fx@gnu.org>
parents:
diff changeset
973 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
974 If a point command is given as an argument to a modifying command, the
Dave Love <fx@gnu.org>
parents:
diff changeset
975 region determined by the point command will be affected by the modifying
Dave Love <fx@gnu.org>
parents:
diff changeset
976 command. On the other hand, if a line command is given as an argument to a
Dave Love <fx@gnu.org>
parents:
diff changeset
977 modifying command, the region determined by the line command will be
Dave Love <fx@gnu.org>
parents:
diff changeset
978 enlarged so that it will become the smallest region properly containing the
Dave Love <fx@gnu.org>
parents:
diff changeset
979 region and consisting of whole lines (we call this process @dfn{expanding
Dave Love <fx@gnu.org>
parents:
diff changeset
980 the region}), and then the enlarged region will be affected by the modifying
Dave Love <fx@gnu.org>
parents:
diff changeset
981 command.
Dave Love <fx@gnu.org>
parents:
diff changeset
982 Text Deletion Commands (@pxref{Deleting Text}), Change commands
Dave Love <fx@gnu.org>
parents:
diff changeset
983 (@pxref{Changing Text}), even Shell Commands (@pxref{Shell Commands})
Dave Love <fx@gnu.org>
parents:
diff changeset
984 use these commands to describe a region of text to operate on.
Dave Love <fx@gnu.org>
parents:
diff changeset
985 Thus, type @kbd{dw} to delete a word, @kbd{>@}} to shift a paragraph, or
Dave Love <fx@gnu.org>
parents:
diff changeset
986 @kbd{!'afmt} to format a region from @samp{point} to textmarker
Dave Love <fx@gnu.org>
parents:
diff changeset
987 @samp{a}.
Dave Love <fx@gnu.org>
parents:
diff changeset
988
Dave Love <fx@gnu.org>
parents:
diff changeset
989 @cindex r and R region specifiers
Dave Love <fx@gnu.org>
parents:
diff changeset
990
Dave Love <fx@gnu.org>
parents:
diff changeset
991 Viper adds the region specifiers @samp{r} and @samp{R}. Emacs has a
Dave Love <fx@gnu.org>
parents:
diff changeset
992 special marker called @dfn{mark}. The text-area between the current cursor
Dave Love <fx@gnu.org>
parents:
diff changeset
993 position @dfn{point} and the @dfn{mark} is called the @dfn{region}.
Dave Love <fx@gnu.org>
parents:
diff changeset
994 @samp{r} specifies the raw region and @samp{R} is the expanded region
Dave Love <fx@gnu.org>
parents:
diff changeset
995 (i.e., the minimal contiguous chunk of full lines that contains the raw
Dave Love <fx@gnu.org>
parents:
diff changeset
996 region).
Dave Love <fx@gnu.org>
parents:
diff changeset
997 @kbd{dr} will now delete the region, @kbd{>r} will shift it, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
998 @kbd{r,R} are not motion commands, however. The special mark is set by
Dave Love <fx@gnu.org>
parents:
diff changeset
999 @kbd{m.} and other commands. @xref{Marking}, for more info.
Dave Love <fx@gnu.org>
parents:
diff changeset
1000
Dave Love <fx@gnu.org>
parents:
diff changeset
1001 Viper also adds counts to most commands for which it would make sense.
Dave Love <fx@gnu.org>
parents:
diff changeset
1002
Dave Love <fx@gnu.org>
parents:
diff changeset
1003 In the Overview chapter, some Multiple File issues were discussed
Dave Love <fx@gnu.org>
parents:
diff changeset
1004 (@pxref{Multiple Files in Viper}). In addition to the files, Emacs has
Dave Love <fx@gnu.org>
parents:
diff changeset
1005 buffers. These can be seen in the @kbd{:args} list and switched using
Dave Love <fx@gnu.org>
parents:
diff changeset
1006 @kbd{:next} if you type @kbd{:set ex-cycle-through-non-files t}, or
Dave Love <fx@gnu.org>
parents:
diff changeset
1007 specify @code{(setq ex-cycle-through-non-files t)} in your @file{.viper}
Dave Love <fx@gnu.org>
parents:
diff changeset
1008 file. @xref{Customization}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
1009
Dave Love <fx@gnu.org>
parents:
diff changeset
1010 @node Undo and Backups, History, Basics, Improvements over Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
1011 @section Undo and Backups
Dave Love <fx@gnu.org>
parents:
diff changeset
1012
Dave Love <fx@gnu.org>
parents:
diff changeset
1013 @cindex undo
Dave Love <fx@gnu.org>
parents:
diff changeset
1014
Dave Love <fx@gnu.org>
parents:
diff changeset
1015 Viper provides multiple undo. The number of undo's and the size is limited
Dave Love <fx@gnu.org>
parents:
diff changeset
1016 by the machine. The Viper command @kbd{u} does an undo. Undo can be
Dave Love <fx@gnu.org>
parents:
diff changeset
1017 repeated by typing @kbd{.} (a period). Another @kbd{u} will undo the undo,
Dave Love <fx@gnu.org>
parents:
diff changeset
1018 and further
Dave Love <fx@gnu.org>
parents:
diff changeset
1019 @kbd{.} will repeat it. Typing @kbd{u} does the first undo, and changes the
Dave Love <fx@gnu.org>
parents:
diff changeset
1020 direction.
Dave Love <fx@gnu.org>
parents:
diff changeset
1021
Dave Love <fx@gnu.org>
parents:
diff changeset
1022 @cindex backup files
Dave Love <fx@gnu.org>
parents:
diff changeset
1023 @cindex auto save
Dave Love <fx@gnu.org>
parents:
diff changeset
1024
Dave Love <fx@gnu.org>
parents:
diff changeset
1025 Since the undo size is limited, Viper can create backup files and
Dave Love <fx@gnu.org>
parents:
diff changeset
1026 auto-save files. It will normally do this automatically. It is possible
Dave Love <fx@gnu.org>
parents:
diff changeset
1027 to have numbered backups, etc. For details, @pxref{Backup,,Backup and
Dave Love <fx@gnu.org>
parents:
diff changeset
1028 Auto-Save,emacs,The GNU Emacs Manual} @refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1029
Dave Love <fx@gnu.org>
parents:
diff changeset
1030 @comment [ balance parens
Dave Love <fx@gnu.org>
parents:
diff changeset
1031 @cindex viewing registers and markers
Dave Love <fx@gnu.org>
parents:
diff changeset
1032 @cindex registers
Dave Love <fx@gnu.org>
parents:
diff changeset
1033 @cindex markers
Dave Love <fx@gnu.org>
parents:
diff changeset
1034 @cindex textmarkers
Dave Love <fx@gnu.org>
parents:
diff changeset
1035
Dave Love <fx@gnu.org>
parents:
diff changeset
1036 The results of the 9 previous changes are available in the 9 numeric
Dave Love <fx@gnu.org>
parents:
diff changeset
1037 registers, as in Vi. The extra goody is the ability to @emph{view} these
Dave Love <fx@gnu.org>
parents:
diff changeset
1038 registers, in addition to being able to access them through @kbd{p} and
Dave Love <fx@gnu.org>
parents:
diff changeset
1039 @kbd{M-y} (@xref{Insert State}, for details.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1040 The Viper command @kbd{] register} will display the contents of any
Dave Love <fx@gnu.org>
parents:
diff changeset
1041 register, numeric or alphabetical. The related command @kbd{[ textmarker}
Dave Love <fx@gnu.org>
parents:
diff changeset
1042 will show the text around the textmarker. @samp{register} and @samp{textmarker}
Dave Love <fx@gnu.org>
parents:
diff changeset
1043 can be any letters from a through z.
Dave Love <fx@gnu.org>
parents:
diff changeset
1044 @comment ] balance parens
Dave Love <fx@gnu.org>
parents:
diff changeset
1045
Dave Love <fx@gnu.org>
parents:
diff changeset
1046 @node History, Macros and Registers, Undo and Backups,Improvements over Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
1047 @section History
Dave Love <fx@gnu.org>
parents:
diff changeset
1048
Dave Love <fx@gnu.org>
parents:
diff changeset
1049 @cindex history
Dave Love <fx@gnu.org>
parents:
diff changeset
1050 @cindex Minibuffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1051
Dave Love <fx@gnu.org>
parents:
diff changeset
1052 History is provided for Ex commands, Vi searches, file names, pieces of
Dave Love <fx@gnu.org>
parents:
diff changeset
1053 text inserted in earlier commands that use Insert or Replace state, and for
Dave Love <fx@gnu.org>
parents:
diff changeset
1054 destructive commands in Vi state. These are
Dave Love <fx@gnu.org>
parents:
diff changeset
1055 useful for fixing those small typos that screw up searches and @kbd{:s},
Dave Love <fx@gnu.org>
parents:
diff changeset
1056 and for eliminating routine associated with repeated typing of file names
Dave Love <fx@gnu.org>
parents:
diff changeset
1057 or pieces of text that need to be inserted frequently.
Dave Love <fx@gnu.org>
parents:
diff changeset
1058 At the @kbd{:} or @kbd{/} prompts in the Minibuffer, you can do the following:
Dave Love <fx@gnu.org>
parents:
diff changeset
1059
Dave Love <fx@gnu.org>
parents:
diff changeset
1060 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1061 @item M-p and M-n
Dave Love <fx@gnu.org>
parents:
diff changeset
1062 To move to previous and next history items. This causes the history
Dave Love <fx@gnu.org>
parents:
diff changeset
1063 items to appear on the command line, where you can edit them, or
Dave Love <fx@gnu.org>
parents:
diff changeset
1064 simply type Return to execute.
Dave Love <fx@gnu.org>
parents:
diff changeset
1065 @item M-r and M-s
Dave Love <fx@gnu.org>
parents:
diff changeset
1066 To search backward and forward through the history.
Dave Love <fx@gnu.org>
parents:
diff changeset
1067 @item @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
1068 Type @key{RET} to accept a default (which is displayed in the prompt).
Dave Love <fx@gnu.org>
parents:
diff changeset
1069 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1070
Dave Love <fx@gnu.org>
parents:
diff changeset
1071 The history of insertions can be perused by
Dave Love <fx@gnu.org>
parents:
diff changeset
1072 typing @kbd{C-c M-p} and @kbd{C-c M-n} while in Insert or Replace state.
Dave Love <fx@gnu.org>
parents:
diff changeset
1073 The history of destructive Vi commands can be perused via the same keys
Dave Love <fx@gnu.org>
parents:
diff changeset
1074 when Viper is in Vi state. @xref{Viper Specials}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
1075
Dave Love <fx@gnu.org>
parents:
diff changeset
1076 All Ex commands have a file history. For instance, typing @kbd{:e}, space
Dave Love <fx@gnu.org>
parents:
diff changeset
1077 and then @kbd{M-p} will bring up the name of the previously typed file
Dave Love <fx@gnu.org>
parents:
diff changeset
1078 name. Repeatedly typing @kbd{M-p}, @kbd{M-n}, etc., will let you browse
Dave Love <fx@gnu.org>
parents:
diff changeset
1079 through the file history.
Dave Love <fx@gnu.org>
parents:
diff changeset
1080
Dave Love <fx@gnu.org>
parents:
diff changeset
1081 Similarly, commands that have to do with switching buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
1082 have a buffer history, and commands that expect strings or regular
Dave Love <fx@gnu.org>
parents:
diff changeset
1083 expressions keep a history on those items.
Dave Love <fx@gnu.org>
parents:
diff changeset
1084
Dave Love <fx@gnu.org>
parents:
diff changeset
1085 @node Macros and Registers,Completion,History,Improvements over Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
1086 @section Macros and Registers
Dave Love <fx@gnu.org>
parents:
diff changeset
1087
Dave Love <fx@gnu.org>
parents:
diff changeset
1088 @cindex keyboard macros
Dave Love <fx@gnu.org>
parents:
diff changeset
1089 @cindex macros
Dave Love <fx@gnu.org>
parents:
diff changeset
1090 @cindex registers
Dave Love <fx@gnu.org>
parents:
diff changeset
1091 @cindex register execution
Dave Love <fx@gnu.org>
parents:
diff changeset
1092
Dave Love <fx@gnu.org>
parents:
diff changeset
1093 Viper facilitates the use of Emacs-style keyboard macros. @kbd{@@#} will
Dave Love <fx@gnu.org>
parents:
diff changeset
1094 start a macro definition. As you type, the commands will be executed, and
Dave Love <fx@gnu.org>
parents:
diff changeset
1095 remembered (This is called ``learn mode'' in some editors.)
Dave Love <fx@gnu.org>
parents:
diff changeset
1096 @kbd{@@register} will complete the macro, putting it into @samp{register},
Dave Love <fx@gnu.org>
parents:
diff changeset
1097 where @samp{register} is any character from @samp{a} through @samp{z}. Then
Dave Love <fx@gnu.org>
parents:
diff changeset
1098 you can execute this macro using @kbd{@@register}. It is, of course,
Dave Love <fx@gnu.org>
parents:
diff changeset
1099 possible to yank some text into a register and execute it using
Dave Love <fx@gnu.org>
parents:
diff changeset
1100 @kbd{@@register}. Typing @kbd{@@@@}, @kbd{@@RET}, or @kbd{@@C-j} will
Dave Love <fx@gnu.org>
parents:
diff changeset
1101 execute the last macro that was executed using @kbd{@@register}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1102
Dave Love <fx@gnu.org>
parents:
diff changeset
1103 Viper will automatically lowercase the register, so that pressing the
Dave Love <fx@gnu.org>
parents:
diff changeset
1104 @kbd{SHIFT} key for @kbd{@@} will not create problems. This is for
Dave Love <fx@gnu.org>
parents:
diff changeset
1105 @kbd{@@} macros and @kbd{"p} @emph{only}. In the case of @kbd{y},
Dave Love <fx@gnu.org>
parents:
diff changeset
1106 @kbd{"Ayy} will append to @emph{register a}. For @kbd{[,],',`}, it
Dave Love <fx@gnu.org>
parents:
diff changeset
1107 is an error to use a Uppercase register name.
Dave Love <fx@gnu.org>
parents:
diff changeset
1108
Dave Love <fx@gnu.org>
parents:
diff changeset
1109 @comment [ balance parens
Dave Love <fx@gnu.org>
parents:
diff changeset
1110 @cindex viewing registers and markers
Dave Love <fx@gnu.org>
parents:
diff changeset
1111
Dave Love <fx@gnu.org>
parents:
diff changeset
1112 The contents of a register can be seen by @kbd{]register}. (@kbd{[textmarker}
Dave Love <fx@gnu.org>
parents:
diff changeset
1113 will show the contents of a textmarker).
Dave Love <fx@gnu.org>
parents:
diff changeset
1114 @comment ] balance parens
Dave Love <fx@gnu.org>
parents:
diff changeset
1115
Dave Love <fx@gnu.org>
parents:
diff changeset
1116 @cindex last keyboard macro
Dave Love <fx@gnu.org>
parents:
diff changeset
1117
Dave Love <fx@gnu.org>
parents:
diff changeset
1118 The last keyboard macro can also be executed using
Dave Love <fx@gnu.org>
parents:
diff changeset
1119 @kbd{*}, and it can be yanked into a register using @kbd{@@!register}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1120 This is useful for Emacs style keyboard macros defined using @kbd{C-x(}
Dave Love <fx@gnu.org>
parents:
diff changeset
1121 and @kbd{C-x)}. Emacs keyboard macros have more capabilities.
Dave Love <fx@gnu.org>
parents:
diff changeset
1122 @xref{Keyboard Macros,,Keyboard Macros,emacs, The GNU Emacs Manual}, for
Dave Love <fx@gnu.org>
parents:
diff changeset
1123 details.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1124
Dave Love <fx@gnu.org>
parents:
diff changeset
1125 Keyboard Macros allow an interesting form of Query-Replace:
Dave Love <fx@gnu.org>
parents:
diff changeset
1126 @kbd{/pattern} or @kbd{n} to go to the next pattern (the query), followed by a
Dave Love <fx@gnu.org>
parents:
diff changeset
1127 Keyboard Macro execution @kbd{@@@@} (the replace).
Dave Love <fx@gnu.org>
parents:
diff changeset
1128
Dave Love <fx@gnu.org>
parents:
diff changeset
1129 Viper also provides Vi-style macros. @xref{Vi Macros}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
1130
Dave Love <fx@gnu.org>
parents:
diff changeset
1131
Dave Love <fx@gnu.org>
parents:
diff changeset
1132 @node Completion, Improved Search, Macros and Registers, Improvements over Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
1133 @section Completion
Dave Love <fx@gnu.org>
parents:
diff changeset
1134
Dave Love <fx@gnu.org>
parents:
diff changeset
1135 @cindex completion
Dave Love <fx@gnu.org>
parents:
diff changeset
1136
Dave Love <fx@gnu.org>
parents:
diff changeset
1137 Completion is done when you type @key{TAB}. The Emacs completer does not
38866
662d4bf4871a Avoid saying "Unix" in a way that includes GNU.
Richard M. Stallman <rms@gnu.org>
parents: 38514
diff changeset
1138 grok wildcards in file names. Once you type a wildcard, the completer will
662d4bf4871a Avoid saying "Unix" in a way that includes GNU.
Richard M. Stallman <rms@gnu.org>
parents: 38514
diff changeset
1139 no longer work for that file name. Remember that Emacs interprets a file name
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1140 of the form @kbd{/foo//bar} as @kbd{/bar} and @kbd{/foo/~/bar} as
Dave Love <fx@gnu.org>
parents:
diff changeset
1141 @kbd{~/bar}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1142
Dave Love <fx@gnu.org>
parents:
diff changeset
1143 @node Improved Search, Abbreviation Facilities, Completion, Improvements over Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
1144 @section Improved Search
Dave Love <fx@gnu.org>
parents:
diff changeset
1145
Dave Love <fx@gnu.org>
parents:
diff changeset
1146 @cindex buffer search
Dave Love <fx@gnu.org>
parents:
diff changeset
1147 @cindex word search
Dave Love <fx@gnu.org>
parents:
diff changeset
1148
Dave Love <fx@gnu.org>
parents:
diff changeset
1149 Viper provides buffer search, the ability to search the buffer for a region
Dave Love <fx@gnu.org>
parents:
diff changeset
1150 under the cursor. You have to turn this on in @file{.viper} either by calling
Dave Love <fx@gnu.org>
parents:
diff changeset
1151
Dave Love <fx@gnu.org>
parents:
diff changeset
1152 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1153 (viper-buffer-search-enable)
Dave Love <fx@gnu.org>
parents:
diff changeset
1154 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1155
Dave Love <fx@gnu.org>
parents:
diff changeset
1156 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1157 or by setting @code{viper-buffer-search-char} to, say, @kbd{f3}:
Dave Love <fx@gnu.org>
parents:
diff changeset
1158 @example
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
1159 (setq viper-buffer-search-char ?g)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1160 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1161
Dave Love <fx@gnu.org>
parents:
diff changeset
1162 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1163 If the user calls @code{viper-buffer-search-enable} explicitly (the first
Dave Love <fx@gnu.org>
parents:
diff changeset
1164 method), then @code{viper-buffer-search-char} will be set to @kbd{g}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1165 Regardless of how this feature is enabled, the key
Dave Love <fx@gnu.org>
parents:
diff changeset
1166 @code{viper-buffer-search-char} will take movement commands, like
Dave Love <fx@gnu.org>
parents:
diff changeset
1167 @kbd{w,/,e}, to find a region and then search for the contents of that
Dave Love <fx@gnu.org>
parents:
diff changeset
1168 region. This command is very useful for searching for variable names, etc.,
Dave Love <fx@gnu.org>
parents:
diff changeset
1169 in a program. The search can be repeated by @kbd{n} or reversed by @kbd{N}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1170
Dave Love <fx@gnu.org>
parents:
diff changeset
1171 @cindex incremental search
Dave Love <fx@gnu.org>
parents:
diff changeset
1172
Dave Love <fx@gnu.org>
parents:
diff changeset
1173 Emacs provides incremental search. As you type the string in, the
Dave Love <fx@gnu.org>
parents:
diff changeset
1174 cursor will move to the next match. You can snarf words from the buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1175 as you go along. Incremental Search is normally bound to @kbd{C-s} and
Dave Love <fx@gnu.org>
parents:
diff changeset
1176 @kbd{C-r}. @xref{Customization}, to find out how to change the bindings
Dave Love <fx@gnu.org>
parents:
diff changeset
1177 of @kbd{C-r or C-s}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1178 For details, @pxref{Incremental Search,,Incremental
Dave Love <fx@gnu.org>
parents:
diff changeset
1179 Search,emacs,The GNU Emacs Manual} @refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1180
Dave Love <fx@gnu.org>
parents:
diff changeset
1181 @cindex query replace
Dave Love <fx@gnu.org>
parents:
diff changeset
1182
Dave Love <fx@gnu.org>
parents:
diff changeset
1183 Viper also provides a query replace function that prompts through the
Dave Love <fx@gnu.org>
parents:
diff changeset
1184 Minibuffer. It is invoked by the @kbd{Q} key in Vi state.
Dave Love <fx@gnu.org>
parents:
diff changeset
1185
Dave Love <fx@gnu.org>
parents:
diff changeset
1186 @cindex mouse search
Dave Love <fx@gnu.org>
parents:
diff changeset
1187
Dave Love <fx@gnu.org>
parents:
diff changeset
1188 On a window display, Viper supports mouse search, i.e., you can search for a
Dave Love <fx@gnu.org>
parents:
diff changeset
1189 word by clicking on it. @xref{Viper Specials}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
1190
Dave Love <fx@gnu.org>
parents:
diff changeset
1191 Finally, on a window display, Viper highlights search patterns as it finds
Dave Love <fx@gnu.org>
parents:
diff changeset
1192 them. This is done through what is known as @emph{faces} in Emacs. The
Dave Love <fx@gnu.org>
parents:
diff changeset
1193 variable that controls how search patterns are highlighted is
Dave Love <fx@gnu.org>
parents:
diff changeset
1194 @code{viper-search-face}. If you don't want any highlighting at all, put
Dave Love <fx@gnu.org>
parents:
diff changeset
1195 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1196 (copy-face 'default 'viper-search-face)
Dave Love <fx@gnu.org>
parents:
diff changeset
1197 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1198 @vindex @code{viper-search-face}
Dave Love <fx@gnu.org>
parents:
diff changeset
1199 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1200 in @file{~/.viper}. If you want to change how patterns are highlighted, you
Dave Love <fx@gnu.org>
parents:
diff changeset
1201 will have to change @code{viper-search-face} to your liking. The easiest
Dave Love <fx@gnu.org>
parents:
diff changeset
1202 way to do this is to use Emacs customization widget, which is accessible
Dave Love <fx@gnu.org>
parents:
diff changeset
1203 from the menubar. Viper customization group is located under the
Dave Love <fx@gnu.org>
parents:
diff changeset
1204 @emph{Emulations} customization group, which in turn is under the
Dave Love <fx@gnu.org>
parents:
diff changeset
1205 @emph{Editing} group. All Viper faces are grouped together under Viper's
Dave Love <fx@gnu.org>
parents:
diff changeset
1206 @emph{Highlighting} group.
Dave Love <fx@gnu.org>
parents:
diff changeset
1207
Dave Love <fx@gnu.org>
parents:
diff changeset
1208 Try it: it is really simple!
Dave Love <fx@gnu.org>
parents:
diff changeset
1209
Dave Love <fx@gnu.org>
parents:
diff changeset
1210 @node Abbreviation Facilities,Movement and Markers,Improved Search,Improvements over Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
1211 @section Abbreviation Facilities
Dave Love <fx@gnu.org>
parents:
diff changeset
1212
Dave Love <fx@gnu.org>
parents:
diff changeset
1213 @cindex abbrevs
Dave Love <fx@gnu.org>
parents:
diff changeset
1214
Dave Love <fx@gnu.org>
parents:
diff changeset
1215 It is possible in Emacs to define abbrevs based on the contents of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1216 buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1217 Sophisticated templates can be defined using the Emacs abbreviation
Dave Love <fx@gnu.org>
parents:
diff changeset
1218 facilities. @xref{Abbrevs,,Abbreviations,emacs,The GNU Emacs Manual}, for
Dave Love <fx@gnu.org>
parents:
diff changeset
1219 details.
Dave Love <fx@gnu.org>
parents:
diff changeset
1220
Dave Love <fx@gnu.org>
parents:
diff changeset
1221 @cindex dynamic abbrevs
Dave Love <fx@gnu.org>
parents:
diff changeset
1222
Dave Love <fx@gnu.org>
parents:
diff changeset
1223 Emacs also provides Dynamic Abbreviations. Given a partial word, Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
1224 will search the buffer to find an extension for this word. For instance,
Dave Love <fx@gnu.org>
parents:
diff changeset
1225 one can type @samp{Abbreviations} by typing @samp{A}, followed by a keystroke
Dave Love <fx@gnu.org>
parents:
diff changeset
1226 that completed the @samp{A} to @samp{Abbreviations}. Repeated typing
Dave Love <fx@gnu.org>
parents:
diff changeset
1227 will search further back in the buffer, so that one could get
Dave Love <fx@gnu.org>
parents:
diff changeset
1228 @samp{Abbrevs} by repeating the
Dave Love <fx@gnu.org>
parents:
diff changeset
1229 keystroke, which appears earlier in the text. Emacs binds this to
Dave Love <fx@gnu.org>
parents:
diff changeset
1230 @kbd{@key{ESC} /}, so you will have to find a key and bind the function
Dave Love <fx@gnu.org>
parents:
diff changeset
1231 @code{dabbrev-expand} to that key.
Dave Love <fx@gnu.org>
parents:
diff changeset
1232 Facilities like this make Vi's @kbd{:ab} command obsolete.
Dave Love <fx@gnu.org>
parents:
diff changeset
1233
Dave Love <fx@gnu.org>
parents:
diff changeset
1234 @node Movement and Markers, New Commands, Abbreviation Facilities, Improvements over Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
1235 @section Movement and Markers
Dave Love <fx@gnu.org>
parents:
diff changeset
1236
Dave Love <fx@gnu.org>
parents:
diff changeset
1237 @cindex Ex style motion
Dave Love <fx@gnu.org>
parents:
diff changeset
1238 @cindex line editor motion
Dave Love <fx@gnu.org>
parents:
diff changeset
1239
Dave Love <fx@gnu.org>
parents:
diff changeset
1240 Viper can be set free from the line--limited movements in Vi, such as @kbd{l}
Dave Love <fx@gnu.org>
parents:
diff changeset
1241 refusing to move beyond the line, @key{ESC} moving one character back,
Dave Love <fx@gnu.org>
parents:
diff changeset
1242 etc. These derive from Ex, which is a line editor. If your @file{.viper}
Dave Love <fx@gnu.org>
parents:
diff changeset
1243 contains
Dave Love <fx@gnu.org>
parents:
diff changeset
1244
Dave Love <fx@gnu.org>
parents:
diff changeset
1245 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1246 @code{(setq viper-ex-style-motion nil)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1247 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1248
Dave Love <fx@gnu.org>
parents:
diff changeset
1249 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1250 the motion will be a true screen editor motion. One thing you must then
Dave Love <fx@gnu.org>
parents:
diff changeset
1251 watch out for is that it is possible to be on the end-of-line character.
Dave Love <fx@gnu.org>
parents:
diff changeset
1252 The keys @kbd{x} and @kbd{%} will still work correctly, i.e., as if they
Dave Love <fx@gnu.org>
parents:
diff changeset
1253 were on the last character.
Dave Love <fx@gnu.org>
parents:
diff changeset
1254
Dave Love <fx@gnu.org>
parents:
diff changeset
1255 @vindex @code{viper-syntax-preference}
Dave Love <fx@gnu.org>
parents:
diff changeset
1256 @cindex syntax table
Dave Love <fx@gnu.org>
parents:
diff changeset
1257
Dave Love <fx@gnu.org>
parents:
diff changeset
1258 The word-movement commands @kbd{w}, @kbd{e}, etc., and the associated
Dave Love <fx@gnu.org>
parents:
diff changeset
1259 deletion/yanking commands, @kbd{dw}, @kbd{yw}, etc., can be made to
Dave Love <fx@gnu.org>
parents:
diff changeset
1260 understand Emacs syntax tables. If the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1261 @code{viper-syntax-preference} is set to @code{strict-vi} then
Dave Love <fx@gnu.org>
parents:
diff changeset
1262 the meaning of @emph{word} is the same as in
Dave Love <fx@gnu.org>
parents:
diff changeset
1263 Vi. However, if the value is @code{reformed-vi} (the default) then the
Dave Love <fx@gnu.org>
parents:
diff changeset
1264 alphanumeric symbols will be those specified by the current Emacs syntax
Dave Love <fx@gnu.org>
parents:
diff changeset
1265 table (which may be different for different major modes) plus the
Dave Love <fx@gnu.org>
parents:
diff changeset
1266 underscore symbol @kbd{_}, minus some non-word symbols, like '.;,|, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
1267 Both @code{strict-vi} and @code{reformed-vi} work close to Vi in
Dave Love <fx@gnu.org>
parents:
diff changeset
1268 traditional cases, but @code{reformed-vi} does a better job when editing
Dave Love <fx@gnu.org>
parents:
diff changeset
1269 text in non-Latin alphabets.
Dave Love <fx@gnu.org>
parents:
diff changeset
1270
Dave Love <fx@gnu.org>
parents:
diff changeset
1271 The user can also specify the value @code{emacs}, which would
Dave Love <fx@gnu.org>
parents:
diff changeset
1272 make Viper use exactly the Emacs notion of word. In particular, the
Dave Love <fx@gnu.org>
parents:
diff changeset
1273 underscore may not be part of a word. Finally, if
Dave Love <fx@gnu.org>
parents:
diff changeset
1274 @code{viper-syntax-preference} is set to @code{extended}, Viper words would
Dave Love <fx@gnu.org>
parents:
diff changeset
1275 consist of characters that are classified as alphanumeric @emph{or} as
Dave Love <fx@gnu.org>
parents:
diff changeset
1276 parts of symbols. This is convenient for writing programs and in many other
Dave Love <fx@gnu.org>
parents:
diff changeset
1277 situations.
Dave Love <fx@gnu.org>
parents:
diff changeset
1278
Dave Love <fx@gnu.org>
parents:
diff changeset
1279 @code{viper-syntax-preference} is a local variable, so it can have different
Dave Love <fx@gnu.org>
parents:
diff changeset
1280 values for different major modes. For instance, in programming modes it can
Dave Love <fx@gnu.org>
parents:
diff changeset
1281 have the value @code{extended}. In text modes where words contain special
Dave Love <fx@gnu.org>
parents:
diff changeset
1282 characters, such as European (non-English) letters, Cyrillic letters, etc.,
Dave Love <fx@gnu.org>
parents:
diff changeset
1283 the value can be @code{reformed-vi} or @code{emacs}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1284
Dave Love <fx@gnu.org>
parents:
diff changeset
1285 Changes to @code{viper-syntax-preference} should be done in the hooks to
Dave Love <fx@gnu.org>
parents:
diff changeset
1286 various major modes by executing @code{viper-set-syntax-preference} as in
Dave Love <fx@gnu.org>
parents:
diff changeset
1287 the following example:
Dave Love <fx@gnu.org>
parents:
diff changeset
1288
Dave Love <fx@gnu.org>
parents:
diff changeset
1289 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1290 (viper-set-syntax-preference nil "emacs")
Dave Love <fx@gnu.org>
parents:
diff changeset
1291 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1292
Dave Love <fx@gnu.org>
parents:
diff changeset
1293 @findex @code{viper-set-syntax-preference}
Dave Love <fx@gnu.org>
parents:
diff changeset
1294
Dave Love <fx@gnu.org>
parents:
diff changeset
1295 The above discussion of the meaning of Viper's words concerns only Viper's
Dave Love <fx@gnu.org>
parents:
diff changeset
1296 movement commands. In regular expressions, words remain the same as in
Dave Love <fx@gnu.org>
parents:
diff changeset
1297 Emacs. That is, the expressions @code{\w}, @code{\>}, @code{\<}, etc., use
Dave Love <fx@gnu.org>
parents:
diff changeset
1298 Emacs' idea of what is a word, and they don't look into the value of
Dave Love <fx@gnu.org>
parents:
diff changeset
1299 variable @code{viper-syntax-preference}. This is because Viper doesn't change
Dave Love <fx@gnu.org>
parents:
diff changeset
1300 syntax tables in fear of upsetting the various major modes that set these
Dave Love <fx@gnu.org>
parents:
diff changeset
1301 tables.
Dave Love <fx@gnu.org>
parents:
diff changeset
1302
Dave Love <fx@gnu.org>
parents:
diff changeset
1303 @cindex textmarkers
Dave Love <fx@gnu.org>
parents:
diff changeset
1304
Dave Love <fx@gnu.org>
parents:
diff changeset
1305 Textmarkers in Viper remember the file and the position, so that you can
Dave Love <fx@gnu.org>
parents:
diff changeset
1306 switch files by simply doing @kbd{'a}. If you set up a regimen for using
Dave Love <fx@gnu.org>
parents:
diff changeset
1307 Textmarkers, this is very useful. Contents of textmarkers can be viewed
Dave Love <fx@gnu.org>
parents:
diff changeset
1308 by @kbd{[marker}. (Contents of registers can be viewed by @kbd{]register}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1309
Dave Love <fx@gnu.org>
parents:
diff changeset
1310 @node New Commands, Useful Packages, Movement and Markers, Improvements over Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
1311 @section New Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
1312
Dave Love <fx@gnu.org>
parents:
diff changeset
1313 These commands have no Vi analogs.
Dave Love <fx@gnu.org>
parents:
diff changeset
1314
Dave Love <fx@gnu.org>
parents:
diff changeset
1315 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1316 @item C-x, C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
1317 @kindex @kbd{C-x}
Dave Love <fx@gnu.org>
parents:
diff changeset
1318 @kindex @kbd{C-c}
Dave Love <fx@gnu.org>
parents:
diff changeset
1319 These two keys invoke many important Emacs functions. For example, if you
Dave Love <fx@gnu.org>
parents:
diff changeset
1320 hit @kbd{C-x} followed by @kbd{2}, then the current window will be split
Dave Love <fx@gnu.org>
parents:
diff changeset
1321 into 2. Except for novice users, @kbd{C-c} is also set to execute an Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
1322 command from the current major mode. @key{ESC} will do the same, if you
Dave Love <fx@gnu.org>
parents:
diff changeset
1323 configure @key{ESC} as Meta by setting @code{viper-no-multiple-ESC} to nil
Dave Love <fx@gnu.org>
parents:
diff changeset
1324 in @file{.viper}. @xref{Customization}. @kbd{C-\} in Insert, Replace, or Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
1325 states will make Emacs think @kbd{Meta} has been hit.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1326 @item \
Dave Love <fx@gnu.org>
parents:
diff changeset
1327 @kindex @kbd{\}
Dave Love <fx@gnu.org>
parents:
diff changeset
1328 Escape to Emacs to execute a single Emacs command. For instance,
Dave Love <fx@gnu.org>
parents:
diff changeset
1329 @kbd{\ @key{ESC}} will act like a Meta key.
Dave Love <fx@gnu.org>
parents:
diff changeset
1330 @item Q
Dave Love <fx@gnu.org>
parents:
diff changeset
1331 @kindex @kbd{Q}
Dave Love <fx@gnu.org>
parents:
diff changeset
1332 @cindex query replace
Dave Love <fx@gnu.org>
parents:
diff changeset
1333 @kbd{Q} is for query replace. By default,
Dave Love <fx@gnu.org>
parents:
diff changeset
1334 each string to be replaced is treated as a regular expression. You can use
Dave Love <fx@gnu.org>
parents:
diff changeset
1335 @code{(setq viper-re-query-replace nil)} in your @file{.emacs} file to
Dave Love <fx@gnu.org>
parents:
diff changeset
1336 turn this off. (For normal searches, @kbd{:se nomagic} will work. Note
Dave Love <fx@gnu.org>
parents:
diff changeset
1337 that @kbd{:se nomagic} turns Regexps off completely, unlike Vi).
Dave Love <fx@gnu.org>
parents:
diff changeset
1338 @item v
Dave Love <fx@gnu.org>
parents:
diff changeset
1339 @itemx V
Dave Love <fx@gnu.org>
parents:
diff changeset
1340 @itemx C-v
Dave Love <fx@gnu.org>
parents:
diff changeset
1341 @kindex @kbd{v}
Dave Love <fx@gnu.org>
parents:
diff changeset
1342 @kindex @kbd{V}
Dave Love <fx@gnu.org>
parents:
diff changeset
1343 @kindex @kbd{C-v}
Dave Love <fx@gnu.org>
parents:
diff changeset
1344 These keys are used to visit files. @kbd{v} will switch to a buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1345 visiting file whose name can be entered in the Minibuffer. @kbd{V} is
Dave Love <fx@gnu.org>
parents:
diff changeset
1346 similar, but will use a window different from the current window.
Dave Love <fx@gnu.org>
parents:
diff changeset
1347 @kbd{C-v} is like @kbd{V}, except that a new frame (X window) will be used
Dave Love <fx@gnu.org>
parents:
diff changeset
1348 instead of a new Emacs window.
Dave Love <fx@gnu.org>
parents:
diff changeset
1349 @item #
Dave Love <fx@gnu.org>
parents:
diff changeset
1350 @kindex @kbd{#}
Dave Love <fx@gnu.org>
parents:
diff changeset
1351 If followed by a certain character @var{ch}, it becomes an operator whose
Dave Love <fx@gnu.org>
parents:
diff changeset
1352 argument is the region determined by the motion command that follows
Dave Love <fx@gnu.org>
parents:
diff changeset
1353 (indicated as <move>).
Dave Love <fx@gnu.org>
parents:
diff changeset
1354 Currently, @var{ch} can be one of @kbd{c}, @kbd{C}, @kbd{g}, @kbd{q}, and
Dave Love <fx@gnu.org>
parents:
diff changeset
1355 @kbd{s}. For instance, @kbd{#qr} will prompt you for a string and then
Dave Love <fx@gnu.org>
parents:
diff changeset
1356 prepend this string to each line in the buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1357 @item # c
Dave Love <fx@gnu.org>
parents:
diff changeset
1358 @kindex @kbd{#c<move>}
Dave Love <fx@gnu.org>
parents:
diff changeset
1359 @cindex changing case
Dave Love <fx@gnu.org>
parents:
diff changeset
1360 Change upper-case characters in the region to lower-case
Dave Love <fx@gnu.org>
parents:
diff changeset
1361 (@code{downcase-region}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1362 Emacs command @kbd{M-l} does the same for words.
Dave Love <fx@gnu.org>
parents:
diff changeset
1363 @item # C
Dave Love <fx@gnu.org>
parents:
diff changeset
1364 @kindex @kbd{#C<move>}
Dave Love <fx@gnu.org>
parents:
diff changeset
1365 Change lower-case characters in the region to upper-case. For instance,
Dave Love <fx@gnu.org>
parents:
diff changeset
1366 @kbd{# C 3 w} will capitalize 3 words from the current point
Dave Love <fx@gnu.org>
parents:
diff changeset
1367 (@code{upcase-region}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1368 Emacs command @kbd{M-u} does the same for words.
Dave Love <fx@gnu.org>
parents:
diff changeset
1369 @item # g
Dave Love <fx@gnu.org>
parents:
diff changeset
1370 @kindex @kbd{#g<move>}
Dave Love <fx@gnu.org>
parents:
diff changeset
1371 Execute last keyboard macro for each line in the region
Dave Love <fx@gnu.org>
parents:
diff changeset
1372 (@code{viper-global-execute}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1373 @item # q
Dave Love <fx@gnu.org>
parents:
diff changeset
1374 @kindex @kbd{#q<move>}
Dave Love <fx@gnu.org>
parents:
diff changeset
1375 Insert specified string at the beginning of each line in the region
Dave Love <fx@gnu.org>
parents:
diff changeset
1376 (@code{viper-quote-region}). The default string is composed of the comment
Dave Love <fx@gnu.org>
parents:
diff changeset
1377 character(s) appropriate for the current major mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
1378 @item # s
Dave Love <fx@gnu.org>
parents:
diff changeset
1379 @kindex @kbd{#s<move>}
Dave Love <fx@gnu.org>
parents:
diff changeset
1380 Check spelling of words in the region (@code{spell-region}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1381 The function used for spelling is determined from the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1382 @code{viper-spell-function}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1383 @vindex @code{viper-spell-function}
Dave Love <fx@gnu.org>
parents:
diff changeset
1384 @item *
Dave Love <fx@gnu.org>
parents:
diff changeset
1385 @kindex @kbd{*}
Dave Love <fx@gnu.org>
parents:
diff changeset
1386 Call last keyboard macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
1387 @item m .
Dave Love <fx@gnu.org>
parents:
diff changeset
1388 Set mark at point and push old mark off the ring
Dave Love <fx@gnu.org>
parents:
diff changeset
1389 @item m<
Dave Love <fx@gnu.org>
parents:
diff changeset
1390 @item m>
Dave Love <fx@gnu.org>
parents:
diff changeset
1391 Set mark at beginning and end of buffer, respectively.
Dave Love <fx@gnu.org>
parents:
diff changeset
1392 @item m,
Dave Love <fx@gnu.org>
parents:
diff changeset
1393 Jump to mark and pop mark off the ring. @xref{Mark,,Mark,emacs,The GNU
Dave Love <fx@gnu.org>
parents:
diff changeset
1394 Emacs Manual}, for more info.
Dave Love <fx@gnu.org>
parents:
diff changeset
1395 @item ] register
Dave Love <fx@gnu.org>
parents:
diff changeset
1396 @kindex @kbd{]<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
1397 View contents of register
Dave Love <fx@gnu.org>
parents:
diff changeset
1398 @item [ textmarker
Dave Love <fx@gnu.org>
parents:
diff changeset
1399 @kindex @kbd{[<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
1400 View filename and position of textmarker
Dave Love <fx@gnu.org>
parents:
diff changeset
1401 @item @@#
Dave Love <fx@gnu.org>
parents:
diff changeset
1402 @item @@register
Dave Love <fx@gnu.org>
parents:
diff changeset
1403 @item @@!
Dave Love <fx@gnu.org>
parents:
diff changeset
1404 @kindex @kbd{@@#}
Dave Love <fx@gnu.org>
parents:
diff changeset
1405 @kindex @kbd{@@<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
1406 @kindex @kbd{@@!}
Dave Love <fx@gnu.org>
parents:
diff changeset
1407 @cindex keyboard macros
Dave Love <fx@gnu.org>
parents:
diff changeset
1408 @cindex register execution
Dave Love <fx@gnu.org>
parents:
diff changeset
1409
Dave Love <fx@gnu.org>
parents:
diff changeset
1410 Begin/end keyboard macro. @@register has a different meaning when used after
Dave Love <fx@gnu.org>
parents:
diff changeset
1411 a @kbd{@@#}. @xref{Macros and Registers}, for details
Dave Love <fx@gnu.org>
parents:
diff changeset
1412 @item []
Dave Love <fx@gnu.org>
parents:
diff changeset
1413 @kindex @kbd{[]}
Dave Love <fx@gnu.org>
parents:
diff changeset
1414 Go to end of heading.
Dave Love <fx@gnu.org>
parents:
diff changeset
1415 @item g <@emph{movement command}>
Dave Love <fx@gnu.org>
parents:
diff changeset
1416 Search buffer for text delimited by movement command. The canonical
Dave Love <fx@gnu.org>
parents:
diff changeset
1417 example is @kbd{gw} to search for the word under the cursor.
Dave Love <fx@gnu.org>
parents:
diff changeset
1418 @xref{Improved Search}, for details.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1419 @item C-g and C-]
Dave Love <fx@gnu.org>
parents:
diff changeset
1420 @kindex @kbd{C-g}
Dave Love <fx@gnu.org>
parents:
diff changeset
1421 @kindex @kbd{C-]}
Dave Love <fx@gnu.org>
parents:
diff changeset
1422 Quit and Abort Recursive edit. These may be necessary on occasion.
Dave Love <fx@gnu.org>
parents:
diff changeset
1423 @xref{Vi State}, for a reason.
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
1424 @item C-c C-g
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
1425 @kindex @kbd{C-c C-g}
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
1426 Hitting @kbd{C-c} followed by @kbd{C-g} will display the information on the
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1427 current buffer. This is the same as hitting @kbd{C-g} in Vi, but, as
Dave Love <fx@gnu.org>
parents:
diff changeset
1428 explained above, @kbd{C-g} is needed for other purposes in Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
1429 @item C-c /
Dave Love <fx@gnu.org>
parents:
diff changeset
1430 @kindex @kbd{C-c /}
Dave Love <fx@gnu.org>
parents:
diff changeset
1431 Without a prefix argument, this command toggles
Dave Love <fx@gnu.org>
parents:
diff changeset
1432 case-sensitive/case-insensitive search modes and plain vanilla/regular
Dave Love <fx@gnu.org>
parents:
diff changeset
1433 expression search. With the prefix argument 1, i.e.,
Dave Love <fx@gnu.org>
parents:
diff changeset
1434 @kbd{1 C-c /}, this toggles case-sensitivity; with the prefix argument 2,
Dave Love <fx@gnu.org>
parents:
diff changeset
1435 toggles plain vanilla search and search using
Dave Love <fx@gnu.org>
parents:
diff changeset
1436 regular expressions. @xref{Viper Specials}, for alternative ways to invoke
Dave Love <fx@gnu.org>
parents:
diff changeset
1437 this function.
Dave Love <fx@gnu.org>
parents:
diff changeset
1438 @cindex vanilla search
Dave Love <fx@gnu.org>
parents:
diff changeset
1439 @cindex case-sensitive search
Dave Love <fx@gnu.org>
parents:
diff changeset
1440 @cindex case-insensitive search
Dave Love <fx@gnu.org>
parents:
diff changeset
1441
Dave Love <fx@gnu.org>
parents:
diff changeset
1442 @item M-p and M-n
Dave Love <fx@gnu.org>
parents:
diff changeset
1443 @kindex @kbd{M-p}
Dave Love <fx@gnu.org>
parents:
diff changeset
1444 @kindex @kbd{M-n}
Dave Love <fx@gnu.org>
parents:
diff changeset
1445 In the Minibuffer, these commands navigate through the minibuffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1446 histories, such as the history of search strings, Ex commands, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
1447
Dave Love <fx@gnu.org>
parents:
diff changeset
1448 @item C-c M-p and C-c M-n
Dave Love <fx@gnu.org>
parents:
diff changeset
1449 @kindex @kbd{C-c M-p}
Dave Love <fx@gnu.org>
parents:
diff changeset
1450 @kindex @kbd{C-c M-n}
Dave Love <fx@gnu.org>
parents:
diff changeset
1451 @cindex Insertion history
Dave Love <fx@gnu.org>
parents:
diff changeset
1452 @cindex Insertion ring
Dave Love <fx@gnu.org>
parents:
diff changeset
1453 @cindex Command history
Dave Love <fx@gnu.org>
parents:
diff changeset
1454 @cindex Command ring
Dave Love <fx@gnu.org>
parents:
diff changeset
1455
Dave Love <fx@gnu.org>
parents:
diff changeset
1456 In Insert or Replace state, these commands let the user
Dave Love <fx@gnu.org>
parents:
diff changeset
1457 peruse the history of insertion strings used in previous insert or replace
Dave Love <fx@gnu.org>
parents:
diff changeset
1458 commands. Try to hit @kbd{C-c M-p} or @kbd{C-c M-n} repeatedly and see what
Dave Love <fx@gnu.org>
parents:
diff changeset
1459 happens. @xref{Viper Specials}, for more.
Dave Love <fx@gnu.org>
parents:
diff changeset
1460
Dave Love <fx@gnu.org>
parents:
diff changeset
1461 In Vi state, these commands let the user peruse the history of Vi-style
Dave Love <fx@gnu.org>
parents:
diff changeset
1462 destructive commands, such as @kbd{dw}, @kbd{J}, @kbd{a}, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
1463 By repeatedly typing @kbd{C-c M-p} or @kbd{C-c M-n} you will cycle Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
1464 through the recent history of Vi commands, displaying the commands one by
Dave Love <fx@gnu.org>
parents:
diff changeset
1465 one. Once
Dave Love <fx@gnu.org>
parents:
diff changeset
1466 an appropriate command is found, it can be executed by typing `@kbd{.}'.
Dave Love <fx@gnu.org>
parents:
diff changeset
1467
Dave Love <fx@gnu.org>
parents:
diff changeset
1468 Since typing @kbd{C-c M-p} is tedious, it is more convenient to bind an
Dave Love <fx@gnu.org>
parents:
diff changeset
1469 appropriate function to a function key on the keyboard and use that key.
Dave Love <fx@gnu.org>
parents:
diff changeset
1470 @xref{Viper Specials}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
1471
Dave Love <fx@gnu.org>
parents:
diff changeset
1472 @item Ex commands
Dave Love <fx@gnu.org>
parents:
diff changeset
1473 @findex @kbd{:args}
Dave Love <fx@gnu.org>
parents:
diff changeset
1474 @findex @kbd{:n}
Dave Love <fx@gnu.org>
parents:
diff changeset
1475 @findex @kbd{:pwd}
Dave Love <fx@gnu.org>
parents:
diff changeset
1476 @findex @kbd{:pre}
Dave Love <fx@gnu.org>
parents:
diff changeset
1477 The commands @kbd{:args}, @kbd{:next}, @kbd{:pre} behave
Dave Love <fx@gnu.org>
parents:
diff changeset
1478 differently. @kbd{:pwd} exists to get current directory.
Dave Love <fx@gnu.org>
parents:
diff changeset
1479 The commands @kbd{:b} and @kbd{:B} switch buffers around. @xref{File and
Dave Love <fx@gnu.org>
parents:
diff changeset
1480 Buffer Handling}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
1481 There are also the new commands @kbd{:RelatedFile} and
Dave Love <fx@gnu.org>
parents:
diff changeset
1482 @kbd{PreviousRelatedFile} (which abbreviate to @kbd{R} and @kbd{P},
Dave Love <fx@gnu.org>
parents:
diff changeset
1483 respectively. @xref{Viper Specials}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
1484 @findex @kbd{:RelatedFile}
Dave Love <fx@gnu.org>
parents:
diff changeset
1485 @findex @kbd{:PreviousRelatedFile}
Dave Love <fx@gnu.org>
parents:
diff changeset
1486 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1487
Dave Love <fx@gnu.org>
parents:
diff changeset
1488 Apart from the new commands, many old commands have been enhanced. Most
Dave Love <fx@gnu.org>
parents:
diff changeset
1489 notably, Vi style macros are much more powerful in Viper than in Vi. @xref{Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
1490 Macros}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
1491
Dave Love <fx@gnu.org>
parents:
diff changeset
1492 @node Useful Packages, ,New Commands, Improvements over Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
1493 @section Useful Packages
Dave Love <fx@gnu.org>
parents:
diff changeset
1494
Dave Love <fx@gnu.org>
parents:
diff changeset
1495 Some Emacs packages are mentioned here as an aid to the new Viper user, to
Dave Love <fx@gnu.org>
parents:
diff changeset
1496 indicate what Viper is capable of.
Dave Love <fx@gnu.org>
parents:
diff changeset
1497 A vast number comes with the standard Emacs distribution, and many more exist
Dave Love <fx@gnu.org>
parents:
diff changeset
1498 on the net and on the archives.
Dave Love <fx@gnu.org>
parents:
diff changeset
1499
Dave Love <fx@gnu.org>
parents:
diff changeset
1500 This manual also mentions some Emacs features a new user
Dave Love <fx@gnu.org>
parents:
diff changeset
1501 should know about. The details of these are found in the GNU Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
1502 Manual.
Dave Love <fx@gnu.org>
parents:
diff changeset
1503
Dave Love <fx@gnu.org>
parents:
diff changeset
1504 The features first. For details, look up the Emacs Manual.
Dave Love <fx@gnu.org>
parents:
diff changeset
1505
Dave Love <fx@gnu.org>
parents:
diff changeset
1506 @table @samp
Dave Love <fx@gnu.org>
parents:
diff changeset
1507 @item Make
Dave Love <fx@gnu.org>
parents:
diff changeset
1508 @cindex make
Dave Love <fx@gnu.org>
parents:
diff changeset
1509 @cindex compiling
Dave Love <fx@gnu.org>
parents:
diff changeset
1510
Dave Love <fx@gnu.org>
parents:
diff changeset
1511 Makes and Compiles can be done from the editor. Error messages will be
Dave Love <fx@gnu.org>
parents:
diff changeset
1512 parsed and you can move to the error lines.
Dave Love <fx@gnu.org>
parents:
diff changeset
1513 @item Shell
Dave Love <fx@gnu.org>
parents:
diff changeset
1514 @cindex shell
Dave Love <fx@gnu.org>
parents:
diff changeset
1515 @cindex interactive shell
Dave Love <fx@gnu.org>
parents:
diff changeset
1516 You can talk to Shells from inside the editor. Your entire shell session
Dave Love <fx@gnu.org>
parents:
diff changeset
1517 can be treated as a file.
Dave Love <fx@gnu.org>
parents:
diff changeset
1518 @item Mail
Dave Love <fx@gnu.org>
parents:
diff changeset
1519 @cindex email
Dave Love <fx@gnu.org>
parents:
diff changeset
1520 @cindex mail
Dave Love <fx@gnu.org>
parents:
diff changeset
1521 Mail can be read from and sent within the editor. Several sophisticated
Dave Love <fx@gnu.org>
parents:
diff changeset
1522 packages exist.
Dave Love <fx@gnu.org>
parents:
diff changeset
1523 @item Language Sensitive Editing
Dave Love <fx@gnu.org>
parents:
diff changeset
1524 Editing modes are written for most computer languages in existence. By
Dave Love <fx@gnu.org>
parents:
diff changeset
1525 controlling indentation, they catch punctuation errors.
Dave Love <fx@gnu.org>
parents:
diff changeset
1526 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1527
Dave Love <fx@gnu.org>
parents:
diff changeset
1528 The packages, below, represents a drop in the sea of special-purpose
Dave Love <fx@gnu.org>
parents:
diff changeset
1529 packages that come with standard distribution of Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
1530
Dave Love <fx@gnu.org>
parents:
diff changeset
1531 @table @samp
Dave Love <fx@gnu.org>
parents:
diff changeset
1532 @item Transparent FTP
Dave Love <fx@gnu.org>
parents:
diff changeset
1533 @cindex transparent ftp
Dave Love <fx@gnu.org>
parents:
diff changeset
1534 @pindex ange-ftp.el
Dave Love <fx@gnu.org>
parents:
diff changeset
1535 @code{ange-ftp.el} can ftp from the editor to files on other machines
Dave Love <fx@gnu.org>
parents:
diff changeset
1536 transparent to the user.
Dave Love <fx@gnu.org>
parents:
diff changeset
1537 @item RCS Interfaces
Dave Love <fx@gnu.org>
parents:
diff changeset
1538 @cindex version maintenance
Dave Love <fx@gnu.org>
parents:
diff changeset
1539 @cindex RCS
Dave Love <fx@gnu.org>
parents:
diff changeset
1540 @pindex vc.el
Dave Love <fx@gnu.org>
parents:
diff changeset
1541 @code{vc.el} for doing RCS commands from inside the editor
Dave Love <fx@gnu.org>
parents:
diff changeset
1542 @item Directory Editor
Dave Love <fx@gnu.org>
parents:
diff changeset
1543 @cindex dired
Dave Love <fx@gnu.org>
parents:
diff changeset
1544 @pindex dired.el
Dave Love <fx@gnu.org>
parents:
diff changeset
1545 @code{dired.el} for editing contents of directories and for navigating in
Dave Love <fx@gnu.org>
parents:
diff changeset
1546 the file system.
Dave Love <fx@gnu.org>
parents:
diff changeset
1547 @item Syntactic Highlighting
Dave Love <fx@gnu.org>
parents:
diff changeset
1548 @cindex font-lock
Dave Love <fx@gnu.org>
parents:
diff changeset
1549 @pindex font-lock.el
Dave Love <fx@gnu.org>
parents:
diff changeset
1550 @code{font-lock.el} for automatic highlighting various parts of a buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1551 using different fonts and colors.
Dave Love <fx@gnu.org>
parents:
diff changeset
1552 @item Saving Emacs Configuration
Dave Love <fx@gnu.org>
parents:
diff changeset
1553 @cindex desktop
Dave Love <fx@gnu.org>
parents:
diff changeset
1554 @pindex desktop.el
Dave Love <fx@gnu.org>
parents:
diff changeset
1555 @code{desktop.el} for saving/restoring configuration on Emacs exit/startup.
Dave Love <fx@gnu.org>
parents:
diff changeset
1556 @item Spell Checker
Dave Love <fx@gnu.org>
parents:
diff changeset
1557 @cindex ispell
Dave Love <fx@gnu.org>
parents:
diff changeset
1558 @pindex ispell.el
Dave Love <fx@gnu.org>
parents:
diff changeset
1559 @code{ispell.el} for spell checking the buffer, words, regions, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
1560 @item File and Buffer Comparison
Dave Love <fx@gnu.org>
parents:
diff changeset
1561 @cindex ediff
Dave Love <fx@gnu.org>
parents:
diff changeset
1562 @pindex ediff.el
Dave Love <fx@gnu.org>
parents:
diff changeset
1563 @code{ediff.el} for finding differences between files and for applying
Dave Love <fx@gnu.org>
parents:
diff changeset
1564 patches.
Dave Love <fx@gnu.org>
parents:
diff changeset
1565 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1566
Dave Love <fx@gnu.org>
parents:
diff changeset
1567 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1568 Emacs Lisp archives exist on
Dave Love <fx@gnu.org>
parents:
diff changeset
1569 @samp{archive.cis.ohio-state.edu}
Dave Love <fx@gnu.org>
parents:
diff changeset
1570 and @samp{wuarchive.wustl.edu}@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1571
Dave Love <fx@gnu.org>
parents:
diff changeset
1572
Dave Love <fx@gnu.org>
parents:
diff changeset
1573 @node Customization,Commands,Improvements over Vi,Top
Dave Love <fx@gnu.org>
parents:
diff changeset
1574 @chapter Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
1575
Dave Love <fx@gnu.org>
parents:
diff changeset
1576 @cindex customization
Dave Love <fx@gnu.org>
parents:
diff changeset
1577
Dave Love <fx@gnu.org>
parents:
diff changeset
1578 Customization can be done in 2 ways.
Dave Love <fx@gnu.org>
parents:
diff changeset
1579
Dave Love <fx@gnu.org>
parents:
diff changeset
1580 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
1581 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1582 @cindex initialization
Dave Love <fx@gnu.org>
parents:
diff changeset
1583 @cindex .viper
Dave Love <fx@gnu.org>
parents:
diff changeset
1584 Elisp code in a @file{.viper} file in your home directory. Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
1585 loads @file{.viper} just before it does the binding for mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1586 hooks. This is the recommended method.
Dave Love <fx@gnu.org>
parents:
diff changeset
1587 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1588 @cindex .emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
1589 Elisp code in your @file{.emacs} file before and after the @code{(require
Dave Love <fx@gnu.org>
parents:
diff changeset
1590 'viper)} line. This method is not recommended, unless you know what you are
Dave Love <fx@gnu.org>
parents:
diff changeset
1591 doing. Only two variables, @code{viper-mode} and
Dave Love <fx@gnu.org>
parents:
diff changeset
1592 @code{viper-custom-file-name} are supposed to be customized in @file{.emacs},
Dave Love <fx@gnu.org>
parents:
diff changeset
1593 prior to loading Viper.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1594 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
1595
Dave Love <fx@gnu.org>
parents:
diff changeset
1596 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1597 Most of Viper's behavior can be customized via the interactive Emacs user
Dave Love <fx@gnu.org>
parents:
diff changeset
1598 interface. Choose "Customize" from the menubar, click on "Editing", then on
Dave Love <fx@gnu.org>
parents:
diff changeset
1599 "Emulations". The customization widget is self-explanatory. Once you are
Dave Love <fx@gnu.org>
parents:
diff changeset
1600 satisfied with your changes, save them into a file and then include the
Dave Love <fx@gnu.org>
parents:
diff changeset
1601 contents of that file in the Viper customization repository, @file{.viper}
Dave Love <fx@gnu.org>
parents:
diff changeset
1602 (except for @code{viper-mode} and @code{viper-custom-file-name}, which are
Dave Love <fx@gnu.org>
parents:
diff changeset
1603 supposed to go into @code{.emacs}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1604
Dave Love <fx@gnu.org>
parents:
diff changeset
1605 Some advanced customization cannot be accomplished this way, however, and
Dave Love <fx@gnu.org>
parents:
diff changeset
1606 has to be done in Emacs Lisp. For the common cases, examples are provided
Dave Love <fx@gnu.org>
parents:
diff changeset
1607 that you can use directly.
Dave Love <fx@gnu.org>
parents:
diff changeset
1608
Dave Love <fx@gnu.org>
parents:
diff changeset
1609 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1610 * Rudimentary Changes:: Simple constant definitions.
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38866
diff changeset
1611 * Key Bindings:: Enabling Emacs Keys, Rebinding keys, etc.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1612 * Packages that Change Keymaps:: How to deal with such beasts.
Dave Love <fx@gnu.org>
parents:
diff changeset
1613 * Viper Specials:: Special Viper commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
1614 * Vi Macros:: How to do Vi style macros.
Dave Love <fx@gnu.org>
parents:
diff changeset
1615 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1616
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38866
diff changeset
1617 @node Rudimentary Changes,Key Bindings,Customization,Customization
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1618 @section Rudimentary Changes
Dave Love <fx@gnu.org>
parents:
diff changeset
1619
Dave Love <fx@gnu.org>
parents:
diff changeset
1620 @cindex setting variables
Dave Love <fx@gnu.org>
parents:
diff changeset
1621 @cindex variables for customization
Dave Love <fx@gnu.org>
parents:
diff changeset
1622 @findex @kbd{:set}
Dave Love <fx@gnu.org>
parents:
diff changeset
1623
Dave Love <fx@gnu.org>
parents:
diff changeset
1624 An easy way to customize Viper is to change the values of constants used in
Dave Love <fx@gnu.org>
parents:
diff changeset
1625 Viper. Here is the list of the constants used in Viper and their default
Dave Love <fx@gnu.org>
parents:
diff changeset
1626 values. The corresponding :se command is also indicated. (The symbols
Dave Love <fx@gnu.org>
parents:
diff changeset
1627 @code{t} and @code{nil} represent ``true'' and ``false'' in Lisp).
Dave Love <fx@gnu.org>
parents:
diff changeset
1628
Dave Love <fx@gnu.org>
parents:
diff changeset
1629 Viper supports both the abbreviated Vi variable names and their full
Dave Love <fx@gnu.org>
parents:
diff changeset
1630 names. Variable completion is done on full names only. @key{TAB} and
Dave Love <fx@gnu.org>
parents:
diff changeset
1631 @key{SPC} complete
Dave Love <fx@gnu.org>
parents:
diff changeset
1632 variable names. Typing `=' will complete the name and then will prompt for
Dave Love <fx@gnu.org>
parents:
diff changeset
1633 a value, if applicable. For instance, @kbd{:se au @key{SPC}} will complete the
Dave Love <fx@gnu.org>
parents:
diff changeset
1634 command to @kbd{:set autoindent}; @kbd{:se ta @key{SPC}} will complete the command
Dave Love <fx@gnu.org>
parents:
diff changeset
1635 and prompt further like this: @kbd{:set tabstop = }.
Dave Love <fx@gnu.org>
parents:
diff changeset
1636 However, typing @kbd{:se ts @key{SPC}} will produce a ``No match'' message
Dave Love <fx@gnu.org>
parents:
diff changeset
1637 because @kbd{ts} is an abbreviation for @kbd{tabstop} and Viper supports
Dave Love <fx@gnu.org>
parents:
diff changeset
1638 completion on full names only. However, you can still hit @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
1639 or @kbd{=}, which will complete the command like this: @kbd{:set ts = } and
Dave Love <fx@gnu.org>
parents:
diff changeset
1640 Viper will be waiting for you to type a value for the tabstop variable.
Dave Love <fx@gnu.org>
parents:
diff changeset
1641 To get the full list of Vi variables, type @kbd{:se @key{SPC} @key{TAB}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1642
Dave Love <fx@gnu.org>
parents:
diff changeset
1643 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
1644 @item viper-auto-indent nil
Dave Love <fx@gnu.org>
parents:
diff changeset
1645 @itemx :se ai (:se autoindent)
Dave Love <fx@gnu.org>
parents:
diff changeset
1646 @itemx :se ai-g (:se autoindent-global)
Dave Love <fx@gnu.org>
parents:
diff changeset
1647 If @code{t}, enable auto indentation.
Dave Love <fx@gnu.org>
parents:
diff changeset
1648 by @key{RET}, @kbd{o} or @kbd{O} command.
Dave Love <fx@gnu.org>
parents:
diff changeset
1649
Dave Love <fx@gnu.org>
parents:
diff changeset
1650 @code{viper-auto-indent} is a local variable. To change the value globally, use
Dave Love <fx@gnu.org>
parents:
diff changeset
1651 @code{setq-default}. It may be useful for certain major modes to have their
Dave Love <fx@gnu.org>
parents:
diff changeset
1652 own values of @code{viper-auto-indent}. This can be achieved by using
Dave Love <fx@gnu.org>
parents:
diff changeset
1653 @code{setq} to change the local value of this variable in the hooks to the
Dave Love <fx@gnu.org>
parents:
diff changeset
1654 appropriate major modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
1655
Dave Love <fx@gnu.org>
parents:
diff changeset
1656 @kbd{:se ai} changes the value of @code{viper-auto-indent} in the current
Dave Love <fx@gnu.org>
parents:
diff changeset
1657 buffer only; @kbd{:se ai-g} does the same globally.
Dave Love <fx@gnu.org>
parents:
diff changeset
1658 @item viper-electric-mode t
Dave Love <fx@gnu.org>
parents:
diff changeset
1659 If not @code{nil}, auto-indentation becomes electric, which means that
Dave Love <fx@gnu.org>
parents:
diff changeset
1660 @key{RET}, @kbd{O}, and @kbd{o} indent cursor according to the current
Dave Love <fx@gnu.org>
parents:
diff changeset
1661 major mode. In the future, this variable may control additional electric
Dave Love <fx@gnu.org>
parents:
diff changeset
1662 features.
Dave Love <fx@gnu.org>
parents:
diff changeset
1663
Dave Love <fx@gnu.org>
parents:
diff changeset
1664 This is a local variable: @code{setq} changes the value of this variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1665 in the current buffer only. Use @code{setq-default} to change the value in
Dave Love <fx@gnu.org>
parents:
diff changeset
1666 all buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
1667 @item viper-case-fold-search nil
Dave Love <fx@gnu.org>
parents:
diff changeset
1668 @itemx :se ic (:se ignorecase)
Dave Love <fx@gnu.org>
parents:
diff changeset
1669 If not @code{nil}, search ignores cases.
Dave Love <fx@gnu.org>
parents:
diff changeset
1670 This can also be toggled by quickly hitting @kbd{/} twice.
Dave Love <fx@gnu.org>
parents:
diff changeset
1671 @item viper-re-search nil
Dave Love <fx@gnu.org>
parents:
diff changeset
1672 @itemx :se magic
Dave Love <fx@gnu.org>
parents:
diff changeset
1673 If not @code{nil}, search will use regular expressions; if @code{nil} then
Dave Love <fx@gnu.org>
parents:
diff changeset
1674 use vanilla search.
Dave Love <fx@gnu.org>
parents:
diff changeset
1675 This behavior can also be toggled by quickly hitting @kbd{/} trice.
Dave Love <fx@gnu.org>
parents:
diff changeset
1676 @item buffer-read-only
Dave Love <fx@gnu.org>
parents:
diff changeset
1677 @itemx :se ro (:se readonly)
Dave Love <fx@gnu.org>
parents:
diff changeset
1678 Set current buffer to read only. To change globally put
Dave Love <fx@gnu.org>
parents:
diff changeset
1679 @code{(setq-default buffer-read-only t)} in your @file{.emacs} file.
Dave Love <fx@gnu.org>
parents:
diff changeset
1680 @item blink-matching-paren t
Dave Love <fx@gnu.org>
parents:
diff changeset
1681 @itemx :se sm (:se showmatch)
Dave Love <fx@gnu.org>
parents:
diff changeset
1682 Show matching parens by blinking cursor.
Dave Love <fx@gnu.org>
parents:
diff changeset
1683 @item tab-width t (default setting via @code{setq-default})
Dave Love <fx@gnu.org>
parents:
diff changeset
1684 @itemx :se ts=value (:se tabstop=value)
Dave Love <fx@gnu.org>
parents:
diff changeset
1685 @itemx :se ts-g=value (:se tabstop-global=value)
Dave Love <fx@gnu.org>
parents:
diff changeset
1686 @code{tab-width} is a local variable that controls the width of the tab stops.
Dave Love <fx@gnu.org>
parents:
diff changeset
1687 To change the value globally, use @code{setq-default}; for local settings,
Dave Love <fx@gnu.org>
parents:
diff changeset
1688 use @code{setq}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1689
Dave Love <fx@gnu.org>
parents:
diff changeset
1690 The command @kbd{:se ts}
Dave Love <fx@gnu.org>
parents:
diff changeset
1691 sets the tab width in the current
Dave Love <fx@gnu.org>
parents:
diff changeset
1692 buffer only; it has no effect on other buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
1693
Dave Love <fx@gnu.org>
parents:
diff changeset
1694 The command @kbd{:se ts-g} sets tab width globally,
Dave Love <fx@gnu.org>
parents:
diff changeset
1695 for all buffers where the tab is not yet set locally,
Dave Love <fx@gnu.org>
parents:
diff changeset
1696 including the new buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
1697
Dave Love <fx@gnu.org>
parents:
diff changeset
1698 Note that typing @key{TAB} normally
Dave Love <fx@gnu.org>
parents:
diff changeset
1699 doesn't insert the tab, since this key is usually bound to
Dave Love <fx@gnu.org>
parents:
diff changeset
1700 a text-formatting function, @code{indent-for-tab-command} (which facilitates
Dave Love <fx@gnu.org>
parents:
diff changeset
1701 programming and document writing). Instead, the tab is inserted via the
Dave Love <fx@gnu.org>
parents:
diff changeset
1702 command @code{viper-insert-tab}, which is bound to @kbd{S-tab} (shift + tab).
Dave Love <fx@gnu.org>
parents:
diff changeset
1703
Dave Love <fx@gnu.org>
parents:
diff changeset
1704 On some non-windowing terminals, Shift doesn't modify the @key{TAB} key, so
Dave Love <fx@gnu.org>
parents:
diff changeset
1705 @kbd{S-tab} behaves as if it were @key{TAB}. In such a case, you will have
Dave Love <fx@gnu.org>
parents:
diff changeset
1706 to bind @code{viper-insert-tab} to some other convenient key.
Dave Love <fx@gnu.org>
parents:
diff changeset
1707
Dave Love <fx@gnu.org>
parents:
diff changeset
1708 @item viper-shift-width 8
Dave Love <fx@gnu.org>
parents:
diff changeset
1709 @itemx :se sw=value (:se shiftwidth=value)
Dave Love <fx@gnu.org>
parents:
diff changeset
1710 The number of columns shifted by @kbd{>} and @kbd{<} commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
1711 @item viper-search-wrap-around t
Dave Love <fx@gnu.org>
parents:
diff changeset
1712 @itemx :se ws (:se wrapscan)
Dave Love <fx@gnu.org>
parents:
diff changeset
1713 If not @code{nil}, search wraps around the end/beginning of buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1714 @item viper-search-scroll-threshold 2
Dave Love <fx@gnu.org>
parents:
diff changeset
1715 If search lands within this many lines of the window top or bottom, the
Dave Love <fx@gnu.org>
parents:
diff changeset
1716 window will be scrolled up or down by about 1/7-th of its size, to reveal
Dave Love <fx@gnu.org>
parents:
diff changeset
1717 the context. If the value is negative---don't scroll.
Dave Love <fx@gnu.org>
parents:
diff changeset
1718 @item viper-tags-file-name "TAGS"
Dave Love <fx@gnu.org>
parents:
diff changeset
1719 The name of the file used as the tag table.
Dave Love <fx@gnu.org>
parents:
diff changeset
1720 @item viper-re-query-replace nil
Dave Love <fx@gnu.org>
parents:
diff changeset
1721 If not @code{nil}, use reg-exp replace in query replace.
Dave Love <fx@gnu.org>
parents:
diff changeset
1722 @item viper-want-ctl-h-help nil
Dave Love <fx@gnu.org>
parents:
diff changeset
1723 If not @code{nil}, @kbd{C-h} is bound to @code{help-command};
Dave Love <fx@gnu.org>
parents:
diff changeset
1724 otherwise, @kbd{C-h} is bound as usual in Vi.
Dave Love <fx@gnu.org>
parents:
diff changeset
1725 @item viper-vi-style-in-minibuffer t
Dave Love <fx@gnu.org>
parents:
diff changeset
1726 If not @code{nil}, Viper provides a high degree of compatibility with Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
1727 insert mode when you type text in the Minibuffer; if @code{nil}, typing in
Dave Love <fx@gnu.org>
parents:
diff changeset
1728 the Minibuffer feels like plain Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
1729 @item viper-no-multiple-ESC t
Dave Love <fx@gnu.org>
parents:
diff changeset
1730 If you set this to @code{nil}, you can use @key{ESC} as Meta in Vi state.
Dave Love <fx@gnu.org>
parents:
diff changeset
1731 Normally, this is not necessary, since graphical displays have separate
Dave Love <fx@gnu.org>
parents:
diff changeset
1732 Meta keys (usually on each side of the space bar). On a dumb terminal, Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
1733 sets this variable to @code{twice}, which is almost like @code{nil}, except
Dave Love <fx@gnu.org>
parents:
diff changeset
1734 that double @key{ESC} beeps. This, too, lets @key{ESC} to be used as a Meta.
Dave Love <fx@gnu.org>
parents:
diff changeset
1735 @item viper-ESC-keyseq-timeout 200 on tty, 0 on windowing display
Dave Love <fx@gnu.org>
parents:
diff changeset
1736 Escape key sequences separated by this much delay (in milliseconds) are
Dave Love <fx@gnu.org>
parents:
diff changeset
1737 interpreted as command, ignoring the special meaning of @key{ESC} in
Dave Love <fx@gnu.org>
parents:
diff changeset
1738 VI. The default is suitable for most terminals. However, if your terminal
Dave Love <fx@gnu.org>
parents:
diff changeset
1739 is extremely slow, you might want to increase this slightly. You will know
Dave Love <fx@gnu.org>
parents:
diff changeset
1740 if your terminal is slow if the @key{ESC} key sequences emitted by the
Dave Love <fx@gnu.org>
parents:
diff changeset
1741 arrow keys are interpreted as separately typed characters (and thus the
Dave Love <fx@gnu.org>
parents:
diff changeset
1742 arrow keys won't work). Making this value too large will slow you down, so
Dave Love <fx@gnu.org>
parents:
diff changeset
1743 exercise restraint.
Dave Love <fx@gnu.org>
parents:
diff changeset
1744 @item viper-fast-keyseq-timeout 200
Dave Love <fx@gnu.org>
parents:
diff changeset
1745 Key sequences separated by this many milliseconds are treated as Vi-style
Dave Love <fx@gnu.org>
parents:
diff changeset
1746 keyboard macros. If the key sequence is defined as such a macro, it will be
Dave Love <fx@gnu.org>
parents:
diff changeset
1747 executed. Otherwise, it is processed as an ordinary sequence of typed keys.
Dave Love <fx@gnu.org>
parents:
diff changeset
1748
Dave Love <fx@gnu.org>
parents:
diff changeset
1749 Setting this variable too high may slow down your typing. Setting it too
Dave Love <fx@gnu.org>
parents:
diff changeset
1750 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
1751 @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
1752 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
1753 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
1754 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
1755 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
1756 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
1757 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
1758 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
1759 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
1760 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
1761 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
1762 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
1763 way suits you best.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1764 @item viper-ex-style-motion t
Dave Love <fx@gnu.org>
parents:
diff changeset
1765 Set this to @code{nil}, if you want @kbd{l,h} to cross
Dave Love <fx@gnu.org>
parents:
diff changeset
1766 lines, etc. @xref{Movement and Markers}, for more info.
Dave Love <fx@gnu.org>
parents:
diff changeset
1767 @item viper-ex-style-editing t
36340
1ca425b36c74 (Rudimentary Changes): Remove doubled `to'.
Gerd Moellmann <gerd@gnu.org>
parents: 36155
diff changeset
1768 Set this to @code{nil}, if you want
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1769 @kbd{C-h} and @key{DEL} to not stop
Dave Love <fx@gnu.org>
parents:
diff changeset
1770 at the beginning of a line in Insert state, @key{X} and @key{x} to delete
Dave Love <fx@gnu.org>
parents:
diff changeset
1771 characters across lines in Vi command state, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
1772 @item viper-ESC-moves-cursor-back t
Dave Love <fx@gnu.org>
parents:
diff changeset
1773 It t, cursor moves back 1 character when switching from insert state to vi
Dave Love <fx@gnu.org>
parents:
diff changeset
1774 state. If nil, the cursor stays where it was before the switch.
Dave Love <fx@gnu.org>
parents:
diff changeset
1775 @item viper-always t
Dave Love <fx@gnu.org>
parents:
diff changeset
1776 @code{t} means: leave it to Viper to decide when a buffer must be brought
Dave Love <fx@gnu.org>
parents:
diff changeset
1777 up in Vi state,
Dave Love <fx@gnu.org>
parents:
diff changeset
1778 Insert state, or Emacs state. This heuristics works well in virtually all
Dave Love <fx@gnu.org>
parents:
diff changeset
1779 cases. @code{nil} means you either has to invoke @code{viper-mode} manually
Dave Love <fx@gnu.org>
parents:
diff changeset
1780 for each buffer (or you can add @code{viper-mode} to the appropriate major mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1781 hooks using @code{viper-load-hook}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1782
Dave Love <fx@gnu.org>
parents:
diff changeset
1783 This option must be set in the file @file{~/.viper}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1784 @item viper-custom-file-name "~/.viper"
Dave Love <fx@gnu.org>
parents:
diff changeset
1785 File used for Viper-specific customization.
Dave Love <fx@gnu.org>
parents:
diff changeset
1786 Change this setting, if you want. Must be set in @file{.emacs} (not @file{.viper}!)
Dave Love <fx@gnu.org>
parents:
diff changeset
1787 before Viper is loaded. Note that you
Dave Love <fx@gnu.org>
parents:
diff changeset
1788 have to set it as a string inside double quotes.
Dave Love <fx@gnu.org>
parents:
diff changeset
1789 @item viper-spell-function 'ispell-region
Dave Love <fx@gnu.org>
parents:
diff changeset
1790 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
1791 @item viper-glob-function
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
1792 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
1793 symbols. This is platform-dependent. The default tries to set this variable
38866
662d4bf4871a Avoid saying "Unix" in a way that includes GNU.
Richard M. Stallman <rms@gnu.org>
parents: 38514
diff changeset
1794 to work with most shells, MS Windows, OS/2, etc. However, if it
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
1795 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
1796 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
1797 @file{viper-util.el} as examples.
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
1798
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
1799 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
1800 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
1801 commands, because file completion is a better mechanism.
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
1802 @findex @code{viper-glob-function}
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
1803
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1804 @item ex-cycle-other-window t
Dave Love <fx@gnu.org>
parents:
diff changeset
1805 If not @code{nil}, @kbd{:n} and @kbd{:b} will cycle through files in another
Dave Love <fx@gnu.org>
parents:
diff changeset
1806 window, if one exists.
Dave Love <fx@gnu.org>
parents:
diff changeset
1807 @item ex-cycle-through-non-files nil
Dave Love <fx@gnu.org>
parents:
diff changeset
1808 @kbd{:n} does not normally cycle through buffers. Set this to get
Dave Love <fx@gnu.org>
parents:
diff changeset
1809 buffers also.
Dave Love <fx@gnu.org>
parents:
diff changeset
1810 @item viper-want-emacs-keys-in-insert
Dave Love <fx@gnu.org>
parents:
diff changeset
1811 This is set to @code{nil} for user levels 1 and 2 and to @code{t} for user
Dave Love <fx@gnu.org>
parents:
diff changeset
1812 levels 3 and 4. Users who specify level 5 are allowed to set this variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1813 as they please (the default for this level is @code{t}). If set to
Dave Love <fx@gnu.org>
parents:
diff changeset
1814 @code{nil}, complete Vi compatibility is provided in Insert state. This is
Dave Love <fx@gnu.org>
parents:
diff changeset
1815 really not recommended, as this precludes you from using language-specific
Dave Love <fx@gnu.org>
parents:
diff changeset
1816 features provided by the major modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
1817 @item viper-want-emacs-keys-in-vi
Dave Love <fx@gnu.org>
parents:
diff changeset
1818 This is set to @code{nil} for user
Dave Love <fx@gnu.org>
parents:
diff changeset
1819 level 1 and to @code{t} for user levels 2--4.
Dave Love <fx@gnu.org>
parents:
diff changeset
1820 At level 5, users are allowed to set this variable as they please (the
Dave Love <fx@gnu.org>
parents:
diff changeset
1821 default for this level is @code{t}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1822 If set to @code{nil}, complete Vi compatibility is provided
Dave Love <fx@gnu.org>
parents:
diff changeset
1823 in Vi command state. Setting this to @code{nil} is really a bad idea,
Dave Love <fx@gnu.org>
parents:
diff changeset
1824 unless you are a novice, as this precludes the use
Dave Love <fx@gnu.org>
parents:
diff changeset
1825 of language-specific features provided by the major modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
1826 @item viper-keep-point-on-repeat t
Dave Love <fx@gnu.org>
parents:
diff changeset
1827 If not @code{nil}, point is not moved when the user repeats the previous
Dave Love <fx@gnu.org>
parents:
diff changeset
1828 command by typing `.' This is very useful for doing repeated changes with
Dave Love <fx@gnu.org>
parents:
diff changeset
1829 the @kbd{.} key.
Dave Love <fx@gnu.org>
parents:
diff changeset
1830 @item viper-repeat-from-history-key 'f12
Dave Love <fx@gnu.org>
parents:
diff changeset
1831 Prefix key used to invoke the macros @kbd{f12 1} and @kbd{f12 2} that repeat
Dave Love <fx@gnu.org>
parents:
diff changeset
1832 the second-last and the third-last destructive command.
Dave Love <fx@gnu.org>
parents:
diff changeset
1833 Both these macros are bound (as Viper macros) to
Dave Love <fx@gnu.org>
parents:
diff changeset
1834 @code{viper-repeat-from-history},
Dave Love <fx@gnu.org>
parents:
diff changeset
1835 which checks the second key by which it is invoked to see which of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1836 previous commands to invoke. Viper binds @kbd{f12 1} and @kbd{f12 2} only,
Dave Love <fx@gnu.org>
parents:
diff changeset
1837 but the user can bind more in @file{~/.viper}. @xref{Vi Macros}, for how to do
Dave Love <fx@gnu.org>
parents:
diff changeset
1838 this.
Dave Love <fx@gnu.org>
parents:
diff changeset
1839 @item viper-keep-point-on-undo nil
Dave Love <fx@gnu.org>
parents:
diff changeset
1840 If not @code{nil}, Viper tries to not move point when undoing commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
1841 Instead, it will briefly move the cursor to the place where change has
Dave Love <fx@gnu.org>
parents:
diff changeset
1842 taken place. However, if the undone piece of text is not seen in window,
Dave Love <fx@gnu.org>
parents:
diff changeset
1843 then point will be moved to the place where the change took place.
Dave Love <fx@gnu.org>
parents:
diff changeset
1844 Set it to @code{t} and see if you like it better.
Dave Love <fx@gnu.org>
parents:
diff changeset
1845 @item viper-delete-backwards-in-replace nil
Dave Love <fx@gnu.org>
parents:
diff changeset
1846 If not @code{nil}, @key{DEL} key will delete characters while moving the cursor
Dave Love <fx@gnu.org>
parents:
diff changeset
1847 backwards. If @code{nil}, the cursor will move backwards without deleting
Dave Love <fx@gnu.org>
parents:
diff changeset
1848 anything.
Dave Love <fx@gnu.org>
parents:
diff changeset
1849 @item viper-replace-overlay-face 'viper-replace-overlay-face
Dave Love <fx@gnu.org>
parents:
diff changeset
1850 On a graphical display, Viper highlights replacement regions instead of
Dave Love <fx@gnu.org>
parents:
diff changeset
1851 putting a @samp{$} at the end. This variable controls the so called
Dave Love <fx@gnu.org>
parents:
diff changeset
1852 @dfn{face} used to highlight the region.
Dave Love <fx@gnu.org>
parents:
diff changeset
1853
Dave Love <fx@gnu.org>
parents:
diff changeset
1854 By default, @code{viper-replace-overlay-face} underlines the replacement on
Dave Love <fx@gnu.org>
parents:
diff changeset
1855 monochrome displays and also lays a stipple over them. On color displays,
Dave Love <fx@gnu.org>
parents:
diff changeset
1856 replacement regions are highlighted with color.
Dave Love <fx@gnu.org>
parents:
diff changeset
1857
Dave Love <fx@gnu.org>
parents:
diff changeset
1858 If you know something about Emacs faces and don't like how Viper highlights
Dave Love <fx@gnu.org>
parents:
diff changeset
1859 replacement regions, you can change @code{viper-replace-overlay-face} by
Dave Love <fx@gnu.org>
parents:
diff changeset
1860 specifying a new face. (Emacs faces are described in the Emacs Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1861 reference.) On a color display, the following customization method is
Dave Love <fx@gnu.org>
parents:
diff changeset
1862 usually most effective:
Dave Love <fx@gnu.org>
parents:
diff changeset
1863 @example
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
1864 (set-face-foreground viper-replace-overlay-face "DarkSlateBlue")
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
1865 (set-face-background viper-replace-overlay-face "yellow")
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1866 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1867 For a complete list of colors available to you, evaluate the expression
Dave Love <fx@gnu.org>
parents:
diff changeset
1868 @code{(x-defined-colors)}. (Type it in the buffer @code{*scratch*} and then
Dave Love <fx@gnu.org>
parents:
diff changeset
1869 hit the @kbd{C-j} key.
Dave Love <fx@gnu.org>
parents:
diff changeset
1870
Dave Love <fx@gnu.org>
parents:
diff changeset
1871 @item viper-replace-overlay-cursor-color "Red"
Dave Love <fx@gnu.org>
parents:
diff changeset
1872 @vindex @code{viper-replace-overlay-cursor-color}
Dave Love <fx@gnu.org>
parents:
diff changeset
1873 Cursor color when it is inside the replacement region.
Dave Love <fx@gnu.org>
parents:
diff changeset
1874 This has effect only on color displays and only when Emacs runs as an X
Dave Love <fx@gnu.org>
parents:
diff changeset
1875 application.
Dave Love <fx@gnu.org>
parents:
diff changeset
1876 @item viper-insert-state-cursor-color nil
Dave Love <fx@gnu.org>
parents:
diff changeset
1877 @vindex @code{viper-insert-state-cursor-color}
Dave Love <fx@gnu.org>
parents:
diff changeset
1878 If set to a valid color, this will be the cursor color when Viper is in
Dave Love <fx@gnu.org>
parents:
diff changeset
1879 insert state.
Dave Love <fx@gnu.org>
parents:
diff changeset
1880 @item viper-replace-region-end-delimiter "$"
Dave Love <fx@gnu.org>
parents:
diff changeset
1881 A string used to mark the end of replacement regions. It is used only on
Dave Love <fx@gnu.org>
parents:
diff changeset
1882 TTYs or if @code{viper-use-replace-region-delimiters} is non-nil.
Dave Love <fx@gnu.org>
parents:
diff changeset
1883 @item viper-replace-region-start-delimiter ""
Dave Love <fx@gnu.org>
parents:
diff changeset
1884 A string used to mark the beginning of replacement regions. It is used
Dave Love <fx@gnu.org>
parents:
diff changeset
1885 only on TTYs or if @code{viper-use-replace-region-delimiters} is non-nil.
Dave Love <fx@gnu.org>
parents:
diff changeset
1886 @item viper-use-replace-region-delimiters
Dave Love <fx@gnu.org>
parents:
diff changeset
1887 If non-nil, Viper will always use @code{viper-replace-region-end-delimiter} and
Dave Love <fx@gnu.org>
parents:
diff changeset
1888 @code{viper-replace-region-start-delimiter} to delimit replacement regions,
Dave Love <fx@gnu.org>
parents:
diff changeset
1889 even on color displays (where this is unnecessary). By default, this
Dave Love <fx@gnu.org>
parents:
diff changeset
1890 variable is non-nil only on TTYs or monochrome displays.
Dave Love <fx@gnu.org>
parents:
diff changeset
1891 @item viper-allow-multiline-replace-regions t
Dave Love <fx@gnu.org>
parents:
diff changeset
1892 If non-nil, multi-line text replacement regions, such as those produced by
Dave Love <fx@gnu.org>
parents:
diff changeset
1893 commands @kbd{c55w}, @kbd{3C}, etc., will stay around until the user exits
Dave Love <fx@gnu.org>
parents:
diff changeset
1894 the replacement mode. In this variable is set to @code{nil}, Viper will
Dave Love <fx@gnu.org>
parents:
diff changeset
1895 emulate the standard Vi behavior, which supports only intra-line
Dave Love <fx@gnu.org>
parents:
diff changeset
1896 replacement regions (and multi-line replacement regions are deleted).
Dave Love <fx@gnu.org>
parents:
diff changeset
1897 @item viper-toggle-key "\C-z"
Dave Love <fx@gnu.org>
parents:
diff changeset
1898 Specifies the key used to switch from Emacs to Vi and back.
Dave Love <fx@gnu.org>
parents:
diff changeset
1899 Must be set in @file{.viper}. This variable can't be
Dave Love <fx@gnu.org>
parents:
diff changeset
1900 changed interactively after Viper is loaded.
Dave Love <fx@gnu.org>
parents:
diff changeset
1901
Dave Love <fx@gnu.org>
parents:
diff changeset
1902 In Insert state, this key acts as a temporary escape to Vi state, i.e., it
Dave Love <fx@gnu.org>
parents:
diff changeset
1903 will set Viper up so that the very next command will be executed as if it
Dave Love <fx@gnu.org>
parents:
diff changeset
1904 were typed in Vi state.
Dave Love <fx@gnu.org>
parents:
diff changeset
1905 @item viper-ESC-key "\e"
Dave Love <fx@gnu.org>
parents:
diff changeset
1906 Specifies the key used to escape from Insert/Replace states to Vi.
Dave Love <fx@gnu.org>
parents:
diff changeset
1907 Must be set in @file{.viper}. This variable cannot be
Dave Love <fx@gnu.org>
parents:
diff changeset
1908 changed interactively after Viper is loaded.
Dave Love <fx@gnu.org>
parents:
diff changeset
1909 @item viper-buffer-search-char nil
Dave Love <fx@gnu.org>
parents:
diff changeset
1910 Key used for buffer search. @xref{Viper Specials}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
1911 @item viper-surrounding-word-function 'viper-surrounding-word
Dave Love <fx@gnu.org>
parents:
diff changeset
1912 The value of this variable is a function name that is used to determine
Dave Love <fx@gnu.org>
parents:
diff changeset
1913 what constitutes a word clicked upon by the mouse. This is used by mouse
Dave Love <fx@gnu.org>
parents:
diff changeset
1914 search and insert.
Dave Love <fx@gnu.org>
parents:
diff changeset
1915 @item viper-search-face 'viper-search-face
Dave Love <fx@gnu.org>
parents:
diff changeset
1916 Variable that controls how search patterns are highlighted when they are
Dave Love <fx@gnu.org>
parents:
diff changeset
1917 found.
Dave Love <fx@gnu.org>
parents:
diff changeset
1918 @item viper-vi-state-hook nil
Dave Love <fx@gnu.org>
parents:
diff changeset
1919 List of parameterless functions to be run just after entering the Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
1920 command state.
Dave Love <fx@gnu.org>
parents:
diff changeset
1921 @item viper-insert-state-hook nil
Dave Love <fx@gnu.org>
parents:
diff changeset
1922 Same for Insert state. This hook is also run after entering Replace state.
Dave Love <fx@gnu.org>
parents:
diff changeset
1923 @item viper-replace-state-hook nil
Dave Love <fx@gnu.org>
parents:
diff changeset
1924 List of (parameterless) functions called just after entering Replace state
Dave Love <fx@gnu.org>
parents:
diff changeset
1925 (and after all @code{viper-insert-state-hook}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1926 @item viper-emacs-state-hook nil
Dave Love <fx@gnu.org>
parents:
diff changeset
1927 List of (parameterless) functions called just after switching from Vi state
Dave Love <fx@gnu.org>
parents:
diff changeset
1928 to Emacs state.
Dave Love <fx@gnu.org>
parents:
diff changeset
1929 @item viper-load-hook nil
Dave Love <fx@gnu.org>
parents:
diff changeset
1930 List of (parameterless) functions called just after loading Viper. This is
Dave Love <fx@gnu.org>
parents:
diff changeset
1931 the last chance to do customization before Viper is up and running.
Dave Love <fx@gnu.org>
parents:
diff changeset
1932 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1933 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1934 You can reset some of these constants in Viper with the Ex command @kbd{:set}
Dave Love <fx@gnu.org>
parents:
diff changeset
1935 (when so indicated in the table). Or you
Dave Love <fx@gnu.org>
parents:
diff changeset
1936 can include a line like this in your @file{.viper} file:
Dave Love <fx@gnu.org>
parents:
diff changeset
1937 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1938 (setq viper-case-fold-search t)
Dave Love <fx@gnu.org>
parents:
diff changeset
1939 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1940 @vindex @code{viper-auto-indent}
Dave Love <fx@gnu.org>
parents:
diff changeset
1941 @vindex @code{viper-electric-mode}
Dave Love <fx@gnu.org>
parents:
diff changeset
1942 @vindex @code{viper-case-fold-search}
Dave Love <fx@gnu.org>
parents:
diff changeset
1943 @vindex @code{viper-re-search}
Dave Love <fx@gnu.org>
parents:
diff changeset
1944 @vindex @code{viper-shift-width}
Dave Love <fx@gnu.org>
parents:
diff changeset
1945 @vindex @code{buffer-read-only}
Dave Love <fx@gnu.org>
parents:
diff changeset
1946 @vindex @code{viper-search-wrap-around}
Dave Love <fx@gnu.org>
parents:
diff changeset
1947 @vindex @code{viper-search-scroll-threshold}
Dave Love <fx@gnu.org>
parents:
diff changeset
1948 @vindex @code{viper-search-face}
Dave Love <fx@gnu.org>
parents:
diff changeset
1949 @vindex @code{viper-tags-file-name}
Dave Love <fx@gnu.org>
parents:
diff changeset
1950 @vindex @code{viper-re-query-replace}
Dave Love <fx@gnu.org>
parents:
diff changeset
1951 @vindex @code{viper-want-ctl-h-help}
Dave Love <fx@gnu.org>
parents:
diff changeset
1952 @vindex @code{viper-vi-style-in-minibuffer}
Dave Love <fx@gnu.org>
parents:
diff changeset
1953 @vindex @code{viper-no-multiple-ESC}
Dave Love <fx@gnu.org>
parents:
diff changeset
1954 @vindex @code{viper-always}
Dave Love <fx@gnu.org>
parents:
diff changeset
1955 @vindex @code{viper-ESC-keyseq-timeout}
Dave Love <fx@gnu.org>
parents:
diff changeset
1956 @vindex @code{viper-fast-keyseq-timeout}
Dave Love <fx@gnu.org>
parents:
diff changeset
1957 @vindex @code{viper-ex-style-motion}
Dave Love <fx@gnu.org>
parents:
diff changeset
1958 @vindex @code{viper-ex-style-editing}
Dave Love <fx@gnu.org>
parents:
diff changeset
1959 @vindex @code{viper-ESC-moves-cursor-back}
Dave Love <fx@gnu.org>
parents:
diff changeset
1960 @vindex @code{viper-custom-file-name}
Dave Love <fx@gnu.org>
parents:
diff changeset
1961 @vindex @code{viper-spell-function}
Dave Love <fx@gnu.org>
parents:
diff changeset
1962 @vindex @code{ex-cycle-other-window}
Dave Love <fx@gnu.org>
parents:
diff changeset
1963 @vindex @code{ex-cycle-through-non-files}
Dave Love <fx@gnu.org>
parents:
diff changeset
1964 @vindex @code{viper-want-emacs-keys-in-insert}
Dave Love <fx@gnu.org>
parents:
diff changeset
1965 @vindex @code{viper-want-emacs-keys-in-vi}
Dave Love <fx@gnu.org>
parents:
diff changeset
1966 @vindex @code{viper-keep-point-on-repeat}
Dave Love <fx@gnu.org>
parents:
diff changeset
1967 @vindex @code{viper-keep-point-on-undo}
Dave Love <fx@gnu.org>
parents:
diff changeset
1968 @vindex @code{viper-delete-backwards-in-replace}
Dave Love <fx@gnu.org>
parents:
diff changeset
1969 @vindex @code{viper-replace-overlay-face}
Dave Love <fx@gnu.org>
parents:
diff changeset
1970 @vindex @code{viper-replace-region-end-symbol}
Dave Love <fx@gnu.org>
parents:
diff changeset
1971 @vindex @code{viper-replace-region-start-symbol}
Dave Love <fx@gnu.org>
parents:
diff changeset
1972 @vindex @code{viper-allow-multiline-replace-regions}
Dave Love <fx@gnu.org>
parents:
diff changeset
1973 @vindex @code{viper-toggle-key}
Dave Love <fx@gnu.org>
parents:
diff changeset
1974 @vindex @code{viper-ESC-key}
Dave Love <fx@gnu.org>
parents:
diff changeset
1975 @vindex @code{viper-buffer-search-char}
Dave Love <fx@gnu.org>
parents:
diff changeset
1976 @vindex @code{viper-surrounding-word-function}
Dave Love <fx@gnu.org>
parents:
diff changeset
1977 @vindex @code{viper-vi-state-hook}
Dave Love <fx@gnu.org>
parents:
diff changeset
1978 @vindex @code{viper-insert-state-hook}
Dave Love <fx@gnu.org>
parents:
diff changeset
1979 @vindex @code{viper-replace-state-hook}
Dave Love <fx@gnu.org>
parents:
diff changeset
1980 @vindex @code{viper-emacs-state-hook}
Dave Love <fx@gnu.org>
parents:
diff changeset
1981
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38866
diff changeset
1982 @node Key Bindings, Packages that Change Keymaps, Rudimentary Changes,Customization
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38866
diff changeset
1983 @section Key Bindings
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38866
diff changeset
1984
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38866
diff changeset
1985 @cindex key bindings
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1986 @cindex keymaps
Dave Love <fx@gnu.org>
parents:
diff changeset
1987
Dave Love <fx@gnu.org>
parents:
diff changeset
1988 Viper lets you define hot keys, i.e., you can associate keyboard keys
Dave Love <fx@gnu.org>
parents:
diff changeset
1989 such as F1, Help, PgDn, etc., with Emacs Lisp functions (that may already
Dave Love <fx@gnu.org>
parents:
diff changeset
1990 exist or that you will write). Each key has a "preferred form" in
Dave Love <fx@gnu.org>
parents:
diff changeset
1991 Emacs. For instance, the Up key's preferred form is [up], the Help key's
Dave Love <fx@gnu.org>
parents:
diff changeset
1992 preferred form is [help], and the Undo key has the preferred form [f14].
Dave Love <fx@gnu.org>
parents:
diff changeset
1993 You can find out the preferred form of a key by typing @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
1994 describe-key-briefly} and then typing the key you want to know about.
Dave Love <fx@gnu.org>
parents:
diff changeset
1995
35188
94d46968a93f Don't say "X Windows". From Colin Walters <walters@cis.ohio-state.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 33679
diff changeset
1996 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
1997 so you can just type
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1998
Dave Love <fx@gnu.org>
parents:
diff changeset
1999 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2000 (global-set-key [f11] 'calendar) ; L1, Stop
Dave Love <fx@gnu.org>
parents:
diff changeset
2001 (global-set-key [f14] 'undo) ; L4, Undo
Dave Love <fx@gnu.org>
parents:
diff changeset
2002 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2003
Dave Love <fx@gnu.org>
parents:
diff changeset
2004 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2005 to bind L1 so it will invoke the Emacs Calendar and to bind L4 so it will
Dave Love <fx@gnu.org>
parents:
diff changeset
2006 undo changes.
Dave Love <fx@gnu.org>
parents:
diff changeset
2007 However, on a dumb terminal or in an Xterm window, even the standard arrow
Dave Love <fx@gnu.org>
parents:
diff changeset
2008 keys may
Dave Love <fx@gnu.org>
parents:
diff changeset
2009 not emit the right signals for Emacs to understand. To let Emacs know about
Dave Love <fx@gnu.org>
parents:
diff changeset
2010 those keys, you will have to find out which key sequences they emit
Dave Love <fx@gnu.org>
parents:
diff changeset
2011 by typing @kbd{C-q} and then the key (you should switch to Emacs state
Dave Love <fx@gnu.org>
parents:
diff changeset
2012 first). Then you can bind those sequences to their preferred forms using
Dave Love <fx@gnu.org>
parents:
diff changeset
2013 @code{function-key-map} as follows:
Dave Love <fx@gnu.org>
parents:
diff changeset
2014
Dave Love <fx@gnu.org>
parents:
diff changeset
2015 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2016 (cond ((string= (getenv "TERM") "xterm")
Dave Love <fx@gnu.org>
parents:
diff changeset
2017 (define-key function-key-map "\e[192z" [f11]) ; L1
Dave Love <fx@gnu.org>
parents:
diff changeset
2018 (define-key function-key-map "\e[195z" [f14]) ; L4, Undo
Dave Love <fx@gnu.org>
parents:
diff changeset
2019 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2020
Dave Love <fx@gnu.org>
parents:
diff changeset
2021 The above illustrates how to do this for Xterm. On VT100, you would have to
Dave Love <fx@gnu.org>
parents:
diff changeset
2022 replace "xterm" with "vt100" and also change the key sequences (the same
Dave Love <fx@gnu.org>
parents:
diff changeset
2023 key may emit different sequences on different types of terminals).
Dave Love <fx@gnu.org>
parents:
diff changeset
2024
Dave Love <fx@gnu.org>
parents:
diff changeset
2025 The above keys are global, so they are overwritten by the local maps
Dave Love <fx@gnu.org>
parents:
diff changeset
2026 defined by the major modes and by Viper itself. Therefore, if you wish to
Dave Love <fx@gnu.org>
parents:
diff changeset
2027 change a binding set by a major mode or by Viper, read this.
Dave Love <fx@gnu.org>
parents:
diff changeset
2028
Dave Love <fx@gnu.org>
parents:
diff changeset
2029 Viper users who wish to specify their own key bindings should be concerned
Dave Love <fx@gnu.org>
parents:
diff changeset
2030 only with the following three keymaps:
Dave Love <fx@gnu.org>
parents:
diff changeset
2031 @code{viper-vi-global-user-map} for Vi state commands,
Dave Love <fx@gnu.org>
parents:
diff changeset
2032 @code{viper-insert-global-user-map} for Insert state commands,
Dave Love <fx@gnu.org>
parents:
diff changeset
2033 and @code{viper-emacs-global-user-map} for Emacs state commands (note:
Dave Love <fx@gnu.org>
parents:
diff changeset
2034 customized bindings for Emacs state made to @code{viper-emacs-global-user-map}
Dave Love <fx@gnu.org>
parents:
diff changeset
2035 are @emph{not} inherited by Insert state).
Dave Love <fx@gnu.org>
parents:
diff changeset
2036
Dave Love <fx@gnu.org>
parents:
diff changeset
2037 For more information on Viper keymaps, see the header of the file
Dave Love <fx@gnu.org>
parents:
diff changeset
2038 @file{viper.el}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2039 If you wish to change a Viper binding, you can use the
Dave Love <fx@gnu.org>
parents:
diff changeset
2040 @code{define-key} command, to modify @code{viper-vi-global-user-map},
Dave Love <fx@gnu.org>
parents:
diff changeset
2041 @code{viper-insert-global-user-map}, and @code{viper-emacs-global-user-map}, as
Dave Love <fx@gnu.org>
parents:
diff changeset
2042 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
2043 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
2044 state.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2045
Dave Love <fx@gnu.org>
parents:
diff changeset
2046 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2047 If you want to
Dave Love <fx@gnu.org>
parents:
diff changeset
2048 bind a key, say @kbd{C-v}, to the function that scrolls
Dave Love <fx@gnu.org>
parents:
diff changeset
2049 page down and to make @kbd{0} display information on the current buffer,
Dave Love <fx@gnu.org>
parents:
diff changeset
2050 putting this in @file{.viper} will do the trick in Vi state:
Dave Love <fx@gnu.org>
parents:
diff changeset
2051 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2052 (define-key viper-vi-global-user-map "\C-v" 'scroll-down)
Dave Love <fx@gnu.org>
parents:
diff changeset
2053 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2054 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2055 To set a key globally,
Dave Love <fx@gnu.org>
parents:
diff changeset
2056 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2057 (define-key viper-emacs-global-user-map "\C-c m" 'smail)
Dave Love <fx@gnu.org>
parents:
diff changeset
2058 (define-key viper-vi-global-user-map "0" 'viper-info-on-file)
Dave Love <fx@gnu.org>
parents:
diff changeset
2059 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2060 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2061 Note, however, that this binding may be overwritten by other keymaps, since
Dave Love <fx@gnu.org>
parents:
diff changeset
2062 the global keymap has the lowest priority.
Dave Love <fx@gnu.org>
parents:
diff changeset
2063 To make sure that nothing will override a binding in Emacs state, you
Dave Love <fx@gnu.org>
parents:
diff changeset
2064 can write this:
Dave Love <fx@gnu.org>
parents:
diff changeset
2065 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2066 (define-key viper-emacs-global-user-map "\C-c m" 'smail)
Dave Love <fx@gnu.org>
parents:
diff changeset
2067 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2068 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2069 To customize the binding for @kbd{C-h} in Insert state:
Dave Love <fx@gnu.org>
parents:
diff changeset
2070 @example
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
2071 (define-key viper-insert-global-user-map "\C-h" 'my-del-backwards-function)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2072 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2073 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2074
Dave Love <fx@gnu.org>
parents:
diff changeset
2075 Each Emacs command key calls some lisp function. If you have enabled the
Dave Love <fx@gnu.org>
parents:
diff changeset
2076 Help, (@pxref{Rudimentary Changes}) @kbd{C-h k} will show you the function
Dave Love <fx@gnu.org>
parents:
diff changeset
2077 for each specific key; @kbd{C-h b} will show all bindings, and @kbd{C-h m}
Dave Love <fx@gnu.org>
parents:
diff changeset
2078 will provide information on the major mode in effect. If Help is not
Dave Love <fx@gnu.org>
parents:
diff changeset
2079 enabled, you can still get help in Vi state by prefixing the above commands
Dave Love <fx@gnu.org>
parents:
diff changeset
2080 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
2081 menu bar, if Emacs runs under X).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2082
Dave Love <fx@gnu.org>
parents:
diff changeset
2083 Viper users can also change bindings on a per major mode basis. As with
Dave Love <fx@gnu.org>
parents:
diff changeset
2084 global bindings, this can be done separately for each of the three main Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
2085 states. To this end, Viper provides the function
Dave Love <fx@gnu.org>
parents:
diff changeset
2086 @code{viper-modify-major-mode}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2087 @findex @code{viper-modify-major-mode}
Dave Love <fx@gnu.org>
parents:
diff changeset
2088
Dave Love <fx@gnu.org>
parents:
diff changeset
2089 To modify keys in Emacs state for @code{my-favorite-major-mode}, the user
Dave Love <fx@gnu.org>
parents:
diff changeset
2090 needs to create a sparse keymap, say, @code{my-fancy-map}, bind whatever
Dave Love <fx@gnu.org>
parents:
diff changeset
2091 keys necessary in that keymap, and put
Dave Love <fx@gnu.org>
parents:
diff changeset
2092
Dave Love <fx@gnu.org>
parents:
diff changeset
2093 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2094 (viper-modify-major-mode 'dired-mode 'emacs-state my-fancy-map)
Dave Love <fx@gnu.org>
parents:
diff changeset
2095 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2096
Dave Love <fx@gnu.org>
parents:
diff changeset
2097 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2098 in @file{~/.viper}. To do the same in Vi and Insert states, you should use
Dave Love <fx@gnu.org>
parents:
diff changeset
2099 @code{vi-state} and @code{insert-state}. Changes in Insert state are also
Dave Love <fx@gnu.org>
parents:
diff changeset
2100 in effect in Replace state. For instance, suppose that the user wants to
Dave Love <fx@gnu.org>
parents:
diff changeset
2101 use @kbd{dd} in Vi state under Dired mode to delete files, @kbd{u} to unmark
Dave Love <fx@gnu.org>
parents:
diff changeset
2102 files, etc. The following code in @file{~/.viper} will then do the job:
Dave Love <fx@gnu.org>
parents:
diff changeset
2103
Dave Love <fx@gnu.org>
parents:
diff changeset
2104 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2105 (setq my-dired-modifier-map (make-sparse-keymap))
Dave Love <fx@gnu.org>
parents:
diff changeset
2106 (define-key my-dired-modifier-map "dd" 'dired-flag-file-deletion)
Dave Love <fx@gnu.org>
parents:
diff changeset
2107 (define-key my-dired-modifier-map "u" 'dired-unmark)
Dave Love <fx@gnu.org>
parents:
diff changeset
2108 (viper-modify-major-mode 'dired-mode 'vi-state my-dired-modifier-map)
Dave Love <fx@gnu.org>
parents:
diff changeset
2109 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2110
Dave Love <fx@gnu.org>
parents:
diff changeset
2111 A Vi purist may want to modify Emacs state under Dired mode so that
Dave Love <fx@gnu.org>
parents:
diff changeset
2112 @kbd{k}, @kbd{l}, etc., will move around in directory buffers, as in
Dave Love <fx@gnu.org>
parents:
diff changeset
2113 Vi. Although this is not recommended, as these keys are bound to useful
Dave Love <fx@gnu.org>
parents:
diff changeset
2114 Dired functions, the trick can be accomplished via the following code:
Dave Love <fx@gnu.org>
parents:
diff changeset
2115
Dave Love <fx@gnu.org>
parents:
diff changeset
2116 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2117 (setq my-dired-vi-purist-map (make-sparse-keymap))
Dave Love <fx@gnu.org>
parents:
diff changeset
2118 (define-key my-dired-vi-purist-map "k" 'viper-previous-line)
Dave Love <fx@gnu.org>
parents:
diff changeset
2119 (define-key my-dired-vi-purist-map "l" 'viper-forward-char)
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
2120 (viper-modify-major-mode 'dired-mode 'emacs-state my-dired-vi-purist-map)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2121 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2122
Dave Love <fx@gnu.org>
parents:
diff changeset
2123 Yet another way to customize key bindings in a major mode is to edit the
Dave Love <fx@gnu.org>
parents:
diff changeset
2124 list @code{viper-major-mode-modifier-list} using the customization widget.
Dave Love <fx@gnu.org>
parents:
diff changeset
2125 @vindex @code{viper-major-mode-modifier-list}
Dave Love <fx@gnu.org>
parents:
diff changeset
2126 (This variable is in the Viper-misc customization group.)
Dave Love <fx@gnu.org>
parents:
diff changeset
2127 The elements of this list are triples of the form: (major-mode viper-state
Dave Love <fx@gnu.org>
parents:
diff changeset
2128 keymap), where the keymap contains bindings that are supposed to be active
Dave Love <fx@gnu.org>
parents:
diff changeset
2129 in the given major mode and the given viper-state.
Dave Love <fx@gnu.org>
parents:
diff changeset
2130
Dave Love <fx@gnu.org>
parents:
diff changeset
2131 Effects similar to key binding changes can be achieved by defining Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
2132 keyboard macros using the Ex commands @kbd{:map} and @kbd{:map!}. The
Dave Love <fx@gnu.org>
parents:
diff changeset
2133 difference is that multi-key Vi macros do not override the keys they are
Dave Love <fx@gnu.org>
parents:
diff changeset
2134 bound to, unless these keys are typed in quick succession. So, with macros,
Dave Love <fx@gnu.org>
parents:
diff changeset
2135 one can use the normal keys alongside with the macros. If per-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
2136 modifications are needed, the user can try both ways and see which one is
Dave Love <fx@gnu.org>
parents:
diff changeset
2137 more convenient.
Dave Love <fx@gnu.org>
parents:
diff changeset
2138 @findex @kbd{:map}
Dave Love <fx@gnu.org>
parents:
diff changeset
2139 @xref{Vi Macros}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
2140
Dave Love <fx@gnu.org>
parents:
diff changeset
2141 Note: in major modes that come up in @emph{Emacs state} by default, the
Dave Love <fx@gnu.org>
parents:
diff changeset
2142 aforesaid modifications may not take place immediately (but only after the
Dave Love <fx@gnu.org>
parents:
diff changeset
2143 buffer switches to some other Viper state and then back to Emacs state). To
Dave Love <fx@gnu.org>
parents:
diff changeset
2144 avoid this, one should add @code{viper-change-state-to-emacs} to an
Dave Love <fx@gnu.org>
parents:
diff changeset
2145 appropriate hook of that major mode. (Check the function
Dave Love <fx@gnu.org>
parents:
diff changeset
2146 @code{viper-set-hooks} in @file{viper.el} for examples.) However, if you
Dave Love <fx@gnu.org>
parents:
diff changeset
2147 have set @code{viper-always} to @code{t}, chances are that you won't need to
Dave Love <fx@gnu.org>
parents:
diff changeset
2148 perform the above procedure, because Viper will take care of most useful
Dave Love <fx@gnu.org>
parents:
diff changeset
2149 defaults.
Dave Love <fx@gnu.org>
parents:
diff changeset
2150
Dave Love <fx@gnu.org>
parents:
diff changeset
2151
Dave Love <fx@gnu.org>
parents:
diff changeset
2152 Finally, Viper has a facility that lets the user define per-buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
2153 bindings, i.e., bindings that are in effect in some specific buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
2154 only. Unlike per-mode bindings described above, per-buffer bindings can be
Dave Love <fx@gnu.org>
parents:
diff changeset
2155 defined based on considerations other than the major mode. This is done
Dave Love <fx@gnu.org>
parents:
diff changeset
2156 via the function @code{viper-add-local-keys}, which lets one specify bindings
Dave Love <fx@gnu.org>
parents:
diff changeset
2157 that should be in effect in the current buffer only and for a specific Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
2158 state. For instance,
Dave Love <fx@gnu.org>
parents:
diff changeset
2159 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2160 (viper-add-local-keys 'vi-state '(("ZZ" .@: TeX-command-master)
Dave Love <fx@gnu.org>
parents:
diff changeset
2161 ("ZQ" .@: viper-save-kill-buffer)))
Dave Love <fx@gnu.org>
parents:
diff changeset
2162 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2163 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2164 redefines @kbd{ZZ} to invoke @code{TeX-command-master} in @code{vi-state}
Dave Love <fx@gnu.org>
parents:
diff changeset
2165 and @kbd{ZQ} to save-then-kill the current buffer. These bindings take
Dave Love <fx@gnu.org>
parents:
diff changeset
2166 effect only in the buffer where this command is executed. The typical use
Dave Love <fx@gnu.org>
parents:
diff changeset
2167 of this function is to execute the above expression from within a function
Dave Love <fx@gnu.org>
parents:
diff changeset
2168 that is included in a hook to some major mode. For instance, the above
Dave Love <fx@gnu.org>
parents:
diff changeset
2169 expression
Dave Love <fx@gnu.org>
parents:
diff changeset
2170 could be called from a function, @code{my-tex-init}, which may be added to
Dave Love <fx@gnu.org>
parents:
diff changeset
2171 @code{tex-mode-hook} as follows:
Dave Love <fx@gnu.org>
parents:
diff changeset
2172 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2173 (add-hook 'tex-mode-hook 'my-tex-init)
Dave Love <fx@gnu.org>
parents:
diff changeset
2174 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2175 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2176 When TeX mode starts, the hook is executed and the above Lisp expression is
Dave Love <fx@gnu.org>
parents:
diff changeset
2177 evaluated. Then, the bindings for @kbd{ZZ} and @kbd{ZQ} are changed in Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
2178 command mode for all buffers in TeX mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
2179
Dave Love <fx@gnu.org>
parents:
diff changeset
2180 Another useful application is to bind @kbd{ZZ} to @code{send-mail}
Dave Love <fx@gnu.org>
parents:
diff changeset
2181 in the Mail mode buffers (the specifics of this depend on which mail
Dave Love <fx@gnu.org>
parents:
diff changeset
2182 package you are using, @code{rmail}, @code{mh-e}, @code{vm}, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
2183 For instance, here is how to do this for @code{mh-e}, the Emacs interface
Dave Love <fx@gnu.org>
parents:
diff changeset
2184 to MH:
Dave Love <fx@gnu.org>
parents:
diff changeset
2185 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2186 (defun mh-add-vi-keys ()
Dave Love <fx@gnu.org>
parents:
diff changeset
2187 "Set up ZZ for MH-e and XMH."
Dave Love <fx@gnu.org>
parents:
diff changeset
2188 (viper-add-local-keys 'vi-state '(("ZZ" .@: mh-send-letter))))
Dave Love <fx@gnu.org>
parents:
diff changeset
2189 (add-hook 'mh-letter-mode-hook 'mh-add-vi-keys)
Dave Love <fx@gnu.org>
parents:
diff changeset
2190 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2191
Dave Love <fx@gnu.org>
parents:
diff changeset
2192 You can also use @code{viper-add-local-keys} to set per buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
2193 bindings in Insert state and Emacs state by passing as a parameter the
Dave Love <fx@gnu.org>
parents:
diff changeset
2194 symbols @code{insert-state} and @code{emacs-state}, respectively.
Dave Love <fx@gnu.org>
parents:
diff changeset
2195 As with global bindings, customized local bindings done to Emacs state
Dave Love <fx@gnu.org>
parents:
diff changeset
2196 are not inherited by Insert state.
Dave Love <fx@gnu.org>
parents:
diff changeset
2197
Dave Love <fx@gnu.org>
parents:
diff changeset
2198 On rare occasions, local keys may be added by mistake. Usually this is done
Dave Love <fx@gnu.org>
parents:
diff changeset
2199 indirectly, by invoking a major mode that adds local keys (e.g.,
Dave Love <fx@gnu.org>
parents:
diff changeset
2200 @code{shell-mode} redefines @key{RET}). In such a case, exiting the wrong
Dave Love <fx@gnu.org>
parents:
diff changeset
2201 major mode won't rid you from unwanted local keys, since these keys are
Dave Love <fx@gnu.org>
parents:
diff changeset
2202 local to Viper state and the current buffer, not to the major mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
2203 In such situations, the remedy is to type @kbd{M-x viper-zap-local-keys}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2204
Dave Love <fx@gnu.org>
parents:
diff changeset
2205 So much about Viper-specific bindings.
Dave Love <fx@gnu.org>
parents:
diff changeset
2206 @xref{Customization,,Customization,emacs,The GNU Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
2207 Manual}, and the Emacs quick reference card for the general info on key
Dave Love <fx@gnu.org>
parents:
diff changeset
2208 bindings in Emacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
2209
Dave Love <fx@gnu.org>
parents:
diff changeset
2210 @vindex @code{function-key-map}
Dave Love <fx@gnu.org>
parents:
diff changeset
2211 @vindex @code{viper-vi-global-user-map}
Dave Love <fx@gnu.org>
parents:
diff changeset
2212 @vindex @code{viper-insert-global-user-map}
Dave Love <fx@gnu.org>
parents:
diff changeset
2213 @vindex @code{viper-emacs-global-user-map}
Dave Love <fx@gnu.org>
parents:
diff changeset
2214 @findex @code{viper-add-local-keys}
Dave Love <fx@gnu.org>
parents:
diff changeset
2215 @findex @code{viper-zap-local-keys}
Dave Love <fx@gnu.org>
parents:
diff changeset
2216
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38866
diff changeset
2217 @node Packages that Change Keymaps,Viper Specials,Key Bindings,Customization
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2218 @subsection Packages that Change Keymaps
Dave Love <fx@gnu.org>
parents:
diff changeset
2219 @cindex C-c and Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
2220 @cindex Viper and C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
2221
Dave Love <fx@gnu.org>
parents:
diff changeset
2222 Viper is designed to coexist with all major and minor modes of Emacs. This
Dave Love <fx@gnu.org>
parents:
diff changeset
2223 means that bindings set by those modes are generally available with Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
2224 (unless you explicitly prohibit them by setting
Dave Love <fx@gnu.org>
parents:
diff changeset
2225 @code{viper-want-emacs-keys-in-vi} and @code{viper-want-emacs-keys-in-insert} to
Dave Love <fx@gnu.org>
parents:
diff changeset
2226 @code{nil}).
Dave Love <fx@gnu.org>
parents:
diff changeset
2227 If @code{viper-always} is set to @code{t}, Viper will try to bring each buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
2228 in the Viper state that is most appropriate for that buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
2229 Usually, this would be the Vi state, but sometimes it could be the Insert
Dave Love <fx@gnu.org>
parents:
diff changeset
2230 state or the Emacs state.
Dave Love <fx@gnu.org>
parents:
diff changeset
2231
Dave Love <fx@gnu.org>
parents:
diff changeset
2232 Some major mode bindings will necessarily be overwritten by Viper. Indeed, in
Dave Love <fx@gnu.org>
parents:
diff changeset
2233 Vi state, most of the 1-character keys are used for Vi-style editing. This
Dave Love <fx@gnu.org>
parents:
diff changeset
2234 usually causes no problems because most packages designed for editing files
Dave Love <fx@gnu.org>
parents:
diff changeset
2235 typically do not bind such keys. Instead, they use key sequences that start
Dave Love <fx@gnu.org>
parents:
diff changeset
2236 with @kbd{C-x} and @kbd{C-c}. This is why it was so important for us to
Dave Love <fx@gnu.org>
parents:
diff changeset
2237 free up @kbd{C-x} and @kbd{C-c}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2238 It is common for language-specific major modes to bind @key{TAB} and
Dave Love <fx@gnu.org>
parents:
diff changeset
2239 @kbd{C-j} (the line feed) keys to various formatting functions. This is
Dave Love <fx@gnu.org>
parents:
diff changeset
2240 extremely useful, but may require some getting used to for a Vi user. If you
Dave Love <fx@gnu.org>
parents:
diff changeset
2241 decide that this feature is not for you, you can re-bind these keys as
Dave Love <fx@gnu.org>
parents:
diff changeset
2242 explained earlier (@pxref{Customization}).
Dave Love <fx@gnu.org>
parents:
diff changeset
2243
Dave Love <fx@gnu.org>
parents:
diff changeset
2244 Binding for @key{TAB} is one of the most unusual aspects of Viper for many
Dave Love <fx@gnu.org>
parents:
diff changeset
2245 novice users. In Emacs, @key{TAB} is used to format text and programs, and
Dave Love <fx@gnu.org>
parents:
diff changeset
2246 is extremely useful. For instance, hitting @key{TAB} causes the current
Dave Love <fx@gnu.org>
parents:
diff changeset
2247 line to be re-indented in accordance with the context. In programming,
Dave Love <fx@gnu.org>
parents:
diff changeset
2248 this is very important, since improper automatic indentation would
Dave Love <fx@gnu.org>
parents:
diff changeset
2249 immediately alert the programmer to a possible error. For instance, if a
Dave Love <fx@gnu.org>
parents:
diff changeset
2250 @kbd{)} or a @kbd{"} is missing somewhere above the current
Dave Love <fx@gnu.org>
parents:
diff changeset
2251 line, @key{TAB} is likely to mis-indent the line.
Dave Love <fx@gnu.org>
parents:
diff changeset
2252
Dave Love <fx@gnu.org>
parents:
diff changeset
2253 For this reason, Viper doesn't change the standard Emacs binding of
Dave Love <fx@gnu.org>
parents:
diff changeset
2254 @key{TAB}, thereby sacrificing Vi compatibility
Dave Love <fx@gnu.org>
parents:
diff changeset
2255 (except for users at level 1). Instead, in Viper, the key
Dave Love <fx@gnu.org>
parents:
diff changeset
2256 @kbd{S-tab} (shift+ tab) is chosen to emulate Vi's @key{TAB}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2257
Dave Love <fx@gnu.org>
parents:
diff changeset
2258 We should note that on some non-windowing terminals, Shift doesn't modify
Dave Love <fx@gnu.org>
parents:
diff changeset
2259 the @key{TAB} key, so @kbd{S-tab} behaves as if it were @key{TAB}. In such
Dave Love <fx@gnu.org>
parents:
diff changeset
2260 a case, you will have to bind @code{viper-insert-tab} to some other
Dave Love <fx@gnu.org>
parents:
diff changeset
2261 convenient key.
Dave Love <fx@gnu.org>
parents:
diff changeset
2262
Dave Love <fx@gnu.org>
parents:
diff changeset
2263 Some packages, notably Dired, Gnus, Info, etc., attach special meaning to
Dave Love <fx@gnu.org>
parents:
diff changeset
2264 common keys like @key{SPC}, @kbd{x}, @kbd{d}, @kbd{v}, and others. This
Dave Love <fx@gnu.org>
parents:
diff changeset
2265 means that Vi command state is inappropriate for working with these
Dave Love <fx@gnu.org>
parents:
diff changeset
2266 packages. Fortunately, these modes operate on read-only buffers and are
Dave Love <fx@gnu.org>
parents:
diff changeset
2267 designed not for editing files, but for special-purpose browsing, reading
Dave Love <fx@gnu.org>
parents:
diff changeset
2268 news, mail, etc., and Vi commands are meaningless in these situations. For
Dave Love <fx@gnu.org>
parents:
diff changeset
2269 this reason, Viper doesn't force Vi state on such major modes---it
Dave Love <fx@gnu.org>
parents:
diff changeset
2270 brings them in Emacs state. You can switch to Vi state by typing @kbd{C-z}
Dave Love <fx@gnu.org>
parents:
diff changeset
2271 if, for instance, you want to do Vi-style search in a buffer (although,
Dave Love <fx@gnu.org>
parents:
diff changeset
2272 usually, incremental search, which is bound to @kbd{C-s}, is sufficient in
Dave Love <fx@gnu.org>
parents:
diff changeset
2273 these situations). But you should then switch back to Emacs state if you
Dave Love <fx@gnu.org>
parents:
diff changeset
2274 plan to continue using these major modes productively. You can also switch
Dave Love <fx@gnu.org>
parents:
diff changeset
2275 to Vi temporarily, to execute just one command. This is done by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
2276 @kbd{C-c \}. (In some of these modes, @kbd{/} and @kbd{:} are bound
Dave Love <fx@gnu.org>
parents:
diff changeset
2277 Vi-style, unless these keys perform essential duties.)
Dave Love <fx@gnu.org>
parents:
diff changeset
2278
Dave Love <fx@gnu.org>
parents:
diff changeset
2279 If you would like certain major modes to come up in Emacs state rather than
Dave Love <fx@gnu.org>
parents:
diff changeset
2280 Vi state (but Viper thinks otherwise), you should put these major modes
Dave Love <fx@gnu.org>
parents:
diff changeset
2281 on the @code{viper-emacs-state-mode-list} list and delete them from
Dave Love <fx@gnu.org>
parents:
diff changeset
2282 @code{viper-vi-state-mode-list}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2283 Likewise, you can force Viper's Insert state on a major mode by putting it
Dave Love <fx@gnu.org>
parents:
diff changeset
2284 in @code{viper-insert-state-mode-list}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2285 @vindex @code{viper-emacs-state-mode-list}
Dave Love <fx@gnu.org>
parents:
diff changeset
2286 @vindex @code{viper-insert-state-mode-list}
Dave Love <fx@gnu.org>
parents:
diff changeset
2287 @vindex @code{viper-vi-state-mode-list}
Dave Love <fx@gnu.org>
parents:
diff changeset
2288
Dave Love <fx@gnu.org>
parents:
diff changeset
2289 It is also possible to impose Vi on some major modes, even though they may
Dave Love <fx@gnu.org>
parents:
diff changeset
2290 bind common keys to specialized commands. This might make sense for modes
Dave Love <fx@gnu.org>
parents:
diff changeset
2291 that bind only a small number of common keys. For instance, Viper subverts
Dave Love <fx@gnu.org>
parents:
diff changeset
2292 the Shell mode by changing the bindings for @kbd{C-m} and @kbd{C-d} using
Dave Love <fx@gnu.org>
parents:
diff changeset
2293 @code{viper-add-local-keys} described in section on customization
Dave Love <fx@gnu.org>
parents:
diff changeset
2294 (@pxref{Customization}).
Dave Love <fx@gnu.org>
parents:
diff changeset
2295
Dave Love <fx@gnu.org>
parents:
diff changeset
2296 In some cases, some @emph{minor} modes might override certain essential
Dave Love <fx@gnu.org>
parents:
diff changeset
2297 bindings in Vi command state. This is not a big priblem because this
Dave Love <fx@gnu.org>
parents:
diff changeset
2298 can happen only in the beginning, when the minor mode kicks in. Typing
Dave Love <fx@gnu.org>
parents:
diff changeset
2299 @code{M-x viper-mode} will correct the situation. Viper knows about
Dave Love <fx@gnu.org>
parents:
diff changeset
2300 several such minor modes and takes care of them, so the above trick
Dave Love <fx@gnu.org>
parents:
diff changeset
2301 is usually not necessary. If you find that some minor mode, e.g.,
Dave Love <fx@gnu.org>
parents:
diff changeset
2302 @code{nasty-mode.el} interferes with Viper, putting the following in
Dave Love <fx@gnu.org>
parents:
diff changeset
2303 @file{.viper} should fix the problem:
Dave Love <fx@gnu.org>
parents:
diff changeset
2304 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2305 (viper-harness-minor-mode "nasty-mode")
Dave Love <fx@gnu.org>
parents:
diff changeset
2306 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2307 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2308 The argument to @code{viper-harness-minor-mode} is the name of the file for the
Dave Love <fx@gnu.org>
parents:
diff changeset
2309 offending minor mode with the suffixes @file{.el} and @file{.elc} removed.
Dave Love <fx@gnu.org>
parents:
diff changeset
2310
Dave Love <fx@gnu.org>
parents:
diff changeset
2311 It may not be always obvious which minor mode is at fault. The only
Dave Love <fx@gnu.org>
parents:
diff changeset
2312 guidance here is to look into the file that defines the minor mode you are
Dave Love <fx@gnu.org>
parents:
diff changeset
2313 suspecting, say @code{nasty-mode.el}, and see if it has a variable called
Dave Love <fx@gnu.org>
parents:
diff changeset
2314 @code{nasty-mode-map}. Then check if there is a statement of the form
Dave Love <fx@gnu.org>
parents:
diff changeset
2315 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2316 (define-key nasty-mode-map key function)
Dave Love <fx@gnu.org>
parents:
diff changeset
2317 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2318 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2319 that binds the misbehaving
Dave Love <fx@gnu.org>
parents:
diff changeset
2320 keys. If so, use the above line to harness @code{nasty-mode}. If your
Dave Love <fx@gnu.org>
parents:
diff changeset
2321 suspicion is wrong, no harm is done if you harness a minor mode that
Dave Love <fx@gnu.org>
parents:
diff changeset
2322 doesn't need to be harnessed.
Dave Love <fx@gnu.org>
parents:
diff changeset
2323
Dave Love <fx@gnu.org>
parents:
diff changeset
2324 @vindex @code{viper-want-emacs-keys-in-vi}
Dave Love <fx@gnu.org>
parents:
diff changeset
2325 @vindex @code{viper-want-emacs-keys-in-insert}
Dave Love <fx@gnu.org>
parents:
diff changeset
2326 @vindex @code{viper-always}
Dave Love <fx@gnu.org>
parents:
diff changeset
2327 @findex @code{viper-set-hooks}
Dave Love <fx@gnu.org>
parents:
diff changeset
2328 @findex @code{viper-mode}
Dave Love <fx@gnu.org>
parents:
diff changeset
2329 @findex @code{viper-harness-minor-mode}
Dave Love <fx@gnu.org>
parents:
diff changeset
2330 @findex @code{remove-hook}
Dave Love <fx@gnu.org>
parents:
diff changeset
2331 @findex @code{add-hook}
Dave Love <fx@gnu.org>
parents:
diff changeset
2332
Dave Love <fx@gnu.org>
parents:
diff changeset
2333 @node Viper Specials,Vi Macros,Packages that Change Keymaps,Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
2334 @section Viper Specials
Dave Love <fx@gnu.org>
parents:
diff changeset
2335
Dave Love <fx@gnu.org>
parents:
diff changeset
2336 Viper extends Vi with a number of useful features. This includes various
Dave Love <fx@gnu.org>
parents:
diff changeset
2337 search functions, histories of search strings, Ex commands, insertions, and
Dave Love <fx@gnu.org>
parents:
diff changeset
2338 Vi's destructive commands. In addition, Viper supports file name completion
Dave Love <fx@gnu.org>
parents:
diff changeset
2339 and history, completion of Ex commands and variables, and many other
Dave Love <fx@gnu.org>
parents:
diff changeset
2340 features. Some of these features are explained in detail elsewhere in this
Dave Love <fx@gnu.org>
parents:
diff changeset
2341 document. Other features are explained here.
Dave Love <fx@gnu.org>
parents:
diff changeset
2342
Dave Love <fx@gnu.org>
parents:
diff changeset
2343 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
2344 @item (viper-buffer-search-enable)
Dave Love <fx@gnu.org>
parents:
diff changeset
2345 @item viper-buffer-search-char nil
Dave Love <fx@gnu.org>
parents:
diff changeset
2346 Enable buffer search. Explicit call to @code{viper-buffer-search-enable}
Dave Love <fx@gnu.org>
parents:
diff changeset
2347 sets @code{viper-buffer-search-char} to @kbd{g}. Alternatively, the user can
Dave Love <fx@gnu.org>
parents:
diff changeset
2348 set @code{viper-buffer-search-char} in @file{.viper} to a key sequence
Dave Love <fx@gnu.org>
parents:
diff changeset
2349 to be used for buffer search. There is no need to call
Dave Love <fx@gnu.org>
parents:
diff changeset
2350 @code{viper-buffer-search-enable} in that case.
Dave Love <fx@gnu.org>
parents:
diff changeset
2351 @findex @code{viper-buffer-search-enable}
Dave Love <fx@gnu.org>
parents:
diff changeset
2352 @vindex @code{viper-buffer-search-char}
Dave Love <fx@gnu.org>
parents:
diff changeset
2353 @item viper-toggle-search-style
Dave Love <fx@gnu.org>
parents:
diff changeset
2354 This function, bound to @kbd{C-c /}, lets one toggle case-sensitive and
Dave Love <fx@gnu.org>
parents:
diff changeset
2355 case-insensitive search, and also switch between plain vanilla search and
Dave Love <fx@gnu.org>
parents:
diff changeset
2356 search via regular expressions. Without the prefix argument, the user is
Dave Love <fx@gnu.org>
parents:
diff changeset
2357 asked which mode to toggle. With prefix argument 1, this toggles
Dave Love <fx@gnu.org>
parents:
diff changeset
2358 case-sensitivity. With prefix argument 2, regular expression/vanilla search
Dave Love <fx@gnu.org>
parents:
diff changeset
2359 will be toggled.
Dave Love <fx@gnu.org>
parents:
diff changeset
2360
Dave Love <fx@gnu.org>
parents:
diff changeset
2361 However, we found that the most convenient way to toggle
Dave Love <fx@gnu.org>
parents:
diff changeset
2362 these options is to bind a Vi macro to
Dave Love <fx@gnu.org>
parents:
diff changeset
2363 bind @kbd{//} to toggles case sensitivity and to @kbd{///} to toggles
Dave Love <fx@gnu.org>
parents:
diff changeset
2364 vanilla search. Thus, quickly hitting @kbd{/} twice will switch Viper from
Dave Love <fx@gnu.org>
parents:
diff changeset
2365 case sensitive search to case-insensitive. Repeating this once again will
Dave Love <fx@gnu.org>
parents:
diff changeset
2366 restore the original state. Likewise, quickly hitting @kbd{/} three times
Dave Love <fx@gnu.org>
parents:
diff changeset
2367 will switch you from vanilla-style search to search via regular expressions.
Dave Love <fx@gnu.org>
parents:
diff changeset
2368 If you hit something other than @kbd{/} after the first @kbd{/} or if the
Dave Love <fx@gnu.org>
parents:
diff changeset
2369 second @kbd{/} doesn't follow quickly enough, then Viper will issue the
Dave Love <fx@gnu.org>
parents:
diff changeset
2370 usual prompt @kbd{/} and will wait for input, as usual in Vi.
Dave Love <fx@gnu.org>
parents:
diff changeset
2371 If you don't like this behavior, you can ``unrecord'' these macros in your
Dave Love <fx@gnu.org>
parents:
diff changeset
2372 @file{~/.viper} file. For instance, if you don't like the above feature, put
Dave Love <fx@gnu.org>
parents:
diff changeset
2373 this in @file{~/.viper}:
Dave Love <fx@gnu.org>
parents:
diff changeset
2374 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2375 (viper-set-searchstyle-toggling-macros 'undefine)
Dave Love <fx@gnu.org>
parents:
diff changeset
2376 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2377 @findex @code{viper-set-searchstyle-toggling-macros}
Dave Love <fx@gnu.org>
parents:
diff changeset
2378
Dave Love <fx@gnu.org>
parents:
diff changeset
2379 @item Vi-isms in Emacs state
Dave Love <fx@gnu.org>
parents:
diff changeset
2380 Some people find it useful to use the Vi-style search key, `/', to invoke
Dave Love <fx@gnu.org>
parents:
diff changeset
2381 search in modes which Viper leaves in emacs-state. These modes are:
Dave Love <fx@gnu.org>
parents:
diff changeset
2382 @code{dired-mode}, @code{mh-folder-mode}, @code{gnus-group-mode},
Dave Love <fx@gnu.org>
parents:
diff changeset
2383 @code{gnus-summary-mode}, @code{Info-mode}, and @code{Buffer-menu-mode}
Dave Love <fx@gnu.org>
parents:
diff changeset
2384 (more may be added in the future). So, in the above modes, Viper binds `/'
Dave Love <fx@gnu.org>
parents:
diff changeset
2385 so that it will behave Vi-style. Furthermore, in those major modes, Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
2386 binds `:' to invoke ex-style commands, like in vi-state. And, as described
Dave Love <fx@gnu.org>
parents:
diff changeset
2387 above, `//' and `///' get bound to Vi-style macros that toggle
Dave Love <fx@gnu.org>
parents:
diff changeset
2388 case-insensitivity and regexp-search.
Dave Love <fx@gnu.org>
parents:
diff changeset
2389
Dave Love <fx@gnu.org>
parents:
diff changeset
2390 If you don't like these features---which I don't really understand---you
Dave Love <fx@gnu.org>
parents:
diff changeset
2391 can unbind `/' and `:' in @code{viper-dired-modifier-map} (for Dired) or in
Dave Love <fx@gnu.org>
parents:
diff changeset
2392 @code{viper-slash-and-colon-map}, for other modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
2393 @vindex @code{viper-slash-and-colon-map}
Dave Love <fx@gnu.org>
parents:
diff changeset
2394 @vindex @code{viper-dired-modifier-map}
Dave Love <fx@gnu.org>
parents:
diff changeset
2395
Dave Love <fx@gnu.org>
parents:
diff changeset
2396 To unbind the macros `//' and `///' for a major mode where you feel they
Dave Love <fx@gnu.org>
parents:
diff changeset
2397 are undesirable, execute @code{viper-set-emacs-state-searchstyle-macros} with a
Dave Love <fx@gnu.org>
parents:
diff changeset
2398 non-nil argument. This can be done either interactively, by supplying a
Dave Love <fx@gnu.org>
parents:
diff changeset
2399 prefix argument, or by placing
Dave Love <fx@gnu.org>
parents:
diff changeset
2400 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2401 (viper-set-emacs-state-searchstyle-macros 'undefine)
Dave Love <fx@gnu.org>
parents:
diff changeset
2402 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2403 @findex @code{viper-set-emacs-state-searchstyle-macros}
Dave Love <fx@gnu.org>
parents:
diff changeset
2404 in the hook to the major mode (e.g., @code{dired-mode-hook}).
Dave Love <fx@gnu.org>
parents:
diff changeset
2405 @xref{Vi Macros}, for more information on Vi macros.
Dave Love <fx@gnu.org>
parents:
diff changeset
2406
Dave Love <fx@gnu.org>
parents:
diff changeset
2407 @item viper-heading-start
Dave Love <fx@gnu.org>
parents:
diff changeset
2408 @item viper-heading-end
Dave Love <fx@gnu.org>
parents:
diff changeset
2409 @cindex headings
Dave Love <fx@gnu.org>
parents:
diff changeset
2410 @cindex sections
Dave Love <fx@gnu.org>
parents:
diff changeset
2411 @cindex paragraphs
Dave Love <fx@gnu.org>
parents:
diff changeset
2412 @cindex sentences
Dave Love <fx@gnu.org>
parents:
diff changeset
2413 Regular Expressions for @kbd{[[} and @kbd{]]}. Note that Emacs defines
Dave Love <fx@gnu.org>
parents:
diff changeset
2414 Regexps for paragraphs and sentences. @xref{Paragraphs,,Paragraphs and
Dave Love <fx@gnu.org>
parents:
diff changeset
2415 Sentences,emacs,The GNU Emacs Manual}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
2416 @item M-x viper-set-expert-level
Dave Love <fx@gnu.org>
parents:
diff changeset
2417 @findex @code{viper-set-expert-level}
Dave Love <fx@gnu.org>
parents:
diff changeset
2418 Change your user level interactively.
Dave Love <fx@gnu.org>
parents:
diff changeset
2419 @item viper-smart-suffix-list '("" "tex" "c" "cc" "el" "p")
Dave Love <fx@gnu.org>
parents:
diff changeset
2420 @vindex @code{viper-smart-suffix-list}
Dave Love <fx@gnu.org>
parents:
diff changeset
2421 Viper supports Emacs-style file completion when it prompts the user for a
Dave Love <fx@gnu.org>
parents:
diff changeset
2422 file name. However, in many cases, the same directory may contain files
Dave Love <fx@gnu.org>
parents:
diff changeset
2423 with identical prefix but different suffixes, e.g., prog.c, prog.o,
Dave Love <fx@gnu.org>
parents:
diff changeset
2424 paper.tex, paper.dvi. In such cases, completion will stop at the `.'.
Dave Love <fx@gnu.org>
parents:
diff changeset
2425 If the above variable is a list of strings representing suffixes, Viper will
Dave Love <fx@gnu.org>
parents:
diff changeset
2426 try these suffixes
Dave Love <fx@gnu.org>
parents:
diff changeset
2427 in the order listed and will check if the corresponding file exists.
Dave Love <fx@gnu.org>
parents:
diff changeset
2428
Dave Love <fx@gnu.org>
parents:
diff changeset
2429 For instance, if completion stopped at `paper.'@: and the user typed
Dave Love <fx@gnu.org>
parents:
diff changeset
2430 @key{RET},
Dave Love <fx@gnu.org>
parents:
diff changeset
2431 then Viper will check if the files `paper.', `paper.tex', `paper.c', etc., exist.
Dave Love <fx@gnu.org>
parents:
diff changeset
2432 It will take the first such file. If no file exists, Viper will give a chance
Dave Love <fx@gnu.org>
parents:
diff changeset
2433 to complete the file name by typing the appropriate suffix. If `paper.'@: was
Dave Love <fx@gnu.org>
parents:
diff changeset
2434 the intended file name, hitting return will accept it.
Dave Love <fx@gnu.org>
parents:
diff changeset
2435
Dave Love <fx@gnu.org>
parents:
diff changeset
2436 To turn this feature off, set the above variable to @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2437
Dave Love <fx@gnu.org>
parents:
diff changeset
2438 @item viper-insertion-ring-size 14
Dave Love <fx@gnu.org>
parents:
diff changeset
2439 @vindex @code{viper-insertion-ring-size}
Dave Love <fx@gnu.org>
parents:
diff changeset
2440 @cindex Insertion ring
Dave Love <fx@gnu.org>
parents:
diff changeset
2441 Viper remembers what was previously inserted in Insert and Replace states.
Dave Love <fx@gnu.org>
parents:
diff changeset
2442 Several such recent insertions are kept in a special ring of strings of size
Dave Love <fx@gnu.org>
parents:
diff changeset
2443 @code{viper-insertion-ring-size}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2444 If you enter Insert or Replace state you can reinsert strings from this
Dave Love <fx@gnu.org>
parents:
diff changeset
2445 ring by typing @kbd{C-c M-p} or @kbd{C-c M-n}. The former will search the
Dave Love <fx@gnu.org>
parents:
diff changeset
2446 ring in
Dave Love <fx@gnu.org>
parents:
diff changeset
2447 the direction of older insertions, and the latter will search in
Dave Love <fx@gnu.org>
parents:
diff changeset
2448 the direction of newer insertions. Hitting @kbd{C-c M-p} or @kbd{C-c M-n}
Dave Love <fx@gnu.org>
parents:
diff changeset
2449 in succession
Dave Love <fx@gnu.org>
parents:
diff changeset
2450 will undo the previous insertion from the ring and insert the next item on
Dave Love <fx@gnu.org>
parents:
diff changeset
2451 the ring. If a larger ring size is needed, change the value of the above
Dave Love <fx@gnu.org>
parents:
diff changeset
2452 variable in the @file{~/.viper} file.
Dave Love <fx@gnu.org>
parents:
diff changeset
2453
Dave Love <fx@gnu.org>
parents:
diff changeset
2454 Since typing these sequences of keys may be tedious, it is suggested that the
Dave Love <fx@gnu.org>
parents:
diff changeset
2455 user should bind a function key, such as @kbd{f31}, as follows:
Dave Love <fx@gnu.org>
parents:
diff changeset
2456 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2457 (define-key viper-insert-global-user-map [f31]
Dave Love <fx@gnu.org>
parents:
diff changeset
2458 'viper-insert-prev-from-insertion-ring)
Dave Love <fx@gnu.org>
parents:
diff changeset
2459 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2460 This binds @kbd{f31} (which is usually @kbd{R11} on a Sun workstation)
Dave Love <fx@gnu.org>
parents:
diff changeset
2461 to the function that inserts the previous string in the insertion history.
Dave Love <fx@gnu.org>
parents:
diff changeset
2462 To rotate the history in the opposite
Dave Love <fx@gnu.org>
parents:
diff changeset
2463 direction, you can either bind an unused key to
Dave Love <fx@gnu.org>
parents:
diff changeset
2464 @code{viper-insert-next-from-insertion-ring} or hit any digit (1 to 9) then
Dave Love <fx@gnu.org>
parents:
diff changeset
2465 @kbd{f31}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2466
Dave Love <fx@gnu.org>
parents:
diff changeset
2467 One should not bind the above functions to @kbd{M-p} or @kbd{M-n}, since
Dave Love <fx@gnu.org>
parents:
diff changeset
2468 this will interfere with the Minibuffer histories and, possibly, other
Dave Love <fx@gnu.org>
parents:
diff changeset
2469 major modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
2470
Dave Love <fx@gnu.org>
parents:
diff changeset
2471 @item viper-command-ring-size 14
Dave Love <fx@gnu.org>
parents:
diff changeset
2472 @vindex @code{viper-command-ring-size}
Dave Love <fx@gnu.org>
parents:
diff changeset
2473 @cindex Destructive command ring
Dave Love <fx@gnu.org>
parents:
diff changeset
2474 @cindex Destructive command history
Dave Love <fx@gnu.org>
parents:
diff changeset
2475 Viper keeps track of the recent history of destructive
Dave Love <fx@gnu.org>
parents:
diff changeset
2476 commands, such as @kbd{dw}, @kbd{i}, etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
2477 In Vi state,
Dave Love <fx@gnu.org>
parents:
diff changeset
2478 the most recent command can be re-executed by hitting `@kbd{.}', as in Vi.
Dave Love <fx@gnu.org>
parents:
diff changeset
2479 However, repeated typing @kbd{C-c M-p} will cause Viper to show the
Dave Love <fx@gnu.org>
parents:
diff changeset
2480 previous destructive commands in the minibuffer. Subsequent hitting `@kbd{.}'
Dave Love <fx@gnu.org>
parents:
diff changeset
2481 will execute the command that was displayed last.
Dave Love <fx@gnu.org>
parents:
diff changeset
2482 The key @kbd{C-c M-n} will cycle through the command history in the
Dave Love <fx@gnu.org>
parents:
diff changeset
2483 opposite direction.
Dave Love <fx@gnu.org>
parents:
diff changeset
2484 Since typing @kbd{C-c M-p} may be tedious, it is more convenient to bind an
Dave Love <fx@gnu.org>
parents:
diff changeset
2485 appropriate function to an unused function key on the keyboard and use that
Dave Love <fx@gnu.org>
parents:
diff changeset
2486 key. For instance, the following
Dave Love <fx@gnu.org>
parents:
diff changeset
2487 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2488 (define-key viper-vi-global-user-map [f31]
Dave Love <fx@gnu.org>
parents:
diff changeset
2489 'viper-prev-destructive-command)
Dave Love <fx@gnu.org>
parents:
diff changeset
2490 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2491 binds the key @kbd{f31} (which is usually @kbd{R11} on a Sun workstation)
Dave Love <fx@gnu.org>
parents:
diff changeset
2492 to the function that searches the command history in the direction of older
Dave Love <fx@gnu.org>
parents:
diff changeset
2493 commands. To search in the opposite
Dave Love <fx@gnu.org>
parents:
diff changeset
2494 direction, you can either bind an unused key to
Dave Love <fx@gnu.org>
parents:
diff changeset
2495 @code{viper-next-destructive-command} or hit any digit (1 to 9) then @kbd{f31}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2496
Dave Love <fx@gnu.org>
parents:
diff changeset
2497 One should not bind the above functions to @kbd{M-p} or @kbd{M-n}, since
Dave Love <fx@gnu.org>
parents:
diff changeset
2498 this will interfere with the Minibuffer histories and, possibly, other
Dave Love <fx@gnu.org>
parents:
diff changeset
2499 major modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
2500
Dave Love <fx@gnu.org>
parents:
diff changeset
2501 @item viper-minibuffer-vi-face 'viper-minibuffer-vi-face
Dave Love <fx@gnu.org>
parents:
diff changeset
2502 @item viper-minibuffer-insert-face 'viper-minibuffer-insert-face
Dave Love <fx@gnu.org>
parents:
diff changeset
2503 @item viper-minibuffer-emacs-face 'viper-minibuffer-emacs-face
Dave Love <fx@gnu.org>
parents:
diff changeset
2504 These faces control the appearance of the minibuffer text in the
Dave Love <fx@gnu.org>
parents:
diff changeset
2505 corresponding Viper states. You can change the appearance of these faces
Dave Love <fx@gnu.org>
parents:
diff changeset
2506 through Emacs' customization widget, which is accessible through the
Dave Love <fx@gnu.org>
parents:
diff changeset
2507 menubar.
Dave Love <fx@gnu.org>
parents:
diff changeset
2508
Dave Love <fx@gnu.org>
parents:
diff changeset
2509 Viper is located in this widget under the @emph{Emulations} customization
Dave Love <fx@gnu.org>
parents:
diff changeset
2510 subgroup of the @emph{Editing} group. All Viper faces are grouped together
Dave Love <fx@gnu.org>
parents:
diff changeset
2511 in Viper's @emph{Highlighting} customization subgroup.
Dave Love <fx@gnu.org>
parents:
diff changeset
2512
Dave Love <fx@gnu.org>
parents:
diff changeset
2513 Note that only the text you type in is affected by the above faces.
Dave Love <fx@gnu.org>
parents:
diff changeset
2514 Prompts and Minibuffer messages are not affected.
Dave Love <fx@gnu.org>
parents:
diff changeset
2515
Dave Love <fx@gnu.org>
parents:
diff changeset
2516 Purists who do not like adornments in the minibuffer can always zap them by
Dave Love <fx@gnu.org>
parents:
diff changeset
2517 putting
Dave Love <fx@gnu.org>
parents:
diff changeset
2518 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2519 (copy-face 'default 'viper-minibuffer-vi-face)
Dave Love <fx@gnu.org>
parents:
diff changeset
2520 (copy-face 'default 'viper-minibuffer-insert-face)
Dave Love <fx@gnu.org>
parents:
diff changeset
2521 (copy-face 'default 'viper-minibuffer-emacs-face)
Dave Love <fx@gnu.org>
parents:
diff changeset
2522 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2523 in the @file{~/.viper} file or through the customization widget, as
Dave Love <fx@gnu.org>
parents:
diff changeset
2524 described above. However, in that case, the user will not have any
Dave Love <fx@gnu.org>
parents:
diff changeset
2525 indication of the current Viper state in the minibuffer. (This is important
Dave Love <fx@gnu.org>
parents:
diff changeset
2526 if the user accidentally switches to another Viper state by typing @key{ESC} or
Dave Love <fx@gnu.org>
parents:
diff changeset
2527 @kbd{C-z}).
Dave Love <fx@gnu.org>
parents:
diff changeset
2528 @item M-x viper-go-away
Dave Love <fx@gnu.org>
parents:
diff changeset
2529 @findex @code{viper-go-away}
Dave Love <fx@gnu.org>
parents:
diff changeset
2530 Make Viper disappear from the face of your running Emacs instance. If your
Dave Love <fx@gnu.org>
parents:
diff changeset
2531 fingers start aching again, @kbd{M-x viper-mode} might save your day.
Dave Love <fx@gnu.org>
parents:
diff changeset
2532 @item M-x toggle-viper-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
2533 @findex @code{toggle-viper-mode}
Dave Love <fx@gnu.org>
parents:
diff changeset
2534 Toggle Viperization of Emacs on and off.
Dave Love <fx@gnu.org>
parents:
diff changeset
2535 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
2536
Dave Love <fx@gnu.org>
parents:
diff changeset
2537 @cindex Multifile documents and programs
Dave Love <fx@gnu.org>
parents:
diff changeset
2538
Dave Love <fx@gnu.org>
parents:
diff changeset
2539 Viper provides some support for multi-file documents and programs.
Dave Love <fx@gnu.org>
parents:
diff changeset
2540 If a document consists of several files we can designate one of them as a
Dave Love <fx@gnu.org>
parents:
diff changeset
2541 master and put the following at the end of that file:
Dave Love <fx@gnu.org>
parents:
diff changeset
2542 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2543 ;;; Local Variables:
37806
8da84c32ff29 Avoid overfull hboxes.
Eli Zaretskii <eliz@gnu.org>
parents: 37404
diff changeset
2544 ;;; eval: (viper-setup-master-buffer "file1" "file2" "file3" "file4")
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2545 ;;; End:
Dave Love <fx@gnu.org>
parents:
diff changeset
2546 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2547 @noindent
37806
8da84c32ff29 Avoid overfull hboxes.
Eli Zaretskii <eliz@gnu.org>
parents: 37404
diff changeset
2548 where @code{file1} to @code{file4} are names of files related to the master
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2549 file. Next time, when the master file is visited, the command
Dave Love <fx@gnu.org>
parents:
diff changeset
2550 @code{viper-setup-master-buffer} will be evaluated and the above files will
Dave Love <fx@gnu.org>
parents:
diff changeset
2551 be associated with the master file. Then, the new Ex command
37806
8da84c32ff29 Avoid overfull hboxes.
Eli Zaretskii <eliz@gnu.org>
parents: 37404
diff changeset
2552 @kbd{:RelatedFile} (abbr.@: @kbd{:R}) will display files 1 to 4 one after
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2553 another, so you can edit them. If a file is not in any Emacs buffer, it
Dave Love <fx@gnu.org>
parents:
diff changeset
2554 will be visited. The command @kbd{PreviousRelatedFile} (abbr., @kbd{:P})
Dave Love <fx@gnu.org>
parents:
diff changeset
2555 goes through the file list in the opposite direction.
Dave Love <fx@gnu.org>
parents:
diff changeset
2556 @findex @kbd{:RelatedFile}
Dave Love <fx@gnu.org>
parents:
diff changeset
2557 @findex @kbd{:PreviousRelatedFile}
Dave Love <fx@gnu.org>
parents:
diff changeset
2558
Dave Love <fx@gnu.org>
parents:
diff changeset
2559 These commands are akin to @kbd{:n} and @kbd{:N}, but they allow the user to
Dave Love <fx@gnu.org>
parents:
diff changeset
2560 focus on relevant files only.
Dave Love <fx@gnu.org>
parents:
diff changeset
2561
Dave Love <fx@gnu.org>
parents:
diff changeset
2562 Note that only the master file needs to have the aforementioned block of
Dave Love <fx@gnu.org>
parents:
diff changeset
2563 commands. Also, ";;;" above can be replaced by some other
Dave Love <fx@gnu.org>
parents:
diff changeset
2564 markers. Semicolon is good for Lisp programs, since it is considered a
Dave Love <fx@gnu.org>
parents:
diff changeset
2565 comment designator there. For LaTeX, this could be "%%%", and for C the
Dave Love <fx@gnu.org>
parents:
diff changeset
2566 above block should be commented out.
Dave Love <fx@gnu.org>
parents:
diff changeset
2567
Dave Love <fx@gnu.org>
parents:
diff changeset
2568 Even though these commands are sometimes useful, they are no substitute for
Dave Love <fx@gnu.org>
parents:
diff changeset
2569 the powerful @emph{tag table} facility of Emacs. Viper's @kbd{:tag} command
Dave Love <fx@gnu.org>
parents:
diff changeset
2570 in a primitive interface to Emacs tags. @xref{Tags,Tags,Tags,emacs,
Dave Love <fx@gnu.org>
parents:
diff changeset
2571 The Gnu Emacs Manual}, for more information on tags.
Dave Love <fx@gnu.org>
parents:
diff changeset
2572
Dave Love <fx@gnu.org>
parents:
diff changeset
2573 The following two commands are normally bound to a mouse click and are part
Dave Love <fx@gnu.org>
parents:
diff changeset
2574 of Viper. They work only if Emacs runs as an application under X
Dave Love <fx@gnu.org>
parents:
diff changeset
2575 Windows (or under some other window system for which a port of GNU Emacs 20
Dave Love <fx@gnu.org>
parents:
diff changeset
2576 is available). Clicking the mouse when Emacs is invoked in an Xterm window
Dave Love <fx@gnu.org>
parents:
diff changeset
2577 (using @code{emacs -nw}) will do no good.
Dave Love <fx@gnu.org>
parents:
diff changeset
2578
Dave Love <fx@gnu.org>
parents:
diff changeset
2579 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
2580 @cindex mouse
Dave Love <fx@gnu.org>
parents:
diff changeset
2581 @cindex mouse-search
Dave Love <fx@gnu.org>
parents:
diff changeset
2582 @item viper-mouse-search-key (meta shift 1)
Dave Love <fx@gnu.org>
parents:
diff changeset
2583 @vindex @code{viper-mouse-insert-key}
Dave Love <fx@gnu.org>
parents:
diff changeset
2584 This variable controls the @emph{mouse-search} feature of Viper. The
Dave Love <fx@gnu.org>
parents:
diff changeset
2585 default value
Dave Love <fx@gnu.org>
parents:
diff changeset
2586 states that holding Meta and Shift keys while clicking mouse button 1
Dave Love <fx@gnu.org>
parents:
diff changeset
2587 should initiate search for a region under the mouse pointer (defined
Dave Love <fx@gnu.org>
parents:
diff changeset
2588 below). This command can take a prefix argument, which indicates the
Dave Love <fx@gnu.org>
parents:
diff changeset
2589 occurrence of the pattern to search for.
Dave Love <fx@gnu.org>
parents:
diff changeset
2590
Dave Love <fx@gnu.org>
parents:
diff changeset
2591 Note: while loading initially, Viper binds this mouse action only if it is
Dave Love <fx@gnu.org>
parents:
diff changeset
2592 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
2593 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
2594 something else, you can rebind the mouse-search feature by setting
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2595 @code{viper-mouse-search-key} to something else in your @code{~/.viper}
Dave Love <fx@gnu.org>
parents:
diff changeset
2596 file:
Dave Love <fx@gnu.org>
parents:
diff changeset
2597 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2598 (setq viper-mouse-search-key '(meta 1))
Dave Love <fx@gnu.org>
parents:
diff changeset
2599 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2600 This would bind mouse search to the action invoked by pressing the
Dave Love <fx@gnu.org>
parents:
diff changeset
2601 Meta key and clicking mouse button 1. The allowed values of
Dave Love <fx@gnu.org>
parents:
diff changeset
2602 @code{viper-mouse-search-key} are lists that contain a mouse-button number
Dave Love <fx@gnu.org>
parents:
diff changeset
2603 (1,2, or 3) and any combination of the words `control', `meta', and
Dave Love <fx@gnu.org>
parents:
diff changeset
2604 `shift'.
Dave Love <fx@gnu.org>
parents:
diff changeset
2605
Dave Love <fx@gnu.org>
parents:
diff changeset
2606 If the requested mouse action (e.g., (meta 1)) is already taken for other
Dave Love <fx@gnu.org>
parents:
diff changeset
2607 purposes then you have to confirm your intention by placing the following
Dave Love <fx@gnu.org>
parents:
diff changeset
2608 command in @code{~/.viper} after setting @code{viper-mouse-search-key}:
Dave Love <fx@gnu.org>
parents:
diff changeset
2609 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2610 (viper-bind-mouse-search-key 'force)
Dave Love <fx@gnu.org>
parents:
diff changeset
2611 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2612
Dave Love <fx@gnu.org>
parents:
diff changeset
2613 You can also change this setting interactively, through the customization
Dave Love <fx@gnu.org>
parents:
diff changeset
2614 widget of Emacs (choose option "Customize.Customize Group" from the
Dave Love <fx@gnu.org>
parents:
diff changeset
2615 menubar).
Dave Love <fx@gnu.org>
parents:
diff changeset
2616
Dave Love <fx@gnu.org>
parents:
diff changeset
2617 The region that is chosen as a pattern to search for is determined as
Dave Love <fx@gnu.org>
parents:
diff changeset
2618 follows. If search is invoked via a single click, Viper chooses the region
Dave Love <fx@gnu.org>
parents:
diff changeset
2619 that lies between the beginning of the ``word'' under the pointer (``word''
Dave Love <fx@gnu.org>
parents:
diff changeset
2620 is understood in Vi sense) and the end of that word. The only difference
Dave Love <fx@gnu.org>
parents:
diff changeset
2621 with Vi's words is that in Lisp major modes `-' is considered an
Dave Love <fx@gnu.org>
parents:
diff changeset
2622 alphanumeric symbol. This is done for the convenience of working with Lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2623 symbols, which often have an `-' in them. Also, if you click on a
Dave Love <fx@gnu.org>
parents:
diff changeset
2624 non-alphanumeric character that is not a word separator (in Vi sense) then
Dave Love <fx@gnu.org>
parents:
diff changeset
2625 this character will also be considered alphanumeric, provided that it is
Dave Love <fx@gnu.org>
parents:
diff changeset
2626 adjacent (from either side) to an alphanumeric character. This useful
Dave Love <fx@gnu.org>
parents:
diff changeset
2627 feature gives added control over the patterns selected by the mouse click.
Dave Love <fx@gnu.org>
parents:
diff changeset
2628
Dave Love <fx@gnu.org>
parents:
diff changeset
2629 On a double-click, the region is determined by the beginning of the current
Dave Love <fx@gnu.org>
parents:
diff changeset
2630 Vi's ``Word'' (i.e., the largest non-separator chunk of text) and the End
Dave Love <fx@gnu.org>
parents:
diff changeset
2631 of that ``Word'' (as determined by the @kbd{E} command).
Dave Love <fx@gnu.org>
parents:
diff changeset
2632
Dave Love <fx@gnu.org>
parents:
diff changeset
2633 On a triple-click, the region consists of the entire line where the click
Dave Love <fx@gnu.org>
parents:
diff changeset
2634 occurred with all leading and trailing spaces and tabs removed.
Dave Love <fx@gnu.org>
parents:
diff changeset
2635
Dave Love <fx@gnu.org>
parents:
diff changeset
2636 @cindex mouse-insert
Dave Love <fx@gnu.org>
parents:
diff changeset
2637 @item viper-mouse-insert-key (meta shift 2)
Dave Love <fx@gnu.org>
parents:
diff changeset
2638 @vindex @code{viper-mouse-insert-key}
Dave Love <fx@gnu.org>
parents:
diff changeset
2639 This variable controls the @emph{mouse-insert} feature of Viper.
Dave Love <fx@gnu.org>
parents:
diff changeset
2640 The above default value states that
Dave Love <fx@gnu.org>
parents:
diff changeset
2641 holding Meta and Shift keys while clicking mouse button 2
Dave Love <fx@gnu.org>
parents:
diff changeset
2642 should insert the region surrounding the
Dave Love <fx@gnu.org>
parents:
diff changeset
2643 mouse pointer. The rules defining this region are the same as for
Dave Love <fx@gnu.org>
parents:
diff changeset
2644 mouse-search. This command takes an optional prefix argument, which
Dave Love <fx@gnu.org>
parents:
diff changeset
2645 indicates how many such regions to snarf from the buffer and insert. (In
Dave Love <fx@gnu.org>
parents:
diff changeset
2646 case of a triple-click, the prefix argument is ignored.)
Dave Love <fx@gnu.org>
parents:
diff changeset
2647
Dave Love <fx@gnu.org>
parents:
diff changeset
2648 Note: while loading initially, Viper binds this mouse action only if it not
Dave Love <fx@gnu.org>
parents:
diff changeset
2649 already bound to something else. If you want to use this feature and the
Dave Love <fx@gnu.org>
parents:
diff changeset
2650 default mouse action is already bound, you can rebind mouse-insert by
Dave Love <fx@gnu.org>
parents:
diff changeset
2651 placing this command in @code{~/.viper}:
Dave Love <fx@gnu.org>
parents:
diff changeset
2652 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2653 (setq viper-mouse-insert-key '(meta 2))
Dave Love <fx@gnu.org>
parents:
diff changeset
2654 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2655 If you want to bind mouse-insert to an action even if this action is
Dave Love <fx@gnu.org>
parents:
diff changeset
2656 already taked for other purposes in Emacs, then you should add this command
Dave Love <fx@gnu.org>
parents:
diff changeset
2657 to @code{~/.viper}, after setting @code{viper-mouse-insert-key}:
Dave Love <fx@gnu.org>
parents:
diff changeset
2658 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2659 (viper-bind-mouse-insert-key 'force)
Dave Love <fx@gnu.org>
parents:
diff changeset
2660 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2661
Dave Love <fx@gnu.org>
parents:
diff changeset
2662 This value can also be changed via the Emacs customization widget at the
Dave Love <fx@gnu.org>
parents:
diff changeset
2663 menubar.
Dave Love <fx@gnu.org>
parents:
diff changeset
2664
Dave Love <fx@gnu.org>
parents:
diff changeset
2665 @item viper-multiclick-timeout
Dave Love <fx@gnu.org>
parents:
diff changeset
2666 This variable controls the rate at which double-clicking must occur for the
Dave Love <fx@gnu.org>
parents:
diff changeset
2667 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
2668 @code{double-click-time} in Emacs and to
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
2669 @code{mouse-track-multi-click-time} milliseconds in XEmacs.
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
2670 @end table
36155
3594ca3f5f64 Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36043
diff changeset
2671 @kindex @kbd{S-Mouse-1}
3594ca3f5f64 Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36043
diff changeset
2672 @kindex @kbd{S-Mouse-2}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2673 @kindex @kbd{meta shift button1up}
Dave Love <fx@gnu.org>
parents:
diff changeset
2674 @kindex @kbd{meta shift button2up}
Dave Love <fx@gnu.org>
parents:
diff changeset
2675 @vindex @code{viper-multiclick-timeout}
Dave Love <fx@gnu.org>
parents:
diff changeset
2676 @findex @code{viper-mouse-click-insert-word}
Dave Love <fx@gnu.org>
parents:
diff changeset
2677 @findex @code{viper-mouse-click-search-word}
Dave Love <fx@gnu.org>
parents:
diff changeset
2678
Dave Love <fx@gnu.org>
parents:
diff changeset
2679 Note: The above functions search and insert in the selected window of
Dave Love <fx@gnu.org>
parents:
diff changeset
2680 the latest active frame. This means that you can click in another window or
Dave Love <fx@gnu.org>
parents:
diff changeset
2681 another frame and have search or insertion done in the frame and window you
Dave Love <fx@gnu.org>
parents:
diff changeset
2682 just left. This lets one use these functions in a multi-frame
Dave Love <fx@gnu.org>
parents:
diff changeset
2683 configuration. However, this may require some getting used to. For
Dave Love <fx@gnu.org>
parents:
diff changeset
2684 instance, if you are typing in a frame, A, and then move the mouse to frame
Dave Love <fx@gnu.org>
parents:
diff changeset
2685 B and click to invoke mouse search, search (or insertion) will be performed
Dave Love <fx@gnu.org>
parents:
diff changeset
2686 in frame A. To perform search/insertion in frame B, you will first have to
Dave Love <fx@gnu.org>
parents:
diff changeset
2687 shift focus there, which doesn't happen until you type a character or
Dave Love <fx@gnu.org>
parents:
diff changeset
2688 perform some other action in frame B---mouse search doesn't shift focus.
Dave Love <fx@gnu.org>
parents:
diff changeset
2689
Dave Love <fx@gnu.org>
parents:
diff changeset
2690 If you decide that you don't like the above feature and always want
Dave Love <fx@gnu.org>
parents:
diff changeset
2691 search/insertion be performed in the frame where the click occurs, don't
Dave Love <fx@gnu.org>
parents:
diff changeset
2692 bind (and unbind, if necessary) @code{viper-mouse-catch-frame-switch} from
Dave Love <fx@gnu.org>
parents:
diff changeset
2693 the mouse event it is bound to.
Dave Love <fx@gnu.org>
parents:
diff changeset
2694
Dave Love <fx@gnu.org>
parents:
diff changeset
2695 Mouse search is integrated with Vi-style search, so you can
Dave Love <fx@gnu.org>
parents:
diff changeset
2696 repeat it with @kbd{n} and @kbd{N}. It should be also noted that, while
Dave Love <fx@gnu.org>
parents:
diff changeset
2697 case-sensitivity of search in Viper is controlled by the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
2698 @code{viper-case-fold-search}, the case of mouse search is
Dave Love <fx@gnu.org>
parents:
diff changeset
2699 controlled by the Emacs variable @code{case-fold-search}, which may be set
Dave Love <fx@gnu.org>
parents:
diff changeset
2700 differently from @code{viper-case-fold-search}. Therefore, case-sensitivity
Dave Love <fx@gnu.org>
parents:
diff changeset
2701 of mouse search may be different from that of the usual Vi-style search.
Dave Love <fx@gnu.org>
parents:
diff changeset
2702
Dave Love <fx@gnu.org>
parents:
diff changeset
2703 Finally, if the way Viper determines the word to be searched for or to be
Dave Love <fx@gnu.org>
parents:
diff changeset
2704 inserted is not what you want, there is a variable,
Dave Love <fx@gnu.org>
parents:
diff changeset
2705 @code{viper-surrounding-word-function}, which can be changed to indicate
Dave Love <fx@gnu.org>
parents:
diff changeset
2706 another function for snarfing words out of the buffer. The catch is that
Dave Love <fx@gnu.org>
parents:
diff changeset
2707 you will then have to write such a function and make it known to your
Dave Love <fx@gnu.org>
parents:
diff changeset
2708 Emacs. The function @code{viper-surrounding-word} in @file{viper.el} can be
Dave Love <fx@gnu.org>
parents:
diff changeset
2709 used as a guiding example.
Dave Love <fx@gnu.org>
parents:
diff changeset
2710
Dave Love <fx@gnu.org>
parents:
diff changeset
2711 @node Vi Macros, ,Viper Specials,Customization
Dave Love <fx@gnu.org>
parents:
diff changeset
2712 @section Vi Macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2713
Dave Love <fx@gnu.org>
parents:
diff changeset
2714 @cindex Vi macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2715
Dave Love <fx@gnu.org>
parents:
diff changeset
2716 Viper supports much enhanced Vi-style macros and also facilitates the use
Dave Love <fx@gnu.org>
parents:
diff changeset
2717 of Emacs-style macros. To define a temporary macro, it is generally more
Dave Love <fx@gnu.org>
parents:
diff changeset
2718 convenient to use Emacs keyboard macro facility. Emacs keyboard macros are
Dave Love <fx@gnu.org>
parents:
diff changeset
2719 usually defined anonymously, and the latest macro can be executed by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
2720 @kbd{C-x e} (or @kbd{*}, if Viper is in Vi state). If you need to use several
Dave Love <fx@gnu.org>
parents:
diff changeset
2721 temporary macros, Viper lets you save them to a
Dave Love <fx@gnu.org>
parents:
diff changeset
2722 register (a lowercase letter); such macros can then be executed by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
2723 @kbd{@@a} in Vi state (if a macro was previously saved in register
Dave Love <fx@gnu.org>
parents:
diff changeset
2724 @kbd{a}).
Dave Love <fx@gnu.org>
parents:
diff changeset
2725 @xref{Macros and Registers}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
2726
Dave Love <fx@gnu.org>
parents:
diff changeset
2727 If, however, you need to use a macro regularly, it must be given a
Dave Love <fx@gnu.org>
parents:
diff changeset
2728 permanent name and saved. Emacs manual explains how to do this, but
Dave Love <fx@gnu.org>
parents:
diff changeset
2729 invocation of named Emacs macros is quite different from Vi's. First,
Dave Love <fx@gnu.org>
parents:
diff changeset
2730 invocation of permanent Emacs macros takes time because of the extra keys.
Dave Love <fx@gnu.org>
parents:
diff changeset
2731 Second, binding such macros to function keys, for
Dave Love <fx@gnu.org>
parents:
diff changeset
2732 fast access, hogs valuable real estate on the keyboard.
Dave Love <fx@gnu.org>
parents:
diff changeset
2733
Dave Love <fx@gnu.org>
parents:
diff changeset
2734 Vi-style macros are better in that respect, since Vi lets the user overload
Dave Love <fx@gnu.org>
parents:
diff changeset
2735 the meaning of key sequences: keys typed in fast succession are treated
Dave Love <fx@gnu.org>
parents:
diff changeset
2736 specially, if this key sequence is bound to a macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
2737
Dave Love <fx@gnu.org>
parents:
diff changeset
2738 Viper provides keyboard macros through the usual Ex commands, @kbd{:map} and
Dave Love <fx@gnu.org>
parents:
diff changeset
2739 @kbd{:map!}. Vi-style macros are much more powerful in Viper than
Dave Love <fx@gnu.org>
parents:
diff changeset
2740 they are in the original Vi and in other emulators. This is because Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
2741 implements an enhanced vi-style
Dave Love <fx@gnu.org>
parents:
diff changeset
2742 interface to the powerful Emacs keyboard macro facility.
Dave Love <fx@gnu.org>
parents:
diff changeset
2743
Dave Love <fx@gnu.org>
parents:
diff changeset
2744 First, any Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
2745 command can be executed while defining a macro, not just the Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
2746 commands. In particular, the user can invoke Emacs commands via @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
2747 command-name} or by pressing various function keys on the keyboard. One
Dave Love <fx@gnu.org>
parents:
diff changeset
2748 can even use the mouse, although this is usually not useful and is not
Dave Love <fx@gnu.org>
parents:
diff changeset
2749 recommended (and macros defined with the use of the mouse cannot be saved in
Dave Love <fx@gnu.org>
parents:
diff changeset
2750 command history and in the startup file, for future use).
Dave Love <fx@gnu.org>
parents:
diff changeset
2751
Dave Love <fx@gnu.org>
parents:
diff changeset
2752 Macros defined by mixing Vi and Emacs commands are represented as
Dave Love <fx@gnu.org>
parents:
diff changeset
2753 vectors. So, don't be confused when you see one (usually through the
Dave Love <fx@gnu.org>
parents:
diff changeset
2754 history of Ex commands). For instance, if @kbd{gg} is defined by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
2755 @kbd{l}, the up-arrow key and @kbd{M-x next-line}, its definition will look
Dave Love <fx@gnu.org>
parents:
diff changeset
2756 as follows in Emacs:
Dave Love <fx@gnu.org>
parents:
diff changeset
2757
Dave Love <fx@gnu.org>
parents:
diff changeset
2758 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2759 [l up (meta x) n e x t - l i n e return]
Dave Love <fx@gnu.org>
parents:
diff changeset
2760 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2761
Dave Love <fx@gnu.org>
parents:
diff changeset
2762 Second, Viper macros are defined in a WYSIWYG style. This means that
Dave Love <fx@gnu.org>
parents:
diff changeset
2763 commands are executed as you type them, so you can see precisely what is
Dave Love <fx@gnu.org>
parents:
diff changeset
2764 being defined. Third, macros can be bound to arbitrary sequences of keys,
Dave Love <fx@gnu.org>
parents:
diff changeset
2765 not just to printable keys. For instance, one can define a macro that will
Dave Love <fx@gnu.org>
parents:
diff changeset
2766 be invoked by hitting @kbd{f3} then @kbd{f2} function keys. (The keys
Dave Love <fx@gnu.org>
parents:
diff changeset
2767 @kbd{delete} and @kbd{backspace} are excluded; also, a macro invocation
Dave Love <fx@gnu.org>
parents:
diff changeset
2768 sequence can't start with @key{ESC}. Some other keys, such as @kbd{f1} and
Dave Love <fx@gnu.org>
parents:
diff changeset
2769 @kbd{help}, can't be bound to macros under Emacs, since they
Dave Love <fx@gnu.org>
parents:
diff changeset
2770 are bound in @code{key-translation-map}, which overrides any other binding
Dave Love <fx@gnu.org>
parents:
diff changeset
2771 the user gives to keys. In general, keys that have a binding in
Dave Love <fx@gnu.org>
parents:
diff changeset
2772 @code{key-translation-map} can't be bound to a macro.)
Dave Love <fx@gnu.org>
parents:
diff changeset
2773
Dave Love <fx@gnu.org>
parents:
diff changeset
2774 Fourth, in Viper, one can define macros that are specific to a given
Dave Love <fx@gnu.org>
parents:
diff changeset
2775 buffer, a given major mode, or macros that are defined for all buffers. In
Dave Love <fx@gnu.org>
parents:
diff changeset
2776 fact, the same macro name can have several different definitions: one
Dave Love <fx@gnu.org>
parents:
diff changeset
2777 global, several definitions for various major modes, and
Dave Love <fx@gnu.org>
parents:
diff changeset
2778 definitions for various specific buffers. Buffer-specific definitions
Dave Love <fx@gnu.org>
parents:
diff changeset
2779 override mode-specific definitions, which, in turn, override global
Dave Love <fx@gnu.org>
parents:
diff changeset
2780 definitions.
Dave Love <fx@gnu.org>
parents:
diff changeset
2781
Dave Love <fx@gnu.org>
parents:
diff changeset
2782 As if all that is not enough, Viper (through its interface to Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
2783 macros) lets the user define keyboard macros that ask for confirmation or
Dave Love <fx@gnu.org>
parents:
diff changeset
2784 even prompt the user for input and then continue. To do this, one should
Dave Love <fx@gnu.org>
parents:
diff changeset
2785 type @kbd{C-x q} (for confirmation) or @kbd{C-u C-x q} (for prompt).
Dave Love <fx@gnu.org>
parents:
diff changeset
2786 For details, @pxref{Kbd Macro Query,,Customization,emacs,The GNU Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
2787 Manual} @refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2788
Dave Love <fx@gnu.org>
parents:
diff changeset
2789 When the user finishes defining a macro (which is done by typing @kbd{C-x)} ---
Dave Love <fx@gnu.org>
parents:
diff changeset
2790 a departure from Vi), you will be asked whether you want this
Dave Love <fx@gnu.org>
parents:
diff changeset
2791 macro to be global, mode-specific, or buffer-specific. You will also be
Dave Love <fx@gnu.org>
parents:
diff changeset
2792 given a chance to save the macro in your @file{~/.viper} file.
Dave Love <fx@gnu.org>
parents:
diff changeset
2793 This is the easiest way to save a macro and make
Dave Love <fx@gnu.org>
parents:
diff changeset
2794 it permanently available. If you work your startup files with bare hands,
Dave Love <fx@gnu.org>
parents:
diff changeset
2795 here is how Viper saves the above macro so that it will be
Dave Love <fx@gnu.org>
parents:
diff changeset
2796 available in Viper's Insert state (and Replace state) in buffer @code{my-buf}
Dave Love <fx@gnu.org>
parents:
diff changeset
2797 only:
Dave Love <fx@gnu.org>
parents:
diff changeset
2798
Dave Love <fx@gnu.org>
parents:
diff changeset
2799 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2800 (viper-record-kbd-macro "gg" 'insert-state
Dave Love <fx@gnu.org>
parents:
diff changeset
2801 [l up (meta x) n e x t - l i n e return]
Dave Love <fx@gnu.org>
parents:
diff changeset
2802 "my-buf")
Dave Love <fx@gnu.org>
parents:
diff changeset
2803 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2804
Dave Love <fx@gnu.org>
parents:
diff changeset
2805 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2806 To do the same for Vi state and all buffers with the major mode
Dave Love <fx@gnu.org>
parents:
diff changeset
2807 @code{cc-mode}, use:
Dave Love <fx@gnu.org>
parents:
diff changeset
2808
Dave Love <fx@gnu.org>
parents:
diff changeset
2809 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2810 (viper-record-kbd-macro "gg" 'vi-state
Dave Love <fx@gnu.org>
parents:
diff changeset
2811 [l up (meta x) n e x t - l i n e return]
Dave Love <fx@gnu.org>
parents:
diff changeset
2812 'cc-mode)
Dave Love <fx@gnu.org>
parents:
diff changeset
2813 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2814
Dave Love <fx@gnu.org>
parents:
diff changeset
2815 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2816 Both macro names and macro definitions are vectors of symbols that denote
Dave Love <fx@gnu.org>
parents:
diff changeset
2817 keys on the keyboard. Some keys, like @kbd{\}, @kbd{ }, or digit-keys must
Dave Love <fx@gnu.org>
parents:
diff changeset
2818 be escaped with a backslash. Modified keys are represented as lists. For
Dave Love <fx@gnu.org>
parents:
diff changeset
2819 instance, holding Meta and Control and pressing @kbd{f4} is represented as
Dave Love <fx@gnu.org>
parents:
diff changeset
2820 @kbd{(control meta f4)}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2821 If all members of a vectors are printable characters (or sequences, such as
Dave Love <fx@gnu.org>
parents:
diff changeset
2822 @kbd{\e}, @kbd{\t}, for @key{ESC} and @key{TAB}), then they can also be represented as
Dave Love <fx@gnu.org>
parents:
diff changeset
2823 strings:
Dave Love <fx@gnu.org>
parents:
diff changeset
2824
Dave Love <fx@gnu.org>
parents:
diff changeset
2825 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2826 (viper-record-kbd-macro "aa" 'vi-state "aaa\e" "my-buffer")
Dave Love <fx@gnu.org>
parents:
diff changeset
2827 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2828
Dave Love <fx@gnu.org>
parents:
diff changeset
2829 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2830 Thus, typing @kbd{aa} fast in Vi state will switch Viper to Insert state
Dave Love <fx@gnu.org>
parents:
diff changeset
2831 (due to the first @kbd{a}), insert @kbd{aa}, and then it will switch back to Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
2832 state. All this will take effect only in the buffer named @code{my-buffer}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2833
Dave Love <fx@gnu.org>
parents:
diff changeset
2834 Note that the last argument to @code{viper-record-kbd-macro} must be either a
Dave Love <fx@gnu.org>
parents:
diff changeset
2835 string (a buffer name), a symbol representing a major mode, or @code{t};
Dave Love <fx@gnu.org>
parents:
diff changeset
2836 the latter says that the macro is to be defined for all buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
2837 (which is how macros are defined in original Vi).
Dave Love <fx@gnu.org>
parents:
diff changeset
2838
Dave Love <fx@gnu.org>
parents:
diff changeset
2839 For convenience, Viper also lets you define Vi-style macros in its Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
2840 state. There is no Ex command, like @kbd{:map} and @kbd{:map!} for doing
Dave Love <fx@gnu.org>
parents:
diff changeset
2841 this, but the user can include such a macro in the @file{~/.viper} file. The
Dave Love <fx@gnu.org>
parents:
diff changeset
2842 only thing is that the @code{viper-record-kbd-macro} command should specify
Dave Love <fx@gnu.org>
parents:
diff changeset
2843 @code{emacs-state} instead of @code{vi-state} or @code{insert-state}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2844
Dave Love <fx@gnu.org>
parents:
diff changeset
2845 The user can get rid of a macro either by using the Ex commands @kbd{:unmap}
Dave Love <fx@gnu.org>
parents:
diff changeset
2846 and @kbd{:unmap!} or by issuing a call to @code{viper-unrecord-kbd-macro}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2847 The latter is more powerful, since it can delete macros even in
Dave Love <fx@gnu.org>
parents:
diff changeset
2848 @code{emacs-state}. However, @code{viper-unrecord-kbd-macro} is usually
Dave Love <fx@gnu.org>
parents:
diff changeset
2849 needed only when the user needs to get rid of the macros that are already
Dave Love <fx@gnu.org>
parents:
diff changeset
2850 predefined in Viper.
Dave Love <fx@gnu.org>
parents:
diff changeset
2851 The syntax is:
Dave Love <fx@gnu.org>
parents:
diff changeset
2852 @findex @code{viper-unrecord-kbd-macro}
Dave Love <fx@gnu.org>
parents:
diff changeset
2853 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2854 (viper-unrecord-kbd-macro macro state)
Dave Love <fx@gnu.org>
parents:
diff changeset
2855 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2856 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2857 The second argument must be @code{vi-state}, @code{insert-state}, or
Dave Love <fx@gnu.org>
parents:
diff changeset
2858 @code{emacs-state}. The first argument is a name of a macro. To avoid
Dave Love <fx@gnu.org>
parents:
diff changeset
2859 mistakes in specifying names of existing macros, type @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
2860 viper-describe-kbd-macros} and use a name from the list displayed by this
Dave Love <fx@gnu.org>
parents:
diff changeset
2861 command.
Dave Love <fx@gnu.org>
parents:
diff changeset
2862
Dave Love <fx@gnu.org>
parents:
diff changeset
2863 If an error occurs during macro definition, Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
2864 aborts the process, and it must be repeated. This is analogous to Vi,
Dave Love <fx@gnu.org>
parents:
diff changeset
2865 except that in Vi the user doesn't know there is an error until the macro is
Dave Love <fx@gnu.org>
parents:
diff changeset
2866 actually run. All that means that in order for a definition to be
Dave Love <fx@gnu.org>
parents:
diff changeset
2867 successful, the user must do some simple planning of the process in
Dave Love <fx@gnu.org>
parents:
diff changeset
2868 advance, to avoid errors. For instance, if you want to map @kbd{gg} to
Dave Love <fx@gnu.org>
parents:
diff changeset
2869 @kbd{llll} in Vi state, you must make sure that there is enough room on the
Dave Love <fx@gnu.org>
parents:
diff changeset
2870 current line. Since @kbd{l} moves the cursor forward, it may signal an
Dave Love <fx@gnu.org>
parents:
diff changeset
2871 error on reaching the end of line, which will abort the definition.
Dave Love <fx@gnu.org>
parents:
diff changeset
2872
Dave Love <fx@gnu.org>
parents:
diff changeset
2873 These precautions are necessary only when defining macros; they will help
Dave Love <fx@gnu.org>
parents:
diff changeset
2874 avoid the need to redo the job. When macros are actually run, an error
Dave Love <fx@gnu.org>
parents:
diff changeset
2875 during the execution will simply terminate the current execution
Dave Love <fx@gnu.org>
parents:
diff changeset
2876 (but the macro will remain mapped).
Dave Love <fx@gnu.org>
parents:
diff changeset
2877
Dave Love <fx@gnu.org>
parents:
diff changeset
2878 A macro name can be a string of characters or a vector of keys.
Dave Love <fx@gnu.org>
parents:
diff changeset
2879 The latter makes it possible to define macros bound to, say, double-hits
Dave Love <fx@gnu.org>
parents:
diff changeset
2880 on a function key, such as @kbd{up} or @kbd{f13}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2881 This is very useful if you run out of function keys on your keyboard; it
Dave Love <fx@gnu.org>
parents:
diff changeset
2882 makes Viper macro facility a @emph{keyboard doubler}, so to speak.
Dave Love <fx@gnu.org>
parents:
diff changeset
2883
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38866
diff changeset
2884 Elsewhere (@xref{Key Bindings}, for details), we review
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2885 the standard Emacs mechanism for binding function keys to commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
2886 For instance,
Dave Love <fx@gnu.org>
parents:
diff changeset
2887
Dave Love <fx@gnu.org>
parents:
diff changeset
2888 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2889 (global-set-key [f13] 'repeat-complex-command)
Dave Love <fx@gnu.org>
parents:
diff changeset
2890 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2891
Dave Love <fx@gnu.org>
parents:
diff changeset
2892 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2893 binds the key f13 to the Emacs function that repeats the last minibuffer
Dave Love <fx@gnu.org>
parents:
diff changeset
2894 command. Under Viper, however, you may still use this key for additional
Dave Love <fx@gnu.org>
parents:
diff changeset
2895 purposes, if you bind, say, a double-hitting action for that key to some
Dave Love <fx@gnu.org>
parents:
diff changeset
2896 other function. Emacs doesn't allow the user to do that, but Viper does
Dave Love <fx@gnu.org>
parents:
diff changeset
2897 this through its keyboard macro facility. To do this, type @kbd{:map }
Dave Love <fx@gnu.org>
parents:
diff changeset
2898 first. When you are asked to enter a macro name, hit f13 twice, followed by
Dave Love <fx@gnu.org>
parents:
diff changeset
2899 @key{RET} or @key{SPC}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2900
Dave Love <fx@gnu.org>
parents:
diff changeset
2901 Emacs will now start the mapping process by actually executing
Dave Love <fx@gnu.org>
parents:
diff changeset
2902 Vi and Emacs commands, so that you could see what will happen each time the
Dave Love <fx@gnu.org>
parents:
diff changeset
2903 macro is executed. Suppose now we wanted to bind the key sequence
Dave Love <fx@gnu.org>
parents:
diff changeset
2904 @kbd{f13 f13} to the command @code{eval-last-sexp}. To accomplish this, we
Dave Love <fx@gnu.org>
parents:
diff changeset
2905 can type @kbd{M-x eval-last-sexp} followed by @kbd{C-x )}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2906 If you answer positively to Viper's offer to save this macro in @file{~/.viper}
Dave Love <fx@gnu.org>
parents:
diff changeset
2907 for future uses, the following will be inserted in that file:
Dave Love <fx@gnu.org>
parents:
diff changeset
2908
Dave Love <fx@gnu.org>
parents:
diff changeset
2909 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2910 (viper-record-kbd-macro [f16 f16] 'vi-state
Dave Love <fx@gnu.org>
parents:
diff changeset
2911 [(meta x) e v a l - l a s t - s e x p]
Dave Love <fx@gnu.org>
parents:
diff changeset
2912 'lisp-interaction-mode)
Dave Love <fx@gnu.org>
parents:
diff changeset
2913 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2914
Dave Love <fx@gnu.org>
parents:
diff changeset
2915 To illustrate the above point, Viper provides two canned macros, which, by
Dave Love <fx@gnu.org>
parents:
diff changeset
2916 default, are bound to @kbd{[f12 \1]} and @kbd{[f12 \2]} (invoked by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
2917 @kbd{f12} then @kbd{1} and @kbd{2}, respectively). These macros are useful
Dave Love <fx@gnu.org>
parents:
diff changeset
2918 shortcuts to Viper's command ring history. The first macro will execute the
Dave Love <fx@gnu.org>
parents:
diff changeset
2919 second-last destructive command (the last one is executed by @kbd{.}, as
Dave Love <fx@gnu.org>
parents:
diff changeset
2920 usual). The second macro executes the third-last command.
Dave Love <fx@gnu.org>
parents:
diff changeset
2921
Dave Love <fx@gnu.org>
parents:
diff changeset
2922 If you need to go deeper into the command history, you will have to use
Dave Love <fx@gnu.org>
parents:
diff changeset
2923 other commands, as described earlier in this section; or you can bind,
Dave Love <fx@gnu.org>
parents:
diff changeset
2924 say, @kbd{f12 \3} like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
2925
Dave Love <fx@gnu.org>
parents:
diff changeset
2926 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2927 (viper-record-kbd-macro [f12 \3] 'vi-state
Dave Love <fx@gnu.org>
parents:
diff changeset
2928 [(meta x) r e p e a t - f r o m - h i s t o r y]
Dave Love <fx@gnu.org>
parents:
diff changeset
2929 t)
Dave Love <fx@gnu.org>
parents:
diff changeset
2930 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2931
Dave Love <fx@gnu.org>
parents:
diff changeset
2932
Dave Love <fx@gnu.org>
parents:
diff changeset
2933 Note that even though the macro uses the function key @kbd{f12}, the key is
Dave Love <fx@gnu.org>
parents:
diff changeset
2934 actually free and can still be bound to some Emacs function via
Dave Love <fx@gnu.org>
parents:
diff changeset
2935 @code{define-key} or @code{global-set-key}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2936
Dave Love <fx@gnu.org>
parents:
diff changeset
2937
Dave Love <fx@gnu.org>
parents:
diff changeset
2938 Viper allows the user to define macro names that are prefixes of other macros.
Dave Love <fx@gnu.org>
parents:
diff changeset
2939 For instance, one can define @kbd{[[} and @kbd{[[[[} to be macros.
Dave Love <fx@gnu.org>
parents:
diff changeset
2940 If you type the exact sequence of such keys and then pause, Viper will
Dave Love <fx@gnu.org>
parents:
diff changeset
2941 execute the right macro. However, if you don't pause and, say, type
Dave Love <fx@gnu.org>
parents:
diff changeset
2942 @kbd{[[[[text} then the conflict is resolved as follows. If only one of the
Dave Love <fx@gnu.org>
parents:
diff changeset
2943 key sequences, @kbd{[[} or @kbd{[[[[} has a definition applicable to the
Dave Love <fx@gnu.org>
parents:
diff changeset
2944 current buffer, then, in fact, there is no conflict and the right macro
Dave Love <fx@gnu.org>
parents:
diff changeset
2945 will be chosen. If both have applicable definitions, then the first one
Dave Love <fx@gnu.org>
parents:
diff changeset
2946 found will be executed. Usually this is the macro with a shorter name. So,
Dave Love <fx@gnu.org>
parents:
diff changeset
2947 in our case, @kbd{[[[[text} will cause the macro @kbd{[[} to be executed
Dave Love <fx@gnu.org>
parents:
diff changeset
2948 twice and then the remaining keys, @kbd{t e x t}, will be processed.
Dave Love <fx@gnu.org>
parents:
diff changeset
2949
36155
3594ca3f5f64 Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36043
diff changeset
2950 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
2951 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
2952 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
2953 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
2954 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
2955 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
2956 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
2957 cause name completion. Completions are displayed as strings or
3594ca3f5f64 Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36043
diff changeset
2958 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
2959 @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
2960 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
2961 vector or a string.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2962
Dave Love <fx@gnu.org>
parents:
diff changeset
2963 One last difference from Vi: Vi-style keyboard macros cannot be defined in
Dave Love <fx@gnu.org>
parents:
diff changeset
2964 terms of other Vi-style keyboard macros (but named Emacs macros are OK).
Dave Love <fx@gnu.org>
parents:
diff changeset
2965 More precisely, while defining or executing a macro, the special meaning
Dave Love <fx@gnu.org>
parents:
diff changeset
2966 of key sequences (as Vi macros) is ignored.
Dave Love <fx@gnu.org>
parents:
diff changeset
2967 This is because it is all too easy to create an infinite loop in this way.
Dave Love <fx@gnu.org>
parents:
diff changeset
2968 Since Viper macros are much more powerful than Vi's it is impossible to
Dave Love <fx@gnu.org>
parents:
diff changeset
2969 detect such loops. In practice, this is not really a limitation but,
Dave Love <fx@gnu.org>
parents:
diff changeset
2970 rather, a feature.
Dave Love <fx@gnu.org>
parents:
diff changeset
2971
Dave Love <fx@gnu.org>
parents:
diff changeset
2972 We should also note that Vi macros are disabled in the Minibuffer, which
Dave Love <fx@gnu.org>
parents:
diff changeset
2973 helps keep some potential troubles away.
Dave Love <fx@gnu.org>
parents:
diff changeset
2974
Dave Love <fx@gnu.org>
parents:
diff changeset
2975 The rate at which the user must type keys in order for them to be
Dave Love <fx@gnu.org>
parents:
diff changeset
2976 recognized as a timeout macro is controlled by the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
2977 @code{viper-fast-keyseq-timeout}, which defaults to 200 milliseconds.
Dave Love <fx@gnu.org>
parents:
diff changeset
2978
Dave Love <fx@gnu.org>
parents:
diff changeset
2979 For the most part, Viper macros defined in @file{~/.viper} can be shared
Dave Love <fx@gnu.org>
parents:
diff changeset
2980 between X and TTY modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
2981 The problem with TTY may be that the function keys there generate sequences
Dave Love <fx@gnu.org>
parents:
diff changeset
2982 of events instead of a single event (as under a window system).
Dave Love <fx@gnu.org>
parents:
diff changeset
2983 Emacs maps some of these sequences back to the logical keys
Dave Love <fx@gnu.org>
parents:
diff changeset
2984 (e.g., the sequences generated by the arrow keys are mapped to @kbd{up},
Dave Love <fx@gnu.org>
parents:
diff changeset
2985 @kbd{left}, etc.). However, not all function keys are mapped in this way.
Dave Love <fx@gnu.org>
parents:
diff changeset
2986 Macros that are bound to key sequences that contain such unmapped function
Dave Love <fx@gnu.org>
parents:
diff changeset
2987 keys have to be redefined for TTY's (and possibly for every type of TTY you
Dave Love <fx@gnu.org>
parents:
diff changeset
2988 may be using). To do this, start Emacs on an appropriate TTY device and
Dave Love <fx@gnu.org>
parents:
diff changeset
2989 define the macro using @kbd{:map}, as usual.
Dave Love <fx@gnu.org>
parents:
diff changeset
2990
Dave Love <fx@gnu.org>
parents:
diff changeset
2991 @findex @code{viper-describe-kbd-macros}
Dave Love <fx@gnu.org>
parents:
diff changeset
2992 Finally, Viper provides a function that conveniently displays all macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2993 currently defined. To see all macros along with their definitions, type
Dave Love <fx@gnu.org>
parents:
diff changeset
2994 @kbd{M-x viper-describe-kbd-macros}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2995
Dave Love <fx@gnu.org>
parents:
diff changeset
2996 @node Commands,,Customization,Top
Dave Love <fx@gnu.org>
parents:
diff changeset
2997 @chapter Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
2998
Dave Love <fx@gnu.org>
parents:
diff changeset
2999 This section is a semi-automatically bowdlerized version of the Vi
Dave Love <fx@gnu.org>
parents:
diff changeset
3000 reference created by @* @samp{maart@@cs.vu.nl} and others. It can be
Dave Love <fx@gnu.org>
parents:
diff changeset
3001 found on the Vi archives. This reference has been adapted for Viper.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3002
Dave Love <fx@gnu.org>
parents:
diff changeset
3003 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
3004 * Groundwork:: Textual Conventions and Viper basics
Dave Love <fx@gnu.org>
parents:
diff changeset
3005 * Text Handling:: Moving, Editing, Undoing.
Dave Love <fx@gnu.org>
parents:
diff changeset
3006 * Display:: Scrolling.
Dave Love <fx@gnu.org>
parents:
diff changeset
3007 * File and Buffer Handling:: Editing, Writing and Quitting.
Dave Love <fx@gnu.org>
parents:
diff changeset
3008 * Mapping:: Mapping Keys, Keyboard Macros
Dave Love <fx@gnu.org>
parents:
diff changeset
3009 * Shell Commands:: Accessing Shell Commands, Processing Text
Dave Love <fx@gnu.org>
parents:
diff changeset
3010 * Options:: Ex options, the @kbd{:set} commands
Dave Love <fx@gnu.org>
parents:
diff changeset
3011 * Emacs Related Commands:: Meta Keys, Windows
Dave Love <fx@gnu.org>
parents:
diff changeset
3012 * Mouse-bound Commands:: Search and insertion of text
Dave Love <fx@gnu.org>
parents:
diff changeset
3013 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
3014
Dave Love <fx@gnu.org>
parents:
diff changeset
3015 @node Groundwork, Text Handling, Commands, Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
3016 @comment node-name, next, previous, up
Dave Love <fx@gnu.org>
parents:
diff changeset
3017 @section Groundwork
Dave Love <fx@gnu.org>
parents:
diff changeset
3018
Dave Love <fx@gnu.org>
parents:
diff changeset
3019 The VI command set is based on the idea of combining motion commands
Dave Love <fx@gnu.org>
parents:
diff changeset
3020 with other commands. The motion command is used as a text region
Dave Love <fx@gnu.org>
parents:
diff changeset
3021 specifier for other commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
3022 We classify motion commands into @dfn{point commands} and
Dave Love <fx@gnu.org>
parents:
diff changeset
3023 @dfn{line commands}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3024
Dave Love <fx@gnu.org>
parents:
diff changeset
3025 @cindex point commands
Dave Love <fx@gnu.org>
parents:
diff changeset
3026
Dave Love <fx@gnu.org>
parents:
diff changeset
3027 The point commands are:
Dave Love <fx@gnu.org>
parents:
diff changeset
3028
Dave Love <fx@gnu.org>
parents:
diff changeset
3029 @quotation
Dave Love <fx@gnu.org>
parents:
diff changeset
3030 @kbd{h}, @kbd{l}, @kbd{0}, @kbd{$}, @kbd{w}, @kbd{W}, @kbd{b}, @kbd{B},
Dave Love <fx@gnu.org>
parents:
diff changeset
3031 @kbd{e}, @kbd{E}, @kbd{(}, @kbd{)}, @kbd{/}, @kbd{?}, @kbd{`}, @kbd{f},
Dave Love <fx@gnu.org>
parents:
diff changeset
3032 @kbd{F}, @kbd{t}, @kbd{T}, @kbd{%}, @kbd{;}, @kbd{,}, @kbd{^}
Dave Love <fx@gnu.org>
parents:
diff changeset
3033 @end quotation
Dave Love <fx@gnu.org>
parents:
diff changeset
3034
Dave Love <fx@gnu.org>
parents:
diff changeset
3035 @cindex line commands
Dave Love <fx@gnu.org>
parents:
diff changeset
3036
Dave Love <fx@gnu.org>
parents:
diff changeset
3037 The line commands are:
Dave Love <fx@gnu.org>
parents:
diff changeset
3038
Dave Love <fx@gnu.org>
parents:
diff changeset
3039 @quotation
Dave Love <fx@gnu.org>
parents:
diff changeset
3040 @kbd{j}, @kbd{k}, @kbd{+}, @kbd{-}, @kbd{H}, @kbd{M}, @kbd{L}, @kbd{@{},
Dave Love <fx@gnu.org>
parents:
diff changeset
3041 @kbd{@}}, @kbd{G}, @kbd{'}, @kbd{[[}, @kbd{]]}, @kbd{[]}
Dave Love <fx@gnu.org>
parents:
diff changeset
3042 @end quotation
Dave Love <fx@gnu.org>
parents:
diff changeset
3043 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3044
Dave Love <fx@gnu.org>
parents:
diff changeset
3045 Text Deletion Commands (@pxref{Deleting Text}), Change commands
Dave Love <fx@gnu.org>
parents:
diff changeset
3046 (@pxref{Changing Text}), even Shell Commands (@pxref{Shell Commands})
Dave Love <fx@gnu.org>
parents:
diff changeset
3047 use these commands to describe a region of text to operate on.
Dave Love <fx@gnu.org>
parents:
diff changeset
3048
Dave Love <fx@gnu.org>
parents:
diff changeset
3049 @cindex r and R region specifiers
Dave Love <fx@gnu.org>
parents:
diff changeset
3050
Dave Love <fx@gnu.org>
parents:
diff changeset
3051 Viper adds two region descriptors, @kbd{r} and @kbd{R}. These describe
Dave Love <fx@gnu.org>
parents:
diff changeset
3052 the Emacs regions (@pxref{Basics}), but they are not movement commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
3053
Dave Love <fx@gnu.org>
parents:
diff changeset
3054 The command description uses angle brackets @samp{<>} to indicate
Dave Love <fx@gnu.org>
parents:
diff changeset
3055 metasyntactic variables, since the normal conventions of using simple
Dave Love <fx@gnu.org>
parents:
diff changeset
3056 text can be confusing with Viper where the commands themselves are
Dave Love <fx@gnu.org>
parents:
diff changeset
3057 characters. Watch out where @kbd{<} shift commands and @kbd{<count>} are
Dave Love <fx@gnu.org>
parents:
diff changeset
3058 mentioned together!!!
Dave Love <fx@gnu.org>
parents:
diff changeset
3059
Dave Love <fx@gnu.org>
parents:
diff changeset
3060 @kindex <move>
Dave Love <fx@gnu.org>
parents:
diff changeset
3061 @kindex <a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
3062 @kindex <address>
Dave Love <fx@gnu.org>
parents:
diff changeset
3063 @cindex <move>
Dave Love <fx@gnu.org>
parents:
diff changeset
3064 @cindex <a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
3065 @cindex <address>
Dave Love <fx@gnu.org>
parents:
diff changeset
3066 @cindex movements
Dave Love <fx@gnu.org>
parents:
diff changeset
3067
Dave Love <fx@gnu.org>
parents:
diff changeset
3068 @samp{<move>} refers to the above movement commands, and @samp{<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3069 refers to registers or textmarkers from @samp{a} to @samp{z}. Note
Dave Love <fx@gnu.org>
parents:
diff changeset
3070 that the @samp{<move>} is described by full move commands, that is to
Dave Love <fx@gnu.org>
parents:
diff changeset
3071 say they will take counts, and otherwise behave like normal move commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
3072 @cindex Ex addresses
Dave Love <fx@gnu.org>
parents:
diff changeset
3073 @samp{<address>} refers to Ex line addresses, which include
Dave Love <fx@gnu.org>
parents:
diff changeset
3074
Dave Love <fx@gnu.org>
parents:
diff changeset
3075 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
3076 @item .@: <No address>
Dave Love <fx@gnu.org>
parents:
diff changeset
3077 Current line
Dave Love <fx@gnu.org>
parents:
diff changeset
3078 @item .+n .-n
Dave Love <fx@gnu.org>
parents:
diff changeset
3079 Add or subtract for current line
Dave Love <fx@gnu.org>
parents:
diff changeset
3080 @item number
Dave Love <fx@gnu.org>
parents:
diff changeset
3081 Actual line number, use @kbd{.=} to get the line number
Dave Love <fx@gnu.org>
parents:
diff changeset
3082 @item '<a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
3083 Textmarker
Dave Love <fx@gnu.org>
parents:
diff changeset
3084 @item $
Dave Love <fx@gnu.org>
parents:
diff changeset
3085 Last line
Dave Love <fx@gnu.org>
parents:
diff changeset
3086 @item x,y
Dave Love <fx@gnu.org>
parents:
diff changeset
3087 Where x and y are one of the above
Dave Love <fx@gnu.org>
parents:
diff changeset
3088 @item %
Dave Love <fx@gnu.org>
parents:
diff changeset
3089 @cindex % (Ex address)
Dave Love <fx@gnu.org>
parents:
diff changeset
3090 For the whole file, same as (1,$).
Dave Love <fx@gnu.org>
parents:
diff changeset
3091 @item /<pat>/
Dave Love <fx@gnu.org>
parents:
diff changeset
3092 @itemx ?<pat>?
Dave Love <fx@gnu.org>
parents:
diff changeset
3093 Next or previous line with pattern <pat>.
Dave Love <fx@gnu.org>
parents:
diff changeset
3094
Dave Love <fx@gnu.org>
parents:
diff changeset
3095 Note that the pattern is allowed to contain newline character (inserted as
Dave Love <fx@gnu.org>
parents:
diff changeset
3096 @kbd{C-qC-j}). Therefore, one can search for patterns that span several
Dave Love <fx@gnu.org>
parents:
diff changeset
3097 lines.
Dave Love <fx@gnu.org>
parents:
diff changeset
3098 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3099
Dave Love <fx@gnu.org>
parents:
diff changeset
3100 @cindex % (Current file)
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
3101 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
3102 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
3103 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
3104 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
3105 file history is a better mechanism.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3106 @cindex # (Previous file)
Dave Love <fx@gnu.org>
parents:
diff changeset
3107 Similarly, @samp{#} expands to the previous file. The previous file is
Dave Love <fx@gnu.org>
parents:
diff changeset
3108 the first file in @kbd{:args} listing. This defaults to previous window
Dave Love <fx@gnu.org>
parents:
diff changeset
3109 in the VI sense if you have one window only.
Dave Love <fx@gnu.org>
parents:
diff changeset
3110
Dave Love <fx@gnu.org>
parents:
diff changeset
3111 @kindex <args>
Dave Love <fx@gnu.org>
parents:
diff changeset
3112 @kindex <cmd>
Dave Love <fx@gnu.org>
parents:
diff changeset
3113 @cindex <args>
Dave Love <fx@gnu.org>
parents:
diff changeset
3114 @cindex <cmd>
Dave Love <fx@gnu.org>
parents:
diff changeset
3115 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3116 Others like @samp{<args> -- arguments}, @samp{<cmd> -- command} etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
3117 should be fairly obvious.
Dave Love <fx@gnu.org>
parents:
diff changeset
3118
Dave Love <fx@gnu.org>
parents:
diff changeset
3119 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3120 Common characters referred to include:
Dave Love <fx@gnu.org>
parents:
diff changeset
3121
Dave Love <fx@gnu.org>
parents:
diff changeset
3122 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
3123 @item <sp>
Dave Love <fx@gnu.org>
parents:
diff changeset
3124 Space
Dave Love <fx@gnu.org>
parents:
diff changeset
3125 @item <ht>
Dave Love <fx@gnu.org>
parents:
diff changeset
3126 Tab
Dave Love <fx@gnu.org>
parents:
diff changeset
3127 @item <lf>
Dave Love <fx@gnu.org>
parents:
diff changeset
3128 Linefeed
Dave Love <fx@gnu.org>
parents:
diff changeset
3129 @item <esc>
Dave Love <fx@gnu.org>
parents:
diff changeset
3130 Escape
Dave Love <fx@gnu.org>
parents:
diff changeset
3131 @item <cr>
Dave Love <fx@gnu.org>
parents:
diff changeset
3132 Return, Enter
Dave Love <fx@gnu.org>
parents:
diff changeset
3133 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3134 @cindex <cr>
Dave Love <fx@gnu.org>
parents:
diff changeset
3135 @cindex <esc>
Dave Love <fx@gnu.org>
parents:
diff changeset
3136 @cindex <lf>
Dave Love <fx@gnu.org>
parents:
diff changeset
3137 @cindex <ht>
Dave Love <fx@gnu.org>
parents:
diff changeset
3138 @cindex <sp>
Dave Love <fx@gnu.org>
parents:
diff changeset
3139
Dave Love <fx@gnu.org>
parents:
diff changeset
3140 @cindex words
Dave Love <fx@gnu.org>
parents:
diff changeset
3141 @cindex WORDS
Dave Love <fx@gnu.org>
parents:
diff changeset
3142 @cindex char
Dave Love <fx@gnu.org>
parents:
diff changeset
3143 @cindex CHAR
Dave Love <fx@gnu.org>
parents:
diff changeset
3144
Dave Love <fx@gnu.org>
parents:
diff changeset
3145 We also use @samp{word} for alphanumeric/non-alphanumeric words, and
Dave Love <fx@gnu.org>
parents:
diff changeset
3146 @samp{WORD} for whitespace delimited words. @samp{char} refers to any
Dave Love <fx@gnu.org>
parents:
diff changeset
3147 ASCII character, @samp{CHAR} to non-whitespace character.
Dave Love <fx@gnu.org>
parents:
diff changeset
3148 Brackets @samp{[]} indicate optional parameters; @samp{<count>} also
Dave Love <fx@gnu.org>
parents:
diff changeset
3149 optional, usually defaulting to 1. Brackets are elided for
Dave Love <fx@gnu.org>
parents:
diff changeset
3150 @samp{<count>} to eschew obfuscation.
Dave Love <fx@gnu.org>
parents:
diff changeset
3151
Dave Love <fx@gnu.org>
parents:
diff changeset
3152 Viper's idea of Vi's words is slightly different from Vi. First, Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
3153 words understand Emacs symbol tables. Therefore, all symbols declared to be
Dave Love <fx@gnu.org>
parents:
diff changeset
3154 alphanumeric in a symbol table can automatically be made part of the Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
3155 word. This is useful when, for instance, editing text containing European,
Dave Love <fx@gnu.org>
parents:
diff changeset
3156 Cyrillic, Japanese, etc., texts.
Dave Love <fx@gnu.org>
parents:
diff changeset
3157
Dave Love <fx@gnu.org>
parents:
diff changeset
3158 Second, Viper lets you depart from Vi's idea of a word by changing the a
Dave Love <fx@gnu.org>
parents:
diff changeset
3159 syntax preference via the customization widget (the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
3160 @code{viper-syntax-preference}) or by executing
Dave Love <fx@gnu.org>
parents:
diff changeset
3161 @code{viper-set-syntax-preference} interactively.
Dave Love <fx@gnu.org>
parents:
diff changeset
3162
Dave Love <fx@gnu.org>
parents:
diff changeset
3163 By default, Viper syntax preference is @code{reformed-vi}, which means that
Dave Love <fx@gnu.org>
parents:
diff changeset
3164 Viper considers only those symbols to be part of a word that are specified
Dave Love <fx@gnu.org>
parents:
diff changeset
3165 as word-symbols by the current Emacs syntax table (which may be different
Dave Love <fx@gnu.org>
parents:
diff changeset
3166 for different major modes) plus the underscore symbol @kbd{_}, minus the
Dave Love <fx@gnu.org>
parents:
diff changeset
3167 symbols that are not considered words in Vi (e.g., `,',;, etc.), but may be
Dave Love <fx@gnu.org>
parents:
diff changeset
3168 considered as word-symbols by various Emacs major modes. Reformed-Vi works
Dave Love <fx@gnu.org>
parents:
diff changeset
3169 very close to Vi, and it also recognizes words in other
Dave Love <fx@gnu.org>
parents:
diff changeset
3170 alphabets. Therefore, this is the most appropriate mode for editing text
Dave Love <fx@gnu.org>
parents:
diff changeset
3171 and is likely to fit all your needs.
Dave Love <fx@gnu.org>
parents:
diff changeset
3172
Dave Love <fx@gnu.org>
parents:
diff changeset
3173 You can also set Viper syntax preference to @code{strict-vi}, which would
Dave Love <fx@gnu.org>
parents:
diff changeset
3174 cause Viper to view all non-English letters as non-word-symbols.
Dave Love <fx@gnu.org>
parents:
diff changeset
3175
Dave Love <fx@gnu.org>
parents:
diff changeset
3176 You can also specify @code{emacs} as your preference, which would
Dave Love <fx@gnu.org>
parents:
diff changeset
3177 make Viper use exactly the same notion of a word as Emacs does. In
Dave Love <fx@gnu.org>
parents:
diff changeset
3178 particular, the underscore may not be part of a word in some major modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
3179
Dave Love <fx@gnu.org>
parents:
diff changeset
3180 Finally, if @code{viper-syntax-preference} is set to @code{extended}, Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
3181 words would consist of characters that are classified as alphanumeric
Dave Love <fx@gnu.org>
parents:
diff changeset
3182 @emph{or} as parts of symbols. This is convenient for editing programs.
Dave Love <fx@gnu.org>
parents:
diff changeset
3183
Dave Love <fx@gnu.org>
parents:
diff changeset
3184 @code{viper-syntax-preference} is a local variable, so it can have different
Dave Love <fx@gnu.org>
parents:
diff changeset
3185 values for different major modes. For instance, in programming modes it can
Dave Love <fx@gnu.org>
parents:
diff changeset
3186 have the value @code{extended}. In text modes where words contain special
Dave Love <fx@gnu.org>
parents:
diff changeset
3187 characters, such as European (non-English) letters, Cyrillic letters, etc.,
Dave Love <fx@gnu.org>
parents:
diff changeset
3188 the value can be @code{reformed-vi} or @code{emacs}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3189 If you consider using different syntactic preferences for different major
Dave Love <fx@gnu.org>
parents:
diff changeset
3190 modes, you should execute, for example,
Dave Love <fx@gnu.org>
parents:
diff changeset
3191
Dave Love <fx@gnu.org>
parents:
diff changeset
3192 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3193 (viper-set-syntax-preference nil "extended")
Dave Love <fx@gnu.org>
parents:
diff changeset
3194 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3195
Dave Love <fx@gnu.org>
parents:
diff changeset
3196 in the appropriate major mode hooks.
Dave Love <fx@gnu.org>
parents:
diff changeset
3197
Dave Love <fx@gnu.org>
parents:
diff changeset
3198 @vindex @code{viper-syntax-preference}
Dave Love <fx@gnu.org>
parents:
diff changeset
3199 @findex @code{viper-set-syntax-preference}
Dave Love <fx@gnu.org>
parents:
diff changeset
3200 @cindex syntax table
Dave Love <fx@gnu.org>
parents:
diff changeset
3201
Dave Love <fx@gnu.org>
parents:
diff changeset
3202
Dave Love <fx@gnu.org>
parents:
diff changeset
3203
Dave Love <fx@gnu.org>
parents:
diff changeset
3204 The above discussion concerns only the movement commands. In regular
Dave Love <fx@gnu.org>
parents:
diff changeset
3205 expressions, words remain the same as in Emacs. That is, the expressions
Dave Love <fx@gnu.org>
parents:
diff changeset
3206 @code{\w}, @code{\>}, @code{\<}, etc., use Emacs' idea of what is a word,
Dave Love <fx@gnu.org>
parents:
diff changeset
3207 and they don't look into the value of variable
Dave Love <fx@gnu.org>
parents:
diff changeset
3208 @code{viper-syntax-preference}. This is because Viper avoids changing
Dave Love <fx@gnu.org>
parents:
diff changeset
3209 syntax tables in order to not thwart the various major modes that set these
Dave Love <fx@gnu.org>
parents:
diff changeset
3210 tables.
Dave Love <fx@gnu.org>
parents:
diff changeset
3211
Dave Love <fx@gnu.org>
parents:
diff changeset
3212 The usual Emacs convention is used to indicate Control Characters, i.e
39901
50f67a72ea1b 2001-10-13 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 39267
diff changeset
3213 C-h for Control-h. @emph{Do not confuse this with a sequence of separate
50f67a72ea1b 2001-10-13 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 39267
diff changeset
3214 characters
50f67a72ea1b 2001-10-13 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 39267
diff changeset
3215 C, -, h!!!} The @kbd{^} is itself, never used to indicate a
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3216 Control character.
Dave Love <fx@gnu.org>
parents:
diff changeset
3217
Dave Love <fx@gnu.org>
parents:
diff changeset
3218 Finally, we note that Viper's Ex-style commands can be made to work on the
Dave Love <fx@gnu.org>
parents:
diff changeset
3219 current Emacs region. This is done by typing a digit argument before
Dave Love <fx@gnu.org>
parents:
diff changeset
3220 @kbd{:}. For instance, typing @kbd{1:} will propmt you with something like
Dave Love <fx@gnu.org>
parents:
diff changeset
3221 @emph{:123,135}, assuming that the current region starts at line 123 and
Dave Love <fx@gnu.org>
parents:
diff changeset
3222 ends at line 135. There is no need to type the line numbers, since Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
3223 inserts them automatically in front of the Ex command.
Dave Love <fx@gnu.org>
parents:
diff changeset
3224 @cindex Ex commands
Dave Love <fx@gnu.org>
parents:
diff changeset
3225
Dave Love <fx@gnu.org>
parents:
diff changeset
3226 @node Text Handling, Display, Groundwork, Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
3227 @section Text Handling
Dave Love <fx@gnu.org>
parents:
diff changeset
3228
Dave Love <fx@gnu.org>
parents:
diff changeset
3229 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
3230 * Move Commands:: Moving, Searching
Dave Love <fx@gnu.org>
parents:
diff changeset
3231 * Marking:: Textmarkers in Viper and the Emacs Mark.
Dave Love <fx@gnu.org>
parents:
diff changeset
3232 * Appending Text:: Text insertion, Shifting, Putting
Dave Love <fx@gnu.org>
parents:
diff changeset
3233 * Editing in Insert State:: Autoindent, Quoting etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
3234 * Deleting Text:: Deleting
Dave Love <fx@gnu.org>
parents:
diff changeset
3235 * Changing Text:: Changing, Replacement, Joining
Dave Love <fx@gnu.org>
parents:
diff changeset
3236 * Search and Replace:: Searches, Query Replace, Pattern Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
3237 * Yanking:: Yanking, Viewing Registers
Dave Love <fx@gnu.org>
parents:
diff changeset
3238 * Undoing:: Multiple Undo, Backups
Dave Love <fx@gnu.org>
parents:
diff changeset
3239 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
3240
Dave Love <fx@gnu.org>
parents:
diff changeset
3241 @node Move Commands,Marking,,Text Handling
Dave Love <fx@gnu.org>
parents:
diff changeset
3242 @subsection Move Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
3243
Dave Love <fx@gnu.org>
parents:
diff changeset
3244 @cindex movement commands
Dave Love <fx@gnu.org>
parents:
diff changeset
3245 @cindex searching
Dave Love <fx@gnu.org>
parents:
diff changeset
3246 @cindex textmarkers
Dave Love <fx@gnu.org>
parents:
diff changeset
3247 @cindex markers
Dave Love <fx@gnu.org>
parents:
diff changeset
3248 @cindex column movement
Dave Love <fx@gnu.org>
parents:
diff changeset
3249 @cindex paragraphs
Dave Love <fx@gnu.org>
parents:
diff changeset
3250 @cindex headings
Dave Love <fx@gnu.org>
parents:
diff changeset
3251 @cindex sections
Dave Love <fx@gnu.org>
parents:
diff changeset
3252 @cindex sentences
Dave Love <fx@gnu.org>
parents:
diff changeset
3253 @cindex matching parens
Dave Love <fx@gnu.org>
parents:
diff changeset
3254 @cindex paren matching
Dave Love <fx@gnu.org>
parents:
diff changeset
3255
Dave Love <fx@gnu.org>
parents:
diff changeset
3256 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
3257 @item <count> h C-h
Dave Love <fx@gnu.org>
parents:
diff changeset
3258 <count> chars to the left.
Dave Love <fx@gnu.org>
parents:
diff changeset
3259 @item <count> j <lf> C-n
Dave Love <fx@gnu.org>
parents:
diff changeset
3260 <count> lines downward.
Dave Love <fx@gnu.org>
parents:
diff changeset
3261 @item <count> l <sp>
Dave Love <fx@gnu.org>
parents:
diff changeset
3262 <count> chars to the right.
Dave Love <fx@gnu.org>
parents:
diff changeset
3263 @item <count> k C-p
Dave Love <fx@gnu.org>
parents:
diff changeset
3264 <count> lines upward.
Dave Love <fx@gnu.org>
parents:
diff changeset
3265 @item <count> $
Dave Love <fx@gnu.org>
parents:
diff changeset
3266 To the end of line <count> from the cursor.
Dave Love <fx@gnu.org>
parents:
diff changeset
3267 @item <count> ^
Dave Love <fx@gnu.org>
parents:
diff changeset
3268 To the first CHAR <count> - 1 lines lower.
Dave Love <fx@gnu.org>
parents:
diff changeset
3269 @item <count> -
Dave Love <fx@gnu.org>
parents:
diff changeset
3270 To the first CHAR <count> lines higher.
Dave Love <fx@gnu.org>
parents:
diff changeset
3271 @item <count> + <cr>
Dave Love <fx@gnu.org>
parents:
diff changeset
3272 To the first CHAR <count> lines lower.
Dave Love <fx@gnu.org>
parents:
diff changeset
3273 @item 0
Dave Love <fx@gnu.org>
parents:
diff changeset
3274 To the first char of the line.
Dave Love <fx@gnu.org>
parents:
diff changeset
3275 @item <count> |
Dave Love <fx@gnu.org>
parents:
diff changeset
3276 To column <count>
Dave Love <fx@gnu.org>
parents:
diff changeset
3277 @item <count> f<char>
Dave Love <fx@gnu.org>
parents:
diff changeset
3278 <count> <char>s to the right (find).
Dave Love <fx@gnu.org>
parents:
diff changeset
3279 @item <count> t<char>
Dave Love <fx@gnu.org>
parents:
diff changeset
3280 Till before <count> <char>s to the right.
Dave Love <fx@gnu.org>
parents:
diff changeset
3281 @item <count> F<char>
Dave Love <fx@gnu.org>
parents:
diff changeset
3282 <count> <char>s to the left.
Dave Love <fx@gnu.org>
parents:
diff changeset
3283 @item <count> T<char>
Dave Love <fx@gnu.org>
parents:
diff changeset
3284 Till after <count> <char>s to the left.
Dave Love <fx@gnu.org>
parents:
diff changeset
3285 @item <count> ;
Dave Love <fx@gnu.org>
parents:
diff changeset
3286 Repeat latest @kbd{f t F T} <count> times.
Dave Love <fx@gnu.org>
parents:
diff changeset
3287 @item <count> ,
Dave Love <fx@gnu.org>
parents:
diff changeset
3288 Repeat latest @kbd{f t F T}
Dave Love <fx@gnu.org>
parents:
diff changeset
3289 <count> times in opposite direction.
Dave Love <fx@gnu.org>
parents:
diff changeset
3290 @item <count> w
Dave Love <fx@gnu.org>
parents:
diff changeset
3291 <count> words forward.
Dave Love <fx@gnu.org>
parents:
diff changeset
3292 @item <count> W
Dave Love <fx@gnu.org>
parents:
diff changeset
3293 <count> WORDS forward.
Dave Love <fx@gnu.org>
parents:
diff changeset
3294 @item <count> b
Dave Love <fx@gnu.org>
parents:
diff changeset
3295 <count> words backward.
Dave Love <fx@gnu.org>
parents:
diff changeset
3296 @item <count> B
Dave Love <fx@gnu.org>
parents:
diff changeset
3297 <count> WORDS backward.
Dave Love <fx@gnu.org>
parents:
diff changeset
3298 @item <count> e
Dave Love <fx@gnu.org>
parents:
diff changeset
3299 To the end of word <count> forward.
Dave Love <fx@gnu.org>
parents:
diff changeset
3300 @item <count> E
Dave Love <fx@gnu.org>
parents:
diff changeset
3301 To the end of WORD <count> forward.
Dave Love <fx@gnu.org>
parents:
diff changeset
3302 @item <count> G
Dave Love <fx@gnu.org>
parents:
diff changeset
3303 Go to line <count> (default end-of-file).
Dave Love <fx@gnu.org>
parents:
diff changeset
3304 @item <count> H
Dave Love <fx@gnu.org>
parents:
diff changeset
3305 To line <count> from top of the screen (home).
Dave Love <fx@gnu.org>
parents:
diff changeset
3306 @item <count> L
Dave Love <fx@gnu.org>
parents:
diff changeset
3307 To line <count> from bottom of the screen (last).
Dave Love <fx@gnu.org>
parents:
diff changeset
3308 @item M
Dave Love <fx@gnu.org>
parents:
diff changeset
3309 To the middle line of the screen.
Dave Love <fx@gnu.org>
parents:
diff changeset
3310 @item <count> )
Dave Love <fx@gnu.org>
parents:
diff changeset
3311 <count> sentences forward.
Dave Love <fx@gnu.org>
parents:
diff changeset
3312 @item <count> (
Dave Love <fx@gnu.org>
parents:
diff changeset
3313 <count> sentences backward.
Dave Love <fx@gnu.org>
parents:
diff changeset
3314 @item <count> @}
Dave Love <fx@gnu.org>
parents:
diff changeset
3315 <count> paragraphs forward.
Dave Love <fx@gnu.org>
parents:
diff changeset
3316 @item <count> @{
Dave Love <fx@gnu.org>
parents:
diff changeset
3317 <count> paragraphs backward.
Dave Love <fx@gnu.org>
parents:
diff changeset
3318 @item <count> ]]
Dave Love <fx@gnu.org>
parents:
diff changeset
3319 To the <count>th heading.
Dave Love <fx@gnu.org>
parents:
diff changeset
3320 @item <count> [[
Dave Love <fx@gnu.org>
parents:
diff changeset
3321 To the <count>th previous heading.
Dave Love <fx@gnu.org>
parents:
diff changeset
3322 @item <count> []
Dave Love <fx@gnu.org>
parents:
diff changeset
3323 To the end of <count>th heading.
Dave Love <fx@gnu.org>
parents:
diff changeset
3324 @item m<a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
3325 Mark the cursor position with a letter.
Dave Love <fx@gnu.org>
parents:
diff changeset
3326 @item `<a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
3327 To the mark.
Dave Love <fx@gnu.org>
parents:
diff changeset
3328 @item '<a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
3329 To the first CHAR of the line with the mark.
Dave Love <fx@gnu.org>
parents:
diff changeset
3330 @item [<a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
3331 Show contents of textmarker.
Dave Love <fx@gnu.org>
parents:
diff changeset
3332 @item ]<a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
3333 Show contents of register.
Dave Love <fx@gnu.org>
parents:
diff changeset
3334 @item ``
Dave Love <fx@gnu.org>
parents:
diff changeset
3335 To the cursor position before the latest absolute
Dave Love <fx@gnu.org>
parents:
diff changeset
3336 jump (of which are examples @kbd{/} and @kbd{G}).
Dave Love <fx@gnu.org>
parents:
diff changeset
3337 @item ''
Dave Love <fx@gnu.org>
parents:
diff changeset
3338 To the first CHAR of the line on which the cursor
Dave Love <fx@gnu.org>
parents:
diff changeset
3339 was placed before the latest absolute jump.
Dave Love <fx@gnu.org>
parents:
diff changeset
3340 @item <count> /<string>
Dave Love <fx@gnu.org>
parents:
diff changeset
3341 To the <count>th occurrence of <string>.
Dave Love <fx@gnu.org>
parents:
diff changeset
3342 @item <count> /<cr>
Dave Love <fx@gnu.org>
parents:
diff changeset
3343 To the <count>th occurrence of <string> from previous @kbd{/ or ?}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3344 @item <count> ?<string>
Dave Love <fx@gnu.org>
parents:
diff changeset
3345 To the <count>th previous occurrence of <string>.
Dave Love <fx@gnu.org>
parents:
diff changeset
3346 @item <count> ?<cr>
Dave Love <fx@gnu.org>
parents:
diff changeset
3347 To the <count>th previous occurrence of <string> from previous @kbd{?@: or /}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3348 @item n
Dave Love <fx@gnu.org>
parents:
diff changeset
3349 Repeat latest @kbd{/} @kbd{?} (next).
Dave Love <fx@gnu.org>
parents:
diff changeset
3350 @item N
Dave Love <fx@gnu.org>
parents:
diff changeset
3351 Repeat latest search in opposite direction.
Dave Love <fx@gnu.org>
parents:
diff changeset
3352 @item C-c /
Dave Love <fx@gnu.org>
parents:
diff changeset
3353 Without a prefix argument, this command toggles
Dave Love <fx@gnu.org>
parents:
diff changeset
3354 case-sensitive/case-insensitive search modes and plain vanilla/regular
Dave Love <fx@gnu.org>
parents:
diff changeset
3355 expression search. With the prefix argument 1, i.e.,
Dave Love <fx@gnu.org>
parents:
diff changeset
3356 @kbd{1 C-c /}, this toggles case-sensitivity; with the prefix argument 2,
Dave Love <fx@gnu.org>
parents:
diff changeset
3357 toggles plain vanilla search and search using
Dave Love <fx@gnu.org>
parents:
diff changeset
3358 regular expressions. @xref{Viper Specials}, for alternative ways to invoke
Dave Love <fx@gnu.org>
parents:
diff changeset
3359 this function.
Dave Love <fx@gnu.org>
parents:
diff changeset
3360 @cindex vanilla search
Dave Love <fx@gnu.org>
parents:
diff changeset
3361 @cindex case-sensitive search
Dave Love <fx@gnu.org>
parents:
diff changeset
3362 @cindex case-insensitive search
Dave Love <fx@gnu.org>
parents:
diff changeset
3363 @item %
Dave Love <fx@gnu.org>
parents:
diff changeset
3364 Find the next bracket/parenthesis/brace and go to its match.
Dave Love <fx@gnu.org>
parents:
diff changeset
3365 By default, Viper ignores brackets/parentheses/braces that occur inside
Dave Love <fx@gnu.org>
parents:
diff changeset
3366 parentheses. You can change this by setting
Dave Love <fx@gnu.org>
parents:
diff changeset
3367 @code{viper-parse-sexp-ignore-comments} to nil in your @file{.viper} file.
Dave Love <fx@gnu.org>
parents:
diff changeset
3368 This option can also be toggled interactively if you quickly hit @kbd{%%%}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3369
Dave Love <fx@gnu.org>
parents:
diff changeset
3370 This latter feature is implemented as a vi-style keyboard macro. If you
Dave Love <fx@gnu.org>
parents:
diff changeset
3371 don't want this macro, put
Dave Love <fx@gnu.org>
parents:
diff changeset
3372
Dave Love <fx@gnu.org>
parents:
diff changeset
3373 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3374 (viper-set-parsing-style-toggling-macro 'undefine)
Dave Love <fx@gnu.org>
parents:
diff changeset
3375 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3376 @findex @code{viper-set-parsing-style-toggling-macro}
Dave Love <fx@gnu.org>
parents:
diff changeset
3377
Dave Love <fx@gnu.org>
parents:
diff changeset
3378 in your @file{~/.viper} file.
Dave Love <fx@gnu.org>
parents:
diff changeset
3379
Dave Love <fx@gnu.org>
parents:
diff changeset
3380 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3381 @kindex @kbd{%}
Dave Love <fx@gnu.org>
parents:
diff changeset
3382 @kindex @kbd{C-c /}
Dave Love <fx@gnu.org>
parents:
diff changeset
3383 @kindex @kbd{N}
Dave Love <fx@gnu.org>
parents:
diff changeset
3384 @kindex @kbd{n}
Dave Love <fx@gnu.org>
parents:
diff changeset
3385 @kindex @kbd{?<cr>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3386 @kindex @kbd{/<cr>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3387 @kindex @kbd{?<string>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3388 @kindex @kbd{/<string>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3389 @kindex @kbd{''}
Dave Love <fx@gnu.org>
parents:
diff changeset
3390 @kindex @kbd{``}
Dave Love <fx@gnu.org>
parents:
diff changeset
3391 @kindex @kbd{]<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3392 @kindex @kbd{[<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3393 @kindex @kbd{'<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3394 @kindex @kbd{`<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3395 @kindex @kbd{m<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3396 @kindex @kbd{[]}
Dave Love <fx@gnu.org>
parents:
diff changeset
3397 @kindex @kbd{[[}
Dave Love <fx@gnu.org>
parents:
diff changeset
3398 @kindex @kbd{]]}
Dave Love <fx@gnu.org>
parents:
diff changeset
3399 @kindex @kbd{@{}
Dave Love <fx@gnu.org>
parents:
diff changeset
3400 @kindex @kbd{@}}
Dave Love <fx@gnu.org>
parents:
diff changeset
3401 @kindex @kbd{(}
Dave Love <fx@gnu.org>
parents:
diff changeset
3402 @kindex @kbd{)}
Dave Love <fx@gnu.org>
parents:
diff changeset
3403 @kindex @kbd{M}
Dave Love <fx@gnu.org>
parents:
diff changeset
3404 @kindex @kbd{L}
Dave Love <fx@gnu.org>
parents:
diff changeset
3405 @kindex @kbd{H}
Dave Love <fx@gnu.org>
parents:
diff changeset
3406 @kindex @kbd{G}
Dave Love <fx@gnu.org>
parents:
diff changeset
3407 @kindex @kbd{E}
Dave Love <fx@gnu.org>
parents:
diff changeset
3408 @kindex @kbd{e}
Dave Love <fx@gnu.org>
parents:
diff changeset
3409 @kindex @kbd{B}
Dave Love <fx@gnu.org>
parents:
diff changeset
3410 @kindex @kbd{b}
Dave Love <fx@gnu.org>
parents:
diff changeset
3411 @kindex @kbd{W}
Dave Love <fx@gnu.org>
parents:
diff changeset
3412 @kindex @kbd{w}
Dave Love <fx@gnu.org>
parents:
diff changeset
3413 @kindex @kbd{,}
Dave Love <fx@gnu.org>
parents:
diff changeset
3414 @kindex @kbd{;}
Dave Love <fx@gnu.org>
parents:
diff changeset
3415 @kindex @kbd{T<char>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3416 @kindex @kbd{F<char>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3417 @kindex @kbd{t<char>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3418 @kindex @kbd{f<char>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3419 @kindex @kbd{|}
Dave Love <fx@gnu.org>
parents:
diff changeset
3420 @kindex @kbd{0}
Dave Love <fx@gnu.org>
parents:
diff changeset
3421 @kindex @kbd{<cr>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3422 @kindex @kbd{+}
Dave Love <fx@gnu.org>
parents:
diff changeset
3423 @kindex @kbd{-}
Dave Love <fx@gnu.org>
parents:
diff changeset
3424 @kindex @kbd{^}
Dave Love <fx@gnu.org>
parents:
diff changeset
3425 @kindex @kbd{$}
Dave Love <fx@gnu.org>
parents:
diff changeset
3426 @kindex @kbd{C-p}
Dave Love <fx@gnu.org>
parents:
diff changeset
3427 @kindex @kbd{<lf>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3428 @kindex @kbd{<sp>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3429 @kindex @kbd{C-n}
Dave Love <fx@gnu.org>
parents:
diff changeset
3430 @kindex @kbd{C-h}
Dave Love <fx@gnu.org>
parents:
diff changeset
3431 @kindex @kbd{h}
Dave Love <fx@gnu.org>
parents:
diff changeset
3432 @kindex @kbd{j}
Dave Love <fx@gnu.org>
parents:
diff changeset
3433 @kindex @kbd{k}
Dave Love <fx@gnu.org>
parents:
diff changeset
3434 @kindex @kbd{l}
Dave Love <fx@gnu.org>
parents:
diff changeset
3435 @vindex @code{viper-parse-sexp-ignore-comments}
Dave Love <fx@gnu.org>
parents:
diff changeset
3436
Dave Love <fx@gnu.org>
parents:
diff changeset
3437 @node Marking,Appending Text,Move Commands,Text Handling
Dave Love <fx@gnu.org>
parents:
diff changeset
3438 @subsection Marking
Dave Love <fx@gnu.org>
parents:
diff changeset
3439
Dave Love <fx@gnu.org>
parents:
diff changeset
3440 Emacs mark is referred to in the region specifiers @kbd{r} and @kbd{R}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3441 @xref{Emacs Preliminaries}, and @xref{Basics}, for explanation. Also
Dave Love <fx@gnu.org>
parents:
diff changeset
3442 see @ref{Mark,,Mark,emacs,The GNU Emacs manual}, for an explanation of
Dave Love <fx@gnu.org>
parents:
diff changeset
3443 the Emacs mark ring.
Dave Love <fx@gnu.org>
parents:
diff changeset
3444
Dave Love <fx@gnu.org>
parents:
diff changeset
3445 @cindex marking
Dave Love <fx@gnu.org>
parents:
diff changeset
3446
Dave Love <fx@gnu.org>
parents:
diff changeset
3447 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
3448 @item m<a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
3449 Mark the current file and position with the specified letter.
Dave Love <fx@gnu.org>
parents:
diff changeset
3450 @item m .
Dave Love <fx@gnu.org>
parents:
diff changeset
3451 Set the Emacs mark (@pxref{Emacs Preliminaries}) at point.
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
3452 @item m ^
26490
2b08d829af86 Fix complaints from makeinfo 4.0.
Eli Zaretskii <eliz@gnu.org>
parents: 26263
diff changeset
3453 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
3454 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
3455 @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
3456 it in a way that you didn't like.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3457 @item m <
Dave Love <fx@gnu.org>
parents:
diff changeset
3458 Set the Emacs mark at beginning of buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
3459 @item m >
Dave Love <fx@gnu.org>
parents:
diff changeset
3460 Set the Emacs mark at end of buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
3461 @item m ,
Dave Love <fx@gnu.org>
parents:
diff changeset
3462 Jump to the Emacs mark.
Dave Love <fx@gnu.org>
parents:
diff changeset
3463 @item :mark <char>
Dave Love <fx@gnu.org>
parents:
diff changeset
3464 Mark position with text marker named <char>. This is an Ex command.
Dave Love <fx@gnu.org>
parents:
diff changeset
3465 @item :k <char>
Dave Love <fx@gnu.org>
parents:
diff changeset
3466 Same as @kbd{:mark}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3467 @item ``
Dave Love <fx@gnu.org>
parents:
diff changeset
3468 Exchange point and mark.
Dave Love <fx@gnu.org>
parents:
diff changeset
3469 @item ''
Dave Love <fx@gnu.org>
parents:
diff changeset
3470 Exchange point and mark and go to the first CHAR on line.
Dave Love <fx@gnu.org>
parents:
diff changeset
3471 @item '<a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
3472 Go to specified Viper mark.
Dave Love <fx@gnu.org>
parents:
diff changeset
3473 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3474 Go to specified Viper mark and go to the first CHAR on line.
Dave Love <fx@gnu.org>
parents:
diff changeset
3475 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3476 @kindex @kbd{m<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3477 @kindex @kbd{m.}
Dave Love <fx@gnu.org>
parents:
diff changeset
3478 @kindex @kbd{m>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3479 @kindex @kbd{m<}
Dave Love <fx@gnu.org>
parents:
diff changeset
3480 @kindex @kbd{m,}
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
3481 @kindex @kbd{m^}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3482 @findex @kbd{:mark}
Dave Love <fx@gnu.org>
parents:
diff changeset
3483 @findex @kbd{:k}
Dave Love <fx@gnu.org>
parents:
diff changeset
3484 @kindex @kbd{''}
Dave Love <fx@gnu.org>
parents:
diff changeset
3485 @kindex @kbd{``}
Dave Love <fx@gnu.org>
parents:
diff changeset
3486 @kindex @kbd{`<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3487 @kindex @kbd{'<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3488
Dave Love <fx@gnu.org>
parents:
diff changeset
3489 @node Appending Text, Editing in Insert State, Marking,Text Handling
Dave Love <fx@gnu.org>
parents:
diff changeset
3490 @subsection Appending Text
Dave Love <fx@gnu.org>
parents:
diff changeset
3491
Dave Love <fx@gnu.org>
parents:
diff changeset
3492 @xref{Options}, to see how to change tab and shiftwidth size. See the GNU
Dave Love <fx@gnu.org>
parents:
diff changeset
3493 Emacs manual, or try @kbd{C-ha tabs} (If you have turned Emacs help on).
Dave Love <fx@gnu.org>
parents:
diff changeset
3494 Check out the variable @code{indent-tabs-mode} to put in just spaces.
Dave Love <fx@gnu.org>
parents:
diff changeset
3495 Also see options for word-wrap.
Dave Love <fx@gnu.org>
parents:
diff changeset
3496
Dave Love <fx@gnu.org>
parents:
diff changeset
3497 @cindex inserting
Dave Love <fx@gnu.org>
parents:
diff changeset
3498 @cindex appending
Dave Love <fx@gnu.org>
parents:
diff changeset
3499 @cindex paste
Dave Love <fx@gnu.org>
parents:
diff changeset
3500 @cindex put
Dave Love <fx@gnu.org>
parents:
diff changeset
3501
Dave Love <fx@gnu.org>
parents:
diff changeset
3502 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
3503 @item <count> a
Dave Love <fx@gnu.org>
parents:
diff changeset
3504 <count> times after the cursor.
Dave Love <fx@gnu.org>
parents:
diff changeset
3505 @item <count> A
Dave Love <fx@gnu.org>
parents:
diff changeset
3506 <count> times at the end of line.
Dave Love <fx@gnu.org>
parents:
diff changeset
3507 @item <count> i
Dave Love <fx@gnu.org>
parents:
diff changeset
3508 <count> times before the cursor (insert).
Dave Love <fx@gnu.org>
parents:
diff changeset
3509 @item <count> I
Dave Love <fx@gnu.org>
parents:
diff changeset
3510 <count> times before the first CHAR of the line
Dave Love <fx@gnu.org>
parents:
diff changeset
3511 @item <count> o
Dave Love <fx@gnu.org>
parents:
diff changeset
3512 On a new line below the current (open).
Dave Love <fx@gnu.org>
parents:
diff changeset
3513 The count is only useful on a slow terminal.
Dave Love <fx@gnu.org>
parents:
diff changeset
3514 @item <count> O
Dave Love <fx@gnu.org>
parents:
diff changeset
3515 On a new line above the current.
Dave Love <fx@gnu.org>
parents:
diff changeset
3516 The count is only useful on a slow terminal.
Dave Love <fx@gnu.org>
parents:
diff changeset
3517 @item <count> ><move>
Dave Love <fx@gnu.org>
parents:
diff changeset
3518 Shift the lines described by <count><move> one
Dave Love <fx@gnu.org>
parents:
diff changeset
3519 shiftwidth to the right (layout!).
Dave Love <fx@gnu.org>
parents:
diff changeset
3520 @item <count> >>
Dave Love <fx@gnu.org>
parents:
diff changeset
3521 Shift <count> lines one shiftwidth to the right.
Dave Love <fx@gnu.org>
parents:
diff changeset
3522 @item <count> ["<a-z1-9>]p
Dave Love <fx@gnu.org>
parents:
diff changeset
3523 Put the contents of the (default undo) buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
3524 <count> times after the cursor. The register will
Dave Love <fx@gnu.org>
parents:
diff changeset
3525 be automatically down-cased.
Dave Love <fx@gnu.org>
parents:
diff changeset
3526 @item <count> ["<a-z1-9>]P
Dave Love <fx@gnu.org>
parents:
diff changeset
3527 Put the contents of the (default undo) buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
3528 <count> times before the cursor. The register will
Dave Love <fx@gnu.org>
parents:
diff changeset
3529 @item [<a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
3530 Show contents of textmarker.
Dave Love <fx@gnu.org>
parents:
diff changeset
3531 @item ]<a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
3532 Show contents of register.
Dave Love <fx@gnu.org>
parents:
diff changeset
3533 @item <count> .
Dave Love <fx@gnu.org>
parents:
diff changeset
3534 Repeat previous command <count> times. For destructive
Dave Love <fx@gnu.org>
parents:
diff changeset
3535 commands as well as undo.
Dave Love <fx@gnu.org>
parents:
diff changeset
3536 @item f1 1 and f1 2
Dave Love <fx@gnu.org>
parents:
diff changeset
3537 While @kbd{.} repeats the last destructive command,
Dave Love <fx@gnu.org>
parents:
diff changeset
3538 these two macros repeat the second-last and the third-last destructive
Dave Love <fx@gnu.org>
parents:
diff changeset
3539 commands. @xref{Vi Macros}, for more information on Vi macros.
Dave Love <fx@gnu.org>
parents:
diff changeset
3540 @item C-c M-p and C-c M-n
Dave Love <fx@gnu.org>
parents:
diff changeset
3541 In Vi state,
Dave Love <fx@gnu.org>
parents:
diff changeset
3542 these commands help peruse the history of Vi's destructive commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
3543 Successive typing of @kbd{C-c M-p} causes Viper to search the history in
Dave Love <fx@gnu.org>
parents:
diff changeset
3544 the direction
Dave Love <fx@gnu.org>
parents:
diff changeset
3545 of older commands, while hitting @kbd{C-c M-n} does so in reverse
Dave Love <fx@gnu.org>
parents:
diff changeset
3546 order. Each command in the history is displayed in the Minibuffer. The
Dave Love <fx@gnu.org>
parents:
diff changeset
3547 displayed command can
Dave Love <fx@gnu.org>
parents:
diff changeset
3548 then be executed by typing `@kbd{.}'.
Dave Love <fx@gnu.org>
parents:
diff changeset
3549
Dave Love <fx@gnu.org>
parents:
diff changeset
3550 Since typing the above sequences of keys may be tedious, the
Dave Love <fx@gnu.org>
parents:
diff changeset
3551 functions doing the perusing can be bound to unused keyboard keys in the
Dave Love <fx@gnu.org>
parents:
diff changeset
3552 @file{~/.viper} file. @xref{Viper Specials}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
3553 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3554 @kindex @kbd{C-c M-p}
Dave Love <fx@gnu.org>
parents:
diff changeset
3555 @kindex @kbd{C-c M-n}
Dave Love <fx@gnu.org>
parents:
diff changeset
3556 @kindex @kbd{.}
Dave Love <fx@gnu.org>
parents:
diff changeset
3557 @kindex @kbd{]<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3558 @kindex @kbd{[<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3559 @kindex @kbd{P}
Dave Love <fx@gnu.org>
parents:
diff changeset
3560 @kindex @kbd{p}
Dave Love <fx@gnu.org>
parents:
diff changeset
3561 @kindex @kbd{"<a-z1-9>p}
Dave Love <fx@gnu.org>
parents:
diff changeset
3562 @kindex @kbd{"<a-z1-9>P}
Dave Love <fx@gnu.org>
parents:
diff changeset
3563 @kindex @kbd{>>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3564 @kindex @kbd{><move>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3565 @kindex @kbd{O}
Dave Love <fx@gnu.org>
parents:
diff changeset
3566 @kindex @kbd{o}
Dave Love <fx@gnu.org>
parents:
diff changeset
3567 @kindex @kbd{i}
Dave Love <fx@gnu.org>
parents:
diff changeset
3568 @kindex @kbd{A}
Dave Love <fx@gnu.org>
parents:
diff changeset
3569 @kindex @kbd{a}
Dave Love <fx@gnu.org>
parents:
diff changeset
3570
Dave Love <fx@gnu.org>
parents:
diff changeset
3571 @node Editing in Insert State, Deleting Text, Appending Text,Text Handling
Dave Love <fx@gnu.org>
parents:
diff changeset
3572 @subsection Editing in Insert State
Dave Love <fx@gnu.org>
parents:
diff changeset
3573
Dave Love <fx@gnu.org>
parents:
diff changeset
3574 Minibuffer can be edited similarly to Insert state, and you can switch
Dave Love <fx@gnu.org>
parents:
diff changeset
3575 between Insert/Replace/Vi states at will.
Dave Love <fx@gnu.org>
parents:
diff changeset
3576 Some users prefer plain Emacs feel in the Minibuffer. To this end, set
Dave Love <fx@gnu.org>
parents:
diff changeset
3577 @var{viper-vi-style-in-minibuffer} to @code{nil}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3578
Dave Love <fx@gnu.org>
parents:
diff changeset
3579 @cindex Insert state
Dave Love <fx@gnu.org>
parents:
diff changeset
3580
Dave Love <fx@gnu.org>
parents:
diff changeset
3581 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
3582 @item C-v
Dave Love <fx@gnu.org>
parents:
diff changeset
3583 Deprive the next char of its special meaning (quoting).
Dave Love <fx@gnu.org>
parents:
diff changeset
3584 @item C-h
Dave Love <fx@gnu.org>
parents:
diff changeset
3585 One char back.
Dave Love <fx@gnu.org>
parents:
diff changeset
3586 @item C-w
Dave Love <fx@gnu.org>
parents:
diff changeset
3587 One word back.
Dave Love <fx@gnu.org>
parents:
diff changeset
3588 @item C-u
Dave Love <fx@gnu.org>
parents:
diff changeset
3589 Back to the begin of the change on the
Dave Love <fx@gnu.org>
parents:
diff changeset
3590 current line.
Dave Love <fx@gnu.org>
parents:
diff changeset
3591
Dave Love <fx@gnu.org>
parents:
diff changeset
3592 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3593 @kindex @kbd{C-u}
Dave Love <fx@gnu.org>
parents:
diff changeset
3594 @kindex @kbd{C-w}
Dave Love <fx@gnu.org>
parents:
diff changeset
3595 @kindex @kbd{C-v}
Dave Love <fx@gnu.org>
parents:
diff changeset
3596
Dave Love <fx@gnu.org>
parents:
diff changeset
3597 @node Deleting Text, Changing Text, Editing in Insert State, Text Handling
Dave Love <fx@gnu.org>
parents:
diff changeset
3598 @subsection Deleting Text
Dave Love <fx@gnu.org>
parents:
diff changeset
3599
Dave Love <fx@gnu.org>
parents:
diff changeset
3600
Dave Love <fx@gnu.org>
parents:
diff changeset
3601 There is one difference in text deletion that you should be
Dave Love <fx@gnu.org>
parents:
diff changeset
3602 aware of. This difference comes from Emacs and was adopted in Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
3603 because we find it very useful. In Vi, if you delete a line, say, and then
Dave Love <fx@gnu.org>
parents:
diff changeset
3604 another line, these two deletions are separated and are put back
Dave Love <fx@gnu.org>
parents:
diff changeset
3605 separately if you use the @samp{p} command. In Emacs (and Viper), successive
Dave Love <fx@gnu.org>
parents:
diff changeset
3606 series of deletions that are @emph{not interrupted} by other commands are
Dave Love <fx@gnu.org>
parents:
diff changeset
3607 lumped together, so the deleted text gets accumulated and can be put back
Dave Love <fx@gnu.org>
parents:
diff changeset
3608 as one chunk. If you want to break a sequence of deletions so that the
Dave Love <fx@gnu.org>
parents:
diff changeset
3609 newly deleted text could be put back separately from the previously deleted
Dave Love <fx@gnu.org>
parents:
diff changeset
3610 text, you should perform a non-deleting action, e.g., move the cursor one
Dave Love <fx@gnu.org>
parents:
diff changeset
3611 character in any direction.
Dave Love <fx@gnu.org>
parents:
diff changeset
3612
Dave Love <fx@gnu.org>
parents:
diff changeset
3613 @cindex shifting text
Dave Love <fx@gnu.org>
parents:
diff changeset
3614
Dave Love <fx@gnu.org>
parents:
diff changeset
3615 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
3616 @item <count> x
Dave Love <fx@gnu.org>
parents:
diff changeset
3617 Delete <count> chars under and after the cursor.
Dave Love <fx@gnu.org>
parents:
diff changeset
3618 @item <count> X
Dave Love <fx@gnu.org>
parents:
diff changeset
3619 Delete <count> chars before the cursor.
Dave Love <fx@gnu.org>
parents:
diff changeset
3620 @item <count> d<move>
Dave Love <fx@gnu.org>
parents:
diff changeset
3621 Delete from point to endpoint of <count><move>.
Dave Love <fx@gnu.org>
parents:
diff changeset
3622 @item <count> dd
Dave Love <fx@gnu.org>
parents:
diff changeset
3623 Delete <count> lines.
Dave Love <fx@gnu.org>
parents:
diff changeset
3624 @item D
Dave Love <fx@gnu.org>
parents:
diff changeset
3625 The rest of the line.
Dave Love <fx@gnu.org>
parents:
diff changeset
3626 @item <count> <<move>
Dave Love <fx@gnu.org>
parents:
diff changeset
3627 Shift the lines described by <count><move> one
Dave Love <fx@gnu.org>
parents:
diff changeset
3628 shiftwidth to the left (layout!).
Dave Love <fx@gnu.org>
parents:
diff changeset
3629 @item <count> <<
Dave Love <fx@gnu.org>
parents:
diff changeset
3630 Shift <count> lines one shiftwidth to the left.
Dave Love <fx@gnu.org>
parents:
diff changeset
3631 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3632 @kindex @kbd{<<}
Dave Love <fx@gnu.org>
parents:
diff changeset
3633 @kindex @kbd{<<move>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3634 @kindex @kbd{D}
Dave Love <fx@gnu.org>
parents:
diff changeset
3635 @kindex @kbd{dd}
Dave Love <fx@gnu.org>
parents:
diff changeset
3636 @kindex @kbd{d<move>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3637 @kindex @kbd{X}
Dave Love <fx@gnu.org>
parents:
diff changeset
3638 @kindex @kbd{x}
Dave Love <fx@gnu.org>
parents:
diff changeset
3639
Dave Love <fx@gnu.org>
parents:
diff changeset
3640 @node Changing Text, Search and Replace, Deleting Text,Text Handling
Dave Love <fx@gnu.org>
parents:
diff changeset
3641 @subsection Changing Text
Dave Love <fx@gnu.org>
parents:
diff changeset
3642
Dave Love <fx@gnu.org>
parents:
diff changeset
3643 @cindex joining lines
Dave Love <fx@gnu.org>
parents:
diff changeset
3644 @cindex changing case
Dave Love <fx@gnu.org>
parents:
diff changeset
3645 @cindex quoting regions
Dave Love <fx@gnu.org>
parents:
diff changeset
3646 @cindex substitution
Dave Love <fx@gnu.org>
parents:
diff changeset
3647
Dave Love <fx@gnu.org>
parents:
diff changeset
3648 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
3649 @item <count> r<char>
Dave Love <fx@gnu.org>
parents:
diff changeset
3650 Replace <count> chars by <char> - no <esc>.
Dave Love <fx@gnu.org>
parents:
diff changeset
3651 @item <count> R
Dave Love <fx@gnu.org>
parents:
diff changeset
3652 Overwrite the rest of the line,
Dave Love <fx@gnu.org>
parents:
diff changeset
3653 appending change @var{count - 1} times.
Dave Love <fx@gnu.org>
parents:
diff changeset
3654 @item <count> s
Dave Love <fx@gnu.org>
parents:
diff changeset
3655 Substitute <count> chars.
Dave Love <fx@gnu.org>
parents:
diff changeset
3656 @item <count> S
Dave Love <fx@gnu.org>
parents:
diff changeset
3657 Change <count> lines.
Dave Love <fx@gnu.org>
parents:
diff changeset
3658 @item <count> c<move>
Dave Love <fx@gnu.org>
parents:
diff changeset
3659 Change from begin to endpoint of <count><move>.
Dave Love <fx@gnu.org>
parents:
diff changeset
3660 @item <count> cc
Dave Love <fx@gnu.org>
parents:
diff changeset
3661 Change <count> lines.
Dave Love <fx@gnu.org>
parents:
diff changeset
3662 @item <count> C
Dave Love <fx@gnu.org>
parents:
diff changeset
3663 The rest of the line and <count> - 1 next lines.
Dave Love <fx@gnu.org>
parents:
diff changeset
3664 @item <count> =<move>
Dave Love <fx@gnu.org>
parents:
diff changeset
3665 Reindent the region described by move.
Dave Love <fx@gnu.org>
parents:
diff changeset
3666 @item <count> ~
Dave Love <fx@gnu.org>
parents:
diff changeset
3667 Switch lower and upper cases.
Dave Love <fx@gnu.org>
parents:
diff changeset
3668 @item <count> J
Dave Love <fx@gnu.org>
parents:
diff changeset
3669 Join <count> lines (default 2).
Dave Love <fx@gnu.org>
parents:
diff changeset
3670 @item :[x,y]s/<pat>/<repl>/<f>
Dave Love <fx@gnu.org>
parents:
diff changeset
3671 Substitute (on lines x through y) the pattern
Dave Love <fx@gnu.org>
parents:
diff changeset
3672 <pat> (default the last pattern) with <repl>. Useful
Dave Love <fx@gnu.org>
parents:
diff changeset
3673 flags <f> are @samp{g} for @samp{global} (i.e.@: change every
Dave Love <fx@gnu.org>
parents:
diff changeset
3674 non-overlapping occurrence of <pat>) and @samp{c} for
Dave Love <fx@gnu.org>
parents:
diff changeset
3675 @samp{confirm} (type @samp{y} to confirm a particular
Dave Love <fx@gnu.org>
parents:
diff changeset
3676 substitution, else @samp{n} ). Instead of @kbd{/} any
Dave Love <fx@gnu.org>
parents:
diff changeset
3677 punctuation CHAR unequal to <space> <tab> and <lf> can be used as
Dave Love <fx@gnu.org>
parents:
diff changeset
3678 delimiter.
Dave Love <fx@gnu.org>
parents:
diff changeset
3679
Dave Love <fx@gnu.org>
parents:
diff changeset
3680 In Emacs, @samp{\&} stands for the last matched expression, so
Dave Love <fx@gnu.org>
parents:
diff changeset
3681 @kbd{s/[ab]+/\&\&/} will double the string matched by @kbd{[ab]}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3682 Viper doesn't treat @samp{&} specially, unlike Vi: use @samp{\&} instead.
Dave Love <fx@gnu.org>
parents:
diff changeset
3683
39901
50f67a72ea1b 2001-10-13 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 39267
diff changeset
3684 Viper does not parse search patterns and does not expand special symbols
50f67a72ea1b 2001-10-13 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 39267
diff changeset
3685 found there (e.g., @samp{~} is not expanded to the result of the previous
50f67a72ea1b 2001-10-13 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 39267
diff changeset
3686 substitution).
50f67a72ea1b 2001-10-13 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 39267
diff changeset
3687
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3688 Note: @emph{The newline character (inserted as @kbd{C-qC-j})
Dave Love <fx@gnu.org>
parents:
diff changeset
3689 can be used in <repl>}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3690 @item :[x,y]copy [z]
Dave Love <fx@gnu.org>
parents:
diff changeset
3691 Copy text between @kbd{x} and @kbd{y} to the position after @kbd{z}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3692 @item :[x,y]t [z]
Dave Love <fx@gnu.org>
parents:
diff changeset
3693 Same as @kbd{:copy}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3694 @item :[x,y]move [z]
Dave Love <fx@gnu.org>
parents:
diff changeset
3695 Move text between @kbd{x} and @kbd{y} to the position after @kbd{z}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3696 @item &
Dave Love <fx@gnu.org>
parents:
diff changeset
3697 Repeat latest Ex substitute command, e.g.
Dave Love <fx@gnu.org>
parents:
diff changeset
3698 @kbd{:s/wrong/right}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3699 @item C-c /
Dave Love <fx@gnu.org>
parents:
diff changeset
3700 Toggle case-sensitive search. With prefix argument, toggle vanilla/regular
Dave Love <fx@gnu.org>
parents:
diff changeset
3701 expression search.
Dave Love <fx@gnu.org>
parents:
diff changeset
3702 @item #c<move>
Dave Love <fx@gnu.org>
parents:
diff changeset
3703 Change upper-case characters in the region to lower-case.
Dave Love <fx@gnu.org>
parents:
diff changeset
3704 @item #C<move>
Dave Love <fx@gnu.org>
parents:
diff changeset
3705 Change lower-case characters in the region to upper-case.
Dave Love <fx@gnu.org>
parents:
diff changeset
3706 @item #q<move>
Dave Love <fx@gnu.org>
parents:
diff changeset
3707 Insert specified string at the beginning of each line in the region
Dave Love <fx@gnu.org>
parents:
diff changeset
3708 @item C-c M-p and C-c M-n
Dave Love <fx@gnu.org>
parents:
diff changeset
3709 In Insert and Replace states, these keys are bound to commands that peruse
Dave Love <fx@gnu.org>
parents:
diff changeset
3710 the history of the text
Dave Love <fx@gnu.org>
parents:
diff changeset
3711 previously inserted in other insert or replace commands. By repeatedly typing
Dave Love <fx@gnu.org>
parents:
diff changeset
3712 @kbd{C-c M-p} or @kbd{C-c M-n}, you will cause Viper to
Dave Love <fx@gnu.org>
parents:
diff changeset
3713 insert these previously used strings one by one.
Dave Love <fx@gnu.org>
parents:
diff changeset
3714 When a new string is inserted, the previous one is deleted.
Dave Love <fx@gnu.org>
parents:
diff changeset
3715
Dave Love <fx@gnu.org>
parents:
diff changeset
3716 In Vi state, these keys are bound to functions that peruse the history of
Dave Love <fx@gnu.org>
parents:
diff changeset
3717 destructive Vi commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
3718 @xref{Viper Specials}, for details.
Dave Love <fx@gnu.org>
parents:
diff changeset
3719 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3720 @kindex @kbd{C-c M-p}
Dave Love <fx@gnu.org>
parents:
diff changeset
3721 @kindex @kbd{C-c M-n}
Dave Love <fx@gnu.org>
parents:
diff changeset
3722 @kindex @kbd{#q<move> }
Dave Love <fx@gnu.org>
parents:
diff changeset
3723 @kindex @kbd{#C<move>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3724 @kindex @kbd{#c<move>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3725 @kindex @kbd{&}
Dave Love <fx@gnu.org>
parents:
diff changeset
3726 @kindex @kbd{\&}
Dave Love <fx@gnu.org>
parents:
diff changeset
3727 @findex @kbd{:substitute/<pat>/<repl>/<f>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3728 @findex @kbd{:s/<pat>/<repl>/<f>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3729 @findex @kbd{:copy [z]}
Dave Love <fx@gnu.org>
parents:
diff changeset
3730 @findex @kbd{:t [z]}
Dave Love <fx@gnu.org>
parents:
diff changeset
3731 @findex @kbd{:move [z]}
Dave Love <fx@gnu.org>
parents:
diff changeset
3732 @kindex @kbd{J}
Dave Love <fx@gnu.org>
parents:
diff changeset
3733 @kindex @kbd{~}
Dave Love <fx@gnu.org>
parents:
diff changeset
3734 @kindex @kbd{=<move>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3735 @kindex @kbd{C}
Dave Love <fx@gnu.org>
parents:
diff changeset
3736 @kindex @kbd{cc}
Dave Love <fx@gnu.org>
parents:
diff changeset
3737 @kindex @kbd{c<move>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3738 @kindex @kbd{S}
Dave Love <fx@gnu.org>
parents:
diff changeset
3739 @kindex @kbd{s}
Dave Love <fx@gnu.org>
parents:
diff changeset
3740 @kindex @kbd{R}
Dave Love <fx@gnu.org>
parents:
diff changeset
3741 @kindex @kbd{r<char>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3742
Dave Love <fx@gnu.org>
parents:
diff changeset
3743 @node Search and Replace, Yanking, Changing Text,Text Handling
Dave Love <fx@gnu.org>
parents:
diff changeset
3744 @subsection Search and Replace
Dave Love <fx@gnu.org>
parents:
diff changeset
3745
Dave Love <fx@gnu.org>
parents:
diff changeset
3746 @xref{Groundwork}, for Ex address syntax. @xref{Options}, to see how to
Dave Love <fx@gnu.org>
parents:
diff changeset
3747 get literal (non-regular-expression) search and how to stop search from
Dave Love <fx@gnu.org>
parents:
diff changeset
3748 wrapping around.
Dave Love <fx@gnu.org>
parents:
diff changeset
3749
Dave Love <fx@gnu.org>
parents:
diff changeset
3750 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
3751 @item <count> /<string>
Dave Love <fx@gnu.org>
parents:
diff changeset
3752 To the <count>th occurrence of <string>.
39901
50f67a72ea1b 2001-10-13 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 39267
diff changeset
3753
50f67a72ea1b 2001-10-13 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 39267
diff changeset
3754 Viper does not parse search patterns and does not expand special symbols
50f67a72ea1b 2001-10-13 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 39267
diff changeset
3755 found there (e.g., @samp{~} is not expanded to the result of the previous
50f67a72ea1b 2001-10-13 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 39267
diff changeset
3756 substitution).
50f67a72ea1b 2001-10-13 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 39267
diff changeset
3757
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3758 @item <count> ?<string>
Dave Love <fx@gnu.org>
parents:
diff changeset
3759 To the <count>th previous occurrence of <string>.
Dave Love <fx@gnu.org>
parents:
diff changeset
3760 @item <count> g<move>
Dave Love <fx@gnu.org>
parents:
diff changeset
3761 Search for the text described by move. (off by default)
Dave Love <fx@gnu.org>
parents:
diff changeset
3762 @item n
Dave Love <fx@gnu.org>
parents:
diff changeset
3763 Repeat latest @kbd{/} @kbd{?} (next).
Dave Love <fx@gnu.org>
parents:
diff changeset
3764 @item N
Dave Love <fx@gnu.org>
parents:
diff changeset
3765 Idem in opposite direction.
Dave Love <fx@gnu.org>
parents:
diff changeset
3766 @item %
Dave Love <fx@gnu.org>
parents:
diff changeset
3767 Find the next bracket and go to its match
Dave Love <fx@gnu.org>
parents:
diff changeset
3768 @item :[x,y]g/<string>/<cmd>
Dave Love <fx@gnu.org>
parents:
diff changeset
3769 @cindex text processing
Dave Love <fx@gnu.org>
parents:
diff changeset
3770 Search globally [from line x to y] for <string>
Dave Love <fx@gnu.org>
parents:
diff changeset
3771 and execute the Ex <cmd> on each occurrence.
Dave Love <fx@gnu.org>
parents:
diff changeset
3772 @item :[x,y]v/<string>/<cmd>
Dave Love <fx@gnu.org>
parents:
diff changeset
3773 Execute <cmd> on the lines that don't match.
Dave Love <fx@gnu.org>
parents:
diff changeset
3774 @item #g<move>
Dave Love <fx@gnu.org>
parents:
diff changeset
3775 Execute the last keyboard macro for each line in the region.
Dave Love <fx@gnu.org>
parents:
diff changeset
3776 @xref{Macros and Registers}, for more info.
Dave Love <fx@gnu.org>
parents:
diff changeset
3777 @item Q
Dave Love <fx@gnu.org>
parents:
diff changeset
3778 Query Replace.
Dave Love <fx@gnu.org>
parents:
diff changeset
3779 @item :ta <name>
Dave Love <fx@gnu.org>
parents:
diff changeset
3780 Search in the tags file where <name> is defined (file, line), and go to it.
Dave Love <fx@gnu.org>
parents:
diff changeset
3781 @item :[x,y]s/<pat>/<repl>/<f>
Dave Love <fx@gnu.org>
parents:
diff changeset
3782 Substitute (on lines x through y) the pattern <pat> (default the last
Dave Love <fx@gnu.org>
parents:
diff changeset
3783 pattern) with <repl>. Useful
Dave Love <fx@gnu.org>
parents:
diff changeset
3784 flags <f> are @samp{g} for @samp{global} (i.e.@: change every
Dave Love <fx@gnu.org>
parents:
diff changeset
3785 non-overlapping occurrence of <pat>) and @samp{c} for
Dave Love <fx@gnu.org>
parents:
diff changeset
3786 @samp{confirm} (type @samp{y} to confirm a particular
Dave Love <fx@gnu.org>
parents:
diff changeset
3787 substitution, else @samp{n}). Instead of @kbd{/} any
Dave Love <fx@gnu.org>
parents:
diff changeset
3788 punctuation character other than <space> <tab> and <lf> can be used as
Dave Love <fx@gnu.org>
parents:
diff changeset
3789 delimiter.
Dave Love <fx@gnu.org>
parents:
diff changeset
3790
Dave Love <fx@gnu.org>
parents:
diff changeset
3791 Note: @emph{The newline character (inserted as @kbd{C-qC-j})
Dave Love <fx@gnu.org>
parents:
diff changeset
3792 can be used in <repl>}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3793 @item &
Dave Love <fx@gnu.org>
parents:
diff changeset
3794 Repeat latest Ex substitute command, e.g.@: @kbd{:s/wrong/right}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3795 @item :global /<pattern>/<ex-command>
Dave Love <fx@gnu.org>
parents:
diff changeset
3796 @itemx :g /<pattern>/<ex-command>
Dave Love <fx@gnu.org>
parents:
diff changeset
3797 Execute <ex-command> on all lines that match <pattern>.
Dave Love <fx@gnu.org>
parents:
diff changeset
3798 @item :vglobal /<pattern>/<ex-command>
Dave Love <fx@gnu.org>
parents:
diff changeset
3799 @itemx :v /<pattern>/<ex-command>
Dave Love <fx@gnu.org>
parents:
diff changeset
3800 Execute <ex-command> on all lines that do not match <pattern>.
Dave Love <fx@gnu.org>
parents:
diff changeset
3801 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3802 @kindex @kbd{&}
Dave Love <fx@gnu.org>
parents:
diff changeset
3803 @findex @kbd{:substitute/<pat>/<repl>/<f>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3804 @kindex @kbd{Q}
Dave Love <fx@gnu.org>
parents:
diff changeset
3805 @kindex @kbd{#g<move>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3806 @findex @kbd{:v}
Dave Love <fx@gnu.org>
parents:
diff changeset
3807 @findex @kbd{:g}
Dave Love <fx@gnu.org>
parents:
diff changeset
3808 @findex @kbd{:global}
Dave Love <fx@gnu.org>
parents:
diff changeset
3809 @findex @kbd{:vglobal}
Dave Love <fx@gnu.org>
parents:
diff changeset
3810 @findex @kbd{:tag <name>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3811 @kindex @kbd{%}
Dave Love <fx@gnu.org>
parents:
diff changeset
3812 @kindex @kbd{N}
Dave Love <fx@gnu.org>
parents:
diff changeset
3813 @kindex @kbd{n}
Dave Love <fx@gnu.org>
parents:
diff changeset
3814 @kindex @kbd{g<move>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3815 @kindex @kbd{?<string>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3816 @kindex @kbd{/<string>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3817
Dave Love <fx@gnu.org>
parents:
diff changeset
3818 @node Yanking,Undoing,Search and Replace,Text Handling
Dave Love <fx@gnu.org>
parents:
diff changeset
3819 @subsection Yanking
Dave Love <fx@gnu.org>
parents:
diff changeset
3820
Dave Love <fx@gnu.org>
parents:
diff changeset
3821 @cindex cut and paste
Dave Love <fx@gnu.org>
parents:
diff changeset
3822 @cindex paste
Dave Love <fx@gnu.org>
parents:
diff changeset
3823
Dave Love <fx@gnu.org>
parents:
diff changeset
3824 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
3825 @item <count> y<move>
Dave Love <fx@gnu.org>
parents:
diff changeset
3826 Yank from begin to endpoint of <count><move>.
Dave Love <fx@gnu.org>
parents:
diff changeset
3827 @item <count> "<a-z>y<move>
Dave Love <fx@gnu.org>
parents:
diff changeset
3828 Yank from begin to endpoint of <count><move> to register.
Dave Love <fx@gnu.org>
parents:
diff changeset
3829 @item <count> "<A-Z>y<move>
Dave Love <fx@gnu.org>
parents:
diff changeset
3830 Yank from begin to endpoint of <count><move> and append
Dave Love <fx@gnu.org>
parents:
diff changeset
3831 to register.
Dave Love <fx@gnu.org>
parents:
diff changeset
3832 @item <count> yy
Dave Love <fx@gnu.org>
parents:
diff changeset
3833 <count> lines.
Dave Love <fx@gnu.org>
parents:
diff changeset
3834 @item <count> Y
Dave Love <fx@gnu.org>
parents:
diff changeset
3835 Idem (should be equivalent to @kbd{y$} though).
Dave Love <fx@gnu.org>
parents:
diff changeset
3836 @item m<a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
3837 Mark the cursor position with a letter.
Dave Love <fx@gnu.org>
parents:
diff changeset
3838 @item [<a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
3839 Show contents of textmarker.
Dave Love <fx@gnu.org>
parents:
diff changeset
3840 @item ]<a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
3841 Show contents of register.
Dave Love <fx@gnu.org>
parents:
diff changeset
3842 @item <count> ["<a-z1-9>]p
Dave Love <fx@gnu.org>
parents:
diff changeset
3843 Put the contents of the (default undo) buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
3844 <count> times after the cursor. The register will
Dave Love <fx@gnu.org>
parents:
diff changeset
3845 be automatically down-cased.
Dave Love <fx@gnu.org>
parents:
diff changeset
3846 @item <count> ["<a-z1-9>]P
Dave Love <fx@gnu.org>
parents:
diff changeset
3847 Put the contents of the (default undo) buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
3848 <count> times before the cursor. The register will
Dave Love <fx@gnu.org>
parents:
diff changeset
3849 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3850 @kindex @kbd{P}
Dave Love <fx@gnu.org>
parents:
diff changeset
3851 @kindex @kbd{p}
Dave Love <fx@gnu.org>
parents:
diff changeset
3852 @kindex @kbd{"<a-z1-9>p}
Dave Love <fx@gnu.org>
parents:
diff changeset
3853 @kindex @kbd{"<a-z1-9>P}
Dave Love <fx@gnu.org>
parents:
diff changeset
3854 @kindex @kbd{]<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3855 @kindex @kbd{[<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3856 @kindex @kbd{m<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3857 @kindex @kbd{Y}
Dave Love <fx@gnu.org>
parents:
diff changeset
3858 @kindex @kbd{yy}
Dave Love <fx@gnu.org>
parents:
diff changeset
3859 @kindex @kbd{"<A-Z>y<move>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3860 @kindex @kbd{"<a-z>y<move>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3861 @kindex @kbd{y<move>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3862 @kindex @kbd{yank}
Dave Love <fx@gnu.org>
parents:
diff changeset
3863 @findex @kbd{:yank}
Dave Love <fx@gnu.org>
parents:
diff changeset
3864
Dave Love <fx@gnu.org>
parents:
diff changeset
3865 @node Undoing,, Yanking,Text Handling
Dave Love <fx@gnu.org>
parents:
diff changeset
3866 @subsection Undoing
Dave Love <fx@gnu.org>
parents:
diff changeset
3867
Dave Love <fx@gnu.org>
parents:
diff changeset
3868 @cindex undo
Dave Love <fx@gnu.org>
parents:
diff changeset
3869 @cindex backup files
Dave Love <fx@gnu.org>
parents:
diff changeset
3870
Dave Love <fx@gnu.org>
parents:
diff changeset
3871 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
3872 @item u U
Dave Love <fx@gnu.org>
parents:
diff changeset
3873 Undo the latest change.
Dave Love <fx@gnu.org>
parents:
diff changeset
3874 @item .
Dave Love <fx@gnu.org>
parents:
diff changeset
3875 Repeat undo.
Dave Love <fx@gnu.org>
parents:
diff changeset
3876 @item :q!
Dave Love <fx@gnu.org>
parents:
diff changeset
3877 Quit Vi without writing.
Dave Love <fx@gnu.org>
parents:
diff changeset
3878 @item :e!
Dave Love <fx@gnu.org>
parents:
diff changeset
3879 Re-edit a messed-up file.
Dave Love <fx@gnu.org>
parents:
diff changeset
3880 @item :rec
Dave Love <fx@gnu.org>
parents:
diff changeset
3881 Recover file from autosave. Viper also creates backup files
Dave Love <fx@gnu.org>
parents:
diff changeset
3882 that have a @samp{~} appended to them.
Dave Love <fx@gnu.org>
parents:
diff changeset
3883 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3884 @findex @kbd{:rec}
Dave Love <fx@gnu.org>
parents:
diff changeset
3885 @findex @kbd{:e!}
Dave Love <fx@gnu.org>
parents:
diff changeset
3886 @findex @kbd{:q!}
Dave Love <fx@gnu.org>
parents:
diff changeset
3887 @kindex @kbd{.}
Dave Love <fx@gnu.org>
parents:
diff changeset
3888 @kindex @kbd{U}
Dave Love <fx@gnu.org>
parents:
diff changeset
3889 @kindex @kbd{u}
Dave Love <fx@gnu.org>
parents:
diff changeset
3890
Dave Love <fx@gnu.org>
parents:
diff changeset
3891 @node Display, File and Buffer Handling, Text Handling, Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
3892 @section Display
Dave Love <fx@gnu.org>
parents:
diff changeset
3893
Dave Love <fx@gnu.org>
parents:
diff changeset
3894 @cindex scrolling
Dave Love <fx@gnu.org>
parents:
diff changeset
3895
Dave Love <fx@gnu.org>
parents:
diff changeset
3896 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
3897 @item C-g
Dave Love <fx@gnu.org>
parents:
diff changeset
3898 At user level 1,
Dave Love <fx@gnu.org>
parents:
diff changeset
3899 give file name, status, current line number
Dave Love <fx@gnu.org>
parents:
diff changeset
3900 and relative position.@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3901 At user levels 2 and higher, abort the current command.
Dave Love <fx@gnu.org>
parents:
diff changeset
3902 @item C-c g
Dave Love <fx@gnu.org>
parents:
diff changeset
3903 Give file name, status, current line number and relative position -- all
Dave Love <fx@gnu.org>
parents:
diff changeset
3904 user levels.
Dave Love <fx@gnu.org>
parents:
diff changeset
3905 @item C-l
Dave Love <fx@gnu.org>
parents:
diff changeset
3906 Refresh the screen.
Dave Love <fx@gnu.org>
parents:
diff changeset
3907 @item <count> C-e
Dave Love <fx@gnu.org>
parents:
diff changeset
3908 Expose <count> more lines at bottom, cursor stays put (if possible).
Dave Love <fx@gnu.org>
parents:
diff changeset
3909 @item <count> C-y
Dave Love <fx@gnu.org>
parents:
diff changeset
3910 Expose <count> more lines at top, cursor stays put (if possible).
Dave Love <fx@gnu.org>
parents:
diff changeset
3911 @item <count> C-d
Dave Love <fx@gnu.org>
parents:
diff changeset
3912 Scroll <count> lines downward (default the number of the previous scroll;
Dave Love <fx@gnu.org>
parents:
diff changeset
3913 initialization: half a page).
Dave Love <fx@gnu.org>
parents:
diff changeset
3914 @item <count> C-u
Dave Love <fx@gnu.org>
parents:
diff changeset
3915 Scroll <count> lines upward (default the number of the previous scroll;
Dave Love <fx@gnu.org>
parents:
diff changeset
3916 initialization: half a page).
Dave Love <fx@gnu.org>
parents:
diff changeset
3917 @item <count> C-f
Dave Love <fx@gnu.org>
parents:
diff changeset
3918 <count> pages forward.
Dave Love <fx@gnu.org>
parents:
diff changeset
3919 @item <count> C-b
Dave Love <fx@gnu.org>
parents:
diff changeset
3920 <count> pages backward (in older versions @kbd{C-b} only works without count).
Dave Love <fx@gnu.org>
parents:
diff changeset
3921 @item <count> z<cr>
Dave Love <fx@gnu.org>
parents:
diff changeset
3922 @item zH
Dave Love <fx@gnu.org>
parents:
diff changeset
3923 Put line <count> at the top of the window (default the current line).
Dave Love <fx@gnu.org>
parents:
diff changeset
3924 @item <count> z-
Dave Love <fx@gnu.org>
parents:
diff changeset
3925 @item zL
Dave Love <fx@gnu.org>
parents:
diff changeset
3926 Put line <count> at the bottom of the window
Dave Love <fx@gnu.org>
parents:
diff changeset
3927 (default the current line).
Dave Love <fx@gnu.org>
parents:
diff changeset
3928 @item <count> z.
Dave Love <fx@gnu.org>
parents:
diff changeset
3929 @item zM
Dave Love <fx@gnu.org>
parents:
diff changeset
3930 Put line <count> in the center of the window
Dave Love <fx@gnu.org>
parents:
diff changeset
3931 (default the current line).
Dave Love <fx@gnu.org>
parents:
diff changeset
3932 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3933 @kindex @kbd{zM}
Dave Love <fx@gnu.org>
parents:
diff changeset
3934 @kindex @kbd{zL}
Dave Love <fx@gnu.org>
parents:
diff changeset
3935 @kindex @kbd{zH}
Dave Love <fx@gnu.org>
parents:
diff changeset
3936 @kindex @kbd{z<cr>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3937 @kindex @kbd{z.}
Dave Love <fx@gnu.org>
parents:
diff changeset
3938 @kindex @kbd{z-}
Dave Love <fx@gnu.org>
parents:
diff changeset
3939 @kindex @kbd{z<cr>}
Dave Love <fx@gnu.org>
parents:
diff changeset
3940 @kindex @kbd{C-b}
Dave Love <fx@gnu.org>
parents:
diff changeset
3941 @kindex @kbd{C-f}
Dave Love <fx@gnu.org>
parents:
diff changeset
3942 @kindex @kbd{C-u}
Dave Love <fx@gnu.org>
parents:
diff changeset
3943 @kindex @kbd{C-d}
Dave Love <fx@gnu.org>
parents:
diff changeset
3944 @kindex @kbd{C-y}
Dave Love <fx@gnu.org>
parents:
diff changeset
3945 @kindex @kbd{C-e}
Dave Love <fx@gnu.org>
parents:
diff changeset
3946 @kindex @kbd{C-l}
Dave Love <fx@gnu.org>
parents:
diff changeset
3947 @kindex @kbd{C-g}
Dave Love <fx@gnu.org>
parents:
diff changeset
3948
Dave Love <fx@gnu.org>
parents:
diff changeset
3949
Dave Love <fx@gnu.org>
parents:
diff changeset
3950 @node File and Buffer Handling, Mapping, Display,Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
3951 @section File and Buffer Handling
Dave Love <fx@gnu.org>
parents:
diff changeset
3952
Dave Love <fx@gnu.org>
parents:
diff changeset
3953 @cindex multiple files
Dave Love <fx@gnu.org>
parents:
diff changeset
3954
Dave Love <fx@gnu.org>
parents:
diff changeset
3955 In all file handling commands, space should be typed before entering the file
Dave Love <fx@gnu.org>
parents:
diff changeset
3956 name. If you need to type a modifier, such as @kbd{>>} or @kbd{!}, don't
Dave Love <fx@gnu.org>
parents:
diff changeset
3957 put any space between the command and the modifier.
Dave Love <fx@gnu.org>
parents:
diff changeset
3958
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
3959 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
3960 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
3961 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
3962 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
3963
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3964 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
3965 @item :q
Dave Love <fx@gnu.org>
parents:
diff changeset
3966 Quit buffer except if modified.
Dave Love <fx@gnu.org>
parents:
diff changeset
3967 @item :q!
Dave Love <fx@gnu.org>
parents:
diff changeset
3968 Quit buffer without checking. In Viper, these two commands
Dave Love <fx@gnu.org>
parents:
diff changeset
3969 are identical. Confirmation is required if exiting modified buffers that
Dave Love <fx@gnu.org>
parents:
diff changeset
3970 visit files.
Dave Love <fx@gnu.org>
parents:
diff changeset
3971 @item :suspend
Dave Love <fx@gnu.org>
parents:
diff changeset
3972 @item :stop
Dave Love <fx@gnu.org>
parents:
diff changeset
3973 Suspend Viper
Dave Love <fx@gnu.org>
parents:
diff changeset
3974 @item :[x,y] w
Dave Love <fx@gnu.org>
parents:
diff changeset
3975 Write the file. Viper makes sure that a final newline is always added to
Dave Love <fx@gnu.org>
parents:
diff changeset
3976 any file where this newline is missing. This is done by setting Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
3977 variable @code{require-final-newline} to @code{t}. If you don't like this
Dave Love <fx@gnu.org>
parents:
diff changeset
3978 feature, use @code{setq-default} to set @code{require-final-newline} to
Dave Love <fx@gnu.org>
parents:
diff changeset
3979 @code{nil}. This must be done in @file{.viper} file.
Dave Love <fx@gnu.org>
parents:
diff changeset
3980 @item :[x,y] w <name>
Dave Love <fx@gnu.org>
parents:
diff changeset
3981 Write to the file <name>.
Dave Love <fx@gnu.org>
parents:
diff changeset
3982 @item :[x,y] w>> <name>
Dave Love <fx@gnu.org>
parents:
diff changeset
3983 Append the buffer to the file <name>. There should be no space between
Dave Love <fx@gnu.org>
parents:
diff changeset
3984 @kbd{w} and @kbd{>>}. Type space after the @kbd{>>} and see what happens.
Dave Love <fx@gnu.org>
parents:
diff changeset
3985 @item :w!@: <name>
Dave Love <fx@gnu.org>
parents:
diff changeset
3986 Overwrite the file <name>. In Viper, @kbd{:w} and @kbd{:w!} are identical.
Dave Love <fx@gnu.org>
parents:
diff changeset
3987 Confirmation is required for writing to an existing file (if this is not
Dave Love <fx@gnu.org>
parents:
diff changeset
3988 the file the buffer is visiting) or to a read-only file.
Dave Love <fx@gnu.org>
parents:
diff changeset
3989 @item :x,y w <name>
Dave Love <fx@gnu.org>
parents:
diff changeset
3990 Write lines x through y to the file <name>.
Dave Love <fx@gnu.org>
parents:
diff changeset
3991 @item :wq
Dave Love <fx@gnu.org>
parents:
diff changeset
3992 Write the file and kill buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
3993 @item :r <file> [<file> ...]
Dave Love <fx@gnu.org>
parents:
diff changeset
3994 Read file into a buffer, inserting its contents after the current line.
Dave Love <fx@gnu.org>
parents:
diff changeset
3995 @item :xit
Dave Love <fx@gnu.org>
parents:
diff changeset
3996 Same as @kbd{:wq}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3997 @item :Write
Dave Love <fx@gnu.org>
parents:
diff changeset
3998 @itemx :W
Dave Love <fx@gnu.org>
parents:
diff changeset
3999 Save all unsaved buffers, asking for confirmation.
Dave Love <fx@gnu.org>
parents:
diff changeset
4000 @item :WWrite
Dave Love <fx@gnu.org>
parents:
diff changeset
4001 @itemx :WW
Dave Love <fx@gnu.org>
parents:
diff changeset
4002 Like @kbd{W}, but without asking for confirmation.
Dave Love <fx@gnu.org>
parents:
diff changeset
4003 @item ZZ
Dave Love <fx@gnu.org>
parents:
diff changeset
4004 Save current buffer and kill it. If user level is 1, then save all files
Dave Love <fx@gnu.org>
parents:
diff changeset
4005 and kill Emacs. Killing Emacs is the wrong way to use it, so you should
Dave Love <fx@gnu.org>
parents:
diff changeset
4006 switch to higher user levels as soon as possible.
Dave Love <fx@gnu.org>
parents:
diff changeset
4007 @item :x [<file>]
Dave Love <fx@gnu.org>
parents:
diff changeset
4008 Save and kill buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4009 @item :x!@: [<file>]
Dave Love <fx@gnu.org>
parents:
diff changeset
4010 @kbd{:w![<file>]} and @kbd{:q}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4011 @item :pre
Dave Love <fx@gnu.org>
parents:
diff changeset
4012 Preserve the file -- autosave buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
4013 @item :rec
Dave Love <fx@gnu.org>
parents:
diff changeset
4014 Recover file from autosave.
42288
3ce98f3e0608 2001-12-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 39901
diff changeset
4015 @item :f [<file>]
3ce98f3e0608 2001-12-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 39901
diff changeset
4016 without the argument, prints file name and character/line information afout
3ce98f3e0608 2001-12-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 39901
diff changeset
4017 the currently visited file. With an argument, sets the currently visited
3ce98f3e0608 2001-12-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 39901
diff changeset
4018 filename to @file{file}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4019 @item :cd [<dir>]
Dave Love <fx@gnu.org>
parents:
diff changeset
4020 Set the working directory to <dir> (default home directory).
Dave Love <fx@gnu.org>
parents:
diff changeset
4021 @item :pwd
Dave Love <fx@gnu.org>
parents:
diff changeset
4022 Print present working directory.
Dave Love <fx@gnu.org>
parents:
diff changeset
4023 @item :e [+<cmd>] <files>
Dave Love <fx@gnu.org>
parents:
diff changeset
4024 Edit files. If no filename is given, edit the file visited by the current
Dave Love <fx@gnu.org>
parents:
diff changeset
4025 buffer. If buffer was modified or the file changed on disk, ask for
Dave Love <fx@gnu.org>
parents:
diff changeset
4026 confirmation. Unlike Vi, Viper allows @kbd{:e} to take multiple arguments.
Dave Love <fx@gnu.org>
parents:
diff changeset
4027 The first file is edited the same way as in Vi. The rest are visited
Dave Love <fx@gnu.org>
parents:
diff changeset
4028 in the usual Emacs way.
Dave Love <fx@gnu.org>
parents:
diff changeset
4029 @item :e!@: [+<cmd>] <files>
Dave Love <fx@gnu.org>
parents:
diff changeset
4030 Re-edit file. If no filename, re-edit current file.
Dave Love <fx@gnu.org>
parents:
diff changeset
4031 In Viper, unlike Vi, @kbd{e!} is identical to @kbd{:e}. In both cases, the
Dave Love <fx@gnu.org>
parents:
diff changeset
4032 user is asked to confirm if there is a danger of discarding changes to a
Dave Love <fx@gnu.org>
parents:
diff changeset
4033 buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4034 @item :q!
Dave Love <fx@gnu.org>
parents:
diff changeset
4035 Quit Vi without writing.
Dave Love <fx@gnu.org>
parents:
diff changeset
4036 @item C-^
Dave Love <fx@gnu.org>
parents:
diff changeset
4037 Edit the alternate (normally the previous) file.
Dave Love <fx@gnu.org>
parents:
diff changeset
4038 @item :rew
Dave Love <fx@gnu.org>
parents:
diff changeset
4039 Obsolete
Dave Love <fx@gnu.org>
parents:
diff changeset
4040 @item :args
Dave Love <fx@gnu.org>
parents:
diff changeset
4041 List files not shown anywhere with counts for next
Dave Love <fx@gnu.org>
parents:
diff changeset
4042 @item :n [count] [+<cmd>] [<files>]
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
4043 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
4044 @item :N [count] [+<cmd>] [<files>]
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4045 Like @kbd{:n}, but the meaning of the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
4046 @var{ex-cycle-other-window} is reversed.
Dave Love <fx@gnu.org>
parents:
diff changeset
4047 @item :b
Dave Love <fx@gnu.org>
parents:
diff changeset
4048 Switch to another buffer. If @var{ex-cycle-other-window} is @code{t},
Dave Love <fx@gnu.org>
parents:
diff changeset
4049 switch in another window. Buffer completion is supported.
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
4050 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
4051 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
4052 but better alternatives are also available in Emacs (e.g.,
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
4053 @code{iswitchb-read-buffer}).
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
4054 @vindex @var{viper-read-buffer-function}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4055 @item :B
Dave Love <fx@gnu.org>
parents:
diff changeset
4056 Like @kbd{:b}, but the meaning of @var{ex-cycle-other-window} is reversed.
Dave Love <fx@gnu.org>
parents:
diff changeset
4057 @item :<address>r <name>
Dave Love <fx@gnu.org>
parents:
diff changeset
4058 Read the file <name> into the buffer after the line <address>.
Dave Love <fx@gnu.org>
parents:
diff changeset
4059 @item v, V, C-v
Dave Love <fx@gnu.org>
parents:
diff changeset
4060 Edit a file in current or another window, or in another frame. File name
Dave Love <fx@gnu.org>
parents:
diff changeset
4061 is typed in Minibuffer. File completion and history are supported.
Dave Love <fx@gnu.org>
parents:
diff changeset
4062 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
4063 @kindex @kbd{v}
Dave Love <fx@gnu.org>
parents:
diff changeset
4064 @kindex @kbd{V}
Dave Love <fx@gnu.org>
parents:
diff changeset
4065 @findex @kbd{:args}
Dave Love <fx@gnu.org>
parents:
diff changeset
4066 @findex @kbd{:rew}
Dave Love <fx@gnu.org>
parents:
diff changeset
4067 @kindex @kbd{C-^}
Dave Love <fx@gnu.org>
parents:
diff changeset
4068 @findex @kbd{:e!@: [<files>]}
Dave Love <fx@gnu.org>
parents:
diff changeset
4069 @findex @kbd{:e [<files>]}
Dave Love <fx@gnu.org>
parents:
diff changeset
4070 @findex @kbd{:edit [<files>]}
Dave Love <fx@gnu.org>
parents:
diff changeset
4071 @findex @kbd{:edit!@: [<files>]}
Dave Love <fx@gnu.org>
parents:
diff changeset
4072 @findex @kbd{:q!}
Dave Love <fx@gnu.org>
parents:
diff changeset
4073 @findex @kbd{:q}
Dave Love <fx@gnu.org>
parents:
diff changeset
4074 @findex @kbd{:quit}
Dave Love <fx@gnu.org>
parents:
diff changeset
4075 @findex @kbd{:quit!}
Dave Love <fx@gnu.org>
parents:
diff changeset
4076 @findex @kbd{:f}
Dave Love <fx@gnu.org>
parents:
diff changeset
4077 @findex @kbd{:rec}
Dave Love <fx@gnu.org>
parents:
diff changeset
4078 @findex @kbd{:r}
Dave Love <fx@gnu.org>
parents:
diff changeset
4079 @findex @kbd{:read}
Dave Love <fx@gnu.org>
parents:
diff changeset
4080 @findex @kbd{:pre}
Dave Love <fx@gnu.org>
parents:
diff changeset
4081 @kindex @kbd{ZZ}
Dave Love <fx@gnu.org>
parents:
diff changeset
4082 @findex @kbd{:wq}
Dave Love <fx@gnu.org>
parents:
diff changeset
4083 @findex @kbd{:w <file>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4084 @findex @kbd{:w!@: <file>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4085 @findex @kbd{:w >> <file>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4086 @findex @kbd{:write <file>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4087 @findex @kbd{:write!@: <file>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4088 @findex @kbd{:write >> <file>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4089 @findex @kbd{:W}
Dave Love <fx@gnu.org>
parents:
diff changeset
4090 @findex @kbd{:WW}
Dave Love <fx@gnu.org>
parents:
diff changeset
4091 @findex @kbd{:Write}
Dave Love <fx@gnu.org>
parents:
diff changeset
4092 @findex @kbd{:WWrite}
Dave Love <fx@gnu.org>
parents:
diff changeset
4093 @findex @kbd{:WWrite}
Dave Love <fx@gnu.org>
parents:
diff changeset
4094 @findex @kbd{:x}
Dave Love <fx@gnu.org>
parents:
diff changeset
4095 @findex @kbd{:x!}
Dave Love <fx@gnu.org>
parents:
diff changeset
4096 @findex @kbd{:suspend}
Dave Love <fx@gnu.org>
parents:
diff changeset
4097 @findex @kbd{:stop}
Dave Love <fx@gnu.org>
parents:
diff changeset
4098 @findex @kbd{:n [<count> | <file>]}
Dave Love <fx@gnu.org>
parents:
diff changeset
4099 @findex @kbd{:cd [<dir>]}
Dave Love <fx@gnu.org>
parents:
diff changeset
4100 @findex @kbd{:pwd}
Dave Love <fx@gnu.org>
parents:
diff changeset
4101
Dave Love <fx@gnu.org>
parents:
diff changeset
4102 @node Mapping, Shell Commands, File and Buffer Handling, Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
4103 @section Mapping
Dave Love <fx@gnu.org>
parents:
diff changeset
4104
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38866
diff changeset
4105 @cindex key bindings
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4106 @cindex key mapping
Dave Love <fx@gnu.org>
parents:
diff changeset
4107
Dave Love <fx@gnu.org>
parents:
diff changeset
4108 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
4109 @item :map <string>
Dave Love <fx@gnu.org>
parents:
diff changeset
4110 Start defining a Vi-style keyboard macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
4111 For instance, typing
Dave Love <fx@gnu.org>
parents:
diff changeset
4112 @kbd{:map www} followed by @kbd{:!wc %} and then typing @kbd{C-x )}
Dave Love <fx@gnu.org>
parents:
diff changeset
4113 will cause @kbd{www} to run wc on
Dave Love <fx@gnu.org>
parents:
diff changeset
4114 current file (Vi replaces @samp{%} with the current file name).
Dave Love <fx@gnu.org>
parents:
diff changeset
4115 @item C-x )
Dave Love <fx@gnu.org>
parents:
diff changeset
4116 Finish defining a keyboard macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
4117 In Viper, this command completes the process of defining all keyboard
Dave Love <fx@gnu.org>
parents:
diff changeset
4118 macros, whether they are Emacs-style or Vi-style.
Dave Love <fx@gnu.org>
parents:
diff changeset
4119 This is a departure from Vi, needed to allow WYSIWYG mapping of
Dave Love <fx@gnu.org>
parents:
diff changeset
4120 keyboard macros and to permit the use of function keys and arbitrary Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
4121 functions in the macros.
Dave Love <fx@gnu.org>
parents:
diff changeset
4122 @item :unmap <string>
Dave Love <fx@gnu.org>
parents:
diff changeset
4123 Deprive <string> of its mappings in Vi state.
Dave Love <fx@gnu.org>
parents:
diff changeset
4124 @item :map!@: <string>
Dave Love <fx@gnu.org>
parents:
diff changeset
4125 Map a macro for Insert state.
Dave Love <fx@gnu.org>
parents:
diff changeset
4126 @item :unmap!@: <string>
Dave Love <fx@gnu.org>
parents:
diff changeset
4127 Deprive <string> of its mapping in Insert state (see @kbd{:unmap}).
Dave Love <fx@gnu.org>
parents:
diff changeset
4128 @item @@<a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
4129 In Vi state,
Dave Love <fx@gnu.org>
parents:
diff changeset
4130 execute the contents of register as a command.
Dave Love <fx@gnu.org>
parents:
diff changeset
4131 @item @@@@
Dave Love <fx@gnu.org>
parents:
diff changeset
4132 In Vi state,
Dave Love <fx@gnu.org>
parents:
diff changeset
4133 repeat last register command.
Dave Love <fx@gnu.org>
parents:
diff changeset
4134 @item @@#
Dave Love <fx@gnu.org>
parents:
diff changeset
4135 In Vi state,
Dave Love <fx@gnu.org>
parents:
diff changeset
4136 begin keyboard macro. End with @@<a-z>. This will
Dave Love <fx@gnu.org>
parents:
diff changeset
4137 put the macro in the proper register. Register will
Dave Love <fx@gnu.org>
parents:
diff changeset
4138 be automatically down-cased.
Dave Love <fx@gnu.org>
parents:
diff changeset
4139 @xref{Macros and Registers}, for more info.
Dave Love <fx@gnu.org>
parents:
diff changeset
4140 @item @@!<a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
4141 In Vi state,
Dave Love <fx@gnu.org>
parents:
diff changeset
4142 yank anonymous macro to register
Dave Love <fx@gnu.org>
parents:
diff changeset
4143 @item *
Dave Love <fx@gnu.org>
parents:
diff changeset
4144 In Vi state,
Dave Love <fx@gnu.org>
parents:
diff changeset
4145 execute anonymous macro (defined by C-x( and C-x )).
Dave Love <fx@gnu.org>
parents:
diff changeset
4146 @item C-x e
Dave Love <fx@gnu.org>
parents:
diff changeset
4147 Like @kbd{*}, but works in all Viper states.
Dave Love <fx@gnu.org>
parents:
diff changeset
4148 @item #g<move>
Dave Love <fx@gnu.org>
parents:
diff changeset
4149 Execute the last keyboard macro for each line in the region.
Dave Love <fx@gnu.org>
parents:
diff changeset
4150 @xref{Macros and Registers}, for more info.
Dave Love <fx@gnu.org>
parents:
diff changeset
4151 @item [<a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
4152 Show contents of textmarker.
Dave Love <fx@gnu.org>
parents:
diff changeset
4153 @item ]<a-z>
Dave Love <fx@gnu.org>
parents:
diff changeset
4154 Show contents of register.
Dave Love <fx@gnu.org>
parents:
diff changeset
4155 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
4156 @kindex @kbd{]<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4157 @kindex @kbd{[<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4158 @kindex @kbd{#g<move>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4159 @kindex @kbd{*}
Dave Love <fx@gnu.org>
parents:
diff changeset
4160 @kindex @kbd{@@!<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4161 @kindex @kbd{@@#}
Dave Love <fx@gnu.org>
parents:
diff changeset
4162 @kindex @kbd{@@@@}
Dave Love <fx@gnu.org>
parents:
diff changeset
4163 @kindex @kbd{@@<a-z>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4164 @findex @kbd{:unmap <char>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4165 @findex @kbd{:map <char> <seq>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4166 @findex @kbd{:unmap!@: <char>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4167 @findex @kbd{:map!@: <char> <seq>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4168
Dave Love <fx@gnu.org>
parents:
diff changeset
4169 @node Shell Commands, Options, Mapping, Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
4170 @section Shell Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
4171
Dave Love <fx@gnu.org>
parents:
diff changeset
4172 @cindex % (Current file)
Dave Love <fx@gnu.org>
parents:
diff changeset
4173
26263
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
4174 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
4175 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
4176 @cindex @samp{%} (Ex address)
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
4177 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
4178 the whole file.
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
4179 @cindex @samp{#} (Previous file)
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
4180 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
4181 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
4182 the VI sense if you have one window.@refill
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
4183
4f315ca65976 *** empty log message ***
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 25829
diff changeset
4184 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
4185 @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
4186 <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
4187 better mechanism.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4188
Dave Love <fx@gnu.org>
parents:
diff changeset
4189 @cindex shell commands
Dave Love <fx@gnu.org>
parents:
diff changeset
4190
Dave Love <fx@gnu.org>
parents:
diff changeset
4191 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
4192 @item :sh
Dave Love <fx@gnu.org>
parents:
diff changeset
4193 Execute a subshell in another window
Dave Love <fx@gnu.org>
parents:
diff changeset
4194 @item :[x,y]!<cmd>
Dave Love <fx@gnu.org>
parents:
diff changeset
4195 Execute a shell <cmd> [on lines x through y;
Dave Love <fx@gnu.org>
parents:
diff changeset
4196 % is replace by current file, \% is changed to %
Dave Love <fx@gnu.org>
parents:
diff changeset
4197 @item :[x,y]!!@: [<args>]
Dave Love <fx@gnu.org>
parents:
diff changeset
4198 Repeat last shell command [and append <args>].
Dave Love <fx@gnu.org>
parents:
diff changeset
4199 @item :!<cmd>
Dave Love <fx@gnu.org>
parents:
diff changeset
4200 Just execute command and display result in a buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4201 @item :!!@: <args>
Dave Love <fx@gnu.org>
parents:
diff changeset
4202 Repeat last shell command and append <args>
Dave Love <fx@gnu.org>
parents:
diff changeset
4203 @item <count> !<move><cmd>
Dave Love <fx@gnu.org>
parents:
diff changeset
4204 The shell executes <cmd>, with standard
Dave Love <fx@gnu.org>
parents:
diff changeset
4205 input the lines described by <count><move>,
Dave Love <fx@gnu.org>
parents:
diff changeset
4206 next the standard output replaces those lines
Dave Love <fx@gnu.org>
parents:
diff changeset
4207 (think of @samp{cb}, @samp{sort}, @samp{nroff}, etc.).
Dave Love <fx@gnu.org>
parents:
diff changeset
4208 @item <count> !!<cmd>
Dave Love <fx@gnu.org>
parents:
diff changeset
4209 Give <count> lines as standard input to the
Dave Love <fx@gnu.org>
parents:
diff changeset
4210 shell <cmd>, next let the standard output
Dave Love <fx@gnu.org>
parents:
diff changeset
4211 replace those lines.
Dave Love <fx@gnu.org>
parents:
diff changeset
4212 @item :[x,y] w !<cmd>
Dave Love <fx@gnu.org>
parents:
diff changeset
4213 Let lines x to y be standard input for <cmd>
Dave Love <fx@gnu.org>
parents:
diff changeset
4214 (notice the <sp> between @kbd{w} and @kbd{!}).
Dave Love <fx@gnu.org>
parents:
diff changeset
4215 @item :<address>r !<cmd>
Dave Love <fx@gnu.org>
parents:
diff changeset
4216 Put the output of <cmd> after the line <address> (default current).
Dave Love <fx@gnu.org>
parents:
diff changeset
4217 @item :<address>r <name>
Dave Love <fx@gnu.org>
parents:
diff changeset
4218 Read the file <name> into the buffer after the line <address> (default
Dave Love <fx@gnu.org>
parents:
diff changeset
4219 current).
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
4220 @item :make
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
4221 Run the make command in the current directory.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4222 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
4223 @findex @kbd{:<address>r <name>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4224 @findex @kbd{:<address>r !<cmd>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4225 @findex @kbd{!<cmd>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4226 @findex @kbd{!!<cmd>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4227 @findex @kbd{!<move><cmd>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4228 @findex @kbd{:w !<cmd>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4229 @findex @kbd{:x,y w !<cmd>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4230 @findex @kbd{:!!@: <args>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4231 @findex @kbd{:!<cmd>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4232 @findex @kbd{:sh}
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
4233 @findex @kbd{:make}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4234
Dave Love <fx@gnu.org>
parents:
diff changeset
4235 @node Options,Emacs Related Commands,Shell Commands,Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
4236 @section Options
Dave Love <fx@gnu.org>
parents:
diff changeset
4237
Dave Love <fx@gnu.org>
parents:
diff changeset
4238 @cindex Vi options
Dave Love <fx@gnu.org>
parents:
diff changeset
4239
Dave Love <fx@gnu.org>
parents:
diff changeset
4240 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
4241 @item autoindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4242 @itemx ai
Dave Love <fx@gnu.org>
parents:
diff changeset
4243 @cindex autoindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4244 autoindent -- In append mode after a <cr> the
Dave Love <fx@gnu.org>
parents:
diff changeset
4245 cursor will move directly below the first
Dave Love <fx@gnu.org>
parents:
diff changeset
4246 character on the previous line.
Dave Love <fx@gnu.org>
parents:
diff changeset
4247 This setting affects the current buffer only.
Dave Love <fx@gnu.org>
parents:
diff changeset
4248 @item autoindent-global
Dave Love <fx@gnu.org>
parents:
diff changeset
4249 @itemx ai-global
Dave Love <fx@gnu.org>
parents:
diff changeset
4250 Same as `autoindent', but affects all buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
4251 @item noautoindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4252 @itemx noai
Dave Love <fx@gnu.org>
parents:
diff changeset
4253 Cancel autoindent.
Dave Love <fx@gnu.org>
parents:
diff changeset
4254 @item noautoindent-global
Dave Love <fx@gnu.org>
parents:
diff changeset
4255 @itemx noai-g
Dave Love <fx@gnu.org>
parents:
diff changeset
4256 Cancel autoindent-global.
Dave Love <fx@gnu.org>
parents:
diff changeset
4257 @item ignorecase
Dave Love <fx@gnu.org>
parents:
diff changeset
4258 @itemx ic
Dave Love <fx@gnu.org>
parents:
diff changeset
4259 @cindex case and searching
Dave Love <fx@gnu.org>
parents:
diff changeset
4260 ignorecase -- No distinction between upper and lower cases when searching.
Dave Love <fx@gnu.org>
parents:
diff changeset
4261 @item noignorecase
Dave Love <fx@gnu.org>
parents:
diff changeset
4262 @itemx noic
Dave Love <fx@gnu.org>
parents:
diff changeset
4263 Cancel ignorecase.
Dave Love <fx@gnu.org>
parents:
diff changeset
4264 @item magic
Dave Love <fx@gnu.org>
parents:
diff changeset
4265 @itemx ma
Dave Love <fx@gnu.org>
parents:
diff changeset
4266 @cindex literal searching
Dave Love <fx@gnu.org>
parents:
diff changeset
4267 Regular expressions used in searches; nomagic means no regexps.
Dave Love <fx@gnu.org>
parents:
diff changeset
4268 @item nomagic
Dave Love <fx@gnu.org>
parents:
diff changeset
4269 @item noma
Dave Love <fx@gnu.org>
parents:
diff changeset
4270 Cancel magic.
Dave Love <fx@gnu.org>
parents:
diff changeset
4271 @item readonly
Dave Love <fx@gnu.org>
parents:
diff changeset
4272 @itemx ro
Dave Love <fx@gnu.org>
parents:
diff changeset
4273 @cindex readonly files
Dave Love <fx@gnu.org>
parents:
diff changeset
4274 readonly -- The file is not to be changed.
Dave Love <fx@gnu.org>
parents:
diff changeset
4275 If the user attempts to write to this file, confirmation will be requested.
Dave Love <fx@gnu.org>
parents:
diff changeset
4276 @item noreadonly
Dave Love <fx@gnu.org>
parents:
diff changeset
4277 @itemx noro
Dave Love <fx@gnu.org>
parents:
diff changeset
4278 Cancel readonly.
Dave Love <fx@gnu.org>
parents:
diff changeset
4279 @item shell=<string>
Dave Love <fx@gnu.org>
parents:
diff changeset
4280 @itemx sh=<string>
Dave Love <fx@gnu.org>
parents:
diff changeset
4281 @cindex shell
Dave Love <fx@gnu.org>
parents:
diff changeset
4282 shell -- The program to be used for shell escapes
Dave Love <fx@gnu.org>
parents:
diff changeset
4283 (default @samp{$SHELL} (default @file{/bin/sh})).
Dave Love <fx@gnu.org>
parents:
diff changeset
4284 @item shiftwidth=<count>
Dave Love <fx@gnu.org>
parents:
diff changeset
4285 @itemx sw=<count>
Dave Love <fx@gnu.org>
parents:
diff changeset
4286 @cindex layout
Dave Love <fx@gnu.org>
parents:
diff changeset
4287 @cindex shifting text
Dave Love <fx@gnu.org>
parents:
diff changeset
4288 shiftwidth -- Gives the shiftwidth (default 8 positions).
Dave Love <fx@gnu.org>
parents:
diff changeset
4289 @item showmatch
Dave Love <fx@gnu.org>
parents:
diff changeset
4290 @itemx sm
Dave Love <fx@gnu.org>
parents:
diff changeset
4291 @cindex paren matching
Dave Love <fx@gnu.org>
parents:
diff changeset
4292 @cindex matching parens
Dave Love <fx@gnu.org>
parents:
diff changeset
4293 showmatch -- Whenever you append a @kbd{)}, Vi shows
Dave Love <fx@gnu.org>
parents:
diff changeset
4294 its match if it's on the same page; also with
Dave Love <fx@gnu.org>
parents:
diff changeset
4295 @kbd{@{} and @kbd{@}}. If there's no match, Vi will beep.
Dave Love <fx@gnu.org>
parents:
diff changeset
4296 @item noshowmatch
Dave Love <fx@gnu.org>
parents:
diff changeset
4297 @itemx nosm
Dave Love <fx@gnu.org>
parents:
diff changeset
4298 Cancel showmatch.
Dave Love <fx@gnu.org>
parents:
diff changeset
4299 @item tabstop=<count>
Dave Love <fx@gnu.org>
parents:
diff changeset
4300 @itemx ts=<count>
Dave Love <fx@gnu.org>
parents:
diff changeset
4301 @cindex changing tab width
Dave Love <fx@gnu.org>
parents:
diff changeset
4302 @cindex tabbing
Dave Love <fx@gnu.org>
parents:
diff changeset
4303 tabstop -- The length of a <ht>; warning: this is
Dave Love <fx@gnu.org>
parents:
diff changeset
4304 only IN the editor, outside of it <ht>s have
Dave Love <fx@gnu.org>
parents:
diff changeset
4305 their normal length (default 8 positions).
Dave Love <fx@gnu.org>
parents:
diff changeset
4306 This setting affects the current buffer only.
Dave Love <fx@gnu.org>
parents:
diff changeset
4307 @item tabstop-global
Dave Love <fx@gnu.org>
parents:
diff changeset
4308 @itemx ts-g
Dave Love <fx@gnu.org>
parents:
diff changeset
4309 Same as `tabstop', but affects all buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
4310 @item wrapmargin=<count>
Dave Love <fx@gnu.org>
parents:
diff changeset
4311 @itemx wm=<count>
Dave Love <fx@gnu.org>
parents:
diff changeset
4312 @cindex auto fill
Dave Love <fx@gnu.org>
parents:
diff changeset
4313 @cindex word wrap
Dave Love <fx@gnu.org>
parents:
diff changeset
4314 wrapmargin -- In append mode Vi automatically
Dave Love <fx@gnu.org>
parents:
diff changeset
4315 puts a <lf> whenever there is a <sp> or <ht>
Dave Love <fx@gnu.org>
parents:
diff changeset
4316 within <wm> columns from the right margin.
Dave Love <fx@gnu.org>
parents:
diff changeset
4317 @item wrapscan
Dave Love <fx@gnu.org>
parents:
diff changeset
4318 @itemx ws
Dave Love <fx@gnu.org>
parents:
diff changeset
4319 @cindex searching
Dave Love <fx@gnu.org>
parents:
diff changeset
4320 wrapscan -- When searching, the end is
Dave Love <fx@gnu.org>
parents:
diff changeset
4321 considered @samp{stuck} to the begin of the file.
Dave Love <fx@gnu.org>
parents:
diff changeset
4322 @item nowrapscan
Dave Love <fx@gnu.org>
parents:
diff changeset
4323 @itemx nows
Dave Love <fx@gnu.org>
parents:
diff changeset
4324 Cancel wrapscan.
Dave Love <fx@gnu.org>
parents:
diff changeset
4325 @item :set <option>
Dave Love <fx@gnu.org>
parents:
diff changeset
4326 Turn <option> on.
Dave Love <fx@gnu.org>
parents:
diff changeset
4327 @item :set no<option>
Dave Love <fx@gnu.org>
parents:
diff changeset
4328 Turn <option> off.
Dave Love <fx@gnu.org>
parents:
diff changeset
4329 @item :set <option>=<value>
Dave Love <fx@gnu.org>
parents:
diff changeset
4330 Set <option> to <value>.
Dave Love <fx@gnu.org>
parents:
diff changeset
4331 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
4332 @findex @kbd{:set <option>=<value>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4333 @findex @kbd{:set no<option>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4334 @findex @kbd{:set <option>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4335 @findex @kbd{:set ws}
Dave Love <fx@gnu.org>
parents:
diff changeset
4336 @findex @kbd{:set wrapscan}
Dave Love <fx@gnu.org>
parents:
diff changeset
4337 @findex @kbd{:set wm=<count>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4338 @findex @kbd{:set wrapmargin=<count>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4339 @findex @kbd{:set ts=<count>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4340 @findex @kbd{:set tabstop=<count>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4341 @findex @kbd{:set tab-stop-local=<count>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4342 @findex @kbd{:set sm}
Dave Love <fx@gnu.org>
parents:
diff changeset
4343 @findex @kbd{:set showmatch}
Dave Love <fx@gnu.org>
parents:
diff changeset
4344 @findex @kbd{:set sw=<count>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4345 @findex @kbd{:set shiftwidth=<count>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4346 @findex @kbd{:set sh=<string>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4347 @findex @kbd{:set shell=<string>}
Dave Love <fx@gnu.org>
parents:
diff changeset
4348 @findex @kbd{:set ro}
Dave Love <fx@gnu.org>
parents:
diff changeset
4349 @findex @kbd{:set readonly}
Dave Love <fx@gnu.org>
parents:
diff changeset
4350 @findex @kbd{:set magic}
Dave Love <fx@gnu.org>
parents:
diff changeset
4351 @findex @kbd{:set ic}
Dave Love <fx@gnu.org>
parents:
diff changeset
4352 @findex @kbd{:set ignorecase}
Dave Love <fx@gnu.org>
parents:
diff changeset
4353 @findex @kbd{:set ai}
Dave Love <fx@gnu.org>
parents:
diff changeset
4354 @findex @kbd{:set autoindent}
Dave Love <fx@gnu.org>
parents:
diff changeset
4355
Dave Love <fx@gnu.org>
parents:
diff changeset
4356 @node Emacs Related Commands,,Options,Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
4357 @section Emacs Related Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
4358
Dave Love <fx@gnu.org>
parents:
diff changeset
4359 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
4360 @item C-\
Dave Love <fx@gnu.org>
parents:
diff changeset
4361 Begin Meta command in Vi or Insert states. Most often used as C-\ x (M-x).
Dave Love <fx@gnu.org>
parents:
diff changeset
4362
Dave Love <fx@gnu.org>
parents:
diff changeset
4363 Note: Emacs binds @kbd{C-\} to a function that offers to change the
Dave Love <fx@gnu.org>
parents:
diff changeset
4364 keyboard input method in the multilingual environment. Viper overrides this
Dave Love <fx@gnu.org>
parents:
diff changeset
4365 binding. However, it is still possible to switch the input method by typing
Dave Love <fx@gnu.org>
parents:
diff changeset
4366 @kbd{\ C-\} in the Vi command state and @kbd{C-z \ C-\} in the Insert state.
Dave Love <fx@gnu.org>
parents:
diff changeset
4367 Or you can use the MULE menu on the menubar.
Dave Love <fx@gnu.org>
parents:
diff changeset
4368 @item C-z
Dave Love <fx@gnu.org>
parents:
diff changeset
4369 In Insert and Replace states, prepare Viper to accept the next command and
Dave Love <fx@gnu.org>
parents:
diff changeset
4370 execute it as if Viper was in Vi state. Then return to Insert state.
Dave Love <fx@gnu.org>
parents:
diff changeset
4371
Dave Love <fx@gnu.org>
parents:
diff changeset
4372 In Vi state, switch to Emacs state; in Emacs state, switch to Vi state.
Dave Love <fx@gnu.org>
parents:
diff changeset
4373 @item C-c \
Dave Love <fx@gnu.org>
parents:
diff changeset
4374 Switches to Vi state for the duration of a single command. Then goes back
Dave Love <fx@gnu.org>
parents:
diff changeset
4375 to the original Viper state. Works from Vi, Insert, Replace, and Emacs states.
Dave Love <fx@gnu.org>
parents:
diff changeset
4376 @item C-x0
Dave Love <fx@gnu.org>
parents:
diff changeset
4377 Close Window
Dave Love <fx@gnu.org>
parents:
diff changeset
4378 @item C-x1
Dave Love <fx@gnu.org>
parents:
diff changeset
4379 Close Other Windows
Dave Love <fx@gnu.org>
parents:
diff changeset
4380 @item C-x2
Dave Love <fx@gnu.org>
parents:
diff changeset
4381 Split Window
Dave Love <fx@gnu.org>
parents:
diff changeset
4382 @item C-xo
Dave Love <fx@gnu.org>
parents:
diff changeset
4383 Move among windows
Dave Love <fx@gnu.org>
parents:
diff changeset
4384 @item C-xC-f
Dave Love <fx@gnu.org>
parents:
diff changeset
4385 Emacs find-file, useful in Insert state
Dave Love <fx@gnu.org>
parents:
diff changeset
4386 @item C-y
Dave Love <fx@gnu.org>
parents:
diff changeset
4387 Put back the last killed text. Similar to Vi's @kbd{p}, but also works in
Dave Love <fx@gnu.org>
parents:
diff changeset
4388 Insert and Replace state. This command doesn't work in Vi command state,
Dave Love <fx@gnu.org>
parents:
diff changeset
4389 since this binding is taken for something else.
Dave Love <fx@gnu.org>
parents:
diff changeset
4390 @item M-y
Dave Love <fx@gnu.org>
parents:
diff changeset
4391 Undoes the last @kbd{C-y} and puts another kill from the kill ring.
Dave Love <fx@gnu.org>
parents:
diff changeset
4392 Using this command, you can try may different kills until you find the one
Dave Love <fx@gnu.org>
parents:
diff changeset
4393 you need.
Dave Love <fx@gnu.org>
parents:
diff changeset
4394 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
4395 @kindex @kbd{M-y}
Dave Love <fx@gnu.org>
parents:
diff changeset
4396 @kindex @kbd{C-y}
Dave Love <fx@gnu.org>
parents:
diff changeset
4397 @kindex @kbd{C-xC-f}
Dave Love <fx@gnu.org>
parents:
diff changeset
4398 @kindex @kbd{C-xo}
Dave Love <fx@gnu.org>
parents:
diff changeset
4399 @kindex @kbd{C-x2}
Dave Love <fx@gnu.org>
parents:
diff changeset
4400 @kindex @kbd{C-x1}
Dave Love <fx@gnu.org>
parents:
diff changeset
4401 @kindex @kbd{C-x0}
Dave Love <fx@gnu.org>
parents:
diff changeset
4402 @kindex @kbd{C-z}
Dave Love <fx@gnu.org>
parents:
diff changeset
4403 @kindex @kbd{C-\}
Dave Love <fx@gnu.org>
parents:
diff changeset
4404 @kindex @kbd{C-c\}
Dave Love <fx@gnu.org>
parents:
diff changeset
4405
Dave Love <fx@gnu.org>
parents:
diff changeset
4406 @node Mouse-bound Commands,,,Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
4407 @section Mouse-bound Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
4408
36340
1ca425b36c74 (Rudimentary Changes): Remove doubled `to'.
Gerd Moellmann <gerd@gnu.org>
parents: 36155
diff changeset
4409 The following two mouse actions are normally bound to special search and
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4410 insert commands in of Viper:
Dave Love <fx@gnu.org>
parents:
diff changeset
4411
Dave Love <fx@gnu.org>
parents:
diff changeset
4412 @table @kbd
36155
3594ca3f5f64 Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36043
diff changeset
4413 @item S-Mouse-1
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4414 Holding Shift and clicking mouse button 1 will
Dave Love <fx@gnu.org>
parents:
diff changeset
4415 initiate search for
Dave Love <fx@gnu.org>
parents:
diff changeset
4416 a region under the mouse pointer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4417 This command can take a prefix argument. Note: Viper sets this
Dave Love <fx@gnu.org>
parents:
diff changeset
4418 binding only if this mouse action is not
Dave Love <fx@gnu.org>
parents:
diff changeset
4419 already bound to something else.
Dave Love <fx@gnu.org>
parents:
diff changeset
4420 @xref{Viper Specials}, for more information.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4421
36155
3594ca3f5f64 Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36043
diff changeset
4422 @item S-Mouse-2
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4423 Holding Shift and clicking button 2 of the mouse will
Dave Love <fx@gnu.org>
parents:
diff changeset
4424 insert a region surrounding the mouse pointer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4425 This command can also take a prefix argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
4426 Note: Viper sets this binding only if this mouse action is not
Dave Love <fx@gnu.org>
parents:
diff changeset
4427 already bound to something else.
Dave Love <fx@gnu.org>
parents:
diff changeset
4428 @xref{Viper Specials}, for more details.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4429 @end table
36155
3594ca3f5f64 Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36043
diff changeset
4430 @kindex @kbd{S-Mouse-1}
3594ca3f5f64 Fix some Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 36043
diff changeset
4431 @kindex @kbd{S-Mouse-2}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4432 @kindex @kbd{meta button1up}
Dave Love <fx@gnu.org>
parents:
diff changeset
4433 @kindex @kbd{meta button2up}
Dave Love <fx@gnu.org>
parents:
diff changeset
4434
Dave Love <fx@gnu.org>
parents:
diff changeset
4435 @node Acknowledgments,,,Top
Dave Love <fx@gnu.org>
parents:
diff changeset
4436 @comment node-name, next, previous, up
Dave Love <fx@gnu.org>
parents:
diff changeset
4437 @unnumbered Acknowledgments
Dave Love <fx@gnu.org>
parents:
diff changeset
4438
Dave Love <fx@gnu.org>
parents:
diff changeset
4439 Viper, formerly known as VIP-19, was written by Michael Kifer. Viper is
Dave Love <fx@gnu.org>
parents:
diff changeset
4440 based on the original VIP package by Masahiko Sato and on its enhancement,
Dave Love <fx@gnu.org>
parents:
diff changeset
4441 VIP 4.4, by Aamod Sane. This manual is an adaptation of the manual for VIP
Dave Love <fx@gnu.org>
parents:
diff changeset
4442 4.4, which, in turn, was based on Sato's manual for VIP 3.5.
Dave Love <fx@gnu.org>
parents:
diff changeset
4443
Dave Love <fx@gnu.org>
parents:
diff changeset
4444 Many contributors on the net pointed out bugs and suggested a number of
Dave Love <fx@gnu.org>
parents:
diff changeset
4445 useful features. Here is a (hopefully) complete list of contributors:
Dave Love <fx@gnu.org>
parents:
diff changeset
4446
Dave Love <fx@gnu.org>
parents:
diff changeset
4447 @example
33019
6306740f6938 2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 30009
diff changeset
4448 aaronl@@vitelus.com (Aaron Lehmann),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4449 ahg@@panix.com (Al Gelders),
Dave Love <fx@gnu.org>
parents:
diff changeset
4450 amade@@diagram.fr (Paul-Bernard Amade),
Dave Love <fx@gnu.org>
parents:
diff changeset
4451 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
4452 bronson@@trestle.com (Scott Bronson),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4453 cook@@biostat.wisc.edu (Tom Cook),
Dave Love <fx@gnu.org>
parents:
diff changeset
4454 csdayton@@midway.uchicago.edu (Soren Dayton),
Dave Love <fx@gnu.org>
parents:
diff changeset
4455 dave@@hellgate.utah.edu,
42288
3ce98f3e0608 2001-12-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 39901
diff changeset
4456 dm@@scs.cs.nyu.edu (David Mazieres),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4457 dominik@@strw.LeidenUniv.nl (Carsten Dominik),
Dave Love <fx@gnu.org>
parents:
diff changeset
4458 dwallach@@cs.princeton.edu (Dan Wallach),
Dave Love <fx@gnu.org>
parents:
diff changeset
4459 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
4460 dxc@@xprt.net (David X. Callaway),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4461 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
4462 gin@@mo.msk.ru (Golubev I.N.),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4463 gviswana@@cs.wisc.edu (Guhan Viswanathan),
Dave Love <fx@gnu.org>
parents:
diff changeset
4464 gvr@@halcyon.com (George V.@: Reilly),
Dave Love <fx@gnu.org>
parents:
diff changeset
4465 hatazaki@@bach.convex.com (Takao Hatazaki),
Dave Love <fx@gnu.org>
parents:
diff changeset
4466 hpz@@ibmhpz.aug.ipp-garching.mpg.de (Hans-Peter Zehrfeld),
Dave Love <fx@gnu.org>
parents:
diff changeset
4467 jackr@@dblues.engr.sgi.com (Jack Repenning),
Dave Love <fx@gnu.org>
parents:
diff changeset
4468 jamesm@@bga.com (D.J.@: Miller II),
Dave Love <fx@gnu.org>
parents:
diff changeset
4469 jjm@@hplb.hpl.hp.com (Jean-Jacques Moreau),
Dave Love <fx@gnu.org>
parents:
diff changeset
4470 jl@@cse.ogi.edu (John Launchbury),
Dave Love <fx@gnu.org>
parents:
diff changeset
4471 jobrien@@hchp.org (John O'Brien),
Dave Love <fx@gnu.org>
parents:
diff changeset
4472 johnw@@borland.com (John Wiegley),
Dave Love <fx@gnu.org>
parents:
diff changeset
4473 kanze@@gabi-soft.fr (James Kanze),
Dave Love <fx@gnu.org>
parents:
diff changeset
4474 kin@@isi.com (Kin Cho),
Dave Love <fx@gnu.org>
parents:
diff changeset
4475 kwzh@@gnu.org (Karl Heuer),
Dave Love <fx@gnu.org>
parents:
diff changeset
4476 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
4477 minakaji@@osaka.email.ne.jp (Mikio Nakajima),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4478 Mark.Bordas@@East.Sun.COM (Mark Bordas),
Dave Love <fx@gnu.org>
parents:
diff changeset
4479 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
4480 martin@@xemacs.org (Martin Buchholz),
38514
10482dd382e7 * viper-ex.el (ex-token-list,ex-cmd-execute): Revamped, courtesy
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 37806
diff changeset
4481 mbutler@@redfernnetworks.com (Malcolm Butler),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4482 mveiga@@dit.upm.es (Marcelino Veiga Tuimil),
Dave Love <fx@gnu.org>
parents:
diff changeset
4483 paulk@@summit.esg.apertus.com (Paul Keusemann),
Dave Love <fx@gnu.org>
parents:
diff changeset
4484 pfister@@cs.sunysb.edu (Hanspeter Pfister),
Dave Love <fx@gnu.org>
parents:
diff changeset
4485 phil_brooks@@MENTORG.COM (Phil Brooks),
Dave Love <fx@gnu.org>
parents:
diff changeset
4486 pogrell@@informatik.hu-berlin.de (Lutz Pogrell),
Dave Love <fx@gnu.org>
parents:
diff changeset
4487 pradyut@@cs.uchicago.edu (Pradyut Shah),
Dave Love <fx@gnu.org>
parents:
diff changeset
4488 roderick@@argon.org (Roderick Schertler),
Dave Love <fx@gnu.org>
parents:
diff changeset
4489 rxga@@ulysses.att.com,
Dave Love <fx@gnu.org>
parents:
diff changeset
4490 sawdey@@lcse.umn.edu (Aaron Sawdey),
Dave Love <fx@gnu.org>
parents:
diff changeset
4491 simonb@@prl.philips.co.uk (Simon Blanchard),
42288
3ce98f3e0608 2001-12-24 Michael Kifer <kifer@cs.sunysb.edu>
Michael Kifer <kifer@cs.stonybrook.edu>
parents: 39901
diff changeset
4492 spadgett1@@nc.rr.com (Samuel Padgett),
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4493 stephen@@farrell.org (Stephen Farrell),
Dave Love <fx@gnu.org>
parents:
diff changeset
4494 sudish@@MindSpring.COM (Sudish Joseph),
Dave Love <fx@gnu.org>
parents:
diff changeset
4495 schwab@@issan.informatik.uni-dortmund.de (Andreas Schwab)
Dave Love <fx@gnu.org>
parents:
diff changeset
4496 terra@@diku.dk (Morten Welinder),
Dave Love <fx@gnu.org>
parents:
diff changeset
4497 thanh@@informatics.muni.cz (Han The Thanh),
Dave Love <fx@gnu.org>
parents:
diff changeset
4498 toma@@convex.convex.com,
Dave Love <fx@gnu.org>
parents:
diff changeset
4499 vrenjak@@sun1.racal.com (Milan Vrenjak),
Dave Love <fx@gnu.org>
parents:
diff changeset
4500 whicken@@dragon.parasoft.com (Wendell Hicken),
Dave Love <fx@gnu.org>
parents:
diff changeset
4501 zapman@@cc.gatech.edu (Jason Zapman II),
Dave Love <fx@gnu.org>
parents:
diff changeset
4502 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4503
Dave Love <fx@gnu.org>
parents:
diff changeset
4504
Dave Love <fx@gnu.org>
parents:
diff changeset
4505 @node Key Index,Function Index,,Top
Dave Love <fx@gnu.org>
parents:
diff changeset
4506 @comment node-name, next, previous, up
Dave Love <fx@gnu.org>
parents:
diff changeset
4507 @unnumbered Key Index
Dave Love <fx@gnu.org>
parents:
diff changeset
4508
Dave Love <fx@gnu.org>
parents:
diff changeset
4509 @printindex ky
Dave Love <fx@gnu.org>
parents:
diff changeset
4510
Dave Love <fx@gnu.org>
parents:
diff changeset
4511 @node Function Index,Variable Index,Key Index,Top
Dave Love <fx@gnu.org>
parents:
diff changeset
4512 @comment node-name, next, previous, up
Dave Love <fx@gnu.org>
parents:
diff changeset
4513 @unnumbered Function Index
Dave Love <fx@gnu.org>
parents:
diff changeset
4514
Dave Love <fx@gnu.org>
parents:
diff changeset
4515 @printindex fn
Dave Love <fx@gnu.org>
parents:
diff changeset
4516
Dave Love <fx@gnu.org>
parents:
diff changeset
4517 @node Variable Index,Package Index,Function Index,Top
Dave Love <fx@gnu.org>
parents:
diff changeset
4518 @comment node-name, next, previous, up
Dave Love <fx@gnu.org>
parents:
diff changeset
4519 @unnumbered Variable Index
Dave Love <fx@gnu.org>
parents:
diff changeset
4520
Dave Love <fx@gnu.org>
parents:
diff changeset
4521 @printindex vr
Dave Love <fx@gnu.org>
parents:
diff changeset
4522
Dave Love <fx@gnu.org>
parents:
diff changeset
4523 @node Package Index,Concept Index,Variable Index,Top
Dave Love <fx@gnu.org>
parents:
diff changeset
4524 @comment node-name, next, previous, up
Dave Love <fx@gnu.org>
parents:
diff changeset
4525 @unnumbered Package Index
Dave Love <fx@gnu.org>
parents:
diff changeset
4526
Dave Love <fx@gnu.org>
parents:
diff changeset
4527 @printindex pg
Dave Love <fx@gnu.org>
parents:
diff changeset
4528
Dave Love <fx@gnu.org>
parents:
diff changeset
4529 @node Concept Index,,Package Index,Top
Dave Love <fx@gnu.org>
parents:
diff changeset
4530 @comment node-name, next, previous, up
Dave Love <fx@gnu.org>
parents:
diff changeset
4531 @unnumbered Concept Index
Dave Love <fx@gnu.org>
parents:
diff changeset
4532
Dave Love <fx@gnu.org>
parents:
diff changeset
4533 @printindex cp
Dave Love <fx@gnu.org>
parents:
diff changeset
4534
29713
983e65f12610 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 29165
diff changeset
4535 @setchapternewpage odd
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4536 @contents
Dave Love <fx@gnu.org>
parents:
diff changeset
4537 @bye