[Emacs-diffs] Changes to emacs/man/custom.texi

[Chong Yidong]

Index: emacs/man/custom.texi
diff -u emacs/man/custom.texi:1.109 emacs/man/custom.texi:1.110
--- emacs/man/custom.texi:1.109 Wed Feb  8 02:29:14 2006
+++ emacs/man/custom.texi       Tue Feb 14 01:21:48 2006
@@ -1043,6 +1043,15 @@
 specifications; it automatically makes these variables local to the
 buffer, and sets them to the values specified in the file.
 
address@hidden
+* Specifying File Variables:: Specifying file local variables.
+* Unsafe File Variables::     Handling local variables that may not
+                              be safe.
address@hidden menu
+
address@hidden Specifying File Variables
address@hidden Specifying File Variables
+
   There are two ways to specify local variable values: in the first
 line, or with a local variables list.  Here's how to specify them in the
 first line:
@@ -1170,33 +1179,60 @@
 major mode of a buffer according to the file name and contents,
 including the local variables list if any.  @xref{Choosing Modes}.
 
address@hidden Unsafe File Variables
address@hidden Unsafe File Variables
+
+  File variables create a certain amount of risk; when you visit
+someone else's file, its variables could affect your Emacs in
+arbitrary ways.  A special risk is posed by the @code{eval}
+``variable,'' which can potentially execute arbitrary code, and
+certain actual variables such as @code{load-path}.
+
+  Therefore, whenever Emacs encounters file variables that are not
+known to be safe, it displays the entire list of variables defined in
+that file, and asks you for confirmation before setting them.  You can
+type @samp{y} or @samp{SPC} to apply the local variables list, or
address@hidden to ignore it.
+
+  There is a set of file variables and values that are known to be
+safe.  For instance, it is safe to give @code{comment-column} or
address@hidden any integer value.  If a file specifies only safe
+variable-value pairs, Emacs will not ask for confirmation before
+setting them.  You can also tell Emacs that a set of variable-value
+pairs is safe, by entering @samp{!} at the file variables confirmation
+prompt.  In that case, Emacs will not ask for confirmation if it
+encounters these variable-value pairs in the future.  You can directly
+edit the list of safe variable-value pairs by customizing
address@hidden (@pxref{Easy Customization}).
+
+  Some variables, such as @code{load-path}, are considered
address@hidden: there is seldom any reason to specify them as file
+variables, and changing them can be dangerous.  Even if you enter
address@hidden at the confirmation prompt, Emacs will not save these values
+for the future.  Therefore, you will be prompted each time the
+variable is encountered.  If you really want to allow such a variable,
+you can avoid the prompt by editing @samp{safe-local-variable-values}.
+
 @findex enable-local-variables
-  The variable @code{enable-local-variables} controls whether to process
-local variables in files, and thus gives you a chance to override them.
-Its default value is @code{t}, which means do process local variables in
-files.  If you set the value to @code{nil}, Emacs simply ignores local
-variables in files.  Any other value says to query you about each file
-that has local variables, showing you the local variable specifications
-so you can judge.
+  The variable @code{enable-local-variables} allows you to change the
+way Emacs processes local variables.  Its default value is @code{t},
+which means the behavior described above.  If you set the value to
address@hidden, Emacs simply ignores local variables in files.  Any other
+value says to query you about each file that has local variables, even
+if the variables are known to be safe.
 
 @findex enable-local-eval
-  The @code{eval} ``variable,'' and certain actual variables, create a
-special risk; when you visit someone else's file, local variable
-specifications for these could affect your Emacs in arbitrary ways.
-Therefore, the variable @code{enable-local-eval} controls whether Emacs
-processes @code{eval} variables, as well variables with names that end
-in @samp{-hook}, @samp{-hooks}, @samp{-function} or @samp{-functions},
-and certain other variables.  The three possibilities for the variable's
-value are @code{t}, @code{nil}, and anything else, just as for
address@hidden  The default is @code{maybe}, which is
-neither @code{t} nor @code{nil}, so normally Emacs does ask for
-confirmation about file settings for these variables.
+  The variable @code{enable-local-eval} controls whether Emacs
+processes @code{eval} variables.  The three possibilities for the
+variable's value are @code{t}, @code{nil}, and anything else, just as
+for @code{enable-local-variables}.  The default is @code{maybe}, which
+is neither @code{t} nor @code{nil}, so normally Emacs does ask for
+confirmation about processes @code{eval} variables.
 
 @findex safe-local-eval-forms
   The @code{safe-local-eval-forms} is a customizable list of eval
 forms which are safe to eval, so Emacs should not ask for
-confirmation to evaluate these forms, even if
address@hidden says to ask for confirmation in general.
+confirmation to evaluate these forms.
 
 @node Key Bindings
 @section Customizing Key Bindings