VIP is a Vi emulating package written in Emacs Lisp. VIP implements most Vi commands including Ex commands. It is therefore hoped that this package will enable you to do Vi style editing under the powerful GNU Emacs environment. This info file describes the usage of VIP assuming that you are fairly accustomed to Vi but not so much with Emacs. Also we will concentrate mainly on differences from Vi, especially features unique to VIP.
It is recommended that you read nodes on survey and on customization before you start using VIP. Other nodes may be visited as needed.
Comments and bug reports are welcome. Please send messages to
ms@Sail.Stanford.Edu if you are outside of Japan and to
masahiko@sato.riec.tohoku.junet if you are in Japan.
In this chapter we describe basics of VIP with emphasis on the features not found in Vi and on how to use VIP under GNU Emacs.
We begin by explaining some basic concepts of Emacs. These concepts are explained in more detail in the GNU Emacs Manual.
Conceptually, a buffer is just a string of ASCII characters and two special characters <PNT> (point) and <MRK> (mark) such that the character <PNT> occurs exactly once and <MRK> occurs at most once. The text of a buffer is obtained by deleting the occurrences of <PNT> and <MRK>. If, in a buffer, there is a character following <PNT> then we say that point is looking at the character; otherwise we say that point is at the end of buffer. <PNT> and <MRK> are used to indicate positions in a buffer and they are not part of the text of the buffer. If a buffer contains a <MRK> then the text between <MRK> and <PNT> is called the region of the buffer.
Emacs provides (multiple) windows on the screen, and you can see the content of a buffer through the window associated with the buffer. The cursor of the screen is always positioned on the character after <PNT>.
A keymap is a table that records the bindings between characters and command functions. There is the global keymap common to all the buffers. Each buffer has its local keymap that determines the mode of the buffer. Local keymap overrides global keymap, so that if a function is bound to some key in the local keymap then that function will be executed when you type the key. If no function is bound to a key in the local map, however, the function bound to the key in the global map becomes in effect.
The recommended way to load VIP automatically is to include the line:
(load "vip")
in your .emacs file. The .emacs file is placed in your home directory and it will be executed every time you invoke Emacs. If you wish to be in vi mode whenever Emacs starts up, you can include the following line in your .emacs file instead of the above line:
(setq term-setup-hook 'vip-mode)
(See Vi Mode, for the explanation of vi mode.)
Even if your .emacs file does not contain any of the above lines, you can load VIP and enter vi mode by typing the following from within Emacs.
M-x vip-mode
Loading VIP has the effect of globally binding C-z (Control-z)
to the function vip-change-mode-to-vi. The default binding of C-z
in GNU Emacs is suspend-emacs, but, you can also call
suspend-emacs by typing C-x C-z. Other than this, all the
key bindings of Emacs remain the same after loading VIP.
Now, if you hit C-z, the function vip-change-mode-to-vi will be
called and you will be in vi mode. (Some major modes may locally bind
C-z to some special functions. In such cases, you can call
vip-change-mode-to-vi by execute-extended-command which is
invoked by M-x. Here M-x means Meta-x, and if your
terminal does not have a <META> key you can enter it by typing
<ESC> x. The same effect can also be achieve by typing
M-x vip-mode.)
You can observe the change of mode by looking at the mode line. For instance, if the mode line is:
-----Emacs: *scratch* (Lisp Interaction)----All------------
then it will change to:
-----Vi: *scratch* (Lisp Interaction)----All------------
Thus the word `Emacs' in the mode line will change to `Vi'.
You can go back to the original emacs mode by typing C-z in vi mode. Thus C-z toggles between these two modes.
Note that modes in VIP exist orthogonally to modes in Emacs. This means that you can be in vi mode and at the same time, say, shell mode.
Vi mode corresponds to Vi's command mode. From vi mode you can enter insert mode (which corresponds to Vi's insert mode) by usual Vi command keys like i, a, o ... etc.
In insert mode, the mode line will look like this:
-----Insert *scratch* (Lisp Interaction)----All------------
You can exit from insert mode by hitting <ESC> key as you do in Vi.
That VIP has three modes may seem very complicated, but in fact it is not so. VIP is implemented so that you can do most editing remaining only in the two modes for Vi (that is vi mode and insert mode).
You will be in this mode just after you loaded VIP. You can do all
normal Emacs editing in this mode. Note that the key C-z is globally
bound to vip-change-mode-to-vi. So, if you type C-z in this mode
then you will be in vi mode.
This mode corresponds to Vi's command mode. Most Vi commands work as they do in Vi. You can go back to emacs mode by typing C-z. You can enter insert mode, just as in Vi, by typing i, a etc.
The key bindings in this mode is the same as in the emacs mode except for the following 4 keys. So, you can move around in the buffer and change its content while you are in insert mode.
The major differences from Vi are explained below.
You can repeat undoing by the . key. So, u will undo a single change, while u . . ., for instance, will undo 4 previous changes. Undo is undoable as in Vi. So the content of the buffer will be the same before and after u u.
Some commands which change a small number of characters are executed slightly differently. Thus, if point is at the beginning of a word `foo' and you wished to change it to `bar' by typing c w, then VIP will prompt you for a new word in the minibuffer by the prompt `foo => '. You can then enter `bar' followed by <RET> or <ESC> to complete the command. Before you enter <RET> or <ESC> you can abort the command by typing C-g. In general, you can abort a partially formed command by typing C-g.
As in Vi, searching is done by / and ?. The string will be
searched literally by default. To invoke a regular expression search,
first execute the search command / (or ?) with empty search
string. (I.e, type / followed by <RET>.)
A search for empty string will toggle the search mode between vanilla
search and regular expression search. You cannot give an offset to the
search string. (It is a limitation.) By default, search will wrap around
the buffer as in Vi. You can change this by rebinding the variable
vip-search-wrap-around. See Customization, for how to do this.
For those of you who cannot remember which of z followed by <RET>, . and - do what. You can also use z followed by H, M and L to place the current line in the Home (Middle, and Last) line of the window.
Some Vi commands which do not accept a count now accept one
Typing an m followed by a lower-case character ch marks the point to the register named ch as in Vi. In addition to these, we have following key bindings for marking.
Vi operators like d, c etc. are usually used in combination with motion commands. It is now possible to use current region as the argument to these operators. (A region is a part of buffer delimited by point and mark.) The key r is used for this purpose. Thus d r will delete the current region. If R is used instead of r the region will first be enlarged so that it will become the smallest region containing the original region and consisting of whole lines. Thus m . d R will have the same effect as d d.
Note that the keys below (except for R) are not used in Vi.
downcase-region).
upcase-region).
vip-global-execute).
vip-quote-region).
spell-region).
In VIP the meanings of some keys are entirely different from Vi. These key bindings are done deliberately in the hope that editing under Emacs will become easier. It is however possible to rebind these keys to functions which behave similarly as in Vi. See Customizing Key Bindings, for details.
In addition to these, ctl-x-map is slightly modified:
In this and following subsections, we give a summary of key bindings for basic functions related to windows, buffers and files.
vip-switch-to-buffer).
vip-switch-to-buffer-other-window).
This chapter describes Vi commands other than Ex commands implemented in VIP. Except for the last section which discusses insert mode, all the commands described in this chapter are to be used in vi mode.
Most Vi commands accept a numeric argument which can be supplied as a prefix to the commands. A numeric argument is also called a count. In many cases, if a count is given, the command is executed that many times. For instance, 5 d d deletes 5 lines while simple d d deletes a line. In this manual the metavariable n will denote a count.
The keys C-g and C-l are unique in that their associated functions are the same in any of emacs, vi and insert mode.
keyboard-quit).
recenter).
In Emacs many commands are bound to the key strokes that start with C-x, C-c and <ESC>. These commands can be accessed from vi mode as easily as from emacs mode.
In Emacs the text you edit is stored in a buffer. See GNU Emacs Manual, for details. There is always one current buffer, also called the selected buffer.
You can see the contents of buffers through windows created by Emacs. When you have multiple windows on the screen only one of them is selected. Each buffer has a unique name, and each window has a mode line which shows the name of the buffer associated with the window and other information about the status of the buffer. You can change the format of the mode line, but normally if you see `**' at the beginning of a mode line it means that the buffer is modified. If you write out the content of the buffer to a file, then the buffer will become not modified. Also if you see `%%' at the beginning of the mode line, it means that the file associated with the buffer is write protected.
We have the following commands related to windows and buffers.
vip-next-window).
delete-other-windows).
split-window-vertically).
vip-switch-to-buffer).
vip-switch-to-buffer-other-window).
vip-kill-buffer).
list-buffers).
As buffer name completion is provided, you have only to type in initial substring of the buffer name which is sufficient to identify it among names of existing buffers. After that, if you hit <TAB> the rest of the buffer name will be supplied by the system, and you can confirm it by <RET>. The default buffer name to switch to will also be prompted, and you can select it by giving a simple <RET>. See GNU Emacs Manual for details of completion.
We have the following commands related to files. They are used to visit, save and insert files.
vip-find-file).
vip-find-file-other-window).
In Emacs, you can edit a file by visiting it. If you wish to visit a file in the current window, you can just type v. Emacs maintains the default directory which is specific to each buffer. Suppose, for instance, that the default directory of the current buffer is /usr/masahiko/lisp/. Then you will get the following prompt in the minibuffer.
visit file: /usr/masahiko/lisp/
If you wish to visit, say, vip.el in this directory, then you can just type `vip.el' followed by <RET>. If the file vip.el already exists in the directory, Emacs will visit that file, and if not, the file will be created. Emacs will use the file name (vip.el, in this case) as the name of the buffer visiting the file. In order to make the buffer name unique, Emacs may append `<2>', `<3>' etc., to the buffer name. As the file name completion is provided here, you can sometime save typing. For instance, suppose there is only one file in the default directory whose name starts with `v', that is `vip.el'. Then if you just type v <TAB> then it will be completed to `vip.el'. Thus, in this case, you just have to type v v <TAB> <RET> to visit /usr/masahiko/lisp/vip.el. Continuing the example, let us now suppose that you wished to visit the file /usr/masahiko/man/vip.texinfo. Then to the same prompt which you get after you typed v, you can enter `/usr/masahiko/man/vip.texinfo' or `../man/vip.texinfo' followed by <RET>.
Use V instead of v, if you wish to visit a file in another window.
You can verify which file you are editing by typing g. (You can also type X B to get information on other buffers too.) If you type g you will get an information like below in the echo area:
"/usr/masahiko/man/vip.texinfo" line 921 of 1949
After you edited the buffer (`vip.texinfo', in our example) for a while, you may wish to save it in a file. If you wish to save it in the file associated with the buffer (/usr/masahiko/man/vip.texinfo, in this case), you can just say X S. If you wish to save it in another file, you can type X W. You will then get a similar prompt as you get for v, to which you can enter the file name.
In this and next section we discuss commands for moving around in the buffer. These command do not change the content of the buffer. The following commands are useful for viewing the content of the current buffer.
vip-scroll).
vip-scroll-back).
vip-scroll-down).
vip-scroll-up).
vip-scroll-down-one).
vip-scroll-up-one).
The following commands reposition point in the window.
vip-line-to-top).
vip-line-to-middle).
vip-line-to-bottom).
recenter).
The following commands are used to mark positions in the buffer.
Emacs uses the mark ring to store marked positions. The commands m <, m > and m . not only set mark but also add it as the latest element of the mark ring (replacing the oldest one). By repeating the command `m ,' you can visit older and older marked positions. You will eventually be in a loop as the mark ring is a ring.
Commands for moving around in the current buffer are collected here. These commands are used as an `argument' for the delete, change and yank commands to be described in the next section.
vip-backward-char).
vip-forward-char).
vip-next-line).
vip-next-line).
vip-next-line-at-bol).
vip-previous-line-at-bol).
vip-beginning-of-line).
vip-bol-and-skip-white).
vip-goto-eol).
vip-goto-col).
vip-forward-word).
vip-forward-Word).
vip-backward-word).
vip-forward-Word).
vip-end-of-word).
vip-end-of-Word).
vip-window-top).
vip-window-middle).
vip-window-bottom).
vip-backward-sentence).
vip-forward-sentence).
vip-backward-paragraph).
vip-forward-paragraph).
vip-goto-line).
vip-goto-mark).
vip-goto-mark-and-skip-white).
vip-paren-match).
The following commands are useful for moving points on the line. A count will repeat the effect.
vip-find-char-forward).
vip-find-char-backward).
vip-goto-char-forward).
vip-goto-char-backward).
vip-repeat-find).
vip-repeat-find-opposite).
Following commands are available for searching and replacing.
vip-re-search has value
t then regular expression search is done and the string
matching the regular expression string is found. If you give an
empty string as string then the search mode will change from vanilla
search to regular expression search and vice versa
(vip-search-forward).
vip-search-backward).
vip-search-next).
vip-search-Next).
isearch-forward).
isearch-backward).
vip-replace-string).
vip-query-replace).
vip-replace-char).
In this section, commands for modifying the content of a buffer are described. These commands affect the region determined by a motion command which is given to the commands as their argument.
We classify motion commands into point commands and line commands. The point commands are as follows:
h, l, 0, ^, $, w, W, b, B, e, E, (, ), /, ?, `, f, F, t, T, %, ;, ,
The line commands are as follows:
j, k, +, -, H, M, L, {, }, G, '
If a point command is given as an argument to a modifying command, the region determined by the point command will be affected by the modifying command. On the other hand, if a line command is given as an argument to a modifying command, the region determined by the line command will be enlarged so that it will become the smallest region properly containing the region and consisting of whole lines (we call this process expanding the region), and then the enlarged region will be affected by the modifying command.
It is also possible to save the deleted text into a register you specify. For example, you can say " t 3 d w to delete three words and save it to register t. The name of a register is a lower-case letter between a and z. If you give an upper-case letter as an argument to a delete command, then the deleted text will be appended to the content of the register having the corresponding lower-case letter as its name. So, " T d w will delete a word and append it to register t. Other modifying commands also accept a register name as their argument, and we will not repeat similar explanations.
We have more delete commands as below.
vip-kill-line).
vip-delete-char).
vip-delete-backward-char).
Yank commands yank a text of buffer into a (usually anonymous) register. Here the word `yank' is used in Vi's sense. Thus yank commands do not alter the content of the buffer, and useful only in combination with commands that put back the yanked text into the buffer.
Use the following command to yank consecutive lines of text.
vip-yank-line).
Deleted or yanked texts can be put back into the buffer by the command below.
vip-put-back).
vip-Put-back).
Most commonly used change command takes the following form.
VIP records the previous modifying command, so that it is easy to repeat it. It is also very easy to undo changes made by modifying commands.
vip-undo).
vip-repeat).
Miscellaneous Vi commands are collected here.
save-buffers-kill-emacs).
vip-command-argument).
vip-join-lines).
vip-command-argument).
vip-command-argument).
vip-command-argument).
The following keys are reserved for future extensions, and currently
assigned to a function that just beeps (vip-nil).
&, @, U, [, ], _, q, ~
VIP uses a special local keymap to interpret key strokes you enter in vi mode. The following keys are bound to nil in the keymap. Therefore, these keys are interpreted by the global keymap of Emacs. We give below a short description of the functions bound to these keys in the global keymap. See GNU Emacs Manual for details.
set-mark-command).
indent-for-tab-command).
newline-and-indent).
kill-line).
recenter).
previous-line).
quoted-insert).
isearch-backward).
isearch-forward).
transpose-chars).
scroll-up).
kill-region).
You can enter insert mode by one of the following commands. In addition to
these, you will enter insert mode if you give a change command with a line
command as the motion command. Insert commands are also modifying commands
and you can repeat them by the repeat command . (vip-repeat).
vip-insert).
vip-Insert).
vip-append).
vip-Append).
vip-open-line).
vip-Open-line).
vip-open-line-at-point).
Insert mode is almost like emacs mode. Only the following 4 keys behave differently from emacs mode.
vip-change-mode-to-vi).
delete-backward-char).
vip-delete-backward-word).
vip-ESC).
help-command if you like.
(See Customizing Key Bindings, for details.) Binding C-h to
help-command has the effect of making the meaning of C-h
uniform among emacs, vi and insert modes.
When you enter insert mode, VIP records point as the start point of insertion, and when you leave insert mode the region between point and start point is saved for later use by repeat command etc. Therefore, repeat command will not really repeat insertion if you move point by emacs commands while in insert mode.
In vi mode, you can execute an Ex command ex-command by typing:
: ex-command <RET>
Every Ex command follows the following pattern:
address command ! parameters count flags
where all parts are optional. For the syntax of address, the reader is referred to the reference manual of Ex.
In the current version of VIP, searching by Ex commands is always magic. That is, search patterns are always treated as regular expressions. For example, a typical forward search would be invoked by :/pat/. If you wish to include `/' as part of pat you must preceded it by `\'. VIP strips off these \'s before / and the resulting pat becomes the actual search pattern. Emacs provides a different and richer class or regular expressions than Vi/Ex, and VIP uses Emacs' regular expressions. See GNU Emacs Manual for details of regular expressions.
Several Ex commands can be entered in a line by separating them by a pipe character `|'.
In this section we briefly explain all the Ex commands supported by VIP. Most Ex commands expect address as their argument, and they use default addresses if they are not explicitly given. In the following, such default addresses will be shown in parentheses.
Most command names can and preferably be given in abbreviated forms. In the following, optional parts of command names will be enclosed in brackets. For example, `co[py]' will mean that copy command can be give as `co' or `cop' or `copy'.
If command is empty, point will move to the beginning of the line specified by the address. If address is also empty, point will move to the beginning of the current line.
Some commands accept flags which are one of p, l and #. If flags are given, the text affected by the commands will be displayed on a temporary window, and you will be asked to hit return to continue. In this way, you can see the text affected by the commands before the commands will be executed. If you hit C-g instead of <RET> then the commands will be aborted. Note that the meaning of flags is different in VIP from that in Vi/Ex.
vip-shift-width
(default value is 8) determines the amount of shift.
vip-shift-width
(default value is 8) determines the amount of shift.
The following Ex commands are available in Vi, but not implemented in VIP.
abbreviate, list, next, print, preserve, recover, rewind, source,
unabbreviate, xit, z
If you have a file called .vip in your home directory, then it will also be loaded when VIP is loaded. This file is thus useful for customizing VIP.
An easy way to customize VIP is to change the values of constants used in VIP. Here is the list of the constants used in VIP and their default values.
vip-shift-width 8vip-re-replace nilt then do regexp replace, if nil then do string replace.
vip-search-wrap-around tt, search wraps around the buffer.
vip-re-search nilt then search is reg-exp search, if nil then vanilla
search.
vip-case-fold-search nilt search ignores cases.
vip-re-query-replace nilt then do reg-exp replace in query replace.
vip-open-with-indent nilt then indent to the previous current line when open a new line
by o or O command.
vip-tags-file-name "TAGS"vip-help-in-insert-mode nilt then <C-h> is bound to help-command in insert mode,
if nil then it sis bound to delete-backward-char.
(setq vip-case-fold-search t)
VIP uses vip-command-mode-map as the local keymap for vi mode.
For example, in vi mode, <SPC> is bound to the function
vip-scroll. But, if you wish to make <SPC> and some other keys
behave like Vi, you can include the following lines in your .vip
file.
(define-key vip-command-mode-map "\C-g" 'vip-info-on-file)
(define-key vip-command-mode-map "\C-h" 'vip-backward-char)
(define-key vip-command-mode-map "\C-m" 'vip-next-line-at-bol)
(define-key vip-command-mode-map " " 'vip-forward-char)
(define-key vip-command-mode-map "g" 'vip-keyboard-quit)
(define-key vip-command-mode-map "s" 'vip-substitute)
(define-key vip-command-mode-map "C" 'vip-change-to-eol)
(define-key vip-command-mode-map "R" 'vip-change-to-eol)
(define-key vip-command-mode-map "S" 'vip-substitute-line)
(define-key vip-command-mode-map "X" 'vip-delete-backward-char)
Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
The purpose of this License is to make a manual, textbook, or other functional and useful document “free” in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of “copyleft,” which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document,” below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you.” You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque.”
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.
A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements,” “Dedications,” “Endorsements,” or “History.”) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
A. Use in the Title Page (and on the covers, if any) a title distinct
from that of the Document, and from those of previous versions
(which should, if there were any, be listed in the History section
of the Document). You may use the same title as a previous version
if the original publisher of that version gives permission.
B. List on the Title Page, as authors, one or more persons or entities
responsible for authorship of the modifications in the Modified
Version, together with at least five of the principal authors of the
Document (all of its principal authors, if it has fewer than five),
unless they release you from this requirement.
C. State on the Title page the name of the publisher of the
Modified Version, as the publisher.
D. Preserve all the copyright notices of the Document.
E. Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
F. Include, immediately after the copyright notices, a license notice
giving the public permission to use the Modified Version under the
terms of this License, in the form shown in the Addendum below.
G. Preserve in that license notice the full lists of Invariant Sections
and required Cover Texts given in the Document's license notice.
H. Include an unaltered copy of this License.
I. Preserve the section Entitled “History,” Preserve its Title, and add
to it an item stating at least the title, year, new authors, and
publisher of the Modified Version as given on the Title Page. If
there is no section Entitled “History” in the Document, create one
stating the title, year, authors, and publisher of the Document as
given on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.
J. Preserve the network location, if any, given in the Document for
public access to a Transparent copy of the Document, and likewise
the network locations given in the Document for previous versions
it was based on. These may be placed in the “History” section.
You may omit a network location for a work that was published at
least four years before the Document itself, or if the original
publisher of the version it refers to gives permission.
K. For any section Entitled “Acknowledgements” or “Dedications,”
Preserve the Title of the section, and preserve in the section all
the substance and tone of each of the contributor acknowledgements
and/or dedications given therein.
L. Preserve all the Invariant Sections of the Document,
unaltered in their text and in their titles. Section numbers
or the equivalent are not considered part of the section titles.
M. Delete any section Entitled “Endorsements.” Such a section
may not be included in the Modified Version.
N. Do not retitle any existing section to be Entitled “Endorsements”
or to conflict in title with any Invariant Section.
O. Preserve any Warranty Disclaimers.
If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no material
copied from the Document, you may at your option designate some or all
of these sections as invariant. To do this, add their titles to the
list of Invariant Sections in the Modified Version's license notice.
These titles must be distinct from any other section titles.
You may add a section Entitled “Endorsements,” provided it contains nothing but endorsements of your Modified Version by various parties–for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements,” and any sections Entitled “Dedications.” You must delete all sections Entitled “Endorsements.”
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled “Acknowledgements,” “Dedications,” or “History,” the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.
To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:
Copyright (C) year your name.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled ``GNU
Free Documentation License.''
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with...Texts.” line with this:
with the Invariant Sections being list their titles, with the
Front-Cover Texts being list, and with the Back-Cover Texts being
list.
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.
000 C-@ (set-mark-command): Other Vi Commands001 C-a (vip-beginning-of-line): New Commands002 C-b (vip-scroll-back): Viewing the Buffer003 C-c (vip-ctl-c): Important Keys003 C-c (vip-ctl-c): New Commands004 C-d (vip-scroll-up): Viewing the Buffer005 C-e (vip-scroll-up-one): Viewing the Buffer006 C-f (vip-scroll-back): Viewing the Buffer007 C-g (vip-keyboard-quit): Important Keys007 C-g (vip-keyboard-quit): New Bindings007 C-g (vip-keyboard-quit): Changing010 C-h (delete-backward-char) (insert mode): Commands in Insert Mode010 C-h (vip-delete-backward-char) (insert mode): Insert Mode011 TAB (indent-for-tab-command): Other Vi Commands012 C-j (newline-and-indent): Other Vi Commands013 C-k (kill-line): Other Vi Commands014 C-l (recenter): Other Vi Commands014 C-l (recenter): Important Keys015 RET (vip-scroll-back): Viewing the Buffer015 RET (vip-scroll-back): New Bindings016 C-n (vip-next-window): Buffers and Windows016 C-n (vip-next-window): Window Commands016 C-n (vip-next-window): New Commands017 C-o (vip-open-line-at-point): Commands in Insert Mode017 C-o (vip-open-line-at-point): New Commands020 C-p (previous-line): Other Vi Commands021 C-q (quoted-insert): Other Vi Commands022 C-r (isearch-backward): Other Vi Commands022 C-r (isearch-backward): Searching and Replacing022 C-r (isearch-backward): New Commands023 C-s (isearch-forward): Other Vi Commands023 C-s (isearch-forward): Searching and Replacing023 C-s (isearch-forward): New Commands024 C-t (transpose-chars): Other Vi Commands025 C-u (vip-scroll-down): Viewing the Buffer026 C-v (scroll-up): Other Vi Commands027 C-w (kill-region): Other Vi Commands027 C-w (vip-delete-backward-word) (insert mode): Commands in Insert Mode027 C-w (vip-delete-backward-word) (insert mode): Insert Mode0300 C-x (vip-ctl-x): Important Keys0300 C-x (vip-ctl-x): New Commands0301 C-x C-z (suspend-emacs): Modes in VIP031 C-y (vip-scroll-down-one): Viewing the Buffer032 C-z (vip-change-mode-to-vi): Emacs Mode032 C-z (vip-change-mode-to-vi): Modes in VIP032 C-z (vip-ESC) (insert mode): Commands in Insert Mode032 C-z (vip-ESC) (insert mode): Insert Mode033 ESC (vip-change-mode-to-vi) (insert mode): Commands in Insert Mode033 ESC (vip-change-mode-to-vi) (insert mode): Insert Mode033 ESC (vip-ESC): Important Keys033 ESC (vip-ESC): New Commands040 SPC (vip-scroll): Viewing the Buffer040 SPC (vip-scroll): New Bindings041 ! (vip-command-argument): Other Vi Commands042 " (vip-command-argument): Delete Commands0430 # (vip-command-argument): New Commands0431 # C (upcase-region): New Commands0432 # c (downcase-region): New Commands0432 # g (vip-global-execute): New Commands0432 # q (vip-quote-region): New Commands0432 # s (spell-region): New Commands044 $ (vip-goto-eol): Motion Commands045 % (vip-paren-match): Motion Commands046 & (vip-nil): Other Vi Commands047 ' (vip-goto-mark-and-skip-white): Motion Commands050 ( (vip-backward-sentence): Motion Commands051 ) (vip-forward-sentence): Motion Commands052 * (vip-call-last-kbd-macro): Other Vi Commands052 * (vip-call-last-kbd-macro): Misc Commands052 * (vip-call-last-kbd-macro): New Commands053 + (vip-next-line-at-bol): Motion Commands054 , (vip-repeat-find-opposite): Motion Commands055 - (vip-previous-line-at-bol): Motion Commands056 . (vip-repeat): Repeating and Undoing Modifications056 . (vip-repeat): Undoing057 / (vip-search-forward): Searching and Replacing057 / (vip-search-forward): Counts057 / (vip-search-forward): Searching060 0 (vip-beginning-of-line): Motion Commands061 1 (numeric argument): Numeric Arguments062 2 (numeric argument): Numeric Arguments063 3 (numeric argument): Numeric Arguments064 4 (numeric argument): Numeric Arguments065 5 (numeric argument): Numeric Arguments066 6 (numeric argument): Numeric Arguments067 7 (numeric argument): Numeric Arguments068 8 (numeric argument): Numeric Arguments069 9 (numeric argument): Numeric Arguments072 : (vip-ex): Ex Commands073 ; (vip-repeat-find): Motion Commands074 < (vip-command-argument): Other Vi Commands075 = (vip-command-argument): Other Vi Commands076 > (vip-command-argument): Other Vi Commands077 ? (vip-search-backward): Searching and Replacing077 ? (vip-search-backward): Counts077 ? (vip-search-backward): Searching100 @ (vip-nil): Other Vi Commands101 A (vip-Append): Commands in Insert Mode102 B (vip-backward-Word): Motion Commands103 C (vip-ctl-c-equivalent): Important Keys103 C (vip-ctl-c-equivalent): New Bindings104 D (vip-kill-line): Delete Commands105 E (vip-end-of-Word): Motion Commands106 F (vip-find-char-backward): Motion Commands107 G (vip-goto-line): Motion Commands110 H (vip-window-top): Motion Commands111 I (vip-Insert): Commands in Insert Mode112 J (vip-join-lines): Other Vi Commands113 K (vip-kill-buffer): Buffers and Windows113 K (vip-kill-buffer): Buffer Commands113 K (vip-kill-buffer): New Commands114 L (vip-window-bottom): Motion Commands115 M (vip-window-middle): Motion Commands116 N (vip-search-Next): Searching and Replacing117 O (vip-Open-line): Commands in Insert Mode117 O (vip-Open-line): Counts120 P (vip-Put-back): Put Back Commands120 P (vip-Put-back): Counts121 Q (vip-query-replace): Searching and Replacing121 Q (vip-query-replace): New Commands122 R (vip-replace-string): Searching and Replacing122 R (vip-replace-string): New Commands123 S (vip-switch-to-buffer-other-window): Buffers and Windows123 S (vip-switch-to-buffer-other-window): Buffer Commands123 S (vip-switch-to-buffer-other-window): New Bindings124 T (vip-goto-char-backward): Motion Commands125 U (vip-nil): Other Vi Commands126 V (vip-find-file-other-window): Files126 V (vip-find-file-other-window): File Commands126 V (vip-find-file-other-window): New Commands127 W (vip-forward-Word): Motion Commands1300 X (vip-ctl-x-equivalent): Important Keys1300 X (vip-ctl-x-equivalent): New Bindings1301 X ( (start-kbd-macro): Misc Commands1301 X ) (end-kbd-macro): Misc Commands1301 X 1 (delete-other-windows): Buffers and Windows1301 X 1 (delete-other-windows): Window Commands1301 X 2 (split-window-vertically): Buffers and Windows1301 X 2 (split-window-vertically): Window Commands1301 X 3 (vip-buffer-in-two-windows): Buffers and Windows1301 X 3 (vip-buffer-in-two-windows): Window Commands1301 X 3 (vip-buffer-in-two-windows): New Bindings1302 X B (list-buffers): Buffers and Windows1302 X I (insert-file): Files1302 X I (insert-file): File Commands1302 X S (save-buffer): Files1302 X S (save-buffer): Buffer Commands1302 X W (write-file): Files1302 X W (write-file): File Commands1302 X Z (suspend-emacs): Misc Commands131 Y (vip-yank-line): Yank Commands132 Z Z (save-buffers-kill-emacs): Other Vi Commands133 [ (vip-nil): Other Vi Commands134 \ (vip-escape-to-emacs): Important Keys134 \ (vip-escape-to-emacs): New Commands135 ] (vip-nil): Other Vi Commands136 ^ (vip-bol-and-skip-white): Motion Commands137 _ (vip-nil): Other Vi Commands140 ` (vip-goto-mark): Motion Commands141 a (vip-append): Commands in Insert Mode142 b (vip-backward-word): Motion Commands1430 c (vip-command-argument): Change Commands1431 c R: Change Commands1432 c c: Change Commands1432 c r: Change Commands1440 d (vip-command-argument): Delete Commands1441 d R: Delete Commands1442 d d: Delete Commands1442 d r: Delete Commands145 e (vip-end-of-word): Motion Commands146 f (vip-find-char-forward): Motion Commands147 g (vip-info-on-file): Files147 g (vip-info-on-file): New Bindings150 h (vip-backward-char): Motion Commands151 i (vip-insert): Commands in Insert Mode152 j (vip-next-line): Motion Commands153 k (vip-previous-line): Motion Commands154 l (vip-forward-char): Motion Commands155 m (vip-mark-point): Mark Commands155 m (vip-mark-point): Marking156 n (vip-search-next): Searching and Replacing157 o (vip-open-line): Commands in Insert Mode157 o (vip-open-line): Counts160 p (vip-put-back): Put Back Commands160 p (vip-put-back): Counts161 q (vip-nil): Other Vi Commands162 r (vip-replace-char): Searching and Replacing163 s (vip-switch-to-buffer): Buffers and Windows163 s (vip-switch-to-buffer): Buffer Commands163 s (vip-switch-to-buffer): New Bindings164 t (vip-goto-char-forward): Motion Commands165 u (vip-undo): Repeating and Undoing Modifications165 u (vip-undo): Undoing166 v (vip-find-file): Files166 v (vip-find-file): File Commands166 v (vip-find-file): New Commands167 w (vip-forward-word): Motion Commands170 x (vip-delete-char): Delete Commands1710 y (vip-command-argument): Yank Commands1711 y R: Yank Commands1712 y r: Yank Commands1712 y y (vip-yank-line): Yank Commands1721 z RET (vip-line-to-top): Viewing the Buffer1721 z RET (vip-line-to-top): z Command1722 z - (vip-line-to-bottom): Viewing the Buffer1722 z - (vip-line-to-bottom): z Command1722 z . (vip-line-to-middle): Viewing the Buffer1722 z . (vip-line-to-middle): z Command1723 z H (vip-line-to-top): Viewing the Buffer1723 z H (vip-line-to-top): z Command1723 z L (vip-line-to-bottom): Viewing the Buffer1723 z L (vip-line-to-bottom): z Command1723 z M (vip-line-to-middle): Viewing the Buffer1723 z M (vip-line-to-middle): z Command173 { (vip-backward-paragraph): Motion Commands174 | (vip-goto-col): Motion Commands175 } (vip-forward-paragraph): Motion Commands176 ~ (vip-nil): Other Vi Commands177 DEL (vip-delete-backward-char): Delete Commands