# HG changeset patch
# User Alex Schroeder <alex@gnu.org>
# Date 1137792631 0
# Node ID 7f3a04aaac5efae831e408192c376b5812b6fdd7
# Parent  a64eb026ac9e051ca967dc80bb405db3fd0b9522
(rmail-inbox-alist): Doc.

diff -r a64eb026ac9e -r 7f3a04aaac5e lisp/mail/rmail.el
--- a/lisp/mail/rmail.el	Fri Jan 20 18:50:02 2006 +0000
+++ b/lisp/mail/rmail.el	Fri Jan 20 21:30:31 2006 +0000
@@ -358,8 +358,14 @@
 ;;;###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)