Imported Debian patch 4.84-8
[hcoop/debian/exim4.git] / debian / manpages / exim_convert4r4.8
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 EXIM_CONVERT4R4 8 "March 26, 2003"
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 exim_convert4r4 \- Convert Exim configuration from v3 to v4 format
22 .SH SYNOPSIS
23 .B exim_convert4r4
24
25 .SH DESCRIPTION
26 This script is provided to assist in updating Exim configuration files.
27 It reads an Exim 3 configuration file on the standard input, and writes a
28 modified file on the standard output.
29 It also writes comments about what it has done to the standard error file.
30 It assumes that the input is a valid Exim 3 configuration file.
31 A typical call to the conversion script might be
32
33 .I exim_convert4r4 < /etc/exim/exim.conf > /etc/exim4/exim4.conf.new
34
35 The output file
36 .B MUST
37 be checked and tested before trying to use it on a live system.
38 The conversion script is just an aid which does a lot of the \(lqgrunt
39 work\(rq.
40 It does not guarantee to produce an Exim 4 configuration that behaves
41 exactly the same as the Exim 3 configuration it reads.
42
43 Each option change in the new file is preceded by an identifying comment.
44 In fact, the conversion script tends to make quite a mess of your
45 configuration, and you should expect to go through it afterwards and tidy
46 it up by hand.
47
48 Unless you are running a very straightforward configuration, the automatic
49 conversion is likely to generate a non-optimal configuration.
50 You should not only check it thoroughly, but also run as many tests as you
51 can, to ensure that it is working as you expect.
52 In particular, you should test address routing, using \-bt and \-bv, and the
53 policy controls, using \-bh.
54 If possible, you should also do some live tests (i.e. send and receive
55 some messages) before putting Exim 4 into service.
56
57 If you have a very complicated configuration, it is possible that
58 exim_convert4r4 will break it in some situations, which is why thorough
59 testing is strongly recommended.
60
61 .SH BUGS
62 This manual page needs a major re-work. If somebody knows better groff
63 than us and has more experience in writing manual pages, any patches
64 would be greatly appreciated.
65
66 .SH SEE ALSO
67 .BR exim (8),
68 the files in /usr/share/doc/exim4\-base/, especially Exim4.upgrade.gz
69
70 .SH AUTHOR
71 This manual page was stitched together from Exim4.upgrade by
72 Andreas Metzler <ametzler at downhill.at.eu.org>,
73 for the Debian GNU/Linux system (but may be used by others).