X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fcollectd-unixsock.pod;h=db7000a1d791c742e47c195369653fc86c60b2e4;hb=39049b56158161b4f9eeacdad8918bcf0f1f7e90;hp=83802a14f7a0ba2576c94f0b223b1ddc07b54f67;hpb=c57f2a191b63ce73fc432befebe9fa3af97c8eb5;p=collectd.git diff --git a/src/collectd-unixsock.pod b/src/collectd-unixsock.pod index 83802a14..db7000a1 100644 --- a/src/collectd-unixsock.pod +++ b/src/collectd-unixsock.pod @@ -1,3 +1,5 @@ +=encoding UTF-8 + =head1 NAME collectd-unixsock - Documentation of collectd's C @@ -11,6 +13,7 @@ collectd-unixsock - Documentation of collectd's C SocketFile "/path/to/socket" SocketGroup "collectd" SocketPerms "0770" + DeleteSocket false =head1 DESCRIPTION @@ -81,7 +84,7 @@ Example: =item B I [I] I Submits one or more values (identified by I, see below) to the -daemon which will dispatch it to all it's write-plugins. +daemon which will dispatch it to all its write-plugins. An I is of the form CBIB<->IBIB<->I> with both @@ -174,11 +177,24 @@ table. All the options are optional, but B without B or B without B doesn't make much sense and should be avoided. -Please note that this is the same format as used in the B, see -L. +=item BI + +Sets user defined meta information. The B key is a single character +defining the type of the meta information. + +The current supported types are: + +=over 8 + +=item B A string passed as-is. + +=back =back +Please note that this is the same format as used in the B, see +L. + Example: -> | PUTNOTIF type=temperature severity=warning time=1201094702 message=The roof is on fire! <- | 0 Success @@ -240,6 +256,6 @@ L =head1 AUTHOR -Florian Forster Eocto@verplant.orgE +Florian Forster Eocto@collectd.orgE =cut