chiark / gitweb /
debugging for thing that crashed
[innduct.git] / doc / man / inndf.8
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "INNDF 8"
132 .TH INNDF 8 "2008-04-06" "INN 2.4.5" "InterNetNews Documentation"
133 .SH "NAME"
134 inndf \- Report free disk, inodes, and overview information
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 \&\fBinndf\fR [\fB\-Fhi\fR] [\fB\-f\fR \fIfilename\fR] \fIdirectory\fR [\fIdirectory\fR ...]
138 .PP
139 \&\fBinndf\fR \fB\-n\fR
140 .PP
141 \&\fBinndf\fR \fB\-o\fR
142 .SH "DESCRIPTION"
143 .IX Header "DESCRIPTION"
144 \&\fBinndf\fR was originally a replacement for \f(CW\*(C`df | awk\*(C'\fR in \fIinnwatch.ctl\fR\|(5)
145 and \fIinnstat\fR\|(8), and now also reports various other usage information about
146 \&\s-1INN\s0's storage that \fIdf\fR\|(1) doesn't understand.  \fBinndf\fR doesn't sync, forks
147 less, and is generally less complicated than \fIdf\fR\|(1).
148 .PP
149 Its default behavior is to report free kilobytes (not disk blocks), or
150 free inodes if \fB\-i\fR is used, in the file systems holding the directories
151 given on the command line.  (A kilobyte in this case is 1024 bytes.)  If
152 only one directory is given, the output will be a simple number; if more
153 than one directory is given, the output will be formatted for human
154 readability.
155 .PP
156 If \fIenableoverview\fR is set to true in \fIinn.conf\fR, \fBinndf\fR can also be
157 used to get information about the overview database.  With the \fB\-n\fR
158 option, it reports a count of the total number of overview records stored.
159 With \fB\-o\fR, it reports the percentage of space used in the overview
160 database (for those overview methods where this is meaningful data).
161 .SH "OPTIONS"
162 .IX Header "OPTIONS"
163 .IP "\fB\-f\fR \fIfilename\fR" 4
164 .IX Item "-f filename"
165 \&\fIfilename\fR should contain a list of directories to use in addition to
166 those given by the arguments, one per line.  Blank lines and anything
167 after \f(CW\*(C`#\*(C'\fR on any line are ignored.
168 .IP "\fB\-F\fR" 4
169 .IX Item "-F"
170 Like \fB\-f\fR execpt that the filename is \fIpathetc\fR/filesystems and it is
171 not an error if this file doesn't exist.  (This option is used primarily
172 by such things as \fIinnstat\fR\|(8), so that the news administrator can add
173 additional file systems to check to \fIpathetc\fR/filesystems without having
174 to modify the script.)
175 .IP "\fB\-h\fR" 4
176 .IX Item "-h"
177 Print a usage message and exit.
178 .IP "\fB\-i\fR" 4
179 .IX Item "-i"
180 Report the number of free inodes rather than the amount of free disk
181 space.
182 .IP "\fB\-n\fR" 4
183 .IX Item "-n"
184 Report the total number of records in the overview database.  Note that
185 crossposted articles will have one overview record for each newsgroup
186 they're posted to.
187 .IP "\fB\-o\fR" 4
188 .IX Item "-o"
189 Report the percentage usage of the overview database space.  This is only
190 meaningful for overview methods that pre-allocate a certain amount of
191 space rather than grow to accomodate more records.  Currently, this flag
192 is only useful for the buffindexed overview method.
193 .SH "EXAMPLES"
194 .IX Header "EXAMPLES"
195 Print the free kilobytes in /news/spool as a simple number:
196 .PP
197 .Vb 1
198 \&    inndf /news/spool
199 .Ve
200 .PP
201 Report the free inodes in /usr/local/news and /news/spool in a format
202 designed for human readability:
203 .PP
204 .Vb 1
205 \&    inndf \-i /usr/local/news /news/spool
206 .Ve
207 .PP
208 The same, but also add in all file systems in \fIpathetc\fR/filesystems:
209 .PP
210 .Vb 1
211 \&    inndf \-i \-F /usr/local/news /news/spool
212 .Ve
213 .PP
214 Print out the number of overview records and the percentage space used by
215 a buffindexed overview database:
216 .PP
217 .Vb 1
218 \&    inndf \-no
219 .Ve
220 .SH "HISTORY"
221 .IX Header "HISTORY"
222 \&\fBinndf\fR was written by Ian Dickinson <idickins@fore.com>.  This manual
223 page was written by Swa Frantzen <Swa.Frantzen@belgium.eu.net>.  Thanks
224 also to the following folks for ports, patches, and comments:
225 .PP
226 .Vb 7
227 \&    Mahesh Ramachandran <rr@eel.ufl.edu>
228 \&    Chuck Swiger <chuck@its.com>
229 \&    Sang\-yong Suh <sysuh@kigam.re.kr>
230 \&    Brad Dickey <bdickey@haverford.edu>
231 \&    Taso N. Devetzis <devetzis@snet.net>
232 \&    Wei\-Yeh Lee <weiyeh@columbia.edu>
233 \&    Jeff Garzik <jeff.garzik@spinne.com>
234 .Ve
235 .PP
236 and to all the other folks I met and worked with during my 10 years as a
237 newsadmin.
238 .PP
239 Katsuhiro Kondou added the \fB\-n\fR and \fB\-o\fR options.  Russ Allbery added
240 reporting of percentage free disk space.  Support for \fB\-f\fR and \fB\-F\fR was
241 added by Fabien Tassin <fta@sofaraway.org>.
242 .SH "SEE ALSO"
243 .IX Header "SEE ALSO"
244 \&\fIdf\fR\|(1), \fIinnwatch.ctl\fR\|(5), \fIinnstat\fR\|(8).