procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix @findex and @vindex entries in manuals

Browse source 
* doc/emacs/building.texi:
* doc/emacs/calendar.texi:
* doc/emacs/cmdargs.texi:
* doc/emacs/mini.texi:
* doc/emacs/misc.texi:
* doc/emacs/trouble.texi:
* doc/emacs/windows.texi:
* doc/lispintro/emacs-lisp-intro.texi:
* doc/lispref/edebug.texi:
* doc/lispref/frames.texi:
* doc/lispref/os.texi:
* doc/lispref/windows.texi:
* doc/misc/cc-mode.texi:
* doc/misc/dired-x.texi:
* doc/misc/ediff.texi:
* doc/misc/mh-e.texi:
* doc/misc/pcl-cvs.texi:
* doc/misc/reftex.texi:
* doc/misc/sc.texi:
* doc/misc/vhdl-mode.texi:
* doc/misc/viper.texi: Fix @findex and @vindex entries.
This commit is contained in:
Michael Albinus 2018-02-23 15:30:19 +01:00
parent 76f5242838
commit 2dc24d5536
21 changed files with 563 additions and 562 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/emacs/building.texi
View file

@ -302,7 +302,7 @@ And here's how to do it in csh:
if ($?prompt) set prompt = @dots{} if ($?prompt) set prompt = @dots{}
@end example @end example
@vindex TERM, environment variable, in compilation mode @vindex TERM@r{, environment variable, in compilation mode}
If you want to customize the value of the @env{TERM} environment If you want to customize the value of the @env{TERM} environment
variable passed to the compilation subshell, customize the variable variable passed to the compilation subshell, customize the variable
@code{comint-terminfo-terminal} (@pxref{Shell Options}). @code{comint-terminfo-terminal} (@pxref{Shell Options}).

3
doc/emacs/calendar.texi
View file

@ -1507,7 +1507,8 @@ to the main diary file, if these are different files.
@end ifnottex @end ifnottex
@findex icalendar-export-file, icalendar-export-region @findex icalendar-export-file
@findex icalendar-export-region
Use @code{icalendar-export-file} to interactively export an entire Use @code{icalendar-export-file} to interactively export an entire
Emacs diary file to iCalendar format. To export only a part of a diary Emacs diary file to iCalendar format. To export only a part of a diary
file, mark the relevant area, and call @code{icalendar-export-region}. file, mark the relevant area, and call @code{icalendar-export-region}.

80
doc/emacs/cmdargs.texi
View file

