X-Git-Url: https://sigrok.org/gitweb/?p=sigrok-cli.git;a=blobdiff_plain;f=doc%2Fsigrok-cli.1;h=cbd9f878b40f23d1e40521b6986889b85b18e004;hp=1666f895b6eff284d6df8a322f9d4c01f9677b5f;hb=c1865eb5e7d89708754580f693c9cbf7c4ef035d;hpb=6293db8aea090170eced25d6f92c348b013ea475 diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1 index 1666f89..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" @@ -30,7 +30,8 @@ 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. @@ -76,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 @@ -92,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 @@ -201,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: @@ -309,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