Mercurial > hg > xemacs-beta

comparison man/custom.texi @ 161:28f395d8dc7a r20-3b7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r20-3b7
author cvs
date Mon, 13 Aug 2007 09:42:26 +0200
parents 43dd3413c7c7
children 0132846995bd
comparison
equal deleted inserted replaced
160:1c55655d6702 161:28f395d8dc7a
1 \input texinfo.tex 1 \input texinfo.tex
2 2
3 @c %**start of header 3 @c %**start of header
4 @setfilename custom 4 @setfilename ../info/custom
5 @settitle The Customization Library 5 @settitle The Customization Library
6 @iftex 6 @iftex
7 @afourpaper 7 @afourpaper
8 @headings double 8 @headings double
9 @end iftex 9 @end iftex
34 @item :group 34 @item :group
35 @var{value} should be a customization group. 35 @var{value} should be a customization group.
36 Add @var{symbol} to that group. 36 Add @var{symbol} to that group.
37 @item :link 37 @item :link
38 @var{value} should be a widget type. 38 @var{value} should be a widget type.
39 Add @var{value} to the extrenal links for this customization option. 39 Add @var{value} to the external links for this customization option.
40 Useful widget types include @code{custom-manual}, @code{info-link}, and 40 Useful widget types include @code{custom-manual}, @code{info-link}, and
41 @code{url-link}. 41 @code{url-link}.
42 @item :load 42 @item :load
43 Add @var{value} to the files that should be loaded nefore displaying 43 Add @var{value} to the files that should be loaded before displaying
44 this customization option. The value should be iether a string, which 44 this customization option. The value should be either a string, which
45 should be a string which will be loaded with @code{load-library} unless 45 should be a string which will be loaded with @code{load-library} unless
46 present in @code{load-history}, or a symbol which will be loaded with 46 present in @code{load-history}, or a symbol which will be loaded with
47 @code{require}. 47 @code{require}.
48 @item :tag 48 @item :tag
49 @var{Value} should be a short string used for identifying the option in 49 @var{Value} should be a short string used for identifying the option in
141 function takes one argument, a symbol, and should return the current 141 function takes one argument, a symbol, and should return the current
142 value for that symbol. The default is @code{default-value}. 142 value for that symbol. The default is @code{default-value}.
143 143
144 @item :require 144 @item :require
145 @var{value} should be a feature symbol. Each feature will be required 145 @var{value} should be a feature symbol. Each feature will be required
146 after initialization, of the the user have saved this option. 146 when the `defcustom' is evaluated, or when Emacs is started if the user
147 has saved this option.
147 148
148 @end table 149 @end table
149 150
150 @xref{Sexp Types,,,widget,The Widget Library}, for information about 151 @xref{Sexp Types,,,widget,The Widget Library}, for information about
151 widgets to use together with the @code{:type} keyword. 152 widgets to use together with the @code{:type} keyword.
155 track of the variables type, @code{standard-value} for the program 156 track of the variables type, @code{standard-value} for the program
156 specified default value, @code{saved-value} for a value saved by the 157 specified default value, @code{saved-value} for a value saved by the
157 user, and @code{variable-documentation} for the documentation string. 158 user, and @code{variable-documentation} for the documentation string.
158 159
159 Use @code{custom-add-option} to specify that a specific function is 160 Use @code{custom-add-option} to specify that a specific function is
160 useful as an meber of a hook. 161 useful as an member of a hook.
161 162
162 @defun custom-add-option symbol option 163 @defun custom-add-option symbol option
163 To the variable @var{symbol} add @var{option}. 164 To the variable @var{symbol} add @var{option}.
164 165
165 If @var{symbol} is a hook variable, @var{option} should be a hook 166 If @var{symbol} is a hook variable, @var{option} should be a hook
320 item in XEmacs. This is like the *Completions* buffer in XEmacs. 321 item in XEmacs. This is like the *Completions* buffer in XEmacs.
321 Suggested by Jens Lautenbacher 322 Suggested by Jens Lautenbacher
322 @samp{<jens@@lemming0.lem.uni-karlsruhe.de>}.@refill 323 @samp{<jens@@lemming0.lem.uni-karlsruhe.de>}.@refill
323 324
324 @item 325 @item
325 Explain why it is necessary that all choices have differnet default 326 Explain why it is necessary that all choices have different default
326 values. 327 values.
327 328
328 @item 329 @item
329 Make it possible to include a comment/remark/annotation when saving an 330 Make it possible to include a comment/remark/annotation when saving an
330 option. 331 option.