aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2018-02-22 20:27:24 +0200
committerEli Zaretskii2018-02-22 20:27:24 +0200
commit5fb29578de07d0f5002d88dea58843478c0bc114 (patch)
tree9f1a03e36caf9de7a4f0f74913b13c98a3926e43
parentde17b8e5f06f9c70018d6220dd8eb2056eab7bed (diff)
downloademacs-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.texi77
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
86For help, see [Easy Customization] in the [Emacs manual]. 86For 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}.
119the customization buffer is an editable field for searching for 119the customization buffer is an editable field for searching for
120settings (@pxref{Browsing Custom}). There are also @dfn{buttons} and 120settings (@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,
122or moving point there and typing @key{RET}. For example, the group 122or moving point there and typing @kbd{@key{RET}}. For example, the group
123names like @samp{[Editing]} are links; activating one of these links 123names like @samp{[Editing]} are links; activating one of these links
124brings up the customization buffer for that group. 124brings 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
132field. @kbd{S-@key{TAB}} (@code{widget-backward}) moves back to the 132field. @kbd{S-@key{TAB}} (@code{widget-backward}) moves back to the
133previous button or editable field. 133previous 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
148customization group, you can go straight there with the commands 148customization 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
150customize-group}. @xref{Specific Customization}. 150customize-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
154customize, you can search for them using the editable search field at 154customize, you can search for them using the editable search field at
155the top of each customization buffer. Here, you can type in a search 155the top of each customization buffer. Here, you can type in a search
156term---either one or more words separated by spaces, or a regular 156term---either one or more words separated by spaces, or a regular
157expression (@pxref{Regexps}). Then type @key{RET} in the field, or 157expression (@pxref{Regexps}). Then type @kbd{@key{RET}} in the field,
158activate the @samp{Search} button next to it, to switch to a 158or activate the @samp{Search} button next to it, to switch to a
159customization buffer containing groups and settings that match those 159customization buffer containing groups and settings that match those
160terms. Note, however, that this feature only finds groups and 160terms. Note, however, that this feature only finds groups and
161settings that are loaded in the current Emacs session. 161settings 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
253like minibuffer completion (@pxref{Completion}). 253like 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
256the next field or button, like @key{TAB}. You can thus type @key{RET} 256forward to the next field or button, like @kbd{@key{TAB}}. You can
257when you are finished editing a field, to move on to the next button 257thus type @kbd{@key{RET}} when you are finished editing a field, to
258or field. To insert a newline within an editable field, use @kbd{C-o} 258move on to the next button or field. To insert a newline within an
259or @kbd{C-q C-j}. 259editable 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,
262and you are not allowed to edit the value directly. Instead, a 262and you are not allowed to edit the value directly. Instead, a
@@ -306,9 +306,10 @@ operation. There are actually four reset operations:
306If you have modified but not yet set the variable, this restores the 306If you have modified but not yet set the variable, this restores the
307text in the customization buffer to match the actual value. 307text in the customization buffer to match the actual value.
308 308
309@item Reset to Saved 309@item Revert This Session's Customizations
310This restores the value of the variable to the last saved value, 310This restores the value of the variable to the last saved value, if
311and updates the text accordingly. 311there was one. Otherwise it restores the standard value. It updates
312the text accordingly.
312 313
313@item Erase Customization 314@item Erase Customization
314This sets the variable to its standard value. Any saved value that 315This 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
337Each of the first five buttons performs the stated operation---set, 338The @samp{[Revert...]} button drops a menu with the first 3 reset
338save, reset, etc.---on all the settings in the buffer that could 339operations described above. The @samp{[Apply]} button applies the
339meaningfully be affected. They do not operate on settings that are 340settings for the current session. The @samp{[Apply and Save]} button
340hidden, nor on subgroups that are hidden or not visible in the buffer. 341applies the settings and saves them for future sessions; this button
342does 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
361setting by choosing the @samp{Save for Future Sessions} choice from 364setting by choosing the @samp{Save for Future Sessions} choice from
362its @samp{[State]} button. The @kbd{C-x C-s} (@code{Custom-save}) 365its @samp{[State]} button. The @kbd{C-x C-s} (@code{Custom-save})
363command, or the @samp{[Save for Future Sessions]} button at the top of 366command, or the @samp{[Apply and Save]} button at the top of the
364the customization buffer, saves all applicable settings in the buffer. 367customization 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
367file (@pxref{Init File}). Future Emacs sessions automatically read 370file (@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
429shown with @code{font-lock-comment-face} (@pxref{Font Lock}). In a 432shown with @code{font-lock-comment-face} (@pxref{Font Lock}). In a
430customization buffer, that face appears like this: 433customization buffer, that face appears like this, after you click on
434the @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
469have an explicitly-assigned face; furthermore, its background color 473have an explicitly-assigned face; furthermore, its background color
470attribute serves as the background color of the frame. 474attribute 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
473attribute list, hides the unspecified attributes of the face. When 477attribute list, hides the unspecified attributes of the face. When
474attributes are being hidden, the button changes to @samp{[Show All 478attributes are being hidden, the button changes to @samp{[Show All
475Attributes]}, which reveals the entire attribute list. The 479Attributes]}, 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
483names or RGB triplets (@pxref{Colors}). You can also use the 487names 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
485color with @key{RET} in that buffer to put the color name in the value 489color with @kbd{@key{RET}} in that buffer to put the color name in the
486field. 490value 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
489variables (@pxref{Changing a Variable}). 493variables (@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}
503Set up a customization buffer for just one user option, @var{option}. 507Set 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}
505Set up a customization buffer for just one face, @var{face}. 510Set 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}
507Set up a customization buffer for just one group, @var{group}. 513Set 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}
509Set up a customization buffer for all the settings and groups that 516Set up a customization buffer for all the settings and groups that
510match @var{regexp}. 517match @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}
512Set up a customization buffer with all the settings and groups 520Set up a customization buffer with all the settings and groups
513whose meaning has changed since Emacs version @var{version}. 521whose meaning has changed since Emacs version @var{version}.
522
523@item M-x customize-changed-options @key{RET} @var{version} @key{RET}
524Set up a customization buffer with all the options whose meaning or
525default values have changed since Emacs version @var{version}.
526
514@item M-x customize-saved 527@item M-x customize-saved
515Set up a customization buffer containing all settings that you 528Set up a customization buffer containing all settings that you
516have saved with customization buffers. 529have saved with customization buffers.
530
517@item M-x customize-unsaved 531@item M-x customize-unsaved
518Set up a customization buffer containing all settings that you have 532Set up a customization buffer containing all settings that you have
519set but not saved. 533set 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}
760Display the value and documentation of variable @var{var} 774Display 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}
763Change the value of variable @var{var} to @var{value}. 778Change 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}
953Make variable @var{var} have a local value in the current buffer. 968Make 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}
955Make variable @var{var} use its global value in the current buffer. 971Make 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}
957Mark variable @var{var} so that setting it will make it local to the 974Mark variable @var{var} so that setting it will make it local to the
958buffer that is current at that time. 975buffer that is current at that time.