Commit 60819415 608194155d80f470659a10f995dea6f337361532 by Sergey Poznyakoff

Added entry about mailutils.rc configuration file.

1 parent 8585aa93
...@@ -6,19 +6,66 @@ ...@@ -6,19 +6,66 @@
6 GNU Mailutils provides a set of programs for handling the email. 6 GNU Mailutils provides a set of programs for handling the email.
7 7
8 @menu 8 @menu
9 * imap4d:: IMAP4 daemon. 9 * configuration:: Common configuration file.
10 * pop3d:: POP3 daemon. 10 * imap4d:: IMAP4 daemon.
11 * frm:: List headers from a mailbox. 11 * pop3d:: POP3 daemon.
12 * mail:: Send and receive mail. 12 * frm:: List headers from a mailbox.
13 * mail.local:: Deliver mail to the local mailbox. 13 * mail:: Send and receive mail.
14 * messages:: Count the number of messages in a mailbox. 14 * mail.local:: Deliver mail to the local mailbox.
15 * readmsg:: Extract messages from a folder. 15 * messages:: Count the number of messages in a mailbox.
16 * sieve:: Filter a mailbox. 16 * readmsg:: Extract messages from a folder.
17 * guimb:: Mailbox scanning and processing language. 17 * sieve:: Filter a mailbox.
18 * comsatd:: Comsat daemon. 18 * guimb:: Mailbox scanning and processing language.
19 * comsatd:: Comsat daemon.
19 @end menu 20 @end menu
20 21
21 @page 22 @page
23 @node configuration
24 @section Mailutils configuration file
25 @cindex Mailutils configuration file
26 @cindex mailutils.rc
27
28 There are some command line options that are used so often that it is
29 inconvenient to specify them in the command line each time you run
30 a mailutils utility. The @file{mailutils.rc} provides a way to
31 add default command line arguments without having to type them in
32 the command line. The file is located in your system configuration
33 directory (usually, @file{/etc} or @file{/usr/local/etc}).
34 @footnote{Currently, the mailutils programs that use @file{mailutils.rc}
35 are:
36
37 @itemize @bullet
38 @item imap4d
39 @item pop3d
40 @item mail.local
41 @item comsatd
42 @end itemize}
43
44 The @file{mailutils.rc} has a simple line-oriented syntax. Upon
45 startup, each mailutils program scans this file for a line that
46 begins either with a program name or with word `mailutils'. When
47 found, the rest of the line following the first word is split up
48 at whitespace characters and resulting words are added to the
49 program arguments @emph{before} the command line options. Thus,
50 the options specified in the command line override those from
51 @file{mailutils.rc} file.
52
53 The very long lines may be split across several lines of text by
54 escaping final newline with a backslash (@samp{\}) character.
55 The @samp{#} character introduces comment.
56
57 Here is an example of a simple @file{mailutils.rc} file. It tells
58 all mailutils programs to use @file{/var/spool/mail} as a mailspool
59 directory. All programs, except @command{imap4d} will issue diagnostics
60 via @code{local1} @file{syslog} facility. @command{imap4d} will use
61 @code{local2}.
62
63 @example
64 mailutils --log-facility local1 --maildir /var/spool/mail
65 imap4d --log-facility local2 --daemon=10
66 @end example
67
68 @page
22 @node imap4d 69 @node imap4d
23 @section IMAP4 daemon 70 @section IMAP4 daemon
24 @pindex imap4d 71 @pindex imap4d
......