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 6c92dc95186928d100bc7a3b5d52ded86f2c1454..935f2fe0603129fcb92e79ea9b17c57037e0edb7 100644 (file)
--- a/src/collectd.pod
+++ b/src/collectd.pod
@@ -76,48 +76,52 @@ Number of users logged into the system (I<users>)
 
 =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>
+
+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>
+
+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<-D> I<E<lt>directoryE<gt>>
 
 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<-P> I<E<lt>directoryE<gt>>
+=item B<-M> I<E<lt>directoryE<gt>>
 
 Sets the directory collectd should look for plugins in. Per default this is
 F</usr/lib/collectd>.
 
-=item B<-f>
+=item B<-P> I<E<lt>fileE<gt>>
 
-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>.
+Sets the PID-file.
 
 =item B<-h>
 
 Output usage information and exit.
 
-=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<-p> I<E<lt>hostE<gt>>
 
 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
@@ -157,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
@@ -281,7 +285,7 @@ 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
+=item Users (F<users.rrd>)
 
   DS:users:GAUGE:25:0:65535
 
@@ -320,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