doc/man/inncheck.8

   1 .TH INNCHECK 8
   2 .SH NAME
   3 inncheck \- check inn configuration and database files.
   4 .SH SYNOPSIS
   5 .B inncheck
   6 [
   7 .B \-a
   8 ]
   9 [
  10 .B \-v
  11 ]
  12 [
  13 .B \-pedantic
  14 ]
  15 [
  16 .B \-f
  17 ]
  18 [
  19 .B \-perm
  20 ]
  21 [
  22 .B \-noperm
  23 ]
  24 [
  25 .B "file=value | file"
  26 ]
  27 .SH DESCRIPTION
  28 .I Inncheck
  29 examines various configuration files and databases and verifies things
  30 about them. Things verified depend on the file being checked, but generally
  31 are things like permissions, ownership, syntax errors in config files, etc.
  32 .PP
  33 .I Inncheck
  34 does not make changes to any files \(em it just reports what it
  35 thinks may be wrong, and it is up to the operator to fix the problem.
  36 .PP
  37 The set of files checked may be restricted by using \fBfile\fP or
  38 \fBfile=value\fP arguments. For example, putting \fBincoming.conf\fP causes
  39 only the
  40 .I incoming.conf
  41 file to be checked. Using \fBincoming.conf=/tmp/incoming.conf\fP on the
  42 command line will cause
  43 .I inncheck
  44 to only verify the incoming.conf file, and it will perform the
  45 checks on the file
  46 /tmp/incoming.conf file instead of the default one.
  47 .PP
  48 Valid values for
  49 .I file
  50 are:
  51 .PP
  52 .RS
  53 .nf
  54     active
  55     control.ctl
  56     expire.ctl
  57     incoming.conf
  58     inn.conf
  59     moderators
  60     newsfeeds
  61     overview.fmt
  62     nntpsend.ctl
  63     passwd.nntp
  64     readers.conf
  65 .fi
  66 .RE
  67 .SH OPTIONS
  68 .TP
  69 .B \-a
  70 If any ``\fBfile\fP'' value or ``\fBfile=value\fP'' pairs (see below) are
  71 given, then normally only the files they refer to are checked. Use
  72 the ``\fB\-a\fP'' flag to specify that
  73 .I all
  74 files should be checked regardless. In this case the form \fBfile=value\fP
  75 will be the more useful.
  76 .TP
  77 .B \-v
  78 Use the ``\fB\-v\fP'' option to get more verbose output.
  79 .TP
  80 .B \-pedantic
  81 Use the ``\fB\-pedantic\fP'' option to get reports on things that are not
  82 necessarily wrong, but may indicate a bad configuration \(em such as
  83 \fIinn.conf\fP missing a key.
  84 .TP
  85 .B \-f
  86 Use the ``\fB\-f\fP'' flag to have inncheck print the appropriate
  87 chown/chgrp/chmod command necessary to fix a problem that it reports.  Any
  88 other output lines will be prefixed with a ``#'' character to make the
  89 output be valid input for a shell.  Note that the ``\fB\-perm\fP'' flag
  90 must be used as well when using this flag.
  91 .TP
  92 .B \-perm
  93 Inncheck checks all files for permission problems.
  94 If the ``\fB\-perm\fP'' flag is used, then
  95 .I only
  96 the files specified by the \fBfile\fP or \fBfile=value\fP command line
  97 arguments will be checked for problems other than permission problems.
  98 .TP
  99 .B \-noperm
 100 To avoid doing any checking of file permissions or ownership, use
 101 the ``\fB-noperm\fP'' option.
 102 .SH EXAMPLES
 103 .PP
 104 To have
 105 .I inncheck
 106 check all files for syntax and permission problems simply:
 107 .PP
 108 .RS
 109 .nf
 110 inncheck
 111 .fi
 112 .RE
 113 .PP
 114 To have
 115 .I inncheck
 116 check all files for permission problems and to verify the syntax of the
 117 active and incoming.conf files do:
 118 .PP
 119 .RS
 120 .nf
 121 inncheck -perm active incoming.conf
 122 .fi
 123 .RE
 124 .PP
 125 To fix the permissions problems noted in the output of the above
 126 command, modify it as follow:
 127 .PP
 128 .RS
 129 .nf
 130 inncheck -f -perm | sh
 131 .fi
 132 .RE
 133 .PP
 134 To have
 135 .I inncheck
 136 check the test newsfeeds file in /var/tmp/newsfeeds.testing, do:
 137 .PP
 138 .RS
 139 .nf
 140 inncheck newsfeeds=/var/tmp/newsfeeds.testing
 141 .fi
 142 .RE
 143 .PP
 144 To have
 145 .I inncheck
 146 check all the files as it normally does, but to specify a different
 147 location for the newsfeeds file, so:
 148 .PP
 149 .RS
 150 .nf
 151 inncheck -a newsfeeds=/var/tmp/newsfeeds.testing
 152 .fi
 153 .RE
 154 .SH BUGS
 155 If the ``\fB-f\fP'' and ``\fB-perm\fP'' options are used together, along with
 156 ``\fB\-a\fP'' or some ``\fBfile\fP'' or ``\fBfile=value\fP'' arguments that
 157 refer to a file with a syntax problem, then the output will no longer be
 158 valid input for a shell.
 159 .SH HISTORY
 160 Written by Brendan Kehoe <brendan@cygnus.com> and
 161 Rich Salz <rsalz@uunet.uu.net>
 162 .de R$
 163 This is revision \\$3, dated \\$4.
 164 ..
 165 .R$ $Id: inncheck.8 5909 2002-12-03 05:17:18Z vinocur $
 166 .SH "SEE ALSO"
 167 active(5),
 168 expire.ctl(5),
 169 history(5),
 170 incoming.conf(5),
 171 inn.conf(5),
 172 newsfeeds(5)