@ -464,25 +464,25 @@ variables to be set, but it uses their values if they are set.
@c might be confused with general-purpose phrases. @c might be confused with general-purpose phrases.
@table @env @table @env
@item CDPATH @item CDPATH
@vindex CDPATH, environment variable @vindex CDPATH@r{, environment variable}
Used by the @code{cd} command to search for the directory you specify, Used by the @code{cd} command to search for the directory you specify,
when you specify a relative directory, when you specify a relative directory,
@item DBUS_SESSION_BUS_ADDRESS @item DBUS_SESSION_BUS_ADDRESS
@vindex DBUS_SESSION_BUS_ADDRESS, environment variable @vindex DBUS_SESSION_BUS_ADDRESS@r{, environment variable}
Used by D-Bus when Emacs is compiled with it. Usually, there is no Used by D-Bus when Emacs is compiled with it. Usually, there is no
need to change it. Setting it to a dummy address, like need to change it. Setting it to a dummy address, like
@samp{unix:path=/dev/null}, suppresses connections to the D-Bus session @samp{unix:path=/dev/null}, suppresses connections to the D-Bus session
bus as well as autolaunching the D-Bus session bus if not running yet. bus as well as autolaunching the D-Bus session bus if not running yet.
@item EMACSDATA @item EMACSDATA
@vindex EMACSDATA, environment variable @vindex EMACSDATA@r{, environment variable}
Directory for the architecture-independent files that come with Emacs. Directory for the architecture-independent files that come with Emacs.
This is used to initialize the variable @code{data-directory}. This is used to initialize the variable @code{data-directory}.
@item EMACSDOC @item EMACSDOC
@vindex EMACSDOC, environment variable @vindex EMACSDOC@r{, environment variable}
Directory for the documentation string file, which is used to Directory for the documentation string file, which is used to
initialize the Lisp variable @code{doc-directory}. initialize the Lisp variable @code{doc-directory}.
@item EMACSLOADPATH @item EMACSLOADPATH
@vindex EMACSLOADPATH, environment variable @vindex EMACSLOADPATH@r{, environment variable}
A colon-separated list of directories@footnote{Here and below, A colon-separated list of directories@footnote{Here and below,
whenever we say ``colon-separated list of directories'', it pertains whenever we say ``colon-separated list of directories'', it pertains
to Unix and GNU/Linux systems. On MS-DOS and MS-Windows, the to Unix and GNU/Linux systems. On MS-DOS and MS-Windows, the
@ -496,28 +496,28 @@ the default @code{load-path}. To specify an empty element in the
middle of the list, use 2 colons in a row, as in middle of the list, use 2 colons in a row, as in
@samp{EMACSLOADPATH="/tmp::/foo"}. @samp{EMACSLOADPATH="/tmp::/foo"}.
@item EMACSPATH @item EMACSPATH
@vindex EMACSPATH, environment variable @vindex EMACSPATH@r{, environment variable}
A colon-separated list of directories to search for executable files. A colon-separated list of directories to search for executable files.
If set, Emacs uses this in addition to @env{PATH} (see below) when If set, Emacs uses this in addition to @env{PATH} (see below) when
initializing the variable @code{exec-path} (@pxref{Shell}). initializing the variable @code{exec-path} (@pxref{Shell}).
@item EMAIL @item EMAIL
@vindex EMAIL, environment variable @vindex EMAIL@r{, environment variable}
@vindex user-mail-address@r{, initialization} @vindex user-mail-address@r{, initialization}
Your email address; used to initialize the Lisp variable Your email address; used to initialize the Lisp variable
@code{user-mail-address}, which the Emacs mail interface puts into the @code{user-mail-address}, which the Emacs mail interface puts into the
@samp{From} header of outgoing messages (@pxref{Mail Headers}). @samp{From} header of outgoing messages (@pxref{Mail Headers}).
@item ESHELL @item ESHELL
@vindex ESHELL, environment variable @vindex ESHELL@r{, environment variable}
Used for shell-mode to override the @env{SHELL} environment variable Used for shell-mode to override the @env{SHELL} environment variable
(@pxref{Interactive Shell}). (@pxref{Interactive Shell}).
@item HISTFILE @item HISTFILE
@vindex HISTFILE, environment variable @vindex HISTFILE@r{, environment variable}
The name of the file that shell commands are saved in between logins. The name of the file that shell commands are saved in between logins.
This variable defaults to @file{~/.bash_history} if you use Bash, to This variable defaults to @file{~/.bash_history} if you use Bash, to
@file{~/.sh_history} if you use ksh, and to @file{~/.history} @file{~/.sh_history} if you use ksh, and to @file{~/.history}
otherwise. otherwise.
@item HOME @item HOME
@vindex HOME, environment variable @vindex HOME@r{, environment variable}
The location of your files in the directory tree; used for The location of your files in the directory tree; used for
expansion of file names starting with a tilde (@file{~}). On MS-DOS, expansion of file names starting with a tilde (@file{~}). On MS-DOS,
it defaults to the directory from which Emacs was started, with it defaults to the directory from which Emacs was started, with
@ -529,7 +529,7 @@ where @var{username} is your user name), though for backwards
compatibility @file{C:/} will be used instead if a @file{.emacs} file compatibility @file{C:/} will be used instead if a @file{.emacs} file
is found there. is found there.
@item HOSTNAME @item HOSTNAME
@vindex HOSTNAME, environment variable @vindex HOSTNAME@r{, environment variable}
The name of the machine that Emacs is running on. The name of the machine that Emacs is running on.
@c complete.el is obsolete since 24.1. @c complete.el is obsolete since 24.1.
@ignore @ignore
@ -538,24 +538,24 @@ A colon-separated list of directories. Used by the @code{complete} package
to search for files. to search for files.
@end ignore @end ignore
@item INFOPATH @item INFOPATH
@vindex INFOPATH, environment variable @vindex INFOPATH@r{, environment variable}
A colon-separated list of directories in which to search for Info files. A colon-separated list of directories in which to search for Info files.
@item LC_ALL @item LC_ALL
@vindex LC_ALL, environment variable @vindex LC_ALL@r{, environment variable}
@itemx LC_COLLATE @itemx LC_COLLATE
@vindex LC_COLLATE, environment variable @vindex LC_COLLATE@r{, environment variable}
@itemx LC_CTYPE @itemx LC_CTYPE
@vindex LC_CTYPE, environment variable @vindex LC_CTYPE@r{, environment variable}
@itemx LC_MESSAGES @itemx LC_MESSAGES
@vindex LC_MESSAGES, environment variable @vindex LC_MESSAGES@r{, environment variable}
@itemx LC_MONETARY @itemx LC_MONETARY
@vindex LC_MONETARY, environment variable @vindex LC_MONETARY@r{, environment variable}
@itemx LC_NUMERIC @itemx LC_NUMERIC
@vindex LC_NUMERIC, environment variable @vindex LC_NUMERIC@r{, environment variable}
@itemx LC_TIME @itemx LC_TIME
@vindex LC_TIME, environment variable @vindex LC_TIME@r{, environment variable}
@itemx LANG @itemx LANG
@vindex LANG, environment variable @vindex LANG@r{, environment variable}
The user's preferred locale. The locale has six categories, specified The user's preferred locale. The locale has six categories, specified
by the environment variables @env{LC_COLLATE} for sorting, by the environment variables @env{LC_COLLATE} for sorting,
@env{LC_CTYPE} for character encoding, @env{LC_MESSAGES} for system @env{LC_CTYPE} for character encoding, @env{LC_MESSAGES} for system
@ -578,70 +578,70 @@ matched against entries in @code{locale-language-names},
@code{locale-preferred-coding-systems}, to select a default language @code{locale-preferred-coding-systems}, to select a default language
environment and coding system. @xref{Language Environments}. environment and coding system. @xref{Language Environments}.
@item LOGNAME @item LOGNAME
@vindex LOGNAME, environment variable @vindex LOGNAME@r{, environment variable}
The user's login name. See also @env{USER}. The user's login name. See also @env{USER}.
@item MAIL @item MAIL
@vindex MAIL, environment variable @vindex MAIL@r{, environment variable}
The name of your system mail inbox. The name of your system mail inbox.
@ifnottex @ifnottex
@item MH @item MH
@vindex MH, environment variable @vindex MH@r{, environment variable}
Name of setup file for the mh system. @xref{Top,,MH-E,mh-e, The Emacs Name of setup file for the mh system. @xref{Top,,MH-E,mh-e, The Emacs
Interface to MH}. Interface to MH}.
@end ifnottex @end ifnottex
@item NAME @item NAME
@vindex NAME, environment variable @vindex NAME@r{, environment variable}
Your real-world name. This is used to initialize the variable Your real-world name. This is used to initialize the variable
@code{user-full-name} (@pxref{Mail Headers}). @code{user-full-name} (@pxref{Mail Headers}).
@item NNTPSERVER @item NNTPSERVER
@vindex NNTPSERVER, environment variable @vindex NNTPSERVER@r{, environment variable}
The name of the news server. Used by the mh and Gnus packages. The name of the news server. Used by the mh and Gnus packages.
@item ORGANIZATION @item ORGANIZATION
@vindex ORGANIZATION, environment variable @vindex ORGANIZATION@r{, environment variable}
The name of the organization to which you belong. Used for setting the The name of the organization to which you belong. Used for setting the
@samp{Organization:} header in your posts from the Gnus package. @samp{Organization:} header in your posts from the Gnus package.
@item PATH @item PATH
@vindex PATH, environment variable @vindex PATH@r{, environment variable}
A colon-separated list of directories containing executable files. A colon-separated list of directories containing executable files.
This is used to initialize the variable @code{exec-path} This is used to initialize the variable @code{exec-path}
(@pxref{Shell}). (@pxref{Shell}).
@item PWD @item PWD
@vindex PWD, environment variable @vindex PWD@r{, environment variable}
If set, this should be the default directory when Emacs was started. If set, this should be the default directory when Emacs was started.
@item REPLYTO @item REPLYTO
@vindex REPLYTO, environment variable @vindex REPLYTO@r{, environment variable}
If set, this specifies an initial value for the variable If set, this specifies an initial value for the variable
@code{mail-default-reply-to} (@pxref{Mail Headers}). @code{mail-default-reply-to} (@pxref{Mail Headers}).
@item SAVEDIR @item SAVEDIR
@vindex SAVEDIR, environment variable @vindex SAVEDIR@r{, environment variable}
The name of a directory in which news articles are saved by default. The name of a directory in which news articles are saved by default.
Used by the Gnus package. Used by the Gnus package.
@item SHELL @item SHELL
@vindex SHELL, environment variable @vindex SHELL@r{, environment variable}
The name of an interpreter used to parse and execute programs run from The name of an interpreter used to parse and execute programs run from
inside Emacs. inside Emacs.
@item SMTPSERVER @item SMTPSERVER
@vindex SMTPSERVER, environment variable @vindex SMTPSERVER@r{, environment variable}
The name of the outgoing mail server. This is used to initialize the The name of the outgoing mail server. This is used to initialize the
variable @code{smtpmail-smtp-server} (@pxref{Mail Sending}). variable @code{smtpmail-smtp-server} (@pxref{Mail Sending}).
@cindex background mode, on @command{xterm} @cindex background mode, on @command{xterm}
@item TERM @item TERM
@vindex TERM, environment variable @vindex TERM@r{, environment variable}
The type of the terminal that Emacs is using. This variable must be The type of the terminal that Emacs is using. This variable must be
set unless Emacs is run in batch mode. On MS-DOS, it defaults to set unless Emacs is run in batch mode. On MS-DOS, it defaults to
@samp{internal}, which specifies a built-in terminal emulation that @samp{internal}, which specifies a built-in terminal emulation that
handles the machine's own display. handles the machine's own display.
@item TERMCAP @item TERMCAP
@vindex TERMCAP, environment variable @vindex TERMCAP@r{, environment variable}
The name of the termcap library file describing how to program the The name of the termcap library file describing how to program the
terminal specified by @env{TERM}. This defaults to terminal specified by @env{TERM}. This defaults to
@file{/etc/termcap}. @file{/etc/termcap}.
@item TMPDIR @item TMPDIR
@vindex TMPDIR, environment variable @vindex TMPDIR@r{, environment variable}
@itemx TMP @itemx TMP
@vindex TMP, environment variable @vindex TMP@r{, environment variable}
@itemx TEMP @itemx TEMP
@vindex TEMP, environment variable @vindex TEMP@r{, environment variable}
These environment variables are used to initialize the variable These environment variables are used to initialize the variable
@code{temporary-file-directory}, which specifies a directory in which @code{temporary-file-directory}, which specifies a directory in which
to put temporary files (@pxref{Backup}). Emacs tries to use to put temporary files (@pxref{Backup}). Emacs tries to use
@ -649,7 +649,7 @@ to put temporary files (@pxref{Backup}). Emacs tries to use
@file{/tmp}, but on MS-Windows and MS-DOS it instead falls back on @file{/tmp}, but on MS-Windows and MS-DOS it instead falls back on
@env{TMP}, then @env{TEMP}, and finally @file{c:/temp}. @env{TMP}, then @env{TEMP}, and finally @file{c:/temp}.
@item TZ @item TZ
@vindex TZ, environment variable @vindex TZ@r{, environment variable}
This specifies the default time zone and possibly also daylight This specifies the default time zone and possibly also daylight
saving time information. @xref{Time Zone Rules,,, elisp, The GNU saving time information. @xref{Time Zone Rules,,, elisp, The GNU
Emacs Lisp Reference Manual}. On MS-DOS, if @env{TZ} is not set in the Emacs Lisp Reference Manual}. On MS-DOS, if @env{TZ} is not set in the
@ -657,11 +657,11 @@ environment when Emacs starts, Emacs defines a default value as
appropriate for the country code returned by DOS@. On MS-Windows, Emacs appropriate for the country code returned by DOS@. On MS-Windows, Emacs
does not use @env{TZ} at all. does not use @env{TZ} at all.
@item USER @item USER
@vindex USER, environment variable @vindex USER@r{, environment variable}
The user's login name. See also @env{LOGNAME}. On MS-DOS, this The user's login name. See also @env{LOGNAME}. On MS-DOS, this
defaults to @samp{root}. defaults to @samp{root}.
@item VERSION_CONTROL @item VERSION_CONTROL
@vindex VERSION_CONTROL, environment variable @vindex VERSION_CONTROL@r{, environment variable}
Used to initialize the @code{version-control} variable (@pxref{Backup Used to initialize the @code{version-control} variable (@pxref{Backup
Names}). Names}).
@end table @end table

2
doc/emacs/mini.texi
View file

@ -469,7 +469,7 @@ text in the minibuffer before point. Furthermore, if there is any
text in the minibuffer after point, the rest of the completion text in the minibuffer after point, the rest of the completion
alternative must contain that text as a substring. alternative must contain that text as a substring.
@findex partial completion @findex partial-completion
@item partial-completion @item partial-completion
This aggressive completion style divides the minibuffer text into This aggressive completion style divides the minibuffer text into
words separated by hyphens or spaces, and completes each word words separated by hyphens or spaces, and completes each word

2
doc/emacs/misc.texi
View file

@ -1359,7 +1359,7 @@ directory stack if they are not already on it
underlying shell, of course. underlying shell, of course.
@vindex comint-terminfo-terminal @vindex comint-terminfo-terminal
@vindex TERM, environment variable, in sub-shell @vindex TERM@r{, environment variable, in sub-shell}
Comint mode sets the @env{TERM} environment variable to a safe default Comint mode sets the @env{TERM} environment variable to a safe default
value, but this value disables some useful features. For example, value, but this value disables some useful features. For example,
color is disabled in applications that use @env{TERM} to determine if color is disabled in applications that use @env{TERM} to determine if

2
doc/emacs/trouble.texi
View file

@ -779,7 +779,7 @@ the dribble file.
@item @item
@findex open-termscript @findex open-termscript
@cindex termscript file @cindex termscript file
@vindex TERM, environment variable, and display bugs @vindex TERM@r{, environment variable, and display bugs}
For possible display bugs, the terminal type (the value of environment For possible display bugs, the terminal type (the value of environment
variable @env{TERM}), the complete termcap entry for the terminal from variable @env{TERM}), the complete termcap entry for the terminal from
@file{/etc/termcap} (since that file is not identical on all machines), @file{/etc/termcap} (since that file is not identical on all machines),

2
doc/emacs/windows.texi
View file

@ -379,7 +379,7 @@ Several of these commands are bound in the @kbd{C-x 5} prefix key.
@node Window Choice @node Window Choice
@subsection How @code{display-buffer} works @subsection How @code{display-buffer} works
@findex display-buffer, detailed description @findex display-buffer@r{, detailed description}
The @code{display-buffer} command (as well as commands that call it The @code{display-buffer} command (as well as commands that call it
internally) chooses a window to display by following the steps given internally) chooses a window to display by following the steps given

28
doc/lispintro/emacs-lisp-intro.texi
View file

@ -1716,7 +1716,7 @@ function definition, and vice versa.
@unnumberedsubsec @code{fill-column}, an Example Variable @unnumberedsubsec @code{fill-column}, an Example Variable
@end ifnottex @end ifnottex
@findex fill-column, @r{an example variable} @findex fill-column@r{, an example variable}
@cindex Example variable, @code{fill-column} @cindex Example variable, @code{fill-column}
@cindex Variable, example of, @code{fill-column} @cindex Variable, example of, @code{fill-column}
The variable @code{fill-column} illustrates a symbol with a value The variable @code{fill-column} illustrates a symbol with a value
@ -3839,7 +3839,7 @@ message @samp{5 is greater than 4!} will be printed.
@noindent @noindent
(The function @code{>} tests whether its first argument is greater than (The function @code{>} tests whether its first argument is greater than
its second argument and returns true if it is.) its second argument and returns true if it is.)
@findex > (greater than) @findex > @r{(greater than)}
Of course, in actual use, the test in an @code{if} expression will not Of course, in actual use, the test in an @code{if} expression will not
be fixed for all time as it is by the expression @code{(> 5 4)}. be fixed for all time as it is by the expression @code{(> 5 4)}.
@ -4552,7 +4552,7 @@ buffers. Later, we will study other functions.
@node Finding More @node Finding More
@section Finding More Information @section Finding More Information
@findex describe-function, @r{introduced} @findex describe-function@r{, introduced}
@cindex Find function documentation @cindex Find function documentation
In this walk-through, I will describe each new function as we come to In this walk-through, I will describe each new function as we come to
it, sometimes in detail and sometimes briefly. If you are interested, it, sometimes in detail and sometimes briefly. If you are interested,
@ -5564,7 +5564,7 @@ outline of the function:
@node insert-buffer interactive @node insert-buffer interactive
@subsection The Interactive Expression in @code{insert-buffer} @subsection The Interactive Expression in @code{insert-buffer}
@findex interactive, @r{example use of} @findex interactive@r{, example use of}
In @code{insert-buffer}, the argument to the @code{interactive} In @code{insert-buffer}, the argument to the @code{interactive}
declaration has two parts, an asterisk, @samp{*}, and @samp{bInsert declaration has two parts, an asterisk, @samp{*}, and @samp{bInsert
@ -5881,8 +5881,8 @@ find and use again and again.
@node New insert-buffer @node New insert-buffer
@subsection New Body for @code{insert-buffer} @subsection New Body for @code{insert-buffer}
@findex insert-buffer, new version body @findex insert-buffer@r{, new version body}
@findex new version body for insert-buffer @cindex new version body for insert-buffer
The body in the GNU Emacs 22 version is more confusing than the original. The body in the GNU Emacs 22 version is more confusing than the original.
@ -6734,8 +6734,8 @@ Or can you write the function without them?
@node car cdr & cons @node car cdr & cons
@chapter @code{car}, @code{cdr}, @code{cons}: Fundamental Functions @chapter @code{car}, @code{cdr}, @code{cons}: Fundamental Functions
@findex car, @r{introduced} @findex car@r{, introduced}
@findex cdr, @r{introduced} @findex cdr@r{, introduced}
In Lisp, @code{car}, @code{cdr}, and @code{cons} are fundamental In Lisp, @code{car}, @code{cdr}, and @code{cons} are fundamental
functions. The @code{cons} function is used to construct lists, and functions. The @code{cons} function is used to construct lists, and
@ -6900,7 +6900,7 @@ Emacs Lisp Reference Manual}.)
@node cons @node cons
@section @code{cons} @section @code{cons}
@findex cons, @r{introduced} @findex cons@r{, introduced}
The @code{cons} function constructs lists; it is the inverse of The @code{cons} function constructs lists; it is the inverse of
@code{car} and @code{cdr}. For example, @code{cons} can be used to make @code{car} and @code{cdr}. For example, @code{cons} can be used to make
@ -8715,7 +8715,7 @@ example-list
@noindent @noindent
Now, we can add a new element on to this list by evaluating the Now, we can add a new element on to this list by evaluating the
following expression: following expression:
@findex push, @r{example} @findex push@r{, example}
@smallexample @smallexample
(push "a third clause" example-list) (push "a third clause" example-list)
@ -8762,13 +8762,13 @@ element of the kill ring---this means that since the @sc{cdr} of the
next to last element is the last element of the kill ring, it will set next to last element is the last element of the kill ring, it will set
the last element of the kill ring. the last element of the kill ring.
@findex nthcdr, @r{example} @findex nthcdr@r{, example}
The @code{nthcdr} function works by repeatedly taking the @sc{cdr} of a The @code{nthcdr} function works by repeatedly taking the @sc{cdr} of a
list---it takes the @sc{cdr} of the @sc{cdr} of the @sc{cdr} list---it takes the @sc{cdr} of the @sc{cdr} of the @sc{cdr}
@dots{} It does this @var{N} times and returns the results. @dots{} It does this @var{N} times and returns the results.
(@xref{nthcdr, , @code{nthcdr}}.) (@xref{nthcdr, , @code{nthcdr}}.)
@findex setcdr, @r{example} @findex setcdr@r{, example}
Thus, if we had a four element list that was supposed to be three Thus, if we had a four element list that was supposed to be three
elements long, we could set the @sc{cdr} of the next to last element elements long, we could set the @sc{cdr} of the next to last element
to @code{nil}, and thereby shorten the list. (If you set the last to @code{nil}, and thereby shorten the list. (If you set the last
@ -17177,8 +17177,8 @@ file, as I intended, I accidentally set the width for filled text,
almost always to a width I did not want. Since I hardly ever reset my almost always to a width I did not want. Since I hardly ever reset my
default width, I simply unbound the key. default width, I simply unbound the key.
@findex list-buffers, @r{rebound} @findex list-buffers@r{, rebound}
@findex buffer-menu, @r{bound to key} @findex buffer-menu@r{, bound to key}
@need 1250 @need 1250
The following rebinds an existing key: The following rebinds an existing key:

2
doc/lispref/edebug.texi
View file

@ -158,7 +158,7 @@ display a list of all Edebug commands.
into it, to invoke Edebug at the proper places. into it, to invoke Edebug at the proper places.
@kindex C-M-x @kindex C-M-x
@findex eval-defun (Edebug) @findex eval-defun @r{(Edebug)}
When you invoke command @kbd{C-M-x} (@code{eval-defun}) with a When you invoke command @kbd{C-M-x} (@code{eval-defun}) with a
prefix argument on a function definition, it instruments the prefix argument on a function definition, it instruments the
definition before evaluating it. (This does not modify the source definition before evaluating it. (This does not modify the source

168
doc/lispref/frames.texi
View file

@ -1391,20 +1391,20 @@ text terminals.
frame. @code{title} and @code{name} are meaningful on all terminals. frame. @code{title} and @code{name} are meaningful on all terminals.
@table @code @table @code
@vindex display, a frame parameter @vindex display@r{, a frame parameter}
@item display @item display
The display on which to open this frame. It should be a string of the The display on which to open this frame. It should be a string of the
form @samp{@var{host}:@var{dpy}.@var{screen}}, just like the form @samp{@var{host}:@var{dpy}.@var{screen}}, just like the
@env{DISPLAY} environment variable. @xref{Multiple Terminals}, for @env{DISPLAY} environment variable. @xref{Multiple Terminals}, for
more details about display names. more details about display names.
@vindex display-type, a frame parameter @vindex display-type@r{, a frame parameter}
@item display-type @item display-type
This parameter describes the range of possible colors that can be used This parameter describes the range of possible colors that can be used
in this frame. Its value is @code{color}, @code{grayscale} or in this frame. Its value is @code{color}, @code{grayscale} or
@code{mono}. @code{mono}.
@vindex title, a frame parameter @vindex title@r{, a frame parameter}
@item title @item title
If a frame has a non-@code{nil} title, it appears in the window If a frame has a non-@code{nil} title, it appears in the window
system's title bar at the top of the frame, and also in the mode line system's title bar at the top of the frame, and also in the mode line
@ -1413,7 +1413,7 @@ of windows in that frame if @code{mode-line-frame-identification} uses
Emacs is not using a window system, and can only display one frame at Emacs is not using a window system, and can only display one frame at
a time. @xref{Frame Titles}. a time. @xref{Frame Titles}.
@vindex name, a frame parameter @vindex name@r{, a frame parameter}
@item name @item name
The name of the frame. The frame name serves as a default for the frame The name of the frame. The frame name serves as a default for the frame
title, if the @code{title} parameter is unspecified or @code{nil}. If title, if the @code{title} parameter is unspecified or @code{nil}. If
@ -1424,7 +1424,7 @@ If you specify the frame name explicitly when you create the frame, the
name is also used (instead of the name of the Emacs executable) when name is also used (instead of the name of the Emacs executable) when
looking up X resources for the frame. looking up X resources for the frame.
@vindex explicit-name, a frame parameter @vindex explicit-name@r{, a frame parameter}
@item explicit-name @item explicit-name
If the frame name was specified explicitly when the frame was created, If the frame name was specified explicitly when the frame was created,
this parameter will be that name. If the frame wasn't explicitly this parameter will be that name. If the frame wasn't explicitly
@ -1446,7 +1446,7 @@ frame's parent frame. (Note that none of these parameters is meaningful
on TTY frames.) on TTY frames.)
@table @code @table @code
@vindex left, a frame parameter @vindex left@r{, a frame parameter}
@item left @item left
The position, in pixels, of the left outer edge of the frame with The position, in pixels, of the left outer edge of the frame with
respect to the left edge of the frame's display or parent frame. It can respect to the left edge of the frame's display or parent frame. It can
@ -1521,13 +1521,13 @@ of the display, workarea or parent frame edge. They are also returned
as such by functions like @code{frame-parameters} and restored as such as such by functions like @code{frame-parameters} and restored as such
by the desktop saving routines. by the desktop saving routines.
@vindex top, a frame parameter @vindex top@r{, a frame parameter}
@item top @item top
The screen position of the top (or bottom) edge, in pixels, with respect The screen position of the top (or bottom) edge, in pixels, with respect
to the top (or bottom) edge of the display or parent frame. It works to the top (or bottom) edge of the display or parent frame. It works
just like @code{left}, except vertically instead of horizontally. just like @code{left}, except vertically instead of horizontally.
@vindex icon-left, a frame parameter @vindex icon-left@r{, a frame parameter}
@item icon-left @item icon-left
The screen position of the left edge of the frame's icon, in pixels, The screen position of the left edge of the frame's icon, in pixels,
counting from the left edge of the screen. This takes effect when the counting from the left edge of the screen. This takes effect when the
@ -1535,13 +1535,13 @@ frame is iconified, if the window manager supports this feature. If
you specify a value for this parameter, then you must also specify a you specify a value for this parameter, then you must also specify a
value for @code{icon-top} and vice versa. value for @code{icon-top} and vice versa.
@vindex icon-top, a frame parameter @vindex icon-top@r{, a frame parameter}
@item icon-top @item icon-top
The screen position of the top edge of the frame's icon, in pixels, The screen position of the top edge of the frame's icon, in pixels,
counting from the top edge of the screen. This takes effect when the counting from the top edge of the screen. This takes effect when the
frame is iconified, if the window manager supports this feature. frame is iconified, if the window manager supports this feature.
@vindex user-position, a frame parameter @vindex user-position@r{, a frame parameter}
@item user-position @item user-position
When you create a frame and specify its screen position with the When you create a frame and specify its screen position with the
@code{left} and @code{top} parameters, use this parameter to say whether @code{left} and @code{top} parameters, use this parameter to say whether
@ -1562,7 +1562,7 @@ value for this parameter if the values of the @code{left} and @code{top}
parameters represent the user's stated preference; otherwise, use parameters represent the user's stated preference; otherwise, use
@code{nil}. @code{nil}.
@vindex z-group, a frame parameter @vindex z-group@r{, a frame parameter}
@item z-group @item z-group
This parameter specifies a relative position of the frame's This parameter specifies a relative position of the frame's
window-system window in the stacking (Z-) order of the frame's display. window-system window in the stacking (Z-) order of the frame's display.
@ -1589,7 +1589,7 @@ graphical displays, the @code{default} face determines the actual pixel
sizes of these character units (@pxref{Face Attributes}). sizes of these character units (@pxref{Face Attributes}).
@table @code @table @code
@vindex width, a frame parameter @vindex width@r{, a frame parameter}
@item width @item width
This parameter specifies the width of the frame. It can be specified as This parameter specifies the width of the frame. It can be specified as
in the following ways: in the following ways:
@ -1635,19 +1635,19 @@ width of the frame's text area in characters as an integer rounded, if
necessary, to a multiple of the frame's default character width. That necessary, to a multiple of the frame's default character width. That
value is also used by the desktop saving routines. value is also used by the desktop saving routines.
@vindex height, a frame parameter @vindex height@r{, a frame parameter}
@item height @item height
This parameter specifies the height of the frame. It works just like This parameter specifies the height of the frame. It works just like
@code{width}, except vertically instead of horizontally. @code{width}, except vertically instead of horizontally.
@vindex user-size, a frame parameter @vindex user-size@r{, a frame parameter}
@item user-size @item user-size
This does for the size parameters @code{height} and @code{width} what This does for the size parameters @code{height} and @code{width} what
the @code{user-position} parameter (@pxref{Position Parameters, the @code{user-position} parameter (@pxref{Position Parameters,
user-position}) does for the position parameters @code{top} and user-position}) does for the position parameters @code{top} and
@code{left}. @code{left}.
@vindex min-width, a frame parameter @vindex min-width@r{, a frame parameter}
@item min-width @item min-width
This parameter specifies the minimum native width (@pxref{Frame This parameter specifies the minimum native width (@pxref{Frame
Geometry}) of the frame, in characters. Normally, the functions that Geometry}) of the frame, in characters. Normally, the functions that
@ -1658,7 +1658,7 @@ non-@code{nil} allows to make a frame narrower than that with the
consequence that any components that do not fit will be clipped by the consequence that any components that do not fit will be clipped by the
window manager. window manager.
@vindex min-height, a frame parameter @vindex min-height@r{, a frame parameter}
@item min-height @item min-height
This parameter specifies the minimum native height (@pxref{Frame This parameter specifies the minimum native height (@pxref{Frame
Geometry}) of the frame, in characters. Normally, the functions that Geometry}) of the frame, in characters. Normally, the functions that
@ -1673,7 +1673,7 @@ fit will be clipped by the window manager.
@cindex fullheight frames @cindex fullheight frames
@cindex fullwidth frames @cindex fullwidth frames
@cindex maximized frames @cindex maximized frames
@vindex fullscreen, a frame parameter @vindex fullscreen@r{, a frame parameter}
@item fullscreen @item fullscreen
This parameter specifies whether to maximize the frame's width, height This parameter specifies whether to maximize the frame's width, height
or both. Its value can be @code{fullwidth}, @code{fullheight}, or both. Its value can be @code{fullwidth}, @code{fullheight},
@ -1704,7 +1704,7 @@ Full-screen on macOS hides both the tool-bar and the menu-bar, however
both will be displayed if the mouse pointer is moved to the top of the both will be displayed if the mouse pointer is moved to the top of the
screen. screen.
@vindex fullscreen-restore, a frame parameter @vindex fullscreen-restore@r{, a frame parameter}
@item fullscreen-restore @item fullscreen-restore
This parameter specifies the desired fullscreen state of the frame This parameter specifies the desired fullscreen state of the frame
after invoking the @code{toggle-frame-fullscreen} command (@pxref{Frame after invoking the @code{toggle-frame-fullscreen} command (@pxref{Frame
@ -1723,14 +1723,14 @@ file as, for example
This will give a new frame full height after typing in it @key{F11} for This will give a new frame full height after typing in it @key{F11} for
the first time. the first time.
@vindex fit-frame-to-buffer-margins, a frame parameter @vindex fit-frame-to-buffer-margins@r{, a frame parameter}
@item fit-frame-to-buffer-margins @item fit-frame-to-buffer-margins
This parameter allows to override the value of the option This parameter allows to override the value of the option
@code{fit-frame-to-buffer-margins} when fitting this frame to the buffer @code{fit-frame-to-buffer-margins} when fitting this frame to the buffer
of its root window with @code{fit-frame-to-buffer} (@pxref{Resizing of its root window with @code{fit-frame-to-buffer} (@pxref{Resizing
Windows}). Windows}).
@vindex fit-frame-to-buffer-sizes, a frame parameter @vindex fit-frame-to-buffer-sizes@r{, a frame parameter}
@item fit-frame-to-buffer-sizes @item fit-frame-to-buffer-sizes
This parameter allows to override the value of the option This parameter allows to override the value of the option
@code{fit-frame-to-buffer-sizes} when fitting this frame to the buffer @code{fit-frame-to-buffer-sizes} when fitting this frame to the buffer
@ -1748,38 +1748,38 @@ Windows}).
frame, or control their sizes. frame, or control their sizes.
@table @code @table @code
@vindex border-width, a frame parameter @vindex border-width@r{, a frame parameter}
@item border-width @item border-width
The width in pixels of the frame's outer border (@pxref{Frame Geometry}). The width in pixels of the frame's outer border (@pxref{Frame Geometry}).
@vindex internal-border-width, a frame parameter @vindex internal-border-width@r{, a frame parameter}
@item internal-border-width @item internal-border-width
The width in pixels of the frame's internal border (@pxref{Frame The width in pixels of the frame's internal border (@pxref{Frame
Geometry}). Geometry}).
@vindex vertical-scroll-bars, a frame parameter @vindex vertical-scroll-bars@r{, a frame parameter}
@item vertical-scroll-bars @item vertical-scroll-bars
Whether the frame has scroll bars (@pxref{Scroll Bars}) for vertical Whether the frame has scroll bars (@pxref{Scroll Bars}) for vertical
scrolling, and which side of the frame they should be on. The possible scrolling, and which side of the frame they should be on. The possible
values are @code{left}, @code{right}, and @code{nil} for no scroll bars. values are @code{left}, @code{right}, and @code{nil} for no scroll bars.
@vindex horizontal-scroll-bars, a frame parameter @vindex horizontal-scroll-bars@r{, a frame parameter}
@item horizontal-scroll-bars @item horizontal-scroll-bars
Whether the frame has scroll bars for horizontal scrolling (@code{t} and Whether the frame has scroll bars for horizontal scrolling (@code{t} and
@code{bottom} mean yes, @code{nil} means no). @code{bottom} mean yes, @code{nil} means no).
@vindex scroll-bar-width, a frame parameter @vindex scroll-bar-width@r{, a frame parameter}
@item scroll-bar-width @item scroll-bar-width
The width of vertical scroll bars, in pixels, or @code{nil} meaning to The width of vertical scroll bars, in pixels, or @code{nil} meaning to
use the default width. use the default width.
@vindex scroll-bar-height, a frame parameter @vindex scroll-bar-height@r{, a frame parameter}
@item scroll-bar-height @item scroll-bar-height
The height of horizontal scroll bars, in pixels, or @code{nil} meaning The height of horizontal scroll bars, in pixels, or @code{nil} meaning
to use the default height. to use the default height.
@vindex left-fringe, a frame parameter @vindex left-fringe@r{, a frame parameter}
@vindex right-fringe, a frame parameter @vindex right-fringe@r{, a frame parameter}
@item left-fringe @item left-fringe
@itemx right-fringe @itemx right-fringe
The default width of the left and right fringes of windows in this The default width of the left and right fringes of windows in this
@ -1791,19 +1791,19 @@ these two frame parameters, the return value is always an integer.
When using @code{set-frame-parameter}, passing a @code{nil} value When using @code{set-frame-parameter}, passing a @code{nil} value
imposes an actual default value of 8 pixels. imposes an actual default value of 8 pixels.
@vindex right-divider-width, a frame parameter @vindex right-divider-width@r{, a frame parameter}
@item right-divider-width @item right-divider-width
The width (thickness) reserved for the right divider (@pxref{Window The width (thickness) reserved for the right divider (@pxref{Window
Dividers}) of any window on the frame, in pixels. A value of zero means Dividers}) of any window on the frame, in pixels. A value of zero means
to not draw right dividers. to not draw right dividers.
@vindex bottom-divider-width, a frame parameter @vindex bottom-divider-width@r{, a frame parameter}
@item bottom-divider-width @item bottom-divider-width
The width (thickness) reserved for the bottom divider (@pxref{Window The width (thickness) reserved for the bottom divider (@pxref{Window
Dividers}) of any window on the frame, in pixels. A value of zero means Dividers}) of any window on the frame, in pixels. A value of zero means
to not draw bottom dividers. to not draw bottom dividers.
@vindex menu-bar-lines frame parameter @vindex menu-bar-lines@r{, a frame parameter}
@item menu-bar-lines @item menu-bar-lines
The number of lines to allocate at the top of the frame for a menu bar The number of lines to allocate at the top of the frame for a menu bar
(@pxref{Menu Bar}). The default is one if Menu Bar mode is enabled and (@pxref{Menu Bar}). The default is one if Menu Bar mode is enabled and
@ -1814,25 +1814,25 @@ even when the menu bar wraps to two or more lines. In that case, the
(@pxref{Frame Geometry}) allows to derive whether the menu bar actually (@pxref{Frame Geometry}) allows to derive whether the menu bar actually
occupies one or more lines. occupies one or more lines.
@vindex tool-bar-lines frame parameter @vindex tool-bar-lines@r{, a frame parameter}
@item tool-bar-lines @item tool-bar-lines
The number of lines to use for the tool bar (@pxref{Tool Bar}). The The number of lines to use for the tool bar (@pxref{Tool Bar}). The
default is one if Tool Bar mode is enabled and zero otherwise. default is one if Tool Bar mode is enabled and zero otherwise.
@xref{Tool Bars,,,emacs, The GNU Emacs Manual}. This value may change @xref{Tool Bars,,,emacs, The GNU Emacs Manual}. This value may change
whenever the tool bar wraps (@pxref{Frame Layout}). whenever the tool bar wraps (@pxref{Frame Layout}).
@vindex tool-bar-position frame parameter @vindex tool-bar-position@r{, a frame parameter}
@item tool-bar-position @item tool-bar-position
The position of the tool bar when Emacs was built with GTK+. Its value The position of the tool bar when Emacs was built with GTK+. Its value
can be one of @code{top}, @code{bottom} @code{left}, @code{right}. The can be one of @code{top}, @code{bottom} @code{left}, @code{right}. The
default is @code{top}. default is @code{top}.
@vindex line-spacing, a frame parameter @vindex line-spacing@r{, a frame parameter}
@item line-spacing @item line-spacing
Additional space to leave below each text line, in pixels (a positive Additional space to leave below each text line, in pixels (a positive
integer). @xref{Line Height}, for more information. integer). @xref{Line Height}, for more information.
@vindex no-special-glyphs, a frame parameter @vindex no-special-glyphs@r{, a frame parameter}
@item no-special-glyphs @item no-special-glyphs
If this is non-@code{nil}, it suppresses the display of any truncation If this is non-@code{nil}, it suppresses the display of any truncation
and continuation glyphs (@pxref{Truncation}) for all buffers displayed and continuation glyphs (@pxref{Truncation}) for all buffers displayed
@ -1851,7 +1851,7 @@ Windows}).
with which buffers have been, or should, be displayed in the frame. with which buffers have been, or should, be displayed in the frame.
@table @code @table @code
@vindex minibuffer, a frame parameter @vindex minibuffer@r{, a frame parameter}
@item minibuffer @item minibuffer
Whether this frame has its own minibuffer. The value @code{t} means Whether this frame has its own minibuffer. The value @code{t} means
yes, @code{nil} means no, @code{only} means this frame is just a yes, @code{nil} means no, @code{only} means this frame is just a
@ -1867,7 +1867,7 @@ minibuffer window to @code{t} and vice-versa, or from @code{t} to
@code{nil}. If the parameter specifies a minibuffer window already, @code{nil}. If the parameter specifies a minibuffer window already,
setting it to @code{nil} has no effect. setting it to @code{nil} has no effect.
@vindex buffer-predicate, a frame parameter @vindex buffer-predicate@r{, a frame parameter}
@item buffer-predicate @item buffer-predicate
The buffer-predicate function for this frame. The function The buffer-predicate function for this frame. The function
@code{other-buffer} uses this predicate (from the selected frame) to @code{other-buffer} uses this predicate (from the selected frame) to
@ -1876,12 +1876,12 @@ decide which buffers it should consider, if the predicate is not
each buffer; if the predicate returns a non-@code{nil} value, it each buffer; if the predicate returns a non-@code{nil} value, it
considers that buffer. considers that buffer.
@vindex buffer-list, a frame parameter @vindex buffer-list@r{, a frame parameter}
@item buffer-list @item buffer-list
A list of buffers that have been selected in this frame, ordered A list of buffers that have been selected in this frame, ordered
most-recently-selected first. most-recently-selected first.
@vindex unsplittable, a frame parameter @vindex unsplittable@r{, a frame parameter}
@item unsplittable @item unsplittable
If non-@code{nil}, this frame's window is never split automatically. If non-@code{nil}, this frame's window is never split automatically.
@end table @end table
@ -1895,40 +1895,40 @@ If non-@code{nil}, this frame's window is never split automatically.
These parameters supply forms of interactions between different frames. These parameters supply forms of interactions between different frames.
@table @code @table @code
@vindex parent-frame, a frame parameter @vindex parent-frame@r{, a frame parameter}
@item parent-frame @item parent-frame
If non-@code{nil}, this means that this frame is a child frame If non-@code{nil}, this means that this frame is a child frame
(@pxref{Child Frames}), and this parameter specifies its parent frame. (@pxref{Child Frames}), and this parameter specifies its parent frame.
If @code{nil}, this means that this frame is a normal, top-level frame. If @code{nil}, this means that this frame is a normal, top-level frame.
@vindex delete-before, a frame parameter @vindex delete-before@r{, a frame parameter}
@item delete-before @item delete-before
If non-@code{nil}, this parameter specifies another frame whose deletion If non-@code{nil}, this parameter specifies another frame whose deletion
will automatically trigger the deletion of this frame. @xref{Deleting will automatically trigger the deletion of this frame. @xref{Deleting
Frames}. Frames}.
@vindex mouse-wheel-frame, a frame parameter @vindex mouse-wheel-frame@r{, a frame parameter}
@item mouse-wheel-frame @item mouse-wheel-frame
If non-@code{nil}, this parameter specifies the frame whose windows will If non-@code{nil}, this parameter specifies the frame whose windows will
be scrolled whenever the mouse wheel is scrolled with the mouse pointer be scrolled whenever the mouse wheel is scrolled with the mouse pointer
hovering over this frame, see @ref{Mouse Commands,,, emacs, The GNU hovering over this frame, see @ref{Mouse Commands,,, emacs, The GNU
Emacs Manual}. Emacs Manual}.
@vindex no-other-frame, a frame parameter @vindex no-other-frame@r{, a frame parameter}
@item no-other-frame @item no-other-frame
If this is non-@code{nil}, then this frame is not eligible as candidate If this is non-@code{nil}, then this frame is not eligible as candidate
for the functions @code{next-frame}, @code{previous-frame} for the functions @code{next-frame}, @code{previous-frame}
(@pxref{Finding All Frames}) and @code{other-frame}, see @ref{Frame (@pxref{Finding All Frames}) and @code{other-frame}, see @ref{Frame
Commands,,, emacs, The GNU Emacs Manual}. Commands,,, emacs, The GNU Emacs Manual}.
@vindex auto-hide-function, a frame parameter @vindex auto-hide-function@r{, a frame parameter}
@item auto-hide-function @item auto-hide-function
When this parameter specifies a function, that function will be called When this parameter specifies a function, that function will be called
instead of the function specified by the variable instead of the function specified by the variable
@code{frame-auto-hide-function} when quitting the frame's only window @code{frame-auto-hide-function} when quitting the frame's only window
(@pxref{Quitting Windows}) and there are other frames left. (@pxref{Quitting Windows}) and there are other frames left.
@vindex minibuffer-exit, a frame parameter @vindex minibuffer-exit@r{, a frame parameter}
@item minibuffer-exit @item minibuffer-exit
When this parameter is non-@code{nil}, Emacs will by default make this When this parameter is non-@code{nil}, Emacs will by default make this
frame invisible whenever the minibuffer (@pxref{Minibuffers}) is exited. frame invisible whenever the minibuffer (@pxref{Minibuffers}) is exited.
@ -1937,7 +1937,7 @@ Alternatively, it can specify the functions @code{iconify-frame} and
disappear automatically (similar to how Emacs deals with a window) when disappear automatically (similar to how Emacs deals with a window) when
exiting the minibuffer. exiting the minibuffer.
@vindex keep-ratio, a frame parameter @vindex keep-ratio@r{, a frame parameter}
@item keep-ratio @item keep-ratio
This parameter is currently meaningful for child frames (@pxref{Child This parameter is currently meaningful for child frames (@pxref{Child
Frames}) only. If it is non-@code{nil}, then Emacs will try to keep the Frames}) only. If it is non-@code{nil}, then Emacs will try to keep the
@ -1977,29 +1977,29 @@ Frames}) that come without window manager decorations. If necessary,
they can be used for undecorated top-level frames as well. they can be used for undecorated top-level frames as well.
@table @code @table @code
@vindex drag-internal-border, a frame parameter @vindex drag-internal-border@r{, a frame parameter}
@item drag-internal-border @item drag-internal-border
If non-@code{nil}, the frame can be resized by dragging its internal If non-@code{nil}, the frame can be resized by dragging its internal
borders, if present, with the mouse. borders, if present, with the mouse.
@vindex drag-with-header-line, a frame parameter @vindex drag-with-header-line@r{, a frame parameter}
@item drag-with-header-line @item drag-with-header-line
If non-@code{nil}, the frame can be moved with the mouse by dragging the If non-@code{nil}, the frame can be moved with the mouse by dragging the
header line of its topmost window. header line of its topmost window.
@vindex drag-with-mode-line, a frame parameter @vindex drag-with-mode-line@r{, a frame parameter}
@item drag-with-mode-line @item drag-with-mode-line
If non-@code{nil}, the frame can be moved with the mouse by dragging the If non-@code{nil}, the frame can be moved with the mouse by dragging the
mode line of its bottommost window. Note that such a frame is not mode line of its bottommost window. Note that such a frame is not
allowed to have its own minibuffer window. allowed to have its own minibuffer window.
@vindex snap-width, a frame parameter @vindex snap-width@r{, a frame parameter}
@item snap-width @item snap-width
A frame that is moved with the mouse will ``snap'' at the border(s) of A frame that is moved with the mouse will ``snap'' at the border(s) of
the display or its parent frame whenever it is dragged as near to such the display or its parent frame whenever it is dragged as near to such
an edge as the number of pixels specified by this parameter. an edge as the number of pixels specified by this parameter.
@vindex top-visible, a frame parameter @vindex top-visible@r{, a frame parameter}
@item top-visible @item top-visible
If this parameter is a number, the top edge of the frame never appears If this parameter is a number, the top edge of the frame never appears
above the top edge of its display or parent frame. Moreover, as many above the top edge of its display or parent frame. Moreover, as many
@ -2010,7 +2010,7 @@ dragging a child frame with a non-@code{nil}
@code{drag-with-header-line} parameter completely out of the area @code{drag-with-header-line} parameter completely out of the area
of its parent frame. of its parent frame.
@vindex bottom-visible, a frame parameter @vindex bottom-visible@r{, a frame parameter}
@item bottom-visible @item bottom-visible
If this parameter is a number, the bottom edge of the frame never If this parameter is a number, the bottom edge of the frame never
appears below the bottom edge of its display or parent frame. Moreover, appears below the bottom edge of its display or parent frame. Moreover,
@ -2032,66 +2032,66 @@ interaction with the window manager or window system. They have no
effect on text terminals. effect on text terminals.
@table @code @table @code
@vindex visibility, a frame parameter @vindex visibility@r{, a frame parameter}
@item visibility @item visibility
The state of visibility of the frame. There are three possibilities: The state of visibility of the frame. There are three possibilities:
@code{nil} for invisible, @code{t} for visible, and @code{icon} for @code{nil} for invisible, @code{t} for visible, and @code{icon} for
iconified. @xref{Visibility of Frames}. iconified. @xref{Visibility of Frames}.
@vindex auto-raise, a frame parameter @vindex auto-raise@r{, a frame parameter}
@item auto-raise @item auto-raise
If non-@code{nil}, Emacs automatically raises the frame when it is If non-@code{nil}, Emacs automatically raises the frame when it is
selected. Some window managers do not allow this. selected. Some window managers do not allow this.
@vindex auto-lower, a frame parameter @vindex auto-lower@r{, a frame parameter}
@item auto-lower @item auto-lower
If non-@code{nil}, Emacs automatically lowers the frame when it is If non-@code{nil}, Emacs automatically lowers the frame when it is
deselected. Some window managers do not allow this. deselected. Some window managers do not allow this.
@vindex icon-type, a frame parameter @vindex icon-type@r{, a frame parameter}
@item icon-type @item icon-type
The type of icon to use for this frame. If the value is a string, The type of icon to use for this frame. If the value is a string,
that specifies a file containing a bitmap to use; @code{nil} specifies that specifies a file containing a bitmap to use; @code{nil} specifies
no icon (in which case the window manager decides what to show); any no icon (in which case the window manager decides what to show); any
other non-@code{nil} value specifies the default Emacs icon. other non-@code{nil} value specifies the default Emacs icon.
@vindex icon-name, a frame parameter @vindex icon-name@r{, a frame parameter}
@item icon-name @item icon-name
The name to use in the icon for this frame, when and if the icon The name to use in the icon for this frame, when and if the icon
appears. If this is @code{nil}, the frame's title is used. appears. If this is @code{nil}, the frame's title is used.
@vindex window-id, a frame parameter @vindex window-id@r{, a frame parameter}
@item window-id @item window-id
The ID number which the graphical display uses for this frame. Emacs The ID number which the graphical display uses for this frame. Emacs
assigns this parameter when the frame is created; changing the assigns this parameter when the frame is created; changing the
parameter has no effect on the actual ID number. parameter has no effect on the actual ID number.
@vindex outer-window-id, a frame parameter @vindex outer-window-id@r{, a frame parameter}
@item outer-window-id @item outer-window-id
The ID number of the outermost window-system window in which the frame The ID number of the outermost window-system window in which the frame
exists. As with @code{window-id}, changing this parameter has no exists. As with @code{window-id}, changing this parameter has no
actual effect. actual effect.
@vindex wait-for-wm, a frame parameter @vindex wait-for-wm@r{, a frame parameter}
@item wait-for-wm @item wait-for-wm
If non-@code{nil}, tell Xt to wait for the window manager to confirm If non-@code{nil}, tell Xt to wait for the window manager to confirm
geometry changes. Some window managers, including versions of Fvwm2 geometry changes. Some window managers, including versions of Fvwm2
and KDE, fail to confirm, so Xt hangs. Set this to @code{nil} to and KDE, fail to confirm, so Xt hangs. Set this to @code{nil} to
prevent hanging with those window managers. prevent hanging with those window managers.
@vindex sticky, a frame parameter @vindex sticky@r{, a frame parameter}
@item sticky @item sticky
If non-@code{nil}, the frame is visible on all virtual desktops on systems If non-@code{nil}, the frame is visible on all virtual desktops on systems
with virtual desktops. with virtual desktops.
@vindex inhibit-double-buffering, a frame parameter @vindex inhibit-double-buffering@r{, a frame parameter}
@item inhibit-double-buffering @item inhibit-double-buffering
If non-@code{nil}, the frame is drawn to the screen without double If non-@code{nil}, the frame is drawn to the screen without double
buffering. Emacs normally attempts to use double buffering, where buffering. Emacs normally attempts to use double buffering, where
available, to reduce flicker. Set this property if you experience available, to reduce flicker. Set this property if you experience
display bugs or pine for that retro, flicker-y feeling. display bugs or pine for that retro, flicker-y feeling.
@vindex skip-taskbar, a frame parameter @vindex skip-taskbar@r{, a frame parameter}
@item skip-taskbar @item skip-taskbar
If non-@code{nil}, this tells the window manager to remove the frame's If non-@code{nil}, this tells the window manager to remove the frame's
icon from the taskbar associated with the frame's display and inhibit icon from the taskbar associated with the frame's display and inhibit
@ -2100,13 +2100,13 @@ On MS-Windows, iconifying such a frame will "roll in" its window-system
window at the bottom of the desktop. Some window managers may not honor window at the bottom of the desktop. Some window managers may not honor
this parameter. this parameter.
@vindex no-focus-on-map, a frame parameter @vindex no-focus-on-map@r{, a frame parameter}
@item no-focus-on-map @item no-focus-on-map
If non-@code{nil}, this means that the frame does not want to receive If non-@code{nil}, this means that the frame does not want to receive
input focus when it is mapped (@pxref{Visibility of Frames}). Some input focus when it is mapped (@pxref{Visibility of Frames}). Some
window managers may not honor this parameter. window managers may not honor this parameter.
@vindex no-accept-focus, a frame parameter @vindex no-accept-focus@r{, a frame parameter}
@item no-accept-focus @item no-accept-focus
If non-@code{nil}, this means that the frame does not want to receive If non-@code{nil}, this means that the frame does not want to receive
input focus via explicit mouse clicks or when moving the mouse into it input focus via explicit mouse clicks or when moving the mouse into it
@ -2116,7 +2116,7 @@ This may have the unwanted side-effect that a user cannot scroll a
non-selected frame with the mouse. Some window managers may not honor non-selected frame with the mouse. Some window managers may not honor
this parameter. this parameter.
@vindex undecorated, a frame parameter @vindex undecorated@r{, a frame parameter}
@item undecorated @item undecorated
If non-@code{nil}, this frame's window-system window is drawn without If non-@code{nil}, this frame's window-system window is drawn without
decorations, like the title, minimize/maximize boxes and external decorations, like the title, minimize/maximize boxes and external
@ -2131,7 +2131,7 @@ decorations. Some window managers may not honor these hints.
NS builds consider the tool bar to be a decoration, and therefore hide NS builds consider the tool bar to be a decoration, and therefore hide
it on an undecorated frame. it on an undecorated frame.
@vindex override-redirect, a frame parameter @vindex override-redirect@r{, a frame parameter}
@item override-redirect @item override-redirect
@cindex override redirect frames @cindex override redirect frames
If non-@code{nil}, this means that this is an @dfn{override redirect} If non-@code{nil}, this means that this is an @dfn{override redirect}
@ -2142,7 +2142,7 @@ usually drawn on top of all other frames. Setting this parameter has
no effect on MS-Windows. no effect on MS-Windows.
@ignore @ignore
@vindex parent-id, a frame parameter @vindex parent-id@r{, a frame parameter}
@item parent-id @item parent-id
@c ??? Not yet working. @c ??? Not yet working.
The X window number of the window that should be the parent of this one. The X window number of the window that should be the parent of this one.
@ -2151,7 +2151,7 @@ application's window. (It is not certain this will be implemented; try
it and see if it works.) it and see if it works.)
@end ignore @end ignore
@vindex ns-appearance, a frame parameter @vindex ns-appearance@r{, a frame parameter}
@item ns-appearance @item ns-appearance
Only available on macOS, if set to @code{dark} draw this frame's Only available on macOS, if set to @code{dark} draw this frame's
window-system window using the ``vibrant dark'' theme, otherwise use window-system window using the ``vibrant dark'' theme, otherwise use
@ -2159,7 +2159,7 @@ the system default. The ``vibrant dark'' theme can be used to set the
toolbar and scrollbars to a dark appearance when using an Emacs theme toolbar and scrollbars to a dark appearance when using an Emacs theme
with a dark background. with a dark background.
@vindex ns-transparent-titlebar, a frame parameter @vindex ns-transparent-titlebar@r{, a frame parameter}
@item ns-transparent-titlebar @item ns-transparent-titlebar
Only available on macOS, if non-@code{nil}, set the titlebar and Only available on macOS, if non-@code{nil}, set the titlebar and
toolbar to be transparent. This effectively sets the background color toolbar to be transparent. This effectively sets the background color
@ -2174,7 +2174,7 @@ of both to match the Emacs background color.
This frame parameter controls the way the cursor looks. This frame parameter controls the way the cursor looks.
@table @code @table @code
@vindex cursor-type, a frame parameter @vindex cursor-type@r{, a frame parameter}
@item cursor-type @item cursor-type
How to display the cursor. Legitimate values are: How to display the cursor. Legitimate values are:
@ -2252,7 +2252,7 @@ variable do not take effect immediately, only when you specify the
These frame parameters control the use of fonts and colors. These frame parameters control the use of fonts and colors.
@table @code @table @code
@vindex font-backend, a frame parameter @vindex font-backend@r{, a frame parameter}
@item font-backend @item font-backend
A list of symbols, specifying the @dfn{font backends} to use for A list of symbols, specifying the @dfn{font backends} to use for
drawing fonts in the frame, in order of priority. On X, there are drawing fonts in the frame, in order of priority. On X, there are
@ -2263,12 +2263,12 @@ currently two available font backends: @code{gdi} and
Manual}). On other systems, there is only one available font backend, Manual}). On other systems, there is only one available font backend,
so it does not make sense to modify this frame parameter. so it does not make sense to modify this frame parameter.
@vindex background-mode, a frame parameter @vindex background-mode@r{, a frame parameter}
@item background-mode @item background-mode
This parameter is either @code{dark} or @code{light}, according This parameter is either @code{dark} or @code{light}, according
to whether the background color is a light one or a dark one. to whether the background color is a light one or a dark one.
@vindex tty-color-mode, a frame parameter @vindex tty-color-mode@r{, a frame parameter}
@item tty-color-mode @item tty-color-mode
@cindex standard colors for character terminals @cindex standard colors for character terminals
This parameter overrides the terminal's color support as given by the This parameter overrides the terminal's color support as given by the
@ -2284,7 +2284,7 @@ If the parameter's value is a symbol, it specifies a number through
the value of @code{tty-color-mode-alist}, and the associated number is the value of @code{tty-color-mode-alist}, and the associated number is
used instead. used instead.
@vindex screen-gamma, a frame parameter @vindex screen-gamma@r{, a frame parameter}
@item screen-gamma @item screen-gamma
@cindex gamma correction @cindex gamma correction
If this is a number, Emacs performs gamma correction which adjusts If this is a number, Emacs performs gamma correction which adjusts
@ -2304,7 +2304,7 @@ If your monitor displays colors too light, you should specify a
that makes colors darker. A screen gamma value of 1.5 may give good that makes colors darker. A screen gamma value of 1.5 may give good
results for LCD color displays. results for LCD color displays.
@vindex alpha, a frame parameter @vindex alpha@r{, a frame parameter}
@item alpha @item alpha
@cindex opacity, frame @cindex opacity, frame
@cindex transparency, frame @cindex transparency, frame
@ -2335,45 +2335,45 @@ automatically equivalent to particular face attributes of particular
faces (@pxref{Standard Faces,,, emacs, The Emacs Manual}): faces (@pxref{Standard Faces,,, emacs, The Emacs Manual}):
@table @code @table @code
@vindex font, a frame parameter @vindex font@r{, a frame parameter}
@item font @item font
The name of the font for displaying text in the frame. This is a The name of the font for displaying text in the frame. This is a
string, either a valid font name for your system or the name of an Emacs string, either a valid font name for your system or the name of an Emacs
fontset (@pxref{Fontsets}). It is equivalent to the @code{font} fontset (@pxref{Fontsets}). It is equivalent to the @code{font}
attribute of the @code{default} face. attribute of the @code{default} face.
@vindex foreground-color, a frame parameter @vindex foreground-color@r{, a frame parameter}
@item foreground-color @item foreground-color
The color to use for the image of a character. It is equivalent to The color to use for the image of a character. It is equivalent to
the @code{:foreground} attribute of the @code{default} face. the @code{:foreground} attribute of the @code{default} face.
@vindex background-color, a frame parameter @vindex background-color@r{, a frame parameter}
@item background-color @item background-color
The color to use for the background of characters. It is equivalent to The color to use for the background of characters. It is equivalent to
the @code{:background} attribute of the @code{default} face. the @code{:background} attribute of the @code{default} face.
@vindex mouse-color, a frame parameter @vindex mouse-color@r{, a frame parameter}
@item mouse-color @item mouse-color
The color for the mouse pointer. It is equivalent to the @code{:background} The color for the mouse pointer. It is equivalent to the @code{:background}
attribute of the @code{mouse} face. attribute of the @code{mouse} face.
@vindex cursor-color, a frame parameter @vindex cursor-color@r{, a frame parameter}
@item cursor-color @item cursor-color
The color for the cursor that shows point. It is equivalent to the The color for the cursor that shows point. It is equivalent to the
@code{:background} attribute of the @code{cursor} face. @code{:background} attribute of the @code{cursor} face.
@vindex border-color, a frame parameter @vindex border-color@r{, a frame parameter}
@item border-color @item border-color
The color for the border of the frame. It is equivalent to the The color for the border of the frame. It is equivalent to the
@code{:background} attribute of the @code{border} face. @code{:background} attribute of the @code{border} face.
@vindex scroll-bar-foreground, a frame parameter @vindex scroll-bar-foreground@r{, a frame parameter}
@item scroll-bar-foreground @item scroll-bar-foreground
If non-@code{nil}, the color for the foreground of scroll bars. It is If non-@code{nil}, the color for the foreground of scroll bars. It is
equivalent to the @code{:foreground} attribute of the equivalent to the @code{:foreground} attribute of the
@code{scroll-bar} face. @code{scroll-bar} face.
@vindex scroll-bar-background, a frame parameter @vindex scroll-bar-background@r{, a frame parameter}
@item scroll-bar-background @item scroll-bar-background
If non-@code{nil}, the color for the background of scroll bars. It is If non-@code{nil}, the color for the background of scroll bars. It is
equivalent to the @code{:background} attribute of the equivalent to the @code{:background} attribute of the

