[dovecot-cvs] dovecot/doc mail-storages.txt,1.2,1.3

[cras at procontrol.fi]

Update of /home/cvs/dovecot/doc
In directory danu:/tmp/cvs-serv24537/doc

Modified Files:
	mail-storages.txt 
Log Message:
Support for separate location of mbox INBOX folder.



Index: mail-storages.txt
===================================================================
RCS file: /home/cvs/dovecot/doc/mail-storages.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- mail-storages.txt	15 Oct 2002 00:47:53 -0000	1.2
+++ mail-storages.txt	20 Dec 2002 06:00:07 -0000	1.3
@@ -16,14 +16,18 @@
 mbox
 ----
 
-mbox storage currently requires that all mail is in user-writable
-directory, eg. ~/mail. Especially using /var/mail/user is NOT supported.
-You may however create a ~/mail/inbox hardlink (or symlink if not chrooted)
-to pointing to /var/mail/user. All files in the mail directory are
-considered as mailboxes. Directories specify subfolders in IMAP. "inbox"
-file specifies the INBOX folder and can not be named otherwise. Indexes are
-stored into ".imap/<mailbox name>/" directories.
+mbox storage requires an IMAP root directory where to store IMAP folders
+and some other information. mbox file for INBOX is a special case which may
+exist elsewhere in filesystem.
 
+All files in the IMAP root directory not beginning with a "." are treated
+as IMAP folders. Directories are treated as being IMAP subfolders.
+
+Dovecot's indexes are stored in ".imap/<mailbox name>/" directories under
+the folder directories.
+
+MAIL environment for mbox is: <root folder>|<INBOX path>[:INBOX=<path>].
+For example ~/Mail:INBOX=/var/mail/username.
 
 Detecting what to use
 ---------------------
@@ -44,9 +48,12 @@
 we have rwx access to it. If directory isn't known, / and ~/Maildir are
 checked. / is checked because we could be chrooted.
 
-mbox storage is autodetected by checking if .imap/ (+rwx), inbox (+rw) or
-mbox (+rw) exists in directory. If directory isn't known, / is tried first.
-After that, ~/mail and ~/Mail directories are used.
+mbox storage requires detecting INBOX location and IMAP root directory. If
+MAIL environment points to file (+rw) it's treated as the INBOX file. If it
+points to directory (+rwx) which contains .imap/ (+rwx), inbox (+rw) or
+mbox (+rw) it's treated as IMAP root directory. If INBOX isn't known,
+imap_root/inbox file is used by default. If root directory isn't known, we
+try to find it from /, ~/mail or ~/Mail.
 
 
 Files created by Dovecot