./xemacs-packages/ 0000755 0000000 0000000 00000000000 11423477415 012755 5 ustar root root ./xemacs-packages/man/ 0000755 0000000 0000000 00000000000 11423477463 013533 5 ustar root root ./xemacs-packages/man/prog-modes/ 0000755 0000000 0000000 00000000000 11423477441 015603 5 ustar root root ./xemacs-packages/man/prog-modes/prog-modes.texi 0000644 0000000 0000000 00000276447 11130742316 020565 0 ustar root root @c -*-texinfo-*-
@c
@c Copyright (C) 2002, 2003 Free Software Foundation, Inc.
@c Copyright (C) 2003 Jake Colman
@c Copyright (C) 2004 Ville Skyttä
@c
@c @setfilename prog-modes.info
@settitle Programming Modes for XEmacs
@ifinfo
@dircategory XEmacs Editor
@direntry
* Programming Modes: (prog-modes). Programming Modes for XEmacs.
@end direntry
@end ifinfo
@ignore
@copying
This manual is part of XEmacs.
XEmacs is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
XEmacs is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with XEmacs; see the file COPYING. If not, write to the Free
Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
02111-1307, USA.
@end copying
@end ignore
@node Top, Copying, (dir), (dir)
@chapter The Programming Modes Package
@ifinfo
This Info file contains the manual for the Programming Modes package.
@end ifinfo
The node name for each entry in the menu is the name of the elisp file
containing the code that implements the functionality described. It is
highly recommended that you briefly peruse the elisp source code since it can
provide valuable information on usage and technique. This can easily be done
by typing @code{C-x 4 l RET} where is the name of the
elisp file to be loaded.
In many cases, the @code{customize} command can be used to customize a
package's options. For those packages that support @code{customize}, the
appropriate command is given. Otherwise, peruse the code as described above
to learn how to set the package's options.
When you have entered a mode, you may get more info on the capabilities of
that mode by pressing @kbd{C-h m}. You may also get online help describing
functions provided by the mode by pressing @code{C-h f }.
@menu
* Copying::
* asm-mode:: Editing Assembler Code
* autoconf-mode:: Editing Autoconf Input Files
* awk-mode:: Editing AWK Code
* cl-indent:: Enhanced Lisp-Indent Mode
* cvs:: Light CVS Support
* diff-mode:: Viewing and Editing Context Diffs
* eiffel:: Editing Eiffel Code
* icon:: Editing Icon Code
* javascript-mode:: Editing JavaScript Code
* ksh-mode:: Editing Shell Script (sh, ksh, bash) Code
* lua-mode:: Editing Lua Code
* m4-mode:: Editing m4 Code
* make-mode:: Editing Makefiles
* mode-compile:: Compiling Files According to Major-Mode
* modula2:: Editing Modula-2 Code
* old-c-mode:: Editing C Code
* p4:: Integration with Perforce Version Control
* pascal:: Editing Pascal Code
* php-mode:: Editing PHP Code
* postscript:: Editing PostScript Programs
* prolog:: Editing and Running Prolog Code
* rexx-mode:: Editing REXX Code
* rpm-spec-mode:: Editing RPM Spec Files
* simula:: Editing SIMULA 87 Code
* sql:: Specialized Mode for SQL Interpreters
* tcl:: Editing Tcl Code
* teco:: Teco Interpreter
* uil-mode:: Editing Motif UIL Code
* verilog-mode:: Editing Verilog HDL Source
* vrml-mode:: Editing VRML (.wrl) Files
* XEmacs License:: XEmacs License
@end menu
@node Copying, asm-mode, Top, Top
@chapter Copying
This document may be redistributed, verbatim or in modified form, under
the terms of the GNU General Public License, version 2 or any later
version. The same terms apply to the libraries it documents. A copy
of the General Public License is provided as an Appendix.
Most XEmacs documentation has its own license, which is an ancestor of
the GNU Free Documentation License (@dfn{FDL}), and whose terms are
quite similar to those imposed by GNU on Emacs documentation. Why is
this manual licensed differently (under the GNU General Public License,
or @dfn{GPL}), and why does it have to be distributed separately from
the XEmacs User's Guide and the XEmacs Lisp Reference Manual?
Taking the second question first, XEmacs is @dfn{community-owned}
software. That is, unlike GNU Emacs, there is no monopoly copyright
holder. Many of us, including the original Lucid authors, have
contributed our copyrights to the Free Software Foundation (FSF), and of
course much content is derived from GNU Emacs, and therefore is held by
the FSF. Another large chunk is held by Sun Microsystems, and a few
individual authors hold copyright to thousands of lines each. But many
individuals hold copyright to only a few dozen lines. Like the Linux
kernel, copyright ownership is distributed throughout a community.
However, its license is ``copyleft,'' @emph{i.e.}, it @emph{requires}
that you redistribute it under terms @emph{identical} to those under
which you received it, unless you have explicit permission of the
copyright holder. Because of the multiple owners, determining the
ownership of any given part of XEmacs is tedious, and perhaps
impossible. For practical purposes, then, the license of any
substantial chunk of existing XEmacs content cannot be changed, except
to a later version of the GPL, for those parts under GPL. (That is due
to the @emph{explicit} permission to change to a later version of the
GPL, present in every file of XEmacs.)
Unfortunately, this severe restriction means that the GPL, FDL, and the
XEmacs documentation license (@dfn{XDL}) are @emph{mutually
incompatible}. That is, content licensed under any of the GPL, FDL, or
XDL @emph{may not} be mixed with content licensed under either of the
other two without changing the license of some of the content. But this
requires permission of the copyright holder, which is often difficult or
impossible to get.
For example, you @emph{may not} take comments or docstrings from XEmacs
code and add them to the Lispref to mend a gap in the latter's coverage.
You @emph{may not} copy text from the Lispref into docstrings in the
code. And you @emph{may not} copy text from the GNU Emacs Lisp
Reference to the XEmacs Lisp Reference Manual. (In this case it is at
least trivial to ask permission, although it is rather unclear whether
it would be granted.)
In fact, parts of this document were derived by copying from XEmacs code
under the GPL, without any further permission from the authors. Thus,
this document must be distributed under the GPL, as a ``volume''
separate from the XEmacs documentation under the XDL. Note that the
``mere aggregation'' clauses allow us to distribute in the same
tarball. But incorporating it as a node in the Lispref is prohibited,
even if done by inclusion.
A bit of advocacy:
If you look carefully at the additional restrictions imposed by the
soi-disant "free" documentation licenses, you discover that they are
simply proprietary restrictions guaranteeing a certain amount of
@emph{unpaid} political advertising to the Free Software Foundation and
GNU Project (and in the case of the FDL, this is extended to commercial
advertising by authors of original or derived works). Whether this is
``ethically justified'' or not is a difficult question. What is certain
is that there is little social benefit to these terms (since the license
documents themselves contain the advocacy and must be included with any
distribution).
I conclude it makes sense for XEmacs to reduce its restrictions, where
possible, to the ``least common denominator,'' the GNU General Public
License.
@node asm-mode, autoconf-mode, Copying, Top
@chapter Editing Assembler Code
This mode is used for editing Assembler code. The mode is automatically
invoked for buffers visiting any file ending with one of the following
extensions: @file{.s}, @file{.S}, @file{.asm}.
The mode is based on text-mode. It defines a private abbrev table that can
be used to save abbrevs for assembler mnemonics. It binds just five keys:
@table @kbd
@item TAB
Tab to next tab stop
@item :
Outdent preceding label, tab to tab stop
@item comment char
Place or move comment. @code{asm-comment-char} specifies which character
this is; you can use a different character in different Asm mode buffers.
Alternatively, you may set this variable in @code{asm-mode-set-comment-hook},
which is called near the beginning of mode initialization.
@item C-j, C-m
Newline and tab to tab stop
@end table
Code is automatically indented to the first tab stop level.
Turning on Asm mode runs the hook @code{asm-mode-hook} at the end of
initialization.
To configure this package, type:
@example
M-x customize-group RET asm RET
@end example
@node autoconf-mode, awk-mode, asm-mode, Top
@chapter Editing Autoconf Input Files
This mode is used for editing autoconf input files. It is automatically
invoked for buffers visiting the following types of files:
@itemize @bullet
@item any file ending with an extension of @file{.m4}
@item any file named @file{configure} ending with an extension of either
@file{.in} or @file{.ac}.
@end itemize
To configure this package please view the source code. This can be done by
typing @kbd{C-x 4 l autoconf-mode}.
@menu
* About Autoconf: about-autoconf.
@end menu
@node about-autoconf, , autoconf-mode, autoconf-mode
@section About Autoconf
Autoconf is an extensible package of m4 macros that produce shell scripts to
automatically configure software source code packages. These scripts can
adapt the packages to many kinds of UNIX-like systems without manual user
intervention. Autoconf creates a configuration script for a package from a
template file that lists the operating system features that the package can
use, in the form of m4 macro calls.
@node awk-mode, cl-indent, autoconf-mode, Top
@chapter Editing AWK Code
This mode is used for editing Awk code. It is automatically invoked for
buffers visiting the following types of files:
@itemize @bullet
@item any file ending with an extension of @file{.awk}.
@item any file that has an interpretor line (the "shebang" line) specifying
"awk".
@end itemize
The mode operates much like C mode except for the syntax of comments. It
uses the same keymap as C mode and has the same variables for customizing
indentation. It has its own abbrev table and its own syntax table.
Turning on AWK mode calls the value of the variable @code{awk-mode-hook} with
no arguments, if that value is non-nil.
NOTE: This library is obsolete. Support for AWK is now available directly
via the cc-mode package. @xref{AWK Mode, , , cc-mode, CC Mode Manual}., for
details.
@menu
* About Awk: about-awk.
@end menu
@node about-awk, , awk-mode, awk-mode
@section About Awk
Awk is a text-processing programming language. It is a useful and simple
tool for manipulating text.
@node cl-indent, cvs, awk-mode, Top
@chapter Enhanced Lisp-Indent Mode
This package provides an extension to lisp-mode. It supplies a single entry
point, @code{common-lisp-indent-function}, which performs indentation in the
preferred style for Common Lisp code. To enable it add the following to your
@code{user-init-file}:
@example
(setq lisp-indent-function 'common-lisp-indent-function)
@end example
To configure this package, type:
@example
M-x customize-group RET lisp-indent RET
@end example
@node cvs, diff-mode, cl-indent, Top
@chapter Light CVS Support
This package provides simple CVS support within the editing session.
The package provides the following features:
@itemize @bullet
@item Displays the CVS revision in the mode line.
@item Compares file changes between CVS revisions using @code{ediff}.
@item Keystrokes and menu entries to execute `cvs status', `cvs log' and `cvsann'.
@item Simple interface to `cvs commit' and `cvs update' commands.
@item Status listing per directory.
@item @code{msb} support (better buffer selection).
@item @code{dired} support.
@item Softlink tree support.
@item Little module support (status and update).
@end itemize
To install this library, add the following to your @code{user-init-file}:
@example
(require 'cvs)
@end example
To configure this package please view the source code. This can be done by
typing @kbd{C-x 4 l cvs}.
For related packages please see @ref{Top, PCL-CVS, , pcl-cvs, Pcl-cvs -
The Emacs Front-End to CVS}. and @ref{Version Control, , ,xemacs, The XEmacs
Editor}.
@menu
* About CVS: about-cvs.
@end menu
@node about-cvs, , cvs, cvs
@section About CVS
CVS is the Concurrent Versions System, an open-source network-transparent
version control system. More information on CVS can be found at
@uref{http://www.cvshome.org/,CVS Home}.
@node diff-mode, eiffel, cvs, Top
@chapter Viewing and Editing Context Diffs
This mode facilitates viewing and editing of context diffs. It is
automatically invoked buffers visiting any file ending with one of the
following extensions: @file{.diff}, @file{.diffs}, @file{.patch}, @file{.rej}.
The mode provides support for font-lock, outline, navigation commands,
editing and various conversions as well as jumping.
The following key mappings are defined:
@multitable {M-delete } {diff-reverse-direction}
@item @code{C-c} @tab << Prefix Command >>
@item @code{M-A} @tab diff-ediff-patch
@item @code{M-C} @tab diff-unified->context
@item @code{M-K} @tab diff-file-kill
@item @code{M-N} @tab diff-file-next
@item @code{M-P} @tab diff-file-prev
@item @code{M-R} @tab diff-reverse-direction
@item @code{M-U} @tab diff-context->unified
@item @code{M-W} @tab widen
@item @code{M-k} @tab diff-hunk-kill
@item @code{M-n} @tab diff-hunk-next
@item @code{M-o} @tab diff-goto-source
@item @code{M-p} @tab diff-hunk-prev
@item @code{M-r} @tab diff-restrict-view
@item @code{M-@{} @tab diff-file-prev
@item @code{M-@}} @tab diff-file-next
@item @code{M-delete} @tab scroll-down
@item @code{M-return} @tab diff-goto-source
@item @code{M-space} @tab scroll-up
@item @code{M-C-m} @tab diff-goto-source
@item @code{C-c C-a} @tab diff-apply-hunk
@item @code{C-c C-c} @tab diff-goto-source
@item @code{C-c C-s} @tab diff-split-hunk
@item @code{C-c C-t} @tab diff-test-hunk
@end multitable
To configure this package, type:
@example
M-x customize-group RET diff-mode RET
@end example
@node eiffel, icon, diff-mode, Top
@chapter Editing Eiffel Code
This mode is used for editing Eiffel code. It is automatically invoked for
buffers visiting any file ending in an extension of @file{.e}.
The following key mappings are defined:
@multitable {C-c C-c } {diff-reverse-direction}
@item @code{return} @tab reindent-then-newline-and-indent
@item @code{C-c} @tab << Prefix Command >>
@item @code{C-j} @tab newline-and-indent
@item @code{C-x} @tab << Prefix Command >>
@item @code{M-'} @tab eif-feature-quote
@item @code{M-q} @tab eif-fill-paragraph
@item @code{M-C-a} @tab eif-beginning-of-feature
@item @code{M-C-e} @tab eif-end-of-feature
@item @code{M-C-q} @tab eif-indent-construct
@item @code{C-c C-c} @tab eif-compile
@item @code{C-c C-o} @tab eif-set-compile-options
@item @code{C-c C-r} @tab eif-run
@item @code{C-c C-s} @tab eif-short
@item @code{C-x n} @tab << Prefix Command >>
@item @code{C-x n d} @tab eif-narrow-to-feature
@end multitable
To configure this package, type:
@example
M-x customize-group RET eiffel RET
@end example
@menu
* About Eiffel: about-eiffel.
@end menu
@node about-eiffel, , eiffel, eiffel
@section About Eiffel
The Eiffel programming language was created by Bertrand Meyer and developed
by his company, Interactive Software Engineering (ISE) of Goleta, CA in 1985.
More information on Eiffel can be found at
@uref{http://www.engin.umd.umich.edu/CIS/course.des/cis400/eiffel/eiffel.html,the
Eiffel Web Site}.
@node icon, javascript-mode, eiffel, Top
@chapter Editing Icon Code
This mode is used for editing Icon code. It is automatically invoked for
buffers visiting any file ending in an extension of @file{.icn}.
The mode provides the following features:
@itemize @bullet
@item Expression and list commands understand all Icon brackets.
@item Tab indents for Icon code.
@item Paragraphs are separated by blank lines only.
@item Delete converts tabs to spaces as it moves back.
@end itemize
The following key mappings are defined:
@multitable {M-backspace } {backward-delete-char-untabify}
@item @code{@{} @tab electric-icon-brace
@item @code{@}} @tab electric-icon-brace
@item @code{delete} @tab backward-delete-char-untabify
@item @code{menu-bar} @tab << Prefix command "Icon" >>
@item @code{M-backspace} @tab mark-icon-function
@item @code{M-C-a} @tab beginning-of-icon-defun
@item @code{M-C-e} @tab end-of-icon-defun
@item @code{M-C-h} @tab mark-icon-function
@item @code{M-C-q} @tab indent-icon-exp
@end multitable
The variables controlling indentation style are:
@table @code
@item icon-tab-always-indent
Non-nil means TAB in Icon mode should always reindent the current line,
regardless of where in the line point is when the TAB command is used.
@item icon-auto-newline
Non-nil means automatically newline before and after braces
inserted in Icon code.
@item icon-indent-level
Indentation of Icon statements within surrounding block.
The surrounding block's indentation is the indentation
of the line on which the open-brace appears.
@item icon-continued-statement-offset
Extra indentation given to a substatement, such as the
then-clause of an if or body of a while.
@item icon-continued-brace-offset
Extra indentation given to a brace that starts a substatement.
This is in addition to `icon-continued-statement-offset'.
@item icon-brace-offset
Extra indentation for line if it starts with an open brace.
@item icon-brace-imaginary-offset
An open brace following other text is treated as if it were
this far to the right of the start of its line.
@end table
Turning on Icon mode calls the value of the variable @code{icon-mode-hook}
with no args, if that value is non-nil.
To configure this package, type:
@example
M-x customize-group RET icon RET
@end example
@menu
* About Icon: about-icon.
@end menu
@node about-icon, , icon, icon
@section About Icon
Icon is a high-level, general-purpose programming language with a large
repertoire of features for processing data structures and character
strings. Icon is an imperative, procedural language with a syntax reminiscent
of C and Pascal, but with semantics at a much higher level. More information
on Icon can be found at @uref{http://www.cs.arizona.edu/icon/,The Icon
Programming Language}.
@node javascript-mode, ksh-mode, icon, Top
@chapter Editing JavaScript Code
This mode is used for editing JavaScript code. It is automatically invoked
for buffers visiting any file ending in an extension of @file{.js} or
@file{.pac}.
See the documentation for @code{c++-mode}: JavaScript mode is an extension of
it (@pxref{Top, CC Mode, , cc-mode, CC Mode Manual}). Use the hook
@code{javascript-mode-hook} to execute custom code when entering JavaScript
mode.
The following key mappings are defined:
@multitable {M-C-kp-right } {c-show-syntactic-information}
@item @code{#} @tab c-electric-pound
@item @code{(, )} @tab c-electric-paren
@item @code{*} @tab c-electric-star
@item @code{,} @tab c-electric-semi&comma
@item @code{/} @tab c-electric-slash
@item @code{:} @tab c-electric-colon
@item @code{;} @tab c-electric-semi&comma
@item @code{} @tab c-electric-lt-gt
@item @code{@{} @tab c-electric-brace
@item @code{@}} @tab c-electric-brace
@item @code{backspace} @tab c-electric-backspace
@item @code{delete} @tab c-electric-delete
@item @code{return} @tab c-context-line-break
@item @code{tab} @tab c-indent-command
@item @code{C-c} @tab << Prefix Command >>
@item @code{C-i} @tab c-indent-command
@item @code{C-m} @tab c-context-line-break
@item @code{C-x} @tab << Prefix Command >>
@item @code{M-a} @tab c-beginning-of-statement
@item @code{M-c} @tab c-comment-edit-at-point
@item @code{M-e} @tab c-end-of-statement
@item @code{M-j} @tab c-indent-new-comment-line
@item @code{M-q} @tab c-fill-paragraph
@item @code{M-backspace} @tab backward-kill-word
@item @code{M-backward} @tab backward-kill-word
@item @code{M-delete} @tab backward-kill-word
@item @code{M-linefeed} @tab c-indent-new-comment-line
@item @code{M-C-h} @tab backward-kill-word
@item @code{M-C-j} @tab c-indent-new-comment-line
@item @code{M-C-q} @tab c-indent-exp
@item @code{M-C-kp-left} @tab c-beginning-of-statement
@item @code{M-C-kp-right} @tab c-end-of-statement
@item @code{M-C-left} @tab c-beginning-of-statement
@item @code{M-C-right} @tab c-end-of-statement
@item @code{C-c .} @tab c-set-style
@item @code{C-c C-\} @tab c-backslash-region
@item @code{C-c C-a} @tab c-toggle-auto-state
@item @code{C-c C-b} @tab c-submit-bug-report
@item @code{C-c C-c} @tab comment-region
@item @code{C-c C-d} @tab c-toggle-hungry-state
@item @code{C-c C-n} @tab c-forward-conditional
@item @code{C-c C-o} @tab c-set-offset
@item @code{C-c C-p} @tab c-backward-conditional
@item @code{C-c C-q} @tab c-indent-defun
@item @code{C-c C-s} @tab c-show-syntactic-information
@item @code{C-c C-t} @tab c-toggle-auto-hungry-state
@item @code{C-c C-u} @tab c-up-conditional
@item @code{C-x f} @tab c-fill-paragraph
@end multitable
To configure this package, type:
@example
M-x customize-group RET javascript RET
@end example
@menu
* About JavaScript: about-javascript.
@end menu
@node about-javascript, , javascript-mode, javascript-mode
@section About JavaScript
JavaScript is a compact, object-based scripting language for developing
client and server Internet applications.
@node ksh-mode, lua-mode, javascript-mode, Top
@chapter Editing Shell Script (sh, ksh, bash) Code
This mode is used for editing shell scripts written for the Bourne (sh), Korn
(ksh) or Bourne Again (bash) shells. It is NOT automatically invoked for any
particular file extension. To invoke this mode while editing a file, type
@code{M-x ksh-mode}.
The following key mappings are defined:
@multitable {C-c tab } {reindent-then-newline-and-indent}
@item @code{linefeed} @tab reindent-then-newline-and-indent
@item @code{tab} @tab ksh-indent-line
@item @code{C-c} @tab << Prefix Command >>
@item @code{C-i} @tab ksh-indent-line
@item @code{C-j} @tab reindent-then-newline-and-indent
@item @code{M-tab} @tab ksh-complete-symbol
@item @code{M-C-i} @tab ksh-complete-symbol
@item @code{C-c tab} @tab ksh-completion-init-and-pickup
@item @code{C-c C-i} @tab ksh-completion-init-and-pickup
@end multitable
The variables controlling indentation style are:
@table @code
@item ksh-indent
Indentation of ksh statements with respect to containing block.
Default value is 2.
@item ksh-case-indent
Additional indentation for statements under case items.
Default value is nil which will align the statements one position
past the ")" of the pattern.
@item ksh-case-item-offset
Additional indentation for case items within a case statement.
Default value is 2.
@item ksh-group-offset
Additional indentation for keywords "do" and "then".
Default value is -2.
@item ksh-brace-offset
Additional indentation of "@{" under functions or brace groupings.
Default value is 0.
@item ksh-multiline-offset
Additional indentation of line that is preceded of a line ending with a
@code{\} to make it continue on next line.
@item ksh-tab-always-indent
Controls the operation of the @code{TAB} key. If t (the default), always
reindent the current line. If nil, indent the current line only if
point is at the left margin or in the line's indentation; otherwise
insert a tab.
@item ksh-match-and-tell
If non-nil echo in the minibuffer the matching compound command
for the "done", "@}", "fi", or "esac". Default value is t.
@item ksh-align-to-keyword
Controls whether nested constructs align from the keyword or
the current indentation. If non-nil, indentation will be relative to
the column the keyword starts. If nil, indentation will be relative to
the current indentation of the line the keyword is on.
The default value is non-nil.
@item ksh-comment-regexp
Regular expression used to recognize comments. Customize to support
ksh-like languages. Default value is "\s *#".
@end table
An example of how to set up this mode is as follows:
@example
(setq ksh-mode-hook
(function (lambda ()
(font-lock-mode 1) ;; font-lock the buffer
(setq ksh-indent 8)
(setq ksh-group-offset -8)
(setq ksh-brace-offset -8)
(setq ksh-tab-always-indent t)
(setq ksh-match-and-tell t)
(setq ksh-align-to-keyword t) ;; Turn on keyword alignment
)))
@end example
To configure this package please view the source code. This can be done by
typing @kbd{C-x 4 l ksh-mode}.
For a related package, see @code{sh-script}.
@node lua-mode, m4-mode, ksh-mode, Top
@chapter Editing Lua Code
This mode is used for editing Lua code. It is automatically invoked for
buffers visiting any file ending in the extension @file{.lua}.
To configure this mode, type:
@example
M-x customize-group RET lua RET
@end example
@menu
* About Lua: about-lua.
@end menu
@node about-lua, , lua-mode, lua-mode
@section About Lua
Lua is a powerful light-weight programming language designed for
extending applications. Lua is also frequently used as a
general-purpose, stand-alone language. More information on Lua can be
found at @uref{http://www.lua.org/,The Programming Language Lua}.
@node m4-mode, make-mode, lua-mode, Top
@chapter Editing m4 Code
This mode is used for editing m4 macro definitions. It is NOT automatically
invoked for any particular file extension. To invoke this mode while editing
a file, type @code{M-x m4-mode}.
The mode has most of the syntax right (i.e., sexp motion commands work, but
function motion commands don't). It also sets up font-lock for colorization.
To configure this package please view the source code. This can be done by
typing @kbd{C-x 4 l m4-mode}.
NOTE: The preferred package for editing m4 code is autoconf mode.
@xref{autoconf-mode}., for details.
@menu
* About m4: about-m4.
@end menu
@node about-m4, , m4-mode, m4-mode
@section About m4
m4 is a general purpose macro processor that can be used to preprocess C and
assembly language programs, among other things. Besides the straightforward
replacement of one string of text by another, m4 lets you perform:
@itemize @bullet
@item integer arithmetic
@item file inclusion
@item conditional macro expansion
@item string and substring manipulation
@end itemize
@node make-mode, mode-compile, m4-mode, Top
@chapter Editing Makefiles
This mode is used for editing Makefiles. It is automatically invoked for
for buffers visiting the following types of files:
@itemize @bullet
@item any file ending with an extension of @file{.ma?ke?} or @file{.am}
@item any file named @file{GNU[Mm]akefile} or @file{[Mm]akefile} with an
extension of @file{.in}.
@item any file that has an interpretor line (the "shebang" line) specifying
"make".
@end itemize
The mode knows about Makefile syntax and defines @kbd{M-n} and @kbd{M-p} to
move to next and previous productions.
The keys @kbd{$}, @kbd{=}, @kbd{:} and @kbd{.} are electric; they try to help
you fill in a macro reference, macro definition, ordinary target name, or
special target name, respectively. Such names are completed using a list of
targets and macro names parsed out of the makefile. This list is
automatically updated, if necessary, whenever you invoke one of these
commands. You can force it to be updated with @kbd{C-c C-p}.
The command @kbd{C-c C-f} adds certain filenames in the current directory as
targets. You can filter out filenames by setting the variable
@code{makefile-ignored-files-in-pickup-regex}.
The command @kbd{C-c C-u} grinds for a bit, then pops up a report buffer
showing which target names are up-to-date with respect to their
prerequisites, which targets are out-of-date, and which have no
prerequisites.
The command @kbd{C-c C-b} pops up a browser window listing all target and
macro names. You can mark or unmark items wit @kbd{C-c SPC}, and insert all
marked items back in the Makefile with @kbd{C-c TAB}.
The command @kbd{C-c TAB} in the makefile buffer inserts a GNU make builtin.
You will be prompted for the builtin's args.
The following key mappings are defined:
@multitable {C-c return } {makefile-browser-insert-selection-and-quit}
@item @code{C-c} @tab << Prefix Command >>
@item @code{M-n} @tab makefile-next-dependency
@item @code{M-p} @tab makefile-previous-dependency
@item @code{M-tab} @tab makefile-complete
@item @code{M-C-i} @tab makefile-complete
@item @code{C-c :} @tab makefile-insert-target-ref
@item @code{C-c tab} @tab makefile-insert-gmake-function
@item @code{C-c C-\} @tab makefile-backslash-region
@item @code{C-c C-b} @tab makefile-switch-to-browser
@item @code{C-c C-c} @tab comment-region
@item @code{C-c C-f} @tab makefile-pickup-filenames-as-targets
@item @code{C-c C-i} @tab makefile-insert-gmake-function
@item @code{C-c C-p} @tab makefile-pickup-everything
@item @code{C-c C-u} @tab makefile-create-up-to-date-overview
@end multitable
In the browser, use the following keys:
@multitable {C-c return } {makefile-browser-insert-selection-and-quit}
@item @code{I} @tab makefile-browser-insert-selection-and-quit
@item @code{i} @tab makefile-browser-insert-selection
@item @code{n} @tab makefile-browser-next-line
@item @code{p} @tab makefile-browser-previous-line
@item @code{q} @tab makefile-browser-quit
@item @code{space} @tab makefile-browser-toggle
@item @code{C-c} @tab << Prefix Command >>
@item @code{C-n} @tab makefile-browser-next-line
@item @code{C-p} @tab makefile-browser-previous-line
@item @code{C-c return} @tab makefile-browser-insert-continuation
@item @code{C-c C-m} @tab makefile-browser-insert-continuation
@end multitable
Makefile mode can be configured by modifying the following variables:
@table @code
@item makefile-browser-buffer-name:
Name of the macro- and target browser buffer.
@item makefile-target-colon:
The string that gets appended to all target names
inserted by @code{makefile-insert-target}.
":" or "::" are quite common values.
@item makefile-macro-assign:
The string that gets appended to all macro names
inserted by @code{makefile-insert-macro}.
The normal value should be " = ", since this is what
standard make expects. However, newer makes such as dmake
allow a larger variety of different macro assignments, so you
might prefer to use " += " or " := " .
@item makefile-tab-after-target-colon:
If you want a @code{TAB} (instead of a space) to be appended after the
target colon, then set this to a non-nil value.
@item makefile-browser-leftmost-column:
Number of blanks to the left of the browser selection mark.
@item makefile-browser-cursor-column:
Column in which the cursor is positioned when it moves
up or down in the browser.
@item makefile-browser-selected-mark:
String used to mark selected entries in the browser.
@item makefile-browser-unselected-mark:
String used to mark unselected entries in the browser.
@item makefile-browser-auto-advance-after-selection-p:
If this variable is set to a non-nil value the cursor
will automagically advance to the next line after an item
has been selected in the browser.
@item makefile-pickup-everything-picks-up-filenames-p:
If this variable is set to a non-nil value then
@code{makefile-pickup-everything} also picks up filenames as targets
(i.e. it calls @code{makefile-pickup-filenames-as-targets}), otherwise
filenames are omitted.
@item makefile-cleanup-continuations-p:
If this variable is set to a non-nil value then Makefile mode
will assure that no line in the file ends with a backslash
(the continuation character) followed by any whitespace.
This is done by silently removing the trailing whitespace, leaving
the backslash itself intact.
IMPORTANT: Please note that enabling this option causes Makefile mode
to MODIFY A FILE WITHOUT YOUR CONFIRMATION when "it seems necessary".
@item makefile-browser-hook:
A function or list of functions to be called just before the
browser is entered. This is executed in the makefile buffer.
@item makefile-special-targets-list:
List of special targets. You will be offered to complete
on one of those in the minibuffer whenever you enter a `.'.
at the beginning of a line in Makefile mode.
@end table
To configure this package, type:
@example
M-x customize-group RET makefile RET
@end example
@menu
* About Make: about-make.
@end menu
@node about-make, , make-mode, make-mode
@section About Make
A Makefile is used by a `make' utility to automatically determine which
pieces of a large program need to be recompiled, and to issue the commands to
recompile them. @xref{Top, Make, , make, GNU Make Manual}., for details.
@node mode-compile, modula2, make-mode, Top
@chapter Compiling Files According to Major-Mode
The @code{compile} command is very rudimentary in its creation of its
compilation command, using "make -k" by default. This package provides an
intelligent replacement for the @code{compile} command. @xref{Compilation, ,
,xemacs, The XEmacs Editor}., for details.
The @code{mode-compile} command functions as a layer above @code{compile}.
Its purpose is mainly to build a smarter compile command for @code{compile}
to execute. This compile command is built according to number of parameters:
@itemize @bullet
@item the major-mode
@item presence or absence of a makefile in the current directory
@item the @code{buffer-file-name} and extension
@item contents of the current buffer (`main' function, "#!/path/shell", ...)
@item and more ... (see below)
@end itemize
Most of these parameters are highly customizable through Emacs Lisp variables
(to be set in your @code{user-init-file} or through the Customization menu).
Running @code{mode-compile} after a universal-argument (@kbd{C-u}) allows
remote compilations; the user is prompted for the host name to execute the
compilation command. The @code{mode-compile-kill} function terminates a
running compilation session launched by @code{mode-compile}.
By default, @code{mode-compile} is very verbose and waits a user-specified
number of seconds after displaying each message to give the user time to read
it. The variables @code{mode-compile-expert-p} and
@code{mode-compile-reading-time} can be used to change this behaviour. On
Windows-based systems, the variable @code{mode-compile-other-frame-p} will
create a new frame and launch the compilation command in it.
@menu
* compile-cust:: Customization
* compile-compilation-mode:: compilation-mode
* compile-makefile-mode:: makefile-mode
* compile-emacs-lisp-mode:: emacs-lisp-mode, lisp-interaction-mode
* compile-dired-mode:: dired-mode
* compile-sh-mode:: sh-mode, csh-mode, zsh-mode
* compile-c?perl-mode:: c?perl-mode
* compile-tcl-mode:: tcl-mode
* compile-c-mode:: c-mode, c++-mode
* compile-ada-mode:: ada-mode
* compile-fortran-mode:: fortran-mode
* compile-java-mode:: java-mode
* compile-python-mode:: python-mode
* compile-message-mode:: message-mode
* compile-catchall:: Miscellaneous Modes
@end menu
@node compile-cust, compile-compilation-mode, mode-compile, mode-compile
@section Customization
This section explains how the @code{compile-command} is built according
to the @code{major-mode} and how to customize it. The major modes currently
supported are:
@multitable {lisp-interaction-mode} {lisp-interaction-mode} {lisp-interaction-mode}
@item ada-mode @tab c++-mode @tab c-mode
@item c?perl-mode @tab compilation-mode @tab csh-mode
@item dired-mode @tab emacs-lisp-mode @tab fortran-mode
@item fundamental-mode @tab indented-text-mode @tab java-mode
@item lisp-interaction-mode @tab makefile-mode @tab python-mode
@item sh-mode @tab tcl-mode @tab text-mode
@item zsh-mode
@end multitable
For other modes a default behaviour is provided.
When running @code{mode-compile} or @code{mode-compile-kill} the hooks
@code{mode-compile-(before|after)-(compile|kill)-hook} are executed. The
current buffer can be automatically saved if
@code{mode-compile-always-save-buffer-p} is set to @code{t}. All the
modified buffers can be automatically saved if @code{mode-compile-save-all-p}
is set to @code{t}.
To configure this package, type:
@example
M-x customize-group RET compilation RET
@end example
@node compile-compilation-mode, compile-makefile-mode, compile-cust, mode-compile
@section compilation-mode
Calls @code{compile} with the last compile command.
@node compile-makefile-mode, compile-emacs-lisp-mode, compile-compilation-mode, mode-compile
@section makefile-mode
The makefile is run with make through @code{compile} (user is prompted for
the rule to run, see variable @code{mode-compile-preferred-default-makerule}
to see how a default choice could be selected).
@node compile-emacs-lisp-mode, compile-dired-mode, compile-makefile-mode, mode-compile
@section emacs-lisp-mode, lisp-interaction-mode
If the buffer is a @file{.el} file we @code{byte-compile} it to produce a
@file{.elc} file. Otherwise, just @code{byte-compile} the buffer (this does
not use @code{compile} but @code{byte-compile}).
@node compile-dired-mode, compile-sh-mode, compile-emacs-lisp-mode, mode-compile
@section dired-mode
Find a @file{makefile} in the directory and run make with it (like in
@code{makefile-mode}), else try to @code{byte-recompile} all @file{.el} files
older than their associated @file{.elc} files (unlike
@code{byte-recompile-directory} this is not recursive), finally if no
@file{.el} files are present ask compilation command to user by calling
@code{default-compile}. To find a @file{makefile} a regexp is provided which
name is @code{mode-compile-makefile-regexp}.
@node compile-sh-mode, compile-c?perl-mode, compile-dired-mode, mode-compile
@section sh-mode, csh-mode, zsh-mode
Run "[cz]?sh" with debugging arguments as specified in
@code{[cz]?sh-dbg-flags} on the currently edited file.
@node compile-c?perl-mode, compile-tcl-mode, compile-sh-mode, mode-compile
@section c?perl-mode
Run file with "perl -w" (can step through errors with compile's @code{next-error}
command).
@node compile-tcl-mode, compile-c-mode, compile-c?perl-mode, mode-compile
@section tcl-mode
Run file with "wish" (can step through errors with compile's
@code{next-error} command).
@node compile-c-mode, compile-ada-mode, compile-tcl-mode, mode-compile
@section c-mode, c++-mode
First it tries to see if there is a @file{makefile} in the
directory. Makefiles to look for are specified by the variable
@code{mode-compile-makefile-regexp}. If yes two cases could happen: there is
only one makefile so use it, or there is more than one (sometimes when you
need to write portable soft you could have some makefiles by system:
SunOs.make, HP.make ...), in that case prompt to user for choice (with smart
completion). Once the makefile has been selected it extract the rules from
it and ask to user to choose a rule to make (with smart completion, see
variable @code{mode-compile-preferred-default-makerule} to see how a default
choice could be selected).
There are some cases where no makefiles are present (YES I KNOW this is bad
practice but you sometimes have no need to write a Makefile). In that case
the function tries to build the most intelligent compilation command by using
the favourite user C/C++ compiler: value of environment variable "CC" or
"CXX" or first found, in the PATH, of compilers specified in variable
@code{cc-compilers-list} or @code{c++-compilers-list}. Then it looks for the
environment variable "CFLAGS" of "CXXFLAGS" to append to the compiler command,
finds the file to compile: .(c|cc|C|cpp) (see *)
and asks for confirmation. If you really trust mode-compile will build the
correct command and want to bypass confirmation you could set the variable
@code{mode-compile-never-edit-command-p} to @code{t}.
@node compile-ada-mode, compile-fortran-mode, compile-c-mode, mode-compile
@section ada-mode
Same as c/c++-mode but run Ada compiler on the Ada file. There are no
companion file and no way to find a main function in Ada.
@node compile-fortran-mode, compile-java-mode, compile-ada-mode, mode-compile
@section fortran-mode
Same as c-mode but run Fortran compiler on .[Ff](or)? files.
@node compile-java-mode, compile-python-mode, compile-fortran-mode, mode-compile
@section java-mode
Same as c-mode but call "javac" without the -o option on .java files
@node compile-python-mode, compile-message-mode, compile-java-mode, mode-compile
@section python-mode
Run file with "python" (can step through errors with compile's
@code{next-error} command).
@node compile-message-mode, compile-catchall, compile-python-mode, mode-compile
@section message-mode
Run @code{message-send}.
@node compile-catchall, , compile-message-mode, mode-compile
@section Miscellaneous Modes
This handles @code{fundamental-mode}, @code{text-mode},
@code{indented-text-mode} and any unknown modes.
Try to guess what the file is by
@itemize @bullet
@item Looking at its name and extension (see variable
@code{mode-compile-filename-regexp-alist}).
@item Looking at string "#!/path/shell" at first line to extract shell to run
the script with (see variable @code{mode-compile-shell-alist}).
@item Looking at a makefile in current directory.
@item Calling @code{compile} with the last compile command which is asked to
be edited by user
@end itemize
The @code{kill-compile} command is then bound dynamically (buffer-local).
@node modula2, old-c-mode, mode-compile, Top
@chapter Editing Modula-2 Code
This mode is used for editing Modula-2 code. It is NOT automatically invoked
for any particular file extension. To invoke this mode while editing a file,
type @code{M-x modula-2-mode}.
The mode provides convenient abbrevs for Modula-2 keywords, knows about the
standard layout rules, and supports a native compile command.
All control constructs of Modula-2 can be reached by typing C-c followed by
the first character of the construct.
The following key mappings are defined:
@multitable {C-c C-z suspend Emacs} {Control-c Control-w with}
@item C-c b begin @tab C-c c case
@item C-c d definition @tab C-c e else
@item C-c f for @tab C-c h header
@item C-c i if @tab C-c m module
@item C-c l loop @tab C-c o or
@item C-c p procedure @tab Control-c Control-w with
@item C-c r record @tab C-c s stdio
@item C-c t type @tab C-c u until
@item C-c v var @tab C-c w while
@item C-c x export @tab C-c y import
@item C-c @{ begin-comment @tab C-c @} end-comment
@item C-c C-z suspend Emacs @tab C-c C-t toggle
@item C-c C-c compile @tab M-x m2-next-error next-error
@item C-c C-l link
@end multitable
Following are some important variables:
@table @code
@item m2-indent
controls the number of spaces for each indentation.
@item m2-compile-command
holds the command to compile a Modula-2 program.
@item m2-link-command
holds the command to link a Modula-2 program.
@end table
To configure this package, type:
@example
M-x customize-group RET modula2 RET
@end example
@menu
* About Modula-2: about-modula2.
@end menu
@node about-modula2, , modula2, modula2
@section About Modula-2
Modula-2 is a programming language developed by Niklaus Wirth at ETH in
Zurich, Switzerland in the late 70's. Wirth also developed Algol-W, Pascal,
Modula, and Oberon.
Modula-2 corrects some of the deficiencies of Pascal. It is suitable for
learning programming, for large projects written and maintained in the
fashion of professional software engineers, and for real time embedded
systems. Modula-2 is small, expressive, easy to learn and to read.
@node old-c-mode, p4, modula2, Top
@chapter Editing C Code
This is a smart editing mode for C code. It knows a lot about C syntax and
tries to position the cursor according to C layout conventions. You can
change the details of the layout style with option variables.
The mode provides the following features:
@itemize @bullet
@item Expression and list commands understand all C brackets.
@item Tab indents for C code.
@item Comments are delimited with /* ... */.
@item Paragraphs are separated by blank lines only.
@item Delete converts tabs to spaces as it moves back.
@end itemize
The variables controlling indentation style are:
@table @code
@item c-tab-always-indent
Non-nil means TAB in C mode should always reindent the current line,
regardless of where in the line point is when the TAB command is used.
@item c-auto-newline
Non-nil means automatically newline before and after braces,
and after colons and semicolons, inserted in C code.
@item c-indent-level
Indentation of C statements within surrounding block.
The surrounding block's indentation is the indentation
of the line on which the open-brace appears.
@item c-continued-statement-offset
Extra indentation given to a substatement, such as the
then-clause of an if or body of a while.
@item c-continued-brace-offset
Extra indentation given to a brace that starts a substatement.
This is in addition to c-continued-statement-offset.
@item c-brace-offset
Extra indentation for line if it starts with an open brace.
@item c-brace-imaginary-offset
An open brace following other text is treated as if it were
this far to the right of the start of its line.
@item c-argdecl-indent
Indentation level of declarations of C function arguments.
@item c-label-offset
Extra indentation for line that is a label, or case or default.
@end table
NOTE: This package has been obsoleted by the cc-mode package (@pxref{Top, CC
Mode, , cc-mode, CC Mode Manual}). cc-mode can be quite slow, however, on
large files, even on fast machines. This version works with no problems on
the XEmacs source code and is very very fast.
To configure this package, type:
@example
M-x customize-group RET old-c RET
@end example
@node p4, pascal, old-c-mode, Top
@chapter Integration with Perforce Version Control
This package provides simple integration with Perforce Version Control.
To use this package, add the following line to your @code{user-init-file}:
@example
(load-library "p4")
@end example
To configure this package, type:
@example
M-x customize-group RET p4 RET
@end example
@menu
* About Perforce: about-perforce.
@end menu
@node about-perforce, , p4, p4
@section About Perforce
The Perforce SCM System features comprehensive software configuration
management capabilities built around a scalable client/server
architecture. Requiring only TCP/IP, developers can access the Perforce
Server through a variety of Perforce clients (Windows GUI, Web, or
Command-Line). Perforce can be deployed quickly and easily, and requires
minimal administration1, even for large or distributed sites.
More information on Perforce can be found at @uref{http://www.perforce.com/}.
@node pascal, php-mode, p4, Top
@chapter Editing Pascal Code
This mode is used for editing Pascal code. It is automatically invoked for
buffers visiting any file ending with an extension of @file{.pas}.
The mode provides the following capabilities:
@itemize @bullet
@item TAB indents for Pascal code.
@item Delete converts tabs to spaces as it moves back.
@item @code{pascal-complete-word} completes the word around current point
with respect \ to position in code
@item @code{pascal-show-completions} shows all possible completions at this
point.
@end itemize
Other useful functions are:
@table @code
@item pascal-mark-defun
Mark function.
@item pascal-insert-block
insert begin ... end;
@item pascal-star-comment
insert (* ... *)
@item pascal-comment-area
Put marked area in a comment, fixing nested comments.
@item pascal-uncomment-area
Uncomment an area commented with @code{pascal-comment-area}.
@item pascal-beg-of-defun
Move to beginning of current function.
@item pascal-end-of-defun
Move to end of current function.
@item pascal-goto-defun
Goto function prompted for in the minibuffer.
@item pascal-outline
Enter pascal-outline-mode (see also pascal-outline).
@end table
The variables controlling indentation/edit style are:
@table @code
@item pascal-indent-level
Indentation of Pascal statements with respect to containing block.
@item pascal-case-indent
Indentation for case statements.
@item pascal-auto-newline
Non-nil means automatically newline after semicolons and the punctuation
mark after an end.
@item pascal-tab-always-indent
Non-nil means TAB in Pascal mode should always reindent the current line,
regardless of where in the line point is when the TAB command is used.
@item pascal-auto-endcomments
Non-nil means a comment @{ ... @} is set after the ends which ends cases and
functions. The name of the function or case will be set between the braces.
@item pascal-auto-lineup
List of contexts where auto lineup of :'s or ='s should be done.
@end table
See also the user variables @code{pascal-type-keywords},
@code{pascal-start-keywords} and @code{pascal-separator-keywords}.
Turning on Pascal mode calls the value of the variable
@code{pascal-mode-hook} with no args, if that value is non-nil.
To configure this package, type:
@example
M-x customize-group RET pascal RET
@end example
@node php-mode, postscript, pascal, Top
@chapter Editing PHP Code
PHP mode is a major mode for editing PHP source code. It is
automatically invoked for buffers visiting the following files of files:
@itemize @bullet
@item any file ending with one of the following extensions: @file{.phps},
@file{.php3}, @file{.php4}
@item any file ending with the extension @file{.phtml}
@item any file ending with the extension @file{.inc}
@end itemize
The mode is an extension of cc-mode; thus it inherits all cc-mode's
navigation functionality (@pxref{Top, CC Mode, , cc-mode, CC Mode Manual}).
But it colors according to the PHP grammar and indents according to the PEAR
coding guidelines. It also includes a couple of handy IDE-type features such
as documentation search and a source and class browser.
For colorization, turn on @code{global-font-lock} or add the following to
your @code{user-init-file}:
@example
(add-hook 'php-mode-user-hook 'turn-on-font-lock)
@end example
To use abbrev-mode, add lines like this to your @code{user-init-file}:
@example
(add-hook 'php-mode-user-hook
'(lambda () (define-abbrev php-mode-abbrev-table "ex" "extends")))
@end example
To make php-mode compatible with html-mode, see @uref{http://php-mode.sourceforge.net/}.
To configure this package, type:
@example
M-x customize-group RET php RET
@end example
@menu
* About PHP: about-php.
@end menu
@node about-php, , php-mode, php-mode
@section About PHP
PHP is a widely-used general-purpose scripting language that is especially
suited for Web development and can be embedded into HTML. For more
information, see @uref{http://www.php.net/}.
@node postscript, prolog, php-mode, Top
@chapter Editing PostScript Programs
This mode is used for editing PostScript programs. It is automatically
invoked for buffers visiting any file ending with an extension of @file{.cps}
or @file{.ps}.
@code{C-c C-c} will send the contents of the buffer to the NeWS server using
psh(1). @code{C-c |} sends the current region. @code{C-c !} starts an
interactive psh(1) window which will be used for subsequent @code{C-c C-c} or
@code{C-c |} commands.
In this mode, @code{TAB} and @code{M-C-\} attempt to indent code based on the
position of @{@}, [], and begin/end pairs. The variable
@code{ps-indent-level} controls the amount of indentation used inside arrays
and begin/end pairs.
The following key mappings are defined:
@multitable {C-c C-c } {<< Prefix Command >>}
@item @code{tab} @tab ps-tab
@item @code{C-c} @tab << Prefix Command >>
@item @code{C-i} @tab ps-tab
@item @code{C-c !} @tab ps-shell
@item @code{C-c |} @tab ps-execute-region
@item @code{C-c C-c} @tab ps-execute-buffer
@end multitable
@code{M-x postscript-mode} calls the value of the variable
@code{postscript-mode-hook} with no args, if that value is non-nil.
To configure this package please view the source code. This can be done by
typing @kbd{C-x 4 l postscript}.
@menu
* About PostScript: about-postscript.
@end menu
@node about-postscript, , postscript, postscript
@section About PostScript
PostScript is a programming language optimized for printing graphics and text
(whether on paper, film, or CRT is immaterial). In the jargon of the day, it
is a page description language. It was introduced by Adobe in 1985 and first
(to my knowledge) appeared in the Apple LaserWriter. The main purpose of
PostScript was to provide a convenient language in which to describe images
in a device independent manner. This device independence means that the image
is described without reference to any specific device features (e.g. printer
resolution) so that the same description could be used on any PostScript
printer (say, a LaserWriter or a Linotron) without modification.
@node prolog, rexx-mode, postscript, Top
@chapter Editing and Running Prolog Code
This mode is used for editing Prolog code. It is automatically invoked for
buffers visiting any file ending with an of extension @file{.prolog}.
The mode knows about Prolog syntax and comments, and can send regions to an
inferior Prolog interpreter process.
Blank lines and `%%...' separate paragraphs. `%'s start comments.
The following key mappings are defined:
@multitable {M-C-x } {prolog-consult-region}
@item @code{tab} @tab prolog-indent-line
@item @code{C-i} @tab prolog-indent-line
@item @code{M-C-x} @tab prolog-consult-region
@end multitable
Entry to this mode calls the value of @code{prolog-mode-hook} if that value
is non-nil.
To configure this package, type:
@example
M-x customize-group RET prolog RET
@end example
@node rexx-mode, rpm-spec-mode, prolog, Top
@chapter Editing REXX Code
This mode is used for editing REXX code. It is automatically invoked for
buffers visiting the following types of files:
@itemize @bullet
@item any file ending with an extension of @file{.rexx}.
@item any file that has an interpretor line (the "shebang" line) specifying "rexx".
@end itemize
The following key mappings are defined:
@multitable {backspace } {backward-delete-char-untabify}
@item @code{backspace} @tab backward-delete-char-untabify
@item @code{return} @tab rexx-indent-and-newline
@item @code{tab} @tab rexx-indent-command
@item @code{C-c} @tab << Prefix Command >>
@item @code{C-i} @tab rexx-indent-command
@item @code{C-m} @tab rexx-indent-and-newline
@item @code{C-c C-c} @tab rexx-debug
@item @code{C-c C-p} @tab rexx-find-matching-do
@end multitable
The following variables control indentation style:
@table @code
@item rexx-indent
The basic indentation for do-blocks.
@item rexx-end-indent
The relative offset of the \"end\" statement. 0 places it in the same column
as the statements of the block. Setting it to the same value as rexx-indent
places the \"end\" under the do-line.
@item rexx-cont-indent
The indention for lines following \"then\", \"else\" and \",\" (continued)
lines.
@item rexx-tab-always-indent
Non-nil means TAB in REXX mode should always reindent the current line,
regardless of where in the line the point is when the TAB command is used.
@end table
If you have set @code{rexx-end-indent} to a nonzero value, you probably want
to remap @kbd{RETURN} to @code{rexx-indent-newline-indent}. It makes sure
that lines indents correctly when you press @kbd{RETURN}.
An extensive abbreviation table consisting of all the keywords of REXX are
supplied. Expanded keywords are converted into upper case making it easier
to distinguish them. To use this feature the buffer must be in
@code{abbrev-mode}. (See example below.)
Turning on REXX mode calls the value of the variable @code{rexx-mode-hook}
with no args, if that value is non-nil.
For example:
@example
(setq rexx-mode-hook '(lambda ()
(setq rexx-indent 4)
(setq rexx-end-indent 4)
(setq rexx-cont-indent 4)
(local-set-key \"\\C-m\" 'rexx-indent-newline-indent)
(abbrev-mode 1)
))
@end example
will make the END aligned with the DO/SELECT. It will indent blocks and
IF-statements four steps and make sure that the END jumps into the correct
position when RETURN is pressed. Finally it will use the abbrev table to
convert all REXX keywords into upper case.
To configure this package, type:
@example
M-x customize-group RET rexx RET
@end example
@menu
* About REXX: about-rexx.
@end menu
@node about-rexx, , rexx-mode, rexx-mode
@section About REXX
REXX is a programming language designed by Michael Cowlishaw of IBM UK
Laboratories. Rexx is an acronym which stands for "Restructured Extended
Executor Language". In Mike's own words: "REXX is a procedural language that
allows programs and algorithms to be written in a clear and structured way."
@node rpm-spec-mode, simula, rexx-mode, Top
@chapter Editing RPM Spec Files
This mode is used for editing spec files for building RPM packages.
It is automatically invoked for buffers visiting any file ending with an
extension of @file{.spec?} or @file{.spec.in}.
The mode much like C mode except for the syntax of comments. It uses the
same keymap as C mode and has the same variables for customizing indentation.
It has its own abbrev table and its own syntax table. @xref{Top, CC Mode, ,
cc-mode, CC Mode Manual}., for details.
Turning on RPM spec mode calls the value of the variable
@code{rpm-spec-mode-hook} with no args, if that value is non-nil.
To configure this package, type:
@example
M-x customize-group RET rpm-spec RET
@end example
@menu
* About RPM: about-rpm.
@end menu
@node about-rpm, , rpm-spec-mode, rpm-spec-mode
@section About RPM
The RPM Package Manager (RPM) is a powerful command line driven package
management system capable of installing, uninstalling, verifying, querying,
and updating computer software packages. Each software package consists of an
archive of files along with information about the package like its version, a
description, and the like. There is also a related API ("Application Program
Interface"), permitting advanced developers to bypass 'shelling out' to a
command line, and to manage such transactions from within a native coding
language.
For more information, see @uref{http://www.rpm.org/}.
@node simula, sql, rpm-spec-mode, Top
@chapter Editing SIMULA 87 Code
This mode is used for editing SIMULA code. It is NOT automatically
invoked for any particular file extension. To invoke this mode while editing
a file, type @code{M-x simula-mode}.
The mode knows about Simula syntax and standard indentation commands. It
also provides convenient abbrevs for Simula keywords.
The following key mappings are defined:
@multitable {C-c C-d } {simula-forward-down-level}
@item @code{:} @tab simula-electric-label
@item @code{tab} @tab simula-indent-command
@item @code{C-c} @tab << Prefix Command >>
@item @code{C-i} @tab simula-indent-command
@item @code{C-c C-d} @tab simula-forward-down-level
@item @code{C-c C-n} @tab simula-next-statement
@item @code{C-c C-p} @tab simula-previous-statement
@item @code{C-c C-u} @tab simula-backward-up-level
@end multitable
The following variables controlling indentation style:
@table @code
@item simula-tab-always-indent
Non-nil means TAB in SIMULA mode should always reindent the current line,
regardless of where in the line point is when the TAB command is used.
@item simula-indent-level
Indentation of SIMULA statements with respect to containing block.
@item simula-substatement-offset
Extra indentation after DO, THEN, ELSE, WHEN and OTHERWISE.
@item simula-continued-statement-offset
Extra indentation for lines not starting a statement or substatement,
e.g. a nested FOR-loop. If value is a list, each line in a multiple-
line continued statement will have the car of the list extra indentation
with respect to the previous line of the statement.
@item simula-label-offset -4711
Offset of SIMULA label lines relative to usual indentation.
@item simula-if-indent '(0 . 0)
Extra indentation of THEN and ELSE with respect to the starting IF.
Value is a cons cell, the car is extra THEN indentation and the cdr
extra ELSE indentation. IF after ELSE is indented as the starting IF.
@item simula-inspect-indent '(0 . 0)
Extra indentation of WHEN and OTHERWISE with respect to the
corresponding INSPECT. Value is a cons cell, the car is
extra WHEN indentation and the cdr extra OTHERWISE indentation.
@item simula-electric-indent nil
If this variable is non-nil, `simula-indent-line'
will check the previous line to see if it has to be reindented.
@item simula-abbrev-keyword 'upcase
Determine how SIMULA keywords will be expanded. Value is one of
the symbols `upcase', `downcase', `capitalize', (as in) `abbrev-table',
or nil if they should not be changed.
@item simula-abbrev-stdproc 'abbrev-table
Determine how standard SIMULA procedure and class names will be
expanded. Value is one of the symbols `upcase', `downcase', `capitalize',
(as in) `abbrev-table', or nil if they should not be changed.
@end table
Turning on SIMULA mode calls the value of the variable
@code{simula-mode-hook} with no arguments, if that value is non-nil.
Warning: @code{simula-mode-hook} should not read in an abbrev file without
calling the function @code{simula-install-standard-abbrevs} afterwards,
preferably not at all.
To configure this package, type:
@example
M-x customize-group RET simula RET
@end example
@menu
* About SIMULA: about-simula.
@end menu
@node about-simula, , simula, simula
@section About SIMULA
The SIMULA programming language was designed and built by Ole-Johan Dahl and
Kristen Nygaard at the Norwegian Computing Center (NCC) in Oslo between 1962
and 1967. It was originally designed and implemented as a language for
discrete event simulation, but was later extended and reimplemented as a full
scale general purpose programming language.
For more information, see
@uref{http://www.engin.umd.umich.edu/CIS/course.des/cis400/simula/simula.html}.
@node sql, tcl, simula, Top
@chapter Specialized Mode for SQL Interpreters
This package provides a @code{sql-mode} and a @code{sql-interactive-mode}.
The goals were two simple modes providing syntactic highlighting. The
interactive mode had to provide a command-line history; the other mode had to
provide "send region/buffer to SQL interpreter" functions. "simple" in this
context means easy to use, easy to maintain and little or no bells and
whistles.
@code{sql-interactive-mode} is used to interact with a SQL interpreter
process in a SQLi buffer (usually called `*SQL*'). The SQLi buffer
is created by calling a SQL interpreter-specific entry function. Do
@emph{not} call @code{sql-interactive-mode} by itself.
The list of currently supported interpreters and the corresponding entry
function used to create the SQLi buffers is shown with @kbd{M-x sql-help}.
Since @code{sql-interactive-mode} is built on top of the general
command-interpreter-in-a-buffer mode (comint mode), it shares a common base
functionality, and a common set of bindings, with all modes derived from
comint mode. This makes these modes easier to use.
@code{sql-mode} can be used to keep editing SQL statements. The SQL
statements can be sent to the SQL process in the SQLi buffer.
For documentation on the functionality provided by comint mode, and the hooks
available for customizing it, see the file @file{comint.el}.
Hint for newbies: take a look at @code{dabbrev-expand}, @code{abbrev-mode},
and @code{imenu-add-menubar-index}.
To configure this package, type:
@example
M-x customize-group RET SQL RET
@end example
@node tcl, teco, sql, Top
@chapter Editing Tcl Code
This mode is used to edit Tcl code. The mode is automatically invoked
for buffers visiting the following types of files:
@itemize @bullet
@item any file ending with an extension of @file{.tcl} or @file{.exp}.
@item any file that has an interpretor line (the "shebang" line) specifying
"scope", "wish", "tcl", "tclsh", or "expect".
@end itemize
The mode provides the following capabilities:
@itemize @bullet
@item Expression and list commands understand all Tcl brackets.
@item Tab indents for Tcl code.
@item Paragraphs are separated by blank lines only.
@item Delete converts tabs to spaces as it moves back.
@end itemize
The variables controlling indentation style are:
@table @code
@item tcl-indent-level
Indentation of Tcl statements within surrounding block.
@item tcl-continued-indent-level
Indentation of continuation line relative to first line of command.
@end table
The variables controlling user interaction with mode (see variable
documentation for details) are:
@table @code
@item tcl-tab-always-indent
Controls action of TAB key.
@item tcl-auto-newline
Non-nil means automatically newline before and after braces, brackets,
and semicolons inserted in Tcl code.
@item tcl-electric-hash-style
Controls action of `#' key.
@item tcl-use-hairy-comment-detector
If t, use more complicated, but slower, comment detector.
This variable is only used in Emacs 19.
@item tcl-use-smart-word-finder
If not nil, use a smarter, Tcl-specific way to find the current
word when looking up help on a Tcl command.
@end table
Turning on Tcl mode calls the value of the variable @code{tcl-mode-hook} with
no args, if that value is non-nil. Read the documentation for
@code{tcl-mode-hook} to see what kinds of interesting hook functions already
exist.
The following key mappings are defined:
@multitable {M-backspace } {backward-delete-char-untabify}
@item @code{#} @tab tcl-electric-hash
@item @code{;} @tab tcl-electric-char
@item @code{[} @tab tcl-electric-char
@item @code{]} @tab tcl-electric-char
@item @code{@{} @tab tcl-electric-char
@item @code{@}} @tab tcl-electric-brace
@item @code{delete} @tab backward-delete-char-untabify
@item @code{tab} @tab tcl-indent-command
@item @code{C-c} @tab << Prefix Command >>
@item @code{C-i} @tab tcl-indent-command
@item @code{M-;} @tab tcl-indent-for-comment
@item @code{M-backspace} @tab tcl-mark-defun
@item @code{M-C-a} @tab tcl-beginning-of-defun
@item @code{M-C-e} @tab tcl-end-of-defun
@item @code{M-C-h} @tab tcl-mark-defun
@item @code{M-C-q} @tab indent-tcl-exp
@item @code{M-C-x} @tab tcl-eval-defun
@item @code{C-c tab} @tab tcl-help-on-word
@item @code{C-c C-b} @tab tcl-submit-bug-report
@item @code{C-c C-c} @tab comment-region
@item @code{C-c C-f} @tab tcl-load-file
@item @code{C-c C-i} @tab tcl-help-on-word
@item @code{C-c C-s} @tab switch-to-tcl
@item @code{C-c C-t} @tab inferior-tcl
@item @code{C-c C-v} @tab tcl-eval-defun
@item @code{C-c C-x} @tab tcl-eval-region
@end multitable
To configure this package, type:
@example
M-x customize-group RET tcl RET
@end example
@menu
* About Tcl: about-tcl.
@end menu
@node about-tcl, , tcl, tcl
@section About Tcl
Tcl (Tool Command Language) is used by over half a million developers
worldwide and has become a critical component in thousands of
corporations. It has a simple and programmable syntax and can be either used
as a standalone application or embedded in application programs. Best of all,
Tcl is open source so it's completely free.
Tk is a graphical user interface toolkit that makes it possible to create
powerful GUIs incredibly quickly. It proved so popular that it now ships with
all distributions of Tcl.
For more information, see @uref{http://www.tcl.tk/software/tcltk/}.
@node teco, uil-mode, tcl, Top
@chapter Teco Interpreter
This package implements a Teco Interpreter.
To configure this package please view the source code. This can be done by
typing @kbd{C-x 4 l teco}.
@node uil-mode, verilog-mode, teco, Top
@chapter Editing Motif UIL Code
This mode is used to edit Motif UIL files. It is automatically invoked
for buffers visiting any file ending with an extension of @file{.uil}.
This mode is much like C mode except for the syntax of comments. It uses the
same keymap as C mode and has the same variables for customizing indentation.
It has its own abbrev table and its own syntax table. @xref{Top, CC Mode, ,
cc-mode, CC Mode Manual}., for details.
Turning on uilmode calls the value of the variable @code{uil-mode-hook} with
no args, if that value is non-nil.
To configure this package please view the source code. This can be done by
typing @kbd{C-x 4 l uil-mode}.
@menu
* About UIL: about-uil.
@end menu
@node about-uil, , uil-mode, uil-mode
@section About UIL
The Motif user interface language (UIL) is a specification language for
describing the initial state of a Motif application's user interface.
@node verilog-mode, vrml-mode, uil-mode, Top
@chapter Editing Verilog and SystemVerilog HDL Source
This mode is used to edit Verilog and SystemVerilog source files. It
is automatically invoked for buffers visiting any file ending with one
of the following extensions: @file{.vh?}, @file{.svh?}, @file{.dv}.
The mode provides the following features:
@itemize @bullet
@item NEWLINE, TAB indents for Verilog code.
@item Delete converts tabs to spaces as it moves back.
@item Supports highlighting.
@item Supports SystemVerilog OVM (Open Verification Methodology) macros.
@end itemize
This documentation is only a teaser and does not claim to be
complete. Please check out
@uref{http://www.veripool.org/wiki/verilog-mode/Documentation}
for further information, FAQ and change history.
The variables controlling indentation/edit style are:
@table @code
@item verilog-indent-level
Indentation of Verilog statements with respect to containing block.
@item verilog-indent-level-module
Absolute indentation of Module level Verilog statements.
Set to 0 to get initial and always statements lined up
on the left side of your screen.
@item verilog-indent-level-declaration
Indentation of declarations with respect to containing block.
Set to 0 to get them list right under containing block.
@item verilog-indent-level-behavioral
Indentation of first begin in a task or function block
Set to 0 to get such code to lined up underneath the task or function keyword
@item verilog-indent-level-directive
Indentation of `ifdef/`endif blocks
@item `verilog-cexp-indent
Indentation of Verilog statements broken across lines i.e.:
@example
if (a)
begin
@end example
@item verilog-case-indent
Indentation for case statements.
@item verilog-auto-newline
Non-nil means automatically newline after semicolons and the punctuation
mark after an end.
@item verilog-auto-indent-on-newline
Non-nil means automatically indent line after newline
@item verilog-tab-always-indent
Non-nil means TAB in Verilog mode should always reindent the current line,
regardless of where in the line point is when the TAB command is used.
@item verilog-indent-begin-after-if
Non-nil means to indent begin statements following a preceding
if, else, while, for and repeat statements, if any. otherwise,
the begin is lined up with the preceding token. If t, you get:
@example
if (a)
begin // amount of indent based on `verilog-cexp-indent'
@end example
otherwise you get:
@example
if (a)
begin
@end example
@item verilog-auto-endcomments
Non-nil means a comment /* ... */ is set after the ends which ends
cases, tasks, functions and modules.
The type and name of the object will be set between the braces.
@item verilog-minimum-comment-distance
Minimum distance (in lines) between begin and end required before a comment
will be inserted. Setting this variable to zero results in every
end acquiring a comment; the default avoids too many redundant
comments in tight quarters.
@item verilog-auto-lineup
List of contexts where auto lineup of :'s or ='s should be done.
@end table
Turning on Verilog mode calls the value of the variable
@code{verilog-mode-hook} with no args, if that value is non-nil.
Other useful functions are:
@table @code
@item verilog-complete-word
complete word with appropriate possibilities (functions, verilog keywords...)
@item verilog-comment-region
Put marked area in a comment, fixing nested comments.
@item verilog-uncomment-region
Uncomment an area commented with @code{verilog-comment-region}.
@item verilog-insert-block
insert begin ... end;
@item verilog-star-comment
insert /* ... */
@item verilog-mark-defun
Mark function.
@item verilog-beg-of-defun
Move to beginning of current function.
@item verilog-end-of-defun
Move to end of current function.
@item verilog-label-be
Label matching begin ... end, fork ... join and case ... endcase statements
@item verilog-sk-always
Insert a always @@(AS) begin .. end block
@item verilog-sk-begin
Insert a begin .. end block
@item verilog-sk-case
Insert a case block, prompting for details
@item verilog-sk-else
Insert an else begin .. end block
@item verilog-sk-for
Insert a for (...) begin .. end block, prompting for details
@item verilog-sk-generate
Insert a generate .. endgenerate block
@item verilog-sk-header
Insert a nice header block at the top of file
@item verilog-sk-initial
Insert an initial begin .. end block
@item verilog-sk-fork
Insert a fork begin .. end .. join block
@item verilog-sk-module
Insert a module .. (/*AUTOARG*/);.. endmodule block
@item verilog-sk-primitive
Insert a primitive .. (.. );.. endprimitive block
@item verilog-sk-repeat
Insert a repeat (..) begin .. end block
@item verilog-sk-specify
Insert a specify .. endspecify block
@item verilog-sk-task
Insert a task .. begin .. end endtask block
@item verilog-sk-while
Insert a while (...) begin .. end block, prompting for details
@item verilog-sk-casex
Insert a casex (...) item: begin.. end endcase block, prompting for details
@item verilog-sk-casez
Insert a casez (...) item: begin.. end endcase block, prompting for details
@item verilog-sk-if
Insert an if (..) begin .. end block
@item verilog-sk-else-if
Insert an else if (..) begin .. end block
@item verilog-sk-comment
Insert a comment block
@item verilog-sk-assign
Insert an assign .. = ..; statement
@item verilog-sk-function
Insert a function .. begin .. end endfunction block
@item verilog-sk-input
Insert an input declaration, prompting for details
@item verilog-sk-output
Insert an output declaration, prompting for details
@item verilog-sk-state-machine
Insert a state machine definition, prompting for details!
@item verilog-sk-inout
Insert an inout declaration, prompting for details
@item verilog-sk-wire
Insert a wire declaration, prompting for details
@item verilog-sk-reg
Insert a register declaration, prompting for details"
@end table
To configure this package, type:
@example
M-x customize-group RET verilog-mode RET
@end example
@menu
* About Verilog: about-verilog.
@end menu
@node about-verilog, , verilog-mode, verilog-mode
@section About Verilog
Verilog (IEEE 1364) and SystemVerilog (IEEE 1800) HDL are hardware
description languages used to design and document electronic
systems. In December 2007 IEEE 1364 has been merged into IEEE 1800,
paving the way for SystemVerilog as the official successor to Verilog.
SystemVerilog HDL allows designers to design at various levels of
abstraction.
For more information, see @uref{http://www.systemverilog.org/}.
@node vrml-mode, XEmacs License, verilog-mode, Top
@chapter Editing VRML (.wrl) Files
This mode is used for editing VRML files. It is automatically invoked for
buffers visiting any file ending with an extension of @file{.wrl}.
The mode has the following features:
@itemize @bullet
@item Expression and list commands understand all VRML brackets.
@item Tab indents for VRML code.
@item Paragraphs are separated by blank lines only.
@item Delete converts tabs to spaces as it moves back.
@end itemize
The variables controlling indentation style are:
@table @code
@item vrml-indent-level
Indentation of VRML statements within surrounding block.
@end table
The variables controlling user interaction with mode (see variable
documentation for details) are:
@table @code
@item vrml-tab-always-indent
Controls action of TAB key.
@item vrml-auto-newline
Non-nil means automatically newline before and after braces
inserted in VRML code.
@end table
Turning on VRML mode calls the value of the variable @code{vrml-mode-hook}
with no args, if that value is non-nil. Read the documentation for
@code{vrml-mode-hook} to see what kinds of interesting hook functions already
exist.
To configure this package, type:
@example
M-x customize-group RET vrml RET
@end example
@node XEmacs License, , vrml-mode, Top
@chapter XEmacs License
@unnumbered GNU GENERAL PUBLIC LICENSE
@center Version 2, June 1991
@display
Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc.
675 Mass Ave, Cambridge, MA 02139, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
@end display
@unnumberedsec Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software---to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
@iftex
@unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
@end iftex
@ifinfo
@center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
@end ifinfo
@enumerate 0
@item
This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The ``Program'', below,
refers to any such program or work, and a ``work based on the Program''
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term ``modification''.) Each licensee is addressed as ``you''.
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
@item
You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
@item
You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
@enumerate a
@item
You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
@item
You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
@item
If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
@end enumerate
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
@item
You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
@enumerate a
@item
Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
@item
Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
@item
Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
@end enumerate
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
@item
You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program 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.
@item
You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
@item
Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
@item
If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
@item
If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
@item
The Free Software Foundation may publish revised and/or new versions
of the General Public 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.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and ``any
later version'', you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
@item
If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
@iftex
@heading NO WARRANTY
@end iftex
@ifinfo
@center NO WARRANTY
@end ifinfo
@item
BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW@. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE@. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU@. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
@item
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
@end enumerate
@iftex
@heading END OF TERMS AND CONDITIONS
@end iftex
@ifinfo
@center END OF TERMS AND CONDITIONS
@end ifinfo
@page
@unnumberedsec How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the ``copyright'' line and a pointer to where the full notice is found.
@smallexample
@var{one line to give the program's name and an idea of what it does.}
Copyright (C) 19@var{yy} @var{name of author}
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
@end smallexample
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
@smallexample
Gnomovision version 69, Copyright (C) 19@var{yy} @var{name of author}
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
type `show w'. This is free software, and you are welcome
to redistribute it under certain conditions; type `show c'
for details.
@end smallexample
The hypothetical commands @samp{show w} and @samp{show c} should show
the appropriate parts of the General Public License. Of course, the
commands you use may be called something other than @samp{show w} and
@samp{show c}; they could even be mouse-clicks or menu items---whatever
suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a ``copyright disclaimer'' for the program, if
necessary. Here is a sample; alter the names:
@smallexample
@group
Yoyodyne, Inc., hereby disclaims all copyright
interest in the program `Gnomovision'
(which makes passes at compilers) written
by James Hacker.
@var{signature of Ty Coon}, 1 April 1989
Ty Coon, President of Vice
@end group
@end smallexample
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Library General
Public License instead of this License.
./xemacs-packages/man/viper/ 0000755 0000000 0000000 00000000000 11423477457 014663 5 ustar root root ./xemacs-packages/man/viper/viper.texi 0000644 0000000 0000000 00000545725 11241450460 016704 0 ustar root root % -*-texinfo-*-
\input texinfo
@comment Using viper.info instead of viper in setfilename breaks DOS.
@comment @setfilename viper
@comment @setfilename viper.info
@setfilename ../info/viper
@copying
Copyright @copyright{} 1995, 1996, 1997, 2001, 2002, 2003, 2004,
2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
and with the Back-Cover Texts as in (a) below. A copy of the license
is included in the section entitled ``GNU Free Documentation License''.
(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
modify this GNU manual. Buying copies from the FSF supports it in
developing GNU and promoting software freedom.''
@end quotation
@end copying
@dircategory Editors
@direntry
* VIPER: (viper). The newest Emacs VI-emulation mode.
(also, A VI Plan for Emacs Rescue
or the VI PERil.)
@end direntry
@finalout
@titlepage
@title Viper Is a Package for Emacs Rebels
@subtitle a Vi emulator for Emacs
@subtitle November 2008, Viper Version 3.11.2
@author Michael Kifer (Viper)
@author Aamod Sane (VIP 4.4)
@author Masahiko Sato (VIP 3.5)
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
@contents
@ifnottex
@node Top, Overview,, (DIR)
@unnumbered Viper
We believe that one or more of the following statements are adequate
descriptions of Viper:
@example
Viper Is a Package for Emacs Rebels;
it is a VI Plan for Emacs Rescue
and/or a venomous VI PERil.
@end example
Technically speaking, Viper is a Vi emulation package for Emacs. It
implements all Vi and Ex commands, occasionally improving on them and
adding many new features. It gives the user the best of both worlds: Vi
keystrokes for editing combined with the power of the Emacs environment.
Viper emulates Vi at several levels, from the one that closely follows Vi
conventions to the one that departs from many of them. It has many
customizable options, which can be used to tailor Viper to the work habits
of various users.
This manual describes Viper, concentrating on the differences from Vi and
new features of Viper.
Viper, formerly known as VIP-19, was written by Michael Kifer. It is based
on VIP version 3.5 by Masahiko Sato and VIP version 4.4 by Aamod Sane.
About 15% of the code still comes from those older packages.
Viper is intended to be usable without reading this manual --- the defaults
are set to make Viper as close to Vi as possible. At startup, Viper will
try to set the most appropriate default environment for you, based on
your familiarity with Emacs. It will also tell you the basic GNU Emacs window
management commands to help you start immediately.
Although this manual explains how to customize Viper, some basic
familiarity with Emacs Lisp is a plus.
It is recommended that you read the Overview node. The other nodes may
be visited as needed.
Comments and bug reports are welcome.
@code{kifer@@cs.stonybrook.edu} is the current address for Viper bug reports.
Please use the Ex command @kbd{:submitReport} for this purpose.@refill
@insertcopying
@end ifnottex
@menu
* Overview:: Read for a smoother start
* Improvements over Vi:: New features, Improvements
* Customization:: How to customize Viper
* Commands:: Vi and Ex Commands
* Key Index:: Index of Vi and Ex Commands
* Function Index:: Index of Viper Functions
* Variable Index:: Index of Viper Variables
* Package Index:: Index of Packages Mentioned in this Document
* Concept Index:: Vi, Ex and Emacs concepts
* Acknowledgments::
* GNU Free Documentation License:: The license for this documentation.
@end menu
@iftex
@unnumbered Introduction
We believe that one or more of the following statements are adequate
descriptions of Viper:
@example
Viper Is a Package for Emacs Rebels;
it is a VI Plan for Emacs Rescue
and/or a venomous VI PERil.
@end example
Viper is a Vi emulation package for Emacs. Viper contains virtually all
of Vi and Ex functionality and much more. It gives you the best of both
worlds: Vi keystrokes for editing combined with the GNU Emacs
environment. Viper also fixes some common complaints with Vi commands.
This manual describes Viper, concentrating on the differences from Vi
and on the new features of Viper.
Viper was written by Michael Kifer. It is based on VIP version 3.5 by
Masahiko Sato and VIP version 4.4 by Aamod Sane. About 15% of the code
still comes from those older packages.
Viper is intended to be usable out of the box, without reading this manual
--- the defaults are set to make Viper as close to Vi as possible. At
startup, Viper will attempt to set the most appropriate default environment
for you, based on your familiarity with Emacs. It will also tell you the
basic GNU Emacs window management commands to help you start immediately.
Although this manual explains how to customize Viper, some basic
familiarity with Emacs Lisp is a plus.
It is recommended that you read the chapter Overview. The other chapters
will be useful for customization and advanced usage.
You should also learn to use the Info on-line hypertext manual system that
comes with Emacs. This manual can be read as an Info file. Try the command
@kbd{@key{ESC} x info} with vanilla Emacs sometime.
Comments and bug reports are welcome.
@code{kifer@@cs.stonybrook.edu} is the current address for Viper bug reports.
Please use the Ex command @kbd{:submitReport} for this purpose.@refill
@end iftex
@node Overview,Improvements over Vi,Top,Top
@chapter Overview of Viper
Viper is a Vi emulation on top of Emacs. At the same time, Viper provides a
virtually unrestricted access to Emacs facilities. Perfect compatibility
with Vi is possible but not desirable. This chapter tells you about the
Emacs ideas that you should know about, how to use Viper within Emacs and
some incompatibilities.
This manual is written with the assumption that you are an experienced Vi
user who wants to switch to Emacs while retaining the ability to edit files
Vi style. Incredible as it might seem, there are experienced Emacs users
who use Viper as a backdoor into the superior (as every Vi user already knows)
world of Vi! These users are well familiar with Emacs bindings and prefer them
in some cases, especially in the Vi Insert state. John Hawkins
has provided a set of customizations, which
enables additional Emacs bindings under Viper. These customizations can be
included in your @file{~/.viper} file and are found at the following URL:
@file{http://traeki.freeshell.org/files/viper-sample}.
@menu
* Emacs Preliminaries:: Basic concepts in Emacs.
* Loading Viper:: Loading and Preliminary Configuration.
* States in Viper:: Viper has four states orthogonal to Emacs
modes.
* The Minibuffer:: Command line in Emacs.
* Multiple Files in Viper:: True multiple file handling.
* Unimplemented Features:: That are unlikely to be implemented.
@end menu
@node Emacs Preliminaries, Loading Viper, Overview, Overview
@section Emacs Preliminaries
@cindex buffer
@cindex point
@cindex mark
@cindex text
@cindex looking at
@cindex end (of buffer)
@cindex end (of line)
@cindex region
Emacs can edit several files at once. A file in Emacs is placed in a
@dfn{buffer} that usually has the same name as the file. Buffers are also used
for other purposes, such as shell interfaces, directory editing, etc.
@xref{Dired,,Directory Editor,emacs,The
GNU Emacs Manual}, for an example.@refill
A buffer has a distinguished position called the @dfn{point}.
A @dfn{point} is always between 2 characters, and is @dfn{looking at}
the right hand character. The cursor is positioned on the right hand
character. Thus, when the @dfn{point} is looking at the end-of-line,
the cursor is on the end-of-line character, i.e.@: beyond the last
character on the line. This is the default Emacs behavior.@refill
The default settings of Viper try to mimic the behavior of Vi, preventing
the cursor from going beyond the last character on the line. By using
Emacs commands directly (such as those bound to arrow keys), it is possible
to get the cursor beyond the end-of-line. However, this won't (or
shouldn't) happen if you restrict yourself to standard Vi keys, unless you
modify the default editing style. @xref{Customization}.@refill
In addition to the @dfn{point}, there is another distinguished buffer
position called the @dfn{mark}. @xref{Mark,,Mark,emacs,The GNU Emacs
manual}, for more info on the mark. The text between the @dfn{point} and
the @dfn{mark} is called the @dfn{region} of the buffer. For the Viper
user, this simply means that in addition to the Vi textmarkers a--z, there
is another marker called @dfn{mark}. This is similar to the unnamed Vi
marker used by the jump commands @kbd{``} and @kbd{''}, which move the
cursor to the position of the last absolute jump. Viper provides access to
the region in most text manipulation commands as @kbd{r} and @kbd{R} suffix
to commands that operate on text regions, e.g., @kbd{dr} to delete region,
etc.
Furthermore, Viper lets Ex-style commands to work on the current region.
This is done by typing a digit argument before @kbd{:}. For instance,
typing @kbd{1:} will prompt you with something like @emph{:123,135},
assuming that the current region starts at line 123 and ends at line
135. There is no need to type the line numbers, since Viper inserts them
automatically in front of the Ex command.
@xref{Basics}, for more info.@refill
@cindex window
@cindex mode line
@cindex buffer information
@cindex Minibuffer
@cindex command line
@cindex buffer (modified)
Emacs divides the screen into tiled @dfn{windows}. You can see the
contents of a buffer through the window associated with the buffer. The
cursor of the screen is positioned on the character after @dfn{point}.
Every window has a @dfn{mode line} that displays information about the buffer.
You can change the format of the mode
line, but normally if you see @samp{**} at the beginning of a mode line it
means that the buffer is @dfn{modified}. If you write out the contents of
a buffer to a file, then the buffer will become not modified. Also if
you see @samp{%%} at the beginning of the mode line, it means that the file
associated with the buffer is write protected. The mode line will also
show the buffer name and current major and minor modes (see below).
A special buffer called @dfn{Minibuffer} is displayed as the last line
in a minibuffer window. The minibuffer window is used for command input
output. Viper uses minibuffer window for @kbd{/} and @kbd{:}
commands.@refill
@cindex mode
@cindex keymap
@cindex local keymap
@cindex global keymap
@cindex major mode
@cindex minor mode
An Emacs buffer can have a @dfn{major mode} that customizes Emacs for
editing text of a particular sort by changing the functionality of the keys.
Keys are defined using a @dfn{keymap} that records the bindings between
keystrokes and
functions. The @dfn{global keymap} is common to all the
buffers. Additionally, each buffer has its @dfn{local keymap} that determines the
@dfn{mode} of the buffer. 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
will be executed. @xref{Major Modes,Major Modes,Major Modes,emacs,The
GNU Emacs Manual}, for more information.@refill
A buffer can also have a @dfn{minor mode}. Minor modes are options that
you can use or not. A buffer in @code{text-mode} can have
@code{auto-fill-mode} as minor mode, which can be turned off or on at
any time. In Emacs, a minor mode may have it own keymap,
which overrides the local keymap when the minor mode is turned on. For
more information, @pxref{Minor Modes,Minor Modes,Minor Modes,emacs,The
GNU Emacs Manual} @refill
@cindex Viper as minor mode
@cindex Control keys
@cindex Meta key
Viper is implemented as a collection of minor modes. Different minor modes
are involved when Viper emulates Vi command mode, Vi insert mode, etc.
You can also turn Viper on and off at any time while in Vi command mode.
@xref{States in Viper}, for
more information.@refill
Emacs uses Control and Meta modifiers. These are denoted as C and M,
e.g.@: @kbd{^Z} as @kbd{C-z} and @kbd{Meta-x} as @kbd{M-x}. The Meta key is
usually located on each side of the Space bar; it is used in a manner
similar to the Control key, e.g., @kbd{M-x} means typing @kbd{x} while
holding the Meta key down. For keyboards that do not have a Meta key,
@key{ESC} is used as Meta. Thus @kbd{M-x} is typed as @kbd{@key{ESC}
x}. Viper uses @key{ESC} to switch from Insert state to Vi state. Therefore
Viper defines @kbd{C-\} as its Meta key in Vi state. @xref{Vi State}, for
more info.@refill
Emacs is structured as a Lisp interpreter around a C core. Emacs keys
cause Lisp functions to be called. It is possible to call these
functions directly, by typing @kbd{M-x function-name}.
@node Loading Viper, States in Viper, Emacs Preliminaries, Overview
@section Loading Viper
The most common way to load it automatically is to include the following
lines (in the given order!):
@lisp
(setq viper-mode t)
(require 'viper)
@end lisp
@noindent
in your @file{~/.emacs} file. The @file{.emacs} file is placed in your
home directory and it is be executed every time you invoke Emacs. This is
the place where all general Emacs customization takes place. Beginning with
version 20.0, Emacsen have an interactive interface, which simplifies the
job of customization significantly.
Viper also uses the file @file{~/.viper} for Viper-specific customization.
The location of Viper customization file can be changed by setting the
variable @code{viper-custom-file-name} in @file{.emacs} @emph{prior} to loading
Viper.
The latest versions of Emacs have an interactive customization facility,
which allows you to (mostly) bypass the use of the @file{.emacs} and
@file{.viper} files. You can reach this customization
facility from within Viper's VI state by executing the Ex command
@kbd{:customize}.
Once invoked, Viper will arrange to bring up Emacs buffers in Vi state
whenever this makes sense.
@xref{Packages that Change Keymaps}, to find out when forcing Vi command state
on a buffer may be counter-productive.
Even if your @file{.emacs} file does not invoke Viper automatically,
you can still load Viper and enter the Vi command state by typing the
following from within Emacs:
@lisp
M-x viper-mode
@end lisp
When Emacs first comes up, if you have not specified a file on the
command line, it will show the @samp{*scratch*} buffer, in the
@samp{Lisp Interaction} mode. After you invoke Viper, you can start
editing files by using @kbd{:e}, @kbd{:vi}, or @kbd{v} commands.
(@xref{File and Buffer Handling}, for more information on @kbd{v} and other
new commands that, in many cases, are more convenient than @kbd{:e},
@kbd{:vi}, and similar old-style Vi commands.)@refill
Finally, if at some point you would want to de-Viperize your running
copy of Emacs after Viper has been loaded, the command @kbd{M-x
viper-go-away} will do it for you. The function @code{toggle-viper-mode}
toggles Viperization of Emacs on and off.
@node States in Viper, The Minibuffer, Loading Viper,Overview
@section States in Viper
@kindex @kbd{C-z}
@kindex @key{ESC}
@kindex @kbd{i}
@cindex Emacs state
@cindex Vi state
@cindex Insert state
@cindex Replace state
@cindex Ex commands
@findex @code{viper-go-away}
@findex @code{toggle-viper-mode}
Viper has four states, Emacs, Vi, Insert, and Replace.
@table @samp
@item Emacs state
This is the state plain vanilla Emacs is normally in. After you have loaded
Viper, @kbd{C-z} will normally take you to Vi command state. Another
@kbd{C-z} will take you back to Emacs state. This toggle key can be
changed, @pxref{Customization} You can also type @kbd{M-x viper-mode} to
change to Vi state.@refill
For users who chose to set their user level to 1 at Viper setup time,
switching to Emacs state is deliberately made harder in order to not
confuse the novice user. In this case, @kbd{C-z} will either iconify Emacs
(if Emacs runs as an application under X) or it will stop Emacs (if
Emacs runs on a dumb terminal or in an Xterm window).
@item Vi state
This is the Vi command mode. Any of the Vi commands, such as @kbd{i, o, a},
@dots{}, will take you to Insert state. All Vi commands may
be used in this mode. Most Ex commands can also be used.
For a full list of Ex commands supported by Viper, type
@kbd{:} and then @key{TAB}. To get help on any issue, including the Ex
commands, type @kbd{:help}. This will invoke Viper Info
(if it is installed). Then typing @kbd{i} will prompt you for a topic to
search in the index. Note: to search for Ex commands in the index, you
should start them with a @kbd{:}, e.g., @kbd{:WW}.
In Viper, Ex commands can be made to work on the current Emacs region.
This is done by typing a digit argument before @kbd{:}.
For instance, typing @kbd{1:} will prompt you with something like
@emph{:123,135}, assuming that the current region starts at line 123 and
ends at line 135. There is no need to type the line numbers, since Viper
inserts them automatically in front of the Ex command.
@item Insert state
Insert state is the Vi insertion mode. @key{ESC} will take you back to
Vi state. Insert state editing can be done, including auto-indentation. By
default, Viper disables Emacs key bindings in Insert state.
@item Replace state
Commands like @kbd{cw} invoke the Replace state. When you cross the
boundary of a replacement region (usually designated via a @samp{$} sign),
it will automatically change to Insert state. You do not have to worry
about it. The key bindings remain practically the same as in Insert
state. If you type @key{ESC}, Viper will switch to Vi command mode, terminating the
replacement state.@refill
@end table
@cindex mode line
The modes are indicated on the @dfn{mode line} as , , , and ,
so that the multiple modes do not confuse you. Most of your editing can be
done in Vi and Insert states. Viper will try to make all new buffers be in Vi
state, but sometimes they may come up in Emacs state. @kbd{C-z}
will take you to Vi state in such a case. In some major modes, like Dired,
Info, Gnus, etc., you should not switch to Vi state (and Viper will not
attempt to do so) because these modes are not intended for text editing and
many of the Vi keys have special meaning there. If you plan to read news,
browse directories, read mail, etc., from Emacs (which you should start
doing soon!), you should learn about the meaning of the various keys in
those special modes (typing @kbd{C-h m} in a buffer provides
help with key bindings for the major mode of that buffer).
If you switch to Vi in Dired or similar modes---no harm is done. It is just
that the special key bindings provided by those modes will be temporarily
overshadowed by Viper's bindings. Switching back to Viper's Emacs state
will revive the environment provided by the current major mode.
States in Viper are orthogonal to Emacs major modes, such as C mode or Dired
mode. You can turn Viper on and off for any Emacs state. When Viper is turned
on, Vi state can be used to move around. In Insert state, the bindings for
these modes can be accessed. For beginners (users at Viper levels 1 and 2),
these bindings are suppressed in Insert state, so that new users are not
confused by the Emacs states. Note that unless you allow Emacs bindings in
Insert state, you cannot do many interesting things, like language
sensitive editing. For the novice user (at Viper level 1), all major mode
bindings are turned off in Vi state as well. This includes the bindings for
key sequences that start with @kbd{C-c}, which practically means that all
major mode bindings are unsupported. @xref{Customization}, to find out how
to allow Emacs keys in Insert state.
@menu
* Emacs State:: This is the state you should learn more about when
you get up to speed with Viper.
* Vi State:: Vi commands are executed in this state.
* Insert State:: You can enter text, and also can do sophisticated
editing if you know enough Emacs commands.
* Replace State:: Like Insert mode, but it is invoked via the
replacement commands, such as cw, C, R, etc.
@end menu
@node Emacs State, Vi State, States in Viper, States in Viper
@subsection Emacs State
@kindex @kbd{C-z}
@cindex Emacs state
You will be in this mode only by accident (hopefully). This is the state
Emacs is normally in (imagine!!). Now leave it as soon as possible by
typing @kbd{C-z}. Then you will be in Vi state (sigh of relief) :-).
Emacs state is actually a Viperism to denote all the major and minor modes
(@pxref{Emacs Preliminaries}) other than Viper that Emacs can be in. Emacs
can have several modes, such as C mode for editing C programs, LaTeX mode
for editing LaTeX documents, Dired for directory editing, etc. These are
major modes, each with a different set of key-bindings. Viper states are
orthogonal to these Emacs major modes. The presence of these language
sensitive and other modes is a major win over Vi. @xref{Improvements over
Vi}, for more.@refill
The bindings for these modes can be made available in the Viper Insert state
as well as in Emacs state. Unless you specify your user level as 1 (a
novice), all major mode key sequences that start with @kbd{C-x} and
@kbd{C-c} are also available in Vi state. This is important because major
modes designed for editing files, such as cc-mode or latex-mode, use key
sequences that begin with @kbd{C-x} and @kbd{C-c}.
There is also a key that lets you temporarily escape to Vi command state
from the Insert state: typing @kbd{C-z} will let you execute a
single Vi command while staying in Viper's Insert state.
@node Vi State, Insert State, Emacs State, States in Viper
@subsection Vi State
@cindex Vi state
This is the Vi command mode. When Viper is in Vi state, you will see the sign
in the mode line. Most keys will work as in Vi. The notable
exceptions are:
@table @kbd
@item C-x
@kindex @kbd{C-x}
@kbd{C-x} is used to invoke Emacs commands, mainly those that do window
management. @kbd{C-x 2} will split a window, @kbd{C-x 0} will close a
window. @kbd{C-x 1} will close all other windows. @kbd{C-xb} is used to
switch buffers in a window, and @kbd{C-xo} to move through windows.
These are about the only necessary keystrokes.
For the rest, see the GNU Emacs Manual.
@item C-c
@kindex @kbd{C-c}
For user levels 2 and higher, this key serves as a prefix key for the key
sequences used by various major modes. For users at Viper level 1, @kbd{C-c}
simply beeps.
@item C-g and C-]
@kindex @kbd{C-g}
@kindex @kbd{C-]}
These are the Emacs @samp{quit} keys.
There will be cases where you will have to
use @kbd{C-g} to quit. Similarly, @kbd{C-]} is used to exit
@samp{Recursive Edits} in Emacs for which there is no comparable Vi
functionality and no key-binding. Recursive edits are indicated by
@samp{[]} brackets framing the modes on the mode line.
@xref{Recursive Edit,Recursive
Edit,Recursive Edit,emacs,The GNU Emacs Manual}.
At user level 1, @kbd{C-g} is bound to @code{viper-info-on-file}
function instead.
@refill
@item C-\
@kindex @kbd{C-\}
@cindex Meta key
Viper uses @key{ESC} as a switch between Insert and Vi states. Emacs uses
@key{ESC} for Meta. The Meta key is very important in Emacs since many
functions are accessible only via that key as @kbd{M-x function-name}.
Therefore, we need to simulate it somehow. In Viper's Vi, Insert, and
Replace states, the meta key is set to be @kbd{C-\}. Thus, to get
@kbd{M-x}, you should type @kbd{C-\ x} (if the keyboard has no Meta key,
which is rare these days).
This works both in the Vi command state and in the Insert and Replace
states. In Vi command state, you can also use @kbd{\ @key{ESC}} as the
meta key.
Note: Emacs binds @kbd{C-\} to a function that offers to change the
keyboard input method in the multilingual environment. Viper overrides this
binding. However, it is still possible to switch the input method by typing
@kbd{\ C-\} in the Vi command state and @kbd{C-z \ C-\} in the Insert state.
Or you can use the MULE menu in the menubar.
@end table
@noindent
Other differences are mostly improvements. The ones you should know
about are:
@table @samp
@item Undo
@kindex @kbd{u}
@kbd{u} will undo. Undo can be repeated by the @kbd{.} key. Undo itself
can be undone. Another @kbd{u} will change the direction. The presence
of repeatable undo means that @kbd{U}, undoing lines, is not very
important. Therefore, @kbd{U} also calls @code{viper-undo}.
@cindex multiple undo
@cindex undo
@item Counts
Most commands, @kbd{~}, @kbd{[[}, @kbd{p}, @kbd{/}, @dots{}, etc., take counts.
@comment ]] Just to balance parens
@item Regexps
Viper uses Emacs Regular Expressions for searches. These are a superset of
Vi regular
expressions, excepting the change-of-case escapes @samp{\u}, @samp{\L},
@dots{}, etc. @xref{Regexps,,Syntax of Regular Expressions,emacs,The
GNU Emacs Manual}, for details.
Files specified to @kbd{:e} use @code{csh} regular expressions
(globbing, wildcards, what have you).
However, the function @code{viper-toggle-search-style}, bound to @kbd{C-c /},
lets the user switch from search with regular expressions to plain vanilla
search and vice versa. It also lets one switch from case-sensitive search
to case-insensitive and back.
@xref{Viper Specials}, for more details.
@cindex regular expressions
@cindex vanilla search
@cindex case-sensitive search
@cindex case-insensitive search
@kindex @kbd{C-c /}
@item Ex commands
@cindex Ex commands
The current working directory of a buffer is automatically inserted in the
minibuffer if you type @kbd{:e} then space. Absolute filenames are
required less often in Viper. For file names, Emacs uses a convention that
is slightly different from other programs. It is designed to minimize the
need for deleting file names that Emacs provides in its prompts. (This is
usually convenient, but occasionally the prompt may suggest a wrong file
name for you.) If you see a prompt @kbd{/usr/foo/} and you wish to edit the
file @kbd{~/.viper}, you don't have to erase the prompt. Instead, simply
continue typing what you need. Emacs will interpret @kbd{/usr/foo/~/.viper}
correctly. Similarly, if the prompt is @kbd{~/foo/} and you need to get to
@kbd{/bar/file}, keep typing. Emacs interprets @kbd{~/foo//bar/} as
@kbd{/bar/file}, since when it sees @samp{//}, it understands that
@kbd{~/foo/} is to be discarded.
The command @kbd{:cd} will change the default directory for the
current buffer. The command @kbd{:e} will interpret the
filename argument in @code{csh}. @xref{Customization}, if you
want to change the default shell.
The command @kbd{:next} takes counts from
@kbd{:args}, so that @kbd{:rew} is obsolete. Also, @kbd{:args} will show only
the invisible files (i.e., those that are not currently seen in Emacs
windows).
When applicable, Ex commands support file completion and history. This
means that by typing a partial file name and then @key{TAB}, Emacs will try
to complete the name or it will offer a menu of possible completions.
This works similarly to Tcsh and extends the behavior of Csh. While Emacs
is waiting for a file name, you can type @kbd{M-p} to get the previous file
name you typed. Repeatedly typing @kbd{M-p} and @kbd{M-n} will let you
browse through the file history.
Like file names, partially typed Ex commands can be completed by typing
@key{TAB}, and Viper keeps the history of Ex commands. After typing
@kbd{:}, you can browse through the previously entered Ex commands by
typing @kbd{M-p} and @kbd{M-n}. Viper tries to rationalize when it puts Ex
commands on the history list. For instance, if you typed @kbd{:w!@: foo},
only @kbd{:w!} will be placed on the history list. This is because the
last history element is the default that can be invoked simply by typing
@kbd{: @key{RET}}. If @kbd{:w!@: foo} were placed on the list, it would be all to
easy to override valuable data in another file. Reconstructing the full
command, @kbd{:w!@: foo}, from the history is still not that hard, since Viper
has a separate history for file names. By typing @kbd{: M-p}, you will get
@kbd{:w!} in the minibuffer. Then, repeated @kbd{M-p} will get you through
the file history, inserting one file name after another.
In contrast to @kbd{:w!@: foo}, if the command were @kbd{:r foo}, the entire
command will appear in the history list. This is because having @kbd{:r}
alone as a default is meaningless, since this command requires a file
argument.
@refill
@end table
@noindent
As in Vi, Viper's destructive commands can be re-executed by typing `@kbd{.}'.
However, in addition, Viper keeps track of the history of such commands. This
history can be perused by typing @kbd{C-c M-p} and @kbd{C-c M-n}.
Having found the appropriate command, it can be then executed by typing
`@kbd{.}'.
@xref{Improvements over Vi}, for more information.
@node Insert State, Replace State, Vi State, States in Viper
@subsection Insert State
@cindex Insert state
To avoid confusing the beginner (at Viper level 1 and 2), Viper makes only the
standard Vi keys available in Insert state. The implication is that
Emacs major modes cannot be used in Insert state.
It is strongly recommended that as soon as you are comfortable, make the
Emacs state bindings visible (by changing your user level to 3 or higher).
@xref{Customization},
to see how to do this.@refill
Once this is done, it is possible to do quite a bit of editing in
Insert state. For instance, Emacs has a @dfn{yank} command, @kbd{C-y},
which is similar to Vi's @kbd{p}. However, unlike @kbd{p}, @kbd{C-y} can be
used in Insert state of Viper. Emacs also has a kill ring where it keeps
pieces of text you deleted while editing buffers. The command @kbd{M-y} is
used to delete the text previously put back by Emacs' @kbd{C-y} or by Vi's
@kbd{p} command and reinsert text that was placed on the kill-ring earlier.
This works both in Vi and Insert states.
In Vi state, @kbd{M-y} is a much better alternative to the usual Vi's way
of recovering the 10 previously deleted chunks of text. In Insert state,
you can
use this as follows. Suppose you deleted a piece of text and now you need
to re-insert it while editing in Insert mode. The key @kbd{C-y} will put
back the most recently deleted chunk. If this is not what you want, type
@kbd{M-y} repeatedly and, hopefully, you will find the chunk you want.
Finally, in Insert and Replace states, Viper provides the history of
pieces of text inserted in previous insert or replace commands. These
strings of text can be recovered by repeatedly typing @kbd{C-c M-p} or
@kbd{C-c M-n} while in Insert or Replace state. (This feature is disabled
in the minibuffer: the above keys are usually bound to other histories,
which are more appropriate in the minibuffer.)
@cindex Meta key
You can call Meta functions from Insert state. As in Vi state, the Meta key
is @kbd{C-\}. Thus @kbd{M-x} is typed as @kbd{C-\ x}.
Other Emacs commands that are useful in Insert state are @kbd{C-e}
and @kbd{C-a}, which move the cursor to the end and the beginning of the
current line, respectively. You can also use @kbd{M-f} and @kbd{M-b},
which move the cursor forward (or backward) one word.
If your display has a Meta key, these functions are invoked by holding the
Meta key and then typing @kbd{f} and @kbd{b}, respectively. On displays
without the Meta key, these functions are invoked by typing
@kbd{C-\ f} and @kbd{C-\ b} (@kbd{C-\} simulates the Meta key in Insert
state, as explained above).
The key @kbd{C-z} is sometimes also useful in Insert state: it allows you
to execute a single command in Vi state without leaving the Insert state!
For instance, @kbd{C-z d2w} will delete the next two words without leaving
the Insert state.
When Viper is in Insert state, you will see in the mode line.
@node Replace State,, Insert State, States in Viper
@subsection Replace State
@cindex Replace state
This state is entered through Vi replacement commands, such as @kbd{C},
@kbd{cw}, etc., or by typing @kbd{R}. In Replace state, Viper puts in
the mode line to let you know which state is in effect. If Replace state is
entered through @kbd{R}, Viper stays in that state until the user hits
@key{ESC}. If this state is entered via the other replacement commands,
then Replace state is in effect until you hit @key{ESC} or until you cross
the rightmost boundary of the replacement region. In the latter case, Viper
changes its state from Replace to Insert (which you will notice by the
change in the mode line).
Since Viper runs under Emacs, it is possible to switch between buffers
while in Replace state. You can also move the cursor using the arrow keys
(even on dumb terminals!)@: and the mouse. Because of this freedom (which is
unattainable in regular Vi), it is possible to take the cursor outside the
replacement region. (This may be necessary for several reasons, including
the need to enable text selection and region-setting with the mouse.)
The issue then arises as to what to do when the user
hits the @key{ESC} key. In Vi, this would cause the text between cursor and
the end of the replacement region to be deleted. But what if, as is
possible in Viper, the cursor is not inside the replacement region?
To solve the problem, Viper keeps track of the last cursor position while it
was still inside the replacement region. So, in the above situation, Viper
would delete text between this position and the end of the replacement
region.
@node The Minibuffer,Multiple Files in Viper, States in Viper, Overview
@section The Minibuffer
@cindex Minibuffer
The minibuffer is where commands are entered in. Editing can be done
by commands from Insert state, namely:
@table @kbd
@item C-h
Backspace
@item C-w
Delete Word
@item C-u
Erase line
@item C-v
Quote the following character
@item @key{RET}
Execute command
@item C-g and C-]
Emacs quit and abort keys. These may be necessary. @xref{Vi State}, for an
explanation.
@item M-p and M-n
These keys are bound to functions that peruse minibuffer history. The
precise history to be perused depends on the context. It may be the history
of search strings, Ex commands, file names, etc.
@item C-s
If the minibuffer is entered via the Viper search commands @kbd{/} or
@kbd{?}, then this key inserts the last search string used by the
Emacs incremental search command
(which is bound to @kbd{C-s} everywhere except in this case).
@end table
Most of the Emacs keys are functional in the minibuffer. While in the
minibuffer, Viper tries to make editing resemble Vi's behavior when the
latter is waiting for the user to type an Ex command. In particular, you
can use the regular Vi commands to edit the minibuffer. You can switch
between the Vi state and Insert state at will, and even use the replace mode.
Initially, the minibuffer comes up in Insert state.
Some users prefer plain Emacs bindings in the minibuffer. To this end, set
@code{viper-vi-style-in-minibuffer} to @code{nil} in @file{.viper}.
@xref{Customization}, to learn how to do this.
When the minibuffer changes Viper states, you will notice that the appearance
of the text there changes as well. This is useful because the minibuffer
has no mode line to tell which Vi state it is in.
The appearance of the text in the minibuffer can be changed.
@xref{Viper Specials}, for more details.
@node Multiple Files in Viper,Unimplemented Features,The Minibuffer,Overview
@section Multiple Files in Viper
@cindex multiple files
@cindex managing multiple files
Viper can edit multiple files. This means, for example that you never need
to suffer through @code{No write since last change} errors.
Some Viper elements are common over all the files.
@table @samp
@item Textmarkers
@cindex markers
@cindex textmarkers
Textmarkers remember @emph{files and positions}.
If you set marker @samp{a} in
file @file{foo}, start editing file @file{bar} and type @kbd{'a}, then
@emph{YOU WILL SWITCH TO FILE @file{foo}}. You can see the contents of a
textmarker using the Viper command @kbd{[} where are the
textmarkers, e.g., @kbd{[a} to view marker @samp{a} .@refill
@item Repeated Commands
Command repetitions are common over files. Typing @kbd{!!} will repeat the
last @kbd{!} command whichever file it was issued from.
Typing @kbd{.} will repeat the last command from any file, and
searches will repeat the last search. Ex commands can be repeated by typing
@kbd{: @key{RET}}.@refill
Note: in some rare cases, that @kbd{: @key{RET}} may do something dangerous.
However, usually its effect can be undone by typing @kbd{u}.
@item Registers
@cindex registers
Registers are common to files. Also, text yanked with @kbd{y} can be
put back (@kbd{p}) into any file. The Viper command @kbd{]}, where are
the registers, can be used to look at the contents of a register, e.g.,
type @kbd{]a} to view register @samp{a}.
There is one difference in text deletion that you should be
aware of. This difference comes from Emacs and was adopted in Viper
because we find it very useful. In Vi, if you delete a line, say, and then
another line, these two deletions are separated and are put back
separately if you use the @samp{p} command. In Emacs (and Viper), successive
series of deletions that are @emph{not interrupted} by other commands are
lumped together, so the deleted text gets accumulated and can be put back
as one chunk. If you want to break a sequence of deletions so that the
newly deleted text could be put back separately from the previously deleted
text, you should perform a non-deleting action, e.g., move the cursor one
character in any direction.
@item Absolute Filenames
@cindex absolute file names
The current directory name for a file is automatically prepended to the
file name in any
@kbd{:e}, @kbd{:r}, @kbd{:w}, etc., command (in Emacs, each buffer has a
current directory).
This directory is inserted in the minibuffer once you type space after
@kbd{:e, r}, etc. Viper also supports completion of file names and Ex
commands (@key{TAB}), and it keeps track of
command and file history (@kbd{M-p}, @kbd{M-n}).
Absolute filenames are required less
often in Viper.
You should be aware that Emacs interprets @kbd{/foo/bar//bla} as
@kbd{/bla} and @kbd{/foo/~/bar} as @kbd{~/bar}. This is designed to
minimize the need for erasing file names that Emacs suggests in its
prompts, if a suggested file name is not what you wanted.
The command @kbd{:cd} will change the default directory for the
current Emacs buffer. The Ex command @kbd{:e} will interpret the
filename argument in @samp{csh}, by default. @xref{Customization}, if you
want to change this.
@end table
@noindent
Currently undisplayed files can be listed using the @kbd{:ar} command. The
command @kbd{:n} can be given counts from the @kbd{:ar} list to switch to
other files. For example, use `:n3' to move to the third file in that list.
@node Unimplemented Features,,Multiple Files in Viper,Overview
@section Unimplemented Features
Unimplemented features include:
@itemize @bullet
@item
@kbd{:ab} and @kbd{:una} are not implemented, since
@kbd{:ab} is considered obsolete, since Emacs has much
more powerful facilities for defining abbreviations.
@item
@kbd{:set option?} is not implemented. The current
@kbd{:set} can also be used to set Emacs variables.
@item
@kbd{:se list} requires modification of the display code for Emacs, so
it is not implemented.
A useful alternative is @code{cat -t -e file}. Unfortunately, it cannot
be used directly inside Emacs, since Emacs will obdurately change @samp{^I}
back to normal tabs.@refill
@end itemize
@comment node-name, next, previous, up
@node Improvements over Vi, Customization, Overview, Top
@chapter Improvements over Vi
Some common problems with Vi and Ex have been solved in Viper. This
includes better implementation of existing commands, new commands, and
the facilities provided by Emacs.
@menu
* Basics:: Basic Viper differences, Multi-file effects.
* Undo and Backups:: Multiple undo, auto-save, backups and changes
* History:: History for Ex and Vi commands.
* Macros and Registers:: Keyboard Macros (extended ".")@: @@reg execution.
* Completion:: Filename and Command Completion for Ex.
* Improved Search:: Incremental Search and Buffer Content Search.
* Abbreviation Facilities:: Normal Abbrevs, Templates, and Dynamic Abbrevs.
* Movement and Markers:: Screen Editor movements, viewing textmarkers.
* New Commands:: Commands that do not exist in Vi.
* Useful Packages:: A Sampling of some Emacs packages, and things
you should know about.
@end menu
@node Basics, Undo and Backups, Improvements over Vi, Improvements over Vi
@section Basics
The Vi command set is based on the idea of combining motion commands
with other commands. The motion command is used as a text region
specifier for other commands.
We classify motion commands into @dfn{point commands} and
@dfn{line commands}.@refill
@cindex point commands
The point commands are:
@quotation
@kbd{h}, @kbd{l}, @kbd{0}, @kbd{$}, @kbd{w}, @kbd{W}, @kbd{b}, @kbd{B},
@kbd{e}, @kbd{E}, @kbd{(}, @kbd{)}, @kbd{/}, @kbd{?}, @kbd{`}, @kbd{f},
@kbd{F}, @kbd{t}, @kbd{T}, @kbd{%}, @kbd{;}, @kbd{,}, @kbd{^}
@end quotation
@cindex line commands
The line commands are:
@quotation
@kbd{j}, @kbd{k}, @kbd{+}, @kbd{-}, @kbd{H}, @kbd{M}, @kbd{L}, @kbd{@{},
@kbd{@}}, @kbd{G}, @kbd{'}, @kbd{[[}, @kbd{]]}, @kbd{[]}
@end quotation
@cindex region
@cindex region specification
@cindex expanding (region)
@cindex describing regions
@cindex movement commands
@noindent
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 @dfn{expanding
the region}), and then the enlarged region will be affected by the modifying
command.
Text Deletion Commands (@pxref{Deleting Text}), Change commands
(@pxref{Changing Text}), even Shell Commands (@pxref{Shell Commands})
use these commands to describe a region of text to operate on.
Thus, type @kbd{dw} to delete a word, @kbd{>@}} to shift a paragraph, or
@kbd{!'afmt} to format a region from @samp{point} to textmarker
@samp{a}.
@cindex r and R region specifiers
Viper adds the region specifiers @samp{r} and @samp{R}. Emacs has a
special marker called @dfn{mark}. The text-area between the current cursor
position @dfn{point} and the @dfn{mark} is called the @dfn{region}.
@samp{r} specifies the raw region and @samp{R} is the expanded region
(i.e., the minimal contiguous chunk of full lines that contains the raw
region).
@kbd{dr} will now delete the region, @kbd{>r} will shift it, etc.
@kbd{r,R} are not motion commands, however. The special mark is set by
@kbd{m.} and other commands. @xref{Marking}, for more info.
Viper also adds counts to most commands for which it would make sense.
In the Overview chapter, some Multiple File issues were discussed
(@pxref{Multiple Files in Viper}). In addition to the files, Emacs has
buffers. These can be seen in the @kbd{:args} list and switched using
@kbd{:next} if you type @kbd{:set ex-cycle-through-non-files t}, or
specify @code{(setq ex-cycle-through-non-files t)} in your @file{.viper}
file. @xref{Customization}, for details.
@node Undo and Backups, History, Basics, Improvements over Vi
@section Undo and Backups
@cindex undo
Viper provides multiple undo. The number of undo's and the size is limited
by the machine. The Viper command @kbd{u} does an undo. Undo can be
repeated by typing @kbd{.} (a period). Another @kbd{u} will undo the undo,
and further
@kbd{.} will repeat it. Typing @kbd{u} does the first undo, and changes the
direction.
@cindex backup files
@cindex auto save
Since the undo size is limited, Viper can create backup files and
auto-save files. It will normally do this automatically. It is possible
to have numbered backups, etc. For details, @pxref{Backup,,Backup and
Auto-Save,emacs,The GNU Emacs Manual} @refill
@comment [ balance parens
@cindex viewing registers and markers
@cindex registers
@cindex markers
@cindex textmarkers
The results of the 9 previous changes are available in the 9 numeric
registers, as in Vi. The extra goody is the ability to @emph{view} these
registers, in addition to being able to access them through @kbd{p} and
@kbd{M-y} (@xref{Insert State}, for details.)
The Viper command @kbd{] register} will display the contents of any
register, numeric or alphabetical. The related command @kbd{[ textmarker}
will show the text around the textmarker. @samp{register} and @samp{textmarker}
can be any letters from a through z.
@comment ] balance parens
@node History, Macros and Registers, Undo and Backups,Improvements over Vi
@section History
@cindex history
@cindex Minibuffer
History is provided for Ex commands, Vi searches, file names, pieces of
text inserted in earlier commands that use Insert or Replace state, and for
destructive commands in Vi state. These are
useful for fixing those small typos that screw up searches and @kbd{:s},
and for eliminating routine associated with repeated typing of file names
or pieces of text that need to be inserted frequently.
At the @kbd{:} or @kbd{/} prompts in the minibuffer, you can do the following:
@table @kbd
@item M-p and M-n
To move to previous and next history items. This causes the history
items to appear on the command line, where you can edit them, or
simply type Return to execute.
@item M-r and M-s
To search backward and forward through the history.
@item @key{RET}
Type @key{RET} to accept a default (which is displayed in the prompt).
@end table
The history of insertions can be perused by
typing @kbd{C-c M-p} and @kbd{C-c M-n} while in Insert or Replace state.
The history of destructive Vi commands can be perused via the same keys
when Viper is in Vi state. @xref{Viper Specials}, for details.
All Ex commands have a file history. For instance, typing @kbd{:e}, space
and then @kbd{M-p} will bring up the name of the previously typed file
name. Repeatedly typing @kbd{M-p}, @kbd{M-n}, etc., will let you browse
through the file history.
Similarly, commands that have to do with switching buffers
have a buffer history, and commands that expect strings or regular
expressions keep a history on those items.
@node Macros and Registers,Completion,History,Improvements over Vi
@section Macros and Registers
@cindex keyboard macros
@cindex macros
@cindex registers
@cindex register execution
Viper facilitates the use of Emacs-style keyboard macros. @kbd{@@#} will
start a macro definition. As you type, the commands will be executed, and
remembered (This is called ``learn mode'' in some editors.)
@kbd{@@register} will complete the macro, putting it into @samp{register},
where @samp{register} is any character from @samp{a} through @samp{z}. Then
you can execute this macro using @kbd{@@register}. It is, of course,
possible to yank some text into a register and execute it using
@kbd{@@register}. Typing @kbd{@@@@}, @kbd{@@RET}, or @kbd{@@C-j} will
execute the last macro that was executed using @kbd{@@register}.@refill
Viper will automatically lowercase the register, so that pressing the
@kbd{SHIFT} key for @kbd{@@} will not create problems. This is for
@kbd{@@} macros and @kbd{"p} @emph{only}. In the case of @kbd{y},
@kbd{"Ayy} will append to @emph{register a}. For @kbd{[,],',`}, it
is an error to use a Uppercase register name.
@comment [ balance parens
@cindex viewing registers and markers
The contents of a register can be seen by @kbd{]register}. (@kbd{[textmarker}
will show the contents of a textmarker).
@comment ] balance parens
@cindex last keyboard macro
The last keyboard macro can also be executed using
@kbd{*}, and it can be yanked into a register using @kbd{@@!register}.
This is useful for Emacs style keyboard macros defined using @kbd{C-x(}
and @kbd{C-x)}. Emacs keyboard macros have more capabilities.
@xref{Keyboard Macros,,Keyboard Macros,emacs, The GNU Emacs Manual}, for
details.@refill
Keyboard Macros allow an interesting form of Query-Replace:
@kbd{/pattern} or @kbd{n} to go to the next pattern (the query), followed by a
Keyboard Macro execution @kbd{@@@@} (the replace).
Viper also provides Vi-style macros. @xref{Vi Macros}, for details.
@node Completion, Improved Search, Macros and Registers, Improvements over Vi
@section Completion
@cindex completion
Completion is done when you type @key{TAB}. The Emacs completer does not
grok wildcards in file names. Once you type a wildcard, the completer will
no longer work for that file name. Remember that Emacs interprets a file name
of the form @kbd{/foo//bar} as @kbd{/bar} and @kbd{/foo/~/bar} as
@kbd{~/bar}.
@node Improved Search, Abbreviation Facilities, Completion, Improvements over Vi
@section Improved Search
@cindex buffer search
@cindex word search
Viper provides buffer search, the ability to search the buffer for a region
under the cursor. You have to turn this on in @file{.viper} either by calling
@example
(viper-buffer-search-enable)
@end example
@noindent
or by setting @code{viper-buffer-search-char} to, say, @kbd{f3}:
@example
(setq viper-buffer-search-char ?g)
@end example
@noindent
If the user calls @code{viper-buffer-search-enable} explicitly (the first
method), then @code{viper-buffer-search-char} will be set to @kbd{g}.
Regardless of how this feature is enabled, the key
@code{viper-buffer-search-char} will take movement commands, like
@kbd{w,/,e}, to find a region and then search for the contents of that
region. This command is very useful for searching for variable names, etc.,
in a program. The search can be repeated by @kbd{n} or reversed by @kbd{N}.
@cindex incremental search
Emacs provides incremental search. As you type the string in, the
cursor will move to the next match. You can snarf words from the buffer
as you go along. Incremental Search is normally bound to @kbd{C-s} and
@kbd{C-r}. @xref{Customization}, to find out how to change the bindings
of @kbd{C-r or C-s}.
For details, @pxref{Incremental Search,,Incremental
Search,emacs,The GNU Emacs Manual} @refill
@cindex query replace
Viper also provides a query replace function that prompts through the
minibuffer. It is invoked by the @kbd{Q} key in Vi state.
@cindex mouse search
On a window display, Viper supports mouse search, i.e., you can search for a
word by clicking on it. @xref{Viper Specials}, for details.
Finally, on a window display, Viper highlights search patterns as it finds
them. This is done through what is known as @emph{faces} in Emacs. The
variable that controls how search patterns are highlighted is
@code{viper-search-face}. If you don't want any highlighting at all, put
@example
(copy-face 'default 'viper-search-face)
@end example
@vindex @code{viper-search-face}
@noindent
in @file{~/.viper}. If you want to change how patterns are highlighted, you
will have to change @code{viper-search-face} to your liking. The easiest
way to do this is to use Emacs customization widget, which is accessible
from the menubar. Viper customization group is located under the
@emph{Emulations} customization group, which in turn is under the
@emph{Editing} group (or simply by typing @kbd{:customize}). All Viper
faces are grouped together under Viper's
@emph{Highlighting} group.
Try it: it is really simple!
@node Abbreviation Facilities,Movement and Markers,Improved Search,Improvements over Vi
@section Abbreviation Facilities
@cindex abbrevs
It is possible in Emacs to define abbrevs based on the contents of the
buffer.
Sophisticated templates can be defined using the Emacs abbreviation
facilities. @xref{Abbrevs,,Abbreviations,emacs,The GNU Emacs Manual}, for
details.
@cindex dynamic abbrevs
Emacs also provides Dynamic Abbreviations. Given a partial word, Emacs
will search the buffer to find an extension for this word. For instance,
one can type @samp{Abbreviations} by typing @samp{A}, followed by a keystroke
that completed the @samp{A} to @samp{Abbreviations}. Repeated typing
will search further back in the buffer, so that one could get
@samp{Abbrevs} by repeating the
keystroke, which appears earlier in the text. Emacs binds this to
@kbd{@key{ESC} /}, so you will have to find a key and bind the function
@code{dabbrev-expand} to that key.
Facilities like this make Vi's @kbd{:ab} command obsolete.
@node Movement and Markers, New Commands, Abbreviation Facilities, Improvements over Vi
@section Movement and Markers
@cindex Ex style motion
@cindex line editor motion
Viper can be set free from the line--limited movements in Vi, such as @kbd{l}
refusing to move beyond the line, @key{ESC} moving one character back,
etc. These derive from Ex, which is a line editor. If your @file{.viper}
contains
@example
@code{(setq viper-ex-style-motion nil)}
@end example
@noindent
the motion will be a true screen editor motion. One thing you must then
watch out for is that it is possible to be on the end-of-line character.
The keys @kbd{x} and @kbd{%} will still work correctly, i.e., as if they
were on the last character.
@vindex @code{viper-syntax-preference}
@cindex syntax table
The word-movement commands @kbd{w}, @kbd{e}, etc., and the associated
deletion/yanking commands, @kbd{dw}, @kbd{yw}, etc., can be made to
understand Emacs syntax tables. If the variable
@code{viper-syntax-preference} is set to @code{strict-vi} then
the meaning of @emph{word} is the same as in
Vi. However, if the value is @code{reformed-vi} (the default) then the
alphanumeric symbols will be those specified by the current Emacs syntax
table (which may be different for different major modes) plus the
underscore symbol @kbd{_}, minus some non-word symbols, like '.;,|, etc.
Both @code{strict-vi} and @code{reformed-vi} work close to Vi in
traditional cases, but @code{reformed-vi} does a better job when editing
text in non-Latin alphabets.
The user can also specify the value @code{emacs}, which would
make Viper use exactly the Emacs notion of word. In particular, the
underscore may not be part of a word. Finally, if
@code{viper-syntax-preference} is set to @code{extended}, Viper words would
consist of characters that are classified as alphanumeric @emph{or} as
parts of symbols. This is convenient for writing programs and in many other
situations.
@code{viper-syntax-preference} is a local variable, so it can have different
values for different major modes. For instance, in programming modes it can
have the value @code{extended}. In text modes where words contain special
characters, such as European (non-English) letters, Cyrillic letters, etc.,
the value can be @code{reformed-vi} or @code{emacs}.
Changes to @code{viper-syntax-preference} should be done in the hooks to
various major modes by executing @code{viper-set-syntax-preference} as in
the following example:
@example
(viper-set-syntax-preference nil "emacs")
@end example
@findex @code{viper-set-syntax-preference}
The above discussion of the meaning of Viper's words concerns only Viper's
movement commands. In regular expressions, words remain the same as in
Emacs. That is, the expressions @code{\w}, @code{\>}, @code{\).
Currently, @var{ch} can be one of @kbd{c}, @kbd{C}, @kbd{g}, @kbd{q}, and
@kbd{s}. For instance, @kbd{#qr} will prompt you for a string and then
prepend this string to each line in the buffer.@refill
@item # c
@kindex @kbd{#c}
@cindex changing case
Change upper-case characters in the region to lower-case
(@code{downcase-region}).
Emacs command @kbd{M-l} does the same for words.
@item # C
@kindex @kbd{#C}
Change lower-case characters in the region to upper-case. For instance,
@kbd{# C 3 w} will capitalize 3 words from the current point
(@code{upcase-region}).
Emacs command @kbd{M-u} does the same for words.
@item # g
@kindex @kbd{#g}
Execute last keyboard macro for each line in the region
(@code{viper-global-execute}).@refill
@item # q
@kindex @kbd{#q}
Insert specified string at the beginning of each line in the region
(@code{viper-quote-region}). The default string is composed of the comment
character(s) appropriate for the current major mode.
@item # s
@kindex @kbd{#s}
Check spelling of words in the region (@code{spell-region}).
The function used for spelling is determined from the variable
@code{viper-spell-function}.
@vindex @code{viper-spell-function}
@item *
@kindex @kbd{*}
Call last keyboard macro.
@item m .
Set mark at point and push old mark off the ring
@item m<
@item m>
Set mark at beginning and end of buffer, respectively.
@item m,
Jump to mark and pop mark off the ring. @xref{Mark,,Mark,emacs,The GNU
Emacs Manual}, for more info.
@item ] register
@kindex @kbd{]}
View contents of register
@item [ textmarker
@kindex @kbd{[}
View filename and position of textmarker
@item @@#
@item @@register
@item @@!
@kindex @kbd{@@#}
@kindex @kbd{@@}
@kindex @kbd{@@!}
@cindex keyboard macros
@cindex register execution
Begin/end keyboard macro. @@register has a different meaning when used after
a @kbd{@@#}. @xref{Macros and Registers}, for details
@item []
@kindex @kbd{[]}
Go to end of heading.
@item g
Search buffer for text delimited by movement command. The canonical
example is @kbd{gw} to search for the word under the cursor.
@xref{Improved Search}, for details.@refill
@item C-g and C-]
@kindex @kbd{C-g}
@kindex @kbd{C-]}
Quit and Abort Recursive edit. These may be necessary on occasion.
@xref{Vi State}, for a reason.
@item C-c C-g
@kindex @kbd{C-c C-g}
Hitting @kbd{C-c} followed by @kbd{C-g} will display the information on the
current buffer. This is the same as hitting @kbd{C-g} in Vi, but, as
explained above, @kbd{C-g} is needed for other purposes in Emacs.
@item C-c /
@kindex @kbd{C-c /}
Without a prefix argument, this command toggles
case-sensitive/case-insensitive search modes and plain vanilla/regular
expression search. With the prefix argument 1, i.e.,
@kbd{1 C-c /}, this toggles case-sensitivity; with the prefix argument 2,
toggles plain vanilla search and search using
regular expressions. @xref{Viper Specials}, for alternative ways to invoke
this function.
@cindex vanilla search
@cindex case-sensitive search
@cindex case-insensitive search
@item M-p and M-n
@kindex @kbd{M-p}
@kindex @kbd{M-n}
In the minibuffer, these commands navigate through the minibuffer
histories, such as the history of search strings, Ex commands, etc.
@item C-s
@kindex @kbd{C-s}
If the minibuffer is entered via a Viper search commands @kbd{/} or @kbd{?},
then typing this key inserts the last search string used by the
Emacs incremental search command (that is bound to @kbd{C-s} everywhere
except in this case).
@item C-c M-p and C-c M-n
@kindex @kbd{C-c M-p}
@kindex @kbd{C-c M-n}
@cindex Insertion history
@cindex Insertion ring
@cindex Command history
@cindex Command ring
In Insert or Replace state, these commands let the user
peruse the history of insertion strings used in previous insert or replace
commands. Try to hit @kbd{C-c M-p} or @kbd{C-c M-n} repeatedly and see what
happens. @xref{Viper Specials}, for more.
In Vi state, these commands let the user peruse the history of Vi-style
destructive commands, such as @kbd{dw}, @kbd{J}, @kbd{a}, etc.
By repeatedly typing @kbd{C-c M-p} or @kbd{C-c M-n} you will cycle Viper
through the recent history of Vi commands, displaying the commands one by
one. Once
an appropriate command is found, it can be executed by typing `@kbd{.}'.
Since typing @kbd{C-c M-p} is tedious, it is more convenient to bind an
appropriate function to a function key on the keyboard and use that key.
@xref{Viper Specials}, for details.
@item Ex commands
@findex @kbd{:args}
@findex @kbd{:n}
@findex @kbd{:pwd}
@findex @kbd{:pre}
The commands @kbd{:args}, @kbd{:next}, @kbd{:pre} behave
differently. @kbd{:pwd} exists to get current directory.
The commands @kbd{:b} and @kbd{:B} switch buffers around. @xref{File and
Buffer Handling}, for details.
There are also the new commands @kbd{:RelatedFile} and
@kbd{PreviousRelatedFile} (which abbreviate to @kbd{R} and @kbd{P},
respectively. @xref{Viper Specials}, for details.
@findex @kbd{:RelatedFile}
@findex @kbd{:PreviousRelatedFile}
@end table
Apart from the new commands, many old commands have been enhanced. Most
notably, Vi style macros are much more powerful in Viper than in Vi. @xref{Vi
Macros}, for details.
@node Useful Packages, ,New Commands, Improvements over Vi
@section Useful Packages
Some Emacs packages are mentioned here as an aid to the new Viper user, to
indicate what Viper is capable of.
A vast number comes with the standard Emacs distribution, and many more exist
on the net and on the archives.
This manual also mentions some Emacs features a new user
should know about. The details of these are found in the GNU Emacs
Manual.
The features first. For details, look up the Emacs Manual.
@table @samp
@item Make
@cindex make
@cindex compiling
Makes and Compiles can be done from the editor. Error messages will be
parsed and you can move to the error lines.
@item Shell
@cindex shell
@cindex interactive shell
You can talk to Shells from inside the editor. Your entire shell session
can be treated as a file.
@item Mail
@cindex email
@cindex mail
Mail can be read from and sent within the editor. Several sophisticated
packages exist.
@item Language Sensitive Editing
Editing modes are written for most computer languages in existence. By
controlling indentation, they catch punctuation errors.
@end table
The packages, below, represents a drop in the sea of special-purpose
packages that come with standard distribution of Emacs.
@table @samp
@item Transparent FTP
@cindex transparent ftp
@pindex ange-ftp.el
@code{ange-ftp.el} can ftp from the editor to files on other machines
transparent to the user.
@item RCS Interfaces
@cindex version maintenance
@cindex RCS
@pindex vc.el
@code{vc.el} for doing RCS commands from inside the editor
@item Directory Editor
@cindex dired
@pindex dired.el
@code{dired.el} for editing contents of directories and for navigating in
the file system.
@item Syntactic Highlighting
@cindex font-lock
@pindex font-lock.el
@code{font-lock.el} for automatic highlighting various parts of a buffer
using different fonts and colors.
@item Saving Emacs Configuration
@cindex desktop
@pindex desktop.el
@code{desktop.el} for saving/restoring configuration on Emacs exit/startup.
@item Spell Checker
@cindex ispell
@pindex ispell.el
@code{ispell.el} for spell checking the buffer, words, regions, etc.
@item File and Buffer Comparison
@cindex ediff
@pindex ediff.el
@code{ediff.el} for finding differences between files and for applying
patches.
@end table
@noindent
Emacs Lisp archives exist on
@samp{archive.cis.ohio-state.edu}
and @samp{wuarchive.wustl.edu}@refill
@node Customization,Commands,Improvements over Vi,Top
@chapter Customization
@cindex customization
Customization can be done in 2 ways.
@itemize @bullet
@item
@cindex initialization
@cindex .viper
Elisp code in a @file{.viper} file in your home directory. Viper
loads @file{.viper} just before it does the binding for mode
hooks. This is recommended for experts only.
@item
@cindex .emacs
Elisp code in your @file{.emacs} file before and after the @code{(require
'viper)} line. This method is @emph{not} recommended, unless you know what
you are doing. Only two variables, @code{viper-mode} and
@code{viper-custom-file-name}, are supposed to be customized in @file{.emacs},
prior to loading Viper (i.e., prior to @code{(require 'viper)} command.@refill
@item
@cindex :customize
By executing the @kbd{:customize} Ex command. This takes you to the Emacs
customization widget, which lets you change the values of Viper
customizable variables easily. This method is good for novice and
experts alike. The customization code in the form of Lisp commands will be
placed in @file{~/.emacs} or some other customization file depending on the
version of Emacs that you use. Still, it is recommended to separate
Viper-related customization produced by the Emacs customization widget
and keep it in the @file{.viper} file.
Some advanced customization cannot be accomplished this way, however, and
has to be done in Emacs Lisp in the @file{.viper} file. For the common
cases, examples are provided that you can use directly.
@end itemize
@menu
* Rudimentary Changes:: Simple constant definitions.
* Key Bindings:: Enabling Emacs Keys, Rebinding keys, etc.
* Packages that Change Keymaps:: How to deal with such beasts.
* Viper Specials:: Special Viper commands.
* Vi Macros:: How to do Vi style macros.
@end menu
@node Rudimentary Changes,Key Bindings,Customization,Customization
@section Rudimentary Changes
@cindex setting variables
@cindex variables for customization
@findex @kbd{:set}
An easy way to customize Viper is to change the values of constants used in
Viper. Here is the list of the constants used in Viper and their default
values. The corresponding :se command is also indicated. (The symbols
@code{t} and @code{nil} represent ``true'' and ``false'' in Lisp).
Viper supports both the abbreviated Vi variable names and their full
names. Variable completion is done on full names only. @key{TAB} and
@key{SPC} complete
variable names. Typing `=' will complete the name and then will prompt for
a value, if applicable. For instance, @kbd{:se au @key{SPC}} will complete the
command to @kbd{:set autoindent}; @kbd{:se ta @key{SPC}} will complete the command
and prompt further like this: @kbd{:set tabstop = }.
However, typing @kbd{:se ts @key{SPC}} will produce a ``No match'' message
because @kbd{ts} is an abbreviation for @kbd{tabstop} and Viper supports
completion on full names only. However, you can still hit @key{RET}
or @kbd{=}, which will complete the command like this: @kbd{:set ts = } and
Viper will be waiting for you to type a value for the tabstop variable.
To get the full list of Vi variables, type @kbd{:se @key{SPC} @key{TAB}}.
@table @code
@item viper-auto-indent nil
@itemx :se ai (:se autoindent)
@itemx :se ai-g (:se autoindent-global)
If @code{t}, enable auto indentation.
by @key{RET}, @kbd{o} or @kbd{O} command.
@code{viper-auto-indent} is a local variable. To change the value globally, use
@code{setq-default}. It may be useful for certain major modes to have their
own values of @code{viper-auto-indent}. This can be achieved by using
@code{setq} to change the local value of this variable in the hooks to the
appropriate major modes.
@kbd{:se ai} changes the value of @code{viper-auto-indent} in the current
buffer only; @kbd{:se ai-g} does the same globally.
@item viper-electric-mode t
If not @code{nil}, auto-indentation becomes electric, which means that
@key{RET}, @kbd{O}, and @kbd{o} indent cursor according to the current
major mode. In the future, this variable may control additional electric
features.
This is a local variable: @code{setq} changes the value of this variable
in the current buffer only. Use @code{setq-default} to change the value in
all buffers.
@item viper-case-fold-search nil
@itemx :se ic (:se ignorecase)
If not @code{nil}, search ignores cases.
This can also be toggled by quickly hitting @kbd{/} twice.
@item viper-re-search nil
@itemx :se magic
If not @code{nil}, search will use regular expressions; if @code{nil} then
use vanilla search.
This behavior can also be toggled by quickly hitting @kbd{/} trice.
@item buffer-read-only
@itemx :se ro (:se readonly)
Set current buffer to read only. To change globally put
@code{(setq-default buffer-read-only t)} in your @file{.emacs} file.
@item blink-matching-paren t
@itemx :se sm (:se showmatch)
Show matching parens by blinking cursor.
@item tab-width t (default setting via @code{setq-default})
@itemx :se ts=value (:se tabstop=value)
@itemx :se ts-g=value (:se tabstop-global=value)
@code{tab-width} is a local variable that controls the width of the tab stops.
To change the value globally, use @code{setq-default}; for local settings,
use @code{setq}.
The command @kbd{:se ts}
sets the tab width in the current
buffer only; it has no effect on other buffers.
The command @kbd{:se ts-g} sets tab width globally,
for all buffers where the tab is not yet set locally,
including the new buffers.
Note that typing @key{TAB} normally
doesn't insert the tab, since this key is usually bound to
a text-formatting function, @code{indent-for-tab-command} (which facilitates
programming and document writing). Instead, the tab is inserted via the
command @code{viper-insert-tab}, which is bound to @kbd{S-tab} (shift + tab).
On some non-windowing terminals, Shift doesn't modify the @key{TAB} key, so
@kbd{S-tab} behaves as if it were @key{TAB}. In such a case, you will have
to bind @code{viper-insert-tab} to some other convenient key.
@item viper-shift-width 8
@itemx :se sw=value (:se shiftwidth=value)
The number of columns shifted by @kbd{>} and @kbd{} to spell.
@item viper-glob-function
The value of this variable is the function symbol used to expand wildcard
symbols. This is platform-dependent. The default tries to set this variable
to work with most shells, MS Windows, OS/2, etc. However, if it
doesn't work the way you expect, you should write your own.
Use @code{viper-glob-unix-files} and @code{viper-glob-mswindows-files} in
@file{viper-util.el} as examples.
This feature is used to expand wildcards in the Ex command @kbd{:e}.
Note that Viper doesn't support wildcards in the @kbd{:r} and @kbd{:w}
commands, because file completion is a better mechanism.
@findex @code{viper-glob-function}
@item ex-cycle-other-window t
If not @code{nil}, @kbd{:n} and @kbd{:b} will cycle through files in another
window, if one exists.
@item ex-cycle-through-non-files nil
@kbd{:n} does not normally cycle through buffers. Set this to get
buffers also.
@item viper-want-emacs-keys-in-insert
This is set to @code{nil} for user levels 1 and 2 and to @code{t} for user
levels 3 and 4. Users who specify level 5 are allowed to set this variable
as they please (the default for this level is @code{t}). If set to
@code{nil}, complete Vi compatibility is provided in Insert state. This is
really not recommended, as this precludes you from using language-specific
features provided by the major modes.
@item viper-want-emacs-keys-in-vi
This is set to @code{nil} for user
level 1 and to @code{t} for user levels 2--4.
At level 5, users are allowed to set this variable as they please (the
default for this level is @code{t}).
If set to @code{nil}, complete Vi compatibility is provided
in Vi command state. Setting this to @code{nil} is really a bad idea,
unless you are a novice, as this precludes the use
of language-specific features provided by the major modes.
@item viper-keep-point-on-repeat t
If not @code{nil}, point is not moved when the user repeats the previous
command by typing `.' This is very useful for doing repeated changes with
the @kbd{.} key.
@item viper-repeat-from-history-key 'f12
Prefix key used to invoke the macros @kbd{f12 1} and @kbd{f12 2} that repeat
the second-last and the third-last destructive command.
Both these macros are bound (as Viper macros) to
@code{viper-repeat-from-history},
which checks the second key by which it is invoked to see which of the
previous commands to invoke. Viper binds @kbd{f12 1} and @kbd{f12 2} only,
but the user can bind more in @file{~/.viper}. @xref{Vi Macros}, for how to do
this.
@item viper-keep-point-on-undo nil
If not @code{nil}, Viper tries to not move point when undoing commands.
Instead, it will briefly move the cursor to the place where change has
taken place. However, if the undone piece of text is not seen in window,
then point will be moved to the place where the change took place.
Set it to @code{t} and see if you like it better.
@item viper-delete-backwards-in-replace nil
If not @code{nil}, @key{DEL} key will delete characters while moving the cursor
backwards. If @code{nil}, the cursor will move backwards without deleting
anything.
@item viper-replace-overlay-face 'viper-replace-overlay-face
On a graphical display, Viper highlights replacement regions instead of
putting a @samp{$} at the end. This variable controls the so called
@dfn{face} used to highlight the region.
By default, @code{viper-replace-overlay-face} underlines the replacement on
monochrome displays and also lays a stipple over them. On color displays,
replacement regions are highlighted with color.
If you know something about Emacs faces and don't like how Viper highlights
replacement regions, you can change @code{viper-replace-overlay-face} by
specifying a new face. (Emacs faces are described in the Emacs Lisp
reference.) On a color display, the following customization method is
usually most effective:
@example
(set-face-foreground viper-replace-overlay-face "DarkSlateBlue")
(set-face-background viper-replace-overlay-face "yellow")
@end example
For a complete list of colors available to you, evaluate the expression
@code{(x-defined-colors)}. (Type it in the buffer @code{*scratch*} and then
hit the @kbd{C-j} key.
@item viper-replace-overlay-cursor-color "Red"
@vindex @code{viper-replace-overlay-cursor-color}
Cursor color when it is inside the replacement region.
This has effect only on color displays and only when Emacs runs as an X
application.
@item viper-insert-state-cursor-color nil
@vindex @code{viper-insert-state-cursor-color}
If set to a valid color, this will be the cursor color when Viper is in
insert state.
@item viper-emacs-state-cursor-color nil
@vindex @code{viper-emacs-state-cursor-color}
If set to a valid color, this will be the cursor color when Viper is in
emacs state.
@item viper-replace-region-end-delimiter "$"
A string used to mark the end of replacement regions. It is used only on
TTYs or if @code{viper-use-replace-region-delimiters} is non-@code{nil}.
@item viper-replace-region-start-delimiter ""
A string used to mark the beginning of replacement regions. It is used
only on TTYs or if @code{viper-use-replace-region-delimiters} is non-@code{nil}.
@item viper-use-replace-region-delimiters
If non-@code{nil}, Viper will always use @code{viper-replace-region-end-delimiter} and
@code{viper-replace-region-start-delimiter} to delimit replacement regions,
even on color displays (where this is unnecessary). By default, this
variable is non-@code{nil} only on TTYs or monochrome displays.
@item viper-allow-multiline-replace-regions t
If non-@code{nil}, multi-line text replacement regions, such as those produced by
commands @kbd{c55w}, @kbd{3C}, etc., will stay around until the user exits
the replacement mode. In this variable is set to @code{nil}, Viper will
emulate the standard Vi behavior, which supports only intra-line
replacement regions (and multi-line replacement regions are deleted).
@item viper-toggle-key "\C-z"
Specifies the key used to switch from Emacs to Vi and back.
Must be set in @file{.viper}. This variable can't be
changed interactively after Viper is loaded.
In Insert state, this key acts as a temporary escape to Vi state, i.e., it
will set Viper up so that the very next command will be executed as if it
were typed in Vi state.
@item viper-buffer-search-char nil
Key used for buffer search. @xref{Viper Specials}, for details.
@item viper-surrounding-word-function 'viper-surrounding-word
The value of this variable is a function name that is used to determine
what constitutes a word clicked upon by the mouse. This is used by mouse
search and insert.
@item viper-search-face 'viper-search-face
Variable that controls how search patterns are highlighted when they are
found.
@item viper-vi-state-hook nil
List of parameterless functions to be run just after entering the Vi
command state.
@item viper-insert-state-hook nil
Same for Insert state. This hook is also run after entering Replace state.
@item viper-replace-state-hook nil
List of (parameterless) functions called just after entering Replace state
(and after all @code{viper-insert-state-hook}).
@item viper-emacs-state-hook nil
List of (parameterless) functions called just after switching from Vi state
to Emacs state.
@item viper-load-hook nil
List of (parameterless) functions called just after loading Viper. This is
the last chance to do customization before Viper is up and running.
@end table
@noindent
You can reset some of these constants in Viper with the Ex command @kbd{:set}
(when so indicated in the table). Or you
can include a line like this in your @file{.viper} file:
@example
(setq viper-case-fold-search t)
@end example
@vindex @code{viper-auto-indent}
@vindex @code{viper-electric-mode}
@vindex @code{viper-case-fold-search}
@vindex @code{viper-re-search}
@vindex @code{viper-shift-width}
@vindex @code{buffer-read-only}
@vindex @code{viper-search-wrap-around}
@vindex @code{viper-search-scroll-threshold}
@vindex @code{viper-search-face}
@vindex @code{viper-tags-file-name}
@vindex @code{viper-re-query-replace}
@vindex @code{viper-want-ctl-h-help}
@vindex @code{viper-vi-style-in-minibuffer}
@vindex @code{viper-no-multiple-ESC}
@vindex @code{viper-always}
@vindex @code{viper-fast-keyseq-timeout}
@vindex @code{viper-ex-style-motion}
@vindex @code{viper-ex-style-editing}
@vindex @code{viper-ESC-moves-cursor-back}
@vindex @code{viper-custom-file-name}
@vindex @code{viper-spell-function}
@vindex @code{ex-cycle-other-window}
@vindex @code{ex-cycle-through-non-files}
@vindex @code{viper-want-emacs-keys-in-insert}
@vindex @code{viper-want-emacs-keys-in-vi}
@vindex @code{viper-keep-point-on-repeat}
@vindex @code{viper-keep-point-on-undo}
@vindex @code{viper-delete-backwards-in-replace}
@vindex @code{viper-replace-overlay-face}
@vindex @code{viper-replace-region-end-symbol}
@vindex @code{viper-replace-region-start-symbol}
@vindex @code{viper-allow-multiline-replace-regions}
@vindex @code{viper-toggle-key}
@vindex @code{viper-buffer-search-char}
@vindex @code{viper-surrounding-word-function}
@vindex @code{viper-vi-state-hook}
@vindex @code{viper-insert-state-hook}
@vindex @code{viper-replace-state-hook}
@vindex @code{viper-emacs-state-hook}
@node Key Bindings, Packages that Change Keymaps, Rudimentary Changes,Customization
@section Key Bindings
@cindex key bindings
@cindex keymaps
Viper lets you define hot keys, i.e., you can associate keyboard keys
such as F1, Help, PgDn, etc., with Emacs Lisp functions (that may already
exist or that you will write). Each key has a "preferred form" in
Emacs. For instance, the Up key's preferred form is [up], the Help key's
preferred form is [help], and the Undo key has the preferred form [f14].
You can find out the preferred form of a key by typing @kbd{M-x
describe-key-briefly} and then typing the key you want to know about.
Under the X Window System, every keyboard key emits its preferred form,
so you can just type
@lisp
(global-set-key [f11] 'calendar) ; L1, Stop
(global-set-key [f14] 'undo) ; L4, Undo
@end lisp
@noindent
to bind L1 (a key that exists on some SUN workstations) so it will invoke
the Emacs Calendar and to bind L4 so it will undo changes.
However, on a dumb terminal or in an Xterm window, even the standard arrow
keys may
not emit the right signals for Emacs to understand. To let Emacs know about
those keys, you will have to find out which key sequences they emit
by typing @kbd{C-q} and then the key (you should switch to Emacs state
first). Then you can bind those sequences to their preferred forms using
@code{input-decode-map} as follows:
@lisp
(cond ((string= (getenv "TERM") "xterm")
(define-key input-decode-map "\e[192z" [f11]) ; L1
(define-key input-decode-map "\e[195z" [f14]) ; L4, Undo
@end lisp
The above illustrates how to do this for Xterm. On VT100, you would have to
replace "xterm" with "vt100" and also change the key sequences (the same
key may emit different sequences on different types of terminals).
The above keys are global, so they are overwritten by the local maps
defined by the major modes and by Viper itself. Therefore, if you wish to
change a binding set by a major mode or by Viper, read this.
Viper users who wish to specify their own key bindings should be concerned
only with the following three keymaps:
@code{viper-vi-global-user-map} for Vi state commands,
@code{viper-insert-global-user-map} for Insert state commands,
and @code{viper-emacs-global-user-map} for Emacs state commands (note:
customized bindings for Emacs state made to @code{viper-emacs-global-user-map}
are @emph{not} inherited by Insert state).
For more information on Viper keymaps, see the header of the file
@file{viper.el}.
If you wish to change a Viper binding, you can use the
@code{define-key} command, to modify @code{viper-vi-global-user-map},
@code{viper-insert-global-user-map}, and @code{viper-emacs-global-user-map}, as
explained below. Each of these key maps affects the corresponding Viper state.
The keymap @code{viper-insert-global-user-map} also affects Viper's Replace
state.
@noindent
If you want to
bind a key, say @kbd{C-v}, to the function that scrolls
page down and to make @kbd{0} display information on the current buffer,
putting this in @file{.viper} will do the trick in Vi state:
@example
(define-key viper-vi-global-user-map "\C-v" 'scroll-down)
@end example
@noindent
To set a key globally,
@example
(define-key viper-emacs-global-user-map "\C-c m" 'smail)
(define-key viper-vi-global-user-map "0" 'viper-info-on-file)
@end example
@noindent
Note, however, that this binding may be overwritten by other keymaps, since
the global keymap has the lowest priority.
To make sure that nothing will override a binding in Emacs state, you
can write this:
@example
(define-key viper-emacs-global-user-map "\C-c m" 'smail)
@end example
@noindent
To customize the binding for @kbd{C-h} in Insert state:
@example
(define-key viper-insert-global-user-map "\C-h" 'my-del-backwards-function)
@end example
@noindent
Each Emacs command key calls some Lisp function. If you have enabled the
Help, (@pxref{Rudimentary Changes}) @kbd{C-h k} will show you the function
for each specific key; @kbd{C-h b} will show all bindings, and @kbd{C-h m}
will provide information on the major mode in effect. If Help is not
enabled, you can still get help in Vi state by prefixing the above commands
with @kbd{\}, e.g., @kbd{\ C-h k} (or you can use the Help menu in the
menu bar, if Emacs runs under X).
Viper users can also change bindings on a per major mode basis. As with
global bindings, this can be done separately for each of the three main Viper
states. To this end, Viper provides the function
@code{viper-modify-major-mode}.
@findex @code{viper-modify-major-mode}
To modify keys in Emacs state for @code{my-favorite-major-mode}, the user
needs to create a sparse keymap, say, @code{my-fancy-map}, bind whatever
keys necessary in that keymap, and put
@example
(viper-modify-major-mode 'dired-mode 'emacs-state my-fancy-map)
@end example
@noindent
in @file{~/.viper}. To do the same in Vi and Insert states, you should use
@code{vi-state} and @code{insert-state}. Changes in Insert state are also
in effect in Replace state. For instance, suppose that the user wants to
use @kbd{dd} in Vi state under Dired mode to delete files, @kbd{u} to unmark
files, etc. The following code in @file{~/.viper} will then do the job:
@example
(setq my-dired-modifier-map (make-sparse-keymap))
(define-key my-dired-modifier-map "dd" 'dired-flag-file-deletion)
(define-key my-dired-modifier-map "u" 'dired-unmark)
(viper-modify-major-mode 'dired-mode 'vi-state my-dired-modifier-map)
@end example
A Vi purist may want to modify Emacs state under Dired mode so that
@kbd{k}, @kbd{l}, etc., will move around in directory buffers, as in
Vi. Although this is not recommended, as these keys are bound to useful
Dired functions, the trick can be accomplished via the following code:
@example
(setq my-dired-vi-purist-map (make-sparse-keymap))
(define-key my-dired-vi-purist-map "k" 'viper-previous-line)
(define-key my-dired-vi-purist-map "l" 'viper-forward-char)
(viper-modify-major-mode 'dired-mode 'emacs-state my-dired-vi-purist-map)
@end example
Yet another way to customize key bindings in a major mode is to edit the
list @code{viper-major-mode-modifier-list} using the customization widget.
@vindex @code{viper-major-mode-modifier-list}
(This variable is in the Viper-misc customization group.)
The elements of this list are triples of the form: (major-mode viper-state
keymap), where the keymap contains bindings that are supposed to be active
in the given major mode and the given viper-state.
Effects similar to key binding changes can be achieved by defining Vi
keyboard macros using the Ex commands @kbd{:map} and @kbd{:map!}. The
difference is that multi-key Vi macros do not override the keys they are
bound to, unless these keys are typed in quick succession. So, with macros,
one can use the normal keys alongside with the macros. If per-mode
modifications are needed, the user can try both ways and see which one is
more convenient.
@findex @kbd{:map}
@xref{Vi Macros}, for details.
Note: in major modes that come up in @emph{Emacs state} by default, the
aforesaid modifications may not take place immediately (but only after the
buffer switches to some other Viper state and then back to Emacs state). To
avoid this, one should add @code{viper-change-state-to-emacs} to an
appropriate hook of that major mode. (Check the function
@code{viper-set-hooks} in @file{viper.el} for examples.) However, if you
did not set @code{viper-always} to @code{nil}, chances are that you won't
need to perform the above procedure, because Viper will take care of most
useful defaults.
Finally, Viper has a facility that lets the user define per-buffer
bindings, i.e., bindings that are in effect in some specific buffers
only. Unlike per-mode bindings described above, per-buffer bindings can be
defined based on considerations other than the major mode. This is done
via the function @code{viper-add-local-keys}, which lets one specify bindings
that should be in effect in the current buffer only and for a specific Viper
state. For instance,
@lisp
(viper-add-local-keys 'vi-state '(("ZZ" .@: TeX-command-master)
("ZQ" .@: viper-save-kill-buffer)))
@end lisp
@noindent
redefines @kbd{ZZ} to invoke @code{TeX-command-master} in @code{vi-state}
and @kbd{ZQ} to save-then-kill the current buffer. These bindings take
effect only in the buffer where this command is executed. The typical use
of this function is to execute the above expression from within a function
that is included in a hook to some major mode. For instance, the above
expression
could be called from a function, @code{my-tex-init}, which may be added to
@code{tex-mode-hook} as follows:
@lisp
(add-hook 'tex-mode-hook 'my-tex-init)
@end lisp
@noindent
When TeX mode starts, the hook is executed and the above Lisp expression is
evaluated. Then, the bindings for @kbd{ZZ} and @kbd{ZQ} are changed in Vi
command mode for all buffers in TeX mode.
Another useful application is to bind @kbd{ZZ} to @code{send-mail}
in the Mail mode buffers (the specifics of this depend on which mail
package you are using, @code{rmail}, @code{mh-e}, @code{vm}, etc.
For instance, here is how to do this for @code{mh-e}, the Emacs interface
to MH:
@lisp
(defun mh-add-vi-keys ()
"Set up ZZ for MH-e and XMH."
(viper-add-local-keys 'vi-state '(("ZZ" .@: mh-send-letter))))
(add-hook 'mh-letter-mode-hook 'mh-add-vi-keys)
@end lisp
You can also use @code{viper-add-local-keys} to set per buffer
bindings in Insert state and Emacs state by passing as a parameter the
symbols @code{insert-state} and @code{emacs-state}, respectively.
As with global bindings, customized local bindings done to Emacs state
are not inherited by Insert state.
On rare occasions, local keys may be added by mistake. Usually this is done
indirectly, by invoking a major mode that adds local keys (e.g.,
@code{shell-mode} redefines @key{RET}). In such a case, exiting the wrong
major mode won't rid you from unwanted local keys, since these keys are
local to Viper state and the current buffer, not to the major mode.
In such situations, the remedy is to type @kbd{M-x viper-zap-local-keys}.
So much about Viper-specific bindings.
@xref{Customization,,Customization,emacs,The GNU Emacs
Manual}, and the Emacs quick reference card for the general info on key
bindings in Emacs.
@vindex @code{input-decode-map}
@vindex @code{function-key-map}
@vindex @code{viper-vi-global-user-map}
@vindex @code{viper-insert-global-user-map}
@vindex @code{viper-emacs-global-user-map}
@findex @code{viper-add-local-keys}
@findex @code{viper-zap-local-keys}
@node Packages that Change Keymaps,Viper Specials,Key Bindings,Customization
@subsection Packages that Change Keymaps
@cindex C-c and Viper
@cindex Viper and C-c
Viper is designed to coexist with all major and minor modes of Emacs. This
means that bindings set by those modes are generally available with Viper
(unless you explicitly prohibit them by setting
@code{viper-want-emacs-keys-in-vi} and @code{viper-want-emacs-keys-in-insert} to
@code{nil}).
If @code{viper-always} is set to @code{t} (which is the default), Viper
will try to bring each buffer
in the Viper state that is most appropriate for that buffer.
Usually, this would be the Vi state, but sometimes it could be the Insert
state or the Emacs state.
Some major mode bindings will necessarily be overwritten by Viper. Indeed, in
Vi state, most of the 1-character keys are used for Vi-style editing. This
usually causes no problems because most packages designed for editing files
typically do not bind such keys. Instead, they use key sequences that start
with @kbd{C-x} and @kbd{C-c}. This is why it was so important for us to
free up @kbd{C-x} and @kbd{C-c}.
It is common for language-specific major modes to bind @key{TAB} and
@kbd{C-j} (the line feed) keys to various formatting functions. This is
extremely useful, but may require some getting used to for a Vi user. If you
decide that this feature is not for you, you can re-bind these keys as
explained earlier (@pxref{Customization}).
Binding for @key{TAB} is one of the most unusual aspects of Viper for many
novice users. In Emacs, @key{TAB} is used to format text and programs, and
is extremely useful. For instance, hitting @key{TAB} causes the current
line to be re-indented in accordance with the context. In programming,
this is very important, since improper automatic indentation would
immediately alert the programmer to a possible error. For instance, if a
@kbd{)} or a @kbd{"} is missing somewhere above the current
line, @key{TAB} is likely to mis-indent the line.
For this reason, Viper doesn't change the standard Emacs binding of
@key{TAB}, thereby sacrificing Vi compatibility
(except for users at level 1). Instead, in Viper, the key
@kbd{S-tab} (shift+ tab) is chosen to emulate Vi's @key{TAB}.
We should note that on some non-windowing terminals, Shift doesn't modify
the @key{TAB} key, so @kbd{S-tab} behaves as if it were @key{TAB}. In such
a case, you will have to bind @code{viper-insert-tab} to some other
convenient key.
Some packages, notably Dired, Gnus, Info, etc., attach special meaning to
common keys like @key{SPC}, @kbd{x}, @kbd{d}, @kbd{v}, and others. This
means that Vi command state is inappropriate for working with these
packages. Fortunately, these modes operate on read-only buffers and are
designed not for editing files, but for special-purpose browsing, reading
news, mail, etc., and Vi commands are meaningless in these situations. For
this reason, Viper doesn't force Vi state on such major modes---it
brings them in Emacs state. You can switch to Vi state by typing @kbd{C-z}
if, for instance, you want to do Vi-style search in a buffer (although,
usually, incremental search, which is bound to @kbd{C-s}, is sufficient in
these situations). But you should then switch back to Emacs state if you
plan to continue using these major modes productively. You can also switch
to Vi temporarily, to execute just one command. This is done by typing
@kbd{C-c \}. (In some of these modes, @kbd{/} and @kbd{:} are bound
Vi-style, unless these keys perform essential duties.)
If you would like certain major modes to come up in Emacs state rather than
Vi state (but Viper thinks otherwise), you should put these major modes
on the @code{viper-emacs-state-mode-list} list and delete them from
@code{viper-vi-state-mode-list}.
Likewise, you can force Viper's Insert state on a major mode by putting it
in @code{viper-insert-state-mode-list}.
@vindex @code{viper-emacs-state-mode-list}
@vindex @code{viper-insert-state-mode-list}
@vindex @code{viper-vi-state-mode-list}
It is also possible to impose Vi on some major modes, even though they may
bind common keys to specialized commands. This might make sense for modes
that bind only a small number of common keys. For instance, Viper subverts
the Shell mode by changing the bindings for @kbd{C-m} and @kbd{C-d} using
@code{viper-add-local-keys} described in the section on customization
(@pxref{Customization}).
In some cases, some @emph{minor} modes might override certain essential
bindings in Vi command state. This is not a big problem because this
can happen only in the beginning, when the minor mode kicks in. Typing
@code{M-x viper-mode} will correct the situation. Viper knows about
several such minor modes and takes care of them, so the above trick
is usually not necessary. If you find that some minor mode, e.g.,
@code{nasty-mode} interferes with Viper, putting the following in
@file{.viper} should fix the problem:
@lisp
(viper-harness-minor-mode "nasty-mode")
@end lisp
@noindent
The argument to @code{viper-harness-minor-mode} is the name of the file for the
offending minor mode with the suffixes @file{.el} and @file{.elc} removed.
It may not be always obvious which minor mode is at fault. The only
guidance here is to look into the file that defines the minor mode you are
suspecting, say @file{nasty-mode.el}, and see if it has a variable called
@code{nasty-mode-map}. Then check if there is a statement of the form
@lisp
(define-key nasty-mode-map key function)
@end lisp
@noindent
that binds the misbehaving
keys. If so, use the above line to harness @code{nasty-mode}. If your
suspicion is wrong, no harm is done if you harness a minor mode that
doesn't need to be harnessed.
It is recommended to harness even those minor modes that don't override
Viper keys, but still have their own keymaps. A general way to
make a minor mode, @code{my-mode},
compatible with Viper is to have the file @file{my-mode.el} include the following code:
@lisp
(when (fboundp 'viper-harness-minor-mode)
(let ((lib (file-name-sans-extension
(file-name-nondirectory load-file-name))))
(viper-harness-minor-mode lib)))
@end lisp
@vindex @code{viper-want-emacs-keys-in-vi}
@vindex @code{viper-want-emacs-keys-in-insert}
@vindex @code{viper-always}
@findex @code{viper-set-hooks}
@findex @code{viper-mode}
@findex @code{viper-harness-minor-mode}
@findex @code{remove-hook}
@findex @code{add-hook}
@node Viper Specials,Vi Macros,Packages that Change Keymaps,Customization
@section Viper Specials
Viper extends Vi with a number of useful features. This includes various
search functions, histories of search strings, Ex commands, insertions, and
Vi's destructive commands. In addition, Viper supports file name completion
and history, completion of Ex commands and variables, and many other
features. Some of these features are explained in detail elsewhere in this
document. Other features are explained here.
@table @code
@item (viper-buffer-search-enable)
@item viper-buffer-search-char nil
Enable buffer search. Explicit call to @code{viper-buffer-search-enable}
sets @code{viper-buffer-search-char} to @kbd{g}. Alternatively, the user can
set @code{viper-buffer-search-char} in @file{.viper} to a key sequence
to be used for buffer search. There is no need to call
@code{viper-buffer-search-enable} in that case.
@findex @code{viper-buffer-search-enable}
@vindex @code{viper-buffer-search-char}
@item viper-toggle-search-style
This function, bound to @kbd{C-c /}, lets one toggle case-sensitive and
case-insensitive search, and also switch between plain vanilla search and
search via regular expressions. Without the prefix argument, the user is
asked which mode to toggle. With prefix argument 1, this toggles
case-sensitivity. With prefix argument 2, regular expression/vanilla search
will be toggled.
However, we found that the most convenient way to toggle
these options is to bind a Vi macro to
bind @kbd{//} to toggles case sensitivity and to @kbd{///} to toggles
vanilla search. Thus, quickly hitting @kbd{/} twice will switch Viper from
case sensitive search to case-insensitive. Repeating this once again will
restore the original state. Likewise, quickly hitting @kbd{/} three times
will switch you from vanilla-style search to search via regular expressions.
If you hit something other than @kbd{/} after the first @kbd{/} or if the
second @kbd{/} doesn't follow quickly enough, then Viper will issue the
usual prompt @kbd{/} and will wait for input, as usual in Vi.
If you don't like this behavior, you can ``unrecord'' these macros in your
@file{~/.viper} file. For instance, if you don't like the above feature, put
this in @file{~/.viper}:
@example
(viper-set-searchstyle-toggling-macros 'undefine)
@end example
@findex @code{viper-set-searchstyle-toggling-macros}
If you don't like this feature as a default, but would still like to have
it in some major modes, you can do so by first unsetting it globally, as
shown above, and then setting it in the desired major modes as follows:
@example
(viper-set-searchstyle-toggling-macros nil 'c-mode)
(viper-set-searchstyle-toggling-macros nil 'lisp-mode)
@end example
@item Vi-isms in Emacs state
Some people find it useful to use the Vi-style search key, `/', to invoke
search in modes which Viper leaves in emacs-state. These modes are:
@code{dired-mode}, @code{mh-folder-mode},
@code{Info-mode}, and @code{Buffer-menu-mode}
(more may be added in the future). So, in the above modes, Viper binds `/'
so that it will behave Vi-style. Furthermore, in those major modes, Viper
binds `:' to invoke ex-style commands, like in vi-state. And, as described
above, `//' and `///' get bound to Vi-style macros that toggle
case-insensitivity and regexp-search.
If you don't like these features---which I don't really understand---you
can unbind `/' and `:' in @code{viper-dired-modifier-map} (for Dired) or in
@code{viper-slash-and-colon-map}, for other modes.
@vindex @code{viper-slash-and-colon-map}
@vindex @code{viper-dired-modifier-map}
To unbind the macros `//' and `///' for a major mode where you feel they
are undesirable, execute @code{viper-set-emacs-state-searchstyle-macros} with a
non-@code{nil} argument. This can be done either interactively, by supplying a
prefix argument, or by placing
@example
(viper-set-emacs-state-searchstyle-macros 'undefine)
@end example
@findex @code{viper-set-emacs-state-searchstyle-macros}
in the hook to the major mode (e.g., @code{dired-mode-hook}).
@xref{Vi Macros}, for more information on Vi macros.
@item viper-heading-start
@item viper-heading-end
@cindex headings
@cindex sections
@cindex paragraphs
@cindex sentences
Regular Expressions for @kbd{[[} and @kbd{]]}. Note that Emacs defines
Regexps for paragraphs and sentences. @xref{Paragraphs,,Paragraphs and
Sentences,emacs,The GNU Emacs Manual}, for details.
@item M-x viper-set-expert-level
@findex @code{viper-set-expert-level}
Change your user level interactively.
@item viper-smart-suffix-list '("" "tex" "c" "cc" "el" "p")
@vindex @code{viper-smart-suffix-list}
Viper supports Emacs-style file completion when it prompts the user for a
file name. However, in many cases, the same directory may contain files
with identical prefix but different suffixes, e.g., prog.c, prog.o,
paper.tex, paper.dvi. In such cases, completion will stop at the `.'.
If the above variable is a list of strings representing suffixes, Viper will
try these suffixes
in the order listed and will check if the corresponding file exists.
For instance, if completion stopped at `paper.'@: and the user typed
@key{RET},
then Viper will check if the files `paper.', `paper.tex', `paper.c', etc., exist.
It will take the first such file. If no file exists, Viper will give a chance
to complete the file name by typing the appropriate suffix. If `paper.'@: was
the intended file name, hitting return will accept it.
To turn this feature off, set the above variable to @code{nil}.
@item viper-insertion-ring-size 14
@vindex @code{viper-insertion-ring-size}
@cindex Insertion ring
Viper remembers what was previously inserted in Insert and Replace states.
Several such recent insertions are kept in a special ring of strings of size
@code{viper-insertion-ring-size}.
If you enter Insert or Replace state you can reinsert strings from this
ring by typing @kbd{C-c M-p} or @kbd{C-c M-n}. The former will search the
ring in
the direction of older insertions, and the latter will search in
the direction of newer insertions. Hitting @kbd{C-c M-p} or @kbd{C-c M-n}
in succession
will undo the previous insertion from the ring and insert the next item on
the ring. If a larger ring size is needed, change the value of the above
variable in the @file{~/.viper} file.
Since typing these sequences of keys may be tedious, it is suggested that the
user should bind a function key, such as @kbd{f31}, as follows:
@example
(define-key viper-insert-global-user-map [f31]
'viper-insert-prev-from-insertion-ring)
@end example
This binds @kbd{f31} (which is usually @kbd{R11} on a Sun workstation)
to the function that inserts the previous string in the insertion history.
To rotate the history in the opposite
direction, you can either bind an unused key to
@code{viper-insert-next-from-insertion-ring} or hit any digit (1 to 9) then
@kbd{f31}.
One should not bind the above functions to @kbd{M-p} or @kbd{M-n}, since
this will interfere with the minibuffer histories and, possibly, other
major modes.
@item viper-command-ring-size 14
@vindex @code{viper-command-ring-size}
@cindex Destructive command ring
@cindex Destructive command history
Viper keeps track of the recent history of destructive
commands, such as @kbd{dw}, @kbd{i}, etc.
In Vi state,
the most recent command can be re-executed by hitting `@kbd{.}', as in Vi.
However, repeated typing @kbd{C-c M-p} will cause Viper to show the
previous destructive commands in the minibuffer. Subsequent hitting `@kbd{.}'
will execute the command that was displayed last.
The key @kbd{C-c M-n} will cycle through the command history in the
opposite direction.
Since typing @kbd{C-c M-p} may be tedious, it is more convenient to bind an
appropriate function to an unused function key on the keyboard and use that
key. For instance, the following
@example
(define-key viper-vi-global-user-map [f31]
'viper-prev-destructive-command)
@end example
binds the key @kbd{f31} (which is usually @kbd{R11} on a Sun workstation)
to the function that searches the command history in the direction of older
commands. To search in the opposite
direction, you can either bind an unused key to
@code{viper-next-destructive-command} or hit any digit (1 to 9) then @kbd{f31}.
One should not bind the above functions to @kbd{M-p} or @kbd{M-n}, since
this will interfere with the minibuffer histories and, possibly, other
major modes.
@item viper-minibuffer-vi-face 'viper-minibuffer-vi-face
@item viper-minibuffer-insert-face 'viper-minibuffer-insert-face
@item viper-minibuffer-emacs-face 'viper-minibuffer-emacs-face
These faces control the appearance of the minibuffer text in the
corresponding Viper states. You can change the appearance of these faces
through Emacs' customization widget, which is accessible through the
menubar.
Viper is located in this widget under the @emph{Emulations} customization
subgroup of the @emph{Editing} group. All Viper faces are grouped together
in Viper's @emph{Highlighting} customization subgroup.
Note that only the text you type in is affected by the above faces.
Prompts and minibuffer messages are not affected.
Purists who do not like adornments in the minibuffer can always zap them by
putting
@example
(copy-face 'default 'viper-minibuffer-vi-face)
(copy-face 'default 'viper-minibuffer-insert-face)
(copy-face 'default 'viper-minibuffer-emacs-face)
@end example
in the @file{~/.viper} file or through the customization widget, as
described above. However, in that case, the user will not have any
indication of the current Viper state in the minibuffer. (This is important
if the user accidentally switches to another Viper state by typing @key{ESC} or
@kbd{C-z}).
@item M-x viper-go-away
@findex @code{viper-go-away}
Make Viper disappear from the face of your running Emacs instance. If your
fingers start aching again, @kbd{M-x viper-mode} might save your day.
@item M-x toggle-viper-mode
@findex @code{toggle-viper-mode}
Toggle Viperization of Emacs on and off.
@end table
@cindex Multifile documents and programs
Viper provides some support for multi-file documents and programs.
If a document consists of several files we can designate one of them as a
master and put the following at the end of that file:
@lisp
;; Local Variables:
;; eval: (viper-setup-master-buffer "file1" "file2" "file3" "file4")
;; End:
@end lisp
@noindent
where @code{file1} to @code{file4} are names of files related to the master
file. Next time, when the master file is visited, the command
@code{viper-setup-master-buffer} will be evaluated and the above files will
be associated with the master file. Then, the new Ex command
@kbd{:RelatedFile} (abbr.@: @kbd{:R}) will display files 1 to 4 one after
another, so you can edit them. If a file is not in any Emacs buffer, it
will be visited. The command @kbd{PreviousRelatedFile} (abbr., @kbd{:P})
goes through the file list in the opposite direction.
@findex @kbd{:RelatedFile}
@findex @kbd{:PreviousRelatedFile}
These commands are akin to @kbd{:n} and @kbd{:N}, but they allow the user to
focus on relevant files only.
Note that only the master file needs to have the aforementioned block of
commands. Also, ";;" above can be replaced by some other
markers. Semicolon is good for Lisp programs, since it is considered a
comment designator there. For LaTeX, this could be "%%%", and for C the
above block should be commented out.
Even though these commands are sometimes useful, they are no substitute for
the powerful @emph{tag table} facility of Emacs. Viper's @kbd{:tag} command
in a primitive interface to Emacs tags. @xref{Tags,Tags,Tags,emacs,
The GNU Emacs Manual}, for more information on tags.
The following two commands are normally bound to a mouse click and are part
of Viper. They work only if Emacs runs as an application under X
Windows (or under some other window system for which a port of GNU Emacs 20
is available). Clicking the mouse when Emacs is invoked in an Xterm window
(using @code{emacs -nw}) will do no good.
@table @code
@cindex mouse
@cindex mouse-search
@item viper-mouse-search-key (meta shift 1)
@vindex @code{viper-mouse-insert-key}
This variable controls the @emph{mouse-search} feature of Viper. The
default value
states that holding Meta and Shift keys while clicking mouse button 1
should initiate search for a region under the mouse pointer (defined
below). This command can take a prefix argument, which indicates the
occurrence of the pattern to search for.
Note: while loading initially, Viper binds this mouse action only if it is
not already bound to something else. If you want to use the mouse-search
feature, and the @kbd{Meta-Shift-Mouse-1} mouse action is already bound to
something else, you can rebind the mouse-search feature by setting
@code{viper-mouse-search-key} to something else in your @code{~/.viper}
file:
@lisp
(setq viper-mouse-search-key '(meta 1))
@end lisp
This would bind mouse search to the action invoked by pressing the
Meta key and clicking mouse button 1. The allowed values of
@code{viper-mouse-search-key} are lists that contain a mouse-button number
(1,2, or 3) and any combination of the words `control', `meta', and
`shift'.
If the requested mouse action (e.g., (meta 1)) is already taken for other
purposes then you have to confirm your intention by placing the following
command in @code{~/.viper} after setting @code{viper-mouse-search-key}:
@lisp
(viper-bind-mouse-search-key 'force)
@end lisp
You can also change this setting interactively, through the customization
widget of Emacs (type @kbd{:customize}).
The region that is chosen as a pattern to search for is determined as
follows. If search is invoked via a single click, Viper chooses the region
that lies between the beginning of the ``word'' under the pointer (``word''
is understood in Vi sense) and the end of that word. The only difference
with Vi's words is that in Lisp major modes `-' is considered an
alphanumeric symbol. This is done for the convenience of working with Lisp
symbols, which often have an `-' in them. Also, if you click on a
non-alphanumeric character that is not a word separator (in Vi sense) then
this character will also be considered alphanumeric, provided that it is
adjacent (from either side) to an alphanumeric character. This useful
feature gives added control over the patterns selected by the mouse click.
On a double-click, the region is determined by the beginning of the current
Vi's ``Word'' (i.e., the largest non-separator chunk of text) and the End
of that ``Word'' (as determined by the @kbd{E} command).
On a triple-click, the region consists of the entire line where the click
occurred with all leading and trailing spaces and tabs removed.
@cindex mouse-insert
@item viper-mouse-insert-key (meta shift 2)
@vindex @code{viper-mouse-insert-key}
This variable controls the @emph{mouse-insert} feature of Viper.
The above default value states that
holding Meta and Shift keys while clicking mouse button 2
should insert the region surrounding the
mouse pointer. The rules defining this region are the same as for
mouse-search. This command takes an optional prefix argument, which
indicates how many such regions to snarf from the buffer and insert. (In
case of a triple-click, the prefix argument is ignored.)
Note: while loading initially, Viper binds this mouse action only if it not
already bound to something else. If you want to use this feature and the
default mouse action is already bound, you can rebind mouse-insert by
placing this command in @code{~/.viper}:
@lisp
(setq viper-mouse-insert-key '(meta 2))
@end lisp
If you want to bind mouse-insert to an action even if this action is
already taken for other purposes in Emacs, then you should add this command
to @code{~/.viper}, after setting @code{viper-mouse-insert-key}:
@lisp
(viper-bind-mouse-insert-key 'force)
@end lisp
This value can also be changed via the Emacs customization widget at the
menubar.
@item viper-multiclick-timeout
This variable controls the rate at which double-clicking must occur for the
purpose of mouse search and mouse insert. By default, this is set to
@code{double-click-time} in Emacs and to
@code{mouse-track-multi-click-time} milliseconds in XEmacs.
@end table
@kindex @kbd{S-Mouse-1}
@kindex @kbd{S-Mouse-2}
@kindex @kbd{meta shift button1up}
@kindex @kbd{meta shift button2up}
@vindex @code{viper-multiclick-timeout}
@findex @code{viper-mouse-click-insert-word}
@findex @code{viper-mouse-click-search-word}
Note: The above functions search and insert in the selected window of
the latest active frame. This means that you can click in another window or
another frame and have search or insertion done in the frame and window you
just left. This lets one use these functions in a multi-frame
configuration. However, this may require some getting used to. For
instance, if you are typing in a frame, A, and then move the mouse to frame
B and click to invoke mouse search, search (or insertion) will be performed
in frame A. To perform search/insertion in frame B, you will first have to
shift focus there, which doesn't happen until you type a character or
perform some other action in frame B---mouse search doesn't shift focus.
If you decide that you don't like the above feature and always want
search/insertion be performed in the frame where the click occurs, don't
bind (and unbind, if necessary) @code{viper-mouse-catch-frame-switch} from
the mouse event it is bound to.
Mouse search is integrated with Vi-style search, so you can
repeat it with @kbd{n} and @kbd{N}. It should be also noted that, while
case-sensitivity of search in Viper is controlled by the variable
@code{viper-case-fold-search}, the case of mouse search is
controlled by the Emacs variable @code{case-fold-search}, which may be set
differently from @code{viper-case-fold-search}. Therefore, case-sensitivity
of mouse search may be different from that of the usual Vi-style search.
Finally, if the way Viper determines the word to be searched for or to be
inserted is not what you want, there is a variable,
@code{viper-surrounding-word-function}, which can be changed to indicate
another function for snarfing words out of the buffer. The catch is that
you will then have to write such a function and make it known to your
Emacs. The function @code{viper-surrounding-word} in @file{viper.el} can be
used as a guiding example.
@node Vi Macros, ,Viper Specials,Customization
@section Vi Macros
@cindex Vi macros
Viper supports much enhanced Vi-style macros and also facilitates the use
of Emacs-style macros. To define a temporary macro, it is generally more
convenient to use Emacs keyboard macro facility. Emacs keyboard macros are
usually defined anonymously, and the latest macro can be executed by typing
@kbd{C-x e} (or @kbd{*}, if Viper is in Vi state). If you need to use several
temporary macros, Viper lets you save them to a
register (a lowercase letter); such macros can then be executed by typing
@kbd{@@a} in Vi state (if a macro was previously saved in register
@kbd{a}).
@xref{Macros and Registers}, for details.
If, however, you need to use a macro regularly, it must be given a
permanent name and saved. Emacs manual explains how to do this, but
invocation of named Emacs macros is quite different from Vi's. First,
invocation of permanent Emacs macros takes time because it requires typing
too many keys (to a Vi user's taste, anyway).
Second, binding such macros to function keys, for
fast access, hogs valuable real estate on the keyboard.
Vi-style macros are better in that respect, since Vi lets the user overload
the meaning of key sequences: keys typed in fast succession are treated
specially, if this key sequence is bound to a macro.
Viper provides Vi-style keyboard macros through the usual Ex commands,
@kbd{:map} and
@kbd{:map!}. These macros are much more powerful in Viper than
they are in the original Vi and in other emulators. This is because Viper
implements an enhanced vi-style
interface to the powerful Emacs keyboard macro facility.
First, any Emacs
command can be executed while defining a macro, not just the Vi
commands. In particular, the user can invoke Emacs commands via @kbd{M-x
command-name} or by pressing various function keys on the keyboard. One
can even use the mouse, although this is usually not useful and is not
recommended (and macros defined with the use of the mouse cannot be saved in
command history and in the startup file, for future use).
Macros defined by mixing Vi and Emacs commands are represented as
vectors. So, don't be confused when you see one (usually through the
history of Ex commands). For instance, if @kbd{gg} is defined by typing
@kbd{l}, the up-arrow key and @kbd{M-x next-line}, its definition will look
as follows in Emacs (in XEmacs, it looks slightly different, see below):
@example
[l up (meta x) n e x t - l i n e return]
@end example
Second, Viper macros are defined in a WYSIWYG style. This means that
commands are executed as you type them, so you can see precisely what is
being defined. Third, macros can be bound to arbitrary sequences of keys,
not just to printable keys. For instance, one can define a macro that will
be invoked by hitting @kbd{f3} then @kbd{f2} function keys. (The keys
@kbd{delete} and @kbd{backspace} are excluded; also, a macro invocation
sequence can't start with @key{ESC}. Some other keys, such as @kbd{f1} and
@kbd{help}, can't be bound to macros under Emacs, since they
are bound in @code{key-translation-map}, which overrides any other binding
the user gives to keys. In general, keys that have a binding in
@code{key-translation-map} can't be bound to a macro.)
Fourth, in Viper, one can define macros that are specific to a given
buffer, a given major mode, or macros that are defined for all buffers. In
fact, the same macro name can have several different definitions: one
global, several definitions for various major modes, and
definitions for various specific buffers. Buffer-specific definitions
override mode-specific definitions, which, in turn, override global
definitions.
As if all that is not enough, Viper (through its interface to Emacs
macros) lets the user define keyboard macros that ask for confirmation or
even prompt the user for input and then continue. To do this, one should
type @kbd{C-x q} (for confirmation) or @kbd{C-u C-x q} (for prompt).
For details, @pxref{Keyboard Macro Query,,Customization,emacs,The GNU Emacs
Manual} @refill
When the user finishes defining a macro (which is done by typing @kbd{C-x)} ---
a departure from Vi), you will be asked whether you want this
macro to be global, mode-specific, or buffer-specific. You will also be
given a chance to save the macro in your @file{~/.viper} file.
This is the easiest way to save a macro and make
it permanently available. If you work your startup files with bare hands,
here is how Viper saves the above macro so that it will be
available in Viper's Insert state (and Replace state) in buffer @code{my-buf}
only:
@example
(viper-record-kbd-macro "gg" 'insert-state
[l up (meta x) n e x t - l i n e return]
"my-buf")
@end example
@noindent
To do the same for Vi state and all buffers with the major mode
@code{cc-mode}, use:
@example
(viper-record-kbd-macro "gg" 'vi-state
[l up (meta x) n e x t - l i n e return]
'cc-mode)
@end example
@noindent
Both macro names and macro definitions are vectors of symbols that denote
keys on the keyboard. Some keys, like @kbd{\}, @kbd{ }, or digit-keys must
be escaped with a backslash. Modified keys are represented as lists. For
instance, holding Meta and Control and pressing @kbd{f4} is represented as
@kbd{(control meta f4)}.
If all members of a vectors are printable characters (or sequences, such as
@kbd{\e}, @kbd{\t}, for @key{ESC} and @key{TAB}), then they can also be represented as
strings:
@example
(viper-record-kbd-macro "aa" 'vi-state "aaa\e" "my-buffer")
@end example
@noindent
Thus, typing @kbd{aa} fast in Vi state will switch Viper to Insert state
(due to the first @kbd{a}), insert @kbd{aa}, and then it will switch back to Vi
state. All this will take effect only in the buffer named @code{my-buffer}.
Note that the last argument to @code{viper-record-kbd-macro} must be either a
string (a buffer name), a symbol representing a major mode, or @code{t};
the latter says that the macro is to be defined for all buffers
(which is how macros are defined in original Vi).
For convenience, Viper also lets you define Vi-style macros in its Emacs
state. There is no Ex command, like @kbd{:map} and @kbd{:map!} for doing
this, but the user can include such a macro in the @file{~/.viper} file. The
only thing is that the @code{viper-record-kbd-macro} command should specify
@code{emacs-state} instead of @code{vi-state} or @code{insert-state}.
The user can get rid of a macro either by using the Ex commands @kbd{:unmap}
and @kbd{:unmap!} or by issuing a call to @code{viper-unrecord-kbd-macro}.
The latter is more powerful, since it can delete macros even in
@code{emacs-state}. However, @code{viper-unrecord-kbd-macro} is usually
needed only when the user needs to get rid of the macros that are already
predefined in Viper.
The syntax is:
@findex @code{viper-unrecord-kbd-macro}
@example
(viper-unrecord-kbd-macro macro state)
@end example
@noindent
The second argument must be @code{vi-state}, @code{insert-state}, or
@code{emacs-state}. The first argument is a name of a macro. To avoid
mistakes in specifying names of existing macros, type @kbd{M-x
viper-describe-kbd-macros} and use a name from the list displayed by this
command.
If an error occurs during macro definition, Emacs
aborts the process, and it must be repeated. This is analogous to Vi,
except that in Vi the user doesn't know there is an error until the macro is
actually run. All that means that in order for a definition to be
successful, the user must do some simple planning of the process in
advance, to avoid errors. For instance, if you want to map @kbd{gg} to
@kbd{llll} in Vi state, you must make sure that there is enough room on the
current line. Since @kbd{l} moves the cursor forward, it may signal an
error on reaching the end of line, which will abort the definition.
These precautions are necessary only when defining macros; they will help
avoid the need to redo the job. When macros are actually run, an error
during the execution will simply terminate the current execution
(but the macro will remain mapped).
A macro name can be a string of characters or a vector of keys.
The latter makes it possible to define macros bound to, say, double-hits
on a function key, such as @kbd{up} or @kbd{f13}.
This is very useful if you run out of function keys on your keyboard; it
makes Viper macro facility a @emph{keyboard doubler}, so to speak.
Elsewhere (@xref{Key Bindings}, for details), we review
the standard Emacs mechanism for binding function keys to commands.
For instance,
@example
(global-set-key [f13] 'repeat-complex-command)
@end example
@noindent
binds the key f13 to the Emacs function that repeats the last minibuffer
command. Under Viper, however, you may still use this key for additional
purposes, if you bind, say, a double-hitting action for that key to some
other function. Emacs doesn't allow the user to do that, but Viper does
this through its keyboard macro facility. To do this, type @kbd{:map }
first. When you are asked to enter a macro name, hit f13 twice, followed by
@key{RET} or @key{SPC}.
Emacs will now start the mapping process by actually executing
Vi and Emacs commands, so that you could see what will happen each time the
macro is executed. Suppose now we wanted to bind the key sequence
@kbd{f13 f13} to the command @code{eval-last-sexp}. To accomplish this, we
can type @kbd{M-x eval-last-sexp} followed by @kbd{C-x )}.
If you answer positively to Viper's offer to save this macro in @file{~/.viper}
for future uses, the following will be inserted in that file:
@example
(viper-record-kbd-macro [f16 f16] 'vi-state
[(meta x) e v a l - l a s t - s e x p]
'lisp-interaction-mode)
@end example
To illustrate the above point, Viper provides two canned macros, which, by
default, are bound to @kbd{[f12 \1]} and @kbd{[f12 \2]} (invoked by typing
@kbd{f12} then @kbd{1} and @kbd{2}, respectively). These macros are useful
shortcuts to Viper's command ring history. The first macro will execute the
second-last destructive command (the last one is executed by @kbd{.}, as
usual). The second macro executes the third-last command.
If you need to go deeper into the command history, you will have to use
other commands, as described earlier in this section; or you can bind,
say, @kbd{f12 \3} like this:
@example
(viper-record-kbd-macro [f12 \3] 'vi-state
[(meta x) r e p e a t - f r o m - h i s t o r y]
t)
@end example
Note that even though the macro uses the function key @kbd{f12}, the key is
actually free and can still be bound to some Emacs function via
@code{define-key} or @code{global-set-key}.
Viper allows the user to define macro names that are prefixes of other macros.
For instance, one can define @kbd{[[} and @kbd{[[[[} to be macros.
If you type the exact sequence of such keys and then pause, Viper will
execute the right macro. However, if you don't pause and, say, type
@kbd{[[[[text} then the conflict is resolved as follows. If only one of the
key sequences, @kbd{[[} or @kbd{[[[[} has a definition applicable to the
current buffer, then, in fact, there is no conflict and the right macro
will be chosen. If both have applicable definitions, then the first one
found will be executed. Usually this is the macro with a shorter name. So,
in our case, @kbd{[[[[text} will cause the macro @kbd{[[} to be executed
twice and then the remaining keys, @kbd{t e x t}, will be processed.
When defining macros using @kbd{:map} or @kbd{:map!}, the user enters
the actually keys to be used to invoke the macro. For instance, you
should hit the actual key @kbd{f6} if it is to be part of a macro
name; you do @emph{not} write @kbd{f 6}. When entering keys, Viper
displays them as strings or vectors (e.g., @code{"abc"} or @code{[f6
f7 a]}). The same holds for unmapping. Hitting @key{TAB} while
typing a macro name in the @kbd{:unmap} or @kbd{:unmap!} command will
cause name completion. Completions are displayed as strings or
vectors. However, as before, you don't actually type @samp{"},
@samp{[}, or @samp{]} that appear in the completions. These are
meta-symbols that indicate whether the corresponding macro name is a
vector or a string.
One last difference from Vi: Vi-style keyboard macros cannot be defined in
terms of other Vi-style keyboard macros (but named Emacs macros are OK).
More precisely, while defining or executing a macro, the special meaning
of key sequences (as Vi macros) is ignored.
This is because it is all too easy to create an infinite loop in this way.
Since Viper macros are much more powerful than Vi's it is impossible to
detect such loops. In practice, this is not really a limitation but,
rather, a feature.
We should also note that Vi macros are disabled in the minibuffer, which
helps keep some potential troubles away.
The rate at which the user must type keys in order for them to be
recognized as a timeout macro is controlled by the variable
@code{viper-fast-keyseq-timeout}, which defaults to 200 milliseconds.
For the most part, Viper macros defined in @file{~/.viper} can be shared
between Emacs, XEmacs, and X and TTY modes. However, macros defined via
function keys may need separate definitions when XEmacs and Emacs have
different names for the same keyboard key. For instance, the `Page Up' key
may be known in Emacs as @kbd{prior} and in XEmacs as @kbd{pgup}.
The problem with TTY may be that the function keys there generate sequences
of events instead of a single event (as under a window system).
Emacs maps some of these sequences back to the logical keys
(e.g., the sequences generated by the arrow keys are mapped to @kbd{up},
@kbd{left}, etc.). However, not all function keys are mapped in this way.
Macros that are bound to key sequences that contain such unmapped function
keys have to be redefined for TTY's (and possibly for every type of TTY you
may be using). To do this, start Emacs on an appropriate TTY device and
define the macro using @kbd{:map}, as usual.
@findex @code{viper-describe-kbd-macros}
Finally, Viper provides a function that conveniently displays all macros
currently defined. To see all macros along with their definitions, type
@kbd{M-x viper-describe-kbd-macros}.
@node Commands,,Customization,Top
@chapter Commands
This section is a semi-automatically bowdlerized version of the Vi
reference created by @* @samp{maart@@cs.vu.nl} and others. It can be
found on the Vi archives. This reference has been adapted for Viper.@refill
@menu
* Groundwork:: Textual Conventions and Viper basics
* Text Handling:: Moving, Editing, Undoing.
* Display:: Scrolling.
* File and Buffer Handling:: Editing, Writing and Quitting.
* Mapping:: Mapping Keys, Keyboard Macros
* Shell Commands:: Accessing Shell Commands, Processing Text
* Options:: Ex options, the @kbd{:set} commands
* Emacs Related Commands:: Meta Keys, Windows
* Mouse-bound Commands:: Search and insertion of text
@end menu
@node Groundwork, Text Handling, Commands, Commands
@comment node-name, next, previous, up
@section Groundwork
The VI command set is based on the idea of combining motion commands
with other commands. The motion command is used as a text region
specifier for other commands.
We classify motion commands into @dfn{point commands} and
@dfn{line commands}.@refill
@cindex point commands
The point commands are:
@quotation
@kbd{h}, @kbd{l}, @kbd{0}, @kbd{$}, @kbd{w}, @kbd{W}, @kbd{b}, @kbd{B},
@kbd{e}, @kbd{E}, @kbd{(}, @kbd{)}, @kbd{/}, @kbd{?}, @kbd{`}, @kbd{f},
@kbd{F}, @kbd{t}, @kbd{T}, @kbd{%}, @kbd{;}, @kbd{,}, @kbd{^}
@end quotation
@cindex line commands
The line commands are:
@quotation
@kbd{j}, @kbd{k}, @kbd{+}, @kbd{-}, @kbd{H}, @kbd{M}, @kbd{L}, @kbd{@{},
@kbd{@}}, @kbd{G}, @kbd{'}, @kbd{[[}, @kbd{]]}, @kbd{[]}
@end quotation
@noindent
Text Deletion Commands (@pxref{Deleting Text}), Change commands
(@pxref{Changing Text}), even Shell Commands (@pxref{Shell Commands})
use these commands to describe a region of text to operate on.
@cindex r and R region specifiers
Viper adds two region descriptors, @kbd{r} and @kbd{R}. These describe
the Emacs regions (@pxref{Basics}), but they are not movement commands.
The command description uses angle brackets @samp{<>} to indicate
metasyntactic variables, since the normal conventions of using simple
text can be confusing with Viper where the commands themselves are
characters. Watch out where @kbd{} are
mentioned together!!!
@kindex
@kindex
@kindex
@cindex
@cindex
@cindex
@cindex movements
@samp{} refers to the above movement commands, and @samp{}
refers to registers or textmarkers from @samp{a} to @samp{z}. Note
that the @samp{} is described by full move commands, that is to
say they will take counts, and otherwise behave like normal move commands.
@cindex Ex addresses
@samp{} refers to Ex line addresses, which include
@table @kbd
@item .@:
Current line
@item .+n .-n
Add or subtract for current line
@item number
Actual line number, use @kbd{.=} to get the line number
@item '
Textmarker
@item $
Last line
@item x,y
Where x and y are one of the above
@item %
@cindex % (Ex address)
For the whole file, same as (1,$).
@item //
@itemx ??
Next or previous line with pattern .
Note that the pattern is allowed to contain newline character (inserted as
@kbd{C-qC-j}). Therefore, one can search for patterns that span several
lines.
@end table
@cindex % (Current file)
Note that @samp{%} is used in Ex commands @kbd{:e} and @kbd{:r }
to mean current file. If you want a @samp{%} in your command, it must be
escaped as @samp{\%}. Note that @kbd{:w} and the regular @kbd{:r }
command doesn't support the meta symbols @samp{%} and @samp{#}, because
file history is a better mechanism.
@cindex # (Previous file)
Similarly, @samp{#} expands to the previous file. The previous file is
the first file in @kbd{:args} listing. This defaults to previous window
in the VI sense if you have one window only.
@kindex
@kindex
@cindex
@cindex
@noindent
Others like @samp{ -- arguments}, @samp{ -- command} etc.
should be fairly obvious.
@noindent
Common characters referred to include:
@table @kbd
@item
Space
@item
Tab
@item
Linefeed
@item
Escape
@item
Return, Enter
@end table
@cindex
@cindex
@cindex
@cindex
@cindex
@cindex words
@cindex WORDS
@cindex char
@cindex CHAR
We also use @samp{word} for alphanumeric/non-alphanumeric words, and
@samp{WORD} for whitespace delimited words. @samp{char} refers to any
@acronym{ASCII} character, @samp{CHAR} to non-whitespace character.
Brackets @samp{[]} indicate optional parameters; @samp{} also
optional, usually defaulting to 1. Brackets are elided for
@samp{} to eschew obfuscation.
Viper's idea of Vi's words is slightly different from Vi. First, Viper
words understand Emacs symbol tables. Therefore, all symbols declared to be
alphanumeric in a symbol table can automatically be made part of the Viper
word. This is useful when, for instance, editing text containing European,
Cyrillic, Japanese, etc., texts.
Second, Viper lets you depart from Vi's idea of a word by changing the a
syntax preference via the customization widget (the variable
@code{viper-syntax-preference}) or by executing
@code{viper-set-syntax-preference} interactively.
By default, Viper syntax preference is @code{reformed-vi}, which means that
Viper considers only those symbols to be part of a word that are specified
as word-symbols by the current Emacs syntax table (which may be different
for different major modes) plus the underscore symbol @kbd{_}, minus the
symbols that are not considered words in Vi (e.g., `,',;, etc.), but may be
considered as word-symbols by various Emacs major modes. Reformed-Vi works
very close to Vi, and it also recognizes words in other
alphabets. Therefore, this is the most appropriate mode for editing text
and is likely to fit all your needs.
You can also set Viper syntax preference to @code{strict-vi}, which would
cause Viper to view all non-English letters as non-word-symbols.
You can also specify @code{emacs} as your preference, which would
make Viper use exactly the same notion of a word as Emacs does. In
particular, the underscore may not be part of a word in some major modes.
Finally, if @code{viper-syntax-preference} is set to @code{extended}, Viper
words would consist of characters that are classified as alphanumeric
@emph{or} as parts of symbols. This is convenient for editing programs.
@code{viper-syntax-preference} is a local variable, so it can have different
values for different major modes. For instance, in programming modes it can
have the value @code{extended}. In text modes where words contain special
characters, such as European (non-English) letters, Cyrillic letters, etc.,
the value can be @code{reformed-vi} or @code{emacs}.
If you consider using different syntactic preferences for different major
modes, you should execute, for example,
@example
(viper-set-syntax-preference nil "extended")
@end example
in the appropriate major mode hooks.
@vindex @code{viper-syntax-preference}
@findex @code{viper-set-syntax-preference}
@cindex syntax table
The above discussion concerns only the movement commands. In regular
expressions, words remain the same as in Emacs. That is, the expressions
@code{\w}, @code{\>}, @code{\ h C-h
chars to the left.
@item j C-n
lines downward.
@item l chars to the right.
@item k C-p
lines upward.
@item $
To the end of line from the cursor.
@item ^
To the first CHAR - 1 lines lower.
@item -
To the first CHAR lines higher.
@item +
To the first CHAR lines lower.
@item 0
To the first char of the line.
@item |
To column
@item fs to the right (find).
@item t
Till before s to the right.
@item Fs to the left.
@item T
Till after s to the left.
@item ;
Repeat latest @kbd{f t F T} times.
@item ,
Repeat latest @kbd{f t F T}
times in opposite direction.
@item w
words forward.
@item W
WORDS forward.
@item b
words backward.
@item B
WORDS backward.
@item e
To the end of word forward.
@item E
To the end of WORD forward.
@item G
Go to line (default end-of-file).
@item H
To line from top of the screen (home).
@item L
To line from bottom of the screen (last).
@item M
To the middle line of the screen.
@item )
sentences forward.
@item (
sentences backward.
@item @}
paragraphs forward.
@item @{
paragraphs backward.
@item ]]
To the th heading.
@item [[
To the th previous heading.
@item []
To the end of th heading.
@item m
Mark the cursor position with a letter.
@item `
To the mark.
@item '
To the first CHAR of the line with the mark.
@item [
Show contents of textmarker.
@item ]
Show contents of register.
@item ``
To the cursor position before the latest absolute
jump (of which are examples @kbd{/} and @kbd{G}).
@item ''
To the first CHAR of the line on which the cursor
was placed before the latest absolute jump.
@item /
To the th occurrence of .
@item /
To the th occurrence of from previous @kbd{/ or ?}.
@item ?
To the th previous occurrence of .
@item ?
To the th previous occurrence of from previous @kbd{?@: or /}.
@item n
Repeat latest @kbd{/} @kbd{?} (next).
@item N
Repeat latest search in opposite direction.
@item C-c /
Without a prefix argument, this command toggles
case-sensitive/case-insensitive search modes and plain vanilla/regular
expression search. With the prefix argument 1, i.e.,
@kbd{1 C-c /}, this toggles case-sensitivity; with the prefix argument 2,
toggles plain vanilla search and search using
regular expressions. @xref{Viper Specials}, for alternative ways to invoke
this function.
@cindex vanilla search
@cindex case-sensitive search
@cindex case-insensitive search
@item %
Find the next bracket/parenthesis/brace and go to its match.
By default, Viper ignores brackets/parentheses/braces that occur inside
parentheses. You can change this by setting
@code{viper-parse-sexp-ignore-comments} to @code{nil} in your @file{.viper} file.
This option can also be toggled interactively if you quickly hit @kbd{%%%}.
This latter feature is implemented as a vi-style keyboard macro. If you
don't want this macro, put
@example
(viper-set-parsing-style-toggling-macro 'undefine)
@end example
@findex @code{viper-set-parsing-style-toggling-macro}
in your @file{~/.viper} file.
@end table
@kindex @kbd{%}
@kindex @kbd{C-c /}
@kindex @kbd{N}
@kindex @kbd{n}
@kindex @kbd{?}
@kindex @kbd{/}
@kindex @kbd{?}
@kindex @kbd{/}
@kindex @kbd{''}
@kindex @kbd{``}
@kindex @kbd{]}
@kindex @kbd{[}
@kindex @kbd{'}
@kindex @kbd{`}
@kindex @kbd{m}
@kindex @kbd{[]}
@kindex @kbd{[[}
@kindex @kbd{]]}
@kindex @kbd{@{}
@kindex @kbd{@}}
@kindex @kbd{(}
@kindex @kbd{)}
@kindex @kbd{M}
@kindex @kbd{L}
@kindex @kbd{H}
@kindex @kbd{G}
@kindex @kbd{E}
@kindex @kbd{e}
@kindex @kbd{B}
@kindex @kbd{b}
@kindex @kbd{W}
@kindex @kbd{w}
@kindex @kbd{,}
@kindex @kbd{;}
@kindex @kbd{T}
@kindex @kbd{F}
@kindex @kbd{t}
@kindex @kbd{f}
@kindex @kbd{|}
@kindex @kbd{0}
@kindex @kbd{}
@kindex @kbd{+}
@kindex @kbd{-}
@kindex @kbd{^}
@kindex @kbd{$}
@kindex @kbd{C-p}
@kindex @kbd{}
@kindex @kbd{}
@kindex @kbd{C-n}
@kindex @kbd{C-h}
@kindex @kbd{h}
@kindex @kbd{j}
@kindex @kbd{k}
@kindex @kbd{l}
@vindex @code{viper-parse-sexp-ignore-comments}
@node Marking,Appending Text,Move Commands,Text Handling
@subsection Marking
Emacs mark is referred to in the region specifiers @kbd{r} and @kbd{R}.
@xref{Emacs Preliminaries}, and @xref{Basics}, for explanation. Also
see @ref{Mark,,Mark,emacs,The GNU Emacs manual}, for an explanation of
the Emacs mark ring.
@cindex marking
@table @kbd
@item m
Mark the current file and position with the specified letter.
@item m .
Set the Emacs mark (@pxref{Emacs Preliminaries}) at point.
@item m ^
Set the Emacs mark (@pxref{Emacs Preliminaries}) back to where it was last
set with the @kbd{m.} command. This is useful when you set the mark with
@kbd{m.}, but then some other command (such as @kbd{L} or @kbd{G}) changes
it in a way that you didn't like.
@item m <
Set the Emacs mark at beginning of buffer.
@item m >
Set the Emacs mark at end of buffer.
@item m ,
Jump to the Emacs mark.
@item :mark
Mark position with text marker named . This is an Ex command.
@item :k
Same as @kbd{:mark}.
@item ``
Exchange point and mark.
@item ''
Exchange point and mark and go to the first CHAR on line.
@item '
Go to specified Viper mark.
@item
Go to specified Viper mark and go to the first CHAR on line.
@end table
@kindex @kbd{m}
@kindex @kbd{m.}
@kindex @kbd{m>}
@kindex @kbd{m}
@kindex @kbd{'}
@node Appending Text, Editing in Insert State, Marking,Text Handling
@subsection Appending Text
@xref{Options}, to see how to change tab and shiftwidth size. See the GNU
Emacs manual, or try @kbd{C-ha tabs} (If you have turned Emacs help on).
Check out the variable @code{indent-tabs-mode} to put in just spaces.
Also see options for word-wrap.
@cindex inserting
@cindex appending
@cindex paste
@cindex put
@table @kbd
@item a
times after the cursor.
@item A
times at the end of line.
@item i
times before the cursor (insert).
@item I
times before the first CHAR of the line
@item o
On a new line below the current (open).
The count is only useful on a slow terminal.
@item O
On a new line above the current.
The count is only useful on a slow terminal.
@item >
Shift the lines described by one
shiftwidth to the right (layout!).
@item >>
Shift lines one shiftwidth to the right.
@item ["]p
Put the contents of the (default undo) buffer
times after the cursor. The register will
be automatically down-cased.
@item ["]P
Put the contents of the (default undo) buffer
times before the cursor. The register will
@item [
Show contents of textmarker.
@item ]
Show contents of register.
@item .
Repeat previous command times. For destructive
commands as well as undo.
@item f1 1 and f1 2
While @kbd{.} repeats the last destructive command,
these two macros repeat the second-last and the third-last destructive
commands. @xref{Vi Macros}, for more information on Vi macros.
@item C-c M-p and C-c M-n
In Vi state,
these commands help peruse the history of Vi's destructive commands.
Successive typing of @kbd{C-c M-p} causes Viper to search the history in
the direction
of older commands, while hitting @kbd{C-c M-n} does so in reverse
order. Each command in the history is displayed in the minibuffer. The
displayed command can
then be executed by typing `@kbd{.}'.
Since typing the above sequences of keys may be tedious, the
functions doing the perusing can be bound to unused keyboard keys in the
@file{~/.viper} file. @xref{Viper Specials}, for details.
@end table
@kindex @kbd{C-c M-p}
@kindex @kbd{C-c M-n}
@kindex @kbd{.}
@kindex @kbd{]}
@kindex @kbd{[}
@kindex @kbd{P}
@kindex @kbd{p}
@kindex @kbd{"p}
@kindex @kbd{"P}
@kindex @kbd{>>}
@kindex @kbd{>}
@kindex @kbd{O}
@kindex @kbd{o}
@kindex @kbd{i}
@kindex @kbd{A}
@kindex @kbd{a}
@node Editing in Insert State, Deleting Text, Appending Text,Text Handling
@subsection Editing in Insert State
Minibuffer can be edited similarly to Insert state, and you can switch
between Insert/Replace/Vi states at will.
Some users prefer plain Emacs feel in the minibuffer. To this end, set
@var{viper-vi-style-in-minibuffer} to @code{nil}.
@cindex Insert state
@table @kbd
@item C-v
Deprive the next char of its special meaning (quoting).
@item C-h
One char back.
@item C-w
One word back.
@item C-u
Back to the begin of the change on the
current line.
@end table
@kindex @kbd{C-u}
@kindex @kbd{C-w}
@kindex @kbd{C-v}
@node Deleting Text, Changing Text, Editing in Insert State, Text Handling
@subsection Deleting Text
There is one difference in text deletion that you should be
aware of. This difference comes from Emacs and was adopted in Viper
because we find it very useful. In Vi, if you delete a line, say, and then
another line, these two deletions are separated and are put back
separately if you use the @samp{p} command. In Emacs (and Viper), successive
series of deletions that are @emph{not interrupted} by other commands are
lumped together, so the deleted text gets accumulated and can be put back
as one chunk. If you want to break a sequence of deletions so that the
newly deleted text could be put back separately from the previously deleted
text, you should perform a non-deleting action, e.g., move the cursor one
character in any direction.
@cindex shifting text
@table @kbd
@item x
Delete chars under and after the cursor.
@item X
Delete chars before the cursor.
@item d
Delete from point to endpoint of .
@item dd
Delete lines.
@item D
The rest of the line.
@item <
Shift the lines described by one
shiftwidth to the left (layout!).
@item <<
Shift lines one shiftwidth to the left.
@end table
@kindex @kbd{<}
@kindex @kbd{D}
@kindex @kbd{dd}
@kindex @kbd{d}
@kindex @kbd{X}
@kindex @kbd{x}
@node Changing Text, Search and Replace, Deleting Text,Text Handling
@subsection Changing Text
@cindex joining lines
@cindex changing case
@cindex quoting regions
@cindex substitution
@table @kbd
@item r
Replace chars by - no .
@item R
Overwrite the rest of the line,
appending change @var{count - 1} times.
@item s
Substitute chars.
@item S
Change lines.
@item c
Change from begin to endpoint of .
@item cc
Change lines.
@item C
The rest of the line and - 1 next lines.
@item =
Reindent the region described by move.
@item ~
Switch lower and upper cases.
@item J
Join lines (default 2).
@item :[x,y]s///
Substitute (on lines x through y) the pattern
(default the last pattern) with . Useful
flags are @samp{g} for @samp{global} (i.e.@: change every
non-overlapping occurrence of