2
doc/lispref/os.texi
View file

@ -1301,7 +1301,7 @@ or rounding errors occur.
@section Time Zone Rules @section Time Zone Rules
@cindex time zone rules @cindex time zone rules
@vindex TZ, environment variable @vindex TZ@r{, environment variable}
The default time zone is determined by the @env{TZ} environment The default time zone is determined by the @env{TZ} environment
variable. @xref{System Environment}. For example, you can tell Emacs variable. @xref{System Environment}. For example, you can tell Emacs
to default to Universal Time with @code{(setenv "TZ" "UTC0")}. If to default to Universal Time with @code{(setenv "TZ" "UTC0")}. If

30
doc/lispref/windows.texi
View file

@ -5014,43 +5014,43 @@ code:
@table @code @table @code
@item delete-window @item delete-window
@vindex delete-window, a window parameter @vindex delete-window@r{, a window parameter}
This parameter affects the execution of @code{delete-window} This parameter affects the execution of @code{delete-window}
(@pxref{Deleting Windows}). (@pxref{Deleting Windows}).
@item delete-other-windows @item delete-other-windows
@vindex delete-other-windows, a window parameter @vindex delete-other-windows@r{, a window parameter}
This parameter affects the execution of @code{delete-other-windows} This parameter affects the execution of @code{delete-other-windows}
(@pxref{Deleting Windows}). (@pxref{Deleting Windows}).
@item no-delete-other-windows @item no-delete-other-windows
@vindex no-delete-other-windows, a window parameter @vindex no-delete-other-windows@r{, a window parameter}
This parameter marks the window as not deletable by This parameter marks the window as not deletable by
@code{delete-other-windows} (@pxref{Deleting Windows}). @code{delete-other-windows} (@pxref{Deleting Windows}).
@item split-window @item split-window
@vindex split-window, a window parameter @vindex split-window@r{, a window parameter}
This parameter affects the execution of @code{split-window} This parameter affects the execution of @code{split-window}
(@pxref{Splitting Windows}). (@pxref{Splitting Windows}).
@item other-window @item other-window
@vindex other-window, a window parameter @vindex other-window@r{, a window parameter}
This parameter affects the execution of @code{other-window} This parameter affects the execution of @code{other-window}
(@pxref{Cyclic Window Ordering}). (@pxref{Cyclic Window Ordering}).
@item no-other-window @item no-other-window
@vindex no-other-window, a window parameter @vindex no-other-window@r{, a window parameter}
This parameter marks the window as not selectable by @code{other-window} This parameter marks the window as not selectable by @code{other-window}
(@pxref{Cyclic Window Ordering}). (@pxref{Cyclic Window Ordering}).
@item clone-of @item clone-of
@vindex clone-of, a window parameter @vindex clone-of@r{, a window parameter}
This parameter specifies the window that this one has been cloned This parameter specifies the window that this one has been cloned
from. It is installed by @code{window-state-get} (@pxref{Window from. It is installed by @code{window-state-get} (@pxref{Window
Configurations}). Configurations}).
@item window-preserved-size @item window-preserved-size
@vindex window-preserved-size, a window parameter @vindex window-preserved-size@r{, a window parameter}
This parameter specifies a buffer, a direction where @code{nil} means This parameter specifies a buffer, a direction where @code{nil} means
vertical and @code{t} horizontal, and a size in pixels. If this window vertical and @code{t} horizontal, and a size in pixels. If this window
displays the specified buffer and its size in the indicated direction displays the specified buffer and its size in the indicated direction
@ -5060,7 +5060,7 @@ parameter is installed and updated by the function
@code{window-preserve-size} (@pxref{Preserving Window Sizes}). @code{window-preserve-size} (@pxref{Preserving Window Sizes}).
@item quit-restore @item quit-restore
@vindex quit-restore, a window parameter @vindex quit-restore@r{, a window parameter}
This parameter is installed by the buffer display functions This parameter is installed by the buffer display functions
(@pxref{Choosing Window}) and consulted by @code{quit-restore-window} (@pxref{Choosing Window}) and consulted by @code{quit-restore-window}
(@pxref{Quitting Windows}). It contains four elements: (@pxref{Quitting Windows}). It contains four elements:
@ -5092,18 +5092,18 @@ See the description of @code{quit-restore-window} in @ref{Quitting
Windows} for details. Windows} for details.
@item window-side window-slot @item window-side window-slot
@vindex window-side, a window parameter @vindex window-side@r{, a window parameter}
@vindex window-slot, a window parameter @vindex window-slot@r{, a window parameter}
These parameters are used for implementing side windows (@pxref{Side These parameters are used for implementing side windows (@pxref{Side
Windows}). Windows}).
@item window-atom @item window-atom
@vindex window-atom, a window parameter @vindex window-atom@r{, a window parameter}
This parameter is used for implementing atomic windows, see @ref{Atomic This parameter is used for implementing atomic windows, see @ref{Atomic
Windows}. Windows}.
@item mode-line-format @item mode-line-format
@vindex mode-line-format, a window parameter @vindex mode-line-format@r{, a window parameter}
This parameter replaces the value of the buffer-local variable This parameter replaces the value of the buffer-local variable
@code{mode-line-format} (@pxref{Mode Line Basics}) of this window's @code{mode-line-format} (@pxref{Mode Line Basics}) of this window's
buffer whenever this window is displayed. The symbol @code{none} means buffer whenever this window is displayed. The symbol @code{none} means
@ -5112,7 +5112,7 @@ contents of the mode line on other windows showing this buffer are not
affected. affected.
@item header-line-format @item header-line-format
@vindex header-line-format, a window parameter @vindex header-line-format@r{, a window parameter}
This parameter replaces the value of the buffer-local variable This parameter replaces the value of the buffer-local variable
@code{header-line-format} (@pxref{Mode Line Basics}) of this window's @code{header-line-format} (@pxref{Mode Line Basics}) of this window's
buffer whenever this window is displayed. The symbol @code{none} means buffer whenever this window is displayed. The symbol @code{none} means
@ -5121,7 +5121,7 @@ contents of the header line on other windows showing this buffer are not
affected. affected.
@item min-margins @item min-margins
@vindex min-margins, a window parameter @vindex min-margins@r{, a window parameter}
The value of this parameter is a cons cell whose @sc{car} and @sc{cdr}, The value of this parameter is a cons cell whose @sc{car} and @sc{cdr},
if non-@code{nil}, specify the minimum values (in columns) for the left if non-@code{nil}, specify the minimum values (in columns) for the left
and right margin of this window. When present, Emacs will use these and right margin of this window. When present, Emacs will use these

