doc/pod/innupgrade.pod

   1 =head1 NAME
   2
   3 innupgrade - Upgrade INN configuration files
   4
   5 =head1 SYNOPSIS
   6
   7 B<innupgrade> I<directory>
   8
   9 B<innupgrade> [B<-t> I<type>] B<-f> I<file>
  10
  11 =head1 DESCRIPTION
  12
  13 B<innupgrade> is intended to be run during a major upgrade of INN to fix
  14 the configuration files with any required changes.  If given a directory,
  15 it will scan that directory for any files that it has updates defined for,
  16 try to perform those updates, and replace the files with updated versions
  17 if applying the updates resulted in any changes.  The old versions of the
  18 files will be saved with a C<.OLD> extension.
  19
  20 If the B<-f> flag is used, only that file will be updated.  If the file
  21 name doesn't match the standard file name of an INN configuration file,
  22 the optional B<-t> flag may be given to specify the type.  See
  23 L<"EXAMPLES"> for an example of this.
  24
  25 Currently, B<innupgrade> knows how to apply the following updates:
  26
  27 =over 2
  28
  29 =item *
  30
  31 F<inn.conf>:  Quote values with whitespace and comment out keys with no
  32 values, required for the change in configuration parsers introduced in INN
  33 2.4.  The new format is not backward compatible with the previous parser,
  34 since the previous parser will include the double-quotes in the value of
  35 the parameter.
  36
  37 =back
  38
  39 Normally, B<innupgrade> should be run on the I<pathetc> directory after
  40 any upgrade of INN other than a patch release (any upgrade that changes
  41 the first or second version numbers).  This may occur automatically during
  42 the upgrade process.
  43
  44 =head1 OPTIONS
  45
  46 =over 4
  47
  48 =item B<-f> I<file>
  49
  50 Only act on I<file> rather than working on an entire directory.
  51
  52 =item B<-t> I<type>
  53
  54 For a file specified with B<-f>, parse it and upgrade it as if it were
  55 named I<type>.  Used for upgrading files with the same syntax as normal
  56 INN configuration files but with different names.  Only makes sense in
  57 combination with B<-f>.
  58
  59 =back
  60
  61 =head1 EXAMPLES
  62
  63 Upgrade any configuration files found in F</usr/local/news/etc>:
  64
  65     innupgrade /usr/local/news/etc
  66
  67 Upgrade only F</news/etc/inn.conf>:
  68
  69     innupgrade -f /news/etc/inn.conf
  70
  71 Upgrade a file named F<inn-special.conf> that should have the same syntax
  72 as F<inn.conf>:
  73
  74     innupgrade -t inn.conf -f inn-special.conf
  75
  76 Any upgrade rules that apply to F<inn.conf> will be applied to the
  77 alternate file.
  78
  79 =head1 HISTORY
  80
  81 Written by Russ Allbery <rra@stanford.edu> for InterNetNews.
  82
  83 $Id: innupgrade.pod 5909 2002-12-03 05:17:18Z vinocur $
  84
  85 =cut