diff man/custom.texi @ 412:697ef44129c6 r21-2-14

Import from CVS: tag r21-2-14
author cvs
date Mon, 13 Aug 2007 11:20:41 +0200
parents 74fd4e045ea6
children da8ed4261e83
line wrap: on
line diff
--- a/man/custom.texi	Mon Aug 13 11:19:22 2007 +0200
+++ b/man/custom.texi	Mon Aug 13 11:20:41 2007 +0200
@@ -1,7 +1,7 @@
 \input texinfo.tex
 
 @c %**start of header
-@setfilename ../info/custom.info
+@setfilename ../info/custom
 @settitle The Customization Library
 @iftex
 @afourpaper
@@ -13,6 +13,7 @@
 @dircategory XEmacs Editor
 @direntry
 * Customizations: (custom).	Customization Library.
+package.
 @end direntry
 @end ifinfo
 
@@ -25,13 +26,13 @@
 @file{cus-edit.el} which contains many declarations you can learn from.
 
 @menu
-* Declaring Groups::
-* Declaring Variables::
-* Declaring Faces::
-* Usage for Package Authors::
-* Utilities::
-* The Init File::
-* Wishlist::
+* Declaring Groups::            
+* Declaring Variables::         
+* Declaring Faces::             
+* Usage for Package Authors::   
+* Utilities::                   
+* The Init File::               
+* Wishlist::                    
 @end menu
 
 All the customization declarations can be changes by keyword arguments.
@@ -39,19 +40,19 @@
 
 @table @code
 @item :group
-@var{value} should be a customization group.
-Add @var{symbol} to that group.
+@var{value} should be a customization group. 
+Add @var{symbol} to that group. 
 @item :link
-@var{value} should be a widget type.
+@var{value} should be a widget type. 
 Add @var{value} to the external links for this customization option.
 Useful widget types include @code{custom-manual}, @code{info-link}, and
-@code{url-link}.
+@code{url-link}. 
 @item :load
 Add @var{value} to the files that should be loaded before displaying
 this customization option.  The value should be either a string, which
 should be a string which will be loaded with @code{load-library} unless
 present in @code{load-history}, or a symbol which will be loaded with
-@code{require}.
+@code{require}. 
 @item :tag
 @var{Value} should be a short string used for identifying the option in
 customization menus and buffers.  By default the tag will be
@@ -62,10 +63,10 @@
 @comment  node-name,  next,  previous,  up
 @section Declaring Groups
 
-Use @code{defgroup} to declare new customization groups.
+Use @code{defgroup} to declare new customization groups. 
 
 @defun defgroup symbol members doc [keyword value]...
-Declare @var{symbol} as a customization group containing @var{members}.
+Declare @var{symbol} as a customization group containing @var{members}. 
 @var{symbol} does not need to be quoted.
 
 @var{doc} is the group documentation.
@@ -78,7 +79,7 @@
 
 Internally, custom uses the symbol property @code{custom-group} to keep
 track of the group members, and @code{group-documentation} for the
-documentation string.
+documentation string. 
 
 The following additional @var{keyword}'s are defined:
 
@@ -106,7 +107,7 @@
 The following additional @var{keyword}'s are defined:
 
 @table @code
-@item :type
+@item :type     
 @var{value} should be a widget type.
 
 @item :options
@@ -122,7 +123,7 @@
 @item custom-initialize-set
 Use the @code{:set} method to initialize the variable.  Do not
 initialize it if already bound.  This is the default @code{:initialize}
-method.
+method. 
 
 @item custom-initialize-default
 Always use @code{set-default} to initialize the variable, even if a
@@ -135,10 +136,10 @@
 @item custom-initialize-changed
 Like @code{custom-initialize-reset}, but use @code{set-default} to
 initialize the variable if it is not bound and has not been set
-already.
+already. 
 @end table
 
-@item :set
+@item :set 
 @var{value} should be a function to set the value of the symbol.  It
 takes two arguments, the symbol to set and the value to give it.  The
 default is @code{set-default}.
@@ -151,7 +152,7 @@
 @item :require
 @var{value} should be a feature symbol.  Each feature will be required
 when the `defcustom' is evaluated, or when Emacs is started if the user
-has saved this option.
+has saved this option. 
 
 @end table
 
@@ -180,7 +181,7 @@
 
 Faces are declared with @code{defface}.
 
-@defun defface face spec doc [keyword value]...
+@defun defface face spec doc [keyword value]... 
 
 Declare @var{face} as a customizable face that defaults to @var{spec}.
 @var{face} does not need to be quoted.
@@ -218,7 +219,7 @@
 (what color is used for the background text)@*
 Should be one of @code{light} or @code{dark}.
 @end table
-
+  
 Internally, custom uses the symbol property @code{face-defface-spec} for
 the program specified default face properties, @code{saved-face} for
 properties saved by the user, and @code{face-documentation} for the
@@ -240,13 +241,13 @@
 more of the standard customization groups.  There exists a group for
 each @emph{finder} keyword.  Press @kbd{C-h p} to see a list of finder
 keywords, and add you group to each of them, using the @code{:group}
-keyword.
+keyword. 
 
 @node  Utilities, The Init File, Usage for Package Authors, Top
 @comment  node-name,  next,  previous,  up
 @section Utilities
 
-These utilities can come in handy when adding customization support.
+These utilities can come in handy when adding customization support. 
 
 @deffn Widget custom-manual
 Widget type for specifying the info manual entry for a customization
@@ -269,7 +270,7 @@
 
 @defun customize-menu-create symbol &optional name
 Create menu for customization group @var{symbol}.
-If optional @var{name} is given, use that as the name of the menu.
+If optional @var{name} is given, use that as the name of the menu. 
 Otherwise the menu will be named `Customize'.
 The menu is in a format applicable to @code{easy-menu-define}.
 @end defun
@@ -290,7 +291,7 @@
 @section Wishlist
 
 @itemize @bullet
-@item
+@item 
 Better support for keyboard operations in the customize buffer.
 
 @item
@@ -301,7 +302,7 @@
 
 @item
 Add an `examples' section, with explained examples of custom type
-definitions.
+definitions. 
 
 @item
 Support selectable color themes.  I.e., change many faces by setting one
@@ -316,13 +317,13 @@
 
 @item
 Ask whether set or modified variables should be saved in
-@code{kill-buffer-hook}.
+@code{kill-buffer-hook}. 
 
 Ditto for @code{kill-emacs-query-functions}.
 
 @item
 Command to check if there are any customization options that
-does not belong to an existing group.
+does not belong to an existing group. 
 
 @item
 Optionally disable the point-cursor and instead highlight the selected
@@ -335,9 +336,13 @@
 values.
 
 @item
+Make it possible to include a comment/remark/annotation when saving an
+option.
+
+@item
 Add some direct support for meta variables, i.e. make it possible to
 specify that this variable should be reset when that variable is
-changed.
+changed. 
 
 @item
 Add tutorial.
@@ -378,7 +383,7 @@
 
 @item
 See if it is feasible to scan files for customization information
-instead of loading them,
+instead of loading them, 
 
 @item
 Add hint message when user push a non-pushable tag.
@@ -392,11 +397,11 @@
 @item
 Add option to hide @samp{[hide]} for short options.  Default, on.
 
-@item
+@item 
 Add option to hide @samp{[state]} for options with their standard
 settings.
 
-@item
+@item 
 There should be a way to specify site defaults for user options.
 
 @item