344
doc/misc/cc-mode.texi
View file

File diff suppressed because it is too large Load diff

4
doc/misc/dired-x.texi
View file

@ -640,7 +640,7 @@ A non-@code{nil} value means that @samp{-q} is passed to @code{gzip}
overriding a verbose option in the @env{GZIP} environment variable. overriding a verbose option in the @env{GZIP} environment variable.
@item dired-guess-shell-znew-switches nil @item dired-guess-shell-znew-switches nil
@vindex dired-guess-shell-znew-switches nil @vindex dired-guess-shell-znew-switches
@cindex @code{znew} @cindex @code{znew}
Default: @code{nil} Default: @code{nil}
@ -649,7 +649,7 @@ A string of switches passed to @code{znew}. An example is
smaller than the @file{.gz} file. smaller than the @file{.gz} file.
@item dired-shell-command-history nil @item dired-shell-command-history nil
@vindex dired-shell-command-history nil @vindex dired-shell-command-history
History list for commands that read dired-shell commands. History list for commands that read dired-shell commands.
@end table @end table

8
doc/misc/ediff.texi
View file

@ -345,7 +345,7 @@ file name will be appended to that directory. In addition, if the variable
@code{ediff-use-last-dir} is not @code{nil}, Ediff will offer @code{ediff-use-last-dir} is not @code{nil}, Ediff will offer
previously entered directories as defaults (which will be maintained previously entered directories as defaults (which will be maintained
separately for each type of file, A, B, or C). separately for each type of file, A, B, or C).
@vindex @code{ediff-use-last-dir} @vindex ediff-use-last-dir
All the above functions use the POSIX @code{diff} or @code{diff3} programs All the above functions use the POSIX @code{diff} or @code{diff3} programs
to find differences between two files. They process the @code{diff} output to find differences between two files. They process the @code{diff} output
@ -2304,7 +2304,7 @@ version control, Ediff first tries to check the file out.
If @code{t}, all variant buffers are made read-only at Ediff startup. If @code{t}, all variant buffers are made read-only at Ediff startup.
@item ediff-keep-variants @item ediff-keep-variants
@vindex @code{ediff-keep-variants} @vindex ediff-keep-variants
The default is @code{t}, meaning that the buffers being compared or merged will The default is @code{t}, meaning that the buffers being compared or merged will
be preserved when Ediff quits. Setting this to @code{nil} causes Ediff to be preserved when Ediff quits. Setting this to @code{nil} causes Ediff to
offer the user a chance to delete these buffers (if they are not modified). offer the user a chance to delete these buffers (if they are not modified).
@ -2323,14 +2323,14 @@ Using @code{ediff-cleanup-hook}, one can make Ediff delete the variants
unconditionally (e.g., by making @code{ediff-janitor} into one of these hooks). unconditionally (e.g., by making @code{ediff-janitor} into one of these hooks).
@item ediff-keep-tmp-versions @item ediff-keep-tmp-versions
@vindex @code{ediff-keep-tmp-versions} @vindex ediff-keep-tmp-versions
Default is @code{nil}. If @code{t}, the versions of the files being Default is @code{nil}. If @code{t}, the versions of the files being
compared or merged using operations such as @code{ediff-revision} or compared or merged using operations such as @code{ediff-revision} or
@code{ediff-merge-revisions} are not deleted on exit. The normal action is @code{ediff-merge-revisions} are not deleted on exit. The normal action is
to clean up and delete these version files. to clean up and delete these version files.
@item ediff-grab-mouse @item ediff-grab-mouse
@vindex @code{ediff-grab-mouse} @vindex ediff-grab-mouse
Default is @code{t}. Normally, Ediff grabs mouse and puts it in its Default is @code{t}. Normally, Ediff grabs mouse and puts it in its
control frame. This is useful since the user can be sure that when he control frame. This is useful since the user can be sure that when he
needs to type an Ediff command the focus will be in an appropriate Ediff's needs to type an Ediff command the focus will be in an appropriate Ediff's

40
doc/misc/mh-e.texi
View file

