(rmail-inbox-alist): Doc.

diff --git a/lisp/mail/ChangeLog b/lisp/mail/ChangeLog
index 442775761e71e1fdf09de2ace70b657a2916d566..ea071ac7d0aa4e3f7c442b4a614b536bf1b61655 100644 (file)
--- a/lisp/mail/ChangeLog
+++ b/lisp/mail/ChangeLog
@@ -1,3 +1,7 @@
+2006-01-20  Alex Schroeder  <alex@gnu.org>
+
+       * rmail.el (rmail-inbox-alist): Doc.
+
 2006-01-20  Henrik Enberg  <enberg@printf.se>
 
        * rmailsum.el (rmail-summary-get-sender): New function.

diff --git a/lisp/mail/rmail.el b/lisp/mail/rmail.el
index b1d5cee830ea64ab7e3199918d618ee1075d8b96..98865e43621df4abc496a1d083d523c53ca774f0 100644 (file)
--- a/lisp/mail/rmail.el
+++ b/lisp/mail/rmail.el
@@ -358,8 +358,14 @@ and the value of the environment variable MAIL overrides it)."
 ;;;###autoload
 (defcustom rmail-inbox-alist nil
   "*Alist of mail files and backup directory names.
-Each element looks like (MAIL-FILE . INBOX-LIST).  Mail files with
-names matching MAIL-FILE will retrieve mail from files in INBOX-LIST."
+Each element has the form (MAIL-FILE INBOX ...).  When running
+rmail on MAIL-FILE, mails in all the INBOX files listed will be
+moved to the MAIL-FILE.  Be sure to fully qualify your MAIL-FILE.
+
+Example setting if procmail delivers all your spam to
+~/Mail/SPAM.in and you read it from the file ~/Mail/SPAM:
+
+\(setq rmail-inbox-alist '((\"~/Mail/SPAM\" \"~/Mail/SPAM.in\")))"
   :type '(alist :key-type file :value-type (repeat file))
   :group 'rmail-retrieve
   :group 'rmail-files)