X-Git-Url: https://sigrok.org/gitweb/?p=sigrok-cli.git;a=blobdiff_plain;f=doc%2Fsigrok-cli.1;h=1666f895b6eff284d6df8a322f9d4c01f9677b5f;hp=32f7030031988a48c8d6e94547afd8589ff48f73;hb=198182cc092b56a005e8990057bffb99794ec797;hpb=f99038b44505c05197da6954d8fcfbbd728c7216 diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1 index 32f7030..1666f89 100644 --- a/doc/sigrok-cli.1 +++ b/doc/sigrok-cli.1 @@ -22,7 +22,10 @@ Show a help text and exit. .B "\-V, \-\-version" Show .B sigrok-cli -version, and information about supported hardware drivers, input file +version and the versions of libraries used. +.TP +.B "\-L, \-\-list-supported" +Show information about supported hardware drivers, input file formats, output file formats, and protocol decoders. .TP \fB\-d, \-\-driver\fP @@ -238,48 +241,6 @@ protocol decoder. Additionally, the user tells sigrok to decode the SPI protocol using channel 1 as MISO signal for SPI, channel 5 as MOSI, channel 3 as CLK, and channel 0 as CS# signal. .TP -.BR "\-S, \-\-protocol\-decoder\-stack " -This option allows the user to specify a protocol decoder stack, i.e. -the way in which one protocol decoder's output gets piped into another -protocol decoder. If not specified, the stack will be set up in the same -order in which the protocol decoders were given with the -.B \-\-protocol-decoders -option. -.sp -The decoders are specified by their ID, as shown in the -.B \-\-version -output. In addition to the -.B \-S -option, all protocol decoders that are used in a stack, must also be specified -(together with their options, if any) using the -.B \-P -parameter. -.sp -Example: -.sp - $ -.B "sigrok\-cli \-i \-P i2c:sda=4:scl=7,rtc8564" -.br -.B " \-S i2c,rtc8564" -.sp -In this example, the -.B \-S -option specifies that the output of the -.BR i2c " decoder" -is piped into the -.BR rtc8564 " decoder," -i.e., the -.BR rtc8564 " decoder" -is stacked on top of the -.BR i2c " decoder." -.sp -The respective protocol decoder options and channel name/number assignments -must be given using the -.B \-P -option (you cannot specify them in the -.B \-S -option). -.TP .BR "\-A, \-\-protocol\-decoder\-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 @@ -379,11 +340,13 @@ need a serial port specified: $ .B "sigrok\-cli \-\-driver ols:conn=/dev/ttyACM0 \-\-show .sp -This also works for protocol decoders and output modules: +This also works for protocol decoders, input modules and output modules: .sp $ .B "sigrok\-cli \-\-protocol\-decoders i2c \-\-show $ +.B "sigrok\-cli \-\-input\-format csv \-\-show + $ .B "sigrok\-cli \-\-output\-format bits \-\-show .TP .B "\-\-scan" @@ -443,6 +406,11 @@ frames, then quit. .BR "\-\-continuous" Sample continuously until stopped. Not all devices support this. .TP +.BR "\-\-get " +Get the value of +.B +from the specified device and print it. +.TP .BR "\-\-set" Set one or more variables specified with the \fB\-\-config\fP option, without doing any acquisition.