xemacs-beta: man/xemacs/custom.texi comparison

comparison man/xemacs/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	de805c49cfc1
children	11054d720c21

comparison

equal deleted inserted replaced

-:12e008d41344
+:697ef44129c6
 This chapter talks about various topics relevant to adapting the
 behavior of Emacs in minor ways.
 All kinds of customization affect only the particular Emacs job that you
-do them in.  They are completely lost when you kill the Emacs job, and
+do them in.  They are completely lost when you kill the Emacs job, and have
-have no effect on other Emacs jobs you may run at the same time or
+no effect on other Emacs jobs you may run at the same time or later.  The
-later.  The only way an Emacs job can affect anything outside of it is
+only way an Emacs job can affect anything outside of it is by writing a
-by writing a file; in particular, the only way to make a customization
+file; in particular, the only way to make a customization `permanent' is to
-`permanent' is to put something in your init file or other appropriate
+put something in your @file{.emacs} file or other appropriate file to do the
-file to do the customization in each session.  @xref{Init File}.
+customization in each session.  @xref{Init File}.
 @menu
 * Minor Modes::     Each minor mode is one feature you can turn on
 independently of any others.
 * Variables::       Many Emacs commands examine Emacs variables
 to be replayed with a single command.
 * Key Bindings::    The keymaps say what command each key runs.
 By changing them, you can "redefine keys".
 * Syntax::          The syntax table controls how words and expressions
 are parsed.
-* Init File::       How to write common customizations in the init file.
+* Init File::       How to write common customizations in the @file{.emacs}
-* Audible Bell::    Changing how Emacs sounds the bell.
+file.
-* Faces::           Changing the fonts and colors of a region of text.
+* Audible Bell::    Changing how Emacs sounds the bell.
-* Frame Components::  Controlling the presence and positions of the
+* Faces::           Changing the fonts and colors of a region of text.
-menubar, toolbars, and gutters.
+* X Resources::	    X resources controlling various aspects of the
-* X Resources::     X resources controlling various aspects of the
 behavior of XEmacs.
 @end menu
 @node Minor Modes
 @section Minor Modes
 C-j},
 @cindex saving option value
 Setting the option changes its value in the current Emacs session;
 @dfn{saving} the value changes it for future sessions as well.  This
-works by writing code into your init file so as to set the option
+works by writing code into your @file{~/.emacs} file so as to set the
-variable again each time you start Emacs.  @xref{Init File}.  To save
+option variable again each time you start Emacs.  To save the option,
-the option, invoke @samp{[State]} and select the @samp{Save for Future
+invoke @samp{[State]} and select the @samp{Save for Future Sessions}
-Sessions} operation.
+operation.
 You can also restore the option to its standard value by invoking
 @samp{[State]} and selecting the @samp{Reset} operation.  There are
 actually three reset operations:
 You may be tempted to turn on Auto Fill mode with a local variable
 list.  That is inappropriate.  Whether you use Auto Fill mode or not is
 a matter of personal taste, not a matter of the contents of particular
 files.  If you want to use Auto Fill, set up major mode hooks with your
