inncheck(8)

1INNCHECK(8)               InterNetNews Documentation               INNCHECK(8)
2
3
4

NAME

6       inncheck - Check INN configuration and database files
7

SYNOPSIS

9       inncheck [-afqv] [--noperm | --perm] [--pedantic] [file | file=path
10       ...]
11

DESCRIPTION

13       inncheck examines various configuration files and databases and
14       verifies things about them.  Things verified depend on the file being
15       checked, but generally are things like permissions, ownership, syntax
16       errors in config files, etc.
17
18       inncheck does not make changes to any files -- it just reports what it
19       thinks may be wrong, and it is up to the operator to fix the problem
20
21       The set of files checked may be restricted by using file or file=path
22       arguments.  For example, putting "incoming.conf" causes only the
23       incoming.conf file to be checked.  Using
24       "incoming.conf=/tmp/incoming.conf" on the command line will cause
25       inncheck to only verify the incoming.conf file, and it will perform the
26       checks on the /tmp/incoming.conf file instead of the default one.
27       Setting a file path to an empty value like "incoming.conf=" will skip
28       the check for that file (this only makes sense with -a, or no files
29       will be checked at all).
30
31       Valid values for file are:
32
33           active
34           control.ctl
35           control.ctl.local
36           expire.ctl
37           incoming.conf
38           inn.conf
39           innfeed.conf
40           moderators
41           newsfeeds
42           nntpsend.ctl
43           passwd.nntp
44           readers.conf
45           storage.conf
46

OPTIONS

48       -a, --all
49           If any file value or file=path pairs (see below) are given, then
50           normally only the files they refer to are checked.  Use the -a (or
51           --all) flag to specify that all files should be checked regardless.
52           In this case the form file=path will be the more useful.
53
54       -f, --fix
55           Use the -f flag (or --fix) to have inncheck print the appropriate
56           chown/chgrp/chmod command necessary to fix a problem that it
57           reports.  Any other output lines will be prefixed with a hash sign
58           ("#") to make the output be valid input for a shell.  Note that the
59           --perm flag must be used as well when using this flag.
60
61       --noperm
62           To avoid doing any checking of file permissions or ownership, use
63           the --noperm option.
64
65       --pedantic
66           Use the --pedantic option to get reports on things that are not
67           necessarily wrong, but may indicate a bad configuration, such as
68           inn.conf missing a key.
69
70       --perm
71           inncheck checks all files for permission problems.  If the --perm
72           flag is used, then only the files specified by the file or
73           file=path command line arguments will be checked for problems other
74           than permission problems.
75
76       -q, --quiet
77           Use the -q option (or --quiet) to get less output.
78
79       -v, --verbose
80           Use the -v option (or --verbose) to get more verbose output.
81

EXAMPLES

83       To have inncheck check all files for syntax and permission problems
84       simply run:
85
86           inncheck
87
88       It is recommended to run the following command to be aware of all the
89       potential problems inncheck can detect:
90
91           inncheck -a --perm --pedantic
92
93       To have inncheck check all files for permission problems and to verify
94       the syntax of the active and incoming.conf files, do:
95
96           inncheck --perm active incoming.conf
97
98       To fix the permissions problems noted in the output of the above
99       command, modify it as follows:
100
101           inncheck -f --perm | sh
102
103       (Note that it is useless to mention the name of the two files since
104       permission problems are checked on all files.)
105
106       To have inncheck check the test newsfeeds file in
107       /var/tmp/newsfeeds.testing, do:
108
109           inncheck newsfeeds=/var/tmp/newsfeeds.testing
110
111       To have inncheck check all the files as it normally does, but to
112       specify a different location for the newsfeeds file and omit checking
113       of the innfeed.conf file, do:
114
115           inncheck -a newsfeeds=/var/tmp/newsfeeds.testing innfeed.conf=
116

BUGS

118       If the -f and --perm options are used together, along with -a or some
119       file or file=path arguments that refer to a file with a syntax problem,
120       then the output will no longer be valid input for a shell.
121
122       In most cases, inncheck currently does not correctly understand option
123       values spanning multiple lines.  If you get error messages about
124       runaway quotes, you either have to ignore them and check the
125       correctness of the relevant lines yourself, or merge the value into a
126       single line.
127

HISTORY

129       Written by Brendan Kehoe <brendan@cygnus.com> and Rich Salz
130       <rsalz@uunet.uu.net> for InterNetNews.  Converted to POD by Julien
131       Elie.
132
133       $Id: inncheck.pod 9428 2012-06-15 18:18:45Z iulius $
134