projects
/
collectd.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Docs: use "its" vice "it's" where appropriate
[collectd.git]
/
src
/
collectd-unixsock.pod
diff --git
a/src/collectd-unixsock.pod
b/src/collectd-unixsock.pod
index
ca00a6d
..
db7000a
100644
(file)
--- 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<unixsock plugin>
=head1 NAME
collectd-unixsock - Documentation of collectd's C<unixsock plugin>
@@
-11,17
+13,18
@@
collectd-unixsock - Documentation of collectd's C<unixsock plugin>
SocketFile "/path/to/socket"
SocketGroup "collectd"
SocketPerms "0770"
SocketFile "/path/to/socket"
SocketGroup "collectd"
SocketPerms "0770"
+ DeleteSocket false
</Plugin>
=head1 DESCRIPTION
The C<unixsock plugin> 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
</Plugin>
=head1 DESCRIPTION
The C<unixsock plugin> 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
, or submit externally collected values to
-collectd.
+applications, such as monitoring
solutions, or submit externally collected
+
values to
collectd.
-This plugin is used by L<collectd-nagios(1)> to check if some value is in a
-certain range and exit with a Nagios-compatible exit code.
+For example, this plugin is used by L<collectd-nagios(1)> to check if some
+
value is in a
certain range and exit with a Nagios-compatible exit code.
=head1 COMMANDS
=head1 COMMANDS
@@
-81,7
+84,7
@@
Example:
=item B<PUTVAL> I<Identifier> [I<OptionList>] I<Valuelist>
Submits one or more values (identified by I<Identifier>, see below) to the
=item B<PUTVAL> I<Identifier> [I<OptionList>] I<Valuelist>
Submits one or more values (identified by I<Identifier>, 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<Identifier> is of the form
C<I<host>B</>I<plugin>B<->I<instance>B</>I<type>B<->I<instance>> with both
An I<Identifier> is of the form
C<I<host>B</>I<plugin>B<->I<instance>B</>I<type>B<->I<instance>> with both
@@
-131,10
+134,10
@@
Example:
Submits a notification to the daemon which will then dispatch it to all plugins
which have registered for receiving notifications.
Submits a notification to the daemon which will then dispatch it to all plugins
which have registered for receiving notifications.
-The B<PUTNOTIF>
if followed by a list of options which further describe th
e
-notification. The B<message> option is special in that it will consume the rest
-of the line as its value. The B<message>, B<severity>, and B<time> options are
-mandatory.
+The B<PUTNOTIF>
command is followed by a list of options which further describ
e
+the notification. The B<message> option is special in that it will consume the
+rest of the line as its value. The B<message>, B<severity>, and B<time> options
+
are
mandatory.
Valid options are:
Valid options are:
@@
-174,11
+177,24
@@
table. All the options are optional, but B<plugin_instance> without B<plugin>
or B<type_instance> without B<type> doesn't make much sense and should be
avoided.
or B<type_instance> without B<type> doesn't make much sense and should be
avoided.
-Please note that this is the same format as used in the B<exec plugin>, see
-L<collectd-exec(5)>.
+=item B<type:key=>I<value>
+
+Sets user defined meta information. The B<type> key is a single character
+defining the type of the meta information.
+
+The current supported types are:
+
+=over 8
+
+=item B<s> A string passed as-is.
+
+=back
=back
=back
+Please note that this is the same format as used in the B<exec plugin>, see
+L<collectd-exec(5)>.
+
Example:
-> | PUTNOTIF type=temperature severity=warning time=1201094702 message=The roof is on fire!
<- | 0 Success
Example:
-> | PUTNOTIF type=temperature severity=warning time=1201094702 message=The roof is on fire!
<- | 0 Success
@@
-195,7
+211,7
@@
callback will be flushed.
If the B<identifier> 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
If the B<identifier> 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 la
s
test values for a specific graph. Again, you can specify the
+the latest values for a specific graph. Again, you can specify the
B<identifier> option multiple times to flush several values. If this option is
not specified at all, all values will be flushed.
B<identifier> option multiple times to flush several values. If this option is
not specified at all, all values will be flushed.
@@
-240,6
+256,6
@@
L<unix(7)>
=head1 AUTHOR
=head1 AUTHOR
-Florian Forster E<lt>octo@
verplant
.orgE<gt>
+Florian Forster E<lt>octo@
collectd
.orgE<gt>
=cut
=cut