X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=doc%2Fsigrok-cli.1;h=ce93cd214adeeefa071cb2c77d2fe9424967b637;hb=f2e8273289ec855bb35a5a78ed49d1f1c761be94;hp=8437d91f3b76ef0ea84fb25ddb5fa93c994052a3;hpb=b86569215cf5213e0d2421d1cf014be1c4fe1309;p=sigrok-cli.git diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1 index 8437d91..ce93cd2 100644 --- a/doc/sigrok-cli.1 +++ b/doc/sigrok-cli.1 @@ -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,6 +169,13 @@ for probes 5 and 6 will be reset to the defaults by the .B "1\-8" probe selection. .TP +.BR "\-g, \-\-probe\-group " +Specify the probe 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 +with the \-\-show command. +.TP .BR "\-t, \-\-triggers " A comma-separated list of triggers to use, of the form .BR "=" . @@ -216,7 +223,9 @@ of options, where each option takes the form Example: .sp $ -.B "sigrok\-cli \-i \-P uart:baudrate=115200:parity=odd" +.B "sigrok\-cli \-i " +.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. @@ -289,21 +298,28 @@ display, by specifying its ID: $ .B "sigrok\-cli \-i \-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 \-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 \-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 \-P i2c,i2cfilter,edid" .br -.B " \-A i2c=rawhex,edid" +.B " \-A i2c=data-read:data-write,edid" .TP .BR "\-l, \-\-loglevel " Set the libsigrok and libsigrokdecode loglevel. At the moment \fBsigrok-cli\fP