2013-10-23 Glenn Morris <rgm@gnu.org>
+ * files.texi, glossary.texi, killing.texi, search.texi, sending.texi:
+ Nuke @refill.
+
* Makefile.in (install-dvi, install-html, install-pdf)
(install-ps, uninstall-dvi, uninstall-html, uninstall-ps)
(uninstall-pdf): Quote entities that might contain whitespace.
restores the contents from its auto-save file @file{#@var{file}#}.
You can then save with @kbd{C-x C-s} to put the recovered text into
@var{file} itself. For example, to recover file @file{foo.c} from its
-auto-save file @file{#foo.c#}, do:@refill
+auto-save file @file{#foo.c#}, do:
@example
M-x recover-file @key{RET} foo.c @key{RET}
minibuffer (q.v.@:) arguments when the set of possible valid inputs
is known; for example, on command names, buffer names, and
file names. Completion usually occurs when @key{TAB}, @key{SPC} or
-@key{RET} is typed. @xref{Completion}.@refill
+@key{RET} is typed. @xref{Completion}.
@anchor{Glossary---Continuation Line}
@item Continuation Line
tells the following command, if it is a kill command, to append the text
it kills to the last killed text, instead of starting a new entry. With
@kbd{C-M-w}, you can kill several separated pieces of text and
-accumulate them to be yanked back in one place.@refill
+accumulate them to be yanked back in one place.
A kill command following @kbd{M-w} (@code{kill-ring-save}) does not
append to the text that @kbd{M-w} copied into the kill ring.
tries to match all three @samp{a}s; but the rest of the pattern is
@samp{ar} and there is only @samp{r} left to match, so this try fails.
The next alternative is for @samp{a*} to match only two @samp{a}s.
-With this choice, the rest of the regexp matches successfully.@refill
+With this choice, the rest of the regexp matches successfully.
@item @kbd{+}
is a postfix operator, similar to @samp{*} except that it must match
match @var{a}, and if that fails, by trying to match @var{b}.
Thus, @samp{foo\|bar} matches either @samp{foo} or @samp{bar}
-but no other string.@refill
+but no other string.
@samp{\|} applies to the largest possible surrounding expressions. Only a
surrounding @samp{\( @dots{} \)} grouping can limit the grouping power of
-@samp{\|}.@refill
+@samp{\|}.
Full backtracking capability exists to handle multiple uses of @samp{\|}.
To enclose a complicated expression for the postfix operators @samp{*},
@samp{+} and @samp{?} to operate on. Thus, @samp{ba\(na\)*} matches
@samp{bananana}, etc., with any (zero or more) number of @samp{na}
-strings.@refill
+strings.
@item
To record a matched substring for future reference.
matches the empty string, but only at the beginning or
end of a word. Thus, @samp{\bfoo\b} matches any occurrence of
@samp{foo} as a separate word. @samp{\bballs?\b} matches
-@samp{ball} or @samp{balls} as a separate word.@refill
+@samp{ball} or @samp{balls} as a separate word.
@samp{\b} matches at the beginning or end of the buffer
regardless of what text appears next to it.
you specify searching for @samp{foo}, then @samp{Foo} and @samp{foo}
also match. Regexps, and in particular character sets, behave
likewise: @samp{[ab]} matches @samp{a} or @samp{A} or @samp{b} or
-@samp{B}.@refill
+@samp{B}.
An upper-case letter anywhere in the incremental search string makes
the search case-sensitive. Thus, searching for @samp{Foo} does not find
where @var{fulladdresses} can be either a single address, or multiple
addresses separated with spaces. For instance, to make @code{maingnu}
stand for @code{gnu@@gnu.org} plus a local address of your own, put in
-this line:@refill
+this line:
@example
alias maingnu gnu@@gnu.org local-gnu
2013-10-23 Glenn Morris <rgm@gnu.org>
+ * eval.texi, files.texi, intro.texi, objects.texi, searching.texi:
+ Nuke @refill.
+
* Makefile.in (install-dvi, install-html, install-pdf)
(install-ps, uninstall-dvi, uninstall-html, uninstall-ps)
(uninstall-pdf): Quote entities that might contain whitespace.
2013-10-19 Xue Fuqiao <xfq.free@gmail.com>
- * display.texi (Face Attributes): Add indexes for the ‘:box’ face attribute.
+ * display.texi (Face Attributes): Add indexes for the ‘:box’
+ face attribute.
2013-10-18 Xue Fuqiao <xfq.free@gmail.com>
doesn't exist in Common Lisp. @code{throw} is a special form in
Common Lisp (because it must be able to throw multiple values), but it
is a function in Emacs Lisp (which doesn't have multiple
-values).@refill
+values).
@end quotation
@node Autoloading
In the following example, suppose that @file{~rms/lewis} is the current
default directory, and has five files whose names begin with @samp{f}:
@file{foo}, @file{file~}, @file{file.c}, @file{file.c.~1~}, and
-@file{file.c.~2~}.@refill
+@file{file.c.~2~}.
@example
@group
In the following example, suppose that the current default directory
has five files whose names begin with @samp{f}: @file{foo},
@file{file~}, @file{file.c}, @file{file.c.~1~}, and
-@file{file.c.~2~}.@refill
+@file{file.c.~2~}.
@example
@group
@code{file-name-completion} usually ignores file names that end in any
string in this list. It does not ignore them when all the possible
completions end in one of these suffixes. This variable has no effect
-on @code{file-name-all-completions}.@refill
+on @code{file-name-all-completions}.
A typical value might look like this:
are no arguments.
Here is a description of the imaginary @code{electric-future-map}
-variable.@refill
+variable.
@defvar electric-future-map
The value of this variable is a full keymap used by Electric Command
derived from ``subroutine''.) Most primitive functions evaluate all
their arguments when they are called. A primitive function that does
not evaluate all its arguments is called a @dfn{special form}
-(@pxref{Special Forms}).@refill
+(@pxref{Special Forms}).
It does not matter to the caller of a function whether the function is
primitive. However, this does matter if you try to redefine a primitive
therefore @samp{f} is a regular expression that matches the string
@samp{f} and no other string. (It does @emph{not} match the string
@samp{fg}, but it does match a @emph{part} of that string.) Likewise,
-@samp{o} is a regular expression that matches only @samp{o}.@refill
+@samp{o} is a regular expression that matches only @samp{o}.
Any two regular expressions @var{a} and @var{b} can be concatenated. The
result is a regular expression that matches a string if @var{a} matches
some amount of the beginning of that string and @var{b} matches the rest of
-the string.@refill
+the string.
As a simple example, we can concatenate the regular expressions @samp{f}
and @samp{o} to get the regular expression @samp{fo}, which matches only
is a special character that matches any single character except a newline.
Using concatenation, we can make regular expressions like @samp{a.b}, which
matches any three-character string that begins with @samp{a} and ends with
-@samp{b}.@refill
+@samp{b}.
@item @samp{*}
@cindex @samp{*} in regexp
@samp{\\}. To write a Lisp string that contains the characters
@samp{\\}, Lisp syntax requires you to quote each @samp{\} with another
@samp{\}. Therefore, the read syntax for a regular expression matching
-@samp{\} is @code{"\\\\"}.@refill
+@samp{\} is @code{"\\\\"}.
@end table
@strong{Please note:} For historical compatibility, special characters
meanings make no sense. For example, @samp{*foo} treats @samp{*} as
ordinary since there is no preceding expression on which the @samp{*}
can act. It is poor practice to depend on this behavior; quote the
-special character anyway, regardless of where it appears.@refill
+special character anyway, regardless of where it appears.
As a @samp{\} is not special inside a character alternative, it can
never remove the special meaning of @samp{-} or @samp{]}. So you
specifies an alternative.
Two regular expressions @var{a} and @var{b} with @samp{\|} in
between form an expression that matches anything that either @var{a} or
-@var{b} matches.@refill
+@var{b} matches.
Thus, @samp{foo\|bar} matches either @samp{foo} or @samp{bar}
-but no other string.@refill
+but no other string.
@samp{\|} applies to the largest possible surrounding expressions. Only a
surrounding @samp{\( @dots{} \)} grouping can limit the grouping power of
-@samp{\|}.@refill
+@samp{\|}.
If you need full backtracking capability to handle multiple uses of
@samp{\|}, use the POSIX regular expression functions (@pxref{POSIX
matches the empty string, but only at the beginning or
end of a word. Thus, @samp{\bfoo\b} matches any occurrence of
@samp{foo} as a separate word. @samp{\bballs?\b} matches
-@samp{ball} or @samp{balls} as a separate word.@refill
+@samp{ball} or @samp{balls} as a separate word.
@samp{\b} matches at the beginning or end of the buffer (or string)
regardless of what text appears next to it.
2013-10-23 Glenn Morris <rgm@gnu.org>
+ * dired-x.texi, ebrowse.texi, ede.texi, eieio.texi, eshell.texi:
+ * pcl-cvs.texi, sc.texi, srecode.texi, vip.texi, viper.texi:
+ * widget.texi: Nuke @refill.
+
* Makefile.in (install-dvi, install-html, install-pdf)
(install-ps, uninstall-dvi, uninstall-html, uninstall-ps)
(uninstall-pdf): Quote entities that might contain whitespace.
@vindex dired-guess-shell-alist-default
Predefined rules for shell commands. Set this to @code{nil} to turn guessing off.
The elements of @code{dired-guess-shell-alist-user} (defined by the
-user) will override these rules.@refill
+user) will override these rules.
@item dired-guess-shell-alist-user
@vindex dired-guess-shell-alist-user
commands. These rules take precedence over the predefined rules in the
variable @code{dired-guess-shell-alist-default} (to which they are prepended)
when @code{dired-do-shell-command} is run).
-@refill
Each element of the alist looks like
@item
Types (@code{enum}s, and @code{typedef}s defined with class
-scope).@refill
+scope).
@end itemize
You can switch member buffers from one list to another, or to another
@findex --help
When invoked with option @samp{--help}, @command{ebrowse} prints a list of
-available command line options.@refill
+available command line options.
@menu
* Input files:: Specifying which files to parse
This command views the class declaration if the database
contains information about it. If you don't parse the entire source
you are working on, some classes will only be known to exist but the
-location of their declarations and definitions will not be known.@refill
+location of their declarations and definitions will not be known.
@item RET
Works like @kbd{SPC}, except that it finds the class
declaration rather than viewing it, so that it is ready for
-editing.@refill
+editing.
@end table
The same functionality is available from the menu opened with
If the branch of the class tree containing the class searched for is
currently collapsed, the class itself and all its base classes are
recursively made visible. (See also @ref{Expanding and
-Collapsing}.)@refill
+Collapsing}.)
This function is also available from the tree buffer's context menu.
You can expand and collapse parts of a tree to reduce the complexity of
large class hierarchies. Expanding or collapsing branches of a tree has
no impact on the functionality of other commands, like @kbd{/}. (See
-also @ref{Go to Class}.)@refill
+also @ref{Go to Class}.)
Collapsed branches are indicated with an ellipsis following the class
name like in the example below.
Classes can be marked for operations similar to the standard Emacs
commands @kbd{M-x tags-search} and @kbd{M-x tags-query-replace} (see
-also @xref{Tags-like Functions}.)@refill
+also @xref{Tags-like Functions}.)
@table @kbd
@cindex toggle mark
Ebrowse's commands, the position from where you performed the
jump and the position where you jumped to are recorded in a
@dfn{position stack}. There are several ways in which you can quickly
-move to positions in the stack:@refill
+move to positions in the stack:
@table @kbd
@cindex return to original position
Default Value: @code{"Untitled"}
The name used when generating distribution files.
-@refill
@item :version
Type: @code{string} @*
Default Value: @code{"1.0"}
The version number used when distributing files.
-@refill
@item :directory
Type: @code{string}
Directory this project is associated with.
-@refill
@item :file
Type: @code{string}
File name where this project is stored.
-@refill
@end table
Type: @code{list}
List of top level targets in this project.
-@refill
@item :tool-cache
Type: @code{list}
List of tool cache configurations in this project.
This allows any tool to create, manage, and persist project-specific settings.
-@refill
@item :web-site-url
Type: @code{string} @*
URL to this projects web site.
This is a URL to be sent to a web site for documentation.
-@refill
@item :web-site-directory @*
A directory where web pages can be found by Emacs.
For remote locations use a path compatible with ange-ftp or EFS@.
You can also use TRAMP for use with rcp & scp.
-@refill
@item :web-site-file @*
A file which contains the home page for this project.
This file can be relative to slot @code{web-site-directory}.
This can be a local file, use ange-ftp, EFS, or TRAMP.
-@refill
@item :ftp-site
Type: @code{string} @*
FTP site where this project's distribution can be found.
This FTP site should be in Emacs form, as needed by @code{ange-ftp}, but can
also be of a form used by TRAMP for use with scp, or rcp.
-@refill
@item :ftp-upload-site
Type: @code{string} @*
FTP Site to upload new distributions to.
This FTP site should be in Emacs form as needed by @code{ange-ftp}.
If this slot is @code{nil}, then use @code{ftp-site} instead.
-@refill
@item :configurations
Type: @code{list} @*
List of available configuration types.
Individual target/project types can form associations between a configuration,
and target specific elements such as build variables.
-@refill
@item :configuration-default @*
Default Value: @code{"debug"}
The default configuration.
-@refill
@item :local-variables @*
Default Value: @code{nil}
Project local variables
-@refill
@end table
that are relative to the project's root should start with a /, such
as "/include", meaning the directory @code{include} off the project root
directory.
-@refill
@item :system-include-path
Type: @code{list} @*
C files initialized in an ede-cpp-root-project have their semantic
system include path set to this value. If this is @code{nil}, then the
semantic path is not modified.
-@refill
@item :spp-table
Type: @code{list} @*
are critical symbols derived from header files. Providing header files
macro values through this slot improves accuracy and performance.
Use `:spp-files' to use these files directly.
-@refill
@item :spp-files
Type: @code{list} @*
The PreProcessor symbols appearing in these files will be used while
parsing files in this project.
See @code{semantic-lex-c-preprocessor-symbol-map} for more on how this works.
-@refill
@item :header-match-regexp
Type: @code{string} @*
Default Value: @code{"\\.\\(h\\(h\\|xx\\|pp\\|\\+\\+\\)?\\|H\\)$\\|\\<\\w+$"}
Regexp used to identify C/C++ header files.
-@refill
@item :locate-fcn
Type: @code{(or null function)} @*
It should return the fully qualified file name passed in from NAME@. If that file does not
exist, it should return nil.
-@refill
@end table
Can be one of @code{'Makefile}, 'Makefile.in, or 'Makefile.am.
If this value is NOT @code{'Makefile}, then that overrides the @code{:makefile} slot
in targets.
-@refill
@item :variables
Type: @code{list} @*
Default Value: @code{nil}
Variables to set in this Makefile.
-@refill
@item :configuration-variables
Type: @code{list} @*
Makefile variables to use in different configurations.
These variables are used in the makefile when a configuration becomes active.
-@refill
@item :inference-rules @*
Default Value: @code{nil}
Inference rules to add to the makefile.
-@refill
@item :include-file @*
Default Value: @code{nil}
Additional files to include.
These files can contain additional rules, variables, and customizations.
-@refill
@item :automatic-dependencies
Type: @code{boolean} @*
Default Value: @code{t}
Non-@code{nil} to do implement automatic dependencies in the Makefile.
-@refill
@item :metasubproject
Type: @code{boolean} @*
projects are grouped into a large project not maintained by EDE, then you need
to set this to non-nil. The only effect is that the @code{dist} rule will then avoid
making a tar file.
-@refill
@end table
Default Value: @code{nil}
Variables to set in this Makefile, at top of file.
-@refill
@item :additional-variables
Type: @code{(or null list)} @*
Arbitrary variables needed from this project.
It is safe to leave this blank.
-@refill
@item :additional-rules
Type: @code{(or null list)} @*
Arbitrary rules and dependencies needed to make this target.
It is safe to leave this blank.
-@refill
@item :installation-domain
Type: @code{symbol} @*
Installation domain specification.
The variable GNUSTEP_INSTALLATION_DOMAIN is set at this value.
-@refill
@item :preamble
Type: @code{(or null list)} @*
The auxiliary makefile for additional variables.
Included just before the specific target files.
-@refill
@item :postamble
Type: @code{(or null list)} @*
The auxiliary makefile for additional rules.
Included just after the specific target files.
-@refill
@item :metasubproject
Type: @code{boolean} @*
projects are grouped into a large project not maintained by EDE, then you need
to set this to non-nil. The only effect is that the @code{dist} rule will then avoid
making a tar file.
-@refill
@end table
Type: @code{string}
Name of this target.
-@refill
@item :path
Type: @code{string}
The path to the sources of this target.
Relative to the path of the project it belongs to.
-@refill
@item :source
Type: @code{list} @*
Default Value: @code{nil}
Source files in this target.
-@refill
@item :versionsource
Type: @code{list} @*
These files are checked for a version string whenever the EDE version
of the master project is changed. When strings are found, the version
previously there is updated.
-@refill
@end table
Type: @code{string}
Name of this target.
-@refill
@item :path
Type: @code{string}
The path to the sources of this target.
Relative to the path of the project it belongs to.
-@refill
@item :auxsource
Type: @code{list} @*
Auxiliary source files included in this target.
Each of these is considered equivalent to a source file, but it is not
distributed, and each should have a corresponding rule to build it.
-@refill
@item :compiler
Type: @code{(or null symbol)} @*
This should be a symbol, which contains the object defining the compiler.
This enables save/restore to do so by name, permitting the sharing
of these compiler resources, and global customization thereof.
-@refill
@item :linker
Type: @code{(or null symbol)} @*
This should be a symbol, which contains the object defining the linker.
This enables save/restore to do so by name, permitting the sharing
of these linker resources, and global customization thereof.
-@refill
@end table
Default Value: @code{"Makefile"}
File name of generated Makefile.
-@refill
@item :partofall
Type: @code{boolean} @*
Non @code{nil} means the rule created is part of the all target.
Setting this to @code{nil} creates the rule to build this item, but does not
include it in the ALL`all:' rule.
-@refill
@item :configuration-variables
Type: @code{list} @*
These variables are used in the makefile when a configuration becomes active.
Target variables are always renamed such as foo_CFLAGS, then included into
commands where the variable would usually appear.
-@refill
@item :rules
Type: @code{list} @*
Arbitrary rules and dependencies needed to make this target.
It is safe to leave this blank.
-@refill
@end table
prefix, or a ".so" suffix.
Note: Currently only used for Automake projects.
-@refill
@item :ldflags
Type: @code{list} @*
options to the linker.
Note: Not currently used. This bug needs to be fixed.
-@refill
@end table
There should only be one toplevel package per auxiliary tool needed.
These packages location is found, and added to the compile time
load path.
-@refill
@end table
The file that autoload definitions are placed in.
There should be one load defs file for a given package. The load defs are created
for all Emacs Lisp sources that exist in the directory of the created target.
-@refill
@item :autoload-dirs
Type: @code{list} @*
The directories to scan for autoload definitions.
If @code{nil} defaults to the current directory.
-@refill
@end table
Miscellaneous sources which have a specialized makefile.
The sub-makefile is used to build this target.
-@refill
@end table
The main menu resides in this file.
All other sources should be included independently.
-@refill
@end table
Default Value: @code{"guile"}
The preferred interpreter for this code.
-@refill
@end table
Default Value: @code{nil}
Additional LD args.
-@refill
@end table
@end table
Default Value: @code{nil}
Additional texinfo included in this one.
-@refill
@end table
@end table
The parent of this instance.
If a slot of this class is reference, and is unbound, then the parent
is checked for a value.
-@refill
@item :name
Type: @code{string}
The name of this type of source code.
Such as "C" or "Emacs Lisp"
-@refill
@item :sourcepattern
Type: @code{string} @*
Default Value: @code{".*"}
Emacs regex matching sourcecode this target accepts.
-@refill
@item :auxsourcepattern
Type: @code{(or null string)} @*
Emacs regex matching auxiliary source code this target accepts.
Aux source are source code files needed for compilation, which are not compiled
themselves.
-@refill
@item :enable-subdirectories
Type: @code{boolean} @*
If sourcecode always lives near the target creating it, this should be nil.
If sourcecode can, or typically lives in a subdirectory of the owning
target, set this to t.
-@refill
@item :garbagepattern
Type: @code{list} @*
Shell file regex matching files considered as garbage.
This is a list of items added to an @code{rm} command when executing a @code{clean}
type directive.
-@refill
@end table
The parent of this instance.
If a slot of this class is reference, and is unbound, then the parent
is checked for a value.
-@refill
@item :name
Type: @code{string}
Name of this type of compiler.
-@refill
@item :variables
Type: @code{list}
An assoc list where each element is (VARNAME . VALUE) where VARNAME
is a string, and VALUE is either a string, or a list of strings.
For example, GCC would define CC=gcc, and emacs would define EMACS=emacs.
-@refill
@item :sourcetype
Type: @code{list}
A list of @code{ede-sourcecode} @xref{ede-sourcecode}. objects this class will handle.
This is used to match target objects with the compilers and linkers
they can use, and which files this object is interested in.
-@refill
@item :rules
Type: @code{list} @*
Auxiliary rules needed for this compiler to run.
For example, yacc/lex files need additional chain rules, or inferences.
-@refill
@item :commands
Type: @code{list}
The commands used to execute this compiler.
The object which uses this compiler will place these commands after
it's rule definition.
-@refill
@item :autoconf
Type: @code{list} @*
call to initialize automake to use this compiler.
For example, there may be multiple C compilers, but they all probably
use the same autoconf form.
-@refill
@item :objectextention
Type: @code{string}
A string which is the extension used for object files.
For example, C code uses .o on unix, and Emacs Lisp uses .elc.
-@refill
@end table
The parent of this instance.
If a slot of this class is reference, and is unbound, then the parent
is checked for a value.
-@refill
@item :name
Type: @code{string}
Name of this type of compiler.
-@refill
@item :variables
Type: @code{list}
An assoc list where each element is (VARNAME . VALUE) where VARNAME
is a string, and VALUE is either a string, or a list of strings.
For example, GCC would define CC=gcc, and emacs would define EMACS=emacs.
-@refill
@item :sourcetype
Type: @code{list}
A list of @code{ede-sourcecode} @xref{ede-sourcecode}. objects this class will handle.
This is used to match target objects with the compilers and linkers
they can use, and which files this object is interested in.
-@refill
@item :commands
Type: @code{list}
The commands used to execute this compiler.
The object which uses this compiler will place these commands after
it's rule definition.
-@refill
@item :objectextention
Type: @code{string}
A string which is the extension used for object files.
For example, C code uses .o on unix, and Emacs Lisp uses .elc.
-@refill
@item :makedepends
Type: @code{boolean} @*
Default Value: @code{nil}
Non-@code{nil} if this compiler can make dependencies.
-@refill
@item :uselinker
Type: @code{boolean} @*
Non-@code{nil} if this compiler creates code that can be linked.
This requires that the containing target also define a list of available
linkers that can be used.
-@refill
@end table
Type: @code{list}
A variable dedicated to dependency generation.
-@refill
@end table
@end table
Type: @code{string}
Name of this type of compiler.
-@refill
@item :variables
Type: @code{list}
An assoc list where each element is (VARNAME . VALUE) where VARNAME
is a string, and VALUE is either a string, or a list of strings.
For example, GCC would define CC=gcc, and emacs would define EMACS=emacs.
-@refill
@item :sourcetype
Type: @code{list}
A list of @code{ede-sourcecode} @xref{ede-sourcecode}. objects this class will handle.
This is used to match target objects with the compilers and linkers
they can use, and which files this object is interested in.
-@refill
@item :commands
Type: @code{list}
The commands used to execute this compiler.
The object which uses this compiler will place these commands after
it's rule definition.
-@refill
@item :objectextention
Type: @code{string}
A string which is the extension used for object files.
For example, C code uses .o on unix, and Emacs Lisp uses .elc.
-@refill
@end table
@end table
with it, certain default methods or attributes can be added to all
objects. In CLOS, this would be named @code{STANDARD-CLASS}, and that
symbol is an alias to @code{eieio-default-superclass}.
-@refill
Currently, the default superclass is defined as follows:
@item
Eli Zaretskii made it possible for Eshell to run without requiring
asynchronous subprocess support. This is important for MS-DOS, which
-does not have such support.@refill
+does not have such support.
@item
-Miles Bader contributed many fixes during the port to Emacs 21.@refill
+Miles Bader contributed many fixes during the port to Emacs 21.
@item
Stefan Monnier fixed the things which bothered him, which of course made
-things better for all.@refill
+things better for all.
@item
Gerd Moellmann also helped to contribute bug fixes during the initial
-integration with Emacs 21.@refill
+integration with Emacs 21.
@item
Alex Schroeder contributed code for interactively querying the user
-before overwriting files.@refill
+before overwriting files.
@item
-Sudish Joseph helped with some XEmacs compatibility issues.@refill
+Sudish Joseph helped with some XEmacs compatibility issues.
@end itemize
Apart from these, a lot of people have sent suggestions, ideas,
Inge Wallin wrote the skeleton of
@file{pcl-cvs.texi}, and gave useful comments on it. He also wrote
the files @file{elib-node.el} and @file{compile-all.el}. The file
-@file{cookie.el} was inspired by Inge.@refill
+@file{cookie.el} was inspired by Inge.
@item
@c linus@@lysator.liu.se
Linus Tolke contributed useful comments
-on both the functionality and the documentation.@refill
+on both the functionality and the documentation.
@item
@c jwz@@jwz.com
Jamie Zawinski contributed
@file{pcl-cvs-lucid.el}, which was later renamed to
-@file{pcl-cvs-xemacs.el}.@refill
+@file{pcl-cvs-xemacs.el}.
@item
Leif Lonnblad contributed RCVS support (since superseded by the new
repository. @xref{Committing changes}. You can also press @kbd{O} to
update any of the files that are marked @samp{Need-Update}. You can
also run @kbd{M-x cvs-update @key{RET}} (bound to @kbd{M-u} in the
-@samp{*cvs*} buffer) to update all the files.@refill
+@samp{*cvs*} buffer) to update all the files.
You can then press @kbd{=} to easily get a @samp{diff} between your
modified file and the base version that you started from, or you can
@item
An asterisk when the file is @dfn{marked} (@pxref{Selected
-files}).@refill
+files}).
@item
The actual status of the file wrt the repository. See below.
@item merged
The file was modified in your working directory, and there were
modifications in the repository as well, but they were merged
-successfully, without conflict, in your working directory.@refill
+successfully, without conflict, in your working directory.
@end table
@item Conflict
the two versions; an unmodified copy of your file is also in your
working directory, with the name @file{.#@var{file}.@var{version}},
where @var{version} is the RCS revision that your modified file started
-from. @xref{Viewing differences}, for more details.@refill
+from. @xref{Viewing differences}, for more details.
A conflict can also come from a disagreement on the existence of the file
rather than on its content. This case is indicated by the following
@item Added
The file has been added by you, but it still needs to be checked in to
-the repository.@refill
+the repository.
@item Removed
The file has been removed by you, but it still needs to be checked in to
the repository. You can resurrect it by typing @kbd{a} (@pxref{Adding
-and removing files}).@refill
+and removing files}).
@item Unknown
A file that was detected in your directory, but that neither appears in
the repository, nor is present on the list of files that CVS should
-ignore.@refill
+ignore.
@item Up-to-date
The file is up to date with respect to the version in the repository.
@table @samp
@item added
-You have just added the file to the repository.@refill
+You have just added the file to the repository.
@item updated
The file was brought up to date with respect to the repository. This is
done for any file that exists in the repository but not in your source,
and for files that you haven't changed but are not the most recent
-versions available in the repository.@refill
+versions available in the repository.
@item patched
The file was brought up to date with respect to the remote repository by
way of fetching and applying a patch to the file in your source. This
is equivalent to @samp{updated} except that CVS decided to use a hopefully
-more efficient method.@refill
+more efficient method.
@item committed
-You just committed the file.@refill
+You just committed the file.
@end table
@item Need-Update
Either a newer version than the one in your source is available in the
repository and you have not modified your checked out version, or the
file exists in the repository but not in your source. Use
-@samp{cvs-mode-update} bound to @kbd{O} to update the file.@refill
+@samp{cvs-mode-update} bound to @kbd{O} to update the file.
@item Need-Merge
You have modified the checked out version of the file, and a newer
@table @kbd
@item T
-Toggles whether or not marks will be active in the next command.@refill
+Toggles whether or not marks will be active in the next command.
@item b
Provide the next command with a branch (can be any version
-specifier) to work on.@refill
+specifier) to work on.
@item B
Secondary branch argument. Only meaningful if @kbd{b} is also used.
@table @kbd
@item M-u
-Runs the command @samp{cvs-update}.@refill
+Runs the command @samp{cvs-update}.
@item M-e
-Runs the command @samp{cvs-examine}.@refill
+Runs the command @samp{cvs-examine}.
@item M-s
-Runs the command @samp{cvs-status}.@refill
+Runs the command @samp{cvs-status}.
@end table
In addition to the above commands which operate on the whole module,
@table @kbd
@item O
Runs @code{cvs-mode-update} on the selected files. When run on the
-top-level directory, this is equivalent to @kbd{M-u}.@refill
+top-level directory, this is equivalent to @kbd{M-u}.
@item e
Runs @code{cvs-mode-examine} on the selected files. When run on the
-top-level directory, this is equivalent to @kbd{M-e}.@refill
+top-level directory, this is equivalent to @kbd{M-e}.
@findex cvs-status-mode
@item s
Runs @code{cvs-mode-status} on the selected files. When run on the
top-level directory, this is equivalent to @kbd{M-s}, except that
CVS output will be shown in a @samp{*cvs-info*} buffer that will be
-put in @samp{cvs-status-mode}.@refill
+put in @samp{cvs-status-mode}.
@end table
@item @key{SPC}
@itemx n
These keys move the cursor one file forward, towards the end of the
-buffer (@code{cvs-mode-next-line}).@refill
+buffer (@code{cvs-mode-next-line}).
@item p
This key moves one file backward, towards the beginning of the buffer
@item m
This marks the file that the cursor is positioned on. If the cursor is
positioned on a directory all files in that directory are marked
-(@code{cvs-mode-mark}).@refill
+(@code{cvs-mode-mark}).
@item u
Unmark the file that the cursor is positioned on. If the cursor is on a
directory, all files in that directory are unmarked
-(@code{cvs-mode-unmark}).@refill
+(@code{cvs-mode-unmark}).
@item M
Mark @emph{all} files in the buffer (@code{cvs-mode-mark-all-files}).
@item
After having selected the files you want to commit, you type either
@kbd{c} or @kbd{C} which brings up a special buffer
-@samp{*cvs-commit*}.@refill
+@samp{*cvs-commit*}.
@item
You type in the log message describing the changes you're about to
@item
When you're happy with it, you type @kbd{C-c C-c} to do the actual
-commit.@refill
+commit.
@end enumerate
There's no hidden state, so you can abort the process or pick it up
@item o
Like @kbd{f}, but use another window
-(@code{cvs-mode-find-file-other-window}).@refill
+(@code{cvs-mode-find-file-other-window}).
@item A
Invoke @samp{add-change-log-entry-other-window} to edit a
@file{ChangeLog} file. The @file{ChangeLog} file will be found in the
directory of the file the cursor points to, or in a parent of that
-directory (@code{cvs-mode-add-change-log-entry-other-window}).@refill
+directory (@code{cvs-mode-add-change-log-entry-other-window}).
@end table
files (@pxref{Buffer contents}). The status of the file will change to
@samp{Added}, and you will have to use @kbd{c} (@samp{cvs-mode-commit}
@pxref{Committing changes}), to really add the file to the
-repository.@refill
+repository.
This command can also be used on @samp{Removed} files (before you commit
them) to resurrect them.
also be @samp{cvs remove}d. If the files' status was @samp{Unknown}
they will disappear from the buffer. Otherwise their status will change to
@samp{Removed}, and you must use @kbd{c} (@samp{cvs-mode-commit},
-@pxref{Committing changes}) to commit the removal.@refill
+@pxref{Committing changes}) to commit the removal.
The command that is run is @code{cvs-mode-remove-file}.
@end table
@vindex cvs-mode-remove-handled@r{ (variable)}
@kbd{x} invokes @code{cvs-mode-remove-handled}. If
@samp{cvs-auto-remove-handled} is set to non-@code{nil}, this will
-automatically be performed after every commit.@refill
+automatically be performed after every commit.
@item C-k
This command can be used for lines that @samp{cvs-mode-remove-handled} would
@item =
@itemx d =
Display a @samp{cvs diff} between the selected files and the version
-that they are based on (@code{cvs-mode-diff}).@refill
+that they are based on (@code{cvs-mode-diff}).
@item d b
If CVS finds a conflict while merging two versions of a file (during a
@samp{cvs update}, @pxref{Updating the buffer}) it will save the
original file in a file called @file{.#@var{file}.@var{version}} where
@var{file} is the name of the file, and @var{version} is the revision
-number that @var{file} was based on.@refill
+number that @var{file} was based on.
With the @kbd{d b} command you can run a @samp{diff} on the files
-@file{.#@var{file}.@var{version}} and @file{@var{file}}.@refill
+@file{.#@var{file}.@var{version}} and @file{@var{file}}.
@item d h
Display a @samp{cvs diff} between the selected files and the head
revision (the most recent version on the current
-branch) in the repository (@code{cvs-mode-diff-head}).@refill
+branch) in the repository (@code{cvs-mode-diff-head}).
@item d r
Display a @samp{cvs diff} between the base revision of the selected
@item d v
Display a @samp{cvs diff} between the selected files and the head
revision of the vendor branch in the repository
-(@code{cvs-mode-diff-vendor}).@refill
+(@code{cvs-mode-diff-vendor}).
@item d y
Display a @samp{cvs diff} between the selected files and yesterday's
head revision in the repository
-(@code{cvs-mode-diff-yesterday}).@refill
+(@code{cvs-mode-diff-yesterday}).
@end table
By default, @samp{diff} commands ignore the marks. This can be changed
CVS has already performed a merge. The resulting file is not used in
any way if you use this command. If you use the @kbd{q} command inside
@samp{ediff} (to successfully terminate a merge) the file that CVS
-created will be overwritten.@refill
+created will be overwritten.
@end table
@node Updating files
If you have an idea about any customization that would be handy but
isn't present in this list, please tell us!
-For info on how to reach us, see @ref{Bugs}.@refill
+For info on how to reach us, see @ref{Bugs}.
@table @samp
@item cvs-auto-remove-handled
If this variable is set to any non-@code{nil} value,
@samp{cvs-mode-remove-handled} will be called every time you check in
files, after the check-in is ready. @xref{Removing handled
-entries}.@refill
+entries}.
@item cvs-auto-remove-directories
If this variable is set to any non-@code{nil} value, directories that do
not contain any files to be checked in will not be listed in the
-@samp{*cvs*} buffer.@refill
+@samp{*cvs*} buffer.
@item cvs-auto-revert
If this variable is set to any non-@samp{nil} value any buffers you have
that visit a file that is committed will be automatically reverted.
-This variable defaults to @samp{t}. @xref{Committing changes}.@refill
+This variable defaults to @samp{t}. @xref{Committing changes}.
@item cvs-update-prog-output-skip-regexp
The @samp{-u} flag in the @file{modules} file can be used to run a command
be able to yank (and cite) only a portion of the original message.
Since Supercite only modifies the text it finds in the reply buffer as
set up by the MUA, it is the MUA's responsibility to do partial yanking.
-@xref{Reply Buffer Initialization}.@refill
+@xref{Reply Buffer Initialization}.
@vindex mail-header-separator
Another potentially useful thing would be for Supercite to set up the
bodies cannot be modified by Supercite. Supercite, in fact, doesn't
know anything about the meaning of these headers, and never ventures
outside the designated region. @xref{Hints to MUA Authors}, for more
-details.@refill
+details.
@node What Supercite Does
@section What Supercite Does
@code{sc-cite-original} has been added. When @code{sc-cite-original} is
executed, the original message must be set up in a very specific way,
but this is handled automatically by the MUA@. @xref{Hints to MUA
-Authors}.@refill
+Authors}.
@cindex info alist
The first thing Supercite does, via @code{sc-cite-original}, is to parse
through the original message's mail headers. It saves this data in an
@dfn{information association list}, or @dfn{info alist}. The information
in this list is used in a number of places throughout Supercite.
-@xref{Information Keys and the Info Alist}.@refill
+@xref{Information Keys and the Info Alist}.
@cindex nuking mail headers
@cindex reference header
filling routines, e.g., @code{fill-paragraph}, do not recognize cited
text and will not re-fill them properly because it cannot guess the
@code{fill-prefix} being used.
-@xref{Post-yank Formatting Commands}, for details.@refill
+@xref{Post-yank Formatting Commands}, for details.
As mentioned above, Supercite provides commands to recite or uncite
regions of text in the reply buffer, and commands to perform other
as possible to allow for a wide range of personalized citation styles,
but it is also immediately useful with the default configuration, once
it has been properly connected to your MUA@. @xref{Getting Connected},
-for more details.@refill
+for more details.
@node Citations
@chapter Citations
The @dfn{attribution string}. This element is supplied automatically by
Supercite, based on your preferences and the original message's mail
headers, though you may be asked to confirm Supercite's choice.
-@xref{Selecting an Attribution}, for more details.@refill
+@xref{Selecting an Attribution}, for more details.
@cindex citation delimiter
@vindex sc-citation-delimiter
something like
@code{@asis{" Jane> "}}.
This citation string will be inserted in front of
-every line in the original message that is not already cited.@refill
+every line in the original message that is not already cited.
Nested citations, being simpler than non-nested citations, are composed
of the same elements, sans the attribution string. Supercite is smart
@code{sc-citation-nonnested-root-regexp} is used to describe only
non-nested citation roots. It is important to remember that if you
change @code{sc-citation-root-regexp} you should always also change
-@code{sc-citation-nonnested-root-regexp}.@refill
+@code{sc-citation-nonnested-root-regexp}.
@node Information Keys and the Info Alist
@chapter Information Keys and the Info Alist
the trailing colon. Info keys are always case insensitive (as are
mail headers), and the value for a corresponding key can be retrieved
from the alist with the @code{sc-mail-field} function. Thus, if the
-following fields were present in the original article:@refill
+following fields were present in the original article:
@example
Date:@: 08 April 1991, 17:32:09 EST
If the author's name has more than one middle name, they will appear as
info keys with the appropriate index (e.g., @code{"sc-middlename-2"},
-@dots{}). @xref{Selecting an Attribution}.@refill
+@dots{}). @xref{Selecting an Attribution}.
@node Reference Headers
@chapter Reference Headers
of the info key from the info alist will be inserted there.
(@pxref{Information Keys and the Info Alist}). For example, in @code{sc-header-on-said}
below, @var{date} and @var{from} correspond to the values of the
-@samp{Date:@:} and @samp{From:@:} mail headers respectively.@refill
+@samp{Date:@:} and @samp{From:@:} mail headers respectively.
@vindex sc-reference-tag-string
@vindex reference-tag-string (sc-)
Displays the next reference header in the electric reference buffer. If
the variable @code{sc-electric-circular-p} is non-@code{nil}, invoking
@code{sc-eref-next} while viewing the last reference header in the list
-will wrap around to the first header.@refill
+will wrap around to the first header.
@item @code{sc-eref-prev} (@kbd{p})
@findex sc-eref-prev
@kindex p
Displays the previous reference header in the electric reference buffer.
If the variable @code{sc-electric-circular-p} is non-@code{nil},
-invoking @code{sc-eref-prev} will wrap around to the last header.@refill
+invoking @code{sc-eref-prev} will wrap around to the last header.
@item @code{sc-eref-goto} (@kbd{g})
@findex sc-eref-goto
Goes to a specified reference header. The index (into the
@code{sc-rewrite-header-list}) can be specified as a numeric argument to
the command. Otherwise, Supercite will query you for the index in the
-minibuffer.@refill
+minibuffer.
@item @code{sc-eref-jump} (@kbd{j})
@findex sc-eref-jump
@findex eref-setn (sc-)
@kindex s
Set the preferred reference header (i.e.,
-@code{sc-preferred-header-style}) to the currently displayed header.@refill
+@code{sc-preferred-header-style}) to the currently displayed header.
@item @code{sc-eref-exit} (@kbd{C-j}, @key{RET}, and @key{ESC C-c})
@kindex RET
@findex sc-eref-exit
@findex eref-exit (sc-)
Exit from electric reference mode and insert the current header into the
-reply buffer.@refill
+reply buffer.
@item @code{sc-eref-abort} (@kbd{q}, @kbd{x})
@findex sc-eref-abort
``use your default citation function.'' When you add Supercite's
citation function to the hook, thereby giving the variable a
non-@code{nil} value, it tells the MUA to run the hook via
-@code{run-hooks} instead of using the default citation.@refill
+@code{run-hooks} instead of using the default citation.
Early in Supercite's development, the Supercite author, a few MUA
authors, and some early Supercite users got together and agreed upon a
region. Note that Supercite @emph{never} touches any text outside this
region. Note further that the region need not be active
for @code{sc-cite-original} to do its job.
-@xref{Hints to MUA Authors}.@refill
+@xref{Hints to MUA Authors}.
The other step in the getting connected process is to make sure your
MUA calls @code{sc-cite-original} at the right time. As mentioned
your Emacs maintainer has put Supercite into your dumped Emacs image.
In that case, you can use the @code{sc-pre-hook} variable, but this will
get executed every time @code{sc-cite-original} is called. @xref{Reply
-Buffer Initialization}.@refill
+Buffer Initialization}.
@node Replying and Yanking
@chapter Replying and Yanking
work. You could conceivably use this hook to set certain Supercite
variables based on the reply buffer's mode or name (i.e., to do
something different based on whether you are replying or following up to
-an article).@refill
+an article).
@item
@emph{Inserts Supercite's keymap.}
Supercite to anticipate every style in existence, and you probably
wouldn't encounter them all anyway. But you can configure Supercite to
recognize those styles you see often.
-@xref{Configuring the Citation Engine}, for details.@refill
+@xref{Configuring the Citation Engine}, for details.
@item
@emph{Runs @code{sc-post-hook}.}
This variable is very similar to @code{sc-pre-hook}, except that it runs
after @code{sc-cite-original} is finished. This hook is provided mostly
for completeness and backward compatibility. Perhaps it could be used to
-reset certain variables set in @code{sc-pre-hook}.@refill
+reset certain variables set in @code{sc-pre-hook}.
@end enumerate
@node Filling Cited Text
Also, Supercite will collapse leading whitespace between the citation
string and the text on a line when the variable
@code{sc-fixup-whitespace-p} is non-@code{nil}. The default value for
-this variable is @code{nil}.@refill
+this variable is @code{nil}.
@vindex fill-prefix
Its important to understand that Supercite's automatic filling (during
will use Emacs's undo feature to undo back before the citation was
applied to the original message. Then I'll toggle the variables and
manually cite those paragraphs that I don't want to fill or collapse
-whitespace on. @xref{Variable Toggling Shortcuts}.@refill
+whitespace on. @xref{Variable Toggling Shortcuts}.
@kindex C-c C-p C-p
If you find that Supercite's automatic filling is just too fragile for
Also, to make life easier, a shortcut function to toggle the state of
both of these variables is provided on the key binding
@kbd{C-c C-p C-p} (with the default value of @code{sc-mode-map-prefix};
-@pxref{Post-yank Formatting Commands}).@refill
+@pxref{Post-yank Formatting Commands}).
You will noticed that the minor mode string will
show the state of these variables as qualifier characters. When both
display @samp{SC:fw}. Note that the qualifiers chosen are mnemonics for
the default bindings of the toggling function for each respective
variable.
-@xref{Variable Toggling Shortcuts}.@refill
+@xref{Variable Toggling Shortcuts}.
Why are these variables not set to @code{nil} by default? It is because
many users won't manually fill paragraphs that are Supercited, and there
@item "sc-lastchoice"
the last attribution string you have selected. This is useful when you
-recite paragraphs in the reply.@refill
+recite paragraphs in the reply.
@item "sc-consult"
@vindex sc-attrib-selection-list
@item "x-attribution"
the original author's suggestion for attribution string choice. See below
-for details.@refill
+for details.
@end table
Middle name indexes can be any positive integer greater than zero,
@code{sc-default-author-name} and @code{sc-default-attribution} are
used, otherwise, the following steps are taken to find a valid
attribution string, and the first step to return a non-@code{nil},
-non-empty string becomes the attribution:@refill
+non-empty string becomes the attribution:
@enumerate
@item
citation strings used by Supercite. One possible use of this would be
to override any automatically derived attribution string when it is only
one character long; e.g., you prefer to use @code{"initials"} but the
-author only has one name.@refill
+author only has one name.
@node Author Names
@section Author Names
@code{looking-at}. This match folds case if the optional
@var{case-fold-search} is non-@code{nil}. If @var{pred} is not a
string, or does not @code{eval}uate to a string, it is interpreted as a
-binary value (@code{nil} or non-@code{nil}).@refill
+binary value (@code{nil} or non-@code{nil}).
The four special symbol values for @var{pred} are recognized:
should be careful to do explicitly), Regi will reset the frame to the
first entry, and advance @samp{point} to the beginning of the next line.
If a list is returned from your function, it can contain any combination
-of the following elements:@refill
+of the following elements:
@table @asis
@item the symbol @code{continue}
This tells Regi to substitute @var{newframe} as the frame it is
interpreting. In other words, your @var{func} can modify the Regi frame
on the fly. @var{newframe} can be a variable containing a frame, or it
-can be the frame in-lined.@refill
+can be the frame in-lined.
@item the list @code{(step . @var{step})}
Tells Regi to move @var{step} number of lines forward as it continues
processing. By default, Regi moves forward one line. @var{step} can be
-zero or negative of course, but watch out for infinite loops.@refill
+zero or negative of course, but watch out for infinite loops.
@end table
During execution of your @var{func}, the following variables will be
-temporarily bound to some useful information:@refill
+temporarily bound to some useful information:
@table @code
@item curline
In a similar vein, there are default frames for @dfn{unciting} and
@dfn{reciting}, contained in the variables
@code{sc-default-uncite-frame} and @code{sc-default-recite-frame}
-respectively.@refill
+respectively.
As mentioned earlier (@pxref{Recognizing Citations}), citations are
recognized through the values of the regular expressions
@var{regexp} is a regular expression which is @code{string-match}'d
against the value of the @code{sc-mail-field} key, and @var{frame} is
the frame to use if a match occurred. @var{frame} can be a variable
-containing a frame or a frame in-lined.@refill
+containing a frame or a frame in-lined.
When Supercite is about to cite, uncite, or recite a region, it consults
the appropriate alist and attempts to find a frame to use. If one
@code{sc-mode-map-prefix} is @kbd{C-c C-p}; granted, not a great choice,
but unfortunately the best general solution so far. In the rest of this
chapter, we'll assume you've installed Supercite's keymap on the default
-prefix.@refill
+prefix.
@menu
* Citing Commands::
perform these functions on the region of text between @samp{point} and
@samp{mark}. Each of them sets the @dfn{undo boundary} before modifying
the region so that the command can be undone in the standard Emacs
-way.@refill
+way.
Here is the list of Supercite citing commands:
universal argument (@kbd{C-u}), it temporarily sets
@code{sc-confirm-always-p} to @code{t} so you can confirm the
attribution string for a single manual citing.
-@xref{Configuring the Citation Engine}.@refill
+@xref{Configuring the Citation Engine}.
@findex sc-uncite-region
@findex uncite-region (sc-)
@code{sc-uncite-frame-alist}, or the default unciting frame
@code{sc-default-uncite-frame}. It runs the hook
@code{sc-pre-uncite-hook} before interpreting the frame.
-@xref{Configuring the Citation Engine}.@refill
+@xref{Configuring the Citation Engine}.
@findex sc-recite-region
@findex recite-region (sc-)
frame from @code{sc-recite-frame-alist}, or the default reciting frame
@code{sc-default-recite-frame}. It runs the hook
@code{sc-pre-recite-hook} before interpreting the frame.
-@xref{Configuring the Citation Engine}.@refill
+@xref{Configuring the Citation Engine}.
@vindex sc-confirm-always-p
@vindex confirm-always-p (sc-)
no arguments, the header indexed by @code{sc-preferred-header-style} is
inserted. An optional numeric argument is the index into
@code{sc-rewrite-header-list} indicating which reference header to
-write.@refill
+write.
With just the universal argument (@kbd{C-u}), electric reference mode is
entered, regardless of the value of @code{sc-electric-references-p}.
Like Supercite commands in general, the toggling commands are placed on
a keymap prefix within the greater Supercite keymap. For the default
value of @code{sc-mode-map-prefix}, this will be
-@kbd{C-c C-p C-t}.@refill
+@kbd{C-c C-p C-t}.
The following commands toggle the value of certain Supercite variables
which take only a binary value:
@code{sc-auto-fill-region-p} and @code{sc-fixup-whitespace-p} together.
This is because you typically want to run Supercite with either variable
as @code{nil} or non-@code{nil}. The command to toggle these variables
-together is bound on @kbd{C-c C-p C-p}.@refill
+together is bound on @kbd{C-c C-p C-p}.
Finally, the command @kbd{C-c C-p C-t h} (also @kbd{C-c C-p C-t ?})
brings up a Help message on the toggling keymap.
These commands allow you to view, modify, add, and delete various bits
of information from the info alist.
-@xref{Information Keys and the Info Alist}.@refill
+@xref{Information Keys and the Info Alist}.
@table @asis
@kindex C-c C-p f
Supercite will initially set up its information for the digest
originator, but you want to cite each component article with the real
message author. Note that unless an error during processing occurs, any
-old information is lost.@refill
+old information is lost.
@end table
@node Miscellaneous Commands
@item @code{sc-open-line} (@kbd{C-c C-p o})
Similar to Emacs's standard @code{open-line} commands, but inserts the
citation string in front of the new line. As with @code{open-line},
-an optional numeric argument inserts that many new lines.@refill
+an optional numeric argument inserts that many new lines.
@end table
@node Hints to MUA Authors
@code{mail-yank-hooks}, the hook variable that the MUA should provide is
@code{mail-citation-hook}. Richard Stallman suggests that the MUAs
should @code{defvar} @code{mail-citation-hook} to @code{nil} and perform
-some default citing when that is the case.@refill
+some default citing when that is the case.
If you are writing a new MUA package, or maintaining an existing MUA
package, you should make it conform to this interface so that your users
you should place all the original headers into the body of the reply.
This means that many of the mail headers will be duplicated, one copy
above the @code{mail-header-separator} line and one copy below, however
-there will probably be more headers below this line.@refill
+there will probably be more headers below this line.
@item
Set @samp{point} to the beginning of the line containing the first mail
text Supercite is to modify and that the mail headers are within this
region. Supercite will not venture outside the region for any reason,
and anything within the region is fair game, so don't put anything that
-@strong{must} remain unchanged inside the region.@refill
+@strong{must} remain unchanged inside the region.
@item
Run the hook @code{mail-citation-hook}. You will probably want to
@code{mail-citation-hook} to be @code{nil}, it should perform some
default citing behavior. User who want to connect to Supercite then
need only add @code{sc-cite-original} to this list of hooks using
-@code{add-hook}.@refill
+@code{add-hook}.
@end enumerate
If you do all this your MUA will join the ranks of those that conform to
Some arguments are major-mode specific, such as the @code{:el} or
@code{:cpp} arguments.
-@refill
@section Template Insertion Context
A context can be provided for templates in a file. This helps
A context can be automatically derived as well based on the parsing
state from @i{Semantic}. @inforef{Top, Semantic Manual, semantic}.
-@refill
@section Applications
Commands that do a particular user task which involves also writing
(if that section is not 'visible') or the section is shown one time
for each dictionary added to that symbol.
@xref{Developing Template Functions}.
-@refill
Macros prefixed with ``>'' will include another template. Include
macros would look like this:
Comments and bug reports are welcome. Please send messages to
@code{ms@@Sail.Stanford.Edu} if you are outside of Japan and to
-@code{masahiko@@sato.riec.tohoku.junet} if you are in Japan.@refill
+@code{masahiko@@sato.riec.tohoku.junet} if you are in Japan.
@insertcopying
@key{PNT} and @key{MRK} are used
to indicate positions in a buffer and they are not part of the text of the
buffer. If a buffer contains a @key{MRK} then the text between @key{MRK}
-and @key{PNT} is called the @dfn{region} of the buffer.@refill
+and @key{PNT} is called the @dfn{region} of the buffer.
@cindex window
Emacs provides (multiple) @dfn{windows} on the screen, and you can see the
content of a buffer through the window associated with the buffer. The
cursor of the screen is always positioned on the character after @key{PNT}.
-@refill
@cindex mode
@cindex keymap
a function is bound to some key in the local keymap then that function will
be executed when you type the key. If no function is bound to a key in the
local map, however, the function bound to the key in the global map becomes
-in effect.@refill
+in effect.
@node Loading VIP
@section Loading VIP
to the function @code{vip-change-mode-to-vi}. The default binding of @kbd{C-z}
in GNU Emacs is @code{suspend-emacs}, but, you can also call
@code{suspend-emacs} by typing @kbd{C-x C-z}. Other than this, all the
-key bindings of Emacs remain the same after loading VIP.@refill
+key bindings of Emacs remain the same after loading VIP.
@cindex vi mode
invoked by @kbd{M-x}. Here @kbd{M-x} means @kbd{Meta-x}, and if your
terminal does not have a @key{META} key you can enter it by typing
@kbd{@key{ESC} x}. The same effect can also be achieve by typing
-@kbd{M-x vip-mode}.)@refill
+@kbd{M-x vip-mode}.)
@cindex mode line
You can observe the change of mode by looking at the @dfn{mode line}. For
-instance, if the mode line is:@refill
+instance, if the mode line is:
@example
-----Emacs: *scratch* (Lisp Interaction)----All------------
@end example
@cindex emacs mode
You can go back to the original @dfn{emacs mode} by typing @kbd{C-z} in
-vi mode. Thus @kbd{C-z} toggles between these two modes.@refill
+vi mode. Thus @kbd{C-z} toggles between these two modes.
Note that modes in VIP exist orthogonally to modes in Emacs. This means
that you can be in vi mode and at the same time, say, shell mode.
You will be in this mode just after you loaded VIP@. You can do all
normal Emacs editing in this mode. Note that the key @kbd{C-z} is globally
bound to @code{vip-change-mode-to-vi}. So, if you type @kbd{C-z} in this mode
-then you will be in vi mode.@refill
+then you will be in vi mode.
@node Vi Mode
@subsection Vi Mode
You can repeat undoing by the @kbd{.} key. So, @kbd{u} will undo
a single change, while @kbd{u .@: .@: .@:}, for instance, will undo 4 previous
changes. Undo is undoable as in Vi. So the content of the buffer will
-be the same before and after @kbd{u u}.@refill
+be the same before and after @kbd{u u}.
@node Changing
@subsection Changing
@key{ESC} to complete the command. Before you enter @key{RET} or
@key{ESC} you can abort the command by typing @kbd{C-g}. In general,
@kindex 007 @kbd{C-g} (@code{vip-keyboard-quit})
-you can abort a partially formed command by typing @kbd{C-g}.@refill
+you can abort a partially formed command by typing @kbd{C-g}.
@node Searching
@subsection Searching
search and regular expression search. You cannot give an offset to the
search string. (It is a limitation.) By default, search will wrap around
the buffer as in Vi. You can change this by rebinding the variable
-@code{vip-search-wrap-around}. @xref{Customization}, for how to do this.@refill
+@code{vip-search-wrap-around}. @xref{Customization}, for how to do this.
@node z Command
@subsection z Command
For those of you who cannot remember which of @kbd{z} followed by @key{RET},
@kbd{.}@: and @kbd{-} do what. You can also use @kbd{z} followed by @kbd{H},
@kbd{M} and @kbd{L} to place the current line in the Home (Middle, and
-Last) line of the window.@refill
+Last) line of the window.
@node Counts
@subsection Counts
Thus @kbd{d r} will delete the current region. If @kbd{R} is used instead
of @kbd{r} the region will first be enlarged so that it will become the
smallest region containing the original region and consisting of whole
-lines. Thus @kbd{m .@: d R} will have the same effect as @kbd{d d}.@refill
+lines. Thus @kbd{m .@: d R} will have the same effect as @kbd{d d}.
@node New Commands
@subsection Some New Commands
will be in vi mode again. You can give a count before typing @kbd{\}.
Thus @kbd{5 \ *}, as well as @kbd{\ C-u 5 *}, will insert @samp{*****}
before point. Similarly @kbd{1 0 \ C-p} will move the point 10 lines above
-the current line.@refill
+the current line.
@item K
@kindex 113 @kbd{K} (@code{vip-kill-buffer})
Kill current buffer if it is not modified. Useful when you selected a
If followed by a certain character @var{ch}, it becomes an operator whose
argument is the region determined by the motion command that follows.
Currently, @var{ch} can be one of @kbd{c}, @kbd{C}, @kbd{g}, @kbd{q} and
-@kbd{s}.@refill
+@kbd{s}.
@item # c
@kindex 0432 @kbd{# c} (@code{downcase-region})
Change upper-case characters in the region to lower case
@item # g
@kindex 0432 @kbd{# g} (@code{vip-global-execute})
Execute last keyboard macro for each line in the region
-(@code{vip-global-execute}).@refill
+(@code{vip-global-execute}).
@item # q
@kindex 0432 @kbd{# q} (@code{vip-quote-region})
Insert specified string at the beginning of each line in the region
the idea here is that you can execute useful Emacs commands without typing
control characters. For example, if you hit @kbd{X} (or @kbd{C-x}) followed
by @kbd{2}, then the current window will be split into 2 and you will be in
-vi mode again.@refill
+vi mode again.
@end table
In addition to these, @code{ctl-x-map} is slightly modified:
a prefix to the commands. A numeric argument is also called a @dfn{count}.
In many cases, if a count is given, the command is executed that many times.
For instance, @kbd{5 d d} deletes 5 lines while simple @kbd{d d} deletes a
-line. In this manual the metavariable @var{n} will denote a count.@refill
+line. In this manual the metavariable @var{n} will denote a count.
@node Important Keys
@section Important Keys
In Emacs many commands are bound to the key strokes that start with
@kbd{C-x}, @kbd{C-c} and @key{ESC}. These commands can be
-accessed from vi mode as easily as from emacs mode.@refill
+accessed from vi mode as easily as from emacs mode.
@table @kbd
@item C-x
and you can execute a single Emacs command. After executing the
Emacs command you will be in vi mode again. You can give a count before
typing @kbd{\}. Thus @kbd{5 \ +}, as well as @kbd{\ C-u 5 +}, will insert
-@samp{+++++} before point.@refill
+@samp{+++++} before point.
@end table
@node Buffers and Windows
In Emacs the text you edit is stored in a @dfn{buffer}.
See GNU Emacs Manual, for details. There is always one @dfn{current}
-buffer, also called the @dfn{selected buffer}.@refill
+buffer, also called the @dfn{selected buffer}.
@cindex window
@cindex modified (buffer)
@dfn{default directory} which is specific to each buffer. Suppose, for
instance, that the default directory of the current buffer is
@file{/usr/masahiko/lisp/}. Then you will get the following prompt in the
-minibuffer.@refill
+minibuffer.
@example
visit file: /usr/masahiko/lisp/
@end example
You can verify which file you are editing by typing @kbd{g}. (You can also
type @kbd{X B} to get information on other buffers too.) If you type
-@kbd{g} you will get an information like below in the echo area:@refill
+@kbd{g} you will get an information like below in the echo area:
@example
"/usr/masahiko/man/vip.texinfo" line 921 of 1949
@end example
associated with the buffer (@file{/usr/masahiko/man/vip.texinfo}, in this
case), you can just say @kbd{X S}. If you wish to save it in another file,
you can type @kbd{X W}. You will then get a similar prompt as you get for
-@kbd{v}, to which you can enter the file name.@refill
+@kbd{v}, to which you can enter the file name.
@node Viewing the Buffer
@section Viewing the Buffer
wish to change it to @samp{bar}, you can type @kbd{c w}. Then, as @kbd{w}
is a point command, you will get the prompt @samp{foo =>} in the
minibuffer, for which you can type @kbd{b a r @key{RET}} to complete the change
-command.@refill
+command.
@table @kbd
@item c c
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
+Please use the Ex command @kbd{:submitReport} for this purpose.
@insertcopying
@end ifnottex
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
+Please use the Ex command @kbd{:submitReport} for this purpose.
@end iftex
@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
+GNU Emacs Manual}, for an example.
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
+character on the line. This is the default Emacs behavior.
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
+modify the default editing style. @xref{Customization}.
In addition to the @dfn{point}, there is another distinguished buffer
position called the @dfn{mark}. @xref{Mark,,Mark,emacs,The GNU Emacs
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
+@xref{Basics}, for more info.
@cindex window
@cindex mode line
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
+commands.
@cindex mode
@cindex keymap
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
+GNU Emacs Manual}, for more information.
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
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
+GNU Emacs Manual}.
@cindex Viper as minor mode
@cindex Control keys
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
+more information.
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
@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
+more info.
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
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
+@kbd{:vi}, and similar old-style Vi commands.)
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, @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
+change to Vi state.
For users who chose to set their user level to 1 at Viper setup time,
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
+replacement state.
@end table
@cindex mode line
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
+Vi}, for more.
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
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
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{.}'.
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
+to see how to do this.
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},
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{[<a-z>} where <a-z> are the
-textmarkers, e.g., @kbd{[a} to view marker @samp{a} .@refill
+textmarkers, e.g., @kbd{[a} to view marker @samp{a} .
@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
+@kbd{: @key{RET}}.
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
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
+back to normal tabs.
@end itemize
@node Improvements over Vi
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
+@dfn{line commands}.
@cindex point commands
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
+Auto-Save,emacs,The GNU Emacs Manual}.
@comment [ balance parens
@cindex viewing registers and markers
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
+execute the last macro that was executed using @kbd{@@register}.
Viper will automatically lowercase the register, so that pressing the
@kbd{SHIFT} key for @kbd{@@} will not create problems. This is for
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
+details.
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
@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
+Search,emacs,The GNU Emacs Manual}.
@cindex query replace
command from the current major mode. @key{ESC} will do the same, if you
configure @key{ESC} as Meta by setting @code{viper-no-multiple-ESC} to @code{nil}
in @file{.viper}. @xref{Customization}. @kbd{C-\} in Insert, Replace, or Vi
-states will make Emacs think @kbd{Meta} has been hit.@refill
+states will make Emacs think @kbd{Meta} has been hit.
@item \
@kindex @kbd{\}
Escape to Emacs to execute a single Emacs command. For instance,
(indicated as <move>).
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
+prepend this string to each line in the buffer.
@item # c
@kindex @kbd{#c<move>}
@cindex changing case
@item # g
@kindex @kbd{#g<move>}
Execute last keyboard macro for each line in the region
-(@code{viper-global-execute}).@refill
+(@code{viper-global-execute}).
@item # q
@kindex @kbd{#q<move>}
Insert specified string at the beginning of each line in the region
@item g <@emph{movement command}>
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
+@xref{Improved Search}, for details.
@item C-g and C-]
@kindex @kbd{C-g}
@kindex @kbd{C-]}
@noindent
Emacs Lisp archives exist on
@samp{archive.cis.ohio-state.edu}
-and @samp{wuarchive.wustl.edu}@refill
+and @samp{wuarchive.wustl.edu}
@node Customization
'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
+prior to loading Viper (i.e., prior to @code{(require 'viper)} command.
@item
@cindex :customize
By executing the @kbd{:customize} Ex command. This takes you to the Emacs
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
+Manual}.
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
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
+found on the Vi archives. This reference has been adapted for Viper.
@menu
* Groundwork:: Textual Conventions and Viper basics
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
+@dfn{line commands}.
@cindex point commands
@cindex @samp{#} (Previous file)
Similarly, @samp{#} expands to the previous file. The previous file is the
first file in @kbd{:args} listing. This defaults to the previous file in
-the VI sense if you have one window.@refill
+the VI sense if you have one window.
Symbols @samp{%} and @samp{#} are also used in the Ex commands @kbd{:e} and
@kbd{:r <shell-cmd>}. The commands @kbd{:w} and the regular @kbd{:r
This command can take a prefix argument. Note: Viper sets this
binding only if this mouse action is not
already bound to something else.
-@xref{Viper Specials}, for more information.@refill
+@xref{Viper Specials}, for more information.
@item S-Mouse-2
Holding Shift and clicking button 2 of the mouse will
This command can also take a prefix argument.
Note: Viper sets this binding only if this mouse action is not
already bound to something else.
-@xref{Viper Specials}, for more details.@refill
+@xref{Viper Specials}, for more details.
@end table
@kindex @kbd{S-Mouse-1}
@kindex @kbd{S-Mouse-2}
This should be called after creating all the widgets and before allowing
the user to edit them.
-@refill
@end defun
If you want to insert text outside the widgets in the form, the
@key{TAB} and @kbd{C-@key{TAB}} are bound to @code{widget-forward} and
@code{widget-backward}, respectively. @key{RET} and @kbd{Mouse-2}
are bound to @code{widget-button-press} and
-@code{widget-button-click}.@refill
+@code{widget-button-click}.
@end defvr
@defvar widget-global-map
@defun widget-prompt-value widget prompt [ value unbound ]
Prompt for a value matching @var{widget}, using @var{prompt}.
The current value is assumed to be @var{value}, unless @var{unbound} is
-non-@code{nil}.@refill
+non-@code{nil}.
@end defun
@defun widget-get-sibling widget
HCoop / bpt / emacs.git / commitdiff