chiark / gitweb /
use libinn logging where applicable - debugged
[inn-innduct.git] / doc / pod / ovdb_stat.pod
1 =head1 NAME
2
3 ovdb_stat - Display information from the ovdb database
4
5 =head1 SYNOPSYS
6
7 B<ovdb_stat> B<-Hgci> [B<-r> I<artnumrange>] newsgroup [newsgroup ...]
8
9 B<ovdb_stat> B<-Hklmtv> [B<-d> I<database>]
10
11 =head1 DESCRIPTION
12
13 B<ovdb_stat> displays information from the ovdb database: BerkeleyDB
14 statistics, newsgroup data, and overview records; and optionally
15 outputs in HTML format.
16
17 =head1 OPTIONS
18
19 =over 4
20
21 =item B<-g>
22
23 Newsgroup himark, lowmark, article count, and flag for the given newsgroups
24 (as stored in the ovdb "groupinfo" database) are displayed.
25
26 =item B<-c>
27
28 Similar to B<-g>, except the himark, lowmark, and count are calculated
29 by actually scanning the overview records and counting them.
30 This can be a lengthy operation on groups with lots of articles.
31
32 =item B<-i>
33
34 Internal data regarding the given newsgroups are displayed.
35
36 =item B<-r> I<artnumrange>
37
38 Overview records are retrieved.  The I<artnumrange> parameter may be
39 a single article number, or a range of articles in the format C<low-hi>.
40
41 =item B<-H>
42
43 Output is presented in HTML format.
44
45 =item B<-k>
46
47 Displays lock region statistics, as returned by the BerkeleyDB lock_stat()
48 call.
49
50 =item B<-l>
51
52 Displays log region statistics, as returned by the BerkeleyDB log_stat()
53 call.
54
55 =item B<-m>
56
57 Displays global memory pool statistics, as returned by the
58 BerkeleyDB memp_stat() call.
59
60 =item B<-M>
61
62 Same as B<-m>, and also displays memory pool statistics for each
63 database file.
64
65 =item B<-t>
66
67 Displays log region statistics, as returned by the BerkeleyDB txn_stat()
68 call.
69
70 =item B<-v>
71
72 Displays ovdb version, and BerkeleyDB version.
73
74 =item B<-d> I<database>
75
76 Displays information about the given database, as returned by the
77 BerkeleyDB db->stat() call.  This operation may take a long time
78 on busy systems (several minutes or more).
79
80 =back
81
82 =head1 WARNINGS
83
84 ovdb_stat may be safely killed with the INT, TERM, or HUP signals.
85 It catches those signals and exits cleanly.
86 Do not kill ovdb_stat with other signals, unless absolutely necessary,
87 because it may leave stale locks in the DB environment.
88
89 =head1 HISTORY
90
91 Written by Heath Kehoe E<lt>hakehoe@avalon.netE<gt> for InterNetNews.
92
93 =head1 SEE ALSO
94
95 ovdb(5)
96
97 =cut