doc/pod/inndf.pod

   1 =head1 NAME
   2
   3 inndf - Report free disk, inodes, and overview information
   4
   5 =head1 SYNOPSIS
   6
   7 B<inndf> [B<-Fhi>] [B<-f> I<filename>] I<directory> [I<directory> ...]
   8
   9 B<inndf> B<-n>
  10
  11 B<inndf> B<-o>
  12
  13 =head1 DESCRIPTION
  14
  15 B<inndf> was originally a replacement for C<df | awk> in innwatch.ctl(5)
  16 and innstat(8), and now also reports various other usage information about
  17 INN's storage that df(1) doesn't understand.  B<inndf> doesn't sync, forks
  18 less, and is generally less complicated than df(1).
  19
  20 Its default behavior is to report free kilobytes (not disk blocks), or
  21 free inodes if B<-i> is used, in the file systems holding the directories
  22 given on the command line.  (A kilobyte in this case is 1024 bytes.)  If
  23 only one directory is given, the output will be a simple number; if more
  24 than one directory is given, the output will be formatted for human
  25 readability.
  26
  27 If I<enableoverview> is set to true in F<inn.conf>, B<inndf> can also be
  28 used to get information about the overview database.  With the B<-n>
  29 option, it reports a count of the total number of overview records stored.
  30 With B<-o>, it reports the percentage of space used in the overview
  31 database (for those overview methods where this is meaningful data).
  32
  33 =head1 OPTIONS
  34
  35 =over 4
  36
  37 =item B<-f> I<filename>
  38
  39 I<filename> should contain a list of directories to use in addition to
  40 those given by the arguments, one per line.  Blank lines and anything
  41 after C<#> on any line are ignored.
  42
  43 =item B<-F>
  44
  45 Like B<-f> execpt that the filename is I<pathetc>/filesystems and it is
  46 not an error if this file doesn't exist.  (This option is used primarily
  47 by such things as innstat(8), so that the news administrator can add
  48 additional file systems to check to I<pathetc>/filesystems without having
  49 to modify the script.)
  50
  51 =item B<-h>
  52
  53 Print a usage message and exit.
  54
  55 =item B<-i>
  56
  57 Report the number of free inodes rather than the amount of free disk
  58 space.
  59
  60 =item B<-n>
  61
  62 Report the total number of records in the overview database.  Note that
  63 crossposted articles will have one overview record for each newsgroup
  64 they're posted to.
  65
  66 =item B<-o>
  67
  68 Report the percentage usage of the overview database space.  This is only
  69 meaningful for overview methods that pre-allocate a certain amount of
  70 space rather than grow to accomodate more records.  Currently, this flag
  71 is only useful for the buffindexed overview method.
  72
  73 =back
  74
  75 =head1 EXAMPLES
  76
  77 Print the free kilobytes in /news/spool as a simple number:
  78
  79     inndf /news/spool
  80
  81 Report the free inodes in /usr/local/news and /news/spool in a format
  82 designed for human readability:
  83
  84     inndf -i /usr/local/news /news/spool
  85
  86 The same, but also add in all file systems in I<pathetc>/filesystems:
  87
  88     inndf -i -F /usr/local/news /news/spool
  89
  90 Print out the number of overview records and the percentage space used by
  91 a buffindexed overview database:
  92
  93     inndf -no
  94
  95 =head1 HISTORY
  96
  97 B<inndf> was written by Ian Dickinson <idickins@fore.com>.  This manual
  98 page was written by Swa Frantzen <Swa.Frantzen@belgium.eu.net>.  Thanks
  99 also to the following folks for ports, patches, and comments:
 100
 101     Mahesh Ramachandran <rr@eel.ufl.edu>
 102     Chuck Swiger <chuck@its.com>
 103     Sang-yong Suh <sysuh@kigam.re.kr>
 104     Brad Dickey <bdickey@haverford.edu>
 105     Taso N. Devetzis <devetzis@snet.net>
 106     Wei-Yeh Lee <weiyeh@columbia.edu>
 107     Jeff Garzik <jeff.garzik@spinne.com>
 108
 109 and to all the other folks I met and worked with during my 10 years as a
 110 newsadmin.
 111
 112 Katsuhiro Kondou added the B<-n> and B<-o> options.  Russ Allbery added
 113 reporting of percentage free disk space.  Support for B<-f> and B<-F> was
 114 added by Fabien Tassin <fta@sofaraway.org>.
 115
 116 =head1 SEE ALSO
 117
 118 df(1), innwatch.ctl(5), innstat(8).
 119
 120 =cut