@ -1163,7 +1163,7 @@ your initials. (Unless, of course, your initials happen to be @emph{mh}!)
@cindex customizing MH-E @cindex customizing MH-E
@cindex setting options @cindex setting options
@findex customize-option @findex customize-option
@vindex mh-lpr-command-format, example @vindex mh-lpr-command-format@r{, example}
Many string or integer options are easy to modify using @kbd{M-x Many string or integer options are easy to modify using @kbd{M-x
customize-option}. For example, to modify the option that controls customize-option}. For example, to modify the option that controls
@ -1181,7 +1181,7 @@ Sessions}. To read more about @code{mh-lpr-command-format}, see
@cindex option, turning on and off @cindex option, turning on and off
@cindex t @cindex t
@findex customize-option @findex customize-option
@vindex mh-bury-show-buffer-flag, example @vindex mh-bury-show-buffer-flag@r{, example}
Options can also hold boolean values. In Emacs Lisp, the boolean Options can also hold boolean values. In Emacs Lisp, the boolean
values are @code{nil}, which means false, and @code{t}, which means values are @code{nil}, which means false, and @code{t}, which means
@ -1196,7 +1196,7 @@ the @samp{Erase Customization} menu item to reset the option to the
default, which places the MH-Show buffer at the bottom of the buffer default, which places the MH-Show buffer at the bottom of the buffer
stack. stack.
@vindex mh-mhl-format-file, example @vindex mh-mhl-format-file@r{, example}
The text usually says to turn on an option by setting it to a The text usually says to turn on an option by setting it to a
@emph{non-@code{nil}} value, because sometimes values other than @emph{non-@code{nil}} value, because sometimes values other than
@ -1520,9 +1520,9 @@ after running @kbd{M-x mh-rmail} the first time or when you've changed
the message numbers from outside of MH-E. the message numbers from outside of MH-E.
@findex mh-execute-commands @findex mh-execute-commands
@findex mh-rescan-folder, example @findex mh-rescan-folder@r{, example}
@findex mh-show, example @findex mh-show@r{, example}
@vindex mh-inc-folder-hook, example @vindex mh-inc-folder-hook@r{, example}
@smalllisp @smalllisp
@group @group
@ -3175,7 +3175,7 @@ code to @file{~/.emacs}.
@filbreak @filbreak
@end iftex @end iftex
@findex mh-rmail, example @findex mh-rmail@r{, example}
@smalllisp @smalllisp
@group @group
@ -3490,7 +3490,7 @@ The hook @code{mh-folder-mode-hook} is called when visiting a new
folder in MH-Folder mode. This could be used to set your own key folder in MH-Folder mode. This could be used to set your own key
bindings, for example: bindings, for example:
@vindex mh-folder-mode-hook, example @vindex mh-folder-mode-hook@r{, example}
@smalllisp @smalllisp
@group @group
@ -3810,9 +3810,9 @@ again.
@findex mh-execute-commands @findex mh-execute-commands
@kindex q @kindex q
@vindex mh-before-quit-hook @vindex mh-before-quit-hook
@vindex mh-before-quit-hook, example @vindex mh-before-quit-hook@r{, example}
@vindex mh-quit-hook @vindex mh-quit-hook
@vindex mh-quit-hook, example @vindex mh-quit-hook@r{, example}
The two hooks @code{mh-before-quit-hook} and @code{mh-quit-hook} are The two hooks @code{mh-before-quit-hook} and @code{mh-quit-hook} are
called by @kbd{q}. The former one is called before the quit occurs, so called by @kbd{q}. The former one is called before the quit occurs, so
@ -4099,7 +4099,7 @@ may have a complicated @file{components} file and need to tell MH-E
where the cursor should go. Here's an example of how you would use where the cursor should go. Here's an example of how you would use
this hook. this hook.
@findex mh-insert-signature, example @findex mh-insert-signature@r{, example}
@smalllisp @smalllisp
@group @group
@ -8478,7 +8478,7 @@ message according to MH; it also uses that column for notations.
@vindex mh-adaptive-cmd-note-flag @vindex mh-adaptive-cmd-note-flag
@vindex mh-scan-format-file @vindex mh-scan-format-file
@vindex mh-scan-format-file, example @vindex mh-scan-format-file@r{, example}
The first thing you have to do is tell MH-E to use this file. The first thing you have to do is tell MH-E to use this file.
Customize @code{mh-scan-format-file} and set its value to @samp{Use Customize @code{mh-scan-format-file} and set its value to @samp{Use
@ -8488,7 +8488,7 @@ Default scan Format}. If you didn't get already turn off
Next, tell MH-E what a valid scan line looks like so that you can at Next, tell MH-E what a valid scan line looks like so that you can at
least display the output of scan in your MH-Folder buffer. least display the output of scan in your MH-Folder buffer.
@vindex mh-scan-valid-regexp, example @vindex mh-scan-valid-regexp@r{, example}
@smalllisp @smalllisp
(setq mh-scan-valid-regexp "[0-9]+[+D^ ]$") (setq mh-scan-valid-regexp "[0-9]+[+D^ ]$")
@ -8499,8 +8499,8 @@ message, you need to tell MH-E how to access the message number. You
should also see why MH-E requires that you include a message number in should also see why MH-E requires that you include a message number in
the first place. the first place.
@vindex mh-scan-msg-number-regexp, example @vindex mh-scan-msg-number-regexp@r{, example}
@vindex mh-scan-msg-search-regexp, example @vindex mh-scan-msg-search-regexp@r{, example}
@smalllisp @smalllisp
(setq mh-scan-msg-number-regexp "^.* \\([0-9]+\\)[+D^ ]$") (setq mh-scan-msg-number-regexp "^.* \\([0-9]+\\)[+D^ ]$")
@ -8509,7 +8509,7 @@ the first place.
In order to get the next and previous commands working, add this. In order to get the next and previous commands working, add this.
@vindex mh-scan-good-msg-regexp, example @vindex mh-scan-good-msg-regexp@r{, example}
@smalllisp @smalllisp
(setq mh-scan-good-msg-regexp "^.* \\([0-9]+\\)[+D^ ]$") (setq mh-scan-good-msg-regexp "^.* \\([0-9]+\\)[+D^ ]$")
@ -8519,8 +8519,8 @@ Note that the current message isn't marked with a @samp{+} when moving
between the next and previous messages. Here is the code required to between the next and previous messages. Here is the code required to
get this working. get this working.
@vindex set-mh-cmd-note, example @vindex set-mh-cmd-note@r{, example}
@vindex mh-scan-cur-msg-number-regexp, example @vindex mh-scan-cur-msg-number-regexp@r{, example}
@smalllisp @smalllisp
(set-mh-cmd-note 76) (set-mh-cmd-note 76)
@ -8529,8 +8529,8 @@ get this working.
Finally, add the following to delete and refile messages. Finally, add the following to delete and refile messages.
@vindex mh-scan-deleted-msg-regexp, example @vindex mh-scan-deleted-msg-regexp@r{, example}
@vindex mh-scan-refiled-msg-regexp, example @vindex mh-scan-refiled-msg-regexp@r{, example}
@smalllisp @smalllisp
(setq mh-scan-deleted-msg-regexp "^.* \\([0-9]+\\)D$") (setq mh-scan-deleted-msg-regexp "^.* \\([0-9]+\\)D$")

14
doc/misc/pcl-cvs.texi
View file

@ -1331,13 +1331,13 @@ default.
@node Customizing Faces @node Customizing Faces
@section Customizing Faces @section Customizing Faces
@vindex cvs-header (face) @vindex cvs-header @r{(face)}
@vindex cvs-filename (face) @vindex cvs-filename @r{(face)}
@vindex cvs-unknown (face) @vindex cvs-unknown @r{(face)}
@vindex cvs-handled (face) @vindex cvs-handled @r{(face)}
@vindex cvs-need-action (face) @vindex cvs-need-action @r{(face)}
@vindex cvs-marked (face) @vindex cvs-marked @r{(face)}
@vindex cvs-msg (face) @vindex cvs-msg @r{(face)}
PCL-CVS adds a few extra features, including menus, mouse bindings, and PCL-CVS adds a few extra features, including menus, mouse bindings, and
fontification of the @file{*cvs*} buffer. The faces defined for fontification of the @file{*cvs*} buffer. The faces defined for

24
doc/misc/reftex.texi
View file

@ -1732,8 +1732,8 @@ seems inconvenient to you.@footnote{You could, e.g., bind
@cindex LaTeX packages, @code{varioref} @cindex LaTeX packages, @code{varioref}
@cindex @code{fancyref}, LaTeX package @cindex @code{fancyref}, LaTeX package
@cindex LaTeX packages, @code{fancyref} @cindex LaTeX packages, @code{fancyref}
@vindex reftex-vref-is-default (deprecated) @vindex reftex-vref-is-default @r{(deprecated)}
@vindex reftex-fref-is-default (deprecated) @vindex reftex-fref-is-default @r{(deprecated)}
In former versions of @RefTeX{} only support for @code{varioref} and In former versions of @RefTeX{} only support for @code{varioref} and
@code{fancyref} was included. @code{varioref} is a @LaTeX{} package to @code{fancyref} was included. @code{varioref} is a @LaTeX{} package to
create cross-references with page information. @code{fancyref} is a create cross-references with page information. @code{fancyref} is a
@ -3295,11 +3295,11 @@ The following list describes the individual parts of the interface.
@itemize @bullet @itemize @bullet
@item @item
@findex reftex-label @findex reftex-label
@vindex LaTeX-label-function, @r{AUCTeX} @vindex LaTeX-label-function@r{, AUCTeX}
@kindex C-c C-e @kindex C-c C-e
@kindex C-c C-s @kindex C-c C-s
@findex LaTeX-section, @r{AUCTeX} @findex LaTeX-section@r{, AUCTeX}
@findex TeX-insert-macro, @r{AUCTeX} @findex TeX-insert-macro@r{, AUCTeX}
@b{@AUCTeX{} calls @code{reftex-label} to insert labels}@* @b{@AUCTeX{} calls @code{reftex-label} to insert labels}@*
When a new section is created with @kbd{C-c C-s}, or a new environment When a new section is created with @kbd{C-c C-s}, or a new environment
is inserted with @kbd{C-c C-e}, @AUCTeX{} normally prompts for a label to is inserted with @kbd{C-c C-e}, @AUCTeX{} normally prompts for a label to
@ -3327,14 +3327,14 @@ have to rescan the buffer in order to see it.
@item @item
@findex reftex-arg-label @findex reftex-arg-label
@findex TeX-arg-label, @r{AUCTeX function} @findex TeX-arg-label@r{, AUCTeX function}
@findex reftex-arg-ref @findex reftex-arg-ref
@findex TeX-arg-ref, @r{AUCTeX function} @findex TeX-arg-ref@r{, AUCTeX function}
@findex reftex-arg-cite @findex reftex-arg-cite
@findex TeX-arg-cite, @r{AUCTeX function} @findex TeX-arg-cite@r{, AUCTeX function}
@findex reftex-arg-index @findex reftex-arg-index
@findex TeX-arg-index, @r{AUCTeX function} @findex TeX-arg-index@r{, AUCTeX function}
@findex TeX-insert-macro, @r{AUCTeX function} @findex TeX-insert-macro@r{, AUCTeX function}
@kindex C-c @key{RET} @kindex C-c @key{RET}
@b{@RefTeX{} supplies macro arguments}@* When you insert a macro @b{@RefTeX{} supplies macro arguments}@* When you insert a macro
interactively with @kbd{C-c @key{RET}}, @AUCTeX{} normally prompts for interactively with @kbd{C-c @key{RET}}, @AUCTeX{} normally prompts for
@ -3357,7 +3357,7 @@ Labels}).
@node Style Files @node Style Files
@subsection Style Files @subsection Style Files
@cindex Style files, AUCTeX @cindex Style files, AUCTeX
@findex TeX-add-style-hook, @r{AUCTeX} @findex TeX-add-style-hook@r{, AUCTeX}
Style files are Emacs Lisp files which are evaluated by @AUCTeX{} in Style files are Emacs Lisp files which are evaluated by @AUCTeX{} in
association with the @code{\documentclass} and @code{\usepackage} association with the @code{\documentclass} and @code{\usepackage}
commands of a document (@pxref{Style Files,,,auctex}). Support for commands of a document (@pxref{Style Files,,,auctex}). Support for
@ -3396,7 +3396,7 @@ style file of @AUCTeX{} for example contains the following:
@end lisp @end lisp
@noindent @noindent
@findex LaTeX-add-environments, @r{AUCTeX} @findex LaTeX-add-environments@r{, AUCTeX}
while a package @code{myprop} defining a @code{proposition} environment while a package @code{myprop} defining a @code{proposition} environment
with @code{\newtheorem} might use with @code{\newtheorem} might use

144
doc/misc/sc.texi
View file

