chiark / gitweb /
wip manpage
[inn-innduct.git] / doc / man / cnfsstat.8
1 .\" $Revision: 5909 $
2 .TH CNFSSTAT 8
3 .SH NAME
4 cnfsstat \- show usage of cycbuffs
5 .SH SYNOPSIS
6 .B cnfsstat
7 [
8 .B \-a
9 ]
10 [
11 .B \-c CLASS
12 ]
13 [
14 .B \-h
15 ]
16 [
17 .B \-l
18 [
19 seconds
20 ]
21 ]
22 [
23 .B \-m BUFFER
24 ]
25 [
26 .B \-P
27 ]
28 [
29 .B \-p
30 ]
31 [
32 .B \-s
33 ]
34 .SH DESCRIPTION
35 .I Cnfsstat
36 reads
37 .I <pathetc in inn.conf>/cycbuff.conf
38 and
39 .I <pathetc in inn.conf>/storage.conf
40 to determine which cycbuffs are available, read the specified cycbuffs, and
41 shows their usage status.
42 .PP
43 .I Cnfsstat
44 can be invoked from
45 .IR rc.news (8),
46 if
47 .I <docnfsstat in inn.conf>
48 is ``true'', and the result is written to
49 .IR syslog (3).
50 .SH OPTIONS
51 .TP
52 .B \-a
53 .I Cnfsstat
54 prints also the age of the oldest article in the cycbuff.
55 .TP
56 .B \-c CLASS
57 .I Cnfsstat
58 prints information only for the specified class.
59 .TP
60 .B \-h
61 .I Cnfsstat
62 prints usage information.
63 .TP
64 .B \-l [ seconds ]
65 .I Cnfsstat
66 prints a status snapshot every
67 .IR seconds ,
68 and only exits if there is an error.
69 The default interval is 600 seconds.
70 .TP
71 .B \-m BUFFER
72 .I Cnfsstat
73 prints information about the specified buffer in a format suitable
74 for mrtg.
75 .TP
76 .B \-P
77 .I Cnfsstat
78 writes PID into
79 .IR <pathrun\ in\ inn.conf>/cnfsstat.pid .
80 .TP
81 .B \-p
82 .I Cnfsstat
83 prints an mrtg config file.
84 .TP
85 .B \-s
86 .I Cnfsstat
87 writes output to
88 .IR syslog (3)
89 instead of standard output.
90 .SH HISTORY
91 Written by Katsuhiro Kondou <kondou@nec.co.jp> for InterNetNews.
92 .de R$
93 This is revision \\$3, dated \\$4.
94 ..
95 .R$ $Id: cnfsstat.8 5909 2002-12-03 05:17:18Z vinocur $
96 .SH "SEE ALSO"
97 cycbuff.conf(5),
98 inn.conf(5),
99 rc.news(8),
100 storage.conf(5).