collectd.conf(5): sigrok plugin: Improve markup.

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index a673a584982842b0985e36ad9f845b5167e92cca..7b9a5598b77c65fae169edc835295c0d2801b15a 100644 (file)
--- 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<sigrok>
 
-The I<sigrok> plugin uses libsigrok to retrieve measurements from any device
+The I<sigrok plugin> uses I<libsigrok> to retrieve measurements from any device
 supported by the L<sigrok|http://sigrok.org/> project.
 
 B<Synopsis>
@@ -5159,12 +5159,12 @@ B<Synopsis>
    LogLevel 3
    <Device "AC Voltage">
       Driver "fluke-dmm"
-         MinimumInterval 10
-         Conn "/dev/ttyUSB2"
+      MinimumInterval 10
+      Conn "/dev/ttyUSB2"
    </Device>
    <Device "Sound Level">
       Driver "cem-dt-885x"
-         Conn "/dev/ttyUSB1"
+      Conn "/dev/ttyUSB1"
    </Device>
  </Plugin>
 
@@ -5172,46 +5172,47 @@ B<Synopsis>
 
 =item B<LogLevel> 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<sigrok> logging level to pass on to the I<collectd> log, as a number
+between B<0> and B<5> (inclusive). These levels correspond to C<None>,
+C<Errors>, C<Warnings>, C<Informational>, C<Debug >and C<Spew>, respectively.
+The default is B<2> (C<Warnings>). The I<sigrok> log messages, regardless of
+their level, are always submitted to I<collectd> at its INFO log level.
 
-=item E<lt>B<Device> I<name>E<gt>
+=item E<lt>B<Device> I<Name>E<gt>
 
 A sigrok-supported device, uniquely identified by this section's options. The
-I<name> is passed to collectd as the I<plugin instance>.
+I<Name> is passed to I<collectd> as the I<plugin instance>.
 
-=item B<Driver>
+=item B<Driver> I<DriverName>
 
 The sigrok driver to use for this device.
 
-=item B<Conn>
+=item B<Conn> I<ConnectionSpec>
 
 If the device cannot be auto-discovered, or more than one might be discovered
-by the driver, I<Conn> specifies the connection string to the device. It can
-be of the form of a serial port (I</dev/ttyUSB2>), 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<ConnectionSpec> specifies the connection string to the device.
+It can be of the form of a device path (e.g.E<nbsp>C</dev/ttyUSB2>), or, in
+case of a non-serial USB-connected device, the USB I<VendorID>B<.>I<ProductID>
+separated by a period (e.g.E<nbsp>C<0403.6001>). A USB device can also be
+specified as I<Bus>B<.>I<Address> (e.g.E<nbsp>C<1.41>).
 
-=item B<SerialComm>
+=item B<SerialComm> I<SerialSpec>
 
 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<sigrok>, e.g.E<nbsp>C<9600/8n1>.
+This should not be necessary; drivers know how to communicate with devices they
+support.
 
-=item B<MinimumInterval>
+=item B<MinimumInterval> I<Seconds>
 
-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<collectd>, in
+seconds. Since some I<sigrok> 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<RRD plugin> 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<MinimumInterval> is B<0>, meaning measurements received from the
+device are always dispatched to I<collectd>. When throttled, unused
+measurements are discarded.
 
 =back