From: Florian Forster Date: Wed, 7 Aug 2013 06:14:16 +0000 (+0200) Subject: collectd.conf(5): sigrok plugin: Improve markup. X-Git-Tag: collectd-5.4.0~14^2~2 X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=2e94cad846a5227e7c2d4148a3020cc8dbcf8ab5;p=collectd.git collectd.conf(5): sigrok plugin: Improve markup. --- diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod index a673a584..7b9a5598 100644 --- a/src/collectd.conf.pod +++ b/src/collectd.conf.pod @@ -5148,9 +5148,9 @@ and all other sensors are collected. =back -=head2 Plugin "sigrok" +=head2 Plugin C -The I plugin uses libsigrok to retrieve measurements from any device +The I uses I to retrieve measurements from any device supported by the L project. B @@ -5159,12 +5159,12 @@ B LogLevel 3 Driver "fluke-dmm" - MinimumInterval 10 - Conn "/dev/ttyUSB2" + MinimumInterval 10 + Conn "/dev/ttyUSB2" Driver "cem-dt-885x" - Conn "/dev/ttyUSB1" + Conn "/dev/ttyUSB1" @@ -5172,46 +5172,47 @@ B =item B B<0-5> -The sigrok logging level to pass on to the collectd log, as a number 0-5. -These levels correspond to None, Errors, Warnings, Informational, Debug -and Spew, respectively. The default is 2 (Warnings). The sigrok log messages, -regardless of their level, are always submitted to collectd at its INFO -log level. +The I logging level to pass on to the I log, as a number +between B<0> and B<5> (inclusive). These levels correspond to C, +C, C, C, Cand C, respectively. +The default is B<2> (C). The I log messages, regardless of +their level, are always submitted to I at its INFO log level. -=item EB IE +=item EB IE A sigrok-supported device, uniquely identified by this section's options. The -I is passed to collectd as the I. +I is passed to I as the I. -=item B +=item B I The sigrok driver to use for this device. -=item B +=item B I If the device cannot be auto-discovered, or more than one might be discovered -by the driver, I specifies the connection string to the device. It can -be of the form of a serial port (I), or, in case of a non-serial -USB-connected device, the USB VendorID/ProductID separated by a period -(I<0403.6001>). A USB device can also be specified as bus.address -(I<1.41>). +by the driver, I specifies the connection string to the device. +It can be of the form of a device path (e.g.EC), or, in +case of a non-serial USB-connected device, the USB IB<.>I +separated by a period (e.g.EC<0403.6001>). A USB device can also be +specified as IB<.>I
(e.g.EC<1.41>). -=item B +=item B I For serial devices with non-standard port settings, this option can be used -to specify them in the form I<9600/8n1>. This should not be necessary; drivers -know how to communicate with devices they support. +to specify them in a form understood by I, e.g.EC<9600/8n1>. +This should not be necessary; drivers know how to communicate with devices they +support. -=item B +=item B I -Specifies the minimum time between measurement dispatches to collectd, in -seconds. Since some sigrok-supported devices can acquire measurements many +Specifies the minimum time between measurement dispatches to I, in +seconds. Since some I supported devices can acquire measurements many times per second, it may be necessary to throttle these. For example, the -RRD plugin cannot process writes more than once per second. +I cannot process writes more than once per second. -The default MinimumInterval is 0, meaning measurements received from the -device are always dispatched to collectd. When throttled, unused measurements -are discarded. +The default B is B<0>, meaning measurements received from the +device are always dispatched to I. When throttled, unused +measurements are discarded. =back