| 1 | .\" Hey, EMACS: -*- nroff -*- |
| 2 | .\" First parameter, NAME, should be all caps |
| 3 | .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection |
| 4 | .\" other parameters are allowed: see man(7), man(1) |
| 5 | .TH UPDATE-EXIM4DEFAULTS 8 "March 26, 2003" EXIM4 |
| 6 | .\" Please adjust this date whenever revising the manpage. |
| 7 | .\" |
| 8 | .\" Some roff macros, for reference: |
| 9 | .\" .nh disable hyphenation |
| 10 | .\" .hy enable hyphenation |
| 11 | .\" .ad l left justify |
| 12 | .\" .ad b justify to both left and right margins |
| 13 | .\" .nf disable filling |
| 14 | .\" .fi enable filling |
| 15 | .\" .br insert line break |
| 16 | .\" .sp <n> insert n+1 empty lines |
| 17 | .\" for manpage-specific macros, see man(7) |
| 18 | .\" \(oqthis text is enclosed in single quotes\(cq |
| 19 | .\" \(lqthis text is enclosed in double quotes\(rq |
| 20 | .SH NAME |
| 21 | update\-exim4defaults \- Manage exim4 daemon default file. |
| 22 | .SH SYNOPSIS |
| 23 | .B update\-exim4defaults |
| 24 | .I [ \-\-qflags flags ] |
| 25 | .I [ \-\-queuerunner combined|queueonly|separate|ppp|no|nodaemon ] |
| 26 | .I [ \-\-queuetime time ] |
| 27 | .I [ \-\-commonoptions options ] |
| 28 | .I [ \-\-queuerunneroptions options ] |
| 29 | .I [ \-\-smtplisteneroptions options ] |
| 30 | .I [ \-\-remove\-common options ] |
| 31 | .I [ \-\-remove\-queue options ] |
| 32 | .I [ \-\-remove\-smtp options ] |
| 33 | .I [ \-\-force|\-f ] |
| 34 | .I [ \-\-help|\-h ] |
| 35 | .I [ \-\-init ] |
| 36 | |
| 37 | .SH DESCRIPTION |
| 38 | .B update\-exim4defaults |
| 39 | allows one to set run parameters for the |
| 40 | .B Exim |
| 41 | daemon in |
| 42 | .I /etc/default/exim4. |
| 43 | Its main purpose is for interaction with packages enhancing |
| 44 | .B Exim |
| 45 | like virus-scanners that need to change the way the exim daemon is started. |
| 46 | .PP |
| 47 | |
| 48 | .SH OPTIONS |
| 49 | .TP |
| 50 | .I \-\-help|\-h |
| 51 | Print short usage instructions and exit. |
| 52 | .TP |
| 53 | .I \-\-qflags flags |
| 54 | Set qflags, special flags given to exim directly after the \(lq\-q\(rq. See |
| 55 | .B exim(8) |
| 56 | for more information. |
| 57 | .TP |
| 58 | .I \-\-queuerunner combined|queueonly|separate|ppp|no|nodaemon |
| 59 | Should the init script start one daemon that listens on the smtp port for |
| 60 | incoming connections and runs the queue at regular intervals |
| 61 | .I (combined) |
| 62 | , or should it start two separate daemons, one listening on the smtp port, |
| 63 | the other running the queue |
| 64 | .I (separate) |
| 65 | , or should the queue only be run by /etc/ppp/ip\-up.d/exim4 |
| 66 | .I (ppp) |
| 67 | , or shouldn't we run the queue at all, for example if you'd rather do this |
| 68 | with |
| 69 | .B cron |
| 70 | ? Or should we only start a queuerunner |
| 71 | .I (queueonly) |
| 72 | or no daemon at all |
| 73 | .I (nodaemon) |
| 74 | ? |
| 75 | .TP |
| 76 | .I \-\-queuetime time |
| 77 | In which intervals should we run the queue? This passed as option |
| 78 | .I \-q<qflags>time |
| 79 | to Exim, e.g. \-q30m or \-qq1h. |
| 80 | .TP |
| 81 | .I \-\-commonoptions options |
| 82 | Options passed both to queue\-running and listening instances of Exim. |
| 83 | .TP |
| 84 | .I \-\-queuerunneroptions options |
| 85 | Options only passed to the instance of Exim running the queue. |
| 86 | .TP |
| 87 | .I \-\-smtplisteneroptions options |
| 88 | Options only passed to the instance of Exim listening on the SMTP port. |
| 89 | .TP |
| 90 | .I \-\-force|\-f |
| 91 | Without this option |
| 92 | .B update\-exim4defaults |
| 93 | exits with an error if at least one of the options \-\-queuetime, |
| 94 | \-\-commonoptions, \-\-queuerunneroptions or \-\-smtplisteneroptions is used and the |
| 95 | corresponding value in /etc/default/exim4 is |
| 96 | .I already |
| 97 | set to a nonempty value. |
| 98 | .TP |
| 99 | .I \-\-remove\-common option |
| 100 | Try to remove the given option from COMMONOPTIONS. |
| 101 | .TP |
| 102 | .I \-\-remove\-queue option |
| 103 | Try to remove the given option from QUEUERUNNEROPTIONS. |
| 104 | .TP |
| 105 | .I \-\-remove\-smtp option |
| 106 | Try to remove the given option from SMTPLISTENEROPTIONS. |
| 107 | .PP |
| 108 | The \-\-remove\-commands cannot be used at the same time as any of \-\-commonoptions, |
| 109 | \-\-queuerunneroptions or \-\-smtplisteneroptions. The \-\-remove\-commands will |
| 110 | additionally remove whitespace at the beginning and the end of the option and |
| 111 | exchange multiple spaces wi a single one. |
| 112 | .TP |
| 113 | .I \-\-init |
| 114 | create a default /etc/default/exim4 file and exit immediately. Unless |
| 115 | .I \-\-force |
| 116 | was also specified |
| 117 | .B update\-exim4defaults |
| 118 | exits (successfully) without doing anything if /etc/default/exim4 already |
| 119 | exists. All other options are ignored. |
| 120 | |
| 121 | .SH EXIT STATUS |
| 122 | .TP |
| 123 | .I 0 |
| 124 | change was successful or nothing needed to be done. |
| 125 | .TP |
| 126 | .I 1 |
| 127 | generic error: wrong options, unreadable configuration file, etc. |
| 128 | .TP |
| 129 | .I 2 |
| 130 | QUEUEINTERVAL was already set. |
| 131 | .TP |
| 132 | .I 4 |
| 133 | COMMONOPTIONS was already set. |
| 134 | .TP |
| 135 | .I 8 |
| 136 | QUEUERUNNEROPTIONS was already set. |
| 137 | .TP |
| 138 | .I 16 |
| 139 | SMTPLISTENEROPTIONS was already set. |
| 140 | .TP |
| 141 | .I 32 |
| 142 | QFLAGS was already set. |
| 143 | .TP |
| 144 | .I 64 |
| 145 | \-\-remove\-something failed, i.e. the value of the option was not changed. |
| 146 | .PP |
| 147 | Exit codes 2 to 32 will be summed up, if more than one unsuccessful option was |
| 148 | given. |
| 149 | |
| 150 | .SH FILES |
| 151 | .TP |
| 152 | .I /etc/default/exim4 |
| 153 | The configuration file. |
| 154 | .TP |
| 155 | .I /etc/init.d/exim4 |
| 156 | The Exim init\-script. |
| 157 | .TP |
| 158 | .I /etc/ppp/ip\-up.d/exim4 |
| 159 | The queuerunner in this file also uses COMMONOPTIONS and QUEUERUNNEROPTIONS and |
| 160 | does not run if QUEUERUNNER=no. |
| 161 | |
| 162 | |
| 163 | .SH BUGS |
| 164 | This manual page needs a major re-work. If somebody knows better groff |
| 165 | than us and has more experience in writing manual pages, any patches |
| 166 | would be greatly appreciated. |
| 167 | |
| 168 | .SH SEE ALSO |
| 169 | .BR exim (8), |
| 170 | /usr/share/doc/exim4\-base/ |
| 171 | |
| 172 | .SH AUTHOR |
| 173 | Andreas Metzler <ametzler at downhill.at.eu.org> |