Improves `collectd.conf.pod' and `collectd.pod'
authorocto <octo>
Tue, 17 Jan 2006 10:08:33 +0000 (10:08 +0000)
committerocto <octo>
Tue, 17 Jan 2006 10:08:33 +0000 (10:08 +0000)
src/collectd.conf.pod
src/collectd.pod

index d6be6f3..ca83493 100644 (file)
@@ -84,6 +84,29 @@ is available in the B<Client> and B<Server> mode.
 Some Plugins may register own options. These options must be inclosed in a
 C<Plugin>-Section. Which options exist depends on the plugin used:
 
+=head2 Plugin C<mysql>
+
+=over 4
+
+=item B<Host> I<Hostname>
+
+Hostname of the database server. Defaults to B<localhost>.
+
+=item B<User> I<Username>
+
+Username to use when connecting to the database.
+
+=item B<Password> I<Password>
+
+Password needed to log into the database.
+
+=item B<Database> I<Database>
+
+Select this database. Defaults to I<no database> which is a perfecly reasonable
+option for what this plugin does.
+
+=back
+
 =head2 Plugin C<ping>
 
 =over 4
index 4df62fa..515cba6 100644 (file)
@@ -76,21 +76,11 @@ Number of users logged into the system (I<users>)
 
 =over 4
 
-=item B<-l>
+=item B<-C> I<E<lt>config-fileE<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">.
-
-=item B<-c>
-
-Start in client (transmitter) mode. Data will be sent to the multicast group.
-See L<"MODES">.
-
-=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">.
+Specify an alternative config file. This is the place to go when you wish to
+change B<collectd>'s behavior. The path may be relative to the current working
+directory.
 
 =item B<-f>
 
@@ -98,30 +88,10 @@ 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<-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<-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>>
-
-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.
-
 =back
 
 =head1 RRD FILES