]> sigrok.org Git - sigrok-cli.git/blobdiff - doc/sigrok-cli.1
Rename 'probe group' to 'channel group' everywhere.
[sigrok-cli.git] / doc / sigrok-cli.1
index ffbe06504b9374d4cfa50f8042e7a5aaa480f9e1..400152eab29840b94c2844df11cb5d81e6da563c 100644 (file)
@@ -1,4 +1,4 @@
-.TH SIGROK\-CLI 1 "Feb 05, 2013"
+.TH SIGROK\-CLI 1 "Jan 31, 2014"
 .SH "NAME"
 sigrok\-cli \- Command-line client for the sigrok software
 .SH "SYNOPSIS"
@@ -169,11 +169,11 @@ for probes 5 and 6 will be reset to the defaults by the
 .B "1\-8"
 probe selection.
 .TP
-.BR "\-g, \-\-probe\-group "<probe\ group>
-Specify the probe group to operate on.
+.BR "\-g, \-\-channel\-group "<channel\ group>
+Specify the channel group to operate on.
 
-Some devices organize probes into groups, the settings of which can
-only be changed as a group. The list of probe groups, if any, is displayed
+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 \-\-show command.
 .TP
 .BR "\-t, \-\-triggers " <triggerlist>
@@ -223,7 +223,9 @@ of options, where each option takes the form
 Example:
 .sp
  $
-.B "sigrok\-cli \-i <file.sr> \-P uart:baudrate=115200:parity_type=odd"
+.B "sigrok\-cli \-i <file.sr> "
+.br
+.B "              \-P uart:baudrate=115200:parity_type=odd"
 .sp
 The list of supported options depends entirely on the protocol decoder. Every
 protocol decoder has different options it supports.
@@ -296,21 +298,28 @@ display, by specifying its ID:
  $
 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid -A i2c"
 .sp
-If a protocol decoder has multiple annotation formats, you can also specify
-which of them to show by specifying its short description like this:
+If a protocol decoder has multiple annotations, you can also specify
+which one of them to show by specifying its short description like this:
+.sp
+ $
+.B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
+.br
+.B "              \-A i2c=data-read"
+.sp
+Select multiple annotations by separating them with a colon:
 .sp
  $
 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
 .br
-.B "              \-A i2c=rawhex"
+.B "              \-A i2c=data-read:data-write"
 .sp
 You can also select multiple protocol decoders, with an optional selected
-annotation format each, by separating them with commas:
+annotation each, by separating them with commas:
 .sp
  $
 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
 .br
-.B "              \-A i2c=rawhex,edid"
+.B "              \-A i2c=data-read:data-write,edid"
 .TP
 .BR "\-l, \-\-loglevel " <level>
 Set the libsigrok and libsigrokdecode loglevel. At the moment \fBsigrok-cli\fP