chiark / gitweb /
option for no inotify; manpage fix
[innduct.git] / doc / man / innupgrade.8
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "INNUPGRADE 8"
132 .TH INNUPGRADE 8 "2008-04-06" "INN 2.4.5" "InterNetNews Documentation"
133 .SH "NAME"
134 innupgrade \- Upgrade INN configuration files
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 \&\fBinnupgrade\fR \fIdirectory\fR
138 .PP
139 \&\fBinnupgrade\fR [\fB\-t\fR \fItype\fR] \fB\-f\fR \fIfile\fR
140 .SH "DESCRIPTION"
141 .IX Header "DESCRIPTION"
142 \&\fBinnupgrade\fR is intended to be run during a major upgrade of \s-1INN\s0 to fix
143 the configuration files with any required changes.  If given a directory,
144 it will scan that directory for any files that it has updates defined for,
145 try to perform those updates, and replace the files with updated versions
146 if applying the updates resulted in any changes.  The old versions of the
147 files will be saved with a \f(CW\*(C`.OLD\*(C'\fR extension.
148 .PP
149 If the \fB\-f\fR flag is used, only that file will be updated.  If the file
150 name doesn't match the standard file name of an \s-1INN\s0 configuration file,
151 the optional \fB\-t\fR flag may be given to specify the type.  See
152 \&\*(L"\s-1EXAMPLES\s0\*(R" for an example of this.
153 .PP
154 Currently, \fBinnupgrade\fR knows how to apply the following updates:
155 .IP "\(bu" 2
156 \&\fIinn.conf\fR:  Quote values with whitespace and comment out keys with no
157 values, required for the change in configuration parsers introduced in \s-1INN\s0
158 2.4.  The new format is not backward compatible with the previous parser,
159 since the previous parser will include the double-quotes in the value of
160 the parameter.
161 .PP
162 Normally, \fBinnupgrade\fR should be run on the \fIpathetc\fR directory after
163 any upgrade of \s-1INN\s0 other than a patch release (any upgrade that changes
164 the first or second version numbers).  This may occur automatically during
165 the upgrade process.
166 .SH "OPTIONS"
167 .IX Header "OPTIONS"
168 .IP "\fB\-f\fR \fIfile\fR" 4
169 .IX Item "-f file"
170 Only act on \fIfile\fR rather than working on an entire directory.
171 .IP "\fB\-t\fR \fItype\fR" 4
172 .IX Item "-t type"
173 For a file specified with \fB\-f\fR, parse it and upgrade it as if it were
174 named \fItype\fR.  Used for upgrading files with the same syntax as normal
175 \&\s-1INN\s0 configuration files but with different names.  Only makes sense in
176 combination with \fB\-f\fR.
177 .SH "EXAMPLES"
178 .IX Header "EXAMPLES"
179 Upgrade any configuration files found in \fI/usr/local/news/etc\fR:
180 .PP
181 .Vb 1
182 \&    innupgrade /usr/local/news/etc
183 .Ve
184 .PP
185 Upgrade only \fI/news/etc/inn.conf\fR:
186 .PP
187 .Vb 1
188 \&    innupgrade \-f /news/etc/inn.conf
189 .Ve
190 .PP
191 Upgrade a file named \fIinn\-special.conf\fR that should have the same syntax
192 as \fIinn.conf\fR:
193 .PP
194 .Vb 1
195 \&    innupgrade \-t inn.conf \-f inn\-special.conf
196 .Ve
197 .PP
198 Any upgrade rules that apply to \fIinn.conf\fR will be applied to the
199 alternate file.
200 .SH "HISTORY"
201 .IX Header "HISTORY"
202 Written by Russ Allbery <rra@stanford.edu> for InterNetNews.
203 .PP
204 $Id: innupgrade.8 7880 2008-06-16 20:37:13Z iulius $