doc/man/innconfval.1

   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 "INNCONFVAL 1"
 132 .TH INNCONFVAL 1 "2008-04-06" "INN 2.4.5" "InterNetNews Documentation"
 133 .SH "NAME"
 134 innconfval \- Get configuration parameters from inn.conf
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 \&\fBinnconfval\fR [\fB\-pstv\fR] [\fB\-i\fR \fIfile\fR] [\fIparameter\fR ...]
 138 .PP
 139 \&\fBinnconfval\fR \fB\-C\fR [\fB\-i\fR \fIfile\fR]
 140 .SH "DESCRIPTION"
 141 .IX Header "DESCRIPTION"
 142 \&\fBinnconfval\fR normally prints the values of the parameters specified on
 143 the command line.  By default, it just prints the parameter values, but if
 144 \&\fB\-p\fR, \fB\-s\fR, or \fB\-t\fR are given, it instead prints the parameter and
 145 value in the form of a variable assignment in Perl, Bourne shell, or Tcl
 146 respectively.  If no parameters are specifically requested, \fBinnconfval\fR
 147 prints out all parameter values (this isn't particularly useful unless one
 148 of \fB\-p\fR, \fB\-s\fR, or \fB\-t\fR were specified).
 149 .PP
 150 All parameters are taken from \fIinn.conf\fR except for \fIversion\fR, which is
 151 always the version string of \s-1INN\s0.
 152 .PP
 153 If given the \fB\-C\fR option, \fBinnconfval\fR instead checks \fIinn.conf\fR,
 154 reporting any problems found to standard error.  \fBinnconfval\fR will exit
 155 with status 0 if no problems are found and with status 1 otherwise.
 156 .SH "OPTIONS"
 157 .IX Header "OPTIONS"
 158 .IP "\fB\-C\fR" 4
 159 .IX Item "-C"
 160 Check \fIinn.conf\fR rather than printing out the values of parameters.
 161 .IP "\fB\-i\fR \fIfile\fR" 4
 162 .IX Item "-i file"
 163 Use \fIfile\fR as the source configuration file rather than \fIinn.conf\fR.
 164 \&\fIfile\fR must be a valid \fIinn.conf\fR file and will be parsed the same as
 165 \&\fIinn.conf\fR would be.
 166 .IP "\fB\-p\fR" 4
 167 .IX Item "-p"
 168 Print out parameters as Perl assignment statements.  The variable name
 169 will be the same as the \fIinn.conf\fR parameter, and string values will be
 170 enclosed in single quotes with appropriate escaping.  Boolean values will
 171 be mapped to \f(CW\*(C`true\*(C'\fR or \f(CW\*(C`false\*(C'\fR, and string parameters that are set to
 172 \&\s-1NULL\s0 will be mapped to empty strings.
 173 .IP "\fB\-s\fR" 4
 174 .IX Item "-s"
 175 Print out parameters as Bourne shell assignment statements.  The variable
 176 name will be the \fIinn.conf\fR parameter name in all capitals, and all
 177 variables will be exported.  String values will be enclosed in single
 178 quotes with appropriate escaping, and boolean values will be mapped to
 179 \&\f(CW\*(C`true\*(C'\fR or \f(CW\*(C`false\*(C'\fR.  String parameters that are set to \s-1NULL\s0 will be
 180 mapped to empty strings.
 181 .IP "\fB\-t\fR" 4
 182 .IX Item "-t"
 183 Print out parameters as Tcl assignment statements.  The variable name will
 184 be the same as the \fIinn.conf\fR parameter name but with \f(CW\*(C`inn_\*(C'\fR prepended,
 185 and string variables will be escaped appropriately.  Boolean values will
 186 be mapped to \f(CW\*(C`true\*(C'\fR or \f(CW\*(C`false\*(C'\fR and string parameters that are set to
 187 \&\s-1NULL\s0 will be mapped to empty strings.
 188 .IP "\fB\-v\fR" 4
 189 .IX Item "-v"
 190 Print \s-1INN\s0's version.  This is equivalent to \f(CW\*(C`innconfval version\*(C'\fR.
 191 .SH "HISTORY"
 192 .IX Header "HISTORY"
 193 Written by Rich \f(CW$alz\fR <rsalz@uunet.uu.net> for InterNetNews.
 194 .PP
 195 $Id: innconfval.1 7880 2008-06-16 20:37:13Z iulius $
 196 .SH "SEE ALSO"
 197 .IX Header "SEE ALSO"
 198 \&\fIinn.conf\fR\|(5)