/usr/share/doc/mailutils-doc/mailutils.html/configuration.html is in mailutils-doc 1:2.99.99-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Published by the Free Software Foundation,
51 Franklin Street, Fifth Floor
Boston, MA 02110-1301, USA
Copyright (C) 1999-2004, 2008-2012, 2014-2015 Free Software
Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover, and no Back-Cover texts.
A copy of the license is included in the section entitled "GNU Free
Documentation License". -->
<!-- Created by GNU Texinfo 6.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Mailutils Manual: configuration</title>
<meta name="description" content="GNU Mailutils Manual: configuration">
<meta name="keywords" content="GNU Mailutils Manual: configuration">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-Index.html#Function-Index" rel="index" title="Function Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Programs.html#Programs" rel="up" title="Programs">
<link href="conf_002dsyntax.html#conf_002dsyntax" rel="next" title="conf-syntax">
<link href="Common-Options.html#Common-Options" rel="prev" title="Common Options">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en">
<a name="configuration"></a>
<div class="header">
<p>
Next: <a href="debugging.html#debugging" accesskey="n" rel="next">debugging</a>, Previous: <a href="command-line.html#command-line" accesskey="p" rel="prev">command line</a>, Up: <a href="Programs.html#Programs" accesskey="u" rel="up">Programs</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Mailutils-Configuration-File"></a>
<h3 class="section">2.2 Mailutils Configuration File</h3>
<a name="index-Mailutils-configuration-file"></a>
<a name="index-mailutils_002erc"></a>
<p>Configuration files are the principal means of configuring any GNU
Mailutils component. When started, each utility tries to load its
configuration from the following locations, in that order:
</p>
<ol>
<li> Main site-wide configuration file.
<p>It is named <samp><var>sysconfdir</var>/mailutils.rc</samp>, where <var>sysconfdir</var> stands
for the system configuration directory set when compiling the package.
You can obtain the value of <var>sysconfdir</var> by running
</p>
<div class="example">
<pre class="example">$ mailutils-config --info sysconfdir
</pre></div>
<p>or
</p>
<div class="example">
<pre class="example">$ <var>prog</var> --show-config-options | grep SYSCONFDIR
</pre></div>
<p>where <var>prog</var> stands for any GNU Mailutils utility.
</p>
<a name="index-no_002dsite_002dconfig_002c-_002d_002dno_002dsite_002dconfig-option_002c-described"></a>
<p>The site-wide configuration file is not read if the <samp>--no-site-config</samp>
command line option was given.
</p>
</li><li> Per-user configuration file.
<p>A per user configuration file is located in the user home directory
and is named ‘<samp>.<var>prog</var></samp>’, where <var>prog</var> is the name of the
utility. For example, the per-user configuration file for
<code>sieve</code> utility is named <samp>.sieve</samp>.
</p>
<a name="index-no_002duser_002dconfig_002c-_002d_002dno_002duser_002dconfig-option_002c-described"></a>
<p>This configuration file is not read if the <samp>--no-user-config</samp>
command line option was given.
</p>
</li><li> <a name="index-config_002dfile_002c-_002d_002dconfig_002dfile-option_002c-described"></a>
Additional configuration file, if specified using the
<samp>--config-file</samp> command line option.
</li></ol>
<p>The order in which configuration files are loaded defines the
precedence of their settings. Thus, the settings from additional
configuration file override those set in per-user configuration file.
The latter, in their turn, take precedence over the settings from the
site-wide configuration file.
</p>
<a name="index-config_002dverbose_002c-_002d_002dconfig_002dverbose-option_002c-described"></a>
<p>Neither site-wide nor user configuration files are required to
exist. If any or both of them are absent, GNU Mailutils does not
complain, and the utility falls back to its default settings. To make
configuration processing more verbose, use the
<samp>--config-verbose</samp> command line option. Here is an example of
what you might get using this option:
</p>
<div class="example">
<pre class="example">imap4d: Info: parsing file `/etc/mailutils.rc'
imap4d: Info: finished parsing file `/etc/mailutils.rc'
</pre></div>
<p>Specifying this option more than once adds more verbosity to this
output. If this option is given two times, GNU Mailutils will print
any configuration file statement it parsed, along with the exact
location where it occurred (the exact meaning of each statement will
be described later in this chapter):
</p>
<div class="example">
<pre class="example">imap4d: Info: parsing file `/etc/mailutils.rc'
# 1 "/etc/mailutils.rc"
mailbox {
# 2 "/etc/mailutils.rc"
mailbox-pattern maildir:/var/spool/mail;type=index;param=2;user=${user};
# 3 "/etc/mailutils.rc"
mailbox-type maildir;
};
# 6 "/etc/mailutils.rc"
include /etc/mailutils.d;
imap4d: Info: parsing file `/etc/mailutils.d/imap4d'
...
</pre></div>
<a name="index-config_002dlint_002c-_002d_002dconfig_002dlint-option_002c-described"></a>
<p>To test configuration file without actually starting the utility,
use the <samp>--config-lint</samp> command line option. With this option,
any Mailutils utility exits after finishing parsing of the
configuration files. Any errors occurred during parsing are displayed
on the standard error output. This option can be combined with
<samp>--config-verbose</samp> to obtain more detailed output.
</p>
<a name="index-config_002dhelp_002c-_002d_002dconfig_002dhelp-option_002c-described"></a>
<p>The <samp>--config-help</samp> command line option produces on the
standard output the summary of all configuration statements understood
by the utility, with detailed comments and in the form suitable for
configuration file. For example, the simplest way to write a
configuration file for, say, <code>imap4d</code> is to run
</p>
<div class="example">
<pre class="example">$ imap4d --config-help > imap4d.rc
</pre></div>
<p>and to edit the <samp>imap4d.rc</samp> file with your editor of choice.
</p>
<a name="index-set_002c-_002d_002dset-option_002c-described"></a>
<p>It is also possible to set or override arbitrary configuration
variables in the command line. It can be done via the <samp>--set</samp>
option. Its argument is a <em>pathname</em> of the variable to be set.
For example, to define the variable ‘<samp>syslog</samp>’ in section
‘<samp>logging</samp>’ to ‘<samp>no</samp>’, do the following:
</p>
<div class="example">
<pre class="example">$ imap4d --set .logging.syslog=no
</pre></div>
<p>Configuration pathnames are discussed in detail in <a href="Paths.html#Paths">Paths</a>.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="conf_002dsyntax.html#conf_002dsyntax" accesskey="1">conf-syntax</a>:</td><td> </td><td align="left" valign="top">Configuration File Syntax
</td></tr>
<tr><td align="left" valign="top">• <a href="Include.html#Include" accesskey="2">Include</a>:</td><td> </td><td align="left" valign="top">Include Statement
</td></tr>
<tr><td align="left" valign="top">• <a href="Logging-Statement.html#Logging-Statement" accesskey="3">Logging Statement</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="Debug-Statement.html#Debug-Statement" accesskey="4">Debug Statement</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="Mailbox-Statement.html#Mailbox-Statement" accesskey="5">Mailbox Statement</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="Locking-Statement.html#Locking-Statement" accesskey="6">Locking Statement</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="Mailer-Statement.html#Mailer-Statement" accesskey="7">Mailer Statement</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="ACL-Statement.html#ACL-Statement" accesskey="8">ACL Statement</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="Tcp_002dwrappers-Statement.html#Tcp_002dwrappers-Statement" accesskey="9">Tcp-wrappers Statement</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="Server-Settings.html#Server-Settings">Server Settings</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="Auth-Statement.html#Auth-Statement">Auth Statement</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="PAM-Statement.html#PAM-Statement">PAM Statement</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="Virtdomain-Statement.html#Virtdomain-Statement">Virtdomain Statement</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="Radius-Statement.html#Radius-Statement">Radius Statement</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="SQL-Statement.html#SQL-Statement">SQL Statement</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="LDAP-Statement.html#LDAP-Statement">LDAP Statement</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="TLS-Statement.html#TLS-Statement">TLS Statement</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="GSASL-Statement.html#GSASL-Statement">GSASL Statement</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<div class="header">
<p>
Next: <a href="debugging.html#debugging" accesskey="n" rel="next">debugging</a>, Previous: <a href="command-line.html#command-line" accesskey="p" rel="prev">command line</a>, Up: <a href="Programs.html#Programs" accesskey="u" rel="up">Programs</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|