doc: minor update to -O and -g options in the manpage
authorGerhard Sittig <gerhard.sittig@gmx.net>
Tue, 23 Oct 2018 17:13:24 +0000 (19:13 +0200)
committerGerhard Sittig <gerhard.sittig@gmx.net>
Tue, 23 Oct 2018 17:13:24 +0000 (19:13 +0200)
Demonstrate output format options by means of "-O csv:..." which as a
byproduct also demonstrates booleans. Add an example how to combine -g
and -c, configuring an option of a channel group.

doc/sigrok-cli.1

index 734b0ff731580502139accf3ba453628668e9308..c87d383e8be74b5fb74b5886eed5dcf11662c6f6 100644 (file)
@@ -147,9 +147,11 @@ like this:
  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.vcd \-O vcd:downsample=4"
+.RB "  $ " "sigrok\-cli " "[...] " "\-o example.csv \-O csv:dedup:header=false"
+.sp
+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.
@@ -189,9 +191,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
-Example:
+Examples:
 .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