.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "INNCHECK 8" .TH INNCHECK 8 2024-02-12 "INN 2.7.2" "InterNetNews Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME inncheck \- Check INN configuration and database files .SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBinncheck\fR [\fB\-afqv\fR] [\fB\-\-noperm\fR | \fB\-\-perm\fR] [\fB\-\-pedantic\fR] [\fIfile\fR | \fIfile\fR\fB=\fR\fIpath\fR ...] .SH DESCRIPTION .IX Header "DESCRIPTION" \&\fBinncheck\fR examines various configuration files and databases and verifies things about them. Things verified depend on the file being checked, but generally are things like permissions, ownership, syntax errors in config files, etc. .PP \&\fBinncheck\fR does not make changes to any files \-\-\ it just reports what it thinks may be wrong, and it is up to the operator to fix the problem .PP The set of files checked may be restricted by using \fIfile\fR or \&\fIfile\fR\fB=\fR\fIpath\fR arguments. For example, putting \f(CW\*(C`incoming.conf\*(C'\fR causes only the \fIincoming.conf\fR file to be checked. Using \&\f(CW\*(C`incoming.conf=/tmp/incoming.conf\*(C'\fR on the command line will cause \&\fBinncheck\fR to only verify the \fIincoming.conf\fR file, and it will perform the checks on the \fI/tmp/incoming.conf\fR file instead of the default one. Setting a file path to an empty value like \f(CW\*(C`incoming.conf=\*(C'\fR will skip the check for that file (this only makes sense with \fB\-a\fR, or no files will be checked at all). .PP Valid values for \fIfile\fR are: .PP .Vb 10 \& active \& control.ctl \& control.ctl.local \& expire.ctl \& incoming.conf \& inn.conf \& innfeed.conf \& moderators \& newsfeeds \& nntpsend.ctl \& passwd.nntp \& readers.conf \& storage.conf .Ve .SH OPTIONS .IX Header "OPTIONS" .IP "\fB\-a\fR, \fB\-\-all\fR" 4 .IX Item "-a, --all" If any \fIfile\fR value or \fIfile\fR\fB=\fR\fIpath\fR pairs (see below) are given, then normally only the files they refer to are checked. Use the \fB\-a\fR (or \&\fB\-\-all\fR) flag to specify that \fIall\fR files should be checked regardless. In this case the form \fIfile\fR\fB=\fR\fIpath\fR will be the more useful. .IP "\fB\-f\fR, \fB\-\-fix\fR" 4 .IX Item "-f, --fix" Use the \fB\-f\fR flag (or \fB\-\-fix\fR) to have \fBinncheck\fR print the appropriate \&\fBchown\fR/\fBchgrp\fR/\fBchmod\fR command necessary to fix a problem that it reports. Any other output lines will be prefixed with a hash sign (\f(CW\*(C`#\*(C'\fR) to make the output be valid input for a shell. Note that the \fB\-\-perm\fR flag must be used as well when using this flag. .IP \fB\-\-noperm\fR 4 .IX Item "--noperm" To avoid doing any checking of file permissions or ownership, use the \&\fB\-\-noperm\fR option. .IP \fB\-\-pedantic\fR 4 .IX Item "--pedantic" Use the \fB\-\-pedantic\fR option to get reports on things that are not necessarily wrong, but may indicate a bad configuration, such as \fIinn.conf\fR missing a key. .IP \fB\-\-perm\fR 4 .IX Item "--perm" \&\fBinncheck\fR checks all files for permission problems. If the \fB\-\-perm\fR flag is used, then \fIonly\fR the files specified by the \fIfile\fR or \&\fIfile\fR\fB=\fR\fIpath\fR command line arguments will be checked for problems other than permission problems. .IP "\fB\-q\fR, \fB\-\-quiet\fR" 4 .IX Item "-q, --quiet" Use the \fB\-q\fR option (or \fB\-\-quiet\fR) to get less output. .IP "\fB\-v\fR, \fB\-\-verbose\fR" 4 .IX Item "-v, --verbose" Use the \fB\-v\fR option (or \fB\-\-verbose\fR) to get more verbose output. .SH EXAMPLES .IX Header "EXAMPLES" To have \fBinncheck\fR check all files for syntax and permission problems simply run: .PP .Vb 1 \& inncheck .Ve .PP It is recommended to run the following command to be aware of all the potential problems \fBinncheck\fR can detect: .PP .Vb 1 \& inncheck \-a \-\-perm \-\-pedantic .Ve .PP To have \fBinncheck\fR check all files for permission problems and to verify the syntax of the \fIactive\fR and \fIincoming.conf\fR files, do: .PP .Vb 1 \& inncheck \-\-perm active incoming.conf .Ve .PP To fix the permissions problems noted in the output of the above command, modify it as follows: .PP .Vb 1 \& inncheck \-f \-\-perm | sh .Ve .PP (Note that it is useless to mention the name of the two files since permission problems are checked on all files.) .PP To have \fBinncheck\fR check the test \fInewsfeeds\fR file in \&\fI/var/tmp/newsfeeds.testing\fR, do: .PP .Vb 1 \& inncheck newsfeeds=/var/tmp/newsfeeds.testing .Ve .PP To have \fBinncheck\fR check all the files as it normally does, but to specify a different location for the \fInewsfeeds\fR file and omit checking of the \&\fIinnfeed.conf\fR file, do: .PP .Vb 1 \& inncheck \-a newsfeeds=/var/tmp/newsfeeds.testing innfeed.conf= .Ve .SH BUGS .IX Header "BUGS" If the \fB\-f\fR and \fB\-\-perm\fR options are used together, along with \fB\-a\fR or some \fIfile\fR or \fIfile\fR\fB=\fR\fIpath\fR arguments that refer to a file with a syntax problem, then the output will no longer be valid input for a shell. .PP In most cases, \fBinncheck\fR currently does not correctly understand option values spanning multiple lines. If you get error messages about runaway quotes, you either have to ignore them and check the correctness of the relevant lines yourself, or merge the value into a single line. .SH HISTORY .IX Header "HISTORY" Written by Brendan Kehoe and Rich Salz for InterNetNews. Converted to POD by Julien Elie. .SH "SEE ALSO" .IX Header "SEE ALSO" active(5), control.ctl(5), expire.ctl(5), history(5), incoming.conf(5), inn.conf(5), innfeed.conf(5), moderators(5), newsfeeds(5), nntpsend.ctl(5), passwd.nntp(5), readers.conf(5), storage.conf(5).