Moved `exit_usage' from `collectd.c' to `configfile.c' and renamed it to `cf_callback...

[collectd.git] / src / collectd.pod

diff --git a/src/collectd.pod b/src/collectd.pod
index ba7b6bed9b9fd0c5c7d476e007bb9a2224c32702..935f2fe0603129fcb92e79ea9b17c57037e0edb7 100644 (file)
--- a/src/collectd.pod
+++ b/src/collectd.pod
@@ -66,21 +66,31 @@ Tape drive usage (I<tape>, Solaris only)
 
 Network traffic (I<traffic>)
 
+=item
+
+Number of users logged into the system (I<users>)
+
 =back
 
 =head1 OPTIONS
 
 =over 4
 
+=item B<-l>
+
+Start in local mode. This is the default. No data will be sent or read to/from
+the network. Information will be read and written by the same process. See
+L<"MODES">.
+
 =item B<-c>
 
 Start in client (transmitter) mode. Data will be sent to the multicast group.
 See L<"MODES">.
 
-=item B<-d> I<E<lt>directoryE<gt>>
+=item B<-s>
 
-Sets the directory collectd should work in. All F<.rrd>-files are created in
-this directory. Per default this is F</var/lib/collectd/>.
+Start in server (receiver) mode. Data sent to the multicast group will be read
+and stored in RRD files. See L<"MODES">.
 
 =item B<-f>
 
@@ -88,15 +98,23 @@ Don't fork to the background. I<collectd> will also B<not> close standard file
 descriptors, detach from the session nor write a pid file. This is mainly
 thought for 'supervisioning' init replacements such as I<runit>.
 
-=item B<-h>
+=item B<-D> I<E<lt>directoryE<gt>>
 
-Output usage information and exit.
+Sets the directory collectd should work in. All F<.rrd>-files are created in
+this directory. Per default this is F</var/lib/collectd/>.
 
-=item B<-l>
+=item B<-M> I<E<lt>directoryE<gt>>
 
-Start in local mode. This is the default. No data will be sent or read to/from
-the network. Information will be read and written by the same process. See
-L<"MODES">.
+Sets the directory collectd should look for plugins in. Per default this is
+F</usr/lib/collectd>.
+
+=item B<-P> I<E<lt>fileE<gt>>
+
+Sets the PID-file.
+
+=item B<-h>
+
+Output usage information and exit.
 
 =item B<-p> I<E<lt>hostE<gt>>
 
@@ -104,11 +122,6 @@ Sets the host to ping periodically. This option may be given more than once to
 ping multiple hosts. If this option is not given at least once no host will be
 pinged.
 
-=item B<-s>
-
-Start in server (receiver) mode. Data sent to the multicast group will be read
-and stored in RRD files. See L<"MODES">.
-
 =back
 
 =head1 RRD FILES
@@ -148,7 +161,7 @@ The DS'es depend on the module creating the RRD files:
 
 =item Diskstats (F<disk-I<E<lt>majorE<gt>>-I<E<lt>minorE<gt>>.rrd>)
 
-  DS:rcount:COUNTER:25:0:
+  DS:rcount:COUNTER:25:0:U
   DS:rmerged:COUNTER:25:0:U
   DS:rbytes:COUNTER:25:0:U
   DS:rtime:COUNTER:25:0:U
@@ -272,6 +285,10 @@ The DS'es depend on the module creating the RRD files:
   DS:incoming:COUNTER:25:0:U
   DS:outgoing:COUNTER:25:0:U
 
+=item Users (F<users.rrd>)
+
+  DS:users:GAUGE:25:0:65535
+
 =back
 
 =head1 MODES
@@ -307,6 +324,10 @@ it's totally up to you to secure your net.
 
 The UDP port used has been checked to not be assigned by the IANA.
 
+On multi-homed machines you may need to add a route to the multicast net
+(B<224.0.0.0/4>) if multicast packages take the wrong interface. The listener
+on the other hand listens on B<all> interfaces.
+
 =head1 SPECIAL MODULES
 
 =head2 cpufreq