@ -274,7 +274,7 @@ Notice here that my inclusion of Jane's inclusion of John's original
message did not result in a line cited with @samp{Jane>John>}. message did not result in a line cited with @samp{Jane>John>}.
@vindex sc-nested-citation-p @vindex sc-nested-citation-p
@vindex nested-citation-p (sc-) @vindex nested-citation-p @r{(sc-)}
Supercite supports both styles of citation, and the variable Supercite supports both styles of citation, and the variable
@code{sc-nested-citation-p} controls which style it will use when @code{sc-nested-citation-p} controls which style it will use when
citing previously uncited text. When this variable is @code{nil} (the citing previously uncited text. When this variable is @code{nil} (the
@ -292,7 +292,7 @@ directly user definable. The elements are concatenated together, in
this order: this order:
@cindex citation leader @cindex citation leader
@vindex citation-leader (sc-) @vindex citation-leader @r{(sc-)}
@vindex sc-citation-leader @vindex sc-citation-leader
@enumerate @enumerate
@item @item
@ -309,7 +309,7 @@ headers, though you may be asked to confirm Supercite's choice.
@cindex citation delimiter @cindex citation delimiter
@vindex sc-citation-delimiter @vindex sc-citation-delimiter
@vindex citation-delimiter (sc-) @vindex citation-delimiter @r{(sc-)}
@item @item
The @dfn{citation delimiter}. This string, contained in the variable The @dfn{citation delimiter}. This string, contained in the variable
@code{sc-citation-delimiter} visually separates the citation from the @code{sc-citation-delimiter} visually separates the citation from the
@ -317,7 +317,7 @@ text of the line. This variable has a default value of @code{">"} and
for best results, the string should consist of only a single character. for best results, the string should consist of only a single character.
@cindex citation separator @cindex citation separator
@vindex citation-separator (sc-) @vindex citation-separator @r{(sc-)}
@vindex sc-citation-separator @vindex sc-citation-separator
@item @item
The @dfn{citation separator}. The citation separator is contained in The @dfn{citation separator}. The citation separator is contained in
@ -348,15 +348,15 @@ Recognition of cited lines is controlled by variables analogous to
those that make up the citation string as mentioned previously. those that make up the citation string as mentioned previously.
@vindex sc-citation-leader-regexp @vindex sc-citation-leader-regexp
@vindex citation-leader-regexp (sc-) @vindex citation-leader-regexp @r{(sc-)}
@vindex sc-citation-delimiter-regexp @vindex sc-citation-delimiter-regexp
@vindex citation-delimiter-regexp (sc-) @vindex citation-delimiter-regexp @r{(sc-)}
@vindex sc-citation-separator-regexp @vindex sc-citation-separator-regexp
@vindex citation-separator-regexp (sc-) @vindex citation-separator-regexp @r{(sc-)}
@vindex sc-citation-root-regexp @vindex sc-citation-root-regexp
@vindex citation-root-regexp (sc-) @vindex citation-root-regexp @r{(sc-)}
@vindex sc-citation-nonnested-root-regexp @vindex sc-citation-nonnested-root-regexp
@vindex citation-nonnested-root-regexp (sc-) @vindex citation-nonnested-root-regexp @r{(sc-)}
The variable @code{sc-citation-leader-regexp} describes how citation The variable @code{sc-citation-leader-regexp} describes how citation
leaders can look, by default it matches any number of spaces or tabs. leaders can look, by default it matches any number of spaces or tabs.
@ -388,7 +388,7 @@ change @code{sc-citation-root-regexp} you should always also change
@cindex Info Alist @cindex Info Alist
@cindex information extracted from mail fields @cindex information extracted from mail fields
@findex sc-mail-field @findex sc-mail-field
@findex mail-field (sc-) @findex mail-field @r{(sc-)}
@dfn{Mail header information keys} are nuggets of information that @dfn{Mail header information keys} are nuggets of information that
Supercite extracts from the various mail headers of the original Supercite extracts from the various mail headers of the original
@ -409,7 +409,7 @@ Subject:@: Better get out your asbestos suit
@end example @end example
@vindex sc-mumble @vindex sc-mumble
@vindex mumble (sc-) @vindex mumble @r{(sc-)}
@noindent @noindent
then, the following lisp constructs return: then, the following lisp constructs return:
@ -513,7 +513,7 @@ header.
@cindex header rewrite functions @cindex header rewrite functions
@vindex sc-rewrite-header-list @vindex sc-rewrite-header-list
@vindex rewrite-header-list (sc-) @vindex rewrite-header-list @r{(sc-)}
There are a number of built-in @dfn{header rewrite functions} supplied There are a number of built-in @dfn{header rewrite functions} supplied
by Supercite, but you can write your own custom header rewrite by Supercite, but you can write your own custom header rewrite
functions (perhaps using the built-in ones as examples). The variable functions (perhaps using the built-in ones as examples). The variable
@ -523,7 +523,7 @@ reference header, and when displaying @dfn{electric references}.
@xref{Electric References}. @xref{Electric References}.
@vindex sc-preferred-header-style @vindex sc-preferred-header-style
@vindex preferred-header-style (sc-) @vindex preferred-header-style @r{(sc-)}
When Supercite is initially run on a reply buffer (via When Supercite is initially run on a reply buffer (via
@code{sc-cite-original}), it will automatically call one of these @code{sc-cite-original}), it will automatically call one of these
functions. The one it uses is defined in the variable functions. The one it uses is defined in the variable
@ -544,7 +544,7 @@ below, @var{date} and @var{from} correspond to the values of the
@samp{Date:@:} and @samp{From:@:} mail headers respectively. @samp{Date:@:} and @samp{From:@:} mail headers respectively.
@vindex sc-reference-tag-string @vindex sc-reference-tag-string
@vindex reference-tag-string (sc-) @vindex reference-tag-string @r{(sc-)}
Also, the string @code{">>>>>"} below is really the value of the Also, the string @code{">>>>>"} below is really the value of the
variable @code{sc-reference-tag-string}. This variable is used in all variable @code{sc-reference-tag-string}. This variable is used in all
built-in header rewrite functions, and you can customize its value to built-in header rewrite functions, and you can customize its value to
@ -559,7 +559,7 @@ problem either in your MUA or in Supercite's installation).
@table @code @table @code
@findex sc-no-header @findex sc-no-header
@findex no-header (sc-) @findex no-header @r{(sc-)}
@item sc-no-header @item sc-no-header
This function produces no header. It should be used instead of This function produces no header. It should be used instead of
@code{nil} to produce a blank header. This header can possibly @code{nil} to produce a blank header. This header can possibly
@ -567,38 +567,38 @@ contain a blank line after the @code{mail-header-separator} line.
@item sc-no-blank-line-or-header @item sc-no-blank-line-or-header
@findex sc-no-blank-line-or-header @findex sc-no-blank-line-or-header
@findex no-blank-line-or-header (sc-) @findex no-blank-line-or-header @r{(sc-)}
This function is similar to @code{sc-no-header} except that any blank This function is similar to @code{sc-no-header} except that any blank
line after the @code{mail-header-separator} line will be removed. line after the @code{mail-header-separator} line will be removed.
@item sc-header-on-said @item sc-header-on-said
@findex sc-header-on-said @findex sc-header-on-said
@findex header-on-said (sc-) @findex header-on-said @r{(sc-)}
@code{>>>>> On @var{date}, @var{from} said:} @code{>>>>> On @var{date}, @var{from} said:}
@item sc-header-inarticle-writes @item sc-header-inarticle-writes
@findex sc-header-inarticle-writes @findex sc-header-inarticle-writes
@findex header-inarticle-writes (sc-) @findex header-inarticle-writes @r{(sc-)}
@code{>>>>> In article @var{message-id}, @var{from} writes:} @code{>>>>> In article @var{message-id}, @var{from} writes:}
@item sc-header-regarding-adds @item sc-header-regarding-adds
@findex sc-header-regarding-adds @findex sc-header-regarding-adds
@findex header-regarding-adds (sc-) @findex header-regarding-adds @r{(sc-)}
@code{>>>>> Regarding @var{subject}; @var{from} adds:} @code{>>>>> Regarding @var{subject}; @var{from} adds:}
@item sc-header-attributed-writes @item sc-header-attributed-writes
@findex sc-header-attributed-writes @findex sc-header-attributed-writes
@findex header-attributed-writes (sc-) @findex header-attributed-writes @r{(sc-)}
@code{>>>>> "@var{sc-attribution}" == @var{sc-author} <@var{sc-reply-address}> writes:} @code{>>>>> "@var{sc-attribution}" == @var{sc-author} <@var{sc-reply-address}> writes:}
@item sc-header-author-writes @item sc-header-author-writes
@findex sc-header-author-writes @findex sc-header-author-writes
@findex header-author-writes (sc-) @findex header-author-writes @r{(sc-)}
@code{>>>>> @var{sc-author} writes:} @code{>>>>> @var{sc-author} writes:}
@item sc-header-verbose @item sc-header-verbose
@findex sc-header-verbose @findex sc-header-verbose
@findex header-verbose (sc-) @findex header-verbose @r{(sc-)}
@code{>>>>> On @var{date},}@* @code{>>>>> On @var{date},}@*
@code{>>>>> @var{sc-author}}@* @code{>>>>> @var{sc-author}}@*
@code{>>>>> from the organization of @var{organization}}@* @code{>>>>> from the organization of @var{organization}}@*
@ -624,7 +624,7 @@ not. Supercite provides an optional @dfn{electric reference} mode
which you can drop into to give you this functionality. which you can drop into to give you this functionality.
@vindex sc-electric-references-p @vindex sc-electric-references-p
@vindex electric-references-p (sc-) @vindex electric-references-p @r{(sc-)}
If the variable @code{sc-electric-references-p} is non-@code{nil}, If the variable @code{sc-electric-references-p} is non-@code{nil},
Supercite will bring up an electric reference mode buffer and place you Supercite will bring up an electric reference mode buffer and place you
into a recursive edit. The electric reference buffer is read-only, so into a recursive edit. The electric reference buffer is read-only, so
@ -644,10 +644,10 @@ The following commands are available while in electric reference mode
@table @asis @table @asis
@item @code{sc-eref-next} (@kbd{n}) @item @code{sc-eref-next} (@kbd{n})
@findex sc-eref-next @findex sc-eref-next
@findex eref-next (sc-) @findex eref-next @r{(sc-)}
@kindex n @kindex n
@vindex sc-electric-circular-p @vindex sc-electric-circular-p
@vindex electric-circular-p (sc-) @vindex electric-circular-p @r{(sc-)}
Displays the next reference header in the electric reference buffer. If Displays the next reference header in the electric reference buffer. If
the variable @code{sc-electric-circular-p} is non-@code{nil}, invoking 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 @code{sc-eref-next} while viewing the last reference header in the list
@ -655,7 +655,7 @@ will wrap around to the first header.
@item @code{sc-eref-prev} (@kbd{p}) @item @code{sc-eref-prev} (@kbd{p})
@findex sc-eref-prev @findex sc-eref-prev
@findex eref-prev (sc-) @findex eref-prev @r{(sc-)}
@kindex p @kindex p
Displays the previous reference header in the electric reference buffer. Displays the previous reference header in the electric reference buffer.
If the variable @code{sc-electric-circular-p} is non-@code{nil}, If the variable @code{sc-electric-circular-p} is non-@code{nil},
@ -663,7 +663,7 @@ invoking @code{sc-eref-prev} will wrap around to the last header.
@item @code{sc-eref-goto} (@kbd{g}) @item @code{sc-eref-goto} (@kbd{g})
@findex sc-eref-goto @findex sc-eref-goto
@findex eref-goto (sc-) @findex eref-goto @r{(sc-)}
@kindex g @kindex g
Goes to a specified reference header. The index (into the Goes to a specified reference header. The index (into the
@code{sc-rewrite-header-list}) can be specified as a numeric argument to @code{sc-rewrite-header-list}) can be specified as a numeric argument to
@ -672,14 +672,14 @@ minibuffer.
@item @code{sc-eref-jump} (@kbd{j}) @item @code{sc-eref-jump} (@kbd{j})
@findex sc-eref-jump @findex sc-eref-jump
@findex eref-jump (sc-) @findex eref-jump @r{(sc-)}
@kindex j @kindex j
Display the preferred reference header, i.e., the one indexed by the current Display the preferred reference header, i.e., the one indexed by the current
value of @code{sc-preferred-header-style}. value of @code{sc-preferred-header-style}.
@item @code{sc-eref-setn} (@kbd{s}) @item @code{sc-eref-setn} (@kbd{s})
@findex sc-eref-setn @findex sc-eref-setn
@findex eref-setn (sc-) @findex eref-setn @r{(sc-)}
@kindex s @kindex s
Set the preferred reference header (i.e., Set the preferred reference header (i.e.,
@code{sc-preferred-header-style}) to the currently displayed header. @code{sc-preferred-header-style}) to the currently displayed header.
@ -689,19 +689,19 @@ Set the preferred reference header (i.e.,
@kindex C-j @kindex C-j
@kindex q @kindex q
@findex sc-eref-exit @findex sc-eref-exit
@findex eref-exit (sc-) @findex eref-exit @r{(sc-)}
Exit from electric reference mode and insert the current header into the Exit from electric reference mode and insert the current header into the
reply buffer. reply buffer.
@item @code{sc-eref-abort} (@kbd{q}, @kbd{x}) @item @code{sc-eref-abort} (@kbd{q}, @kbd{x})
@findex sc-eref-abort @findex sc-eref-abort
@findex eref-abort (sc-) @findex eref-abort @r{(sc-)}
@kindex x @kindex x
Exit from electric reference mode without inserting the current header. Exit from electric reference mode without inserting the current header.
@end table @end table
@vindex sc-electric-mode-hook @vindex sc-electric-mode-hook
@vindex electric-mode-hook (sc-) @vindex electric-mode-hook @r{(sc-)}
@noindent @noindent
Supercite will execute the hook @code{sc-electric-mode-hook} before Supercite will execute the hook @code{sc-electric-mode-hook} before
entering electric reference mode. entering electric reference mode.
@ -747,7 +747,7 @@ interface specifications, or if you are writing or maintaining an MUA,
@cindex autoload @cindex autoload
@cindex .emacs file @cindex .emacs file
@findex sc-cite-original @findex sc-cite-original
@findex cite-original (sc-) @findex cite-original @r{(sc-)}
The first thing that everyone should do, regardless of the MUA you are The first thing that everyone should do, regardless of the MUA you are
using is to set up Emacs so it will load Supercite at the appropriate using is to set up Emacs so it will load Supercite at the appropriate
time. This happens automatically if Supercite is distributed with your time. This happens automatically if Supercite is distributed with your
@ -789,7 +789,7 @@ message from an MUA.
@node Reply Buffer Initialization @node Reply Buffer Initialization
@section Reply Buffer Initialization @section Reply Buffer Initialization
@findex sc-cite-original @findex sc-cite-original
@findex cite-original (sc-) @findex cite-original @r{(sc-)}
Executing @code{sc-cite-original} performs the following steps as it Executing @code{sc-cite-original} performs the following steps as it
initializes the reply buffer: initializes the reply buffer:
@ -797,7 +797,7 @@ initializes the reply buffer:
@enumerate @enumerate
@item @item
@vindex sc-pre-hook @vindex sc-pre-hook
@vindex pre-hook (sc-) @vindex pre-hook @r{(sc-)}
@emph{Runs @code{sc-pre-hook}.} @emph{Runs @code{sc-pre-hook}.}
This hook variable is run before @code{sc-cite-original} does any other This hook variable is run before @code{sc-cite-original} does any other
work. You could conceivably use this hook to set certain Supercite work. You could conceivably use this hook to set certain Supercite
@ -808,7 +808,7 @@ an article).
@item @item
@emph{Inserts Supercite's keymap.} @emph{Inserts Supercite's keymap.}
@vindex sc-mode-map-prefix @vindex sc-mode-map-prefix
@vindex mode-map-prefix (sc-) @vindex mode-map-prefix @r{(sc-)}
@kindex C-c C-p @kindex C-c C-p
@cindex keymap prefix @cindex keymap prefix
Supercite provides a number of commands for performing post-yank Supercite provides a number of commands for performing post-yank
@ -842,9 +842,9 @@ affect alternative citing styles.
@item @item
@emph{Processes the mail headers.} @emph{Processes the mail headers.}
@vindex sc-confirm-always-p @vindex sc-confirm-always-p
@vindex confirm-always-p (sc-) @vindex confirm-always-p @r{(sc-)}
@vindex sc-mail-warn-if-non-rfc822-p @vindex sc-mail-warn-if-non-rfc822-p
@vindex mail-warn-if-non-rfc822-p (sc-) @vindex mail-warn-if-non-rfc822-p @r{(sc-)}
All previously retrieved info key-value pairs are deleted from the info All previously retrieved info key-value pairs are deleted from the info
alist, then the mail headers in the body of the yanked message are alist, then the mail headers in the body of the yanked message are
scanned. Info key-value pairs are created for each header found. Also, scanned. Info key-value pairs are created for each header found. Also,
@ -857,8 +857,8 @@ transport agent) along the way.
@vindex sc-nuke-mail-headers @vindex sc-nuke-mail-headers
@vindex sc-nuke-mail-header-list @vindex sc-nuke-mail-header-list
@vindex nuke-mail-headers (sc-) @vindex nuke-mail-headers @r{(sc-)}
@vindex nuke-mail-header-list (sc-) @vindex nuke-mail-header-list @r{(sc-)}
Once the info keys have been extracted from the mail headers, the Once the info keys have been extracted from the mail headers, the
headers are nuked from the reply buffer. You can control exactly which headers are nuked from the reply buffer. You can control exactly which
headers are removed or kept, but by default, all headers are removed. headers are removed or kept, but by default, all headers are removed.
@ -881,7 +881,7 @@ The line is matched against the regexp using @code{looking-at} rooted at
the beginning of the line. the beginning of the line.
@vindex sc-blank-lines-after-headers @vindex sc-blank-lines-after-headers
@vindex blank-lines-after-headers (sc-) @vindex blank-lines-after-headers @r{(sc-)}
If the variable @code{sc-blank-lines-after-headers} is non-@code{nil}, If the variable @code{sc-blank-lines-after-headers} is non-@code{nil},
it contains the number of blank lines remaining in the buffer after mail it contains the number of blank lines remaining in the buffer after mail
headers are nuked. By default, only one blank line is left in the buffer. headers are nuked. By default, only one blank line is left in the buffer.
@ -895,7 +895,7 @@ original message. @xref{Selecting an Attribution}, for details.
@item @item
@emph{Cites the message body.} @emph{Cites the message body.}
@vindex sc-cite-region-limit @vindex sc-cite-region-limit
@vindex cite-region-limit (sc-)b @vindex cite-region-limit @r{(sc-)}
After the selection of the attribution and citation strings, Supercite After the selection of the attribution and citation strings, Supercite
cites the original message by inserting the citation string prefix in cites the original message by inserting the citation string prefix in
front of every uncited line. You may not want Supercite to front of every uncited line. You may not want Supercite to
@ -918,7 +918,7 @@ automatically. Use this if you always want to be able to edit and cite
the message manually. the message manually.
@vindex sc-cite-blank-lines-p @vindex sc-cite-blank-lines-p
@vindex cite-blank-lines-p (sc-) @vindex cite-blank-lines-p @r{(sc-)}
The variable @code{sc-cite-blank-lines-p} controls whether blank lines The variable @code{sc-cite-blank-lines-p} controls whether blank lines
in the original message should be cited or not. If this variable is in the original message should be cited or not. If this variable is
non-@code{nil}, blank lines will be cited just like non-blank lines. non-@code{nil}, blank lines will be cited just like non-blank lines.
@ -936,7 +936,7 @@ recognize those styles you see often.
@item @item
@emph{Runs @code{sc-post-hook}.} @emph{Runs @code{sc-post-hook}.}
@vindex sc-post-hook @vindex sc-post-hook
@vindex post-hook (sc-) @vindex post-hook @r{(sc-)}
This variable is very similar to @code{sc-pre-hook}, except that it runs 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 after @code{sc-cite-original} is finished. This hook is provided mostly
for completeness and backward compatibility. Perhaps it could be used to for completeness and backward compatibility. Perhaps it could be used to
@ -947,11 +947,11 @@ reset certain variables set in @code{sc-pre-hook}.
@section Filling Cited Text @section Filling Cited Text
@cindex filling paragraphs @cindex filling paragraphs
@vindex sc-auto-fill-region-p @vindex sc-auto-fill-region-p
@vindex auto-fill-region-p (sc-) @vindex auto-fill-region-p @r{(sc-)}
@cindex filladapt @cindex filladapt
@cindex gin-mode @cindex gin-mode
@findex sc-setup-filladapt @findex sc-setup-filladapt
@findex setup-filladapt (sc-) @findex setup-filladapt @r{(sc-)}
Supercite will automatically fill newly cited text from the original Supercite will automatically fill newly cited text from the original
message unless the variable @code{sc-auto-fill-region-p} has a message unless the variable @code{sc-auto-fill-region-p} has a
@ -971,7 +971,7 @@ makes @dfn{filladapt} a little more Supercite savvy than its default
setup. setup.
@vindex sc-fixup-whitespace-p @vindex sc-fixup-whitespace-p
@vindex fixup-whitespace-p (sc-) @vindex fixup-whitespace-p @r{(sc-)}
Also, Supercite will collapse leading whitespace between the citation Also, Supercite will collapse leading whitespace between the citation
string and the text on a line when the variable string and the text on a line when the variable
@code{sc-fixup-whitespace-p} is non-@code{nil}. The default value for @code{sc-fixup-whitespace-p} is non-@code{nil}. The default value for
@ -1025,7 +1025,7 @@ fill cited text.
@chapter Selecting an Attribution @chapter Selecting an Attribution
@cindex attribution list @cindex attribution list
@vindex sc-preferred-attribution-list @vindex sc-preferred-attribution-list
@vindex preferred-attribution-list (sc-) @vindex preferred-attribution-list @r{(sc-)}
As you know, the attribution string is the part of the author's name As you know, the attribution string is the part of the author's name
that will be used to composed a non-nested citation string. Supercite that will be used to composed a non-nested citation string. Supercite
@ -1080,7 +1080,7 @@ recite paragraphs in the reply.
@item "sc-consult" @item "sc-consult"
@vindex sc-attrib-selection-list @vindex sc-attrib-selection-list
@vindex attrib-selection-list (sc-) @vindex attrib-selection-list @r{(sc-)}
consults the customizable list @code{sc-attrib-selection-list} which can consults the customizable list @code{sc-attrib-selection-list} which can
be used to select special attributions based on the value of any info be used to select special attributions based on the value of any info
key. See below for details. key. See below for details.
@ -1114,7 +1114,7 @@ suggested that if you change the order of the keys in this list, that
@code{"sc-lastchoice"}. This latter is the default. @code{"sc-lastchoice"}. This latter is the default.
@vindex sc-attrib-selection-list @vindex sc-attrib-selection-list
@vindex attrib-selection-list (sc-) @vindex attrib-selection-list @r{(sc-)}
The value @code{"sc-consult"} in @code{sc-preferred-attribution-list} The value @code{"sc-consult"} in @code{sc-preferred-attribution-list}
has a special meaning during attribution selection. When Supercite has a special meaning during attribution selection. When Supercite
encounters this preference, it begins processing a customizable list of encounters this preference, it begins processing a customizable list of
@ -1131,7 +1131,7 @@ Each element in this list contains lists of the following form:
@noindent @noindent
@findex sc-mail-field @findex sc-mail-field
@findex mail-field (sc-) @findex mail-field @r{(sc-)}
where @var{infokey} is a key for @code{sc-mail-field} and @var{regexp} where @var{infokey} is a key for @code{sc-mail-field} and @var{regexp}
is a regular expression to match against the @var{infokey}'s value. If is a regular expression to match against the @var{infokey}'s value. If
@var{regexp} matches the @var{infokey}'s value, the @var{attribution} is @var{regexp} matches the @var{infokey}'s value, the @var{attribution} is
@ -1148,9 +1148,9 @@ to cite your friend's message with the appropriate attribution.
@node Anonymous Attributions @node Anonymous Attributions
@section Anonymous Attributions @section Anonymous Attributions
@vindex sc-default-author-name @vindex sc-default-author-name
@vindex default-author-name (sc-) @vindex default-author-name @r{(sc-)}
@vindex sc-default-attribution @vindex sc-default-attribution
@vindex default-attribution (sc-) @vindex default-attribution @r{(sc-)}
When the author's name cannot be found in the @samp{From:@:} mail When the author's name cannot be found in the @samp{From:@:} mail
header, a fallback author name and attribution string must be supplied. header, a fallback author name and attribution string must be supplied.
@ -1163,7 +1163,7 @@ author name or attribution is a sign that something is set up
incorrectly. incorrectly.
@vindex sc-use-only-preference-p @vindex sc-use-only-preference-p
@vindex use-only-preference-p (sc-) @vindex use-only-preference-p @r{(sc-)}
Also, if the preferred attribution, which you specified in your Also, if the preferred attribution, which you specified in your
@code{sc-preferred-attribution-list} variable cannot be found, a @code{sc-preferred-attribution-list} variable cannot be found, a
secondary method can be employed to find a valid attribution string. The secondary method can be employed to find a valid attribution string. The
@ -1199,7 +1199,7 @@ attribution alist.
@end enumerate @end enumerate
@vindex sc-confirm-always-p @vindex sc-confirm-always-p
@vindex confirm-always-p (sc-) @vindex confirm-always-p @r{(sc-)}
Once the attribution string has been automatically selected, a number of Once the attribution string has been automatically selected, a number of
things can happen. If the variable @code{sc-confirm-always-p} is things can happen. If the variable @code{sc-confirm-always-p} is
non-@code{nil}, you are queried for confirmation of the chosen non-@code{nil}, you are queried for confirmation of the chosen
@ -1210,15 +1210,15 @@ you enter becomes the value associated with the @code{"sc-lastchoice"}
key in the attribution alist. key in the attribution alist.
@vindex sc-downcase-p @vindex sc-downcase-p
@vindex downcase-p (sc-) @vindex downcase-p @r{(sc-)}
Once an attribution string has been selected, Supercite will force the Once an attribution string has been selected, Supercite will force the
string to lower case if the variable @code{sc-downcase-p} is string to lower case if the variable @code{sc-downcase-p} is
non-@code{nil}. non-@code{nil}.
@vindex sc-attribs-preselect-hook @vindex sc-attribs-preselect-hook
@vindex attribs-preselect-hook (sc-) @vindex attribs-preselect-hook @r{(sc-)}
@vindex sc-attribs-postselect-hook @vindex sc-attribs-postselect-hook
@vindex attribs-postselect-hook (sc-) @vindex attribs-postselect-hook @r{(sc-)}
Two hook variables provide even greater control of the attribution Two hook variables provide even greater control of the attribution
selection process. The hook @code{sc-attribs-preselect-hook} is run selection process. The hook @code{sc-attribs-preselect-hook} is run
@ -1245,7 +1245,7 @@ formats in use. If you encounter a @samp{From:@:} field that Supercite
cannot parse, please report this bug using @kbd{M-x report-emacs-bug}. cannot parse, please report this bug using @kbd{M-x report-emacs-bug}.
@vindex sc-titlecue-regexp @vindex sc-titlecue-regexp
@vindex titlecue-regexp (sc-) @vindex titlecue-regexp @r{(sc-)}
There are a number of Supercite variables that control how author names There are a number of Supercite variables that control how author names
are extracted from the @samp{From:@:} header. Some headers may contain a are extracted from the @samp{From:@:} header. Some headers may contain a
descriptive title as in: descriptive title as in:
@ -1263,7 +1263,7 @@ This variable has the default value of @code{"\\\\s +-+\\\\s +"}. Any
text after this regexp is encountered is ignored as noise. text after this regexp is encountered is ignored as noise.
@vindex sc-name-filter-alist @vindex sc-name-filter-alist
@vindex name-filter-alist (sc-) @vindex name-filter-alist @r{(sc-)}
Some @samp{From:@:} headers may contain extra titles in the name fields Some @samp{From:@:} headers may contain extra titles in the name fields
not separated by a title cue, but which are nonetheless not part of the not separated by a title cue, but which are nonetheless not part of the
author's name proper. Examples include the titles ``Dr.'', ``Mr.'', author's name proper. Examples include the titles ``Dr.'', ``Mr.'',
@ -1497,7 +1497,7 @@ is not found from the alist, then the appropriate default frame is used.
@node Post-yank Formatting Commands @node Post-yank Formatting Commands
@chapter Post-yank Formatting Commands @chapter Post-yank Formatting Commands
@vindex sc-mode-map-prefix @vindex sc-mode-map-prefix
@vindex mode-map-prefix (sc-) @vindex mode-map-prefix @r{(sc-)}
@kindex C-c C-p @kindex C-c C-p
Once the original message has been yanked into the reply buffer, and Once the original message has been yanked into the reply buffer, and
@ -1540,10 +1540,10 @@ Here is the list of Supercite citing commands:
@table @asis @table @asis
@findex sc-cite-region @findex sc-cite-region
@findex cite-region (sc-) @findex cite-region @r{(sc-)}
@kindex C-c C-p c @kindex C-c C-p c
@vindex sc-pre-cite-hook @vindex sc-pre-cite-hook
@vindex pre-cite-hook (sc-) @vindex pre-cite-hook @r{(sc-)}
@vindex sc-confirm-always-p @vindex sc-confirm-always-p
@vindex confirm-always-p @vindex confirm-always-p
@kindex C-u @kindex C-u
@ -1558,7 +1558,7 @@ attribution string for a single manual citing.
@xref{Configuring the Citation Engine}. @xref{Configuring the Citation Engine}.
@findex sc-uncite-region @findex sc-uncite-region
@findex uncite-region (sc-) @findex uncite-region @r{(sc-)}
@kindex C-c C-p u @kindex C-c C-p u
@item @code{sc-uncite-region} (@kbd{C-c C-p u}) @item @code{sc-uncite-region} (@kbd{C-c C-p u})
This command removes any citation strings from the beginning of each This command removes any citation strings from the beginning of each
@ -1569,7 +1569,7 @@ cited line in the region by interpreting the selected frame from
@xref{Configuring the Citation Engine}. @xref{Configuring the Citation Engine}.
@findex sc-recite-region @findex sc-recite-region
@findex recite-region (sc-) @findex recite-region @r{(sc-)}
@kindex C-c C-p r @kindex C-c C-p r
@item @code{sc-recite-region} (@kbd{C-c C-p r}) @item @code{sc-recite-region} (@kbd{C-c C-p r})
This command recites each line the region by interpreting the selected This command recites each line the region by interpreting the selected
@ -1579,7 +1579,7 @@ frame from @code{sc-recite-frame-alist}, or the default reciting frame
@xref{Configuring the Citation Engine}. @xref{Configuring the Citation Engine}.
@vindex sc-confirm-always-p @vindex sc-confirm-always-p
@vindex confirm-always-p (sc-) @vindex confirm-always-p @r{(sc-)}
Supercite will always ask you to confirm the attribution when reciting a Supercite will always ask you to confirm the attribution when reciting a
region, regardless of the value of @code{sc-confirm-always-p}. region, regardless of the value of @code{sc-confirm-always-p}.
@end table @end table
@ -1591,11 +1591,11 @@ These two functions insert various strings into the reply buffer.
@table @asis @table @asis
@findex sc-insert-reference @findex sc-insert-reference
@findex insert-reference (sc-) @findex insert-reference @r{(sc-)}
@kindex C-c C-p w @kindex C-c C-p w
@item @code{sc-insert-reference} (@kbd{C-c C-p w}) @item @code{sc-insert-reference} (@kbd{C-c C-p w})
@vindex sc-preferred-header-style @vindex sc-preferred-header-style
@vindex preferred-header-style (sc-) @vindex preferred-header-style @r{(sc-)}
Inserts a reference header into the reply buffer at @samp{point}. With Inserts a reference header into the reply buffer at @samp{point}. With
no arguments, the header indexed by @code{sc-preferred-header-style} is no arguments, the header indexed by @code{sc-preferred-header-style} is
inserted. An optional numeric argument is the index into inserted. An optional numeric argument is the index into
@ -1606,7 +1606,7 @@ With just the universal argument (@kbd{C-u}), electric reference mode is
entered, regardless of the value of @code{sc-electric-references-p}. entered, regardless of the value of @code{sc-electric-references-p}.
@findex sc-insert-citation @findex sc-insert-citation
@findex insert-citation (sc-) @findex insert-citation @r{(sc-)}
@kindex C-c C-p i @kindex C-c C-p i
@item @code{sc-insert-citation} (@kbd{C-c C-p i}) @item @code{sc-insert-citation} (@kbd{C-c C-p i})
Inserts the current citation string at the beginning of the line that Inserts the current citation string at the beginning of the line that
@ -1704,7 +1704,7 @@ of information from the info alist.
@table @asis @table @asis
@kindex C-c C-p f @kindex C-c C-p f
@findex sc-mail-field-query @findex sc-mail-field-query
@findex mail-field-query (sc-) @findex mail-field-query @r{(sc-)}
@kindex C-c C-p f @kindex C-c C-p f
@item @code{sc-mail-field-query} (@kbd{C-c C-p f}) @item @code{sc-mail-field-query} (@kbd{C-c C-p f})
Allows you to interactively view, modify, add, and delete info alist Allows you to interactively view, modify, add, and delete info alist
@ -1732,7 +1732,7 @@ will override any old value. It will not replace it though; if you
subsequently delete the key-value pair, the old value will reappear. subsequently delete the key-value pair, the old value will reappear.
@findex sc-mail-process-headers @findex sc-mail-process-headers
@findex mail-process-headers (sc-) @findex mail-process-headers @r{(sc-)}
@kindex C-c C-p g @kindex C-c C-p g
@item @code{sc-mail-process-headers} (@kbd{C-c C-p g}) @item @code{sc-mail-process-headers} (@kbd{C-c C-p g})
This command lets you re-initialize Supercite's info alist from any set This command lets you re-initialize Supercite's info alist from any set
@ -1749,7 +1749,7 @@ old information is lost.
@table @asis @table @asis
@findex sc-open-line @findex sc-open-line
@findex open-line (sc-) @findex open-line @r{(sc-)}
@findex open-line @findex open-line
@kindex C-c C-p o @kindex C-c C-p o
@item @code{sc-open-line} (@kbd{C-c C-p o}) @item @code{sc-open-line} (@kbd{C-c C-p o})

38
doc/misc/vhdl-mode.texi
View file

@ -147,7 +147,7 @@ your personal coding style.
@cindex Syntactic Analysis @cindex Syntactic Analysis
@vindex vhdl-offsets-alist @vindex vhdl-offsets-alist
@vindex offsets-alist (vhdl-) @vindex offsets-alist @r{(vhdl-)}
@cindex relative buffer position @cindex relative buffer position
@cindex syntactic symbol @cindex syntactic symbol
@cindex syntactic component @cindex syntactic component
@ -186,7 +186,7 @@ in this and future examples don't actually appear in the buffer.}:
@kindex C-c C-x @kindex C-c C-x
@findex vhdl-show-syntactic-information @findex vhdl-show-syntactic-information
@findex show-syntactic-information (vhdl-) @findex show-syntactic-information @r{(vhdl-)}
We can use the command @kbd{C-c C-x} We can use the command @kbd{C-c C-x}
(@code{vhdl-show-syntactic-information}) to simply report what the (@code{vhdl-show-syntactic-information}) to simply report what the
syntactic analysis is for the current line. Running this command on syntactic analysis is for the current line. Running this command on
@ -241,7 +241,7 @@ components. Also notice that the first component,
@cindex Indentation Calculation @cindex Indentation Calculation
@vindex vhdl-offsets-alist @vindex vhdl-offsets-alist
@vindex offsets-alist (vhdl-) @vindex offsets-alist @r{(vhdl-)}
Indentation for the current line is calculated using the syntactic Indentation for the current line is calculated using the syntactic
component list derived in step 1 above (see @ref{Syntactic component list derived in step 1 above (see @ref{Syntactic
Analysis}). Each component contributes to the final total indentation Analysis}). Each component contributes to the final total indentation
@ -301,7 +301,7 @@ indentation, it's helpful to understand the general indentation model
being used. being used.
@vindex vhdl-echo-syntactic-information-p @vindex vhdl-echo-syntactic-information-p
@vindex echo-syntactic-information-p (vhdl-) @vindex echo-syntactic-information-p @r{(vhdl-)}
@cindex TAB @cindex TAB
To help you configure VHDL Mode, you can set the variable To help you configure VHDL Mode, you can set the variable
@code{vhdl-echo-syntactic-information-p} to non-@code{nil} so that the @code{vhdl-echo-syntactic-information-p} to non-@code{nil} so that the
@ -428,7 +428,7 @@ line. Hitting @kbd{C-c C-x} on line 3 yields:
@end example @end example
@findex vhdl-set-offset @findex vhdl-set-offset
@findex set-offset (vhdl-) @findex set-offset @r{(vhdl-)}
@kindex C-c O @kindex C-c O
@noindent @noindent
So we know that to change the offset of the first signal assignment, we need to So we know that to change the offset of the first signal assignment, we need to
@ -447,7 +447,7 @@ basic indent with the syntactic symbol @code{statement-block-intro} in
the @code{vhdl-offsets-alist} variable. the @code{vhdl-offsets-alist} variable.
@findex vhdl-indent-defun @findex vhdl-indent-defun
@findex indent-defun (vhdl-) @findex indent-defun @r{(vhdl-)}
To check your changes quickly, just enter @kbd{M-x vhdl-indent-defun} to To check your changes quickly, just enter @kbd{M-x vhdl-indent-defun} to
reindent the entire function. The example should now look like: reindent the entire function. The example should now look like:
@example @example
@ -546,7 +546,7 @@ already built-in. These include:
@end itemize @end itemize
@findex vhdl-set-style @findex vhdl-set-style
@findex set-style (vhdl-) @findex set-style @r{(vhdl-)}
If you'd like to experiment with these built-in styles you can simply If you'd like to experiment with these built-in styles you can simply
type @kbd{M-x vhdl-set-style RET} in a VHDL Mode buffer. type @kbd{M-x vhdl-set-style RET} in a VHDL Mode buffer.
@ -583,9 +583,9 @@ files. You would add this:
@cindex Adding Styles @cindex Adding Styles
@vindex vhdl-style-alist @vindex vhdl-style-alist
@vindex style-alist (vhdl-) @vindex style-alist @r{(vhdl-)}
@findex vhdl-add-style @findex vhdl-add-style
@findex add-style (vhdl-) @findex add-style @r{(vhdl-)}
If none of the built-in styles is appropriate, you'll probably want to If none of the built-in styles is appropriate, you'll probably want to
add a new style definition. Styles are kept in the @code{vhdl-style-alist} add a new style definition. Styles are kept in the @code{vhdl-style-alist}
variable, but you probably won't want to modify this variable directly. variable, but you probably won't want to modify this variable directly.
@ -615,9 +615,9 @@ block. VHDL Mode provides two variables that make it easier for
you to customize your style on a per-file basis. you to customize your style on a per-file basis.
@vindex vhdl-file-style @vindex vhdl-file-style
@vindex file-style (vhdl-) @vindex file-style @r{(vhdl-)}
@vindex vhdl-file-offsets @vindex vhdl-file-offsets
@vindex file-offsets (vhdl-) @vindex file-offsets @r{(vhdl-)}
The variable @code{vhdl-file-style} can be set to a style name string as The variable @code{vhdl-file-style} can be set to a style name string as
described in @ref{Built-in Styles}. When the file is visited, described in @ref{Built-in Styles}. When the file is visited,
@ -625,9 +625,9 @@ VHDL Mode will automatically set the file's style to this style
using @code{vhdl-set-style}. using @code{vhdl-set-style}.
@vindex vhdl-offsets-alist @vindex vhdl-offsets-alist
@vindex offsets-alist (vhdl-) @vindex offsets-alist @r{(vhdl-)}
@findex vhdl-set-offset @findex vhdl-set-offset
@findex set-offset (vhdl-) @findex set-offset @r{(vhdl-)}
Another variable, @code{vhdl-file-offsets}, takes an association list Another variable, @code{vhdl-file-offsets}, takes an association list
similar to what is allowed in @code{vhdl-offsets-alist}. When the file is similar to what is allowed in @code{vhdl-offsets-alist}. When the file is
visited, VHDL Mode will automatically institute these offsets using visited, VHDL Mode will automatically institute these offsets using
@ -642,9 +642,9 @@ before file offset settings (i.e., @code{vhdl-file-offsets}).
@cindex Advanced Customizations @cindex Advanced Customizations
@vindex vhdl-style-alist @vindex vhdl-style-alist
@vindex style-alist (vhdl-) @vindex style-alist @r{(vhdl-)}
@vindex vhdl-basic-offset @vindex vhdl-basic-offset
@vindex basic-offset (vhdl-) @vindex basic-offset @r{(vhdl-)}
For most users, VHDL Mode will support their coding styles with For most users, VHDL Mode will support their coding styles with
very little need for customizations. Usually, one of the standard very little need for customizations. Usually, one of the standard
styles defined in @code{vhdl-style-alist} will do the trick. Sometimes, styles defined in @code{vhdl-style-alist} will do the trick. Sometimes,
@ -743,7 +743,7 @@ don't want that value added into the final total twice.
@cindex statement-cont syntactic symbol @cindex statement-cont syntactic symbol
@findex vhdl-lineup-statement-cont @findex vhdl-lineup-statement-cont
@findex lineup-statement-cont (vhdl-) @findex lineup-statement-cont @r{(vhdl-)}
Now, to associate the function @code{vhdl-lineup-statement-cont} with the Now, to associate the function @code{vhdl-lineup-statement-cont} with the
@code{statement-cont} syntactic symbol, we can add something like the @code{statement-cont} syntactic symbol, we can add something like the
following to our @code{vhdl-mode-hook}: following to our @code{vhdl-mode-hook}:
@ -765,7 +765,7 @@ vhdl-indent-defun}):
@end example @end example
@vindex vhdl-offsets-alist @vindex vhdl-offsets-alist
@vindex offsets-alist (vhdl-) @vindex offsets-alist @r{(vhdl-)}
Custom indentation functions can be as simple or as complex as you like, Custom indentation functions can be as simple or as complex as you like,
and any syntactic symbol that appears in @code{vhdl-offsets-alist} can have and any syntactic symbol that appears in @code{vhdl-offsets-alist} can have
a custom indentation function associated with it. Note however that a custom indentation function associated with it. Note however that
@ -777,7 +777,7 @@ VHDL Mode.
@cindex Other Special Indentations @cindex Other Special Indentations
@vindex vhdl-special-indent-hook @vindex vhdl-special-indent-hook
@vindex special-indent-hook (vhdl-) @vindex special-indent-hook @r{(vhdl-)}
One other variable is available for you to customize VHDL Mode: One other variable is available for you to customize VHDL Mode:
@code{vhdl-special-indent-hook}. This is a standard hook variable that @code{vhdl-special-indent-hook}. This is a standard hook variable that
is called after every line is indented by VHDL Mode. You can use is called after every line is indented by VHDL Mode. You can use
@ -956,7 +956,7 @@ The index menu does not work on my XEmacs installation (don't know why).
@kindex C-c C-b @kindex C-c C-b
@findex vhdl-submit-bug-report @findex vhdl-submit-bug-report
@findex submit-bug-report (vhdl-) @findex submit-bug-report @r{(vhdl-)}
@cindex beta testers mailing list @cindex beta testers mailing list
@cindex announcement mailing list @cindex announcement mailing list
To report bugs, use the @kbd{C-c C-b} (@code{vhdl-submit-bug-report}) To report bugs, use the @kbd{C-c C-b} (@code{vhdl-submit-bug-report})

186
doc/misc/viper.texi
View file

@ -376,8 +376,8 @@ toggles Viperization of Emacs on and off.
@cindex Insert state @cindex Insert state
@cindex Replace state @cindex Replace state
@cindex Ex commands @cindex Ex commands
@findex @code{viper-go-away} @findex viper-go-away
@findex @code{toggle-viper-mode} @findex toggle-viper-mode
Viper has four states, Emacs, Vi, Insert, and Replace. Viper has four states, Emacs, Vi, Insert, and Replace.
@ -1182,7 +1182,7 @@ variable that controls how search patterns are highlighted is
@example @example
(copy-face 'default 'viper-search-face) (copy-face 'default 'viper-search-face)
@end example @end example
@vindex @code{viper-search-face} @vindex viper-search-face
@noindent @noindent
in your Viper customization file. If you want to change how patterns are in your Viper customization file. If you want to change how patterns are
highlighted, you will have to change @code{viper-search-face} to your liking. highlighted, you will have to change @code{viper-search-face} to your liking.
@ -1240,7 +1240,7 @@ watch out for is that it is possible to be on the end-of-line character.
The keys @kbd{x} and @kbd{%} will still work correctly, i.e., as if they The keys @kbd{x} and @kbd{%} will still work correctly, i.e., as if they
were on the last character. were on the last character.
@vindex @code{viper-syntax-preference} @vindex viper-syntax-preference
@cindex syntax table @cindex syntax table
The word-movement commands @kbd{w}, @kbd{e}, etc., and the associated The word-movement commands @kbd{w}, @kbd{e}, etc., and the associated
@ -1278,7 +1278,7 @@ the following example:
(viper-set-syntax-preference nil "emacs") (viper-set-syntax-preference nil "emacs")
@end example @end example
@findex @code{viper-set-syntax-preference} @findex viper-set-syntax-preference
The above discussion of the meaning of Viper's words concerns only Viper's The above discussion of the meaning of Viper's words concerns only Viper's
movement commands. In regular expressions, words remain the same as in movement commands. In regular expressions, words remain the same as in
@ -1369,7 +1369,7 @@ character(s) appropriate for the current major mode.
Check spelling of words in the region (@code{spell-region}). Check spelling of words in the region (@code{spell-region}).
The function used for spelling is determined from the variable The function used for spelling is determined from the variable
@code{viper-spell-function}. @code{viper-spell-function}.
@vindex @code{viper-spell-function} @vindex viper-spell-function
@item * @item *
@kindex @kbd{*} @kindex @kbd{*}
Call last keyboard macro. Call last keyboard macro.
@ -1775,7 +1775,7 @@ Use @code{viper-glob-unix-files} and @code{viper-glob-mswindows-files} in
This feature is used to expand wildcards in the Ex command @kbd{:e}. This feature is used to expand wildcards in the Ex command @kbd{:e}.
Note that Viper doesn't support wildcards in the @kbd{:r} and @kbd{:w} Note that Viper doesn't support wildcards in the @kbd{:r} and @kbd{:w}
commands, because file completion is a better mechanism. commands, because file completion is a better mechanism.
@findex @code{viper-glob-function} @findex viper-glob-function
@item ex-cycle-other-window t @item ex-cycle-other-window t
If not @code{nil}, @kbd{:n} and @kbd{:b} will cycle through files in another If not @code{nil}, @kbd{:n} and @kbd{:b} will cycle through files in another
@ -1845,16 +1845,16 @@ For a complete list of colors available to you, evaluate the expression
hit the @kbd{C-j} key. hit the @kbd{C-j} key.
@item viper-replace-overlay-cursor-color "Red" @item viper-replace-overlay-cursor-color "Red"
@vindex @code{viper-replace-overlay-cursor-color} @vindex viper-replace-overlay-cursor-color
Cursor color when it is inside the replacement region. Cursor color when it is inside the replacement region.
This has effect only on color displays and only when Emacs runs as an X This has effect only on color displays and only when Emacs runs as an X
application. application.
@item viper-insert-state-cursor-color nil @item viper-insert-state-cursor-color nil
@vindex @code{viper-insert-state-cursor-color} @vindex viper-insert-state-cursor-color
If set to a valid color, this will be the cursor color when Viper is in If set to a valid color, this will be the cursor color when Viper is in
insert state. insert state.
@item viper-emacs-state-cursor-color nil @item viper-emacs-state-cursor-color nil
@vindex @code{viper-emacs-state-cursor-color} @vindex viper-emacs-state-cursor-color
If set to a valid color, this will be the cursor color when Viper is in If set to a valid color, this will be the cursor color when Viper is in
emacs state. emacs state.
@item viper-replace-region-end-delimiter "$" @item viper-replace-region-end-delimiter "$"
@ -1913,45 +1913,45 @@ can include a line like this in your Viper customization file:
@example @example
(setq viper-case-fold-search t) (setq viper-case-fold-search t)
@end example @end example
@vindex @code{viper-auto-indent} @vindex viper-auto-indent
@vindex @code{viper-electric-mode} @vindex viper-electric-mode
@vindex @code{viper-case-fold-search} @vindex viper-case-fold-search
@vindex @code{viper-re-search} @vindex viper-re-search
@vindex @code{viper-shift-width} @vindex viper-shift-width
@vindex @code{buffer-read-only} @vindex buffer-read-only
@vindex @code{viper-search-wrap-around} @vindex viper-search-wrap-around
@vindex @code{viper-search-scroll-threshold} @vindex viper-search-scroll-threshold
@vindex @code{viper-search-face} @vindex viper-search-face
@vindex @code{viper-tags-file-name} @vindex viper-tags-file-name
@vindex @code{viper-re-query-replace} @vindex viper-re-query-replace
@vindex @code{viper-want-ctl-h-help} @vindex viper-want-ctl-h-help
@vindex @code{viper-vi-style-in-minibuffer} @vindex viper-vi-style-in-minibuffer
@vindex @code{viper-no-multiple-ESC} @vindex viper-no-multiple-ESC
@vindex @code{viper-always} @vindex viper-always
@vindex @code{viper-fast-keyseq-timeout} @vindex viper-fast-keyseq-timeout
@vindex @code{viper-ex-style-motion} @vindex viper-ex-style-motion
@vindex @code{viper-ex-style-editing} @vindex viper-ex-style-editing
@vindex @code{viper-ESC-moves-cursor-back} @vindex viper-ESC-moves-cursor-back
@vindex @code{viper-custom-file-name} @vindex viper-custom-file-name
@vindex @code{viper-spell-function} @vindex viper-spell-function
@vindex @code{ex-cycle-other-window} @vindex ex-cycle-other-window
@vindex @code{ex-cycle-through-non-files} @vindex ex-cycle-through-non-files
@vindex @code{viper-want-emacs-keys-in-insert} @vindex viper-want-emacs-keys-in-insert
@vindex @code{viper-want-emacs-keys-in-vi} @vindex viper-want-emacs-keys-in-vi
@vindex @code{viper-keep-point-on-repeat} @vindex viper-keep-point-on-repeat
@vindex @code{viper-keep-point-on-undo} @vindex viper-keep-point-on-undo
@vindex @code{viper-delete-backwards-in-replace} @vindex viper-delete-backwards-in-replace
@vindex @code{viper-replace-overlay-face} @vindex viper-replace-overlay-face
@vindex @code{viper-replace-region-end-symbol} @vindex viper-replace-region-end-symbol
@vindex @code{viper-replace-region-start-symbol} @vindex viper-replace-region-start-symbol
@vindex @code{viper-allow-multiline-replace-regions} @vindex viper-allow-multiline-replace-regions
@vindex @code{viper-toggle-key} @vindex viper-toggle-key
@vindex @code{viper-buffer-search-char} @vindex viper-buffer-search-char
@vindex @code{viper-surrounding-word-function} @vindex viper-surrounding-word-function
@vindex @code{viper-vi-state-hook} @vindex viper-vi-state-hook
@vindex @code{viper-insert-state-hook} @vindex viper-insert-state-hook
@vindex @code{viper-replace-state-hook} @vindex viper-replace-state-hook
@vindex @code{viper-emacs-state-hook} @vindex viper-emacs-state-hook
@node Key Bindings @node Key Bindings
@section Key Bindings @section Key Bindings
@ -2059,7 +2059,7 @@ Viper users can also change bindings on a per major mode basis. As with
global bindings, this can be done separately for each of the three main Viper global bindings, this can be done separately for each of the three main Viper
states. To this end, Viper provides the function states. To this end, Viper provides the function
@code{viper-modify-major-mode}. @code{viper-modify-major-mode}.
@findex @code{viper-modify-major-mode} @findex viper-modify-major-mode
To modify keys in Emacs state for @code{my-favorite-major-mode}, the user To modify keys in Emacs state for @code{my-favorite-major-mode}, the user
needs to create a sparse keymap, say, @code{my-fancy-map}, bind whatever needs to create a sparse keymap, say, @code{my-fancy-map}, bind whatever
@ -2099,7 +2099,7 @@ Dired functions, the trick can be accomplished via the following code:
Yet another way to customize key bindings in a major mode is to edit the Yet another way to customize key bindings in a major mode is to edit the
list @code{viper-major-mode-modifier-list} using the customization widget. list @code{viper-major-mode-modifier-list} using the customization widget.
@vindex @code{viper-major-mode-modifier-list} @vindex viper-major-mode-modifier-list
(This variable is in the Viper-misc customization group.) (This variable is in the Viper-misc customization group.)
The elements of this list are triples of the form: (major-mode viper-state The elements of this list are triples of the form: (major-mode viper-state
keymap), where the keymap contains bindings that are supposed to be active keymap), where the keymap contains bindings that are supposed to be active
@ -2184,13 +2184,13 @@ So much about Viper-specific bindings.
Manual}, and the Emacs quick reference card for the general info on key Manual}, and the Emacs quick reference card for the general info on key
bindings in Emacs. bindings in Emacs.
@vindex @code{input-decode-map} @vindex input-decode-map
@vindex @code{function-key-map} @vindex function-key-map
@vindex @code{viper-vi-global-user-map} @vindex viper-vi-global-user-map
@vindex @code{viper-insert-global-user-map} @vindex viper-insert-global-user-map
@vindex @code{viper-emacs-global-user-map} @vindex viper-emacs-global-user-map
@findex @code{viper-add-local-keys} @findex viper-add-local-keys
@findex @code{viper-zap-local-keys} @findex viper-zap-local-keys
@node Packages that Change Keymaps @node Packages that Change Keymaps
@section Packages that Change Keymaps @section Packages that Change Keymaps
@ -2261,9 +2261,9 @@ on the @code{viper-emacs-state-mode-list} list and delete them from
@code{viper-vi-state-mode-list}. @code{viper-vi-state-mode-list}.
Likewise, you can force Viper's Insert state on a major mode by putting it Likewise, you can force Viper's Insert state on a major mode by putting it
in @code{viper-insert-state-mode-list}. in @code{viper-insert-state-mode-list}.
@vindex @code{viper-emacs-state-mode-list} @vindex viper-emacs-state-mode-list
@vindex @code{viper-insert-state-mode-list} @vindex viper-insert-state-mode-list
@vindex @code{viper-vi-state-mode-list} @vindex viper-vi-state-mode-list
It is also possible to impose Vi on some major modes, even though they may It is also possible to impose Vi on some major modes, even though they may
bind common keys to specialized commands. This might make sense for modes bind common keys to specialized commands. This might make sense for modes
@ -2312,14 +2312,14 @@ compatible with Viper is to have the file @file{my-mode.el} include the followin
(viper-harness-minor-mode lib))) (viper-harness-minor-mode lib)))
@end lisp @end lisp
@vindex @code{viper-want-emacs-keys-in-vi} @vindex viper-want-emacs-keys-in-vi
@vindex @code{viper-want-emacs-keys-in-insert} @vindex viper-want-emacs-keys-in-insert
@vindex @code{viper-always} @vindex viper-always
@findex @code{viper-set-hooks} @findex viper-set-hooks
@findex @code{viper-mode} @findex viper-mode
@findex @code{viper-harness-minor-mode} @findex viper-harness-minor-mode
@findex @code{remove-hook} @findex remove-hook
@findex @code{add-hook} @findex add-hook
@node Viper Specials @node Viper Specials
@section Viper Specials @section Viper Specials
@ -2339,8 +2339,8 @@ sets @code{viper-buffer-search-char} to @kbd{g}. Alternatively, the user can
set @code{viper-buffer-search-char} in his/her Viper customization file to a key set @code{viper-buffer-search-char} in his/her Viper customization file to a key
sequence to be used for buffer search. There is no need to call sequence to be used for buffer search. There is no need to call
@code{viper-buffer-search-enable} in that case. @code{viper-buffer-search-enable} in that case.
@findex @code{viper-buffer-search-enable} @findex viper-buffer-search-enable
@vindex @code{viper-buffer-search-char} @vindex viper-buffer-search-char
@item viper-toggle-search-style @item viper-toggle-search-style
This function, bound to @kbd{C-c /}, lets one toggle case-sensitive and This function, bound to @kbd{C-c /}, lets one toggle case-sensitive and
case-insensitive search, and also switch between plain vanilla search and case-insensitive search, and also switch between plain vanilla search and
@ -2365,7 +2365,7 @@ feature, put this in the file:
@example @example
(viper-set-searchstyle-toggling-macros 'undefine) (viper-set-searchstyle-toggling-macros 'undefine)
@end example @end example
@findex @code{viper-set-searchstyle-toggling-macros} @findex viper-set-searchstyle-toggling-macros
If you don't like this feature as a default, but would still like to have If you don't like this feature as a default, but would still like to have
it in some major modes, you can do so by first unsetting it globally, as it in some major modes, you can do so by first unsetting it globally, as
@ -2389,8 +2389,8 @@ case-insensitivity and regexp-search.
If you don't like these features---which I don't really understand---you If you don't like these features---which I don't really understand---you
can unbind @kbd{/} and @kbd{:} in @code{viper-dired-modifier-map} (for can unbind @kbd{/} and @kbd{:} in @code{viper-dired-modifier-map} (for
Dired) or in @code{viper-slash-and-colon-map}, for other modes. Dired) or in @code{viper-slash-and-colon-map}, for other modes.
@vindex @code{viper-slash-and-colon-map} @vindex viper-slash-and-colon-map
@vindex @code{viper-dired-modifier-map} @vindex viper-dired-modifier-map
To unbind the macros @kbd{//} and @kbd{///} for a major mode where you To unbind the macros @kbd{//} and @kbd{///} for a major mode where you
feel they feel they
@ -2400,7 +2400,7 @@ prefix argument, or by placing
@example @example
(viper-set-emacs-state-searchstyle-macros 'undefine) (viper-set-emacs-state-searchstyle-macros 'undefine)
@end example @end example
@findex @code{viper-set-emacs-state-searchstyle-macros} @findex viper-set-emacs-state-searchstyle-macros
in the hook to the major mode (e.g., @code{dired-mode-hook}). in the hook to the major mode (e.g., @code{dired-mode-hook}).
@xref{Vi Macros}, for more information on Vi macros. @xref{Vi Macros}, for more information on Vi macros.
@ -2414,10 +2414,10 @@ Regular Expressions for @kbd{[[} and @kbd{]]}. Note that Emacs defines
Regexps for paragraphs and sentences. @xref{Paragraphs,,Paragraphs and Regexps for paragraphs and sentences. @xref{Paragraphs,,Paragraphs and
Sentences,emacs,The GNU Emacs Manual}, for details. Sentences,emacs,The GNU Emacs Manual}, for details.
@item M-x viper-set-expert-level @item M-x viper-set-expert-level
@findex @code{viper-set-expert-level} @findex viper-set-expert-level
Change your user level interactively. Change your user level interactively.
@item viper-smart-suffix-list '("" "tex" "c" "cc" "el" "p") @item viper-smart-suffix-list '("" "tex" "c" "cc" "el" "p")
@vindex @code{viper-smart-suffix-list} @vindex viper-smart-suffix-list
Viper supports Emacs-style file completion when it prompts the user for a Viper supports Emacs-style file completion when it prompts the user for a
file name. However, in many cases, the same directory may contain files file name. However, in many cases, the same directory may contain files
with identical prefix but different suffixes, e.g., prog.c, prog.o, with identical prefix but different suffixes, e.g., prog.c, prog.o,
@ -2437,7 +2437,7 @@ the intended file name, hitting return will accept it.
To turn this feature off, set the above variable to @code{nil}. To turn this feature off, set the above variable to @code{nil}.
@item viper-insertion-ring-size 14 @item viper-insertion-ring-size 14
@vindex @code{viper-insertion-ring-size} @vindex viper-insertion-ring-size
@cindex Insertion ring @cindex Insertion ring
Viper remembers what was previously inserted in Insert and Replace states. Viper remembers what was previously inserted in Insert and Replace states.
Several such recent insertions are kept in a special ring of strings of size Several such recent insertions are kept in a special ring of strings of size
@ -2470,7 +2470,7 @@ this will interfere with the minibuffer histories and, possibly, other
major modes. major modes.
@item viper-command-ring-size 14 @item viper-command-ring-size 14
@vindex @code{viper-command-ring-size} @vindex viper-command-ring-size
@cindex Destructive command ring @cindex Destructive command ring
@cindex Destructive command history @cindex Destructive command history
Viper keeps track of the recent history of destructive Viper keeps track of the recent history of destructive
@ -2527,11 +2527,11 @@ indication of the current Viper state in the minibuffer. (This is important
if the user accidentally switches to another Viper state by typing @key{ESC} or if the user accidentally switches to another Viper state by typing @key{ESC} or
@kbd{C-z}). @kbd{C-z}).
@item M-x viper-go-away @item M-x viper-go-away
@findex @code{viper-go-away} @findex viper-go-away
Make Viper disappear from the face of your running Emacs instance. If your Make Viper disappear from the face of your running Emacs instance. If your
fingers start aching again, @kbd{M-x viper-mode} might save your day. fingers start aching again, @kbd{M-x viper-mode} might save your day.
@item M-x toggle-viper-mode @item M-x toggle-viper-mode
@findex @code{toggle-viper-mode} @findex toggle-viper-mode
Toggle Viperization of Emacs on and off. Toggle Viperization of Emacs on and off.
@end table @end table
@ -2581,7 +2581,7 @@ is available). Clicking the mouse when Emacs is invoked in an Xterm window
@cindex mouse @cindex mouse
@cindex mouse-search @cindex mouse-search
@item viper-mouse-search-key (meta shift 1) @item viper-mouse-search-key (meta shift 1)
@vindex @code{viper-mouse-insert-key} @vindex viper-mouse-insert-key
This variable controls the @emph{mouse-search} feature of Viper. The This variable controls the @emph{mouse-search} feature of Viper. The
default value default value
states that holding Meta and Shift keys while clicking mouse button 1 states that holding Meta and Shift keys while clicking mouse button 1
@ -2636,7 +2636,7 @@ occurred with all leading and trailing spaces and tabs removed.
@cindex mouse-insert @cindex mouse-insert
@item viper-mouse-insert-key (meta shift 2) @item viper-mouse-insert-key (meta shift 2)
@vindex @code{viper-mouse-insert-key} @vindex viper-mouse-insert-key
This variable controls the @emph{mouse-insert} feature of Viper. This variable controls the @emph{mouse-insert} feature of Viper.
The above default value states that The above default value states that
holding Meta and Shift keys while clicking mouse button 2 holding Meta and Shift keys while clicking mouse button 2
@ -2673,9 +2673,9 @@ purpose of mouse search and mouse insert. By default, this is set to
@kindex @kbd{S-mouse-2} @kindex @kbd{S-mouse-2}
@kindex @kbd{meta shift button1up} @kindex @kbd{meta shift button1up}
@kindex @kbd{meta shift button2up} @kindex @kbd{meta shift button2up}
@vindex @code{viper-multiclick-timeout} @vindex viper-multiclick-timeout
@findex @code{viper-mouse-click-insert-word} @findex viper-mouse-click-insert-word
@findex @code{viper-mouse-click-search-word} @findex viper-mouse-click-search-word
Note: The above functions search and insert in the selected window of Note: The above functions search and insert in the selected window of
the latest active frame. This means that you can click in another window or the latest active frame. This means that you can click in another window or
@ -2852,7 +2852,7 @@ The latter is more powerful, since it can delete macros even in
needed only when the user needs to get rid of the macros that are already needed only when the user needs to get rid of the macros that are already
predefined in Viper. predefined in Viper.
The syntax is: The syntax is:
@findex @code{viper-unrecord-kbd-macro} @findex viper-unrecord-kbd-macro
@example @example
(viper-unrecord-kbd-macro macro state) (viper-unrecord-kbd-macro macro state)
@end example @end example
@ -2992,7 +2992,7 @@ keys have to be redefined for TTY's (and possibly for every type of TTY you
may be using). To do this, start Emacs on an appropriate TTY device and may be using). To do this, start Emacs on an appropriate TTY device and
define the macro using @kbd{:map}, as usual. define the macro using @kbd{:map}, as usual.
@findex @code{viper-describe-kbd-macros} @findex viper-describe-kbd-macros
Finally, Viper provides a function that conveniently displays all macros Finally, Viper provides a function that conveniently displays all macros
currently defined. To see all macros along with their definitions, type currently defined. To see all macros along with their definitions, type
@kbd{M-x viper-describe-kbd-macros}. @kbd{M-x viper-describe-kbd-macros}.
@ -3199,8 +3199,8 @@ modes, you should execute, for example,
in the appropriate major mode hooks. in the appropriate major mode hooks.
@vindex @code{viper-syntax-preference} @vindex viper-syntax-preference
@findex @code{viper-set-syntax-preference} @findex viper-set-syntax-preference
@cindex syntax table @cindex syntax table
@ -3378,7 +3378,7 @@ don't want this macro, put
@example @example
(viper-set-parsing-style-toggling-macro 'undefine) (viper-set-parsing-style-toggling-macro 'undefine)
@end example @end example
@findex @code{viper-set-parsing-style-toggling-macro} @findex viper-set-parsing-style-toggling-macro
in your Viper customization file. in your Viper customization file.
@ -3437,7 +3437,7 @@ in your Viper customization file.
@kindex @kbd{j} @kindex @kbd{j}
@kindex @kbd{k} @kindex @kbd{k}
@kindex @kbd{l} @kindex @kbd{l}
@vindex @code{viper-parse-sexp-ignore-comments} @vindex viper-parse-sexp-ignore-comments
@node Marking @node Marking
@subsection Marking @subsection Marking
@ -4069,7 +4069,7 @@ The variable @code{viper-read-buffer-function} controls which function is
actually used to read the buffer name. The default is @code{read-buffer}, actually used to read the buffer name. The default is @code{read-buffer},
but better alternatives are also available in Emacs (e.g., but better alternatives are also available in Emacs (e.g.,
@code{ido-read-buffer}). @code{ido-read-buffer}).
@vindex @code{viper-read-buffer-function} @vindex viper-read-buffer-function
@item :B @item :B
Like @kbd{:b}, but the meaning of @code{ex-cycle-other-window} is reversed. Like @kbd{:b}, but the meaning of @code{ex-cycle-other-window} is reversed.
@item :<address>r <name> @item :<address>r <name>