-file file to turn it on (when appropriate) for you alone
+@file{.emacs} file to turn it on (when appropriate) for you alone
 (@pxref{Init File}).  Don't try to use a local variable list that would
 impose your taste on everyone working with the file.
 XEmacs allows you to specify local variables in the first line
 of a file, in addition to specifying them in the @code{Local Variables}
 If the first line of a file contains two occurrences of @code{`-*-'},
 XEmacs uses the information between them to determine what the major
 mode and variable settings should be.  For example, these are all legal:
 @example
-;;; -*- mode: emacs-lisp -*-
+	;;; -*- mode: emacs-lisp -*-
-;;; -*- mode: postscript; version-control: never -*-
+	;;; -*- mode: postscript; version-control: never -*-
-;;; -*- tags-file-name: "/foo/bar/TAGS" -*-
+	;;; -*- tags-file-name: "/foo/bar/TAGS" -*-
 @end example
 For historical reasons, the syntax @code{`-*- modename -*-'} is allowed
 as well; for example, you can use:
 @example
-;;; -*- emacs-lisp -*-
+	;;; -*- emacs-lisp -*-
 @end example
 @vindex enable-local-variables
 The variable @code{enable-local-variables} controls the use of local
 variables lists in files you visit.  The value can be @code{t},
 This inserts some Lisp code that, when executed later, will define the same
 macro with the same definition it has now.  You need not understand Lisp
 code to do this, because @code{insert-kbd-macro} writes the Lisp code for you.
 Then save the file.  You can load the file with @code{load-file}
 (@pxref{Lisp Libraries}).  If the file you save in is your initialization file
-(@pxref{Init File}), then the macro will be defined each
+@file{~/.emacs} (@pxref{Init File}), then the macro will be defined each
 time you run Emacs.
 If you give @code{insert-kbd-macro} a prefix argument, it creates
 additional Lisp code to record the keys (if any) that you have bound to the
 keyboard macro, so that the macro is reassigned the same keys when you
 all major modes except those that have their own overriding local
 definitions for the same key.  Or you can change the current buffer's
 local map, which affects all buffers using the same major mode.
 @menu
-* Interactive Rebinding::      Changing Key Bindings Interactively
+* Interactive Rebinding::     Changing Key Bindings Interactively
-* Programmatic Rebinding::     Changing Key Bindings Programmatically
+* Programmatic Rebinding::    Changing Key Bindings Programmatically
-* Key Bindings Using Strings:: Using Strings for Changing Key Bindings
+* Key Bindings Using Strings::Using Strings for Changing Key Bindings
 @end menu
 @node Interactive Rebinding
 @subsubsection Changing Key Bindings Interactively
 @findex global-set-key
 @code{spell-other-window}.
 @findex define-key
 @findex substitute-key-definition
 The most general way to modify a keymap is the function
-@code{define-key}, used in Lisp code (such as your init file).
+@code{define-key}, used in Lisp code (such as your @file{.emacs} file).
 @code{define-key} takes three arguments: the keymap, the key to modify
 in it, and the new definition.  @xref{Init File}, for an example.
 @code{substitute-key-definition} is used similarly; it takes three
 arguments, an old definition, a new definition, and a keymap, and
 redefines in that keymap all keys that were previously defined with the
 Here are some examples of programmatically binding keys:
 @example
 ;;;  Bind @code{my-command} to @key{f1}
 (global-set-key 'f1 'my-command)
 ;;;  Bind @code{my-command} to @kbd{Shift-f1}
 (global-set-key '(shift f1) 'my-command)
 ;;; Bind @code{my-command} to @kbd{C-c Shift-f1}
 (global-set-key '[(control c) (shift f1)] 'my-command)
 ;;; Bind @code{my-command} to the middle mouse button.
 (global-set-key 'button2 'my-command)
 ;;; Bind @code{my-command} to @kbd{@key{META} @key{CTL} @key{Right Mouse Button}}
 @cindex redefining keys
 After binding a command to two key sequences with a form like:
 @example
-(define-key global-map "\^X\^I" 'command-1)
+	(define-key global-map "\^X\^I" 'command-1)
 @end example
 it is possible to redefine only one of those sequences like so:
 @example
-(define-key global-map [(control x) (control i)] 'command-2)
+	(define-key global-map [(control x) (control i)] 'command-2)
-(define-key global-map [(control x) tab] 'command-3)
+	(define-key global-map [(control x) tab] 'command-3)
 @end example
 This applies only when running under a window system.  If you are
 talking to Emacs through an ASCII-only channel, you do not get any of
 these features.
 can be executed.  The purpose of disabling a command is to prevent
 beginning users from executing it by accident and being confused.
 The direct mechanism for disabling a command is to have a non-@code{nil}
 @code{disabled} property on the Lisp symbol for the command.  These
-properties are normally set by the user's init file with
+properties are normally set by the user's @file{.emacs} file with
 Lisp expressions such as:
 @example
 (put 'delete-region 'disabled t)
 @end example
-@xref{Init File}.
 If the value of the @code{disabled} property is a string, that string
 is included in the message printed when the command is used:
 @example
 "Text deleted this way cannot be yanked back!\n")
 @end example
 @findex disable-command
 @findex enable-command
-You can disable a command either by editing the init file
+You can disable a command either by editing the @file{.emacs} file
 directly or with the command @kbd{M-x disable-command}, which edits the
-init file for you.  @xref{Init File}.
+@file{.emacs} file for you.  @xref{Init File}.
 When you attempt to invoke a disabled command interactively in Emacs,
 a window is displayed containing the command's name, its
 documentation, and some instructions on what to do next; then
 Emacs asks for input saying whether to execute the command as requested,
 enable it and execute, or cancel it.  If you decide to enable the
 command, you are asked whether to do this permanently or just for the
 current session.  Enabling permanently works by automatically editing
-your init file.  You can use @kbd{M-x enable-command} at any
+your @file{.emacs} file.  You can use @kbd{M-x enable-command} at any
 time to enable any command permanently.
 Whether a command is disabled is independent of what key is used to
 invoke it; it also applies if the command is invoked using @kbd{M-x}.
 Disabling a command has no effect on calling it as a function from Lisp
 character includes both the string you have to pass to
 @code{modify-syntax-entry} to set up that character's current syntax,
 and some English to explain that string if necessary.
 @node Init File
-@section The Init File
+@section The Init File, .emacs
 @cindex init file
 @cindex Emacs initialization file
 @cindex key rebinding, permanent
 @cindex rebinding keys, permanently
-When you start Emacs, it normally loads either @file{.xemacs/init.el}
+When you start Emacs, it normally loads the file @file{.emacs} in your
-or the file @file{.emacs} (whichever comes first) in your home directory.
+home directory.  This file, if it exists, should contain Lisp code.  It
-This file, if it exists, should contain Lisp code.  It is called your
+is called your initialization file or @dfn{init file}.  Use the command
-initialization file or @dfn{init file}.  Use the command line switch
+line switches @samp{-q} and @samp{-u} to tell Emacs whether to load an
-@samp{-q} to tell Emacs whether to load an init file (@pxref{Entering
+init file (@pxref{Entering Emacs}).
-Emacs}).  Use the command line switch @samp{-user-init-file}
-(@pxref{Command Switches}) to tell Emacs to load a different file
+@vindex init-file-user
-instead of @file{~/.xemacs/init.el}/@file{~/.emacs}.
+When the @file{.emacs} file is read, the variable @code{init-file-user}
+says which user's init file it is.  The value may be the null string or a
-When the init file is read, the variable @code{user-init-file} says
+string containing a user's name.  If the value is a null string, it means
-which init file was loaded.
+that the init file was taken from the user that originally logged in.
+In all cases, @code{(concat "~" init-file-user "/")} evaluates to the
+directory name of the directory where the @file{.emacs} file was looked
+for.
 At some sites there is a @dfn{default init file}, which is the
 library named @file{default.el}, found via the standard search path for
 libraries.  The Emacs distribution contains no such library; your site
 may create one for local customizations.  If this library exists, it is
 loaded whenever you start Emacs.  But your init file, if any, is loaded
 first; if it sets @code{inhibit-default-init} non-@code{nil}, then
 @file{default} is not loaded.
-If you have a large amount of code in your init file, you should
+If you have a large amount of code in your @file{.emacs} file, you
-byte-compile it to @file{~/.xemacs/init.elc} or @file{~/.emacs.elc}.
+should move it into another file named @file{@var{something}.el},
+byte-compile it (@pxref{Lisp Libraries}), and load that file from your
+@file{.emacs} file using @code{load}.
 @menu
 * Init Syntax::     Syntax of constants in Emacs Lisp.
 * Init Examples::   How to do some things with an init file.
 * Terminal Init::   Each terminal type can have an init file.
 @end menu
 @node Init Syntax
 @subsection Init File Syntax
-The init file contains one or more Lisp function call
+The @file{.emacs} file contains one or more Lisp function call
 expressions.  Each consists of a function name followed by
 arguments, all surrounded by parentheses.  For example, @code{(setq
 fill-column 60)} represents a call to the function @code{setq} which is
 used to set the variable @code{fill-column} (@pxref{Filling}) to 60.
 The second argument to @code{setq} is an expression for the new value
 of the variable.  This can be a constant, a variable, or a function call
-expression.  In the init file, constants are used most of the time.
+expression.  In @file{.emacs}, constants are used most of the time.
 They can be:
 @table @asis
 @item Numbers
 Integers are written in decimal, with an optional initial minus sign.
 the library @file{term/aaa}.  The code in the library can use
 @code{(getenv "TERM")} to find the full terminal type name.@refill
 @vindex term-file-prefix
 The library's name is constructed by concatenating the value of the
-variable @code{term-file-prefix} and the terminal type.  Your init
+variable @code{term-file-prefix} and the terminal type.  Your @file{.emacs}
 file can prevent the loading of the terminal-specific library by setting
-@code{term-file-prefix} to @code{nil}.  @xref{Init File}.
+@code{term-file-prefix} to @code{nil}.
 @vindex term-setup-hook
 The value of the variable @code{term-setup-hook}, if not @code{nil}, is
 called as a function of no arguments at the end of Emacs initialization,
-after both your init file and any terminal-specific library have been
+after both your @file{.emacs} file and any terminal-specific library have
-read.  @xref{Init File}.  You can set the value in the init file to
+been read.  You can set the value in the @file{.emacs} file to override
-override part of any of the terminal-specific libraries and to define
+part of any of the terminal-specific libraries and to define
 initializations for terminals that do not have a library.@refill
 @node Audible Bell
 @section Changing the Bell Sound
 @cindex audible bell, changing
 The Emacs command loop catches an error
 @item undefined-key
 You type a key that is undefined
 @item undefined-click
 You use an undefined mouse-click combination
 @item no-completion
 Completion was not possible
 @item y-or-n-p
 You type something other than the required @code{y} or @code{n}
 @item yes-or-no-p
 You type something other than @code{yes} or @code{no}
 @end table
 @comment  node-name,  next,  previous,  up
 @node Faces
 @code{set-face-underline-p}. The argument @var{underline-p} can be used
 to make underlining an attribute of the face or not. If the optional
 @var{frame} argument is provided, the face is changed only in that
 frame; otherwise, it is changed in all frames.
-@node Frame Components
-@section Frame Components
-You can control the presence and position of most frame components, such
-as the menubar, toolbars, and gutters.
-This section is not written yet.  Try the Lisp Reference Manual:
-@ref{Menubar,,,lispref,}, @ref{Toolbar Intro,,,lispref,}, and
-@ref{Gutter Intro,,,lispref,}.
 @node X Resources
 @section X Resources
 @cindex X resources
 @findex x-create-frame
 run both variants.
 Starting with XEmacs 21, XEmacs uses the class @samp{XEmacs} if it finds
 any XEmacs resources in the resource database when the X connection is
 initialized.  Otherwise, it will use the class @samp{Emacs} for
-backwards compatibility.  The variable @var{x-emacs-application-class}
+backwards compatability.  The variable @var{x-emacs-application-class}
 may be consulted to determine the application class being used.
 The examples in this section assume the application class is @samp{Emacs}.
 The Emacs resources are generally set per-frame. Each Emacs frame can have
 @end example
 @noindent
 @menu
 * Geometry Resources::     Controlling the size and position of frames.
-* Iconic Resources::       Controlling whether frames come up iconic.
+* Iconic Resources::	   Controlling whether frames come up iconic.
-* Resource List::          List of resources settable on a frame or device.
+* Resource List::	   List of resources settable on a frame or device.
-* Face Resources::         Controlling faces using resources.
+* Face Resources::	   Controlling faces using resources.
-* Widgets::                The widget hierarchy for XEmacs.
+* Widgets::		   The widget hierarchy for XEmacs.
-* Menubar Resources::      Specifying resources for the menubar.
+* Menubar Resources::	   Specifying resources for the menubar.
 @end menu
 @node Geometry Resources
 @subsection Geometry Resources
 @item @code{attributeForeground} (class @code{AttributeForeground}): color-name
 @itemx @code{attributeBackground} (class @code{AttributeBackground}): color-name
 The foreground and background colors of this face.
 @item @code{attributeBackgroundPixmap} (class @code{AttributeBackgroundPixmap}): file-name
-The name of an @sc{xbm} file (or @sc{xpm} file, if your version of Emacs
+The name of an @sc{XBM} file (or @sc{XPM} file, if your version of Emacs
-supports @sc{xpm}), to use as a background stipple.
+supports @sc{XPM}), to use as a background stipple.
 @item @code{attributeUnderline} (class @code{AttributeUnderline}): boolean
 Whether text in this face should be underlined.
 @end table
 @node Menubar Resources
 @subsection Menubar Resources
 As the menubar is implemented as a widget which is not a part of XEmacs
-proper, it does not use the face mechanism for specifying fonts and
+proper, it does not use the fac" mechanism for specifying fonts and
 colors: It uses whatever resources are appropriate to the type of widget
 which is used to implement it.
 If Emacs was compiled to use only the Motif-lookalike menu widgets, then one
 way to specify the font of the menubar would be

Mercurial > hg > xemacs-beta

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