doc/pod/innconfval.pod

   1 =head1 NAME
   2
   3 innconfval - Get configuration parameters from inn.conf
   4
   5 =head1 SYNOPSIS
   6
   7 B<innconfval> [B<-pstv>] [B<-i> I<file>] [I<parameter> ...]
   8
   9 B<innconfval> B<-C> [B<-i> I<file>]
  10
  11 =head1 DESCRIPTION
  12
  13 B<innconfval> normally prints the values of the parameters specified on
  14 the command line.  By default, it just prints the parameter values, but if
  15 B<-p>, B<-s>, or B<-t> are given, it instead prints the parameter and
  16 value in the form of a variable assignment in Perl, Bourne shell, or Tcl
  17 respectively.  If no parameters are specifically requested, B<innconfval>
  18 prints out all parameter values (this isn't particularly useful unless one
  19 of B<-p>, B<-s>, or B<-t> were specified).
  20
  21 All parameters are taken from F<inn.conf> except for I<version>, which is
  22 always the version string of INN.
  23
  24 If given the B<-C> option, B<innconfval> instead checks F<inn.conf>,
  25 reporting any problems found to standard error.  B<innconfval> will exit
  26 with status 0 if no problems are found and with status 1 otherwise.
  27
  28 =head1 OPTIONS
  29
  30 =over 4
  31
  32 =item B<-C>
  33
  34 Check F<inn.conf> rather than printing out the values of parameters.
  35
  36 =item B<-i> I<file>
  37
  38 Use I<file> as the source configuration file rather than F<inn.conf>.
  39 I<file> must be a valid F<inn.conf> file and will be parsed the same as
  40 F<inn.conf> would be.
  41
  42 =item B<-p>
  43
  44 Print out parameters as Perl assignment statements.  The variable name
  45 will be the same as the F<inn.conf> parameter, and string values will be
  46 enclosed in single quotes with appropriate escaping.  Boolean values will
  47 be mapped to C<true> or C<false>, and string parameters that are set to
  48 NULL will be mapped to empty strings.
  49
  50 =item B<-s>
  51
  52 Print out parameters as Bourne shell assignment statements.  The variable
  53 name will be the F<inn.conf> parameter name in all capitals, and all
  54 variables will be exported.  String values will be enclosed in single
  55 quotes with appropriate escaping, and boolean values will be mapped to
  56 C<true> or C<false>.  String parameters that are set to NULL will be
  57 mapped to empty strings.
  58
  59 =item B<-t>
  60
  61 Print out parameters as Tcl assignment statements.  The variable name will
  62 be the same as the F<inn.conf> parameter name but with C<inn_> prepended,
  63 and string variables will be escaped appropriately.  Boolean values will
  64 be mapped to C<true> or C<false> and string parameters that are set to
  65 NULL will be mapped to empty strings.
  66
  67 =item B<-v>
  68
  69 Print INN's version.  This is equivalent to C<innconfval version>.
  70
  71 =back
  72
  73 =head1 HISTORY
  74
  75 Written by Rich $alz <rsalz@uunet.uu.net> for InterNetNews.
  76
  77 $Id: innconfval.pod 5962 2002-12-08 19:52:13Z rra $
  78
  79 =head1 SEE ALSO
  80
  81 inn.conf(5)
  82
  83 =cut