![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/src/collectd-unixsock.5 b/src/collectd-unixsock.5
--- /dev/null
+++ b/src/collectd-unixsock.5
@@ -0,0 +1,380 @@
+.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings. \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote. \*(C+ will
+.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+. ds -- \(*W-
+. ds PI pi
+. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
+. ds L" ""
+. ds R" ""
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds -- \|\(em\|
+. ds PI \(*p
+. ds L" ``
+. ds R" ''
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{
+. if \nF \{
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear. Run. Save yourself. No user-serviceable parts.
+. \" fudge factors for nroff and troff
+.if n \{\
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
+.\}
+.if t \{\
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
+.\}
+. \" simple accents for nroff and troff
+.if n \{\
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
+.\}
+.if t \{\
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+. \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+. \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+. \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+. ds : e
+. ds 8 ss
+. ds o a
+. ds d- d\h'-1'\(ga
+. ds D- D\h'-1'\(hy
+. ds th \o'bp'
+. ds Th \o'LP'
+. ds ae ae
+. ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "COLLECTD-UNIXSOCK 5"
+.TH COLLECTD-UNIXSOCK 5 "2015-03-10" "5.4.1.805.g42e4d6c" "collectd"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"
+collectd\-unixsock \- Documentation of collectd's "unixsock plugin"
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+.Vb 9
+\& # See collectd.conf(5)
+\& LoadPlugin unixsock
+\& # ...
+\& <Plugin unixsock>
+\& SocketFile "/path/to/socket"
+\& SocketGroup "collectd"
+\& SocketPerms "0770"
+\& DeleteSocket false
+\& </Plugin>
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+The \f(CW\*(C`unixsock plugin\*(C'\fR opens an UNIX-socket over which one can interact with
+the daemon. This can be used to use the values collected by collectd in other
+applications, such as monitoring solutions, or submit externally collected
+values to collectd.
+.PP
+For example, this plugin is used by \fIcollectd\-nagios\fR\|(1) to check if some
+value is in a certain range and exit with a Nagios-compatible exit code.
+.SH "COMMANDS"
+.IX Header "COMMANDS"
+Upon start the \f(CW\*(C`unixsock plugin\*(C'\fR opens a UNIX-socket and waits for
+connections. Once a connection is established the client can send commands to
+the daemon which it will answer, if it understand them.
+.PP
+In general the plugin answers with a status line of the following form:
+.PP
+\&\fIStatus\fR \fIMessage\fR
+.PP
+If \fIStatus\fR is greater than or equal to zero the message indicates success,
+if \fIStatus\fR is less than zero the message indicates failure. \fIMessage\fR is a
+human-readable string that further describes the return value.
+.PP
+On success, \fIStatus\fR furthermore indicates the number of subsequent lines of
+output (not including the status line). Each such lines usually contains a
+single return value. See the description of each command for details.
+.PP
+The following commands are implemented:
+.IP "\fB\s-1GETVAL\s0\fR \fIIdentifier\fR" 4
+.IX Item "GETVAL Identifier"
+If the value identified by \fIIdentifier\fR (see below) is found the complete
+value-list is returned. The response is a list of name-value-pairs, each pair
+on its own line (the number of lines is indicated by the status line \- see
+above). Each name-value-pair is of the form \fIname\fR\fB=\fR\fIvalue\fR.
+Counter-values are converted to a rate, e.\ g. bytes per second.
+Undefined values are returned as \fBNaN\fR.
+.Sp
+Example:
+ \-> | \s-1GETVAL\s0 myhost/cpu\-0/cpu\-user
+ <\- | 1 Value found
+ <\- | value=1.260000e+00
+.IP "\fB\s-1LISTVAL\s0\fR" 4
+.IX Item "LISTVAL"
+Returns a list of the values available in the value cache together with the
+time of the last update, so that querying applications can issue a \fB\s-1GETVAL\s0\fR
+command for the values that have changed. Each return value consists of the
+update time as an epoch value and the identifier, separated by a space. The
+update time is the time of the last value, as provided by the collecting
+instance and may be very different from the time the server considers to be
+\&\*(L"now\*(R".
+.Sp
+Example:
+ \-> | \s-1LISTVAL
+ \s0 <\- | 69 Values found
+ <\- | 1182204284 myhost/cpu\-0/cpu\-idle
+ <\- | 1182204284 myhost/cpu\-0/cpu\-nice
+ <\- | 1182204284 myhost/cpu\-0/cpu\-system
+ <\- | 1182204284 myhost/cpu\-0/cpu\-user
+ ...
+.IP "\fB\s-1PUTVAL\s0\fR \fIIdentifier\fR [\fIOptionList\fR] \fIValuelist\fR" 4
+.IX Item "PUTVAL Identifier [OptionList] Valuelist"
+Submits one or more values (identified by \fIIdentifier\fR, see below) to the
+daemon which will dispatch it to all it's write-plugins.
+.Sp
+An \fIIdentifier\fR is of the form
+\&\f(CW\*(C`\f(CIhost\f(CW\f(CB/\f(CW\f(CIplugin\f(CW\f(CB\-\f(CW\f(CIinstance\f(CW\f(CB/\f(CW\f(CItype\f(CW\f(CB\-\f(CW\f(CIinstance\f(CW\*(C'\fR with both
+\&\fIinstance\fR\-parts being optional. If they're omitted the hyphen must be
+omitted, too. \fIplugin\fR and each \fIinstance\fR\-part may be chosen freely as long
+as the tuple (plugin, plugin instance, type instance) uniquely identifies the
+plugin within collectd. \fItype\fR identifies the type and number of values
+(i.\ e. data-set) passed to collectd. A large list of predefined
+data-sets is available in the \fBtypes.db\fR file.
+.Sp
+The \fIOptionList\fR is an optional list of \fIOptions\fR, where each option is a
+key-value-pair. A list of currently understood options can be found below, all
+other options will be ignored. Values that contain spaces must be quoted with
+double quotes.
+.Sp
+\&\fIValuelist\fR is a colon-separated list of the time and the values, each either
+an integer if the data-source is a counter, or a double if the data-source is
+of type \*(L"gauge\*(R". You can submit an undefined gauge-value by using \fBU\fR. When
+submitting \fBU\fR to a counter the behavior is undefined. The time is given as
+epoch (i.\ e. standard \s-1UNIX\s0 time).
+.Sp
+You can mix options and values, but the order is important: Options only
+effect following values, so specifying an option as last field is allowed, but
+useless. Also, an option applies to \fBall\fR following values, so you don't need
+to re-set an option over and over again.
+.Sp
+The currently defined \fBOptions\fR are:
+.RS 4
+.IP "\fBinterval=\fR\fIseconds\fR" 4
+.IX Item "interval=seconds"
+Gives the interval in which the data identified by \fIIdentifier\fR is being
+collected.
+.RE
+.RS 4
+.Sp
+Please note that this is the same format as used in the \fBexec plugin\fR, see
+\&\fIcollectd\-exec\fR\|(5).
+.Sp
+Example:
+ \-> | \s-1PUTVAL\s0 testhost/interface/if_octets\-test0 interval=10 1179574444:123:456
+ <\- | 0 Success
+.RE
+.IP "\fB\s-1PUTNOTIF\s0\fR [\fIOptionList\fR] \fBmessage=\fR\fIMessage\fR" 4
+.IX Item "PUTNOTIF [OptionList] message=Message"
+Submits a notification to the daemon which will then dispatch it to all plugins
+which have registered for receiving notifications.
+.Sp
+The \fB\s-1PUTNOTIF\s0\fR command is followed by a list of options which further describe
+the notification. The \fBmessage\fR option is special in that it will consume the
+rest of the line as its value. The \fBmessage\fR, \fBseverity\fR, and \fBtime\fR options
+are mandatory.
+.Sp
+Valid options are:
+.RS 4
+.IP "\fBmessage=\fR\fIMessage\fR (\fB\s-1REQUIRED\s0\fR)" 4
+.IX Item "message=Message (REQUIRED)"
+Sets the message of the notification. This is the message that will be made
+accessible to the user, so it should contain some useful information. As with
+all options: If the message includes spaces, it must be quoted with double
+quotes. This option is mandatory.
+.IP "\fBseverity=failure\fR|\fBwarning\fR|\fBokay\fR (\fB\s-1REQUIRED\s0\fR)" 4
+.IX Item "severity=failure|warning|okay (REQUIRED)"
+Sets the severity of the notification. This option is mandatory.
+.IP "\fBtime=\fR\fITime\fR (\fB\s-1REQUIRED\s0\fR)" 4
+.IX Item "time=Time (REQUIRED)"
+Sets the time of the notification. The time is given as \*(L"epoch\*(R", i.\ e. as
+seconds since January 1st, 1970, 00:00:00. This option is mandatory.
+.IP "\fBhost=\fR\fIHostname\fR" 4
+.IX Item "host=Hostname"
+.PD 0
+.IP "\fBplugin=\fR\fIPlugin\fR" 4
+.IX Item "plugin=Plugin"
+.IP "\fBplugin_instance=\fR\fIPlugin-Instance\fR" 4
+.IX Item "plugin_instance=Plugin-Instance"
+.IP "\fBtype=\fR\fIType\fR" 4
+.IX Item "type=Type"
+.IP "\fBtype_instance=\fR\fIType-Instance\fR" 4
+.IX Item "type_instance=Type-Instance"
+.PD
+These \*(L"associative\*(R" options establish a relation between this notification and
+collected performance data. This connection is purely informal, i.\ e. the
+daemon itself doesn't do anything with this information. However, websites or
+GUIs may use this information to place notifications near the affected graph or
+table. All the options are optional, but \fBplugin_instance\fR without \fBplugin\fR
+or \fBtype_instance\fR without \fBtype\fR doesn't make much sense and should be
+avoided.
+.IP "\fBtype:key=\fR\fIvalue\fR" 4
+.IX Item "type:key=value"
+Sets user defined meta information. The \fBtype\fR key is a single character
+defining the type of the meta information.
+.Sp
+The current supported types are:
+.RS 4
+.IP "\fBs\fR A string passed as-is." 8
+.IX Item "s A string passed as-is."
+.RE
+.RS 4
+.RE
+.RE
+.RS 4
+.Sp
+Please note that this is the same format as used in the \fBexec plugin\fR, see
+\&\fIcollectd\-exec\fR\|(5).
+.Sp
+Example:
+ \-> | \s-1PUTNOTIF\s0 type=temperature severity=warning time=1201094702 message=The roof is on fire!
+ <\- | 0 Success
+.RE
+.IP "\fB\s-1FLUSH\s0\fR [\fBtimeout=\fR\fITimeout\fR] [\fBplugin=\fR\fIPlugin\fR [...]] [\fBidentifier=\fR\fIIdent\fR [...]]" 4
+.IX Item "FLUSH [timeout=Timeout] [plugin=Plugin [...]] [identifier=Ident [...]]"
+Flushes all cached data older than \fITimeout\fR seconds. If no timeout has been
+specified, it defaults to \-1 which causes all data to be flushed.
+.Sp
+If the \fBplugin\fR option has been specified, only the \fIPlugin\fR plugin will be
+flushed. You can have multiple \fBplugin\fR options to flush multiple plugins in
+one go. If the \fBplugin\fR option is not given all plugins providing a flush
+callback will be flushed.
+.Sp
+If the \fBidentifier\fR option is given only the specified values will be flushed.
+This is meant to be used by graphing or displaying frontends which want to have
+the latest values for a specific graph. Again, you can specify the
+\&\fBidentifier\fR option multiple times to flush several values. If this option is
+not specified at all, all values will be flushed.
+.Sp
+Example:
+ \-> | \s-1FLUSH\s0 plugin=rrdtool identifier=localhost/df/df\-root identifier=localhost/df/df\-var
+ <\- | 0 Done: 2 successful, 0 errors
+.SS "Identifiers"
+.IX Subsection "Identifiers"
+Value or value-lists are identified in a uniform fashion:
+.PP
+\&\fIHostname\fR/\fIPlugin\fR/\fIType\fR
+.PP
+Where \fIPlugin\fR and \fIType\fR are both either of type "\fIName\fR\*(L" or
+\&\*(R"\fIName\fR\-\fIInstance\fR". If the identifier includes spaces, it must be quoted
+using double quotes. This sounds more complicated than it is, so here are
+some examples:
+.PP
+.Vb 5
+\& myhost/cpu\-0/cpu\-user
+\& myhost/load/load
+\& myhost/memory/memory\-used
+\& myhost/disk\-sda/disk_octets
+\& "myups/snmp/temperature\-Outlet 1"
+.Ve
+.SH "ABSTRACTION LAYER"
+.IX Header "ABSTRACTION LAYER"
+\&\fBcollectd\fR ships the Perl-Module Collectd::Unixsock which
+provides an abstraction layer over the actual socket connection. It can be
+found in the directory \fIbindings/perl/\fR in the source distribution or
+(usually) somewhere near \fI/usr/share/perl5/\fR if you're using a package. If
+you want to use Perl to communicate with the daemon, you're encouraged to use
+and expand this module.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fIcollectd\fR\|(1),
+\&\fIcollectd.conf\fR\|(5),
+\&\fIcollectd\-nagios\fR\|(1),
+\&\fIunix\fR\|(7)
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Florian Forster <octo@collectd.org>