*** empty log message ***
[bpt/emacs.git] / lisp / options.el
index e67346c..3697de1 100644 (file)
@@ -1,11 +1,14 @@
-;; Edit Options command for Emacs.
+;;; options.el --- edit Options command for Emacs.
+
 ;; Copyright (C) 1985 Free Software Foundation, Inc.
 
+;; Maintainer: FSF
+
 ;; This file is part of GNU Emacs.
 
 ;; GNU Emacs is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 1, or (at your option)
+;; the Free Software Foundation; either version 2, or (at your option)
 ;; any later version.
 
 ;; GNU Emacs is distributed in the hope that it will be useful,
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to
-;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
+
+;;; Commentary:
+
+;; This code provides functions to list and edit the values of all global
+;; option variables known to loaded Emacs Lisp code.  There are two entry
+;; points, `list-options' and `edit' options'.  The latter enters a major
+;; mode specifically for editing option values.  Do `M-x describe-mode' in
+;; that context for more details.
+
+;; The customization buffer feature is intended to make this obsolete.
 
+;;; Code:
 
+;;;###autoload
 (defun list-options ()
   "Display a list of Emacs user options, with values and documentation."
   (interactive)
-  (save-excursion
-    (set-buffer (get-buffer-create "*List Options*"))
-    (Edit-options-mode))
   (with-output-to-temp-buffer "*List Options*"
     (let (vars)
       (mapatoms (function (lambda (sym)
       (setq vars (sort vars 'string-lessp))
       (while vars
        (let ((sym (car vars)))
-         (princ ";; ")
-         (prin1 sym)
-         (princ ":\n\t")
-         (prin1 (symbol-value sym))
-         (terpri)
-         (princ (substitute-command-keys 
-                 (documentation-property sym 'variable-documentation)))
-         (princ "\n;;\n"))
-       (setq vars (cdr vars))))))
-
+         (when (boundp sym)
+           (princ ";; ")
+           (prin1 sym)
+           (princ ":\n\t")
+           (prin1 (symbol-value sym))
+           (terpri)
+           (princ (substitute-command-keys 
+                   (documentation-property sym 'variable-documentation)))
+           (princ "\n;;\n"))
+         (setq vars (cdr vars))))
+      (with-current-buffer "*List Options*"
+       (Edit-options-mode)
+       (setq buffer-read-only t)))))
+
+;;;###autoload
 (defun edit-options ()
   "Edit a list of Emacs user option values.
 Selects a buffer containing such a list,
 in which there are commands to set the option values.
-Type \\[describe-mode] in that buffer for a list of commands."
+Type \\[describe-mode] in that buffer for a list of commands.
+
+The Custom feature is intended to make this obsolete."
   (interactive)
   (list-options)
   (pop-to-buffer "*List Options*"))
@@ -84,7 +104,7 @@ For convenience, the characters \\[backward-paragraph] and \\[forward-paragraph]
   (make-local-variable 'paragraph-separate)
   (setq paragraph-separate "[^\^@-\^?]")
   (make-local-variable 'paragraph-start)
-  (setq paragraph-start "^\t")
+  (setq paragraph-start "\t")
   (setq truncate-lines t)
   (setq major-mode 'Edit-options-mode)
   (setq mode-name "Options")
@@ -105,7 +125,7 @@ For convenience, the characters \\[backward-paragraph] and \\[forward-paragraph]
 
 (defun Edit-options-modify (modfun)
   (save-excursion
-   (let (var pos)
+   (let ((buffer-read-only nil) var pos)
      (re-search-backward "^;; \\|\\`")
      (forward-char 3)
      (setq pos (point))
@@ -121,3 +141,6 @@ For convenience, the characters \\[backward-paragraph] and \\[forward-paragraph]
      (kill-sexp 1)
      (prin1 (symbol-value var) (current-buffer)))))
 
+(provide 'options)
+
+;;; options.el ends here