INN commit: branches/2.5 (6 files)
INN Commit
rra at isc.org
Sat Feb 12 09:50:55 UTC 2011
Date: Saturday, February 12, 2011 @ 01:50:55
Author: iulius
Revision: 9185
Convert inncheck man page to POD.
Update the help usage.
Fix a few typos, and add the control.ctl.local file.
Added:
branches/2.5/doc/pod/inncheck.pod
(from rev 9184, trunk/doc/pod/inncheck.pod)
Modified:
branches/2.5/MANIFEST
branches/2.5/doc/man/ (properties)
branches/2.5/doc/pod/Makefile
branches/2.5/scripts/inncheck.in
Deleted:
branches/2.5/doc/man/inncheck.8
----------------------+
MANIFEST | 1
doc/man/inncheck.8 | 171 -------------------------------------------------
doc/pod/Makefile | 3
doc/pod/inncheck.pod | 133 ++++++++++++++++++++++++++++++++++++++
scripts/inncheck.in | 4 -
5 files changed, 138 insertions(+), 174 deletions(-)
Modified: MANIFEST
===================================================================
--- MANIFEST 2011-02-12 09:48:24 UTC (rev 9184)
+++ MANIFEST 2011-02-12 09:50:55 UTC (rev 9185)
@@ -262,6 +262,7 @@
doc/pod/inews.pod Master file for inews.1
doc/pod/inn.conf.pod Master file for inn.conf.5
doc/pod/innbind.pod Master file for innbind.8
+doc/pod/inncheck.pod Master file for inncheck.8
doc/pod/innconfval.pod Master file for innconfval.1
doc/pod/innd.pod Master file for innd.8
doc/pod/inndf.pod Master file for inndf.8
Property changes on: branches/2.5/doc/man
___________________________________________________________________
Modified: svn:ignore
- active.5
active.times.5
actsync.8
archive.8
auth_krb5.8
batcher.8
buffchan.8
buffindexed.conf.5
ckpasswd.8
cnfsheadconf.8
cnfsstat.8
control.ctl.5
convdate.1
ctlinnd.8
cvtbatch.8
cycbuff.conf.5
distrib.pats.5
distributions.5
docheckgroups.8
domain.8
expire.ctl.5
expire.8
expireover.8
expirerm.8
fastrm.1
getlist.1
grephistory.1
ident.8
incoming.conf.5
inews.1
inn.conf.5
INN__Config.3pm
innbind.8
innconfval.1
innd.8
inndf.8
innfeed.8
innmail.1
innupgrade.8
innxmit.8
libauth.3
libinnhist.3
libstorage.3
list.3
mailpost.8
makedbz.8
makehistory.8
mod-active.8
moderators.5
motd.news.5
newsfeeds.5
news.daily.8
news2mail.8
newslog.5
newsgroups.5
ninpaths.8
nnrpd.8
nntpsend.8
nntpsend.ctl.5
ovdb.5
ovdb_init.8
ovdb_monitor.8
ovdb_server.8
ovdb_stat.8
overchan.8
passwd.nntp.5
perl-nocem.8
pgpverify.1
prunehistory.8
pullnews.1
qio.3
radius.8
radius.conf.5
rc.news.8
readers.conf.5
rnews.1
sasl.conf.5
scanlogs.8
send-uucp.8
sendinpaths.8
shlock.1
simpleftp.1
sm.1
storage.conf.5
subscriptions.5
tally.control.8
tdx-util.8
tinyleaf.8
tst.3
uwildmat.3
+ active.5
active.times.5
actsync.8
archive.8
auth_krb5.8
batcher.8
buffchan.8
buffindexed.conf.5
ckpasswd.8
cnfsheadconf.8
cnfsstat.8
control.ctl.5
convdate.1
ctlinnd.8
cvtbatch.8
cycbuff.conf.5
distrib.pats.5
distributions.5
docheckgroups.8
domain.8
expire.ctl.5
expire.8
expireover.8
expirerm.8
fastrm.1
getlist.1
grephistory.1
ident.8
incoming.conf.5
inews.1
inn.conf.5
INN__Config.3pm
innbind.8
inncheck.8
innconfval.1
innd.8
inndf.8
innfeed.8
innmail.1
innupgrade.8
innxmit.8
libauth.3
libinnhist.3
libstorage.3
list.3
mailpost.8
makedbz.8
makehistory.8
mod-active.8
moderators.5
motd.news.5
newsfeeds.5
news.daily.8
news2mail.8
newslog.5
newsgroups.5
ninpaths.8
nnrpd.8
nntpsend.8
nntpsend.ctl.5
ovdb.5
ovdb_init.8
ovdb_monitor.8
ovdb_server.8
ovdb_stat.8
overchan.8
passwd.nntp.5
perl-nocem.8
pgpverify.1
prunehistory.8
pullnews.1
qio.3
radius.8
radius.conf.5
rc.news.8
readers.conf.5
rnews.1
sasl.conf.5
scanlogs.8
send-uucp.8
sendinpaths.8
shlock.1
simpleftp.1
sm.1
storage.conf.5
subscriptions.5
tally.control.8
tdx-util.8
tinyleaf.8
tst.3
uwildmat.3
Deleted: doc/man/inncheck.8
===================================================================
--- doc/man/inncheck.8 2011-02-12 09:48:24 UTC (rev 9184)
+++ doc/man/inncheck.8 2011-02-12 09:50:55 UTC (rev 9185)
@@ -1,171 +0,0 @@
-.TH INNCHECK 8
-.SH NAME
-inncheck \- check inn configuration and database files.
-.SH SYNOPSIS
-.B inncheck
-[
-.B \-a
-]
-[
-.B \-v
-]
-[
-.B \-pedantic
-]
-[
-.B \-f
-]
-[
-.B \-perm
-]
-[
-.B \-noperm
-]
-[
-.B "file=value | file"
-]
-.SH DESCRIPTION
-.I Inncheck
-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
-.I Inncheck
-does not make changes to any files \(em 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 \fBfile\fP or
-\fBfile=value\fP arguments. For example, putting \fBincoming.conf\fP causes
-only the
-.I incoming.conf
-file to be checked. Using \fBincoming.conf=/tmp/incoming.conf\fP on the
-command line will cause
-.I inncheck
-to only verify the incoming.conf file, and it will perform the
-checks on the file
-/tmp/incoming.conf file instead of the default one.
-.PP
-Valid values for
-.I file
-are:
-.PP
-.RS
-.nf
- active
- control.ctl
- expire.ctl
- incoming.conf
- inn.conf
- moderators
- newsfeeds
- nntpsend.ctl
- passwd.nntp
- readers.conf
-.fi
-.RE
-.SH OPTIONS
-.TP
-.B \-a
-If any ``\fBfile\fP'' value or ``\fBfile=value\fP'' pairs (see below) are
-given, then normally only the files they refer to are checked. Use
-the ``\fB\-a\fP'' flag to specify that
-.I all
-files should be checked regardless. In this case the form \fBfile=value\fP
-will be the more useful.
-.TP
-.B \-v
-Use the ``\fB\-v\fP'' option to get more verbose output.
-.TP
-.B \-pedantic
-Use the ``\fB\-pedantic\fP'' option to get reports on things that are not
-necessarily wrong, but may indicate a bad configuration \(em such as
-\fIinn.conf\fP missing a key.
-.TP
-.B \-f
-Use the ``\fB\-f\fP'' flag to have inncheck print the appropriate
-chown/chgrp/chmod command necessary to fix a problem that it reports. Any
-other output lines will be prefixed with a ``#'' character to make the
-output be valid input for a shell. Note that the ``\fB\-perm\fP'' flag
-must be used as well when using this flag.
-.TP
-.B \-perm
-Inncheck checks all files for permission problems.
-If the ``\fB\-perm\fP'' flag is used, then
-.I only
-the files specified by the \fBfile\fP or \fBfile=value\fP command line
-arguments will be checked for problems other than permission problems.
-.TP
-.B \-noperm
-To avoid doing any checking of file permissions or ownership, use
-the ``\fB-noperm\fP'' option.
-.SH EXAMPLES
-.PP
-To have
-.I inncheck
-check all files for syntax and permission problems simply:
-.PP
-.RS
-.nf
-inncheck
-.fi
-.RE
-.PP
-To have
-.I inncheck
-check all files for permission problems and to verify the syntax of the
-active and incoming.conf files do:
-.PP
-.RS
-.nf
-inncheck -perm active incoming.conf
-.fi
-.RE
-.PP
-To fix the permissions problems noted in the output of the above
-command, modify it as follow:
-.PP
-.RS
-.nf
-inncheck -f -perm | sh
-.fi
-.RE
-.PP
-To have
-.I inncheck
-check the test newsfeeds file in /var/tmp/newsfeeds.testing, do:
-.PP
-.RS
-.nf
-inncheck newsfeeds=/var/tmp/newsfeeds.testing
-.fi
-.RE
-.PP
-To have
-.I inncheck
-check all the files as it normally does, but to specify a different
-location for the newsfeeds file, so:
-.PP
-.RS
-.nf
-inncheck -a newsfeeds=/var/tmp/newsfeeds.testing
-.fi
-.RE
-.SH BUGS
-If the ``\fB-f\fP'' and ``\fB-perm\fP'' options are used together, along with
-``\fB\-a\fP'' or some ``\fBfile\fP'' or ``\fBfile=value\fP'' arguments that
-refer to a file with a syntax problem, then the output will no longer be
-valid input for a shell.
-.SH HISTORY
-Written by Brendan Kehoe <brendan at cygnus.com> and
-Rich Salz <rsalz at uunet.uu.net>
-.de R$
-This is revision \\$3, dated \\$4.
-..
-.R$ $Id$
-.SH "SEE ALSO"
-active(5),
-expire.ctl(5),
-history(5),
-incoming.conf(5),
-inn.conf(5),
-newsfeeds(5)
Modified: doc/pod/Makefile
===================================================================
--- doc/pod/Makefile 2011-02-12 09:48:24 UTC (rev 9184)
+++ doc/pod/Makefile 2011-02-12 09:50:55 UTC (rev 9185)
@@ -34,7 +34,7 @@
../man/ctlinnd.8 ../man/cvtbatch.8 ../man/docheckgroups.8 \
../man/domain.8 ../man/expire.8 ../man/expireover.8 \
../man/expirerm.8 ../man/ident.8 \
- ../man/innbind.8 ../man/innd.8 ../man/inndf.8 \
+ ../man/innbind.8 ../man/inncheck.8 ../man/innd.8 ../man/inndf.8 \
../man/innfeed.8 ../man/innupgrade.8 \
../man/innxmit.8 \
../man/makedbz.8 ../man/makehistory.8 ../man/mod-active.8 \
@@ -126,6 +126,7 @@
../man/expirerm.8: expirerm.pod ; $(POD2MAN) -s 8 $? > $@
../man/ident.8: ident.pod ; $(POD2MAN) -s 8 $? > $@
../man/innbind.8: innbind.pod ; $(POD2MAN) -s 8 $? > $@
+../man/inncheck.8: inncheck.pod ; $(POD2MAN) -s 8 $? > $@
../man/innd.8: innd.pod ; $(POD2MAN) -s 8 $? > $@
../man/inndf.8: inndf.pod ; $(POD2MAN) -s 8 $? > $@
../man/innfeed.8: innfeed.pod ; $(POD2MAN) -s 8 $? > $@
Copied: branches/2.5/doc/pod/inncheck.pod (from rev 9184, trunk/doc/pod/inncheck.pod)
===================================================================
--- doc/pod/inncheck.pod (rev 0)
+++ doc/pod/inncheck.pod 2011-02-12 09:50:55 UTC (rev 9185)
@@ -0,0 +1,133 @@
+=head1 NAME
+
+inncheck - Check INN configuration and database files
+
+=head1 SYNOPSIS
+
+B<inncheck> [B<-afv>] [B<-noperm> | B<-perm>] [B<-pedantic>]
+[I<file> | I<file>B<=>I<path> ...]
+
+=head1 DESCRIPTION
+
+B<inncheck> 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.
+
+B<inncheck> does not make changes to any files S<-- it> just reports what
+it thinks may be wrong, and it is up to the operator to fix the problem
+
+The set of files checked may be restricted by using I<file> or
+I<file>B<=>I<path> arguments. For example, putting C<incoming.conf>
+causes only the F<incoming.conf> file to be checked. Using
+C<incoming.conf=/tmp/incoming.conf> on the command line will cause
+B<inncheck> to only verify the F<incoming.conf> file, and it will perform
+the checks on the F</tmp/incoming.conf> file instead of the default one.
+
+Valid values for I<file> are:
+
+ active
+ control.ctl
+ control.ctl.local
+ expire.ctl
+ incoming.conf
+ inn.conf
+ moderators
+ newsfeeds
+ nntpsend.ctl
+ passwd.nntp
+ readers.conf
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-a>
+
+If any I<file> value or I<file>B<=>I<path> pairs (see below) are given,
+then normally only the files they refer to are checked. Use the B<-a>
+flag to specify that I<all> files should be checked regardless. In this
+case the form I<file>B<=>I<path> will be the more useful.
+
+=item B<-f>
+
+Use the B<-f> flag to have B<inncheck> print the appropriate
+B<chown>/B<chgrp>/B<chmod> command necessary to fix a problem that it
+reports. Any other output lines will be prefixed with a hash sign (C<#>)
+to make the output be valid input for a shell. Note that the B<-perm>
+flag must be used as well when using this flag.
+
+=item B<-noperm>
+
+To avoid doing any checking of file permissions or ownership, use the
+B<-noperm> option.
+
+=item B<-pedantic>
+
+Use the B<-pedantic> option to get reports on things that are not necessarily
+wrong, but may indicate a bad configuration, such as F<inn.conf> missing
+a key.
+
+=item B<-perm>
+
+B<inncheck> checks all files for permission problems. If the B<-perm>
+flag is used, then I<only> the files specified by the I<file> or
+I<file>B<=>I<path> command line arguments will be checked for problems
+other than permission problems.
+
+=item B<-v>
+
+Use the B<-v> option to get more verbose output.
+
+=back
+
+=head1 EXAMPLES
+
+To have B<inncheck> check all files for syntax and permission problems
+simply run:
+
+ inncheck
+
+To have B<inncheck> check all files for permission problems and to verify
+the syntax of the F<active> and F<incoming.conf> files, do:
+
+ inncheck -perm active incoming.conf
+
+To fix the permissions problems noted in the output of the above command,
+modify it as follows:
+
+ inncheck -f -perm | sh
+
+(Note that it is useless to mention the name of the two files since
+permission problems are checked on all files.)
+
+To have B<inncheck> check the test F<newsfeeds> file in
+F</var/tmp/newsfeeds.testing>, do:
+
+ inncheck newsfeeds=/var/tmp/newsfeeds.testing
+
+To have B<inncheck> check all the files as it normally does, but to specify
+a different location for the F<newsfeeds> file, do:
+
+ inncheck -a newsfeeds=/var/tmp/newsfeeds.testing
+
+=head1 BUGS
+
+If the B<-f> and B<-perm> options are used together, along with B<-a> or
+some I<file> or I<file>B<=>I<path> arguments that refer to a file with
+a syntax problem, then the output will no longer be valid input for a shell.
+
+=head1 HISTORY
+
+Written by Brendan Kehoe <brendan at cygnus.com> and Rich Salz
+<rsalz at uunet.uu.net> for InterNetNews. Converted to POD by Julien Elie.
+
+$Id$
+
+=head1 SEE ALSO
+
+active(5), control.ctl(5), expire.ctl(5), history(5), incoming.conf(5),
+inn.conf(5), moderators(5), newsfeeds(5), nntpsend.ctl(5), passwd.nntp(5),
+readers.conf(5).
+
+=cut
Modified: scripts/inncheck.in
===================================================================
--- scripts/inncheck.in 2011-02-12 09:48:24 UTC (rev 9184)
+++ scripts/inncheck.in 2011-02-12 09:50:55 UTC (rev 9185)
@@ -785,9 +785,9 @@
print "Usage error: @_.\n";
print
"Usage:
- $program [-v] [-noperm] [-pedantic] [-perms [-fix] ] [-a|file...]
+ $program [-afv] [-noperm|perm] [-pedantic] [file | file=value...]
File to check may be followed by \"=path\" to use the specified path. All
-files are checked if -a is used or if -perms is not used. Files that may
+files are checked if -a is used or if -perm is not used. Files that may
be checked are:\n";
foreach ( sort(keys %checklist) ) {
printf " %-20s", $_;
More information about the inn-committers
mailing list