diff options
| author | Eli Zaretskii | 2018-02-22 20:27:24 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2018-02-22 20:27:24 +0200 |
| commit | 5fb29578de07d0f5002d88dea58843478c0bc114 (patch) | |
| tree | 9f1a03e36caf9de7a4f0f74913b13c98a3926e43 | |
| parent | de17b8e5f06f9c70018d6220dd8eb2056eab7bed (diff) | |
| download | emacs-5fb29578de07d0f5002d88dea58843478c0bc114.tar.gz emacs-5fb29578de07d0f5002d88dea58843478c0bc114.zip | |
Improvements in the Emacs manual
* doc/emacs/custom.texi (Customization Groups)
(Changing a Variable, Browsing Custom, Customizing Faces): Fix
markup of keys.
(Changing a Variable, Saving Customizations): Update the
description of buttons in the Custom buffer.
(Face Customization): More accurate description.
(Specific Customization, Examining, Locals): Add blank lines in
the @table. Reported by Michael Albinus <michael.albinus@gmx.de>
in emacs-manual-bugs@gnu.org.
| -rw-r--r-- | doc/emacs/custom.texi | 77 |
1 files changed, 47 insertions, 30 deletions
diff --git a/doc/emacs/custom.texi b/doc/emacs/custom.texi index 1fa47634d43..d54363047bc 100644 --- a/doc/emacs/custom.texi +++ b/doc/emacs/custom.texi | |||
| @@ -83,7 +83,7 @@ top-level @code{Emacs} group. It looks like this, in part: | |||
| 83 | @c @page | 83 | @c @page |
| 84 | @smallexample | 84 | @smallexample |
| 85 | @group | 85 | @group |
| 86 | For help, see [Easy Customization] in the [Emacs manual]. | 86 | For help using this buffer, see [Easy Customization] in the [Emacs manual]. |
| 87 | 87 | ||
| 88 | ________________________________________ [ Search ] | 88 | ________________________________________ [ Search ] |
| 89 | 89 | ||
| @@ -95,10 +95,10 @@ Emacs group: Customization of the One True Editor. | |||
| 95 | [State]: visible group members are all at standard values. | 95 | [State]: visible group members are all at standard values. |
| 96 | See also [Manual]. | 96 | See also [Manual]. |
| 97 | 97 | ||
| 98 | [Editing] : Basic text editing facilities. | 98 | [Editing] Basic text editing facilities. |
| 99 | [Convenience] : Convenience features for faster editing. | 99 | [Convenience] Convenience features for faster editing. |
| 100 | 100 | ||
| 101 | @var{more second-level groups} | 101 | @var{...more second-level groups...} |
| 102 | @end group | 102 | @end group |
| 103 | @end smallexample | 103 | @end smallexample |
| 104 | 104 | ||
| @@ -119,7 +119,7 @@ has been edited, set, or saved. @xref{Changing a Variable}. | |||
| 119 | the customization buffer is an editable field for searching for | 119 | the customization buffer is an editable field for searching for |
| 120 | settings (@pxref{Browsing Custom}). There are also @dfn{buttons} and | 120 | settings (@pxref{Browsing Custom}). There are also @dfn{buttons} and |
| 121 | @dfn{links}, which you can activate by either clicking with the mouse, | 121 | @dfn{links}, which you can activate by either clicking with the mouse, |
| 122 | or moving point there and typing @key{RET}. For example, the group | 122 | or moving point there and typing @kbd{@key{RET}}. For example, the group |
| 123 | names like @samp{[Editing]} are links; activating one of these links | 123 | names like @samp{[Editing]} are links; activating one of these links |
| 124 | brings up the customization buffer for that group. | 124 | brings up the customization buffer for that group. |
| 125 | 125 | ||
| @@ -127,7 +127,7 @@ brings up the customization buffer for that group. | |||
| 127 | @kindex S-TAB @r{(customization buffer)} | 127 | @kindex S-TAB @r{(customization buffer)} |
| 128 | @findex widget-forward | 128 | @findex widget-forward |
| 129 | @findex widget-backward | 129 | @findex widget-backward |
| 130 | In the customization buffer, you can type @key{TAB} | 130 | In the customization buffer, you can type @kbd{@key{TAB}} |
| 131 | (@code{widget-forward}) to move forward to the next button or editable | 131 | (@code{widget-forward}) to move forward to the next button or editable |
| 132 | field. @kbd{S-@key{TAB}} (@code{widget-backward}) moves back to the | 132 | field. @kbd{S-@key{TAB}} (@code{widget-backward}) moves back to the |
| 133 | previous button or editable field. | 133 | previous button or editable field. |
| @@ -146,16 +146,16 @@ settings that you want to customize. | |||
| 146 | 146 | ||
| 147 | If you are interested in customizing a particular setting or | 147 | If you are interested in customizing a particular setting or |
| 148 | customization group, you can go straight there with the commands | 148 | customization group, you can go straight there with the commands |
| 149 | @kbd{M-x customize-option}, @kbd{M-x customize-face}, or @kbd{M-x | 149 | @kbd{M-x customize-option}, @kbd{M-x customize-face}, or @w{@kbd{M-x |
| 150 | customize-group}. @xref{Specific Customization}. | 150 | customize-group}}. @xref{Specific Customization}. |
| 151 | 151 | ||
| 152 | @vindex custom-search-field | 152 | @vindex custom-search-field |
| 153 | If you don't know exactly what groups or settings you want to | 153 | If you don't know exactly what groups or settings you want to |
| 154 | customize, you can search for them using the editable search field at | 154 | customize, you can search for them using the editable search field at |
| 155 | the top of each customization buffer. Here, you can type in a search | 155 | the top of each customization buffer. Here, you can type in a search |
| 156 | term---either one or more words separated by spaces, or a regular | 156 | term---either one or more words separated by spaces, or a regular |
| 157 | expression (@pxref{Regexps}). Then type @key{RET} in the field, or | 157 | expression (@pxref{Regexps}). Then type @kbd{@key{RET}} in the field, |
| 158 | activate the @samp{Search} button next to it, to switch to a | 158 | or activate the @samp{Search} button next to it, to switch to a |
| 159 | customization buffer containing groups and settings that match those | 159 | customization buffer containing groups and settings that match those |
| 160 | terms. Note, however, that this feature only finds groups and | 160 | terms. Note, however, that this feature only finds groups and |
| 161 | settings that are loaded in the current Emacs session. | 161 | settings that are loaded in the current Emacs session. |
| @@ -252,11 +252,11 @@ names, and Emacs command names, you can perform completion with | |||
| 252 | @kbd{M-@key{TAB}} or @kbd{@key{ESC} @key{TAB}}. This behaves much | 252 | @kbd{M-@key{TAB}} or @kbd{@key{ESC} @key{TAB}}. This behaves much |
| 253 | like minibuffer completion (@pxref{Completion}). | 253 | like minibuffer completion (@pxref{Completion}). |
| 254 | 254 | ||
| 255 | Typing @key{RET} on an editable value field moves point forward to | 255 | Typing @kbd{@key{RET}} on an editable value field moves point |
| 256 | the next field or button, like @key{TAB}. You can thus type @key{RET} | 256 | forward to the next field or button, like @kbd{@key{TAB}}. You can |
| 257 | when you are finished editing a field, to move on to the next button | 257 | thus type @kbd{@key{RET}} when you are finished editing a field, to |
| 258 | or field. To insert a newline within an editable field, use @kbd{C-o} | 258 | move on to the next button or field. To insert a newline within an |
| 259 | or @kbd{C-q C-j}. | 259 | editable field, use @kbd{C-o} or @kbd{C-q C-j}. |
| 260 | 260 | ||
| 261 | For some variables, there is only a fixed set of legitimate values, | 261 | For some variables, there is only a fixed set of legitimate values, |
| 262 | and you are not allowed to edit the value directly. Instead, a | 262 | and you are not allowed to edit the value directly. Instead, a |
| @@ -306,9 +306,10 @@ operation. There are actually four reset operations: | |||
| 306 | If you have modified but not yet set the variable, this restores the | 306 | If you have modified but not yet set the variable, this restores the |
| 307 | text in the customization buffer to match the actual value. | 307 | text in the customization buffer to match the actual value. |
| 308 | 308 | ||
| 309 | @item Reset to Saved | 309 | @item Revert This Session's Customizations |
| 310 | This restores the value of the variable to the last saved value, | 310 | This restores the value of the variable to the last saved value, if |
| 311 | and updates the text accordingly. | 311 | there was one. Otherwise it restores the standard value. It updates |
| 312 | the text accordingly. | ||
| 312 | 313 | ||
| 313 | @item Erase Customization | 314 | @item Erase Customization |
| 314 | This sets the variable to its standard value. Any saved value that | 315 | This sets the variable to its standard value. Any saved value that |
| @@ -329,15 +330,17 @@ customization. Use the @samp{Add Comment} item from the | |||
| 329 | Near the top of the customization buffer are two lines of buttons: | 330 | Near the top of the customization buffer are two lines of buttons: |
| 330 | 331 | ||
| 331 | @smallexample | 332 | @smallexample |
| 332 | [Set for Current Session] [Save for Future Sessions] | 333 | Operate on all settings in this buffer: |
| 333 | [Undo Edits] [Reset to Saved] [Erase Customization] [Exit] | 334 | [Revert...] [Apply] [Apply and Save] |
| 334 | @end smallexample | 335 | @end smallexample |
| 335 | 336 | ||
| 336 | @noindent | 337 | @noindent |
| 337 | Each of the first five buttons performs the stated operation---set, | 338 | The @samp{[Revert...]} button drops a menu with the first 3 reset |
| 338 | save, reset, etc.---on all the settings in the buffer that could | 339 | operations described above. The @samp{[Apply]} button applies the |
| 339 | meaningfully be affected. They do not operate on settings that are | 340 | settings for the current session. The @samp{[Apply and Save]} button |
| 340 | hidden, nor on subgroups that are hidden or not visible in the buffer. | 341 | applies the settings and saves them for future sessions; this button |
| 342 | does not appear if Emacs was started with the @option{-q} or | ||
| 343 | @option{-Q} option (@pxref{Initial Options}). | ||
| 341 | 344 | ||
| 342 | @kindex C-c C-c @r{(customization buffer)} | 345 | @kindex C-c C-c @r{(customization buffer)} |
| 343 | @kindex C-x C-c @r{(customization buffer)} | 346 | @kindex C-x C-c @r{(customization buffer)} |
| @@ -360,8 +363,8 @@ kill the customization buffer instead, change the variable | |||
| 360 | In the customization buffer, you can @dfn{save} a customization | 363 | In the customization buffer, you can @dfn{save} a customization |
| 361 | setting by choosing the @samp{Save for Future Sessions} choice from | 364 | setting by choosing the @samp{Save for Future Sessions} choice from |
| 362 | its @samp{[State]} button. The @kbd{C-x C-s} (@code{Custom-save}) | 365 | its @samp{[State]} button. The @kbd{C-x C-s} (@code{Custom-save}) |
| 363 | command, or the @samp{[Save for Future Sessions]} button at the top of | 366 | command, or the @samp{[Apply and Save]} button at the top of the |
| 364 | the customization buffer, saves all applicable settings in the buffer. | 367 | customization buffer, saves all applicable settings in the buffer. |
| 365 | 368 | ||
| 366 | Saving works by writing code to a file, usually your initialization | 369 | Saving works by writing code to a file, usually your initialization |
| 367 | file (@pxref{Init File}). Future Emacs sessions automatically read | 370 | file (@pxref{Init File}). Future Emacs sessions automatically read |
| @@ -427,7 +430,8 @@ both variables and faces. | |||
| 427 | 430 | ||
| 428 | For example, in programming language modes, source code comments are | 431 | For example, in programming language modes, source code comments are |
| 429 | shown with @code{font-lock-comment-face} (@pxref{Font Lock}). In a | 432 | shown with @code{font-lock-comment-face} (@pxref{Font Lock}). In a |
| 430 | customization buffer, that face appears like this: | 433 | customization buffer, that face appears like this, after you click on |
| 434 | the @samp{[Show All Attributes]} link: | ||
| 431 | 435 | ||
| 432 | @smallexample | 436 | @smallexample |
| 433 | [Hide] Font Lock Comment Face:[sample] | 437 | [Hide] Font Lock Comment Face:[sample] |
| @@ -469,7 +473,7 @@ Any unspecified attribute is taken from the special face named | |||
| 469 | have an explicitly-assigned face; furthermore, its background color | 473 | have an explicitly-assigned face; furthermore, its background color |
| 470 | attribute serves as the background color of the frame. | 474 | attribute serves as the background color of the frame. |
| 471 | 475 | ||
| 472 | The @samp{Hide Unused Attributes} button, at the end of the | 476 | The @samp{[Hide Unused Attributes]} button, at the end of the |
| 473 | attribute list, hides the unspecified attributes of the face. When | 477 | attribute list, hides the unspecified attributes of the face. When |
| 474 | attributes are being hidden, the button changes to @samp{[Show All | 478 | attributes are being hidden, the button changes to @samp{[Show All |
| 475 | Attributes]}, which reveals the entire attribute list. The | 479 | Attributes]}, which reveals the entire attribute list. The |
| @@ -482,8 +486,8 @@ usual ways. | |||
| 482 | Foreground and background colors can be specified using either color | 486 | Foreground and background colors can be specified using either color |
| 483 | names or RGB triplets (@pxref{Colors}). You can also use the | 487 | names or RGB triplets (@pxref{Colors}). You can also use the |
| 484 | @samp{[Choose]} button to switch to a list of color names; select a | 488 | @samp{[Choose]} button to switch to a list of color names; select a |
| 485 | color with @key{RET} in that buffer to put the color name in the value | 489 | color with @kbd{@key{RET}} in that buffer to put the color name in the |
| 486 | field. | 490 | value field. |
| 487 | 491 | ||
| 488 | Setting, saving and resetting a face work like the same operations for | 492 | Setting, saving and resetting a face work like the same operations for |
| 489 | variables (@pxref{Changing a Variable}). | 493 | variables (@pxref{Changing a Variable}). |
| @@ -501,19 +505,29 @@ menu you get from invoking @samp{[State]}. | |||
| 501 | @item M-x customize-option @key{RET} @var{option} @key{RET} | 505 | @item M-x customize-option @key{RET} @var{option} @key{RET} |
| 502 | @itemx M-x customize-variable @key{RET} @var{option} @key{RET} | 506 | @itemx M-x customize-variable @key{RET} @var{option} @key{RET} |
| 503 | Set up a customization buffer for just one user option, @var{option}. | 507 | Set up a customization buffer for just one user option, @var{option}. |
| 508 | |||
| 504 | @item M-x customize-face @key{RET} @var{face} @key{RET} | 509 | @item M-x customize-face @key{RET} @var{face} @key{RET} |
| 505 | Set up a customization buffer for just one face, @var{face}. | 510 | Set up a customization buffer for just one face, @var{face}. |
| 511 | |||
| 506 | @item M-x customize-group @key{RET} @var{group} @key{RET} | 512 | @item M-x customize-group @key{RET} @var{group} @key{RET} |
| 507 | Set up a customization buffer for just one group, @var{group}. | 513 | Set up a customization buffer for just one group, @var{group}. |
| 514 | |||
| 508 | @item M-x customize-apropos @key{RET} @var{regexp} @key{RET} | 515 | @item M-x customize-apropos @key{RET} @var{regexp} @key{RET} |
| 509 | Set up a customization buffer for all the settings and groups that | 516 | Set up a customization buffer for all the settings and groups that |
| 510 | match @var{regexp}. | 517 | match @var{regexp}. |
| 518 | |||
| 511 | @item M-x customize-changed @key{RET} @var{version} @key{RET} | 519 | @item M-x customize-changed @key{RET} @var{version} @key{RET} |
| 512 | Set up a customization buffer with all the settings and groups | 520 | Set up a customization buffer with all the settings and groups |
| 513 | whose meaning has changed since Emacs version @var{version}. | 521 | whose meaning has changed since Emacs version @var{version}. |
| 522 | |||
| 523 | @item M-x customize-changed-options @key{RET} @var{version} @key{RET} | ||
| 524 | Set up a customization buffer with all the options whose meaning or | ||
| 525 | default values have changed since Emacs version @var{version}. | ||
| 526 | |||
| 514 | @item M-x customize-saved | 527 | @item M-x customize-saved |
| 515 | Set up a customization buffer containing all settings that you | 528 | Set up a customization buffer containing all settings that you |
| 516 | have saved with customization buffers. | 529 | have saved with customization buffers. |
| 530 | |||
| 517 | @item M-x customize-unsaved | 531 | @item M-x customize-unsaved |
| 518 | Set up a customization buffer containing all settings that you have | 532 | Set up a customization buffer containing all settings that you have |
| 519 | set but not saved. | 533 | set but not saved. |
| @@ -759,6 +773,7 @@ expects (@pxref{Examining}). | |||
| 759 | @item C-h v @var{var} @key{RET} | 773 | @item C-h v @var{var} @key{RET} |
| 760 | Display the value and documentation of variable @var{var} | 774 | Display the value and documentation of variable @var{var} |
| 761 | (@code{describe-variable}). | 775 | (@code{describe-variable}). |
| 776 | |||
| 762 | @item M-x set-variable @key{RET} @var{var} @key{RET} @var{value} @key{RET} | 777 | @item M-x set-variable @key{RET} @var{var} @key{RET} @var{value} @key{RET} |
| 763 | Change the value of variable @var{var} to @var{value}. | 778 | Change the value of variable @var{var} to @var{value}. |
| 764 | @end table | 779 | @end table |
| @@ -951,8 +966,10 @@ be run as well. | |||
| 951 | @table @kbd | 966 | @table @kbd |
| 952 | @item M-x make-local-variable @key{RET} @var{var} @key{RET} | 967 | @item M-x make-local-variable @key{RET} @var{var} @key{RET} |
| 953 | Make variable @var{var} have a local value in the current buffer. | 968 | Make variable @var{var} have a local value in the current buffer. |
| 969 | |||
| 954 | @item M-x kill-local-variable @key{RET} @var{var} @key{RET} | 970 | @item M-x kill-local-variable @key{RET} @var{var} @key{RET} |
| 955 | Make variable @var{var} use its global value in the current buffer. | 971 | Make variable @var{var} use its global value in the current buffer. |
| 972 | |||
| 956 | @item M-x make-variable-buffer-local @key{RET} @var{var} @key{RET} | 973 | @item M-x make-variable-buffer-local @key{RET} @var{var} @key{RET} |
| 957 | Mark variable @var{var} so that setting it will make it local to the | 974 | Mark variable @var{var} so that setting it will make it local to the |
| 958 | buffer that is current at that time. | 975 | buffer that is current at that time. |