.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "INNUPGRADE 8" .TH INNUPGRADE 8 2024-04-01 "INN 2.7.2" "InterNetNews Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME innupgrade \- Upgrade INN configuration files .SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBinnupgrade\fR \fIdirectory\fR .PP \&\fBinnupgrade\fR [\fB\-t\fR \fItype\fR] \fB\-f\fR \fIfile\fR .SH DESCRIPTION .IX Header "DESCRIPTION" \&\fBinnupgrade\fR is intended to be run during a major upgrade of INN to fix the configuration files with any required changes. If given a directory, it will scan that directory for any files that it has updates defined for, try to perform those updates, and replace the files with updated versions if applying the updates resulted in any changes. The old versions of the files will be saved with a \f(CW\*(C`.OLD\*(C'\fR extension. .PP If the \fB\-f\fR flag is used, only that file will be updated. If the file name doesn't match the standard file name of an INN configuration file, the optional \fB\-t\fR flag may be given to specify the type. See "EXAMPLES" for an example of this. .PP Currently, \fBinnupgrade\fR knows how to apply the following updates: .IP \fIincoming.conf\fR 2 .IX Item "incoming.conf" .RS 2 .PD 0 .IP \(bu 2 .PD Rename \fInolist\fR and \fInoresendid\fR to respectively \fIlist\fR and \fIresendid\fR. Invert the related boolean values (since INN\ 2.7). .IP \(bu 2 Comment removed \fIcomment\fR and \fIemail\fR parameters (since INN\ 2.7). .RE .RS 2 .RE .IP \fIinn.conf\fR 2 .IX Item "inn.conf" .RS 2 .PD 0 .IP \(bu 2 .PD Quote values with whitespace and comment out keys with no values, required for the change in configuration parsers introduced in INN\ 2.4. The new format is not backward compatible with the previous parser, since the previous parser will include the double-quotes in the value of the parameter. .IP \(bu 2 Add the \fIhismethod\fR parameter if not found (introduced in INN\ 2.4, with the default value \f(CW\*(C`hisv6\*(C'\fR). .IP \(bu 2 Rename \fInntpactsync\fR to \fIincominglogfrequency\fR (since INN\ 2.5). Rename \fIaddnntppostingdate\fR and \fIaddnntppostinghost\fR to respectively \&\fIaddinjectiondate\fR and \fIaddinjectionpostinghost\fR (since INN\ 2.6). .IP \(bu 2 Remove the \fIrefusecybercancels\fR and \fIverifycancels\fR parameters (since INN\ 2.7). .IP \(bu 2 If the \fIoverview.fmt\fR file exists, its content is merged in the \fIextraoverviewadvertised\fR and \fIextraoverviewhidden\fR parameters introduced in INN\ 2.5. The file is then renamed to \fIoverview.fmt.OLD\fR. .IP \(bu 2 If the \fIsasl.conf\fR file exists, its content is merged in the \fItlscapath\fR, \&\fItlscafile\fR, \fItlscertfile\fR and \fItlskeyfile\fR parameters introduced in INN\ 2.5. The file is then renamed to \fIsasl.conf.OLD\fR. .RE .RS 2 .RE .IP \fIinn\-secrets.conf\fR 2 .IX Item "inn-secrets.conf" .RS 2 .PD 0 .IP \(bu 2 .PD Create a non-world-readable \fIinn\-secrets.conf\fR file in \fIpathetc\fR, if not already existing (new in INN\ 2.7). .RE .RS 2 .RE .IP \fInewsfeeds\fR 2 .IX Item "newsfeeds" .RS 2 .PD 0 .IP \(bu 2 .PD Replace the use of \fBstartinnfeed\fR with the appropriate direct invocation of \fBinnfeed\fR or \fBimapfeed\fR (\fBstartinnfeed\fR was removed in INN\ 2.5). .IP \(bu 2 Replace the use of \fBfilechan\fR with \fBbuffchan\fR in unbuffered mode (\fBfilechan\fR was removed in INN\ 2.7). .RE .RS 2 .RE .IP \fIreaders.conf\fR 2 .IX Item "readers.conf" .RS 2 .PD 0 .IP \(bu 2 .PD Rename \fIrequire_ssl\fR to \fIrequire_encryption\fR (since INN\ 2.7). .RE .RS 2 .RE .PP A few obsolete programs or configuration files are renamed with a \f(CW\*(C`.OLD\*(C'\fR extension by \fBinnupgrade\fR. Obsolete man pages are directly removed. .PP Normally, \fBinnupgrade\fR should be run at least on the \fIpathetc\fR directory after any upgrade of INN other than a patch release (any upgrade that changes the first or second version numbers). This may occur automatically during the upgrade process. .SH OPTIONS .IX Header "OPTIONS" .IP "\fB\-f\fR \fIfile\fR" 4 .IX Item "-f file" Only act on \fIfile\fR rather than working on an entire directory. .IP "\fB\-t\fR \fItype\fR" 4 .IX Item "-t type" For a file specified with \fB\-f\fR, parse it and upgrade it as if it were named \fItype\fR. Used for upgrading files with the same syntax as normal INN configuration files but with different names. Only makes sense in combination with \fB\-f\fR. .SH EXAMPLES .IX Header "EXAMPLES" Upgrade any configuration files found in \fIpathetc\fR and append a \f(CW\*(C`.OLD\*(C'\fR extension to obsolete files in \fIpathetc\fR: .PP .Vb 1 \& innupgrade .Ve .PP Upgrade only \fI/news/etc/inn.conf\fR: .PP .Vb 1 \& innupgrade \-f /news/etc/inn.conf .Ve .PP Upgrade a file named \fIinn\-special.conf\fR that should have the same syntax as \fIinn.conf\fR: .PP .Vb 1 \& innupgrade \-t inn.conf \-f inn\-special.conf .Ve .PP Any upgrade rules that apply to \fIinn.conf\fR will be applied to the alternate file. .SH HISTORY .IX Header "HISTORY" Written by Russ Allbery for InterNetNews. .SH "SEE ALSO" .IX Header "SEE ALSO" incoming.conf(5), inn.conf(5), inn\-secrets.conf(5), newsfeeds(5), readers.conf(5).