From: Richard M. Stallman Date: Sat, 7 Jun 1997 23:12:19 +0000 (+0000) Subject: Customize. Doc fixes. X-Git-Tag: emacs-20.1~1785 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=31407d5d6ea78e278ee60e2cf5be1a6dc6339e9e;p=emacs.git Customize. Doc fixes. Mark some risky local variables. --- diff --git a/lisp/mail/mailalias.el b/lisp/mail/mailalias.el index 54362f11014..f30402f7c9e 100644 --- a/lisp/mail/mailalias.el +++ b/lisp/mail/mailalias.el @@ -32,21 +32,19 @@ (require 'sendmail) -(defvar mail-names t - "Alist of local users, aliases and directory entries as available. -Elements have the form (MAILNAME) or (MAILNAME . FULLNAME). -If the value means t, it means the real value should be calculated -for the next use. this is used in `mail-complete'.") +(defgroup mailalias nil + "Expanding mail aliases" + :group 'mail) -(defvar mail-local-names t - "Alist of local users. -When t this still needs to be initialized.") - -(defvar mail-passwd-files '("/etc/passwd") - "List of files from which to determine valid user names.") +(defcustom mail-passwd-files '("/etc/passwd") + "*List of files from which to determine valid user names." + :type '(repeat string) + :group 'mailalias) -(defvar mail-passwd-command nil - "Shell command to retrieve text to add to `/etc/passwd', or nil.") +(defcustom mail-passwd-command nil + "*Shell command to retrieve text to add to `/etc/passwd', or nil." + :type '(choice string (const nil)) + :group 'mailalias) (defvar mail-directory-names t "Alist of mail address directory entries. @@ -55,7 +53,7 @@ When t this still needs to be initialized.") (defvar mail-address-field-regexp "^\\(Resent-\\)?\\(To\\|From\\|CC\\|BCC\\|Reply-to\\):") -(defvar mail-complete-alist +(defcustom mail-complete-alist `((,mail-address-field-regexp mail-get-names pattern) ("Newsgroups:" . (if (boundp 'gnus-active-hashtb) gnus-active-hashtb @@ -64,60 +62,94 @@ When t this still needs to be initialized.") ("Followup-To:" . (mail-sentto-newsgroups)) ;;("Distribution:" ???) ) - "Alist of header field and expression to return alist for completion. -Expression may reference variable `pattern' which is the string being completed. -If not on matching header, `mail-complete-function' gets called instead.") + "*Alist of header field and expression to return alist for completion. +The expression may reference the variable `pattern' +which will hold the string being completed. +If not on matching header, `mail-complete-function' gets called instead." + :type 'sexp + :group 'mailalias) +(put 'mail-complete-alist 'risky-local-variable t) ;;;###autoload -(defvar mail-complete-style 'angles +(defcustom mail-complete-style 'angles "*Specifies how \\[mail-complete] formats the full name when it completes. If `nil', they contain just the return address like: king@grassland.com If `parens', they look like: king@grassland.com (Elvis Parsley) If `angles', they look like: - Elvis Parsley ") - -(defvar mail-complete-function 'ispell-complete-word - "Function to call when completing outside `mail-complete-alist'-header.") - + Elvis Parsley " + :type '(choice (const angles) (const parens) (const nil)) + :group 'mailalias) -(defvar mail-directory-function nil - "Function to get completions from directory service or `nil' for none. -See `mail-directory-requery'.") +(defcustom mail-complete-function 'ispell-complete-word + "*Function to call when completing outside `mail-complete-alist'-header." + :type '(choice function (const nil)) + :group 'mailalias) +(defcustom mail-directory-function nil + "*Function to get completions from directory service or `nil' for none. +See `mail-directory-requery'." + :type '(choice function (const nil)) + :group 'mailalias) ;; This is for when the directory is huge, or changes frequently. -(defvar mail-directory-requery nil - "When non-`nil' call `mail-directory-function' for each completion. +(defcustom mail-directory-requery nil + "*When non-`nil' call `mail-directory-function' for each completion. In that case, one argument gets passed to the function, the partial string -entered so far.") +entered so far." + :type 'boolean + :group 'mailalias) +(defcustom mail-directory-process nil + "*Shell command to get the list of names from a mail directory. +This value is used when the value of `mail-directory-function' +is `mail-directory-process'. The value should be a list +of the form (COMMAND ARG ...), where each of the list elements +is evaluated. When `mail-directory-requery' is non-nil, during +evaluation of these elements, the variable `pattern' contains +the partial input being completed. -(defvar mail-directory-process nil - "Unix command when `mail-directory-function' is `mail-directory-process'. -This is a list of the form (COMMAND ARG ...), where each of the list elements -is evaluated. When `mail-directory-requery' is non-`nil', during -evaluation the variable `pattern' contains the partial input being completed. -This might look like +The value might look like this: '(remote-shell-program \"HOST\" \"-nl\" \"USER\" \"COMMAND\") -or +or like this: - '(remote-shell-program \"HOST\" \"-n\" \"COMMAND '^\" pattern \"'\")") + '(remote-shell-program \"HOST\" \"-n\" \"COMMAND '^\" pattern \"'\")" + :type 'sexp + :group 'mailalias) +(put 'mail-directory-process 'risky-local-variable t) -(defvar mail-directory-stream () - "List of (HOST SERVICE) for stream connection to mail directory.") +(defcustom mail-directory-stream nil + "*List of (HOST SERVICE) for stream connection to mail directory." + :type 'sexp + :group 'mailalias) +(put 'mail-directory-stream 'risky-local-variable t) -(defvar mail-directory-parser nil - "How to interpret the output of `mail-directory-function'. +(defcustom mail-directory-parser nil + "*How to interpret the output of `mail-directory-function'. Three types of values are possible: - nil means to gather each line as one name - regexp means first \\(grouping\\) in successive matches is name - - function called at beginning of buffer that returns an alist of names") + - function called at beginning of buffer that returns an alist of names" + :type '(choice (cosnt nil) regexp function) + :group 'mailalias) +(put 'mail-directory-parser 'risky-local-variable t) +;; Internal variables. + +(defvar mail-names t + "Alist of local users, aliases and directory entries as available. +Elements have the form (MAILNAME) or (MAILNAME . FULLNAME). +If the value means t, it means the real value should be calculated +for the next use. this is used in `mail-complete'.") + +(defvar mail-local-names t + "Alist of local users. +When t this still needs to be initialized.") + ;; Called from sendmail-send-it, or similar functions, ;; only if some mail aliases are defined. @@ -451,7 +483,7 @@ Calls `mail-directory-function' and applies `mail-directory-parser' to output." (defun mail-directory-process (pattern) - "Call a Unix process to output names in directory. + "Run a shell command to output names in directory. See `mail-directory-process'." (apply 'call-process (eval (car mail-directory-process)) nil t nil (mapcar 'eval (cdr mail-directory-process))))