Commit 066c89f3 066c89f3d131954e302165ae482c619657a66db2 by Sam Roberts

Updated to match src.

1 parent 61e5693c
...@@ -30,14 +30,30 @@ inconvenient to specify them in the command line each time you run ...@@ -30,14 +30,30 @@ inconvenient to specify them in the command line each time you run
30 a mailutils utility. The @dfn{configuration files} provide a way to 30 a mailutils utility. The @dfn{configuration files} provide a way to
31 add default command line arguments without having to type them in 31 add default command line arguments without having to type them in
32 the command line. Upon startup, each mailutils utility scans and 32 the command line. Upon startup, each mailutils utility scans and
33 processes the contents of the three startup files: the site-wide 33 processes the contents of the three startup files, none of which
34 configuration file @file{mailutils.rc}, the user-specific configuration 34 are required to exist:
35 file @file{.mailutils}, and the program-specific configuration 35
36 file @file{.mu.@var{program}rc} (where @var{program} means the 36 @enumerate
37 program name). The site-wide configuration file is searched 37 @item
38 in your system configuration directory (usually, @file{/etc} or 38 the site-wide configuration file
39 @file{/usr/local/etc}), the user-specific and program-specific 39
40 configuration files are searched in the user's home directory. 40 @file{mailutils.rc}, found in your your system configuration directory
41 (usually @file{/etc} or @file{/usr/local/etc}).
42
43 @item
44 the user-specific configuration file
45
46 Usually @file{~/.mailutils}, unless @file{~/.mailutils} is a directory,
47 in which case @file{~/.mailutils/mailutils} is used.
48
49 @item
50 the programs-specific configuration file
51
52 Usually @file{~/.mu.@var{program}rc}, unless @file{~/.mailutils} is a
53 directory, in which case @file{~/.mailutils/@var{program}rc} is used
54 (where @var{program} means the program name).
55
56 @end enumerate
41 57
42 These files have simple line-oriented syntax. Comments begin with the 58 These files have simple line-oriented syntax. Comments begin with the
43 pound sign (@samp{#}) and extend through the end of the line 59 pound sign (@samp{#}) and extend through the end of the line
...@@ -46,20 +62,20 @@ should be separated from the previous word by any amount of whitespace.}. ...@@ -46,20 +62,20 @@ should be separated from the previous word by any amount of whitespace.}.
46 Very long lines may be split across several lines by escaping final newline 62 Very long lines may be split across several lines by escaping final newline
47 with a backslash (@samp{\}) character. 63 with a backslash (@samp{\}) character.
48 64
49 In the non-program-specific configuration files, any non-comment line 65 In the non-program-specific configuration files, any configuration line
50 must start with a @dfn{tag}. In the program-specific configuration 66 must start with a @dfn{tag}. In the program-specific configuration
51 file the tag must not be present, all options are for the specific 67 file the tag must not be present, all options are for that specific
52 program. 68 program.
53 69
54 A tag is either a name of a particular mailutils utility or @dfn{option 70 A tag is either a name of a particular mailutils utility or @dfn{option
55 group}, prefixed with colon (@samp{:}). The command line options common for 71 group}, prefixed with colon (@samp{:}). The command line options common for
56 several mailutils programs are divided into @dfn{option groups} or 72 several mailutils programs are divided into @dfn{option groups} or
57 @dfn{capabilities}, e.g. the options @option{--mail-spool} and 73 @dfn{capabilities}, e.g. the options @option{--mail-spool} and
58 @option{--license} form group @samp{mailutils}. These groups are discussed 74 @option{--lock-flags} form group @samp{mailbox}. These groups are discussed
59 in detail below. 75 in detail below.
60 76
61 When processing the non-program-specific configuration files 77 When processing the non-program-specific configuration files,
62 (@file{mailutils.rc} and @file{.mailutils}), a mailutils utility selects 78 a mailutils utility selects
63 those lines whose tag is either the name of that utility or the name 79 those lines whose tag is either the name of that utility or the name
64 of the option group supported by it. In the program-specific configuration 80 of the option group supported by it. In the program-specific configuration
65 file, all lines are selected. For each line found, its tag (if present) 81 file, all lines are selected. For each line found, its tag (if present)
...@@ -68,7 +84,7 @@ These words are regarded as command line options and are inserted to ...@@ -68,7 +84,7 @@ These words are regarded as command line options and are inserted to
68 the program arguments @emph{before} any options from the command line. 84 the program arguments @emph{before} any options from the command line.
69 Thus the options from @file{.mailutils} take precedence over those 85 Thus the options from @file{.mailutils} take precedence over those
70 from @file{mailutils.rc}, and the options from the command line take 86 from @file{mailutils.rc}, and the options from the command line take
71 precedence over those from both configuration files. 87 precedence over those from all three configuration files.
72 88
73 The word splitting occurs at whitespace characters and is similar to 89 The word splitting occurs at whitespace characters and is similar to
74 that performed by the shell. If an option must contain embedded 90 that performed by the shell. If an option must contain embedded
...@@ -76,25 +92,16 @@ whitespace, it should be enclosed in a pair of quotes (either double ...@@ -76,25 +92,16 @@ whitespace, it should be enclosed in a pair of quotes (either double
76 or single quotes). 92 or single quotes).
77 93
78 @menu 94 @menu
79 * mailutils:: Options common for all utilities. 95 * default:: Options understood by most GNU utilities.
80 * daemon:: Options common for daemon programs. 96 * mailbox:: Specifies the mail spool location, and locking strategy.
81 * auth:: Authentication-specific options. 97 * daemon:: Options common for daemon programs.
82 * logging:: Logging control options. 98 * auth:: Authentication-specific options.
83 * config sample:: A sample configuration file. 99 * logging:: Logging control options.
100 * config sample:: A sample configuration file.
84 @end menu 101 @end menu
85 102
86 @node mailutils 103 @node default
87 @subsection mailutils --- Options common for all utilities. 104 @subsection default --- Options understood by most GNU utilities.
88 @cindex :mailutils
89
90 Option group @samp{mailutils} consists of options common for all
91 utilities in the package:
92
93 @table @option
94 @item -m @var{path}
95 @itemx --mail-spool=@var{path}
96 Set path to the mailspool directory
97 @end table
98 105
99 Each program also understands the following informational options: 106 Each program also understands the following informational options:
100 107
...@@ -113,6 +120,21 @@ Display GNU General Public License and exit. ...@@ -113,6 +120,21 @@ Display GNU General Public License and exit.
113 Display program version and exit. 120 Display program version and exit.
114 @end table 121 @end table
115 122
123 @node mailbox
124 @subsection mailbox --- Specifies the mail spool location, and locking strategy.
125 @cindex :mailbox
126
127 Option group @samp{mailbox} consists of options used to specify the
128 location of the mail spool, and the locking strategy.
129
130 @table @option
131 @item -m @var{path}
132 @itemx --mail-spool=@var{path}
133 Set path to the mailspool directory
134 @item --lock-flags=@var{flags}
135 Set the default mailbox lock flags (E=external, R=retry, T=time, P=pid).
136 @end table
137
116 @node daemon 138 @node daemon
117 @subsection daemon --- Options common for daemon programs. 139 @subsection daemon --- Options common for daemon programs.
118 @cindex :daemon 140 @cindex :daemon
...@@ -195,7 +217,7 @@ facility @samp{local1}. ...@@ -195,7 +217,7 @@ facility @samp{local1}.
195 217
196 @example 218 @example
197 @group 219 @group
198 :mailutils --mail-spool /var/spool/mail 220 :mailbox --mail-spool /var/spool/mail
199 :auth --pam-service mailutils 221 :auth --pam-service mailutils
200 :logging --log-facility mail 222 :logging --log-facility mail
201 imap4d --daemon=20 --timeout=1800 --log-facility local1 223 imap4d --daemon=20 --timeout=1800 --log-facility local1
...@@ -224,7 +246,7 @@ The server runs as daemon, forking a child for each new connection. This ...@@ -224,7 +246,7 @@ The server runs as daemon, forking a child for each new connection. This
224 mode is triggered by @option{-d} command line switch. 246 mode is triggered by @option{-d} command line switch.
225 @end table 247 @end table
226 248
227 The program uses following option groups: @xref{mailutils}, 249 The program uses following option groups: @xref{mailbox},
228 @xref{daemon}, @xref{logging}, @xref{auth}. 250 @xref{daemon}, @xref{logging}, @xref{auth}.
229 251
230 @subheading Command line options 252 @subheading Command line options
...@@ -292,7 +314,7 @@ The server runs as daemon, forking a child for each new connection. This ...@@ -292,7 +314,7 @@ The server runs as daemon, forking a child for each new connection. This
292 mode is triggered by @option{-d} command line switch. 314 mode is triggered by @option{-d} command line switch.
293 @end table 315 @end table
294 316
295 The program uses following option groups: @xref{mailutils}, 317 The program uses following option groups: @xref{mailbox},
296 @xref{daemon}, @xref{logging}, @xref{auth}. 318 @xref{daemon}, @xref{logging}, @xref{auth}.
297 319
298 @subheading Command line options 320 @subheading Command line options
...@@ -340,7 +362,7 @@ user's system mailbox and outputs the contents of @code{From} and ...@@ -340,7 +362,7 @@ user's system mailbox and outputs the contents of @code{From} and
340 the command line, the program reads that folder rather than the default 362 the command line, the program reads that folder rather than the default
341 mailbox. 363 mailbox.
342 364
343 The program uses following option groups: @xref{mailutils}. 365 The program uses following option groups: @xref{mailbox}.
344 366
345 The following command line options alter the behavior of the program: 367 The following command line options alter the behavior of the program:
346 368
...@@ -419,7 +441,7 @@ General usage of @command{mail} program is: ...@@ -419,7 +441,7 @@ General usage of @command{mail} program is:
419 If [address...] part is present, @command{mail} switches to mail sending 441 If [address...] part is present, @command{mail} switches to mail sending
420 mode, otherwise it operates in mail reading mode. 442 mode, otherwise it operates in mail reading mode.
421 443
422 The program uses following option groups: @xref{mailutils}. 444 The program uses following option groups: @xref{mailbox}.
423 445
424 @command{Mail} understands following command line options: 446 @command{Mail} understands following command line options:
425 447
...@@ -1628,7 +1650,7 @@ and appends the received data to the local mailboxes. ...@@ -1628,7 +1650,7 @@ and appends the received data to the local mailboxes.
1628 @node Invocation 1650 @node Invocation
1629 @subsection Invoking mail.local 1651 @subsection Invoking mail.local
1630 1652
1631 The program uses following option groups: @xref{mailutils}, @xref{auth}, 1653 The program uses following option groups: @xref{mailbox}, @xref{auth},
1632 @xref{logging}. 1654 @xref{logging}.
1633 1655
1634 @table @option 1656 @table @option
...@@ -1776,7 +1798,7 @@ folder, the following output line is produced: ...@@ -1776,7 +1798,7 @@ folder, the following output line is produced:
1776 where @var{folder} represents the folder name, @var{number} represents 1798 where @var{folder} represents the folder name, @var{number} represents
1777 the number of messages. 1799 the number of messages.
1778 1800
1779 The program uses following option groups: @xref{mailutils}. 1801 The program uses following option groups: @xref{mailbox}.
1780 1802
1781 The program accepts following command line options: 1803 The program accepts following command line options:
1782 1804
...@@ -1884,7 +1906,7 @@ It processes mailboxes, applying the user-supplied scheme procedures ...@@ -1884,7 +1906,7 @@ It processes mailboxes, applying the user-supplied scheme procedures
1884 to each of them in turn and saves the resulting output in mailbox 1906 to each of them in turn and saves the resulting output in mailbox
1885 format. 1907 format.
1886 1908
1887 The program uses following option groups: @xref{mailutils}. 1909 The program uses following option groups: @xref{mailbox}.
1888 1910
1889 @menu 1911 @menu
1890 * Specifying Scheme Program to Execute:: 1912 * Specifying Scheme Program to Execute::
...@@ -2260,7 +2282,7 @@ either from @file{inetd.conf} or as a standalone daemon. ...@@ -2260,7 +2282,7 @@ either from @file{inetd.conf} or as a standalone daemon.
2260 @node Starting comsatd 2282 @node Starting comsatd
2261 @subsection Starting comsatd 2283 @subsection Starting comsatd
2262 2284
2263 @command{Comsatd} uses following option groups: @xref{mailutils}, 2285 @command{Comsatd} uses following option groups: @xref{mailbox},
2264 @xref{daemon}, @xref{logging}. 2286 @xref{daemon}, @xref{logging}.
2265 2287
2266 @table @option 2288 @table @option
......