X-Git-Url: https://sigrok.org/gitweb/?p=sigrok-cli.git;a=blobdiff_plain;f=doc%2Fsigrok-cli.1;h=cbd9f878b40f23d1e40521b6986889b85b18e004;hp=e7e5a95da8fba41356c8eba268e64d8f046d903e;hb=c1865eb5e7d89708754580f693c9cbf7c4ef035d;hpb=b0f1c54057614508b8702ea2565ec4758019030d diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1 index e7e5a95..cbd9f87 100644 --- a/doc/sigrok-cli.1 +++ b/doc/sigrok-cli.1 @@ -1,4 +1,4 @@ -.TH SIGROK\-CLI 1 "May 04, 2014" +.TH SIGROK\-CLI 1 "September 13, 2017" .SH "NAME" sigrok\-cli \- Command-line client for the sigrok software .SH "SYNOPSIS" @@ -22,12 +22,16 @@ 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 A driver must always be selected (unless doing a global scan). Use the -\fB-V\fP option to get a list of available drivers. +.BR "\-L " ( "\-\-list-supported" ")" +option to get a list of available drivers. .sp Drivers can take options, in the form \fBkey=value\fP separated by colons. @@ -73,7 +77,7 @@ When loading an input file, assume it's in the specified format. If this option is not supplied (in addition to .BR \-\-input\-file ), sigrok-cli attempts to autodetect the file format of the input file. Use the -.B \-V +.BR "\-L " ( "\-\-list-supported" ")" option to see a list of available input formats. .sp The format name may optionally be followed by a colon-separated list of @@ -89,26 +93,14 @@ option. .TP .BR "\-O, \-\-output\-format " Set the output format to use. Use the -.B \-V +.BR "\-L " ( "\-\-list-supported" ")" option to see a list of available output formats. .sp The format name may optionally be followed by a colon-separated list of options, where each option takes the form .BR "key=value" . .sp -Supported formats currently include -.BR bits , -.BR hex , -.BR ascii , -.BR binary , -.BR vcd , -.BR ols , -.BR gnuplot , -.BR chronovu-la8 , -.BR csv ", and" -.BR analog . -.sp -The +For example, the .B bits or .B hex @@ -181,7 +173,7 @@ A rising or falling value on the pin. An effectively corresponds to .BR 01 . .br -.BR "c" : +.BR "e" : Any kind of change on a pin (either a rising or a falling edge). .sp Not every device supports all of these trigger types. Use the \fB\-\-show\fP @@ -198,7 +190,7 @@ nonetheless). This option allows the user to specify a comma-separated list of protocol decoders to be used in this session. The decoders are specified by their ID, as shown in the -.B \-\-version +.BR "\-L " ( "\-\-list-supported" ")" output. .sp Example: @@ -238,48 +230,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 @@ -348,6 +298,10 @@ binary class you're interested in) .sp Not every decoder generates binary output. .TP +.BR "\-\-protocol\-decoder\-samplenum +When given, decoder annotations will include sample numbers, too. +This allows consumers to receive machine readable timing information. +.TP .BR "\-l, \-\-loglevel " Set the libsigrok and libsigrokdecode loglevel. At the moment \fBsigrok-cli\fP doesn't support setting the two loglevels independently. The higher the @@ -379,10 +333,14 @@ need a serial port specified: $ .B "sigrok\-cli \-\-driver ols:conn=/dev/ttyACM0 \-\-show .sp -To view the documentation for a protocol decoder: +This also works for protocol decoders, input modules and output modules: .sp $ -.B "sigrok\-cli \-\-protocol-decoders i2c \-\-show +.B "sigrok\-cli \-\-protocol\-decoders i2c \-\-show + $ +.B "sigrok\-cli \-\-input\-format csv \-\-show + $ +.B "sigrok\-cli \-\-output\-format bits \-\-show .TP .B "\-\-scan" Scan for devices that can be detected automatically. @@ -441,6 +399,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.