summaryrefslogtreecommitdiffstats
path: root/debian/manpages/update-exim4defaults.8
blob: da74a6542478ab79a998dc599e250ff2498fcc7b (plain)
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
.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH UPDATE-EXIM4DEFAULTS 8 "March 26, 2003" EXIM4
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.\" \(oqthis text is enclosed in single quotes\(cq
.\" \(lqthis text is enclosed in double quotes\(rq
.SH NAME
update\-exim4defaults \- Manage exim4 daemon default file.
.SH SYNOPSIS
.B update\-exim4defaults
.I [ \-\-qflags flags ]
.I [ \-\-queuerunner combined|queueonly|separate|ppp|no|nodaemon ]
.I [ \-\-queuetime time ]
.I [ \-\-commonoptions options ]
.I [ \-\-queuerunneroptions options ]
.I [ \-\-smtplisteneroptions options ]
.I [ \-\-remove\-common options ]
.I [ \-\-remove\-queue options ]
.I [ \-\-remove\-smtp options ]
.I [ \-\-force|\-f ]
.I [ \-\-help|\-h ]
.I [ \-\-init ]

.SH DESCRIPTION
.B update\-exim4defaults
allows one to set run parameters for the
.B Exim
daemon in
.I /etc/default/exim4.
Its main purpose is for interaction with packages enhancing
.B Exim
like virus-scanners that need to change the way the exim daemon is started.
.PP

.SH OPTIONS
.TP
.I \-\-help|\-h
Print short usage instructions and exit.
.TP
.I \-\-qflags flags
Set qflags, special flags given to exim directly after the \(lq\-q\(rq. See
.B exim(8)
for more information.
.TP
.I \-\-queuerunner combined|queueonly|separate|ppp|no|nodaemon
Should the init script start one daemon that listens on the smtp port for
incoming connections and runs the queue at regular intervals
.I (combined)
, or should it start two separate daemons, one listening on the smtp port,
the other running the queue
.I (separate)
, or should the queue only be run by /etc/ppp/ip\-up.d/exim4
.I (ppp)
, or shouldn't we run the queue at all, for example if you'd rather do this
with
.B cron
? Or should we only start a queuerunner
.I (queueonly)
or no daemon at all
.I (nodaemon)
?
.TP
.I \-\-queuetime time
In which intervals should we run the queue? This passed as option
.I \-q<qflags>time
to Exim, e.g. \-q30m or \-qq1h.
.TP
.I \-\-commonoptions options
Options passed both to queue\-running and listening instances of Exim.
.TP
.I \-\-queuerunneroptions options
Options only passed to the instance of Exim running the queue.
.TP
.I \-\-smtplisteneroptions options
Options only passed to the instance of Exim listening on the SMTP port.
.TP
.I \-\-force|\-f
Without this option
.B update\-exim4defaults
exits with an error if at least one of the options \-\-queuetime,
\-\-commonoptions, \-\-queuerunneroptions or \-\-smtplisteneroptions is used and the
corresponding value in /etc/default/exim4 is
.I already
set to a nonempty value.
.TP
.I \-\-remove\-common option
Try to remove the given option from COMMONOPTIONS.
.TP
.I \-\-remove\-queue option
Try to remove the given option from QUEUERUNNEROPTIONS.
.TP
.I \-\-remove\-smtp option
Try to remove the given option from SMTPLISTENEROPTIONS.
.PP
The \-\-remove\-commands cannot be used at the same time as any of \-\-commonoptions,
\-\-queuerunneroptions or \-\-smtplisteneroptions. The \-\-remove\-commands will
additionally remove whitespace at the beginning and the end of the option and
exchange multiple spaces wi a single one.
.TP
.I \-\-init
create a default /etc/default/exim4 file and exit immediately. Unless
.I \-\-force
was also specified
.B update\-exim4defaults
exits (successfully) without doing anything if /etc/default/exim4 already
exists. All other options are ignored.

.SH EXIT STATUS
.TP
.I 0
change was successful or nothing needed to be done.
.TP
.I 1
generic error: wrong options, unreadable configuration file, etc.
.TP
.I 2
QUEUEINTERVAL was already set.
.TP
.I 4
COMMONOPTIONS was already set.
.TP
.I 8
QUEUERUNNEROPTIONS was already set.
.TP
.I 16
SMTPLISTENEROPTIONS was already set.
.TP
.I 32
QFLAGS was already set.
.TP
.I 64
\-\-remove\-something failed, i.e. the value of the option was not changed.
.PP
Exit codes 2 to 32 will be summed up, if more than one unsuccessful option was
given.

.SH FILES
.TP
.I /etc/default/exim4
The configuration file.
.TP
.I /etc/init.d/exim4
The Exim init\-script.
.TP
.I /etc/ppp/ip\-up.d/exim4
The queuerunner in this file also uses COMMONOPTIONS and QUEUERUNNEROPTIONS and
does not run if QUEUERUNNER=no.


.SH BUGS
This manual page needs a major re-work. If somebody knows better groff
than us and has more experience in writing manual pages, any patches
would be greatly appreciated.

.SH SEE ALSO
.BR exim (8),
/usr/share/doc/exim4\-base/

.SH AUTHOR
Andreas Metzler <ametzler at downhill.at.eu.org>