decode: nits, whitespace and line length fix

[sigrok-cli.git] / doc / sigrok-cli.1

diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1
index 734b0ff731580502139accf3ba453628668e9308..de0093f53459a968f350bff85e41a1134ef5ba6e 100644 (file)
--- a/doc/sigrok-cli.1
+++ b/doc/sigrok-cli.1
@@ -1,4 +1,4 @@
-.TH SIGROK\-CLI 1 "October 22, 2018"
+.TH SIGROK\-CLI 1 "March 28, 2019"

 .SH "NAME"
 sigrok\-cli \- Command-line client for the sigrok software
 .SH "SYNOPSIS"
 .SH "NAME"
 sigrok\-cli \- Command-line client for the sigrok software
 .SH "SYNOPSIS"


@@ -28,9 +28,14 @@ version and the versions of libraries used.
 Show information about supported hardware drivers, input file
 formats, output file formats, and protocol decoders.
 .TP
 Show information about supported hardware drivers, input file
 formats, output file formats, and protocol decoders.
 .TP

+.B "\-\-list\-supported\-wiki"
+Show information about supported protocol decoders in MediaWiki syntax.
+This is generally only used by developers to easily update the list of
+supported protocol decoders in the sigrok wiki.
+.TP

 \fB\-d, \-\-driver\fP <drivername>
 A driver must always be selected (unless doing a global scan). Use the
 \fB\-d, \-\-driver\fP <drivername>
 A driver must always be selected (unless doing a global scan). Use the

-.BR "\-L " ( "\-\-list-supported" ")"
+.BR "\-L " ( "\-\-list\-supported" ")"

 option to get a list of available drivers.
 .sp
 Drivers can take options, in the form \fBkey=value\fP
 option to get a list of available drivers.
 .sp
 Drivers can take options, in the form \fBkey=value\fP


@@ -147,9 +152,11 @@ like this:
  0:11111111 11111111 11111111 11111111 [...]
  1:11111111 00000000 11111111 00000000 [...]
 .sp
  0:11111111 11111111 11111111 11111111 [...]
  1:11111111 00000000 11111111 00000000 [...]
 .sp

-Example for saving data in the VCD format with options:
+Example for saving data in the CSV format with options:
+.sp
+.RB "  $ " "sigrok\-cli " "[...] " "\-o example.csv \-O csv:dedup:header=false"

 .sp
 .sp

-.RB "  $ " "sigrok\-cli " "[...] " "\-o example.vcd \-O vcd:downsample=4"
+Notice that boolean options are \fBtrue\fP when no value gets specified.

 .TP
 .BR "\-C, \-\-channels " <channellist>
 A comma-separated list of channels to be used in the session.
 .TP
 .BR "\-C, \-\-channels " <channellist>
 A comma-separated list of channels to be used in the session.


@@ -189,9 +196,11 @@ Specify the channel group to operate on. Some devices organize channels into
 groups, the settings of which can only be changed as a group. The list of
 channel groups, if any, is displayed with the \fB\-\-show\fP command.
 .sp
 groups, the settings of which can only be changed as a group. The list of
 channel groups, if any, is displayed with the \fB\-\-show\fP command.
 .sp

-Example:
+Examples:

 .sp
 .RB "  $ " "sigrok\-cli \-g CH1" " [...]"
 .sp
 .RB "  $ " "sigrok\-cli \-g CH1" " [...]"

+.sp
+.RB "  $ " "sigrok\-cli \-d demo \-g Logic \-c pattern=graycode" " [...]"

 .TP
 .BR "\-t, \-\-triggers " <triggerlist>
 A comma-separated list of triggers to use, of the form
 .TP
 .BR "\-t, \-\-triggers " <triggerlist>
 A comma-separated list of triggers to use, of the form


@@ -296,14 +305,14 @@ Example:
 .sp
 .TP
 .BR "\-A, \-\-protocol\-decoder\-annotations " <annotations>
 .sp
 .TP
 .BR "\-A, \-\-protocol\-decoder\-annotations " <annotations>

-By default, only the stack's topmost protocol decoder's annotation output is
-shown. With this option another decoder's annotation can be selected for
-display, by specifying its ID:
+By default, all annotation output of all protocol decoders is
+shown. With this option a specific decoder's annotations can be selected for
+display, by specifying the decoder ID:

 .sp
  $
 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid \-A i2c"
 .sp
 .sp
  $
 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid \-A i2c"
 .sp

-If a protocol decoder has multiple annotations, you can also specify
+If a protocol decoder has multiple annotation classes, you can also specify

 which one of them to show by specifying its short description like this:
 .sp
  $
 which one of them to show by specifying its short description like this:
 .sp
  $


@@ -311,7 +320,7 @@ which one of them to show by specifying its short description like this:
 .br
 .B "              \-A i2c=data\-read"
 .sp
 .br
 .B "              \-A i2c=data\-read"
 .sp

-Select multiple annotations by separating them with a colon:
+Select multiple annotation classes by separating them with a colon:

 .sp
  $
 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
 .sp
  $
 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"


@@ -319,7 +328,7 @@ Select multiple annotations by separating them with a colon:
 .B "              \-A i2c=data\-read:data\-write"
 .sp
 You can also select multiple protocol decoders, with an optional selected
 .B "              \-A i2c=data\-read:data\-write"
 .sp
 You can also select multiple protocol decoders, with an optional selected

-annotation each, by separating them with commas:
+annotation class each, by separating them with commas:

 .sp
  $
 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
 .sp
  $
 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"