X-Git-Url: https://sigrok.org/gitweb/?p=sigrok-cli.git;a=blobdiff_plain;f=doc%2Fsigrok-cli.1;h=bda6cf3a05ff948d1efa74d4827edbb94ffb2cc2;hp=b8940cbdec1605e14b5bd8453b61b007f15f68cf;hb=77525a84a5ffc19ca0ff2989dc787d0c257248da;hpb=6c5438fe2bd772f71549a7a93889b4b3ea1acd06 diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1 index b8940cb..bda6cf3 100644 --- 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" @@ -28,9 +28,17 @@ version and the versions of libraries used. 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 -A driver must always be selected (unless doing a global scan). Use the -.BR "\-L " ( "\-\-list-supported" ")" +Unless doing a global scan, users typically select one of the available +drivers. This can speedup program start, and can avoid false matches for +ambiguous configurations. Selecting a driver also allows to pass more +driver specific options. Use the +.BR "\-L " ( "\-\-list\-supported" ")" option to get a list of available drivers. .sp Drivers can take options, in the form \fBkey=value\fP @@ -54,6 +62,11 @@ USB \fBbus.address\fP example: .sp .RB " $ " "sigrok\-cli \-\-driver=uni\-t\-ut61e:conn=4.6" " [...]" .TP +.B "\-D, \-\-dont\-scan" +Do not automatically scan for device drivers in the absence of a +.BR "\-d " ( "\-\-driver" ) +specification. +.TP .BR "\-c, \-\-config " A colon-separated list of device options, where each option takes the form .BR key=value . @@ -322,8 +335,17 @@ Select multiple annotation classes by separating them with a colon: .br .B " \-A i2c=data\-read:data\-write" .sp -You can also select multiple protocol decoders, with an optional selected -annotation class each, by separating them with commas: +Annotation row names will resolve to their respective list of classes. +Row and class names can be used in combination. When names are ambiguous +then class names take precedence. +.sp + $ +.B "sigrok\-cli \-i \-P i2c" +.br +.B " \-A i2c=addr\-data:warnings" +.sp +You can also select multiple protocol decoders, with optionally selected +annotation classes each, by separating them with commas: .sp $ .B "sigrok\-cli \-i \-P i2c,i2cfilter,edid"