.\" -*- 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 "CNFSSTAT 8"
.TH CNFSSTAT 8 2024-04-01 "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
cnfsstat \- Show usage of CNFS buffers
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBcnfsstat\fR [\fB\-ahpPsv\fR] [\fB\-c\fR \fIclass\fR] [\fB\-i\fR \fIseconds\fR]
[\fB\-l\fR [\fIseconds\fR]] [\fB\-m\fR \fIbuffer\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBcnfsstat\fR reads \fIpathetc\fR/cycbuff.conf and \fIpathetc\fR/storage.conf
to determine which CNFS buffers are available.  It then reads the specified
cyclic buffers and shows their usage status.  \fBcnfsstat\fR can be invoked from
\&\fBrc.news\fR if \fIdocnfsstat\fR is set to true in \fIinn.conf\fR, and the result is
written to syslog(3).
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-a\fR 4
.IX Item "-a"
Besides its usual output, \fBcnfsstat\fR prints the age of the oldest article
in the cycbuff.  You may also want to use the \fB\-v\fR flag to see extended
consistency checks.
.IP "\fB\-c\fR \fIclass\fR" 4
.IX Item "-c class"
Only information for the specified class is printed.
.IP \fB\-h\fR 4
.IX Item "-h"
Print usage information and exit.
.IP "\fB\-i\fR \fIseconds\fR" 4
.IX Item "-i seconds"
With this option, \fBcnfsstat\fR has an initial sleep of \fIseconds\fR
seconds at startup.  This is useful when \fBcnfsstat\fR is started at
the same time as INN, so that it can wait a little before beginning
performing its checks.
.IP "\fB\-l\fR [\fIseconds\fR]" 4
.IX Item "-l [seconds]"
With this option, \fBcnfsstat\fR prints a status snapshot every \fIseconds\fR
seconds, and only exits if an error occurs.  When unspecified, the
default interval is \f(CW\*(C`600\*(C'\fR seconds.
.Sp
At each iteration, \fBcnfsstat\fR checks whether the \fIcycbuff.conf\fR and
\&\fIstorage.conf\fR files have been modified, and loads the new configuration
if needed.
.IP "\fB\-m\fR \fIbuffer\fR" 4
.IX Item "-m buffer"
Print information about the specified buffer in a format suitable for MRTG.
.IP \fB\-p\fR 4
.IX Item "-p"
Print an MRTG config file.
.IP \fB\-P\fR 4
.IX Item "-P"
Write PID into \fIpathrun\fR/cnfsstat.pid.
.IP \fB\-s\fR 4
.IX Item "-s"
Write output to syslog(3) instead of standard output.
.IP \fB\-v\fR 4
.IX Item "-v"
Write additional information, especially about consistency checks for article
storage and the \fIhistory\fR file.
.SH HISTORY
.IX Header "HISTORY"
Written by Katsuhiro Kondou <kondou@nec.co.jp> for InterNetNews.  Converted
to POD by Julien Elie.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
cycbuff.conf(5), history(5), inn.conf(5), rc.news(8), storage.conf(5).