Imported Debian patch 4.84-8
[hcoop/debian/exim4.git] / debian / patches / 31_eximmanpage.dpatch
1 Description: We ship the binary as exim4 instead of exim, fix manpage
2 accordingly.
3 Author: Marc Haber <mh+debian-packages@zugschlus.de>,
4 Andreas Metzler <ametzler@bebt.de>
5 Last-Update: 2014-05-29
6 Forwarded: not-needed (upstream uses the "exim" name)
7
8 --- a/doc/exim.8
9 +++ b/doc/exim.8
10 @@ -1,9 +1,9 @@
11 -.TH EXIM 8
12 +.TH EXIM4 8
13 .SH NAME
14 -exim \- a Mail Transfer Agent
15 +exim4 \- a Mail Transfer Agent
16 .SH SYNOPSIS
17 .nf
18 -.B exim [options] arguments ...
19 +.B exim4 [options] arguments ...
20 .B mailq [options] arguments ...
21 .B rsmtp [options] arguments ...
22 .B rmail [options] arguments ...
23 @@ -40,7 +40,7 @@ local message on the standard input, wit
24 recipients) is assumed. Thus, for example, if Exim is installed in
25 \fI/usr/sbin\fP, you can send a message from the command line like this:
26 .sp
27 - /usr/sbin/exim -i <recipient-address(es)>
28 + /usr/sbin/exim4 -i <recipient-address(es)>
29 <message content, including all the header lines>
30 CTRL-D
31 .sp
32 @@ -125,8 +125,8 @@ ports, on multiple ports, and only on sp
33 .sp
34 When a listening daemon
35 is started without the use of \fB\-oX\fP (that is, without overriding the normal
36 -configuration), it writes its process id to a file called exim\-daemon.pid
37 -in Exim's spool directory. This location can be overridden by setting
38 +configuration), it writes its process id to a file called
39 +/var/run/exim4/exim.pid. This location can be overridden by setting
40 PID_FILE_PATH in Local/Makefile. The file is written while Exim is still
41 running as root.
42 .sp
43 @@ -175,7 +175,7 @@ of lookups, you will just get the same r
44 This option operates like \fB\-be\fP except that it must be followed by the name
45 of a file. For example:
46 .sp
47 - exim \-bem /tmp/testmessage
48 + exim4 \-bem /tmp/testmessage
49 .sp
50 The file is read as a message (as if receiving a locally\-submitted non\-SMTP
51 message) before any of the test expansions are done. Thus, message\-specific
52 @@ -201,7 +201,7 @@ If you want to test a system filter file
53 can use both \fB\-bF\fP and \fB\-bf\fP on the same command, in order to test a system
54 filter and a user filter in the same run. For example:
55 .sp
56 - exim \-bF /system/filter \-bf /user/filter </test/message
57 + exim4 \-bF /system/filter \-bf /user/filter </test/message
58 .sp
59 This is helpful when the system filter adds header lines or sets filter
60 variables that are used by the user filter.
61 @@ -253,8 +253,8 @@ This option runs a fake SMTP session as
62 standard input and output. The IP address may include a port number at the end,
63 after a full stop. For example:
64 .sp
65 - exim \-bh 10.9.8.7.1234
66 - exim \-bh fe80::a00:20ff:fe86:a061.5678
67 + exim4 \-bh 10.9.8.7.1234
68 + exim4 \-bh fe80::a00:20ff:fe86:a061.5678
69 .sp
70 When an IPv6 address is given, it is converted into canonical form. In the case
71 of the second example above, the value of \fI$sender_host_address\fP after
72 @@ -411,7 +411,7 @@ main configuration options to be written
73 of one or more specific options can be requested by giving their names as
74 arguments, for example:
75 .sp
76 - exim \-bP qualify_domain hold_domains
77 + exim4 \-bP qualify_domain hold_domains
78 .sp
79 However, any option setting that is preceded by the word "hide" in the
80 configuration file is not shown in full, except to an admin user. For other
81 @@ -435,7 +435,7 @@ written directly into the spool director
82 .sp
83 If \fB\-bP\fP is followed by a name preceded by +, for example,
84 .sp
85 - exim \-bP +local_domains
86 + exim4 \-bP +local_domains
87 .sp
88 it searches for a matching named list of any type (domain, host, address, or
89 local part) and outputs what it finds.
90 @@ -444,7 +444,7 @@ If one of the words \fBrouter\fP, \fBtra
91 followed by the name of an appropriate driver instance, the option settings for
92 that driver are output. For example:
93 .sp
94 - exim \-bP transport local_delivery
95 + exim4 \-bP transport local_delivery
96 .sp
97 The generic driver options are output first, followed by the driver's private
98 options. A list of the names of drivers of a particular type can be obtained by
99 @@ -523,7 +523,7 @@ This option is for testing retry rules,
100 arguments. It causes Exim to look for a retry rule that matches the values
101 and to write it to the standard output. For example:
102 .sp
103 - exim \-brt bach.comp.mus.example
104 + exim4 \-brt bach.comp.mus.example
105 Retry rule: *.comp.mus.example F,2h,15m; F,4d,30m;
106 .sp
107 The first
108 @@ -536,7 +536,7 @@ rule is found that matches the host, one
109 sought. Finally, an argument that is the name of a specific delivery error, as
110 used in setting up retry rules, can be given. For example:
111 .sp
112 - exim \-brt haydn.comp.mus.example quota_3d
113 + exim4 \-brt haydn.comp.mus.example quota_3d
114 Retry rule: *@haydn.comp.mus.example quota_3d F,1h,15m
115 .TP 10
116 \fB\-brw\fP
117 @@ -639,7 +639,7 @@ doing such tests.
118 .TP 10
119 \fB\-bV\fP
120 This option causes Exim to write the current version number, compilation
121 -number, and compilation date of the \fIexim\fP binary to the standard output.
122 +number, and compilation date of the \fIexim4\fP binary to the standard output.
123 It also lists the DBM library that is being used, the optional modules (such as
124 specific lookup types), the drivers that are included in the binary, and the
125 name of the run time configuration file that is in use.
126 @@ -667,7 +667,7 @@ If no arguments are given, Exim runs in
127 right angle bracket for addresses to be verified.
128 .sp
129 Unlike the \fB\-be\fP test option, you cannot arrange for Exim to use the
130 -readline() function, because it is running as \fIexim\fP and there are
131 +readline() function, because it is running as \fIexim4\fP and there are
132 security issues.
133 .sp
134 Verification differs from address testing (the \fB\-bt\fP option) in that routers
135 @@ -780,14 +780,14 @@ command line item. \fB\-D\fP can be used
136 string, in which case the equals sign is optional. These two commands are
137 synonymous:
138 .sp
139 - exim \-DABC ...
140 - exim \-DABC= ...
141 + exim4 \-DABC ...
142 + exim4 \-DABC= ...
143 .sp
144 To include spaces in a macro definition item, quotes must be used. If you use
145 quotes, spaces are permitted around the macro name and the equals sign. For
146 example:
147 .sp
148 - exim '\-D ABC = something' ...
149 + exim4 '\-D ABC = something' ...
150 .sp
151 \fB\-D\fP may be repeated up to 10 times on a command line.
152 .TP 10
153 @@ -916,8 +916,8 @@ never provoke a bounce. An empty sender
154 string, or as a pair of angle brackets with nothing between them, as in these
155 examples of shell commands:
156 .sp
157 - exim \-f '<>' user@domain
158 - exim \-f "" user@domain
159 + exim4 \-f '<>' user@domain
160 + exim4 \-f "" user@domain
161 .sp
162 In addition, the use of \fB\-f\fP is not restricted when testing a filter file
163 with \fB\-bf\fP or when testing or verifying addresses using the \fB\-bt\fP or
164 @@ -1271,12 +1271,12 @@ other circumstances, they are ignored un
165 The \fB\-oMa\fP option sets the sender host address. This may include a port
166 number at the end, after a full stop (period). For example:
167 .sp
168 - exim \-bs \-oMa 10.9.8.7.1234
169 + exim4 \-bs \-oMa 10.9.8.7.1234
170 .sp
171 An alternative syntax is to enclose the IP address in square brackets,
172 followed by a colon and the port number:
173 .sp
174 - exim \-bs \-oMa [10.9.8.7]:1234
175 + exim4 \-bs \-oMa [10.9.8.7]:1234
176 .sp
177 The IP address is placed in the \fI$sender_host_address\fP variable, and the
178 port, if present, in \fI$sender_host_port\fP. If both \fB\-oMa\fP and \fB\-bh\fP
179 @@ -1474,13 +1474,13 @@ When scanning the queue, Exim can be mad
180 lexically less than a given value by following the \fB\-q\fP option with a
181 starting message id. For example:
182 .sp
183 - exim \-q 0t5C6f\-0000c8\-00
184 + exim4 \-q 0t5C6f\-0000c8\-00
185 .sp
186 Messages that arrived earlier than 0t5C6f\-0000c8\-00 are not inspected. If a
187 second message id is given, messages whose ids are lexically greater than it
188 are also skipped. If the same id is given twice, for example,
189 .sp
190 - exim \-q 0t5C6f\-0000c8\-00 0t5C6f\-0000c8\-00
191 + exim4 \-q 0t5C6f\-0000c8\-00 0t5C6f\-0000c8\-00
192 .sp
193 just one delivery process is started, for that message. This differs from
194 \fB\-M\fP in that retry data is respected, and it also differs from \fB\-Mc\fP in
195 @@ -1496,7 +1496,7 @@ starting a queue runner process at inter
196 single daemon process handles both functions. A common way of starting up a
197 combined daemon at system boot time is to use a command such as
198 .sp
199 - /usr/exim/bin/exim \-bd \-q30m
200 + /usr/sbin/exim4 \-bd \-q30m
201 .sp
202 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
203 process every 30 minutes.
204 @@ -1527,7 +1527,7 @@ regular expression; otherwise it is a li
205 If you want to do periodic queue runs for messages with specific recipients,
206 you can combine \fB\-R\fP with \fB\-q\fP and a time value. For example:
207 .sp
208 - exim \-q25m \-R @special.domain.example
209 + exim4 \-q25m \-R @special.domain.example
210 .sp
211 This example does a queue run for messages with recipients in the given domain
212 every 25 minutes. Any additional flags that are specified with \fB\-q\fP are
213 @@ -1637,6 +1637,26 @@ to the named file. It is ignored by Exi
214 .sp
215 .
216 .SH "SEE ALSO"
217 +.BR exicyclog (8),
218 +.BR exigrep (8),
219 +.BR exim_checkaccess (8),
220 +.BR exim_convert4r4 (8),
221 +.BR exim_db (8),
222 +.BR exim_dbmbuild (8),
223 +.BR exim_lock (8),
224 +.BR eximon (8),
225 +.BR exinext (8),
226 +.BR exiqgrep (8),
227 +.BR exiqsumm (8),
228 +.BR exiwhat (8),
229 +.BR update\-exim4.conf (8),
230 +.BR update\-exim4defaults (8),
231 +/usr/share/doc/exim4\-base/,
232 +/usr/share/doc/exim4\-base/README.Debian.[gz|html].
233 .rs
234 .sp
235 The full Exim specification, the Exim book, and the Exim wiki.
236 +
237 +.SH AUTHOR
238 +This manual page was provided with the upstream Exim source package.
239 +It was enhanced for the Debian GNU/Linux system.