From f6a528b13a43d75b06e15ce3f38550aa5594842a Mon Sep 17 00:00:00 2001 From: Sebastian Harl Date: Mon, 1 Apr 2013 23:30:01 +0200 Subject: [PATCH] sysdbd.conf(5): Added an initial manpage for sysdbd's configuration. --- .gitignore | 1 + doc/Makefile.am | 20 ++++++-- doc/sysdbd.1.txt | 4 ++ doc/sysdbd.conf.5.txt | 104 ++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 126 insertions(+), 3 deletions(-) create mode 100644 doc/sysdbd.conf.5.txt diff --git a/.gitignore b/.gitignore index 076c35e..847ea1b 100644 --- a/.gitignore +++ b/.gitignore @@ -38,5 +38,6 @@ src/liboconfig/scanner.c *.o sysdbd sysdbd.1 +sysdbd.conf.5 sysdb.h diff --git a/doc/Makefile.am b/doc/Makefile.am index 029d95e..35c3a4a 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,13 +1,27 @@ -EXTRA_DIST = sysdbd.1.txt -CLEANFILES = sysdbd.1 +EXTRA_DIST = \ + sysdbd.1.txt \ + sysdbd.conf.5.txt +CLEANFILES = \ + sysdbd.1 \ + sysdbd.conf.5 -man_MANS = sysdbd.1 +man_MANS = \ + sysdbd.1 \ + sysdbd.conf.5 sysdbd.1: sysdbd.1.txt ../version +sysdbd.conf.5: sysdbd.conf.5.txt ../version + %.1: %.1.txt @A2X@ -d manpage -f manpage \ -apackage_version=$(PACKAGE_VERSION) \ -abuild_date="$$( date --utc '+%F' )" \ $< +%.5: %.5.txt + @A2X@ -d manpage -f manpage \ + -apackage_version=$(PACKAGE_VERSION) \ + -abuild_date="$$( date --utc '+%F' )" \ + $< + diff --git a/doc/sysdbd.1.txt b/doc/sysdbd.1.txt index 33ec8cf..019ad97 100644 --- a/doc/sysdbd.1.txt +++ b/doc/sysdbd.1.txt @@ -54,6 +54,10 @@ BUGS ---- None known. +SEE ALSO +-------- +*sysdb.conf*(5) + AUTHOR ------ sysdbd was written by Sebastian "tokkee" Harl . diff --git a/doc/sysdbd.conf.5.txt b/doc/sysdbd.conf.5.txt new file mode 100644 index 0000000..b389a6c --- /dev/null +++ b/doc/sysdbd.conf.5.txt @@ -0,0 +1,104 @@ +sysdbd.conf(5) +============== +Sebastian "tokkee" Harl +version {package_version}, {build_date} +:doctype: manpage + +NAME +---- +sysdbd.conf - configuration for the system management and inventory collection +service + +SYNOPSIS +-------- + Interval 300 + + LoadBackend "collectd::unixsock" + LoadBackend "mk-livestatus" + + + Interval 1800 + + + + + Socket "/var/run/collectd-unixsock" + + + +DESCRIPTION +----------- +The *sysdbd.conf* file controls the behavior of the system management and +inventory collection daemon (*sysdbd*). As the daemon itself does not provide +any real (user-facing) functionality, the most important part of the +configuration is loading and configuring plugins. + +The syntax of this configuration file is similar to that of the Apache +webserver. It is made up of _options_ and _sections_. Each option contains a +_key_ and one or more _values_ separated by spaces and terminated by a newline +character. Sections are enclosed in a start- and end-tag, each on a line of +their own. These tags are enclosed in angle brackets and also contain a key +and value. Section end-tags only contain the key of the start-tag prepended by +a forward-slash ("/"). Empty lines are ignored as well as any unquoted hash +symbol ("#") including anything following up to the following newline. Keys +are unquoted strings consisting only of alphanumeric characters and the +underscore character ("_"). Values may either be unquoted strings, quoted +strings enclosed in double quotes, numbers or boolean values (*true* or +*false*). In order to include a double-quote character in a quoted string, +escape it using a backslash character ("\"). Floating point numbers use a dot +(".") as decimal separator. + +Lines may be wrapped by using a backslash character ("\") as the last +character before the newline. This allows long lines to be split into multiple +lines. Quoted strings may be wrapped as well. However, those are treated +special in that whitespace at the beginning of the following lines will be +ignored, which allows for nicely indenting the wrapped lines. + +GLOBAL SETTINGS +--------------- +*sysdbd* accepts the following global options: + +*Interval* '':: + Sets the interval at which to query backends by default. The interval is + specified in seconds and might be a floating-point value. This option will + be used by any "active" backend, that is, those that actively query some + external system rather than receiving some stream of events. + +*LoadBackend* '':: + Loads the backend named ''. Backends are special plugins taking care + of collecting values from external systems. This may optionally be a + section containing any of the following options: + + *Interval* '';; + Overwrite the global interval setting by setting a custom interval to + be used for this backend. See the global *Interval* option for more + details. + +PLUGINS +------- +Some plugins support additional configuration options. Each of these are +enclosed in a *Plugin* or *Backend* section. The following plugins are shipped +with SysDB. See *sysdb*-''(5) manpages for more details. + +* *collectd::unixsock* +* *mk-livestatus* +* *puppet::store-configs* + +SEE ALSO +-------- +*sysdbd*(1) + +AUTHOR +------ +sysdbd was written by Sebastian "tokkee" Harl . + +COPYRIGHT +--------- +Copyright (C) 2012 Sebastian "tokkee" Harl + +This is free software under the terms of the BSD license, see the source for +copying conditions. There is NO WARRANTY; not even for MERCHANTABILITY or +FITNESS FOR A PARTICULAR PURPOSE. + +// vim: set tw=78 sw=4 ts=4 noexpandtab spell spelllang=en_us : + -- 2.30.2