diff options
| author | Martin Rudalics | 2009-05-21 15:31:31 +0000 |
|---|---|---|
| committer | Martin Rudalics | 2009-05-21 15:31:31 +0000 |
| commit | 01f17ae208c1bd9e70fa7fc76f5463aa46602815 (patch) | |
| tree | 8f4d8c52df05abb97453bc24084992e8a95fb589 | |
| parent | ef6e069495ace3eab6bf810673f5b3741ceff30c (diff) | |
| download | emacs-01f17ae208c1bd9e70fa7fc76f5463aa46602815.tar.gz emacs-01f17ae208c1bd9e70fa7fc76f5463aa46602815.zip | |
* 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.
| -rw-r--r-- | doc/lispref/ChangeLog | 88 | ||||
| -rw-r--r-- | doc/lispref/abbrevs.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/backups.texi | 12 | ||||
| -rw-r--r-- | doc/lispref/buffers.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 52 | ||||
| -rw-r--r-- | doc/lispref/eval.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/files.texi | 16 | ||||
| -rw-r--r-- | doc/lispref/frames.texi | 28 | ||||
| -rw-r--r-- | doc/lispref/help.texi | 8 | ||||
| -rw-r--r-- | doc/lispref/keymaps.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/minibuf.texi | 20 | ||||
| -rw-r--r-- | doc/lispref/modes.texi | 12 | ||||
| -rw-r--r-- | doc/lispref/nonascii.texi | 24 | ||||
| -rw-r--r-- | doc/lispref/os.texi | 16 | ||||
| -rw-r--r-- | doc/lispref/positions.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/searching.texi | 16 | ||||
| -rw-r--r-- | doc/lispref/text.texi | 8 | ||||
| -rw-r--r-- | doc/lispref/variables.texi | 4 | ||||
| -rw-r--r-- | doc/lispref/windows.texi | 12 |
19 files changed, 212 insertions, 124 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index eb82a7e12be..213bd53cb76 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,91 @@ | |||
| 1 | 2009-05-21 Martin Rudalics <rudalics@gmx.at> | ||
| 2 | |||
| 3 | * abbrevs.texi (Abbrev Mode): abbrev-mode is an option. | ||
| 4 | |||
| 5 | * backups.texi (Making Backups): backup-directory-alist and | ||
| 6 | make-backup-file-name-function are options. | ||
| 7 | (Auto-Saving): auto-save-list-file-prefix is an option. | ||
| 8 | |||
| 9 | * buffers.texi (Killing Buffers): buffer-offer-save is an | ||
| 10 | option. | ||
| 11 | |||
| 12 | * display.texi (Refresh Screen): no-redraw-on-reenter is an | ||
| 13 | option. | ||
| 14 | (Echo Area Customization): echo-keystrokes is an option. | ||
| 15 | (Selective Display): selective-display-ellipses is an option. | ||
| 16 | (Temporary Displays): temp-buffer-show-function is an option. | ||
| 17 | (Face Attributes): underline-minimum-offset and x-bitmap-file-path | ||
| 18 | are options. | ||
| 19 | (Font Selection): face-font-family-alternatives, | ||
| 20 | face-font-selection-order, face-font-registry-alternatives, and | ||
| 21 | scalable-fonts-allowed are options. | ||
| 22 | (Fringe Indicators): indicate-buffer-boundaries is an option. | ||
| 23 | (Fringe Cursors): overflow-newline-into-fringe is an option. | ||
| 24 | (Scroll Bars): scroll-bar-mode is an option. | ||
| 25 | |||
| 26 | * eval.texi (Eval): max-lisp-eval-depth is an option. | ||
| 27 | |||
| 28 | * files.texi (Visiting Functions): find-file-hook is an option. | ||
| 29 | (Directory Names): directory-abbrev-alist is an option. | ||
| 30 | (Unique File Names): temporary-file-directory and | ||
| 31 | small-temporary-file-directory are options. | ||
| 32 | |||
| 33 | * frames.texi (Initial Parameters): initial-frame-alist, | ||
| 34 | minibuffer-frame-alist and default-frame-alist are options. | ||
| 35 | (Cursor Parameters): blink-cursor-alist and | ||
| 36 | cursor-in-non-selected-windows ar options. | ||
| 37 | (Window System Selections): selection-coding-system is an | ||
| 38 | option. | ||
| 39 | (Display Feature Testing): display-mm-dimensions-alist is an | ||
| 40 | option. | ||
| 41 | |||
| 42 | * help.texi (Help Functions): help-char and help-event-list are | ||
| 43 | options. | ||
| 44 | |||
| 45 | * keymaps.texi (Functions for Key Lookup): meta-prefix-char is | ||
| 46 | an option. | ||
| 47 | |||
| 48 | * minibuf.texi (Minibuffer History): history-length and | ||
| 49 | history-delete-duplicates are options. | ||
| 50 | (High-Level Completion): read-buffer-function and | ||
| 51 | read-buffer-completion-ignore-case are options. | ||
| 52 | (Reading File Names): read-file-name-completion-ignore-case is | ||
| 53 | an option. | ||
| 54 | |||
| 55 | * modes.texi (Mode Line Top): mode-line-format is an option. | ||
| 56 | (Mode Line Variables): mode-line-position and mode-line-modes | ||
| 57 | are options. | ||
| 58 | |||
| 59 | * nonascii.texi (Text Representations): | ||
| 60 | enable-multibyte-characters is an option. | ||
| 61 | (Default Coding Systems): auto-coding-regexp-alist, | ||
| 62 | file-coding-system-alist, auto-coding-alist and | ||
| 63 | auto-coding-functions are options. | ||
| 64 | (Specifying Coding Systems): inhibit-eol-conversion is an | ||
| 65 | option. | ||
| 66 | |||
| 67 | * os.texi (Init File): site-run-file is an option. | ||
| 68 | (System Environment): mail-host-address is an option. | ||
| 69 | (User Identification): user-mail-address is an option. | ||
| 70 | (Terminal Output): baud-rate is an option. | ||
| 71 | |||
| 72 | * positions.texi (Word Motion): words-include-escapes is an | ||
| 73 | option. | ||
| 74 | |||
| 75 | * searching.texi (Standard Regexps): page-delimiter, | ||
| 76 | paragraph-separate, paragraph-separate and sentence-end are | ||
| 77 | options. | ||
| 78 | |||
| 79 | * text.texi (Margins): left-margin and fill-nobreak-predicate | ||
| 80 | are options. | ||
| 81 | |||
| 82 | * variables.texi (Local Variables): max-specpdl-size is an | ||
| 83 | option. | ||
| 84 | |||
| 85 | * windows.texi (Choosing Window): | ||
| 86 | split-window-preferred-function, special-display-function and | ||
| 87 | display-buffer-function are options. | ||
| 88 | |||
| 1 | 2009-05-20 Chong Yidong <cyd@stupidchicken.com> | 89 | 2009-05-20 Chong Yidong <cyd@stupidchicken.com> |
| 2 | 90 | ||
| 3 | Fix errors spotted by Martin Rudalics. | 91 | Fix errors spotted by Martin Rudalics. |
diff --git a/doc/lispref/abbrevs.texi b/doc/lispref/abbrevs.texi index ad885aa9642..9e14c3d4e9b 100644 --- a/doc/lispref/abbrevs.texi +++ b/doc/lispref/abbrevs.texi | |||
| @@ -64,13 +64,13 @@ Mode, emacs, The GNU Emacs Manual}. | |||
| 64 | Abbrev mode is a minor mode controlled by the variable | 64 | Abbrev mode is a minor mode controlled by the variable |
| 65 | @code{abbrev-mode}. | 65 | @code{abbrev-mode}. |
| 66 | 66 | ||
| 67 | @defvar abbrev-mode | 67 | @defopt abbrev-mode |
| 68 | If this variable is non-@code{nil}, abbrevs are automatically expanded | 68 | If this variable is non-@code{nil}, abbrevs are automatically expanded |
| 69 | in the buffer. If the value is @code{nil}, abbrevs may be defined, | 69 | in the buffer. If the value is @code{nil}, abbrevs may be defined, |
| 70 | but they are not expanded automatically. | 70 | but they are not expanded automatically. |
| 71 | 71 | ||
| 72 | This variable automatically becomes buffer-local when set in any fashion. | 72 | This variable automatically becomes buffer-local when set in any fashion. |
| 73 | @end defvar | 73 | @end defopt |
| 74 | 74 | ||
| 75 | @defvar default-abbrev-mode | 75 | @defvar default-abbrev-mode |
| 76 | This is the value of @code{abbrev-mode} for buffers that do not | 76 | 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 372aedc8a8c..6de8594607f 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 | |||
| 122 | @code{make-backup-files} instead. | 122 | @code{make-backup-files} instead. |
| 123 | @end defvar | 123 | @end defvar |
| 124 | 124 | ||
| 125 | @defvar backup-directory-alist | 125 | @defopt backup-directory-alist |
| 126 | This variable's value is an alist of filename patterns and backup | 126 | This variable's value is an alist of filename patterns and backup |
| 127 | directory names. Each element looks like | 127 | directory names. Each element looks like |
| 128 | @smallexample | 128 | @smallexample |
| @@ -147,9 +147,9 @@ backup is made in the original file's directory. | |||
| 147 | 147 | ||
| 148 | On MS-DOS filesystems without long names this variable is always | 148 | On MS-DOS filesystems without long names this variable is always |
| 149 | ignored. | 149 | ignored. |
| 150 | @end defvar | 150 | @end defopt |
| 151 | 151 | ||
| 152 | @defvar make-backup-file-name-function | 152 | @defopt make-backup-file-name-function |
| 153 | This variable's value is a function to use for making backups instead | 153 | This variable's value is a function to use for making backups instead |
| 154 | of the default @code{make-backup-file-name}. A value of @code{nil} | 154 | of the default @code{make-backup-file-name}. A value of @code{nil} |
| 155 | gives the default @code{make-backup-file-name} behavior. | 155 | gives the default @code{make-backup-file-name} behavior. |
| @@ -158,7 +158,7 @@ gives the default @code{make-backup-file-name} behavior. | |||
| 158 | This could be buffer-local to do something special for specific | 158 | This could be buffer-local to do something special for specific |
| 159 | files. If you define it, you may need to change | 159 | files. If you define it, you may need to change |
| 160 | @code{backup-file-name-p} and @code{file-name-sans-versions} too. | 160 | @code{backup-file-name-p} and @code{file-name-sans-versions} too. |
| 161 | @end defvar | 161 | @end defopt |
| 162 | 162 | ||
| 163 | 163 | ||
| 164 | @node Rename or Copy | 164 | @node Rename or Copy |
| @@ -652,13 +652,13 @@ with @samp{.saves-}. It also contains the Emacs process @acronym{ID} and the | |||
| 652 | host name. | 652 | host name. |
| 653 | @end defvar | 653 | @end defvar |
| 654 | 654 | ||
| 655 | @defvar auto-save-list-file-prefix | 655 | @defopt auto-save-list-file-prefix |
| 656 | After Emacs reads your init file, it initializes | 656 | After Emacs reads your init file, it initializes |
| 657 | @code{auto-save-list-file-name} (if you have not already set it | 657 | @code{auto-save-list-file-name} (if you have not already set it |
| 658 | non-@code{nil}) based on this prefix, adding the host name and process | 658 | non-@code{nil}) based on this prefix, adding the host name and process |
| 659 | ID. If you set this to @code{nil} in your init file, then Emacs does | 659 | ID. If you set this to @code{nil} in your init file, then Emacs does |
| 660 | not initialize @code{auto-save-list-file-name}. | 660 | not initialize @code{auto-save-list-file-name}. |
| 661 | @end defvar | 661 | @end defopt |
| 662 | 662 | ||
| 663 | @node Reverting | 663 | @node Reverting |
| 664 | @section Reverting | 664 | @section Reverting |
diff --git a/doc/lispref/buffers.texi b/doc/lispref/buffers.texi index 2aa5c43984f..5d03865e8e2 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. | |||
| 1065 | is not cleared by changing major modes. | 1065 | is not cleared by changing major modes. |
| 1066 | @end defvar | 1066 | @end defvar |
| 1067 | 1067 | ||
| 1068 | @defvar buffer-offer-save | 1068 | @defopt buffer-offer-save |
| 1069 | This variable, if non-@code{nil} in a particular buffer, tells | 1069 | This variable, if non-@code{nil} in a particular buffer, tells |
| 1070 | @code{save-buffers-kill-emacs} and @code{save-some-buffers} (if the | 1070 | @code{save-buffers-kill-emacs} and @code{save-some-buffers} (if the |
| 1071 | second optional argument to that function is @code{t}) to offer to | 1071 | 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. | |||
| 1073 | @xref{Definition of save-some-buffers}. The variable | 1073 | @xref{Definition of save-some-buffers}. The variable |
| 1074 | @code{buffer-offer-save} automatically becomes buffer-local when set | 1074 | @code{buffer-offer-save} automatically becomes buffer-local when set |
| 1075 | for any reason. @xref{Buffer-Local Variables}. | 1075 | for any reason. @xref{Buffer-Local Variables}. |
| 1076 | @end defvar | 1076 | @end defopt |
| 1077 | 1077 | ||
| 1078 | @defvar buffer-save-without-query | 1078 | @defvar buffer-save-without-query |
| 1079 | This variable, if non-@code{nil} in a particular buffer, tells | 1079 | This variable, if non-@code{nil} in a particular buffer, tells |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 26c089ddeae..17563140436 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 | |||
| 66 | sequential display. If you are using such a terminal, you might want | 66 | sequential display. If you are using such a terminal, you might want |
| 67 | to inhibit the redisplay on resumption. | 67 | to inhibit the redisplay on resumption. |
| 68 | 68 | ||
| 69 | @defvar no-redraw-on-reenter | 69 | @defopt no-redraw-on-reenter |
| 70 | @cindex suspend (cf. @code{no-redraw-on-reenter}) | 70 | @cindex suspend (cf. @code{no-redraw-on-reenter}) |
| 71 | @cindex resume (cf. @code{no-redraw-on-reenter}) | 71 | @cindex resume (cf. @code{no-redraw-on-reenter}) |
| 72 | This variable controls whether Emacs redraws the entire screen after it | 72 | This variable controls whether Emacs redraws the entire screen after it |
| 73 | has been suspended and resumed. Non-@code{nil} means there is no need | 73 | has been suspended and resumed. Non-@code{nil} means there is no need |
| 74 | to redraw, @code{nil} means redrawing is needed. The default is @code{nil}. | 74 | to redraw, @code{nil} means redrawing is needed. The default is @code{nil}. |
| 75 | @end defvar | 75 | @end defopt |
| 76 | 76 | ||
| 77 | @node Forcing Redisplay | 77 | @node Forcing Redisplay |
| 78 | @section Forcing Redisplay | 78 | @section Forcing Redisplay |
| @@ -543,7 +543,7 @@ This normal hook is run whenever the echo area is cleared---either by | |||
| 543 | @code{(message nil)} or for any other reason. | 543 | @code{(message nil)} or for any other reason. |
| 544 | @end defvar | 544 | @end defvar |
| 545 | 545 | ||
| 546 | @defvar echo-keystrokes | 546 | @defopt echo-keystrokes |
| 547 | This variable determines how much time should elapse before command | 547 | This variable determines how much time should elapse before command |
| 548 | characters echo. Its value must be an integer or floating point number, | 548 | characters echo. Its value must be an integer or floating point number, |
| 549 | which specifies the | 549 | which specifies the |
| @@ -554,7 +554,7 @@ begins in a key sequence, all subsequent characters in the same key | |||
| 554 | sequence are echoed immediately.) | 554 | sequence are echoed immediately.) |
| 555 | 555 | ||
| 556 | If the value is zero, then command input is not echoed. | 556 | If the value is zero, then command input is not echoed. |
| 557 | @end defvar | 557 | @end defopt |
| 558 | 558 | ||
| 559 | @defvar message-truncate-lines | 559 | @defvar message-truncate-lines |
| 560 | Normally, displaying a long message resizes the echo area to display | 560 | Normally, displaying a long message resizes the echo area to display |
| @@ -994,7 +994,7 @@ change. | |||
| 994 | @end example | 994 | @end example |
| 995 | @end defvar | 995 | @end defvar |
| 996 | 996 | ||
| 997 | @defvar selective-display-ellipses | 997 | @defopt selective-display-ellipses |
| 998 | If this buffer-local variable is non-@code{nil}, then Emacs displays | 998 | If this buffer-local variable is non-@code{nil}, then Emacs displays |
| 999 | @samp{@dots{}} at the end of a line that is followed by hidden text. | 999 | @samp{@dots{}} at the end of a line that is followed by hidden text. |
| 1000 | This example is a continuation of the previous one. | 1000 | This example is a continuation of the previous one. |
| @@ -1015,7 +1015,7 @@ This example is a continuation of the previous one. | |||
| 1015 | 1015 | ||
| 1016 | You can use a display table to substitute other text for the ellipsis | 1016 | You can use a display table to substitute other text for the ellipsis |
| 1017 | (@samp{@dots{}}). @xref{Display Tables}. | 1017 | (@samp{@dots{}}). @xref{Display Tables}. |
| 1018 | @end defvar | 1018 | @end defopt |
| 1019 | 1019 | ||
| 1020 | @node Temporary Displays | 1020 | @node Temporary Displays |
| 1021 | @section Temporary Displays | 1021 | @section Temporary Displays |
| @@ -1078,7 +1078,7 @@ The value of the last form in @var{forms} is returned. | |||
| 1078 | @end example | 1078 | @end example |
| 1079 | @end defspec | 1079 | @end defspec |
| 1080 | 1080 | ||
| 1081 | @defvar temp-buffer-show-function | 1081 | @defopt temp-buffer-show-function |
| 1082 | If this variable is non-@code{nil}, @code{with-output-to-temp-buffer} | 1082 | If this variable is non-@code{nil}, @code{with-output-to-temp-buffer} |
| 1083 | calls it as a function to do the job of displaying a help buffer. The | 1083 | calls it as a function to do the job of displaying a help buffer. The |
| 1084 | function gets one argument, which is the buffer it should display. | 1084 | 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} | |||
| 1087 | just as @code{with-output-to-temp-buffer} normally would, inside of | 1087 | just as @code{with-output-to-temp-buffer} normally would, inside of |
| 1088 | @code{save-selected-window} and with the chosen window and buffer | 1088 | @code{save-selected-window} and with the chosen window and buffer |
| 1089 | selected. | 1089 | selected. |
| 1090 | @end defvar | 1090 | @end defopt |
| 1091 | 1091 | ||
| 1092 | @defvar temp-buffer-setup-hook | 1092 | @defvar temp-buffer-setup-hook |
| 1093 | This normal hook is run by @code{with-output-to-temp-buffer} before | 1093 | 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 | |||
| 2162 | to be displayed; if it is @code{nil}, the selected frame is used. | 2162 | to be displayed; if it is @code{nil}, the selected frame is used. |
| 2163 | @end defun | 2163 | @end defun |
| 2164 | 2164 | ||
| 2165 | @defvar underline-minimum-offset | 2165 | @defopt underline-minimum-offset |
| 2166 | This variable specifies the minimum distance between the baseline and | 2166 | This variable specifies the minimum distance between the baseline and |
| 2167 | the underline, in pixels, when displaying underlined text. | 2167 | the underline, in pixels, when displaying underlined text. |
| 2168 | @end defvar | 2168 | @end defopt |
| 2169 | 2169 | ||
| 2170 | @defvar x-bitmap-file-path | 2170 | @defopt x-bitmap-file-path |
| 2171 | This variable specifies a list of directories for searching | 2171 | This variable specifies a list of directories for searching |
| 2172 | for bitmap files, for the @code{:stipple} attribute. | 2172 | for bitmap files, for the @code{:stipple} attribute. |
| 2173 | @end defvar | 2173 | @end defopt |
| 2174 | 2174 | ||
| 2175 | @defun bitmap-spec-p object | 2175 | @defun bitmap-spec-p object |
| 2176 | This returns @code{t} if @var{object} is a valid bitmap specification, | 2176 | 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, | |||
| 2674 | Emacs looks for the @dfn{closest matching font}. The variables in | 2674 | Emacs looks for the @dfn{closest matching font}. The variables in |
| 2675 | this section control how Emacs makes this selection. | 2675 | this section control how Emacs makes this selection. |
| 2676 | 2676 | ||
| 2677 | @defvar face-font-family-alternatives | 2677 | @defopt face-font-family-alternatives |
| 2678 | If a given family is specified but does not exist, this variable | 2678 | If a given family is specified but does not exist, this variable |
| 2679 | specifies alternative font families to try. Each element should have | 2679 | specifies alternative font families to try. Each element should have |
| 2680 | this form: | 2680 | this form: |
| @@ -2686,9 +2686,9 @@ this form: | |||
| 2686 | If @var{family} is specified but not available, Emacs will try the other | 2686 | If @var{family} is specified but not available, Emacs will try the other |
| 2687 | families given in @var{alternate-families}, one by one, until it finds a | 2687 | families given in @var{alternate-families}, one by one, until it finds a |
| 2688 | family that does exist. | 2688 | family that does exist. |
| 2689 | @end defvar | 2689 | @end defopt |
| 2690 | 2690 | ||
| 2691 | @defvar face-font-selection-order | 2691 | @defopt face-font-selection-order |
| 2692 | If there is no font that exactly matches all desired face attributes | 2692 | If there is no font that exactly matches all desired face attributes |
| 2693 | (@code{:width}, @code{:height}, @code{:weight}, and @code{:slant}), | 2693 | (@code{:width}, @code{:height}, @code{:weight}, and @code{:slant}), |
| 2694 | this variable specifies the order in which these attributes should be | 2694 | 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 | |||
| 2714 | default one. But if you put @code{:slant} before @code{:height}, the | 2714 | default one. But if you put @code{:slant} before @code{:height}, the |
| 2715 | @code{italic} face will use an italic font, even if its height is not | 2715 | @code{italic} face will use an italic font, even if its height is not |
| 2716 | quite right. | 2716 | quite right. |
| 2717 | @end defvar | 2717 | @end defopt |
| 2718 | 2718 | ||
| 2719 | @defvar face-font-registry-alternatives | 2719 | @defopt face-font-registry-alternatives |
| 2720 | This variable lets you specify alternative font registries to try, if a | 2720 | This variable lets you specify alternative font registries to try, if a |
| 2721 | given registry is specified and doesn't exist. Each element should have | 2721 | given registry is specified and doesn't exist. Each element should have |
| 2722 | this form: | 2722 | this form: |
| @@ -2728,12 +2728,12 @@ this form: | |||
| 2728 | If @var{registry} is specified but not available, Emacs will try the | 2728 | If @var{registry} is specified but not available, Emacs will try the |
| 2729 | other registries given in @var{alternate-registries}, one by one, | 2729 | other registries given in @var{alternate-registries}, one by one, |
| 2730 | until it finds a registry that does exist. | 2730 | until it finds a registry that does exist. |
| 2731 | @end defvar | 2731 | @end defopt |
| 2732 | 2732 | ||
| 2733 | Emacs can make use of scalable fonts, but by default it does not use | 2733 | Emacs can make use of scalable fonts, but by default it does not use |
| 2734 | them. | 2734 | them. |
| 2735 | 2735 | ||
| 2736 | @defvar scalable-fonts-allowed | 2736 | @defopt scalable-fonts-allowed |
| 2737 | This variable controls which scalable fonts to use. A value of | 2737 | This variable controls which scalable fonts to use. A value of |
| 2738 | @code{nil}, the default, means do not use scalable fonts. @code{t} | 2738 | @code{nil}, the default, means do not use scalable fonts. @code{t} |
| 2739 | means to use any scalable font that seems appropriate for the text. | 2739 | means to use any scalable font that seems appropriate for the text. |
| @@ -2748,7 +2748,7 @@ expression in the list. For example, | |||
| 2748 | 2748 | ||
| 2749 | @noindent | 2749 | @noindent |
| 2750 | allows the use of scalable fonts with registry @code{muleindian-2}. | 2750 | allows the use of scalable fonts with registry @code{muleindian-2}. |
| 2751 | @end defvar | 2751 | @end defopt |
| 2752 | 2752 | ||
| 2753 | @defvar face-font-rescale-alist | 2753 | @defvar face-font-rescale-alist |
| 2754 | This variable specifies scaling for certain faces. Its value should | 2754 | This variable specifies scaling for certain faces. Its value should |
| @@ -3214,7 +3214,7 @@ displays. @xref{Fringes}. This variable is automatically | |||
| 3214 | buffer-local in every buffer. | 3214 | buffer-local in every buffer. |
| 3215 | @end defopt | 3215 | @end defopt |
| 3216 | 3216 | ||
| 3217 | @defvar indicate-buffer-boundaries | 3217 | @defopt indicate-buffer-boundaries |
| 3218 | This buffer-local variable controls how the buffer boundaries and | 3218 | This buffer-local variable controls how the buffer boundaries and |
| 3219 | window scrolling are indicated in the window fringes. | 3219 | window scrolling are indicated in the window fringes. |
| 3220 | 3220 | ||
| @@ -3250,7 +3250,7 @@ For example, @code{((top . left) (t . right))} places the top angle | |||
| 3250 | bitmap in left fringe, and the bottom angle bitmap as well as both | 3250 | bitmap in left fringe, and the bottom angle bitmap as well as both |
| 3251 | arrow bitmaps in right fringe. To show the angle bitmaps in the left | 3251 | arrow bitmaps in right fringe. To show the angle bitmaps in the left |
| 3252 | fringe, and no arrow bitmaps, use @code{((top . left) (bottom . left))}. | 3252 | fringe, and no arrow bitmaps, use @code{((top . left) (bottom . left))}. |
| 3253 | @end defvar | 3253 | @end defopt |
| 3254 | 3254 | ||
| 3255 | @defvar default-indicate-buffer-boundaries | 3255 | @defvar default-indicate-buffer-boundaries |
| 3256 | The value of this variable is the default value for | 3256 | 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 | |||
| 3345 | normal @code{hollow-rectangle} bitmap is too tall to fit on a specific | 3345 | normal @code{hollow-rectangle} bitmap is too tall to fit on a specific |
| 3346 | display line. | 3346 | display line. |
| 3347 | 3347 | ||
| 3348 | @defvar overflow-newline-into-fringe | 3348 | @defopt overflow-newline-into-fringe |
| 3349 | If this is non-@code{nil}, lines exactly as wide as the window (not | 3349 | If this is non-@code{nil}, lines exactly as wide as the window (not |
| 3350 | counting the final newline character) are not continued. Instead, | 3350 | counting the final newline character) are not continued. Instead, |
| 3351 | when point is at the end of the line, the cursor appears in the right | 3351 | when point is at the end of the line, the cursor appears in the right |
| 3352 | fringe. | 3352 | fringe. |
| 3353 | @end defvar | 3353 | @end defopt |
| 3354 | 3354 | ||
| 3355 | @defvar fringe-cursor-alist | 3355 | @defvar fringe-cursor-alist |
| 3356 | This variable specifies the mapping from logical cursor type to the | 3356 | 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 | |||
| 3587 | window take note of the new values by calling @code{set-window-buffer} | 3587 | window take note of the new values by calling @code{set-window-buffer} |
| 3588 | specifying the same buffer that is already displayed. | 3588 | specifying the same buffer that is already displayed. |
| 3589 | 3589 | ||
| 3590 | @defvar scroll-bar-mode | 3590 | @defopt scroll-bar-mode |
| 3591 | This variable, always local in all buffers, controls whether and where | 3591 | This variable, always local in all buffers, controls whether and where |
| 3592 | to put scroll bars in windows displaying the buffer. The possible values | 3592 | to put scroll bars in windows displaying the buffer. The possible values |
| 3593 | are @code{nil} for no scroll bar, @code{left} to put a scroll bar on | 3593 | are @code{nil} for no scroll bar, @code{left} to put a scroll bar on |
| 3594 | the left, and @code{right} to put a scroll bar on the right. | 3594 | the left, and @code{right} to put a scroll bar on the right. |
| 3595 | @end defvar | 3595 | @end defopt |
| 3596 | 3596 | ||
| 3597 | @defun window-current-scroll-bars &optional window | 3597 | @defun window-current-scroll-bars &optional window |
| 3598 | This function reports the scroll bar type for window @var{window}. | 3598 | This function reports the scroll bar type for window @var{window}. |
diff --git a/doc/lispref/eval.texi b/doc/lispref/eval.texi index 81b5c27d942..7e470055b77 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. | |||
| 672 | @code{eval-current-buffer} is an alias for this command. | 672 | @code{eval-current-buffer} is an alias for this command. |
| 673 | @end deffn | 673 | @end deffn |
| 674 | 674 | ||
| 675 | @defvar max-lisp-eval-depth | 675 | @defopt max-lisp-eval-depth |
| 676 | @anchor{Definition of max-lisp-eval-depth} | 676 | @anchor{Definition of max-lisp-eval-depth} |
| 677 | This variable defines the maximum depth allowed in calls to @code{eval}, | 677 | This variable defines the maximum depth allowed in calls to @code{eval}, |
| 678 | @code{apply}, and @code{funcall} before an error is signaled (with error | 678 | @code{apply}, and @code{funcall} before an error is signaled (with error |
| @@ -697,7 +697,7 @@ execute. | |||
| 697 | 697 | ||
| 698 | @code{max-specpdl-size} provides another limit on nesting. | 698 | @code{max-specpdl-size} provides another limit on nesting. |
| 699 | @xref{Definition of max-specpdl-size,, Local Variables}. | 699 | @xref{Definition of max-specpdl-size,, Local Variables}. |
| 700 | @end defvar | 700 | @end defopt |
| 701 | 701 | ||
| 702 | @defvar values | 702 | @defvar values |
| 703 | The value of this variable is a list of the values returned by all the | 703 | 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 cd1ee68f56e..4cf715f6fc3 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 | |||
| 203 | and never treat wildcard characters specially. | 203 | and never treat wildcard characters specially. |
| 204 | @end defopt | 204 | @end defopt |
| 205 | 205 | ||
| 206 | @defvar find-file-hook | 206 | @defopt find-file-hook |
| 207 | The value of this variable is a list of functions to be called after a | 207 | The value of this variable is a list of functions to be called after a |
| 208 | file is visited. The file's local-variables specification (if any) will | 208 | file is visited. The file's local-variables specification (if any) will |
| 209 | have been processed before the hooks are run. The buffer visiting the | 209 | have been processed before the hooks are run. The buffer visiting the |
| 210 | file is current when the hook functions are run. | 210 | file is current when the hook functions are run. |
| 211 | 211 | ||
| 212 | This variable is a normal hook. @xref{Hooks}. | 212 | This variable is a normal hook. @xref{Hooks}. |
| 213 | @end defvar | 213 | @end defopt |
| 214 | 214 | ||
| 215 | @defvar find-file-not-found-functions | 215 | @defvar find-file-not-found-functions |
| 216 | The value of this variable is a list of functions to be called when | 216 | 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 | |||
| 1914 | name as an abbreviation for the ``real'' name, Emacs shows users the | 1914 | name as an abbreviation for the ``real'' name, Emacs shows users the |
| 1915 | abbreviation instead. | 1915 | abbreviation instead. |
| 1916 | 1916 | ||
| 1917 | @defvar directory-abbrev-alist | 1917 | @defopt directory-abbrev-alist |
| 1918 | The variable @code{directory-abbrev-alist} contains an alist of | 1918 | The variable @code{directory-abbrev-alist} contains an alist of |
| 1919 | abbreviations to use for file directories. Each element has the form | 1919 | abbreviations to use for file directories. Each element has the form |
| 1920 | @code{(@var{from} . @var{to})}, and says to replace @var{from} with | 1920 | @code{(@var{from} . @var{to})}, and says to replace @var{from} with |
| @@ -1936,7 +1936,7 @@ and so on. | |||
| 1936 | ("^/home/gp" . "/gp") | 1936 | ("^/home/gp" . "/gp") |
| 1937 | ("^/home/gd" . "/gd")) | 1937 | ("^/home/gd" . "/gd")) |
| 1938 | @end example | 1938 | @end example |
| 1939 | @end defvar | 1939 | @end defopt |
| 1940 | 1940 | ||
| 1941 | To convert a directory name to its abbreviation, use this | 1941 | To convert a directory name to its abbreviation, use this |
| 1942 | function: | 1942 | function: |
| @@ -2186,7 +2186,7 @@ should be an absolute file name. On MS-DOS, this function can | |||
| 2186 | truncate the @var{string} prefix to fit into the 8+3 file-name limits. | 2186 | truncate the @var{string} prefix to fit into the 8+3 file-name limits. |
| 2187 | @end defun | 2187 | @end defun |
| 2188 | 2188 | ||
| 2189 | @defvar temporary-file-directory | 2189 | @defopt temporary-file-directory |
| 2190 | @cindex @code{TMPDIR} environment variable | 2190 | @cindex @code{TMPDIR} environment variable |
| 2191 | @cindex @code{TMP} environment variable | 2191 | @cindex @code{TMP} environment variable |
| 2192 | @cindex @code{TEMP} environment variable | 2192 | @cindex @code{TEMP} environment variable |
| @@ -2206,9 +2206,9 @@ file, you should still use this variable to decide which directory to | |||
| 2206 | put the file in. However, if you expect the file to be small, you | 2206 | put the file in. However, if you expect the file to be small, you |
| 2207 | should use @code{small-temporary-file-directory} first if that is | 2207 | should use @code{small-temporary-file-directory} first if that is |
| 2208 | non-@code{nil}. | 2208 | non-@code{nil}. |
| 2209 | @end defvar | 2209 | @end defopt |
| 2210 | 2210 | ||
| 2211 | @defvar small-temporary-file-directory | 2211 | @defopt small-temporary-file-directory |
| 2212 | This variable specifies the directory name for | 2212 | This variable specifies the directory name for |
| 2213 | creating certain temporary files, which are likely to be small. | 2213 | creating certain temporary files, which are likely to be small. |
| 2214 | 2214 | ||
| @@ -2221,7 +2221,7 @@ should compute the directory like this: | |||
| 2221 | (or small-temporary-file-directory | 2221 | (or small-temporary-file-directory |
| 2222 | temporary-file-directory))) | 2222 | temporary-file-directory))) |
| 2223 | @end example | 2223 | @end example |
| 2224 | @end defvar | 2224 | @end defopt |
| 2225 | 2225 | ||
| 2226 | @node File Name Completion | 2226 | @node File Name Completion |
| 2227 | @subsection File Name Completion | 2227 | @subsection File Name Completion |
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index d1370ad2577..548e6e8e501 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi | |||
| @@ -398,7 +398,7 @@ parameter values to frames that will be created henceforth. | |||
| 398 | You can specify the parameters for the initial startup frame | 398 | You can specify the parameters for the initial startup frame |
| 399 | by setting @code{initial-frame-alist} in your init file (@pxref{Init File}). | 399 | by setting @code{initial-frame-alist} in your init file (@pxref{Init File}). |
| 400 | 400 | ||
| 401 | @defvar initial-frame-alist | 401 | @defopt initial-frame-alist |
| 402 | This variable's value is an alist of parameter values used when creating | 402 | This variable's value is an alist of parameter values used when creating |
| 403 | the initial window frame. You can set this variable to specify the | 403 | the initial window frame. You can set this variable to specify the |
| 404 | appearance of the initial frame without altering subsequent frames. | 404 | appearance of the initial frame without altering subsequent frames. |
| @@ -426,27 +426,27 @@ this. Specify parameters in @code{default-frame-alist} to override the | |||
| 426 | X resources for subsequent frames; then, to prevent these from affecting | 426 | X resources for subsequent frames; then, to prevent these from affecting |
| 427 | the initial frame, specify the same parameters in | 427 | the initial frame, specify the same parameters in |
| 428 | @code{initial-frame-alist} with values that match the X resources. | 428 | @code{initial-frame-alist} with values that match the X resources. |
| 429 | @end defvar | 429 | @end defopt |
| 430 | 430 | ||
| 431 | If these parameters specify a separate minibuffer-only frame with | 431 | If these parameters specify a separate minibuffer-only frame with |
| 432 | @code{(minibuffer . nil)}, and you have not created one, Emacs creates | 432 | @code{(minibuffer . nil)}, and you have not created one, Emacs creates |
| 433 | one for you. | 433 | one for you. |
| 434 | 434 | ||
| 435 | @defvar minibuffer-frame-alist | 435 | @defopt minibuffer-frame-alist |
| 436 | This variable's value is an alist of parameter values used when | 436 | This variable's value is an alist of parameter values used when |
| 437 | creating an initial minibuffer-only frame. This is the | 437 | creating an initial minibuffer-only frame. This is the |
| 438 | minibuffer-only frame that Emacs creates if @code{initial-frame-alist} | 438 | minibuffer-only frame that Emacs creates if @code{initial-frame-alist} |
| 439 | specifies a frame with no minibuffer. | 439 | specifies a frame with no minibuffer. |
| 440 | @end defvar | 440 | @end defopt |
| 441 | 441 | ||
| 442 | @defvar default-frame-alist | 442 | @defopt default-frame-alist |
| 443 | This is an alist specifying default values of frame parameters for all | 443 | This is an alist specifying default values of frame parameters for all |
| 444 | Emacs frames---the first frame, and subsequent frames. When using the X | 444 | Emacs frames---the first frame, and subsequent frames. When using the X |
| 445 | Window System, you can get the same results by means of X resources | 445 | Window System, you can get the same results by means of X resources |
| 446 | in many cases. | 446 | in many cases. |
| 447 | 447 | ||
| 448 | Setting this variable does not affect existing frames. | 448 | Setting this variable does not affect existing frames. |
| 449 | @end defvar | 449 | @end defopt |
| 450 | 450 | ||
| 451 | Functions that display a buffer in a separate frame can override the | 451 | Functions that display a buffer in a separate frame can override the |
| 452 | default parameters by supplying their own parameters. @xref{Definition | 452 | default parameters by supplying their own parameters. @xref{Definition |
| @@ -793,7 +793,7 @@ The buffer-local variable @code{cursor-type} overrides the value of | |||
| 793 | the @code{cursor-type} frame parameter, but if it is @code{t}, that | 793 | the @code{cursor-type} frame parameter, but if it is @code{t}, that |
| 794 | means to use the cursor specified for the frame. | 794 | means to use the cursor specified for the frame. |
| 795 | 795 | ||
| 796 | @defvar blink-cursor-alist | 796 | @defopt blink-cursor-alist |
| 797 | This variable specifies how to blink the cursor. Each element has the | 797 | This variable specifies how to blink the cursor. Each element has the |
| 798 | form @code{(@var{on-state} . @var{off-state})}. Whenever the cursor | 798 | form @code{(@var{on-state} . @var{off-state})}. Whenever the cursor |
| 799 | type equals @var{on-state} (comparing using @code{equal}), the | 799 | 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 | |||
| 805 | the type is not mentioned as an @var{on-state} here. Changes in this | 805 | the type is not mentioned as an @var{on-state} here. Changes in this |
| 806 | variable do not take effect immediately, only when you specify the | 806 | variable do not take effect immediately, only when you specify the |
| 807 | @code{cursor-type} frame parameter. | 807 | @code{cursor-type} frame parameter. |
| 808 | @end defvar | 808 | @end defopt |
| 809 | 809 | ||
| 810 | @defvar cursor-in-non-selected-windows | 810 | @defopt cursor-in-non-selected-windows |
| 811 | This variable controls how the cursor looks in a window that is not | 811 | This variable controls how the cursor looks in a window that is not |
| 812 | selected. It supports the same values as the @code{cursor-type} frame | 812 | selected. It supports the same values as the @code{cursor-type} frame |
| 813 | parameter; also, @code{nil} means don't display a cursor in | 813 | parameter; also, @code{nil} means don't display a cursor in |
| 814 | nonselected windows, and @code{t} (the default) means use a standard | 814 | nonselected windows, and @code{t} (the default) means use a standard |
| 815 | modificatoin of the usual cursor type (solid box becomes hollow box, | 815 | modificatoin of the usual cursor type (solid box becomes hollow box, |
| 816 | and bar becomes a narrower bar). | 816 | and bar becomes a narrower bar). |
| 817 | @end defvar | 817 | @end defopt |
| 818 | 818 | ||
| 819 | @node Font and Color Parameters | 819 | @node Font and Color Parameters |
| 820 | @subsubsection Font and Color Parameters | 820 | @subsubsection Font and Color Parameters |
| @@ -1926,12 +1926,12 @@ the first cut buffer moves into the second cut buffer, and the second to | |||
| 1926 | the third, and so on through all eight cut buffers. | 1926 | the third, and so on through all eight cut buffers. |
| 1927 | @end defun | 1927 | @end defun |
| 1928 | 1928 | ||
| 1929 | @defvar selection-coding-system | 1929 | @defopt selection-coding-system |
| 1930 | This variable specifies the coding system to use when reading and | 1930 | This variable specifies the coding system to use when reading and |
| 1931 | writing selections or the clipboard. @xref{Coding | 1931 | writing selections or the clipboard. @xref{Coding |
| 1932 | Systems}. The default is @code{compound-text-with-extensions}, which | 1932 | Systems}. The default is @code{compound-text-with-extensions}, which |
| 1933 | converts to the text representation that X11 normally uses. | 1933 | converts to the text representation that X11 normally uses. |
| 1934 | @end defvar | 1934 | @end defopt |
| 1935 | 1935 | ||
| 1936 | @cindex clipboard support (for MS-Windows) | 1936 | @cindex clipboard support (for MS-Windows) |
| 1937 | When Emacs runs on MS-Windows, it does not implement X selections in | 1937 | 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, | |||
| 2327 | or @code{nil} if Emacs cannot get that information. | 2327 | or @code{nil} if Emacs cannot get that information. |
| 2328 | @end defun | 2328 | @end defun |
| 2329 | 2329 | ||
| 2330 | @defvar display-mm-dimensions-alist | 2330 | @defopt display-mm-dimensions-alist |
| 2331 | This variable allows the user to specify the dimensions of graphical | 2331 | This variable allows the user to specify the dimensions of graphical |
| 2332 | displays returned by @code{display-mm-height} and | 2332 | displays returned by @code{display-mm-height} and |
| 2333 | @code{display-mm-width} in case the system provides incorrect values. | 2333 | @code{display-mm-width} in case the system provides incorrect values. |
| 2334 | @end defvar | 2334 | @end defopt |
| 2335 | 2335 | ||
| 2336 | @defun display-backing-store &optional display | 2336 | @defun display-backing-store &optional display |
| 2337 | This function returns the backing store capability of the display. | 2337 | This function returns the backing store capability of the display. |
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index b6210da7f99..19fa348463a 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi | |||
| @@ -557,7 +557,7 @@ follows: | |||
| 557 | @end smallexample | 557 | @end smallexample |
| 558 | @end deffn | 558 | @end deffn |
| 559 | 559 | ||
| 560 | @defvar help-char | 560 | @defopt help-char |
| 561 | The value of this variable is the help character---the character that | 561 | The value of this variable is the help character---the character that |
| 562 | Emacs recognizes as meaning Help. By default, its value is 8, which | 562 | Emacs recognizes as meaning Help. By default, its value is 8, which |
| 563 | stands for @kbd{C-h}. When Emacs reads this character, if | 563 | 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 | |||
| 574 | binding as a subcommand of the prefix key, it runs | 574 | binding as a subcommand of the prefix key, it runs |
| 575 | @code{describe-prefix-bindings}, which displays a list of all the | 575 | @code{describe-prefix-bindings}, which displays a list of all the |
| 576 | subcommands of the prefix key. | 576 | subcommands of the prefix key. |
| 577 | @end defvar | 577 | @end defopt |
| 578 | 578 | ||
| 579 | @defvar help-event-list | 579 | @defopt help-event-list |
| 580 | The value of this variable is a list of event types that serve as | 580 | The value of this variable is a list of event types that serve as |
| 581 | alternative ``help characters.'' These events are handled just like the | 581 | alternative ``help characters.'' These events are handled just like the |
| 582 | event specified by @code{help-char}. | 582 | event specified by @code{help-char}. |
| 583 | @end defvar | 583 | @end defopt |
| 584 | 584 | ||
| 585 | @defvar help-form | 585 | @defvar help-form |
| 586 | If this variable is non-@code{nil}, its value is a form to evaluate | 586 | 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 de792c76e9f..4afe5e55d82 100644 --- a/doc/lispref/keymaps.texi +++ b/doc/lispref/keymaps.texi | |||
| @@ -1179,7 +1179,7 @@ The argument @var{accept-defaults} controls checking for default | |||
| 1179 | bindings, as in @code{lookup-key} (above). | 1179 | bindings, as in @code{lookup-key} (above). |
| 1180 | @end defun | 1180 | @end defun |
| 1181 | 1181 | ||
| 1182 | @defvar meta-prefix-char | 1182 | @defopt meta-prefix-char |
| 1183 | @cindex @key{ESC} | 1183 | @cindex @key{ESC} |
| 1184 | This variable is the meta-prefix character code. It is used for | 1184 | This variable is the meta-prefix character code. It is used for |
| 1185 | translating a meta character to a two-character sequence so it can be | 1185 | translating a meta character to a two-character sequence so it can be |
| @@ -1225,7 +1225,7 @@ meta-prefix-char ; @r{The default value.} | |||
| 1225 | This translation of one event into two happens only for characters, not | 1225 | This translation of one event into two happens only for characters, not |
| 1226 | for other kinds of input events. Thus, @kbd{M-@key{F1}}, a function | 1226 | for other kinds of input events. Thus, @kbd{M-@key{F1}}, a function |
| 1227 | key, is not converted into @kbd{@key{ESC} @key{F1}}. | 1227 | key, is not converted into @kbd{@key{ESC} @key{F1}}. |
| 1228 | @end defvar | 1228 | @end defopt |
| 1229 | 1229 | ||
| 1230 | @node Changing Key Bindings | 1230 | @node Changing Key Bindings |
| 1231 | @section Changing Key Bindings | 1231 | @section Changing Key Bindings |
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi index f35978d244f..dbc4c0da33d 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 | |||
| 508 | set to a non-@code{nil} value. | 508 | set to a non-@code{nil} value. |
| 509 | @end defvar | 509 | @end defvar |
| 510 | 510 | ||
| 511 | @defvar history-length | 511 | @defopt history-length |
| 512 | The value of this variable specifies the maximum length for all | 512 | The value of this variable specifies the maximum length for all |
| 513 | history lists that don't specify their own maximum lengths. If the | 513 | history lists that don't specify their own maximum lengths. If the |
| 514 | value is @code{t}, that means there no maximum (don't delete old | 514 | value is @code{t}, that means there no maximum (don't delete old |
| 515 | elements). The value of @code{history-length} property of the history | 515 | elements). The value of @code{history-length} property of the history |
| 516 | list variable's symbol, if set, overrides this variable for that | 516 | list variable's symbol, if set, overrides this variable for that |
| 517 | particular history list. | 517 | particular history list. |
| 518 | @end defvar | 518 | @end defopt |
| 519 | 519 | ||
| 520 | @defvar history-delete-duplicates | 520 | @defopt history-delete-duplicates |
| 521 | If the value of this variable is @code{t}, that means when adding a | 521 | If the value of this variable is @code{t}, that means when adding a |
| 522 | new history element, all previous identical elements are deleted. | 522 | new history element, all previous identical elements are deleted. |
| 523 | @end defvar | 523 | @end defopt |
| 524 | 524 | ||
| 525 | Here are some of the standard minibuffer history list variables: | 525 | Here are some of the standard minibuffer history list variables: |
| 526 | 526 | ||
| @@ -1188,17 +1188,17 @@ Buffer name (default foo): @point{} | |||
| 1188 | @end example | 1188 | @end example |
| 1189 | @end defun | 1189 | @end defun |
| 1190 | 1190 | ||
| 1191 | @defvar read-buffer-function | 1191 | @defopt read-buffer-function |
| 1192 | This variable specifies how to read buffer names. For example, if you | 1192 | This variable specifies how to read buffer names. For example, if you |
| 1193 | set this variable to @code{iswitchb-read-buffer}, all Emacs commands | 1193 | set this variable to @code{iswitchb-read-buffer}, all Emacs commands |
| 1194 | that call @code{read-buffer} to read a buffer name will actually use the | 1194 | that call @code{read-buffer} to read a buffer name will actually use the |
| 1195 | @code{iswitchb} package to read it. | 1195 | @code{iswitchb} package to read it. |
| 1196 | @end defvar | 1196 | @end defopt |
| 1197 | 1197 | ||
| 1198 | @defvar read-buffer-completion-ignore-case | 1198 | @defopt read-buffer-completion-ignore-case |
| 1199 | If this variable is non-@code{nil}, @code{read-buffer} ignores case | 1199 | If this variable is non-@code{nil}, @code{read-buffer} ignores case |
| 1200 | when performing completion. | 1200 | when performing completion. |
| 1201 | @end defvar | 1201 | @end defopt |
| 1202 | 1202 | ||
| 1203 | @defun read-command prompt &optional default | 1203 | @defun read-command prompt &optional default |
| 1204 | This function reads the name of a command and returns it as a Lisp | 1204 | 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 | |||
| 1442 | doing its usual work. | 1442 | doing its usual work. |
| 1443 | @end defvar | 1443 | @end defvar |
| 1444 | 1444 | ||
| 1445 | @defvar read-file-name-completion-ignore-case | 1445 | @defopt read-file-name-completion-ignore-case |
| 1446 | If this variable is non-@code{nil}, @code{read-file-name} ignores case | 1446 | If this variable is non-@code{nil}, @code{read-file-name} ignores case |
| 1447 | when performing completion. | 1447 | when performing completion. |
| 1448 | @end defvar | 1448 | @end defopt |
| 1449 | 1449 | ||
| 1450 | @defun read-directory-name prompt &optional directory default require-match initial | 1450 | @defun read-directory-name prompt &optional directory default require-match initial |
| 1451 | This function is like @code{read-file-name} but allows only directory | 1451 | 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 af20bed18b5..b4866fd7d75 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")}. | |||
| 1714 | The variable in overall control of the mode line is | 1714 | The variable in overall control of the mode line is |
| 1715 | @code{mode-line-format}. | 1715 | @code{mode-line-format}. |
| 1716 | 1716 | ||
| 1717 | @defvar mode-line-format | 1717 | @defopt mode-line-format |
| 1718 | The value of this variable is a mode-line construct that controls the | 1718 | The value of this variable is a mode-line construct that controls the |
| 1719 | contents of the mode-line. It is always buffer-local in all buffers. | 1719 | contents of the mode-line. It is always buffer-local in all buffers. |
| 1720 | 1720 | ||
| 1721 | If you set this variable to @code{nil} in a buffer, that buffer does | 1721 | If you set this variable to @code{nil} in a buffer, that buffer does |
| 1722 | not have a mode line. (A window that is just one line tall never | 1722 | not have a mode line. (A window that is just one line tall never |
| 1723 | displays a mode line.) | 1723 | displays a mode line.) |
| 1724 | @end defvar | 1724 | @end defopt |
| 1725 | 1725 | ||
| 1726 | The default value of @code{mode-line-format} is designed to use the | 1726 | The default value of @code{mode-line-format} is designed to use the |
| 1727 | values of other variables such as @code{mode-line-position} and | 1727 | 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 | |||
| 1821 | least 12 columns. | 1821 | least 12 columns. |
| 1822 | @end defvar | 1822 | @end defvar |
| 1823 | 1823 | ||
| 1824 | @defvar mode-line-position | 1824 | @defopt mode-line-position |
| 1825 | This variable indicates the position in the buffer. Its default value | 1825 | This variable indicates the position in the buffer. Its default value |
| 1826 | displays the buffer percentage and, optionally, the buffer size, the | 1826 | displays the buffer percentage and, optionally, the buffer size, the |
| 1827 | line number and the column number. | 1827 | line number and the column number. |
| 1828 | @end defvar | 1828 | @end defopt |
| 1829 | 1829 | ||
| 1830 | @defvar vc-mode | 1830 | @defvar vc-mode |
| 1831 | The variable @code{vc-mode}, buffer-local in each buffer, records | 1831 | 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 | |||
| 1834 | line, or @code{nil} for no version control. | 1834 | line, or @code{nil} for no version control. |
| 1835 | @end defvar | 1835 | @end defvar |
| 1836 | 1836 | ||
| 1837 | @defvar mode-line-modes | 1837 | @defopt mode-line-modes |
| 1838 | This variable displays the buffer's major and minor modes. Its | 1838 | This variable displays the buffer's major and minor modes. Its |
| 1839 | default value also displays the recursive editing level, information | 1839 | default value also displays the recursive editing level, information |
| 1840 | on the process status, and whether narrowing is in effect. | 1840 | on the process status, and whether narrowing is in effect. |
| 1841 | @end defvar | 1841 | @end defopt |
| 1842 | 1842 | ||
| 1843 | The following three variables are used in @code{mode-line-modes}: | 1843 | The following three variables are used in @code{mode-line-modes}: |
| 1844 | 1844 | ||
diff --git a/doc/lispref/nonascii.texi b/doc/lispref/nonascii.texi index 588cac337d7..9f8df7c77f2 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. | |||
| 95 | The representation for a string is determined and recorded in the string | 95 | The representation for a string is determined and recorded in the string |
| 96 | when the string is constructed. | 96 | when the string is constructed. |
| 97 | 97 | ||
| 98 | @defvar enable-multibyte-characters | 98 | @defopt enable-multibyte-characters |
| 99 | This variable specifies the current buffer's text representation. | 99 | This variable specifies the current buffer's text representation. |
| 100 | If it is non-@code{nil}, the buffer contains multibyte text; otherwise, | 100 | If it is non-@code{nil}, the buffer contains multibyte text; otherwise, |
| 101 | it contains unibyte encoded text or binary non-text data. | 101 | it contains unibyte encoded text or binary non-text data. |
| 102 | 102 | ||
| 103 | You cannot set this variable directly; instead, use the function | 103 | You cannot set this variable directly; instead, use the function |
| 104 | @code{set-buffer-multibyte} to change a buffer's representation. | 104 | @code{set-buffer-multibyte} to change a buffer's representation. |
| 105 | @end defvar | 105 | @end defopt |
| 106 | 106 | ||
| 107 | @defvar default-enable-multibyte-characters | 107 | @defvar default-enable-multibyte-characters |
| 108 | This variable's value is entirely equivalent to @code{(default-value | 108 | This variable's value is entirely equivalent to @code{(default-value |
| @@ -1289,7 +1289,7 @@ don't change these variables; instead, override them using | |||
| 1289 | (@pxref{Specifying Coding Systems}). | 1289 | (@pxref{Specifying Coding Systems}). |
| 1290 | 1290 | ||
| 1291 | @cindex file contents, and default coding system | 1291 | @cindex file contents, and default coding system |
| 1292 | @defvar auto-coding-regexp-alist | 1292 | @defopt auto-coding-regexp-alist |
| 1293 | This variable is an alist of text patterns and corresponding coding | 1293 | This variable is an alist of text patterns and corresponding coding |
| 1294 | systems. Each element has the form @code{(@var{regexp} | 1294 | systems. Each element has the form @code{(@var{regexp} |
| 1295 | . @var{coding-system})}; a file whose first few kilobytes match | 1295 | . @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 | |||
| 1299 | @code{file-coding-system-alist} (see below). The default value is set | 1299 | @code{file-coding-system-alist} (see below). The default value is set |
| 1300 | so that Emacs automatically recognizes mail files in Babyl format and | 1300 | so that Emacs automatically recognizes mail files in Babyl format and |
| 1301 | reads them with no code conversions. | 1301 | reads them with no code conversions. |
| 1302 | @end defvar | 1302 | @end defopt |
| 1303 | 1303 | ||
| 1304 | @cindex file name, and default coding system | 1304 | @cindex file name, and default coding system |
| 1305 | @defvar file-coding-system-alist | 1305 | @defopt file-coding-system-alist |
| 1306 | This variable is an alist that specifies the coding systems to use for | 1306 | This variable is an alist that specifies the coding systems to use for |
| 1307 | reading and writing particular files. Each element has the form | 1307 | reading and writing particular files. Each element has the form |
| 1308 | @code{(@var{pattern} . @var{coding})}, where @var{pattern} is a regular | 1308 | @code{(@var{pattern} . @var{coding})}, where @var{pattern} is a regular |
| @@ -1325,14 +1325,14 @@ meaning as described above. | |||
| 1325 | 1325 | ||
| 1326 | If @var{coding} (or what returned by the above function) is | 1326 | If @var{coding} (or what returned by the above function) is |
| 1327 | @code{undecided}, the normal code-detection is performed. | 1327 | @code{undecided}, the normal code-detection is performed. |
| 1328 | @end defvar | 1328 | @end defopt |
| 1329 | 1329 | ||
| 1330 | @defvar auto-coding-alist | 1330 | @defopt auto-coding-alist |
| 1331 | This variable is an alist that specifies the coding systems to use for | 1331 | This variable is an alist that specifies the coding systems to use for |
| 1332 | reading and writing particular files. Its form is like that of | 1332 | reading and writing particular files. Its form is like that of |
| 1333 | @code{file-coding-system-alist}, but, unlike the latter, this variable | 1333 | @code{file-coding-system-alist}, but, unlike the latter, this variable |
| 1334 | takes priority over any @code{coding:} tags in the file. | 1334 | takes priority over any @code{coding:} tags in the file. |
| 1335 | @end defvar | 1335 | @end defopt |
| 1336 | 1336 | ||
| 1337 | @cindex program name, and default coding system | 1337 | @cindex program name, and default coding system |
| 1338 | @defvar process-coding-system-alist | 1338 | @defvar process-coding-system-alist |
| @@ -1380,7 +1380,7 @@ the subprocess, and @var{output-coding} applies to output to it. | |||
| 1380 | @end defvar | 1380 | @end defvar |
| 1381 | 1381 | ||
| 1382 | @cindex default coding system, functions to determine | 1382 | @cindex default coding system, functions to determine |
| 1383 | @defvar auto-coding-functions | 1383 | @defopt auto-coding-functions |
| 1384 | This variable holds a list of functions that try to determine a | 1384 | This variable holds a list of functions that try to determine a |
| 1385 | coding system for a file based on its undecoded contents. | 1385 | coding system for a file based on its undecoded contents. |
| 1386 | 1386 | ||
| @@ -1394,7 +1394,7 @@ Otherwise, it should return @code{nil}. | |||
| 1394 | 1394 | ||
| 1395 | If a file has a @samp{coding:} tag, that takes precedence, so these | 1395 | If a file has a @samp{coding:} tag, that takes precedence, so these |
| 1396 | functions won't be called. | 1396 | functions won't be called. |
| 1397 | @end defvar | 1397 | @end defopt |
| 1398 | 1398 | ||
| 1399 | @defun find-auto-coding filename size | 1399 | @defun find-auto-coding filename size |
| 1400 | This function tries to determine a suitable coding system for | 1400 | 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 | |||
| 1521 | affect it. | 1521 | affect it. |
| 1522 | @end defvar | 1522 | @end defvar |
| 1523 | 1523 | ||
| 1524 | @defvar inhibit-eol-conversion | 1524 | @defopt inhibit-eol-conversion |
| 1525 | When this variable is non-@code{nil}, no end-of-line conversion is done, | 1525 | When this variable is non-@code{nil}, no end-of-line conversion is done, |
| 1526 | no matter which coding system is specified. This applies to all the | 1526 | no matter which coding system is specified. This applies to all the |
| 1527 | Emacs I/O and subprocess primitives, and to the explicit encoding and | 1527 | Emacs I/O and subprocess primitives, and to the explicit encoding and |
| 1528 | decoding functions (@pxref{Explicit Encoding}). | 1528 | decoding functions (@pxref{Explicit Encoding}). |
| 1529 | @end defvar | 1529 | @end defopt |
| 1530 | 1530 | ||
| 1531 | @cindex priority order of coding systems | 1531 | @cindex priority order of coding systems |
| 1532 | @cindex coding systems, priority | 1532 | @cindex coding systems, priority |
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index a97aef4016d..07ae1a0868e 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 | |||
| 279 | loads this @emph{before} the user's init file. You can inhibit the | 279 | loads this @emph{before} the user's init file. You can inhibit the |
| 280 | loading of this file with the option @samp{--no-site-file}. | 280 | loading of this file with the option @samp{--no-site-file}. |
| 281 | 281 | ||
| 282 | @defvar site-run-file | 282 | @defopt site-run-file |
| 283 | This variable specifies the site-customization file to load before the | 283 | This variable specifies the site-customization file to load before the |
| 284 | user's init file. Its normal value is @code{"site-start"}. The only | 284 | user's init file. Its normal value is @code{"site-start"}. The only |
| 285 | way you can change it with real effect is to do so before dumping | 285 | way you can change it with real effect is to do so before dumping |
| 286 | Emacs. | 286 | Emacs. |
| 287 | @end defvar | 287 | @end defopt |
| 288 | 288 | ||
| 289 | @xref{Init Examples,, Init File Examples, emacs, The GNU Emacs Manual}, for | 289 | @xref{Init Examples,, Init File Examples, emacs, The GNU Emacs Manual}, for |
| 290 | examples of how to make various commonly desired customizations in your | 290 | examples of how to make various commonly desired customizations in your |
| @@ -821,14 +821,14 @@ fact, the function returns whatever value the variable | |||
| 821 | system. The variable is also useful for constructing frame titles | 821 | system. The variable is also useful for constructing frame titles |
| 822 | (@pxref{Frame Titles}). | 822 | (@pxref{Frame Titles}). |
| 823 | 823 | ||
| 824 | @defvar mail-host-address | 824 | @defopt mail-host-address |
| 825 | If this variable is non-@code{nil}, it is used instead of | 825 | If this variable is non-@code{nil}, it is used instead of |
| 826 | @code{system-name} for purposes of generating email addresses. For | 826 | @code{system-name} for purposes of generating email addresses. For |
| 827 | example, it is used when constructing the default value of | 827 | example, it is used when constructing the default value of |
| 828 | @code{user-mail-address}. @xref{User Identification}. (Since this is | 828 | @code{user-mail-address}. @xref{User Identification}. (Since this is |
| 829 | done when Emacs starts up, the value actually used is the one saved when | 829 | done when Emacs starts up, the value actually used is the one saved when |
| 830 | Emacs was dumped. @xref{Building Emacs}.) | 830 | Emacs was dumped. @xref{Building Emacs}.) |
| 831 | @end defvar | 831 | @end defopt |
| 832 | 832 | ||
| 833 | @deffn Command getenv var &optional frame | 833 | @deffn Command getenv var &optional frame |
| 834 | @cindex environment variable access | 834 | @cindex environment variable access |
| @@ -1009,13 +1009,13 @@ option was used, then Lisp packages should not load any customization | |||
| 1009 | files or user profile. | 1009 | files or user profile. |
| 1010 | @end defvar | 1010 | @end defvar |
| 1011 | 1011 | ||
| 1012 | @defvar user-mail-address | 1012 | @defopt user-mail-address |
| 1013 | This holds the nominal email address of the user who is using Emacs. | 1013 | This holds the nominal email address of the user who is using Emacs. |
| 1014 | Emacs normally sets this variable to a default value after reading your | 1014 | Emacs normally sets this variable to a default value after reading your |
| 1015 | init files, but not if you have already set it. So you can set the | 1015 | init files, but not if you have already set it. So you can set the |
| 1016 | variable to some other value in your init file if you do not | 1016 | variable to some other value in your init file if you do not |
| 1017 | want to use the default value. | 1017 | want to use the default value. |
| 1018 | @end defvar | 1018 | @end defopt |
| 1019 | 1019 | ||
| 1020 | @defun user-login-name &optional uid | 1020 | @defun user-login-name &optional uid |
| 1021 | If you don't specify @var{uid}, this function returns the name under | 1021 | 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. | |||
| 1928 | track of output sent to the terminal. The variable @code{baud-rate} | 1928 | track of output sent to the terminal. The variable @code{baud-rate} |
| 1929 | tells you what Emacs thinks is the output speed of the terminal. | 1929 | tells you what Emacs thinks is the output speed of the terminal. |
| 1930 | 1930 | ||
| 1931 | @defvar baud-rate | 1931 | @defopt baud-rate |
| 1932 | This variable's value is the output speed of the terminal, as far as | 1932 | This variable's value is the output speed of the terminal, as far as |
| 1933 | Emacs knows. Setting this variable does not change the speed of actual | 1933 | Emacs knows. Setting this variable does not change the speed of actual |
| 1934 | data transmission, but the value is used for calculations such as | 1934 | data transmission, but the value is used for calculations such as |
| @@ -1939,7 +1939,7 @@ screen or repaint on text terminals. @xref{Forcing Redisplay}, | |||
| 1939 | for the corresponding functionality on graphical terminals. | 1939 | for the corresponding functionality on graphical terminals. |
| 1940 | 1940 | ||
| 1941 | The value is measured in baud. | 1941 | The value is measured in baud. |
| 1942 | @end defvar | 1942 | @end defopt |
| 1943 | 1943 | ||
| 1944 | If you are running across a network, and different parts of the | 1944 | If you are running across a network, and different parts of the |
| 1945 | network work at different baud rates, the value returned by Emacs may be | 1945 | 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 06b696ea3a4..d3c13a3eb08 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 | |||
| 220 | backward until encountering the front of a word, rather than forward. | 220 | backward until encountering the front of a word, rather than forward. |
| 221 | @end deffn | 221 | @end deffn |
| 222 | 222 | ||
| 223 | @defvar words-include-escapes | 223 | @defopt words-include-escapes |
| 224 | @c Emacs 19 feature | 224 | @c Emacs 19 feature |
| 225 | This variable affects the behavior of @code{forward-word} and everything | 225 | This variable affects the behavior of @code{forward-word} and everything |
| 226 | that uses it. If it is non-@code{nil}, then characters in the | 226 | that uses it. If it is non-@code{nil}, then characters in the |
| 227 | ``escape'' and ``character quote'' syntax classes count as part of | 227 | ``escape'' and ``character quote'' syntax classes count as part of |
| 228 | words. Otherwise, they do not. | 228 | words. Otherwise, they do not. |
| 229 | @end defvar | 229 | @end defopt |
| 230 | 230 | ||
| 231 | @defvar inhibit-field-text-motion | 231 | @defvar inhibit-field-text-motion |
| 232 | If this variable is non-@code{nil}, certain motion functions including | 232 | If this variable is non-@code{nil}, certain motion functions including |
diff --git a/doc/lispref/searching.texi b/doc/lispref/searching.texi index 3060980675d..146d00cfe16 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} | |||
| 1786 | This section describes some variables that hold regular expressions | 1786 | This section describes some variables that hold regular expressions |
| 1787 | used for certain purposes in editing: | 1787 | used for certain purposes in editing: |
| 1788 | 1788 | ||
| 1789 | @defvar page-delimiter | 1789 | @defopt page-delimiter |
| 1790 | This is the regular expression describing line-beginnings that separate | 1790 | This is the regular expression describing line-beginnings that separate |
| 1791 | pages. The default value is @code{"^\014"} (i.e., @code{"^^L"} or | 1791 | pages. The default value is @code{"^\014"} (i.e., @code{"^^L"} or |
| 1792 | @code{"^\C-l"}); this matches a line that starts with a formfeed | 1792 | @code{"^\C-l"}); this matches a line that starts with a formfeed |
| 1793 | character. | 1793 | character. |
| 1794 | @end defvar | 1794 | @end defopt |
| 1795 | 1795 | ||
| 1796 | The following two regular expressions should @emph{not} assume the | 1796 | The following two regular expressions should @emph{not} assume the |
| 1797 | match always starts at the beginning of a line; they should not use | 1797 | 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 | |||
| 1802 | @samp{^} would be incorrect. However, a @samp{^} is harmless in modes | 1802 | @samp{^} would be incorrect. However, a @samp{^} is harmless in modes |
| 1803 | where a left margin is never used. | 1803 | where a left margin is never used. |
| 1804 | 1804 | ||
| 1805 | @defvar paragraph-separate | 1805 | @defopt paragraph-separate |
| 1806 | This is the regular expression for recognizing the beginning of a line | 1806 | This is the regular expression for recognizing the beginning of a line |
| 1807 | that separates paragraphs. (If you change this, you may have to | 1807 | that separates paragraphs. (If you change this, you may have to |
| 1808 | change @code{paragraph-start} also.) The default value is | 1808 | change @code{paragraph-start} also.) The default value is |
| 1809 | @w{@code{"[@ \t\f]*$"}}, which matches a line that consists entirely of | 1809 | @w{@code{"[@ \t\f]*$"}}, which matches a line that consists entirely of |
| 1810 | spaces, tabs, and form feeds (after its left margin). | 1810 | spaces, tabs, and form feeds (after its left margin). |
| 1811 | @end defvar | 1811 | @end defopt |
| 1812 | 1812 | ||
| 1813 | @defvar paragraph-start | 1813 | @defopt paragraph-start |
| 1814 | This is the regular expression for recognizing the beginning of a line | 1814 | This is the regular expression for recognizing the beginning of a line |
| 1815 | that starts @emph{or} separates paragraphs. The default value is | 1815 | that starts @emph{or} separates paragraphs. The default value is |
| 1816 | @w{@code{"\f\\|[ \t]*$"}}, which matches a line containing only | 1816 | @w{@code{"\f\\|[ \t]*$"}}, which matches a line containing only |
| 1817 | whitespace or starting with a form feed (after its left margin). | 1817 | whitespace or starting with a form feed (after its left margin). |
| 1818 | @end defvar | 1818 | @end defopt |
| 1819 | 1819 | ||
| 1820 | @defvar sentence-end | 1820 | @defopt sentence-end |
| 1821 | If non-@code{nil}, the value should be a regular expression describing | 1821 | If non-@code{nil}, the value should be a regular expression describing |
| 1822 | the end of a sentence, including the whitespace following the | 1822 | the end of a sentence, including the whitespace following the |
| 1823 | sentence. (All paragraph boundaries also end sentences, regardless.) | 1823 | sentence. (All paragraph boundaries also end sentences, regardless.) |
| @@ -1826,7 +1826,7 @@ If the value is @code{nil}, the default, then the function | |||
| 1826 | @code{sentence-end} has to construct the regexp. That is why you | 1826 | @code{sentence-end} has to construct the regexp. That is why you |
| 1827 | should always call the function @code{sentence-end} to obtain the | 1827 | should always call the function @code{sentence-end} to obtain the |
| 1828 | regexp to be used to recognize the end of a sentence. | 1828 | regexp to be used to recognize the end of a sentence. |
| 1829 | @end defvar | 1829 | @end defopt |
| 1830 | 1830 | ||
| 1831 | @defun sentence-end | 1831 | @defun sentence-end |
| 1832 | This function returns the value of the variable @code{sentence-end}, | 1832 | This function returns the value of the variable @code{sentence-end}, |
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 07c5d5c8a8c..56361621845 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi | |||
| @@ -1690,20 +1690,20 @@ may involve either inserting or deleting whitespace.) This function | |||
| 1690 | is value of @code{indent-line-function} in Paragraph-Indent Text mode. | 1690 | is value of @code{indent-line-function} in Paragraph-Indent Text mode. |
| 1691 | @end defun | 1691 | @end defun |
| 1692 | 1692 | ||
| 1693 | @defvar left-margin | 1693 | @defopt left-margin |
| 1694 | This variable specifies the base left margin column. In Fundamental | 1694 | This variable specifies the base left margin column. In Fundamental |
| 1695 | mode, @kbd{C-j} indents to this column. This variable automatically | 1695 | mode, @kbd{C-j} indents to this column. This variable automatically |
| 1696 | becomes buffer-local when set in any fashion. | 1696 | becomes buffer-local when set in any fashion. |
| 1697 | @end defvar | 1697 | @end defopt |
| 1698 | 1698 | ||
| 1699 | @defvar fill-nobreak-predicate | 1699 | @defopt fill-nobreak-predicate |
| 1700 | This variable gives major modes a way to specify not to break a line | 1700 | This variable gives major modes a way to specify not to break a line |
| 1701 | at certain places. Its value should be a list of functions. Whenever | 1701 | at certain places. Its value should be a list of functions. Whenever |
| 1702 | filling considers breaking the line at a certain place in the buffer, | 1702 | filling considers breaking the line at a certain place in the buffer, |
| 1703 | it calls each of these functions with no arguments and with point | 1703 | it calls each of these functions with no arguments and with point |
| 1704 | located at that place. If any of the functions returns | 1704 | located at that place. If any of the functions returns |
| 1705 | non-@code{nil}, then the line won't be broken there. | 1705 | non-@code{nil}, then the line won't be broken there. |
| 1706 | @end defvar | 1706 | @end defopt |
| 1707 | 1707 | ||
| 1708 | @node Adaptive Fill | 1708 | @node Adaptive Fill |
| 1709 | @section Adaptive Fill Mode | 1709 | @section Adaptive Fill Mode |
diff --git a/doc/lispref/variables.texi b/doc/lispref/variables.texi index 75f0b182604..e4598e30326 100644 --- a/doc/lispref/variables.texi +++ b/doc/lispref/variables.texi | |||
| @@ -260,7 +260,7 @@ Variables}); a few variables have terminal-local bindings | |||
| 260 | like ordinary local bindings, but they are localized depending on | 260 | like ordinary local bindings, but they are localized depending on |
| 261 | ``where'' you are in Emacs, rather than localized in time. | 261 | ``where'' you are in Emacs, rather than localized in time. |
| 262 | 262 | ||
| 263 | @defvar max-specpdl-size | 263 | @defopt max-specpdl-size |
| 264 | @anchor{Definition of max-specpdl-size} | 264 | @anchor{Definition of max-specpdl-size} |
| 265 | @cindex variable limit error | 265 | @cindex variable limit error |
| 266 | @cindex evaluation error | 266 | @cindex evaluation error |
| @@ -279,7 +279,7 @@ that Lisp avoids infinite recursion on an ill-defined function. | |||
| 279 | The default value is 1000. Entry to the Lisp debugger increases the | 279 | The default value is 1000. Entry to the Lisp debugger increases the |
| 280 | value, if there is little room left, to make sure the debugger itself | 280 | value, if there is little room left, to make sure the debugger itself |
| 281 | has room to execute. | 281 | has room to execute. |
| 282 | @end defvar | 282 | @end defopt |
| 283 | 283 | ||
| 284 | @node Void Variables | 284 | @node Void Variables |
| 285 | @section When a Variable is ``Void'' | 285 | @section When a Variable is ``Void'' |
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 5e58bb13486..ad9f012f796 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}, | |||
| 959 | @code{display-buffer} does not split any window. | 959 | @code{display-buffer} does not split any window. |
| 960 | @end defopt | 960 | @end defopt |
| 961 | 961 | ||
| 962 | @defvar split-window-preferred-function | 962 | @defopt split-window-preferred-function |
| 963 | This variable must specify a function with one argument, which is a | 963 | This variable must specify a function with one argument, which is a |
| 964 | window. The @code{display-buffer} routines will call this function with | 964 | window. The @code{display-buffer} routines will call this function with |
| 965 | one or more candidate windows when they look for a window to split. The | 965 | 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 | |||
| 987 | window or @code{nil}, but you are not encouraged to do so | 987 | window or @code{nil}, but you are not encouraged to do so |
| 988 | unconditionally. If you want @code{display-buffer} to never split any | 988 | unconditionally. If you want @code{display-buffer} to never split any |
| 989 | windows, set @code{pop-up-windows} to @code{nil}. | 989 | windows, set @code{pop-up-windows} to @code{nil}. |
| 990 | @end defvar | 990 | @end defopt |
| 991 | 991 | ||
| 992 | @defun split-window-sensibly window | 992 | @defun split-window-sensibly window |
| 993 | This function takes a window as argument and tries to split that window | 993 | 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 | |||
| 1130 | of frame parameters. | 1130 | of frame parameters. |
| 1131 | @end defun | 1131 | @end defun |
| 1132 | 1132 | ||
| 1133 | @defvar special-display-function | 1133 | @defopt special-display-function |
| 1134 | This variable holds the function to call to display a buffer specially. | 1134 | This variable holds the function to call to display a buffer specially. |
| 1135 | It receives the buffer as an argument, and should return the window in | 1135 | It receives the buffer as an argument, and should return the window in |
| 1136 | which it is displayed. The default value of this variable is | 1136 | which it is displayed. The default value of this variable is |
| 1137 | @code{special-display-popup-frame}, see below. | 1137 | @code{special-display-popup-frame}, see below. |
| 1138 | @end defvar | 1138 | @end defopt |
| 1139 | 1139 | ||
| 1140 | @defun special-display-popup-frame buffer &optional args | 1140 | @defun special-display-popup-frame buffer &optional args |
| 1141 | This function tries to make @var{buffer} visible in a frame of its own. | 1141 | This function tries to make @var{buffer} visible in a frame of its own. |
| @@ -1183,7 +1183,7 @@ put it in the selected window. | |||
| 1183 | @end defun | 1183 | @end defun |
| 1184 | 1184 | ||
| 1185 | @c Emacs 19 feature | 1185 | @c Emacs 19 feature |
| 1186 | @defvar display-buffer-function | 1186 | @defopt display-buffer-function |
| 1187 | This variable is the most flexible way to customize the behavior of | 1187 | This variable is the most flexible way to customize the behavior of |
| 1188 | @code{display-buffer}. If it is non-@code{nil}, it should be a function | 1188 | @code{display-buffer}. If it is non-@code{nil}, it should be a function |
| 1189 | that @code{display-buffer} calls to do the work. The function should | 1189 | that @code{display-buffer} calls to do the work. The function should |
| @@ -1193,7 +1193,7 @@ buffer in it, and then return the window. | |||
| 1193 | 1193 | ||
| 1194 | This variable takes precedence over all the other options described | 1194 | This variable takes precedence over all the other options described |
| 1195 | above. | 1195 | above. |
| 1196 | @end defvar | 1196 | @end defopt |
| 1197 | 1197 | ||
| 1198 | If all options described above fail to produce a suitable window, | 1198 | If all options described above fail to produce a suitable window, |
| 1199 | @code{display-buffer} tries to reuse an existing window. As a last | 1199 | @code{display-buffer} tries to reuse an existing window. As a last |