From: Martin Rudalics Date: Thu, 21 May 2009 15:31:31 +0000 (+0000) Subject: * abbrevs.texi (Abbrev Mode): abbrev-mode is an option. X-Git-Url: https://git.hcoop.net/bpt/emacs.git/commitdiff_plain/01f17ae208c1bd9e70fa7fc76f5463aa46602815 * abbrevs.texi (Abbrev Mode): abbrev-mode is an option. * backups.texi (Making Backups): backup-directory-alist and make-backup-file-name-function are options. (Auto-Saving): auto-save-list-file-prefix is an option. * buffers.texi (Killing Buffers): buffer-offer-save is an option. * display.texi (Refresh Screen): no-redraw-on-reenter is an option. (Echo Area Customization): echo-keystrokes is an option. (Selective Display): selective-display-ellipses is an option. (Temporary Displays): temp-buffer-show-function is an option. (Face Attributes): underline-minimum-offset and x-bitmap-file-path are options. (Font Selection): face-font-family-alternatives, face-font-selection-order, face-font-registry-alternatives, and scalable-fonts-allowed are options. (Fringe Indicators): indicate-buffer-boundaries is an option. (Fringe Cursors): overflow-newline-into-fringe is an option. (Scroll Bars): scroll-bar-mode is an option. * eval.texi (Eval): max-lisp-eval-depth is an option. * files.texi (Visiting Functions): find-file-hook is an option. (Directory Names): directory-abbrev-alist is an option. (Unique File Names): temporary-file-directory and small-temporary-file-directory are options. * frames.texi (Initial Parameters): initial-frame-alist, minibuffer-frame-alist and default-frame-alist are options. (Cursor Parameters): blink-cursor-alist and cursor-in-non-selected-windows ar options. (Window System Selections): selection-coding-system is an option. (Display Feature Testing): display-mm-dimensions-alist is an option. * help.texi (Help Functions): help-char and help-event-list are options. * keymaps.texi (Functions for Key Lookup): meta-prefix-char is an option. * minibuf.texi (Minibuffer History): history-length and history-delete-duplicates are options. (High-Level Completion): read-buffer-function and read-buffer-completion-ignore-case are options. (Reading File Names): read-file-name-completion-ignore-case is an option. * modes.texi (Mode Line Top): mode-line-format is an option. (Mode Line Variables): mode-line-position and mode-line-modes are options. * nonascii.texi (Text Representations): enable-multibyte-characters is an option. (Default Coding Systems): auto-coding-regexp-alist, file-coding-system-alist, auto-coding-alist and auto-coding-functions are options. (Specifying Coding Systems): inhibit-eol-conversion is an option. * os.texi (Init File): site-run-file is an option. (System Environment): mail-host-address is an option. (User Identification): user-mail-address is an option. (Terminal Output): baud-rate is an option. * positions.texi (Word Motion): words-include-escapes is an option. * searching.texi (Standard Regexps): page-delimiter, paragraph-separate, paragraph-separate and sentence-end are options. * text.texi (Margins): left-margin and fill-nobreak-predicate are options. * variables.texi (Local Variables): max-specpdl-size is an option. * windows.texi (Choosing Window): split-window-preferred-function, special-display-function and display-buffer-function are options. --- diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index eb82a7e12b..213bd53cb7 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -1,3 +1,91 @@ +2009-05-21 Martin Rudalics + + * abbrevs.texi (Abbrev Mode): abbrev-mode is an option. + + * backups.texi (Making Backups): backup-directory-alist and + make-backup-file-name-function are options. + (Auto-Saving): auto-save-list-file-prefix is an option. + + * buffers.texi (Killing Buffers): buffer-offer-save is an + option. + + * display.texi (Refresh Screen): no-redraw-on-reenter is an + option. + (Echo Area Customization): echo-keystrokes is an option. + (Selective Display): selective-display-ellipses is an option. + (Temporary Displays): temp-buffer-show-function is an option. + (Face Attributes): underline-minimum-offset and x-bitmap-file-path + are options. + (Font Selection): face-font-family-alternatives, + face-font-selection-order, face-font-registry-alternatives, and + scalable-fonts-allowed are options. + (Fringe Indicators): indicate-buffer-boundaries is an option. + (Fringe Cursors): overflow-newline-into-fringe is an option. + (Scroll Bars): scroll-bar-mode is an option. + + * eval.texi (Eval): max-lisp-eval-depth is an option. + + * files.texi (Visiting Functions): find-file-hook is an option. + (Directory Names): directory-abbrev-alist is an option. + (Unique File Names): temporary-file-directory and + small-temporary-file-directory are options. + + * frames.texi (Initial Parameters): initial-frame-alist, + minibuffer-frame-alist and default-frame-alist are options. + (Cursor Parameters): blink-cursor-alist and + cursor-in-non-selected-windows ar options. + (Window System Selections): selection-coding-system is an + option. + (Display Feature Testing): display-mm-dimensions-alist is an + option. + + * help.texi (Help Functions): help-char and help-event-list are + options. + + * keymaps.texi (Functions for Key Lookup): meta-prefix-char is + an option. + + * minibuf.texi (Minibuffer History): history-length and + history-delete-duplicates are options. + (High-Level Completion): read-buffer-function and + read-buffer-completion-ignore-case are options. + (Reading File Names): read-file-name-completion-ignore-case is + an option. + + * modes.texi (Mode Line Top): mode-line-format is an option. + (Mode Line Variables): mode-line-position and mode-line-modes + are options. + + * nonascii.texi (Text Representations): + enable-multibyte-characters is an option. + (Default Coding Systems): auto-coding-regexp-alist, + file-coding-system-alist, auto-coding-alist and + auto-coding-functions are options. + (Specifying Coding Systems): inhibit-eol-conversion is an + option. + + * os.texi (Init File): site-run-file is an option. + (System Environment): mail-host-address is an option. + (User Identification): user-mail-address is an option. + (Terminal Output): baud-rate is an option. + + * positions.texi (Word Motion): words-include-escapes is an + option. + + * searching.texi (Standard Regexps): page-delimiter, + paragraph-separate, paragraph-separate and sentence-end are + options. + + * text.texi (Margins): left-margin and fill-nobreak-predicate + are options. + + * variables.texi (Local Variables): max-specpdl-size is an + option. + + * windows.texi (Choosing Window): + split-window-preferred-function, special-display-function and + display-buffer-function are options. + 2009-05-20 Chong Yidong Fix errors spotted by Martin Rudalics. diff --git a/doc/lispref/abbrevs.texi b/doc/lispref/abbrevs.texi index ad885aa964..9e14c3d4e9 100644 --- a/doc/lispref/abbrevs.texi +++ b/doc/lispref/abbrevs.texi @@ -64,13 +64,13 @@ Mode, emacs, The GNU Emacs Manual}. Abbrev mode is a minor mode controlled by the variable @code{abbrev-mode}. -@defvar abbrev-mode +@defopt abbrev-mode If this variable is non-@code{nil}, abbrevs are automatically expanded in the buffer. If the value is @code{nil}, abbrevs may be defined, but they are not expanded automatically. This variable automatically becomes buffer-local when set in any fashion. -@end defvar +@end defopt @defvar default-abbrev-mode This is the value of @code{abbrev-mode} for buffers that do not diff --git a/doc/lispref/backups.texi b/doc/lispref/backups.texi index 372aedc8a8..6de8594607 100644 --- a/doc/lispref/backups.texi +++ b/doc/lispref/backups.texi @@ -122,7 +122,7 @@ its value. Major modes should not set this variable---they should set @code{make-backup-files} instead. @end defvar -@defvar backup-directory-alist +@defopt backup-directory-alist This variable's value is an alist of filename patterns and backup directory names. Each element looks like @smallexample @@ -147,9 +147,9 @@ backup is made in the original file's directory. On MS-DOS filesystems without long names this variable is always ignored. -@end defvar +@end defopt -@defvar make-backup-file-name-function +@defopt make-backup-file-name-function This variable's value is a function to use for making backups instead of the default @code{make-backup-file-name}. A value of @code{nil} gives the default @code{make-backup-file-name} behavior. @@ -158,7 +158,7 @@ gives the default @code{make-backup-file-name} behavior. This could be buffer-local to do something special for specific files. If you define it, you may need to change @code{backup-file-name-p} and @code{file-name-sans-versions} too. -@end defvar +@end defopt @node Rename or Copy @@ -652,13 +652,13 @@ with @samp{.saves-}. It also contains the Emacs process @acronym{ID} and the host name. @end defvar -@defvar auto-save-list-file-prefix +@defopt auto-save-list-file-prefix After Emacs reads your init file, it initializes @code{auto-save-list-file-name} (if you have not already set it non-@code{nil}) based on this prefix, adding the host name and process ID. If you set this to @code{nil} in your init file, then Emacs does not initialize @code{auto-save-list-file-name}. -@end defvar +@end defopt @node Reverting @section Reverting diff --git a/doc/lispref/buffers.texi b/doc/lispref/buffers.texi index 2aa5c43984..5d03865e8e 100644 --- a/doc/lispref/buffers.texi +++ b/doc/lispref/buffers.texi @@ -1065,7 +1065,7 @@ The buffer to be killed is current when the hook functions run. is not cleared by changing major modes. @end defvar -@defvar buffer-offer-save +@defopt buffer-offer-save This variable, if non-@code{nil} in a particular buffer, tells @code{save-buffers-kill-emacs} and @code{save-some-buffers} (if the second optional argument to that function is @code{t}) to offer to @@ -1073,7 +1073,7 @@ save that buffer, just as they offer to save file-visiting buffers. @xref{Definition of save-some-buffers}. The variable @code{buffer-offer-save} automatically becomes buffer-local when set for any reason. @xref{Buffer-Local Variables}. -@end defvar +@end defopt @defvar buffer-save-without-query This variable, if non-@code{nil} in a particular buffer, tells diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 26c089ddea..1756314043 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi @@ -66,13 +66,13 @@ contents for display-oriented programs such as Emacs and for ordinary sequential display. If you are using such a terminal, you might want to inhibit the redisplay on resumption. -@defvar no-redraw-on-reenter +@defopt no-redraw-on-reenter @cindex suspend (cf. @code{no-redraw-on-reenter}) @cindex resume (cf. @code{no-redraw-on-reenter}) This variable controls whether Emacs redraws the entire screen after it has been suspended and resumed. Non-@code{nil} means there is no need to redraw, @code{nil} means redrawing is needed. The default is @code{nil}. -@end defvar +@end defopt @node Forcing Redisplay @section Forcing Redisplay @@ -543,7 +543,7 @@ This normal hook is run whenever the echo area is cleared---either by @code{(message nil)} or for any other reason. @end defvar -@defvar echo-keystrokes +@defopt echo-keystrokes This variable determines how much time should elapse before command characters echo. Its value must be an integer or floating point number, which specifies the @@ -554,7 +554,7 @@ begins in a key sequence, all subsequent characters in the same key sequence are echoed immediately.) If the value is zero, then command input is not echoed. -@end defvar +@end defopt @defvar message-truncate-lines Normally, displaying a long message resizes the echo area to display @@ -994,7 +994,7 @@ change. @end example @end defvar -@defvar selective-display-ellipses +@defopt selective-display-ellipses If this buffer-local variable is non-@code{nil}, then Emacs displays @samp{@dots{}} at the end of a line that is followed by hidden text. This example is a continuation of the previous one. @@ -1015,7 +1015,7 @@ This example is a continuation of the previous one. You can use a display table to substitute other text for the ellipsis (@samp{@dots{}}). @xref{Display Tables}. -@end defvar +@end defopt @node Temporary Displays @section Temporary Displays @@ -1078,7 +1078,7 @@ The value of the last form in @var{forms} is returned. @end example @end defspec -@defvar temp-buffer-show-function +@defopt temp-buffer-show-function If this variable is non-@code{nil}, @code{with-output-to-temp-buffer} calls it as a function to do the job of displaying a help buffer. The function gets one argument, which is the buffer it should display. @@ -1087,7 +1087,7 @@ It is a good idea for this function to run @code{temp-buffer-show-hook} just as @code{with-output-to-temp-buffer} normally would, inside of @code{save-selected-window} and with the chosen window and buffer selected. -@end defvar +@end defopt @defvar temp-buffer-setup-hook This normal hook is run by @code{with-output-to-temp-buffer} before @@ -2162,15 +2162,15 @@ optional argument @var{frame} specifies the frame on which the text is to be displayed; if it is @code{nil}, the selected frame is used. @end defun -@defvar underline-minimum-offset +@defopt underline-minimum-offset This variable specifies the minimum distance between the baseline and the underline, in pixels, when displaying underlined text. -@end defvar +@end defopt -@defvar x-bitmap-file-path +@defopt x-bitmap-file-path This variable specifies a list of directories for searching for bitmap files, for the @code{:stipple} attribute. -@end defvar +@end defopt @defun bitmap-spec-p object This returns @code{t} if @var{object} is a valid bitmap specification, @@ -2674,7 +2674,7 @@ of characters. If no available font exactly fits the requirements, Emacs looks for the @dfn{closest matching font}. The variables in this section control how Emacs makes this selection. -@defvar face-font-family-alternatives +@defopt face-font-family-alternatives If a given family is specified but does not exist, this variable specifies alternative font families to try. Each element should have this form: @@ -2686,9 +2686,9 @@ this form: If @var{family} is specified but not available, Emacs will try the other families given in @var{alternate-families}, one by one, until it finds a family that does exist. -@end defvar +@end defopt -@defvar face-font-selection-order +@defopt face-font-selection-order If there is no font that exactly matches all desired face attributes (@code{:width}, @code{:height}, @code{:weight}, and @code{:slant}), this variable specifies the order in which these attributes should be @@ -2714,9 +2714,9 @@ default font has no italic equivalent. With the default ordering, the default one. But if you put @code{:slant} before @code{:height}, the @code{italic} face will use an italic font, even if its height is not quite right. -@end defvar +@end defopt -@defvar face-font-registry-alternatives +@defopt face-font-registry-alternatives This variable lets you specify alternative font registries to try, if a given registry is specified and doesn't exist. Each element should have this form: @@ -2728,12 +2728,12 @@ this form: If @var{registry} is specified but not available, Emacs will try the other registries given in @var{alternate-registries}, one by one, until it finds a registry that does exist. -@end defvar +@end defopt Emacs can make use of scalable fonts, but by default it does not use them. -@defvar scalable-fonts-allowed +@defopt scalable-fonts-allowed This variable controls which scalable fonts to use. A value of @code{nil}, the default, means do not use scalable fonts. @code{t} means to use any scalable font that seems appropriate for the text. @@ -2748,7 +2748,7 @@ expression in the list. For example, @noindent allows the use of scalable fonts with registry @code{muleindian-2}. -@end defvar +@end defopt @defvar face-font-rescale-alist This variable specifies scaling for certain faces. Its value should @@ -3214,7 +3214,7 @@ displays. @xref{Fringes}. This variable is automatically buffer-local in every buffer. @end defopt -@defvar indicate-buffer-boundaries +@defopt indicate-buffer-boundaries This buffer-local variable controls how the buffer boundaries and window scrolling are indicated in the window fringes. @@ -3250,7 +3250,7 @@ For example, @code{((top . left) (t . right))} places the top angle bitmap in left fringe, and the bottom angle bitmap as well as both arrow bitmaps in right fringe. To show the angle bitmaps in the left fringe, and no arrow bitmaps, use @code{((top . left) (bottom . left))}. -@end defvar +@end defopt @defvar default-indicate-buffer-boundaries The value of this variable is the default value for @@ -3345,12 +3345,12 @@ The @code{hollow-small} type is used instead of @code{hollow} when the normal @code{hollow-rectangle} bitmap is too tall to fit on a specific display line. -@defvar overflow-newline-into-fringe +@defopt overflow-newline-into-fringe If this is non-@code{nil}, lines exactly as wide as the window (not counting the final newline character) are not continued. Instead, when point is at the end of the line, the cursor appears in the right fringe. -@end defvar +@end defopt @defvar fringe-cursor-alist This variable specifies the mapping from logical cursor type to the @@ -3587,12 +3587,12 @@ in a buffer that is already visible in a window, you can make the window take note of the new values by calling @code{set-window-buffer} specifying the same buffer that is already displayed. -@defvar scroll-bar-mode +@defopt scroll-bar-mode This variable, always local in all buffers, controls whether and where to put scroll bars in windows displaying the buffer. The possible values are @code{nil} for no scroll bar, @code{left} to put a scroll bar on the left, and @code{right} to put a scroll bar on the right. -@end defvar +@end defopt @defun window-current-scroll-bars &optional window This function reports the scroll bar type for window @var{window}. diff --git a/doc/lispref/eval.texi b/doc/lispref/eval.texi index 81b5c27d94..7e470055b7 100644 --- a/doc/lispref/eval.texi +++ b/doc/lispref/eval.texi @@ -672,7 +672,7 @@ output of the output functions is printed in the echo area. @code{eval-current-buffer} is an alias for this command. @end deffn -@defvar max-lisp-eval-depth +@defopt max-lisp-eval-depth @anchor{Definition of max-lisp-eval-depth} This variable defines the maximum depth allowed in calls to @code{eval}, @code{apply}, and @code{funcall} before an error is signaled (with error @@ -697,7 +697,7 @@ execute. @code{max-specpdl-size} provides another limit on nesting. @xref{Definition of max-specpdl-size,, Local Variables}. -@end defvar +@end defopt @defvar values The value of this variable is a list of the values returned by all the diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index cd1ee68f56..4cf715f6fc 100644 --- a/doc/lispref/files.texi +++ b/doc/lispref/files.texi @@ -203,14 +203,14 @@ the @code{find-file} commands ignore their @var{wildcards} argument and never treat wildcard characters specially. @end defopt -@defvar find-file-hook +@defopt find-file-hook The value of this variable is a list of functions to be called after a file is visited. The file's local-variables specification (if any) will have been processed before the hooks are run. The buffer visiting the file is current when the hook functions are run. This variable is a normal hook. @xref{Hooks}. -@end defvar +@end defopt @defvar find-file-not-found-functions The value of this variable is a list of functions to be called when @@ -1914,7 +1914,7 @@ annoying to see the directory's ``real'' name. If you define the link name as an abbreviation for the ``real'' name, Emacs shows users the abbreviation instead. -@defvar directory-abbrev-alist +@defopt directory-abbrev-alist The variable @code{directory-abbrev-alist} contains an alist of abbreviations to use for file directories. Each element has the form @code{(@var{from} . @var{to})}, and says to replace @var{from} with @@ -1936,7 +1936,7 @@ and so on. ("^/home/gp" . "/gp") ("^/home/gd" . "/gd")) @end example -@end defvar +@end defopt To convert a directory name to its abbreviation, use this function: @@ -2186,7 +2186,7 @@ should be an absolute file name. On MS-DOS, this function can truncate the @var{string} prefix to fit into the 8+3 file-name limits. @end defun -@defvar temporary-file-directory +@defopt temporary-file-directory @cindex @code{TMPDIR} environment variable @cindex @code{TMP} environment variable @cindex @code{TEMP} environment variable @@ -2206,9 +2206,9 @@ file, you should still use this variable to decide which directory to put the file in. However, if you expect the file to be small, you should use @code{small-temporary-file-directory} first if that is non-@code{nil}. -@end defvar +@end defopt -@defvar small-temporary-file-directory +@defopt small-temporary-file-directory This variable specifies the directory name for creating certain temporary files, which are likely to be small. @@ -2221,7 +2221,7 @@ should compute the directory like this: (or small-temporary-file-directory temporary-file-directory))) @end example -@end defvar +@end defopt @node File Name Completion @subsection File Name Completion diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index d1370ad257..548e6e8e50 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi @@ -398,7 +398,7 @@ parameter values to frames that will be created henceforth. You can specify the parameters for the initial startup frame by setting @code{initial-frame-alist} in your init file (@pxref{Init File}). -@defvar initial-frame-alist +@defopt initial-frame-alist This variable's value is an alist of parameter values used when creating the initial window frame. You can set this variable to specify the appearance of the initial frame without altering subsequent frames. @@ -426,27 +426,27 @@ this. Specify parameters in @code{default-frame-alist} to override the X resources for subsequent frames; then, to prevent these from affecting the initial frame, specify the same parameters in @code{initial-frame-alist} with values that match the X resources. -@end defvar +@end defopt If these parameters specify a separate minibuffer-only frame with @code{(minibuffer . nil)}, and you have not created one, Emacs creates one for you. -@defvar minibuffer-frame-alist +@defopt minibuffer-frame-alist This variable's value is an alist of parameter values used when creating an initial minibuffer-only frame. This is the minibuffer-only frame that Emacs creates if @code{initial-frame-alist} specifies a frame with no minibuffer. -@end defvar +@end defopt -@defvar default-frame-alist +@defopt default-frame-alist This is an alist specifying default values of frame parameters for all Emacs frames---the first frame, and subsequent frames. When using the X Window System, you can get the same results by means of X resources in many cases. Setting this variable does not affect existing frames. -@end defvar +@end defopt Functions that display a buffer in a separate frame can override the default parameters by supplying their own parameters. @xref{Definition @@ -793,7 +793,7 @@ The buffer-local variable @code{cursor-type} overrides the value of the @code{cursor-type} frame parameter, but if it is @code{t}, that means to use the cursor specified for the frame. -@defvar blink-cursor-alist +@defopt blink-cursor-alist This variable specifies how to blink the cursor. Each element has the form @code{(@var{on-state} . @var{off-state})}. Whenever the cursor type equals @var{on-state} (comparing using @code{equal}), the @@ -805,16 +805,16 @@ There are various defaults for how to blink each type of cursor, if the type is not mentioned as an @var{on-state} here. Changes in this variable do not take effect immediately, only when you specify the @code{cursor-type} frame parameter. -@end defvar +@end defopt -@defvar cursor-in-non-selected-windows +@defopt cursor-in-non-selected-windows This variable controls how the cursor looks in a window that is not selected. It supports the same values as the @code{cursor-type} frame parameter; also, @code{nil} means don't display a cursor in nonselected windows, and @code{t} (the default) means use a standard modificatoin of the usual cursor type (solid box becomes hollow box, and bar becomes a narrower bar). -@end defvar +@end defopt @node Font and Color Parameters @subsubsection Font and Color Parameters @@ -1926,12 +1926,12 @@ the first cut buffer moves into the second cut buffer, and the second to the third, and so on through all eight cut buffers. @end defun -@defvar selection-coding-system +@defopt selection-coding-system This variable specifies the coding system to use when reading and writing selections or the clipboard. @xref{Coding Systems}. The default is @code{compound-text-with-extensions}, which converts to the text representation that X11 normally uses. -@end defvar +@end defopt @cindex clipboard support (for MS-Windows) When Emacs runs on MS-Windows, it does not implement X selections in @@ -2327,11 +2327,11 @@ This function returns the width of the screen in millimeters, or @code{nil} if Emacs cannot get that information. @end defun -@defvar display-mm-dimensions-alist +@defopt display-mm-dimensions-alist This variable allows the user to specify the dimensions of graphical displays returned by @code{display-mm-height} and @code{display-mm-width} in case the system provides incorrect values. -@end defvar +@end defopt @defun display-backing-store &optional display This function returns the backing store capability of the display. diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index b6210da7f9..19fa348463 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi @@ -557,7 +557,7 @@ follows: @end smallexample @end deffn -@defvar help-char +@defopt help-char The value of this variable is the help character---the character that Emacs recognizes as meaning Help. By default, its value is 8, which stands for @kbd{C-h}. When Emacs reads this character, if @@ -574,13 +574,13 @@ The help character is special after prefix keys, too. If it has no binding as a subcommand of the prefix key, it runs @code{describe-prefix-bindings}, which displays a list of all the subcommands of the prefix key. -@end defvar +@end defopt -@defvar help-event-list +@defopt help-event-list The value of this variable is a list of event types that serve as alternative ``help characters.'' These events are handled just like the event specified by @code{help-char}. -@end defvar +@end defopt @defvar help-form If this variable is non-@code{nil}, its value is a form to evaluate diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi index de792c76e9..4afe5e55d8 100644 --- a/doc/lispref/keymaps.texi +++ b/doc/lispref/keymaps.texi @@ -1179,7 +1179,7 @@ The argument @var{accept-defaults} controls checking for default bindings, as in @code{lookup-key} (above). @end defun -@defvar meta-prefix-char +@defopt meta-prefix-char @cindex @key{ESC} This variable is the meta-prefix character code. It is used for translating a meta character to a two-character sequence so it can be @@ -1225,7 +1225,7 @@ meta-prefix-char ; @r{The default value.} This translation of one event into two happens only for characters, not for other kinds of input events. Thus, @kbd{M-@key{F1}}, a function key, is not converted into @kbd{@key{ESC} @key{F1}}. -@end defvar +@end defopt @node Changing Key Bindings @section Changing Key Bindings diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi index f35978d244..dbc4c0da33 100644 --- a/doc/lispref/minibuf.texi +++ b/doc/lispref/minibuf.texi @@ -508,19 +508,19 @@ This lets Lisp programs explicitly manage input history by using set to a non-@code{nil} value. @end defvar -@defvar history-length +@defopt history-length The value of this variable specifies the maximum length for all history lists that don't specify their own maximum lengths. If the value is @code{t}, that means there no maximum (don't delete old elements). The value of @code{history-length} property of the history list variable's symbol, if set, overrides this variable for that particular history list. -@end defvar +@end defopt -@defvar history-delete-duplicates +@defopt history-delete-duplicates If the value of this variable is @code{t}, that means when adding a new history element, all previous identical elements are deleted. -@end defvar +@end defopt Here are some of the standard minibuffer history list variables: @@ -1188,17 +1188,17 @@ Buffer name (default foo): @point{} @end example @end defun -@defvar read-buffer-function +@defopt read-buffer-function This variable specifies how to read buffer names. For example, if you set this variable to @code{iswitchb-read-buffer}, all Emacs commands that call @code{read-buffer} to read a buffer name will actually use the @code{iswitchb} package to read it. -@end defvar +@end defopt -@defvar read-buffer-completion-ignore-case +@defopt read-buffer-completion-ignore-case If this variable is non-@code{nil}, @code{read-buffer} ignores case when performing completion. -@end defvar +@end defopt @defun read-command prompt &optional default This function reads the name of a command and returns it as a Lisp @@ -1442,10 +1442,10 @@ called, it calls this function with the supplied arguments instead of doing its usual work. @end defvar -@defvar read-file-name-completion-ignore-case +@defopt read-file-name-completion-ignore-case If this variable is non-@code{nil}, @code{read-file-name} ignores case when performing completion. -@end defvar +@end defopt @defun read-directory-name prompt &optional directory default require-match initial This function is like @code{read-file-name} but allows only directory diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index af20bed18b..b4866fd7d7 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -1714,14 +1714,14 @@ the top of the window is to use a list like this: @code{(-3 "%p")}. The variable in overall control of the mode line is @code{mode-line-format}. -@defvar mode-line-format +@defopt mode-line-format The value of this variable is a mode-line construct that controls the contents of the mode-line. It is always buffer-local in all buffers. If you set this variable to @code{nil} in a buffer, that buffer does not have a mode line. (A window that is just one line tall never displays a mode line.) -@end defvar +@end defopt The default value of @code{mode-line-format} is designed to use the values of other variables such as @code{mode-line-position} and @@ -1821,11 +1821,11 @@ Its default value displays the buffer name, padded with spaces to at least 12 columns. @end defvar -@defvar mode-line-position +@defopt mode-line-position This variable indicates the position in the buffer. Its default value displays the buffer percentage and, optionally, the buffer size, the line number and the column number. -@end defvar +@end defopt @defvar vc-mode The variable @code{vc-mode}, buffer-local in each buffer, records @@ -1834,11 +1834,11 @@ and, if so, which kind. Its value is a string that appears in the mode line, or @code{nil} for no version control. @end defvar -@defvar mode-line-modes +@defopt mode-line-modes This variable displays the buffer's major and minor modes. Its default value also displays the recursive editing level, information on the process status, and whether narrowing is in effect. -@end defvar +@end defopt The following three variables are used in @code{mode-line-modes}: diff --git a/doc/lispref/nonascii.texi b/doc/lispref/nonascii.texi index 588cac337d..9f8df7c77f 100644 --- a/doc/lispref/nonascii.texi +++ b/doc/lispref/nonascii.texi @@ -95,14 +95,14 @@ strings except for manipulating encoded text or binary non-text data. The representation for a string is determined and recorded in the string when the string is constructed. -@defvar enable-multibyte-characters +@defopt enable-multibyte-characters This variable specifies the current buffer's text representation. If it is non-@code{nil}, the buffer contains multibyte text; otherwise, it contains unibyte encoded text or binary non-text data. You cannot set this variable directly; instead, use the function @code{set-buffer-multibyte} to change a buffer's representation. -@end defvar +@end defopt @defvar default-enable-multibyte-characters This variable's value is entirely equivalent to @code{(default-value @@ -1289,7 +1289,7 @@ don't change these variables; instead, override them using (@pxref{Specifying Coding Systems}). @cindex file contents, and default coding system -@defvar auto-coding-regexp-alist +@defopt auto-coding-regexp-alist This variable is an alist of text patterns and corresponding coding systems. Each element has the form @code{(@var{regexp} . @var{coding-system})}; a file whose first few kilobytes match @@ -1299,10 +1299,10 @@ read into a buffer. The settings in this alist take priority over @code{file-coding-system-alist} (see below). The default value is set so that Emacs automatically recognizes mail files in Babyl format and reads them with no code conversions. -@end defvar +@end defopt @cindex file name, and default coding system -@defvar file-coding-system-alist +@defopt file-coding-system-alist This variable is an alist that specifies the coding systems to use for reading and writing particular files. Each element has the form @code{(@var{pattern} . @var{coding})}, where @var{pattern} is a regular @@ -1325,14 +1325,14 @@ meaning as described above. If @var{coding} (or what returned by the above function) is @code{undecided}, the normal code-detection is performed. -@end defvar +@end defopt -@defvar auto-coding-alist +@defopt auto-coding-alist This variable is an alist that specifies the coding systems to use for reading and writing particular files. Its form is like that of @code{file-coding-system-alist}, but, unlike the latter, this variable takes priority over any @code{coding:} tags in the file. -@end defvar +@end defopt @cindex program name, and default coding system @defvar process-coding-system-alist @@ -1380,7 +1380,7 @@ the subprocess, and @var{output-coding} applies to output to it. @end defvar @cindex default coding system, functions to determine -@defvar auto-coding-functions +@defopt auto-coding-functions This variable holds a list of functions that try to determine a coding system for a file based on its undecoded contents. @@ -1394,7 +1394,7 @@ Otherwise, it should return @code{nil}. If a file has a @samp{coding:} tag, that takes precedence, so these functions won't be called. -@end defvar +@end defopt @defun find-auto-coding filename size This function tries to determine a suitable coding system for @@ -1521,12 +1521,12 @@ When a single operation does both input and output, as do affect it. @end defvar -@defvar inhibit-eol-conversion +@defopt inhibit-eol-conversion When this variable is non-@code{nil}, no end-of-line conversion is done, no matter which coding system is specified. This applies to all the Emacs I/O and subprocess primitives, and to the explicit encoding and decoding functions (@pxref{Explicit Encoding}). -@end defvar +@end defopt @cindex priority order of coding systems @cindex coding systems, priority diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index a97aef4016..07ae1a0868 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi @@ -279,12 +279,12 @@ to a non-@code{nil} value, then Emacs does not subsequently load the loads this @emph{before} the user's init file. You can inhibit the loading of this file with the option @samp{--no-site-file}. -@defvar site-run-file +@defopt site-run-file This variable specifies the site-customization file to load before the user's init file. Its normal value is @code{"site-start"}. The only way you can change it with real effect is to do so before dumping Emacs. -@end defvar +@end defopt @xref{Init Examples,, Init File Examples, emacs, The GNU Emacs Manual}, for examples of how to make various commonly desired customizations in your @@ -821,14 +821,14 @@ fact, the function returns whatever value the variable system. The variable is also useful for constructing frame titles (@pxref{Frame Titles}). -@defvar mail-host-address +@defopt mail-host-address If this variable is non-@code{nil}, it is used instead of @code{system-name} for purposes of generating email addresses. For example, it is used when constructing the default value of @code{user-mail-address}. @xref{User Identification}. (Since this is done when Emacs starts up, the value actually used is the one saved when Emacs was dumped. @xref{Building Emacs}.) -@end defvar +@end defopt @deffn Command getenv var &optional frame @cindex environment variable access @@ -1009,13 +1009,13 @@ option was used, then Lisp packages should not load any customization files or user profile. @end defvar -@defvar user-mail-address +@defopt user-mail-address This holds the nominal email address of the user who is using Emacs. Emacs normally sets this variable to a default value after reading your init files, but not if you have already set it. So you can set the variable to some other value in your init file if you do not want to use the default value. -@end defvar +@end defopt @defun user-login-name &optional uid If you don't specify @var{uid}, this function returns the name under @@ -1928,7 +1928,7 @@ trigger an Emacs bug, for the sake of a bug report. track of output sent to the terminal. The variable @code{baud-rate} tells you what Emacs thinks is the output speed of the terminal. -@defvar baud-rate +@defopt baud-rate This variable's value is the output speed of the terminal, as far as Emacs knows. Setting this variable does not change the speed of actual data transmission, but the value is used for calculations such as @@ -1939,7 +1939,7 @@ screen or repaint on text terminals. @xref{Forcing Redisplay}, for the corresponding functionality on graphical terminals. The value is measured in baud. -@end defvar +@end defopt If you are running across a network, and different parts of the network work at different baud rates, the value returned by Emacs may be diff --git a/doc/lispref/positions.texi b/doc/lispref/positions.texi index 06b696ea3a..d3c13a3eb0 100644 --- a/doc/lispref/positions.texi +++ b/doc/lispref/positions.texi @@ -220,13 +220,13 @@ This function is just like @code{forward-word}, except that it moves backward until encountering the front of a word, rather than forward. @end deffn -@defvar words-include-escapes +@defopt words-include-escapes @c Emacs 19 feature This variable affects the behavior of @code{forward-word} and everything that uses it. If it is non-@code{nil}, then characters in the ``escape'' and ``character quote'' syntax classes count as part of words. Otherwise, they do not. -@end defvar +@end defopt @defvar inhibit-field-text-motion If this variable is non-@code{nil}, certain motion functions including diff --git a/doc/lispref/searching.texi b/doc/lispref/searching.texi index 3060980675..146d00cfe1 100644 --- a/doc/lispref/searching.texi +++ b/doc/lispref/searching.texi @@ -1786,12 +1786,12 @@ arguments: the first 3 arguments of @code{re-search-forward} This section describes some variables that hold regular expressions used for certain purposes in editing: -@defvar page-delimiter +@defopt page-delimiter This is the regular expression describing line-beginnings that separate pages. The default value is @code{"^\014"} (i.e., @code{"^^L"} or @code{"^\C-l"}); this matches a line that starts with a formfeed character. -@end defvar +@end defopt The following two regular expressions should @emph{not} assume the match always starts at the beginning of a line; they should not use @@ -1802,22 +1802,22 @@ they accept matches that start after the left margin. In that case, a @samp{^} would be incorrect. However, a @samp{^} is harmless in modes where a left margin is never used. -@defvar paragraph-separate +@defopt paragraph-separate This is the regular expression for recognizing the beginning of a line that separates paragraphs. (If you change this, you may have to change @code{paragraph-start} also.) The default value is @w{@code{"[@ \t\f]*$"}}, which matches a line that consists entirely of spaces, tabs, and form feeds (after its left margin). -@end defvar +@end defopt -@defvar paragraph-start +@defopt paragraph-start This is the regular expression for recognizing the beginning of a line that starts @emph{or} separates paragraphs. The default value is @w{@code{"\f\\|[ \t]*$"}}, which matches a line containing only whitespace or starting with a form feed (after its left margin). -@end defvar +@end defopt -@defvar sentence-end +@defopt sentence-end If non-@code{nil}, the value should be a regular expression describing the end of a sentence, including the whitespace following the sentence. (All paragraph boundaries also end sentences, regardless.) @@ -1826,7 +1826,7 @@ If the value is @code{nil}, the default, then the function @code{sentence-end} has to construct the regexp. That is why you should always call the function @code{sentence-end} to obtain the regexp to be used to recognize the end of a sentence. -@end defvar +@end defopt @defun sentence-end This function returns the value of the variable @code{sentence-end}, diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 07c5d5c8a8..5636162184 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi @@ -1690,20 +1690,20 @@ may involve either inserting or deleting whitespace.) This function is value of @code{indent-line-function} in Paragraph-Indent Text mode. @end defun -@defvar left-margin +@defopt left-margin This variable specifies the base left margin column. In Fundamental mode, @kbd{C-j} indents to this column. This variable automatically becomes buffer-local when set in any fashion. -@end defvar +@end defopt -@defvar fill-nobreak-predicate +@defopt fill-nobreak-predicate This variable gives major modes a way to specify not to break a line at certain places. Its value should be a list of functions. Whenever filling considers breaking the line at a certain place in the buffer, it calls each of these functions with no arguments and with point located at that place. If any of the functions returns non-@code{nil}, then the line won't be broken there. -@end defvar +@end defopt @node Adaptive Fill @section Adaptive Fill Mode diff --git a/doc/lispref/variables.texi b/doc/lispref/variables.texi index 75f0b18260..e4598e3032 100644 --- a/doc/lispref/variables.texi +++ b/doc/lispref/variables.texi @@ -260,7 +260,7 @@ Variables}); a few variables have terminal-local bindings like ordinary local bindings, but they are localized depending on ``where'' you are in Emacs, rather than localized in time. -@defvar max-specpdl-size +@defopt max-specpdl-size @anchor{Definition of max-specpdl-size} @cindex variable limit error @cindex evaluation error @@ -279,7 +279,7 @@ that Lisp avoids infinite recursion on an ill-defined function. The default value is 1000. Entry to the Lisp debugger increases the value, if there is little room left, to make sure the debugger itself has room to execute. -@end defvar +@end defopt @node Void Variables @section When a Variable is ``Void'' diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 5e58bb1348..ad9f012f79 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi @@ -959,7 +959,7 @@ variable @code{pop-up-frames} (see below) is non-@code{nil}, @code{display-buffer} does not split any window. @end defopt -@defvar split-window-preferred-function +@defopt split-window-preferred-function This variable must specify a function with one argument, which is a window. The @code{display-buffer} routines will call this function with one or more candidate windows when they look for a window to split. The @@ -987,7 +987,7 @@ any window as long as the return value of your function specifies a live window or @code{nil}, but you are not encouraged to do so unconditionally. If you want @code{display-buffer} to never split any windows, set @code{pop-up-windows} to @code{nil}. -@end defvar +@end defopt @defun split-window-sensibly window This function takes a window as argument and tries to split that window @@ -1130,12 +1130,12 @@ use the default frame parameters, or else the specified list of frame parameters. @end defun -@defvar special-display-function +@defopt special-display-function This variable holds the function to call to display a buffer specially. It receives the buffer as an argument, and should return the window in which it is displayed. The default value of this variable is @code{special-display-popup-frame}, see below. -@end defvar +@end defopt @defun special-display-popup-frame buffer &optional args This function tries to make @var{buffer} visible in a frame of its own. @@ -1183,7 +1183,7 @@ put it in the selected window. @end defun @c Emacs 19 feature -@defvar display-buffer-function +@defopt display-buffer-function This variable is the most flexible way to customize the behavior of @code{display-buffer}. If it is non-@code{nil}, it should be a function that @code{display-buffer} calls to do the work. The function should @@ -1193,7 +1193,7 @@ buffer in it, and then return the window. This variable takes precedence over all the other options described above. -@end defvar +@end defopt If all options described above fail to produce a suitable window, @code{display-buffer} tries to reuse an existing window. As a last