mirror of
https://git.savannah.gnu.org/git/emacs.git
synced 2024-12-27 10:54:40 +00:00
Remove remaining @refills from doc/*/*.texi files
This commit is contained in:
Glenn Morris
parent
bc4aaa31e2
commit
76f1a3c314
@ -1,5 +1,8 @@
|
||||
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.
|
||||
|
||||
@ -1089,7 +1089,7 @@ of data with the command @kbd{M-x recover-file @key{RET} @var{file}
|
||||
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}
|
||||
|
||||
@ -256,7 +256,7 @@ abbreviation for a name into the entire name. Completion is done for
|
||||
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
|
||||
|
||||
@ -423,7 +423,7 @@ ring. But you can force it to append by first typing the command
|
||||
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.
|
||||
|
||||
@ -668,7 +668,7 @@ it possible to match the rest of the pattern. For example, in matching
|
||||
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
|
||||
@ -830,11 +830,11 @@ either @var{a} matches it or @var{b} matches it. It works by trying to
|
||||
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{\|}.
|
||||
|
||||
@ -850,7 +850,7 @@ Thus, @samp{\(foo\|bar\)x} matches either @samp{foox} or @samp{barx}.
|
||||
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.
|
||||
@ -912,7 +912,7 @@ matches the empty string, but only at point.
|
||||
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.
|
||||
@ -1005,7 +1005,7 @@ searching through, if you specify the text in lower case. Thus, if
|
||||
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
|
||||
|
||||
@ -256,7 +256,7 @@ This means that @var{nick} should expand into @var{fulladdresses},
|
||||
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
|
||||
|
||||
@ -1,12 +1,16 @@
|
||||
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>
|
||||
|
||||
|
||||
@ -523,7 +523,7 @@ GNU Emacs Lisp and Common Lisp. @code{setq}, @code{if}, and
|
||||
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
|
||||
|
||||
@ -2378,7 +2378,7 @@ buffer's default directory is prepended to @var{directory}, if
|
||||
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
|
||||
@ -2409,7 +2409,7 @@ function returns @code{t}. The function returns @code{nil} if directory
|
||||
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
|
||||
@ -2438,7 +2438,7 @@ has five files whose names begin with @samp{f}: @file{foo},
|
||||
@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:
|
||||
|
||||
|
||||
@ -456,7 +456,7 @@ described using a format like that for functions, except that there
|
||||
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
|
||||
|
||||
@ -1301,7 +1301,7 @@ called @dfn{subrs} or @dfn{built-in functions}. (The word ``subr'' is
|
||||
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
|
||||
|
||||
@ -273,12 +273,12 @@ expression is ordinary, unless a @samp{\} precedes it.
|
||||
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
|
||||
@ -304,7 +304,7 @@ expression.
|
||||
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
|
||||
@ -488,7 +488,7 @@ example, the regular expression that matches the @samp{\} character is
|
||||
@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
|
||||
@ -496,7 +496,7 @@ are treated as ordinary ones if they are in contexts where their special
|
||||
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
|
||||
@ -599,14 +599,14 @@ a table of the special @samp{\} constructs.
|
||||
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
|
||||
@ -785,7 +785,7 @@ matches the empty string, but only at point.
|
||||
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.
|
||||
|
||||
@ -1,5 +1,9 @@
|
||||
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.
|
||||
|
||||
@ -560,7 +560,7 @@ of marked files.
|
||||
@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
|
||||
@ -568,7 +568,6 @@ If non-@code{nil}, a user-defined alist of file regexps and their suggested
|
||||
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
|
||||
|
||||
|
||||
@ -138,7 +138,7 @@ list of the pseudo-class @samp{*Globals*};
|
||||
|
||||
@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
|
||||
@ -210,7 +210,7 @@ per line.
|
||||
|
||||
@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
|
||||
@ -478,12 +478,12 @@ name.
|
||||
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
|
||||
@ -570,7 +570,7 @@ positions the cursor on the class in the class tree.
|
||||
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.
|
||||
|
||||
@ -634,7 +634,7 @@ Here is an example of a tree buffer with file names displayed.
|
||||
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.
|
||||
@ -734,7 +734,7 @@ context menu.
|
||||
|
||||
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
|
||||
@ -1292,7 +1292,7 @@ When jumping to a member declaration or definition with one of
|
||||
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
|
||||
|
||||
@ -1564,26 +1564,22 @@ Type: @code{string} @*
|
||||
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
|
||||
|
||||
@ -1656,35 +1652,30 @@ Make sure placeholder @var{THIS} is replaced with the real thing, and pass throu
|
||||
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} @*
|
||||
@ -1692,7 +1683,6 @@ 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} @*
|
||||
@ -1700,7 +1690,6 @@ 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} @*
|
||||
@ -1709,19 +1698,16 @@ Default Value: @code{("debug" "release")}
|
||||
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
|
||||
|
||||
@ -1966,7 +1952,6 @@ buffer's @code{default-directory} (not starting with a /). Directories
|
||||
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} @*
|
||||
@ -1976,7 +1961,6 @@ The system include path for files in this project.
|
||||
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} @*
|
||||
@ -1988,7 +1972,6 @@ These macros might be passed in through the command line compiler, or
|
||||
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} @*
|
||||
@ -1998,14 +1981,12 @@ C header file with Preprocessor macros for your files.
|
||||
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)} @*
|
||||
@ -2020,7 +2001,6 @@ The function symbol must take two arguments:
|
||||
|
||||
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
|
||||
|
||||
@ -2144,14 +2124,12 @@ The type of Makefile to generate.
|
||||
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} @*
|
||||
@ -2159,27 +2137,23 @@ Default Value: @code{("debug" (("DEBUG" . "1")))}
|
||||
|
||||
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} @*
|
||||
@ -2190,7 +2164,6 @@ Usually, a subproject is determined by a parent project. If multiple top level
|
||||
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
|
||||
|
||||
@ -2380,7 +2353,6 @@ Type: @code{list} @*
|
||||
Default Value: @code{nil}
|
||||
|
||||
Variables to set in this Makefile, at top of file.
|
||||
@refill
|
||||
|
||||
@item :additional-variables
|
||||
Type: @code{(or null list)} @*
|
||||
@ -2388,7 +2360,6 @@ Default Value: @code{nil}
|
||||
|
||||
Arbitrary variables needed from this project.
|
||||
It is safe to leave this blank.
|
||||
@refill
|
||||
|
||||
@item :additional-rules
|
||||
Type: @code{(or null list)} @*
|
||||
@ -2396,7 +2367,6 @@ Default Value: @code{nil}
|
||||
|
||||
Arbitrary rules and dependencies needed to make this target.
|
||||
It is safe to leave this blank.
|
||||
@refill
|
||||
|
||||
@item :installation-domain
|
||||
Type: @code{symbol} @*
|
||||
@ -2404,7 +2374,6 @@ Default Value: @code{user}
|
||||
|
||||
Installation domain specification.
|
||||
The variable GNUSTEP_INSTALLATION_DOMAIN is set at this value.
|
||||
@refill
|
||||
|
||||
@item :preamble
|
||||
Type: @code{(or null list)} @*
|
||||
@ -2412,7 +2381,6 @@ Default Value: @code{(quote ("GNUmakefile.preamble"))}
|
||||
|
||||
The auxiliary makefile for additional variables.
|
||||
Included just before the specific target files.
|
||||
@refill
|
||||
|
||||
@item :postamble
|
||||
Type: @code{(or null list)} @*
|
||||
@ -2420,7 +2388,6 @@ Default Value: @code{(quote ("GNUmakefile.postamble"))}
|
||||
|
||||
The auxiliary makefile for additional rules.
|
||||
Included just after the specific target files.
|
||||
@refill
|
||||
|
||||
@item :metasubproject
|
||||
Type: @code{boolean} @*
|
||||
@ -2431,7 +2398,6 @@ Usually, a subproject is determined by a parent project. If multiple top level
|
||||
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
|
||||
|
||||
@ -2536,21 +2502,18 @@ Commit change to local variables in @var{PROJ}.
|
||||
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} @*
|
||||
@ -2560,7 +2523,6 @@ Source files with a version string in them.
|
||||
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
|
||||
|
||||
@ -2752,14 +2714,12 @@ Retrieves the slot @code{menu} from an object of class @code{ede-target}
|
||||
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} @*
|
||||
@ -2768,7 +2728,6 @@ Default Value: @code{nil}
|
||||
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)} @*
|
||||
@ -2778,7 +2737,6 @@ The compiler to be used to compile this object.
|
||||
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)} @*
|
||||
@ -2788,7 +2746,6 @@ The linker to be used to link compiled sources for this object.
|
||||
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
|
||||
|
||||
@ -2950,7 +2907,6 @@ Type: @code{string} @*
|
||||
Default Value: @code{"Makefile"}
|
||||
|
||||
File name of generated Makefile.
|
||||
@refill
|
||||
|
||||
@item :partofall
|
||||
Type: @code{boolean} @*
|
||||
@ -2959,7 +2915,6 @@ Default Value: @code{t}
|
||||
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} @*
|
||||
@ -2969,7 +2924,6 @@ Makefile variables appended to use in different configurations.
|
||||
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} @*
|
||||
@ -2977,7 +2931,6 @@ Default Value: @code{nil}
|
||||
|
||||
Arbitrary rules and dependencies needed to make this target.
|
||||
It is safe to leave this blank.
|
||||
@refill
|
||||
|
||||
@end table
|
||||
|
||||
@ -3221,7 +3174,6 @@ The linker flag "-l" is automatically prepended. Do not include a "lib"
|
||||
prefix, or a ".so" suffix.
|
||||
|
||||
Note: Currently only used for Automake projects.
|
||||
@refill
|
||||
|
||||
@item :ldflags
|
||||
Type: @code{list} @*
|
||||
@ -3232,7 +3184,6 @@ Use ldlibs to add addition libraries. Use this to specify specific
|
||||
options to the linker.
|
||||
|
||||
Note: Not currently used. This bug needs to be fixed.
|
||||
@refill
|
||||
|
||||
@end table
|
||||
|
||||
@ -3358,7 +3309,6 @@ Additional packages needed.
|
||||
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
|
||||
|
||||
@ -3439,7 +3389,6 @@ Default Value: @code{"loaddefs.el"}
|
||||
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} @*
|
||||
@ -3447,7 +3396,6 @@ Default Value: @code{nil}
|
||||
|
||||
The directories to scan for autoload definitions.
|
||||
If @code{nil} defaults to the current directory.
|
||||
@refill
|
||||
|
||||
@end table
|
||||
|
||||
@ -3547,7 +3495,6 @@ Default Value: @code{""}
|
||||
|
||||
Miscellaneous sources which have a specialized makefile.
|
||||
The sub-makefile is used to build this target.
|
||||
@refill
|
||||
|
||||
@end table
|
||||
|
||||
@ -3604,7 +3551,6 @@ Default Value: @code{""}
|
||||
|
||||
The main menu resides in this file.
|
||||
All other sources should be included independently.
|
||||
@refill
|
||||
|
||||
@end table
|
||||
|
||||
@ -3687,7 +3633,6 @@ Type: @code{string} @*
|
||||
Default Value: @code{"guile"}
|
||||
|
||||
The preferred interpreter for this code.
|
||||
@refill
|
||||
|
||||
@end table
|
||||
|
||||
@ -3817,7 +3762,6 @@ No children
|
||||
Default Value: @code{nil}
|
||||
|
||||
Additional LD args.
|
||||
@refill
|
||||
@end table
|
||||
@end table
|
||||
|
||||
@ -3949,7 +3893,6 @@ No children
|
||||
Default Value: @code{nil}
|
||||
|
||||
Additional texinfo included in this one.
|
||||
@refill
|
||||
|
||||
@end table
|
||||
@end table
|
||||
@ -4036,21 +3979,18 @@ Type: @code{eieio-instance-inheritor-child}
|
||||
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)} @*
|
||||
@ -4059,7 +3999,6 @@ Default Value: @code{nil}
|
||||
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} @*
|
||||
@ -4069,7 +4008,6 @@ Non @code{nil} if this sourcecode type uses subdirectores.
|
||||
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} @*
|
||||
@ -4078,7 +4016,6 @@ Default Value: @code{nil}
|
||||
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
|
||||
|
||||
@ -4158,13 +4095,11 @@ Type: @code{eieio-instance-inheritor-child}
|
||||
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}
|
||||
@ -4173,7 +4108,6 @@ Variables needed in the Makefile for this compiler.
|
||||
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}
|
||||
@ -4181,7 +4115,6 @@ 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} @*
|
||||
@ -4189,7 +4122,6 @@ Default Value: @code{nil}
|
||||
|
||||
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}
|
||||
@ -4197,7 +4129,6 @@ 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} @*
|
||||
@ -4208,14 +4139,12 @@ When a project is in Automake mode, this defines the autoconf function to
|
||||
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
|
||||
|
||||
@ -4285,13 +4214,11 @@ Type: @code{eieio-instance-inheritor-child}
|
||||
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}
|
||||
@ -4300,7 +4227,6 @@ Variables needed in the Makefile for this compiler.
|
||||
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}
|
||||
@ -4308,7 +4234,6 @@ 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}
|
||||
@ -4316,21 +4241,18 @@ 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} @*
|
||||
@ -4339,7 +4261,6 @@ Default Value: @code{nil}
|
||||
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
|
||||
|
||||
@ -4399,7 +4320,6 @@ Default Value: @code{t}
|
||||
Type: @code{list}
|
||||
|
||||
A variable dedicated to dependency generation.
|
||||
@refill
|
||||
@end table
|
||||
@end table
|
||||
|
||||
@ -4439,7 +4359,6 @@ No children
|
||||
Type: @code{string}
|
||||
|
||||
Name of this type of compiler.
|
||||
@refill
|
||||
|
||||
@item :variables
|
||||
Type: @code{list}
|
||||
@ -4448,7 +4367,6 @@ Variables needed in the Makefile for this compiler.
|
||||
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}
|
||||
@ -4456,7 +4374,6 @@ 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}
|
||||
@ -4464,14 +4381,12 @@ 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
|
||||
|
||||
@ -1625,7 +1625,6 @@ inherit from a special class stored in
|
||||
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:
|
||||
|
||||
|
||||
@ -158,25 +158,25 @@ The following persons have made contributions to Eshell.
|
||||
@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,
|
||||
|
||||
@ -176,18 +176,18 @@ PCL-CVS as well as all the documentation.
|
||||
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
|
||||
@ -297,7 +297,7 @@ You can move the cursor up and down in the buffer with @kbd{C-n} and
|
||||
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
|
||||
@ -324,7 +324,7 @@ how we got to the current state, for example @samp{patched},
|
||||
|
||||
@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.
|
||||
@ -350,7 +350,7 @@ the following substatus:
|
||||
@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
|
||||
@ -360,7 +360,7 @@ working directory) is now the output of the @code{rcsmerge} command on
|
||||
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
|
||||
@ -382,17 +382,17 @@ repository.
|
||||
|
||||
@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.
|
||||
@ -400,29 +400,29 @@ This status can have a substatus of:
|
||||
|
||||
@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
|
||||
@ -610,11 +610,11 @@ explicitly. The special prefixes are:
|
||||
|
||||
@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.
|
||||
@ -640,13 +640,13 @@ to update the display:
|
||||
|
||||
@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,
|
||||
@ -656,18 +656,18 @@ files/directories with these keys:
|
||||
@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
|
||||
|
||||
|
||||
@ -689,7 +689,7 @@ the fact that the buffer is a PCL-CVS buffer:
|
||||
@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
|
||||
@ -725,12 +725,12 @@ You can mark and unmark files with these commands:
|
||||
@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}).
|
||||
@ -774,7 +774,7 @@ Committing changes basically works as follows:
|
||||
@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
|
||||
@ -782,7 +782,7 @@ commit (@pxref{Log Edit Mode}).
|
||||
|
||||
@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
|
||||
@ -841,13 +841,13 @@ the cursor points to a directory, run @code{dired} on that directory;
|
||||
|
||||
@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
|
||||
|
||||
|
||||
@ -897,7 +897,7 @@ Add all selected files. This command can be used on @samp{Unknown}
|
||||
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.
|
||||
@ -911,7 +911,7 @@ confirmation). The files are deleted from your directory and
|
||||
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
|
||||
@ -957,7 +957,7 @@ get an overview of what needs to be done.
|
||||
@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
|
||||
@ -1008,22 +1008,22 @@ This runs @code{cvs-mode-ignore}.
|
||||
@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
|
||||
@ -1035,12 +1035,12 @@ a checkout, update or commit operation
|
||||
@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
|
||||
@ -1075,7 +1075,7 @@ to do an interactive 3-way merge.
|
||||
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
|
||||
@ -1247,24 +1247,24 @@ argument, these commands move that many messages of 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
|
||||
|
||||
106
doc/misc/sc.texi
106
doc/misc/sc.texi
@ -146,7 +146,7 @@ Supercite should provide them. For example, many people would like to
|
||||
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
|
||||
@ -156,7 +156,7 @@ But by previously agreed upon convention, any text above 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
|
||||
@ -168,14 +168,14 @@ by calling a hook variable to which Supercite's top-level function
|
||||
@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
|
||||
@ -207,7 +207,7 @@ Supercited text and will fill them appropriately. Emacs's built-in
|
||||
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
|
||||
@ -216,7 +216,7 @@ informative citations throughout. Supercite tries to be as configurable
|
||||
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
|
||||
@ -304,7 +304,7 @@ string containing four spaces.
|
||||
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
|
||||
@ -330,7 +330,7 @@ In this case, the composed, non-nested citation string used might be
|
||||
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
|
||||
@ -379,7 +379,7 @@ non-nested citation. Thus the variable
|
||||
@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
|
||||
@ -400,7 +400,7 @@ In the case of mail fields, the key is the name of the field, omitting
|
||||
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
|
||||
@ -489,7 +489,7 @@ the author's first middle name.
|
||||
|
||||
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
|
||||
@ -540,7 +540,7 @@ examples below as @var{infokey} indicates that the corresponding value
|
||||
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-)
|
||||
@ -650,7 +650,7 @@ The following commands are available while in electric reference mode
|
||||
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
|
||||
@ -658,7 +658,7 @@ will wrap around to the first header.@refill
|
||||
@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
|
||||
@ -667,7 +667,7 @@ invoking @code{sc-eref-prev} will wrap around to the last header.@refill
|
||||
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
|
||||
@ -681,7 +681,7 @@ value of @code{sc-preferred-header-style}.
|
||||
@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
|
||||
@ -690,7 +690,7 @@ Set the preferred reference header (i.e.,
|
||||
@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
|
||||
@ -729,7 +729,7 @@ hook variable has a @code{nil} value, which the MUA recognizes to mean,
|
||||
``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
|
||||
@ -767,7 +767,7 @@ expects the original article's mail headers to be present within this
|
||||
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
|
||||
@ -784,7 +784,7 @@ this hook since it is only run once. This will not work, however, if
|
||||
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
|
||||
@ -814,7 +814,7 @@ This hook variable is run before @code{sc-cite-original} does any other
|
||||
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.}
|
||||
@ -942,7 +942,7 @@ there as people on the net, or just about! It would be impossible for
|
||||
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}.}
|
||||
@ -951,7 +951,7 @@ recognize those styles you see often.
|
||||
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
|
||||
@ -987,7 +987,7 @@ setup.
|
||||
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
|
||||
@ -1005,7 +1005,7 @@ When Supercite's automatic filling breaks on a particular message, I
|
||||
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
|
||||
@ -1013,7 +1013,7 @@ your tastes, you might consider one of these alternate approaches.
|
||||
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
|
||||
@ -1025,7 +1025,7 @@ string will display @samp{SC:f}, and when just
|
||||
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
|
||||
@ -1088,7 +1088,7 @@ the author's first middle name.
|
||||
|
||||
@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
|
||||
@ -1099,7 +1099,7 @@ key. See below for details.
|
||||
|
||||
@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,
|
||||
@ -1184,7 +1184,7 @@ case. If the variable's value is non-@code{nil}, then
|
||||
@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
|
||||
@ -1244,7 +1244,7 @@ variables in your hook functions, you change the attribution and
|
||||
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
|
||||
@ -1376,7 +1376,7 @@ matched against the current line, from the beginning, using
|
||||
@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:
|
||||
|
||||
@ -1405,7 +1405,7 @@ processing. By default, if your @var{func} returns @code{nil} (as it
|
||||
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}
|
||||
@ -1422,16 +1422,16 @@ entry is still processed.
|
||||
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
|
||||
@ -1471,7 +1471,7 @@ preferred style.
|
||||
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
|
||||
@ -1500,7 +1500,7 @@ Where @var{infokey} is a key suitable for @code{sc-mail-field},
|
||||
@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
|
||||
@ -1524,7 +1524,7 @@ variable @code{sc-mode-map-prefix}. By default, the
|
||||
@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::
|
||||
@ -1546,7 +1546,7 @@ paragraph to use a nickname, or manually cite a message when setting
|
||||
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:
|
||||
|
||||
@ -1567,7 +1567,7 @@ frame @code{sc-default-cite-frame}. It runs the hook
|
||||
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-)
|
||||
@ -1578,7 +1578,7 @@ cited line in the region by interpreting the selected frame from
|
||||
@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-)
|
||||
@ -1588,7 +1588,7 @@ This command recites each line the region by interpreting the selected
|
||||
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-)
|
||||
@ -1612,7 +1612,7 @@ Inserts a reference header into the reply buffer at @samp{point}. With
|
||||
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}.
|
||||
@ -1640,7 +1640,7 @@ this easy to do.
|
||||
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:
|
||||
@ -1700,7 +1700,7 @@ One special command is provided to toggle both
|
||||
@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.
|
||||
@ -1711,7 +1711,7 @@ 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
|
||||
@ -1753,7 +1753,7 @@ This function is especially useful for replying to digest messages where
|
||||
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
|
||||
@ -1767,7 +1767,7 @@ old information is lost.@refill
|
||||
@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
|
||||
@ -1810,7 +1810,7 @@ the release of Emacs 19. Instead of the variable
|
||||
@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
|
||||
@ -1826,7 +1826,7 @@ buffer. At this point you should not modify the raw text in any way
|
||||
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
|
||||
@ -1835,7 +1835,7 @@ message text. It is very important that the region be set around the
|
||||
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
|
||||
@ -1846,7 +1846,7 @@ yanking function, check its value. If it finds
|
||||
@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
|
||||
|
||||
@ -247,7 +247,6 @@ features of the current file name, user name, time, etc.
|
||||
|
||||
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
|
||||
@ -257,7 +256,6 @@ contexts to have the same name. Some standard contexts are
|
||||
|
||||
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
|
||||
@ -781,7 +779,6 @@ All the text and macros within a section are either not shown at all
|
||||
(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:
|
||||
|
||||
@ -56,7 +56,7 @@ you start using VIP@. Other nodes may be visited as needed.
|
||||
|
||||
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
|
||||
|
||||
@ -128,14 +128,13 @@ the character; otherwise we say that point is @dfn{at the end of buffer}.
|
||||
@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
|
||||
@ -149,7 +148,7 @@ buffers. Each buffer has its @dfn{local keymap} that determines the
|
||||
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
|
||||
@ -187,7 +186,7 @@ Loading VIP has the effect of globally binding @kbd{C-z} (@kbd{Control-z})
|
||||
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
|
||||
|
||||
@ -198,12 +197,12 @@ called and you will be in @dfn{vi mode}. (Some major modes may locally bind
|
||||
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
|
||||
@ -219,7 +218,7 @@ Thus the word @samp{Emacs} in the mode line will change to @samp{Vi}.
|
||||
@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.
|
||||
@ -265,7 +264,7 @@ emacs mode vi mode insert mode
|
||||
You will be in this mode just after you loaded VIP@. You can do all
|
||||
normal Emacs editing in this mode. Note that the key @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
|
||||
@ -332,7 +331,7 @@ The major differences from Vi are explained below.
|
||||
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
|
||||
@ -345,7 +344,7 @@ then VIP will prompt you for a new word in the minibuffer by the prompt
|
||||
@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
|
||||
@ -361,7 +360,7 @@ A search for empty string will toggle the search mode between vanilla
|
||||
search and regular expression search. You cannot give an offset to the
|
||||
search string. (It is a limitation.) By default, search will wrap around
|
||||
the buffer as in Vi. You can change this by rebinding the variable
|
||||
@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
|
||||
@ -376,7 +375,7 @@ the buffer as in Vi. You can change this by rebinding the variable
|
||||
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
|
||||
@ -436,7 +435,7 @@ delimited by point and mark.) The key @kbd{r} is used for this purpose.
|
||||
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
|
||||
@ -478,7 +477,7 @@ 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. 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
|
||||
@ -504,7 +503,7 @@ similar, but will use window different from the current window.
|
||||
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
|
||||
@ -517,7 +516,7 @@ Change lower-case characters in the region to upper case. For instance,
|
||||
@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
|
||||
@ -577,7 +576,7 @@ mode. You get the same effect by typing @kbd{C-x C-s} in vi mode, but
|
||||
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:
|
||||
@ -723,7 +722,7 @@ Most Vi commands accept a @dfn{numeric argument} which can be supplied as
|
||||
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
|
||||
@ -742,7 +741,7 @@ Clear the screen and reprint everything (@code{recenter}).
|
||||
|
||||
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
|
||||
@ -772,7 +771,7 @@ Escape to emacs mode. Hitting the @kbd{\} key will take you to emacs mode,
|
||||
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
|
||||
@ -784,7 +783,7 @@ typing @kbd{\}. Thus @kbd{5 \ +}, as well as @kbd{\ C-u 5 +}, will insert
|
||||
|
||||
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)
|
||||
@ -883,7 +882,7 @@ file in the current window, you can just type @kbd{v}. Emacs maintains the
|
||||
@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
|
||||
@ -911,7 +910,7 @@ window.
|
||||
|
||||
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
|
||||
@ -921,7 +920,7 @@ you may wish to save it in a file. If you wish to save it in the file
|
||||
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
|
||||
@ -1453,7 +1452,7 @@ For example, if point is at the beginning of a word @samp{foo} and you
|
||||
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
|
||||
|
||||
@ -88,7 +88,7 @@ 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
|
||||
Please use the Ex command @kbd{:submitReport} for this purpose.
|
||||
|
||||
@insertcopying
|
||||
@end ifnottex
|
||||
@ -147,7 +147,7 @@ comes with Emacs. This manual can be read as an Info file. Try the command
|
||||
|
||||
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
|
||||
|
||||
@ -197,21 +197,21 @@ 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
|
||||
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
|
||||
@ -232,7 +232,7 @@ 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
|
||||
@xref{Basics}, for more info.
|
||||
|
||||
@cindex window
|
||||
@cindex mode line
|
||||
@ -255,7 +255,7 @@ 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
|
||||
commands.
|
||||
|
||||
@cindex mode
|
||||
@cindex keymap
|
||||
@ -275,7 +275,7 @@ 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
|
||||
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
|
||||
@ -283,7 +283,7 @@ 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
|
||||
@ -293,7 +293,7 @@ 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
|
||||
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
|
||||
@ -303,7 +303,7 @@ 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
|
||||
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
|
||||
@ -357,7 +357,7 @@ command line, it will show the @samp{*scratch*} buffer, in the
|
||||
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
|
||||
@ -386,7 +386,7 @@ 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
|
||||
change to Vi state.
|
||||
|
||||
|
||||
For users who chose to set their user level to 1 at Viper setup time,
|
||||
@ -424,7 +424,7 @@ 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
|
||||
replacement state.
|
||||
@end table
|
||||
|
||||
@cindex mode line
|
||||
@ -488,7 +488,7 @@ 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
|
||||
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
|
||||
@ -541,7 +541,6 @@ functionality and no key-binding. Recursive edits are indicated by
|
||||
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
|
||||
@ -652,7 +651,6 @@ 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{.}'.
|
||||
@ -673,7 +671,7 @@ 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
|
||||
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},
|
||||
@ -823,13 +821,13 @@ 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{[<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
|
||||
@ -897,7 +895,7 @@ more powerful facilities for defining abbreviations.
|
||||
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
|
||||
@ -928,7 +926,7 @@ 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
|
||||
@dfn{line commands}.
|
||||
|
||||
@cindex point commands
|
||||
|
||||
@ -1010,7 +1008,7 @@ direction.
|
||||
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
|
||||
@ -1083,7 +1081,7 @@ 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
|
||||
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
|
||||
@ -1105,7 +1103,7 @@ The last keyboard macro can also be executed using
|
||||
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
|
||||
@ -1161,7 +1159,7 @@ 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
|
||||
Search,emacs,The GNU Emacs Manual}.
|
||||
|
||||
@cindex query replace
|
||||
|
||||
@ -1308,7 +1306,7 @@ into 2. Except for novice users, @kbd{C-c} is also set to execute an Emacs
|
||||
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,
|
||||
@ -1339,7 +1337,7 @@ argument is the region determined by the motion command that follows
|
||||
(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
|
||||
@ -1355,7 +1353,7 @@ Emacs command @kbd{M-u} does the same for words.
|
||||
@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
|
||||
@ -1401,7 +1399,7 @@ Go to end of heading.
|
||||
@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-]}
|
||||
@ -1560,7 +1558,7 @@ patches.
|
||||
@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
|
||||
@ -1583,7 +1581,7 @@ 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
|
||||
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
|
||||
@ -2780,7 +2778,7 @@ 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
|
||||
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
|
||||
@ -2994,7 +2992,7 @@ currently defined. To see all macros along with their definitions, type
|
||||
|
||||
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
|
||||
@ -3015,7 +3013,7 @@ 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
|
||||
@dfn{line commands}.
|
||||
|
||||
@cindex point commands
|
||||
|
||||
@ -4187,7 +4185,7 @@ the whole file.
|
||||
@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
|
||||
@ -4425,7 +4423,7 @@ a region under the mouse pointer.
|
||||
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
|
||||
@ -4433,7 +4431,7 @@ insert a region surrounding the mouse pointer.
|
||||
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}
|
||||
|
||||
@ -431,7 +431,6 @@ Set up a buffer to support widgets.
|
||||
|
||||
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
|
||||
@ -450,7 +449,7 @@ There is a standard widget keymap which you might find useful.
|
||||
@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
|
||||
@ -1718,7 +1717,7 @@ Keymap used in @code{widget-minor-mode}.
|
||||
@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
|
||||
|
||||
Loading…
Reference in New Issue
Block a user