-;; 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."
+ "Display a list of Emacs user options, with values and documentation.
+It is now better to use Customize instead."
(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*"))
(put 'Edit-options-mode 'mode-class 'special)
(defun Edit-options-mode ()
- "Major mode for editing Emacs user option settings.
+ "\\<Edit-options-mode-map>\
+Major mode for editing Emacs user option settings.
Special commands are:
-s -- set variable point points at. New value read using minibuffer.
-x -- toggle variable, t -> nil, nil -> t.
-1 -- set variable to t.
-0 -- set variable to nil.
+\\[Edit-options-set] -- set variable point points at. New value read using minibuffer.
+\\[Edit-options-toggle] -- toggle variable, t -> nil, nil -> t.
+\\[Edit-options-t] -- set variable to t.
+\\[Edit-options-nil] -- set variable to nil.
Changed values made by these commands take effect immediately.
Each variable description is a paragraph.
-For convenience, the characters p and n move back and forward by paragraphs."
+For convenience, the characters \\[backward-paragraph] and \\[forward-paragraph] move back and forward by paragraphs."
(kill-all-local-variables)
(set-syntax-table emacs-lisp-mode-syntax-table)
(use-local-map Edit-options-mode-map)
(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")
(defun Edit-options-set () (interactive)
(Edit-options-modify
- '(lambda (var) (eval-minibuffer (concat "New " (symbol-name var) ": ")))))
+ (lambda (var) (eval-minibuffer (concat "New " (symbol-name var) ": ")))))
(defun Edit-options-toggle () (interactive)
- (Edit-options-modify '(lambda (var) (not (symbol-value var)))))
+ (Edit-options-modify (lambda (var) (not (symbol-value var)))))
(defun Edit-options-t () (interactive)
- (Edit-options-modify '(lambda (var) t)))
+ (Edit-options-modify (lambda (var) t)))
(defun Edit-options-nil () (interactive)
- (Edit-options-modify '(lambda (var) nil)))
+ (Edit-options-modify (lambda (var) nil)))
(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))
(kill-sexp 1)
(prin1 (symbol-value var) (current-buffer)))))
+(provide 'options)
+
+;;; options.el ends here