From ca5c47aa50c8e56229c7220e3354fbdc3abf43dc Mon Sep 17 00:00:00 2001
From: octo <octo>
Date: Mon, 16 Jan 2006 21:23:24 +0000
Subject: [PATCH] Changed `DataDir' to be a valid option for mode `Server' too,
 since it's the working directory.. Wrote a part of collectd.conf(5) (file
 `collectd.conf.pod')

---
 src/Makefile.am       |   5 ++-
 src/collectd.conf.pod | 103 ++++++++++++++++++++++++++++++++++++++++++++++++++
 src/collectd.pod      |   3 +-
 src/configfile.c      |   2 +-
 4 files changed, 110 insertions(+), 3 deletions(-)
 create mode 100644 src/collectd.conf.pod

diff --git a/src/Makefile.am b/src/Makefile.am
index 67105950..236821eb 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -204,10 +204,13 @@ collectd_LDADD += "-dlopen" users.la
 collectd_DEPENDENCIES += users.la
 endif
 
-man_MANS = collectd.1
+man_MANS = collectd.1 collectd.conf.5
 #collectd_1_SOURCES = collectd.pod
 
 EXTRA_DIST = $(man_MANS)
 
 .pod.1:
 	pod2man --release=$(VERSION) --center=$(PACKAGE) $< >$@
+
+.pod.5:
+	pod2man --section=5 --release=$(VERSION) --center=$(PACKAGE) $< >$@
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
new file mode 100644
index 00000000..e4d86e74
--- /dev/null
+++ b/src/collectd.conf.pod
@@ -0,0 +1,103 @@
+=head1 NAME
+
+collectd.conf - Configuration for the system statistics collection daemon B<collectd>
+
+=head1 SYNOPSIS
+
+  Mode Client
+  DataDir /path/to/data/
+  PIDFile /path/to/pidfile/collectd.pid
+  LogFile /path/to/logfile/collectd.log
+  Server  123.123.123.123
+  Port    12345
+
+  LoadPlugin cpu
+  LoadPlugin load
+  LoadPlugin ping
+
+  <Plugin ping>
+    Host example.org
+    Host provider.net
+  </Plugin>
+
+=head1 DESCRIPTION
+
+The syntax of collectd's config file is similar to the config file of the famos
+I<Apache Webserver>. Each line either ... FIXME
+
+=head1 OPTIONS
+
+The available options.. Blah blah blah
+
+=head2 Glocal Options
+
+=over 4
+
+=item B<Mode> (B<Local>|B<Client>|B<Server>)
+
+Sets the operating mode. See the section B<MODES> in L<collectd(1)> for a
+description. This option determines which other options are allowed.
+
+=item B<LoadPlugin> I<Plugin>
+
+Loads the plugin I<Plugin>. There must be at least one such line or B<collectd>
+will be mostly useless. The names of the plugins are listed in L<collectd(1)>.
+
+=item B<PIDFile> I<File>
+
+Sets where to write the PID file to. This file is overwritten when it exists
+and deleted when the program ist stopped. Available in B<all modes>.
+
+=item B<DataDir> I<Directory>
+
+Sets the data directory. This is the directory beneath all RRD-files are
+created. Possibly more subdirectories are created. This is also the working
+directory for the daemon. Available in B<all modes>, though the B<Server> mode
+won't write to this directory.
+
+=item B<LogFile> I<File>
+
+Sets the file to write debugging output to. This is only used if compiled with
+debugging enabled. It's ignored otherwise. Available in B<all modes>.
+
+=item B<Server> I<Hostname or IP-address>
+
+The server to send data to. B<This is not yet implemented!> Maybe a better name
+for this was B<Receiver>, since I plan on detecting multicast groups
+automatically. On the other hand a extra MulticastGroup-option would be of
+interest for the server process. Anyhow, right now this is available for the
+B<Client> mode only.
+
+=item B<Port> I<Port number>
+
+(UDP-)Port to send packages to or to bind to and wait for packages. This option
+is available in the B<Client> and B<Server> mode.
+
+=back
+
+=head2 Plugin options
+
+=over
+
+=item B<ping>-Plugin
+
+=over 4
+
+=item B<Host> I<Hostname or IP-address>
+
+Host to ping periodically. This option may be repeated several times to ping
+multiple hosts.
+
+=back
+
+=back
+
+=head1 SEE ALSO
+
+L<collectd(1)>
+
+=head1 AUTHOR
+
+Florian Forster E<lt>octo@verplant.orgE<gt>
+
+=cut
diff --git a/src/collectd.pod b/src/collectd.pod
index 935f2fe0..4df62fa0 100644
--- a/src/collectd.pod
+++ b/src/collectd.pod
@@ -358,7 +358,8 @@ L<http://www.guzu.net/linux/hddtemp.php>.
 
 =head1 SEE ALSO
 
-L<rrdtool(1)>, L<sensors(1)>, L<hddtemp(8)>, L<kstat(3KSTAT)>
+L<collectd.conf(5)>, L<rrdtool(1)>, L<sensors(1)>, L<hddtemp(8)>,
+L<kstat(3KSTAT)>
 
 =head1 AUTHOR
 
diff --git a/src/configfile.c b/src/configfile.c
index ed8cb77e..988f7312 100644
--- a/src/configfile.c
+++ b/src/configfile.c
@@ -70,7 +70,7 @@ static cf_mode_item_t cf_mode_list[] =
 	{"Server",      NULL, MODE_CLIENT                           },
 	{"Port",        NULL, MODE_CLIENT | MODE_SERVER             },
 	{"PIDFile",     NULL, MODE_CLIENT | MODE_SERVER | MODE_LOCAL},
-	{"DataDir",     NULL, MODE_SERVER |               MODE_LOCAL},
+	{"DataDir",     NULL, MODE_SERVER | MODE_SERVER | MODE_LOCAL},
 	{"LogFile",     NULL, MODE_SERVER | MODE_SERVER | MODE_LOCAL}
 };
 static int cf_mode_num = 5;
-- 
2.11.0