Allow setting samplerate when reading binary files

[sigrok-cli.git] / doc / sigrok-cli.1

diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1
index 9930d511f44a5abc09c9b98ce393b055f7e8fab9..d86e53b7167c15b9cc6181690f600b0a039165bd 100644 (file)
--- a/doc/sigrok-cli.1
+++ b/doc/sigrok-cli.1
@@ -1,8 +1,8 @@
-.TH SIGROK\-CLI 1 "March 18, 2012"
+.TH SIGROK\-CLI 1 "May 29, 2012"

 .SH "NAME"
 sigrok\-cli \- Command-line client for the sigrok logic analyzer software
 .SH "SYNOPSIS"
 .SH "NAME"
 sigrok\-cli \- Command-line client for the sigrok logic analyzer software
 .SH "SYNOPSIS"

-.B sigrok\-cli \fR[\fB\-hVlDdiIoOptwas\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fB\-l\fR|\fB\-\-loglevel\fR level] [\fB\-D\fR|\fB\-\-list\-devices\fR] [\fB\-d\fR|\fB\-\-device\fR device] [\fB\-i\fR|\fB\-\-input\-file\fR filename] [\fB\-I\fR|\fB\-\-input\-format\fR format] [\fB\-o\fR|\fB\-\-output\-file\fR filename] [\fB\-O\fR|\fB\-\-output-format\fR format] [\fB\-p\fR|\fB\-\-probes\fR probelist] [\fB\-t\fR|\fB\-\-triggers\fR triggerlist] [\fB\-w\fR|\fB\-\-wait\-trigger\fR] [\fB\-a\fR|\fB\-\-protocol\-decoders\fR list] [\fB\-s\fR|\fB\-\-protocol\-decoder\-stack\fR stack] [\fB\-\-time\fR ms] [\fB\-\-samples\fR numsamples] [\fB\-\-continuous\fR]
+.B sigrok\-cli \fR[\fB\-hVlDdiIoOptwasA\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fB\-l\fR|\fB\-\-loglevel\fR level] [\fB\-D\fR|\fB\-\-list\-devices\fR] [\fB\-d\fR|\fB\-\-device\fR device] [\fB\-i\fR|\fB\-\-input\-file\fR filename] [\fB\-I\fR|\fB\-\-input\-format\fR format] [\fB\-o\fR|\fB\-\-output\-file\fR filename] [\fB\-O\fR|\fB\-\-output-format\fR format] [\fB\-p\fR|\fB\-\-probes\fR probelist] [\fB\-t\fR|\fB\-\-triggers\fR triggerlist] [\fB\-w\fR|\fB\-\-wait\-trigger\fR] [\fB\-a\fR|\fB\-\-protocol\-decoders\fR decoderlist] [\fB\-s\fR|\fB\-\-protocol\-decoder\-stack\fR stack] [\fB\-A\fR|\fB\-\-protocol\-decoder\-annotations\fR annlist] [\fB\-\-time\fR ms] [\fB\-\-samples\fR numsamples] [\fB\-\-continuous\fR]

 .SH "DESCRIPTION"
 .B sigrok\-cli
 is a cross-platform command line utility for the
 .SH "DESCRIPTION"
 .B sigrok\-cli
 is a cross-platform command line utility for the


@@ -76,7 +76,12 @@ the input file.
 When loading an input file, assume it's in the specified format. If this
 option is not supplied (in addition to
 .BR \-\-input\-file ),
 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.
+sigrok-cli attempts to autodetect the file format of the input file. Use the
+.B \-V
+option to see a list of available input formats. The format name may
+optionally be followed by a colon-separated list of options, where each
+option takes the form
+.BR "key=value" .

 .TP
 .BR "\-o, \-\-output\-file " <filename>
 Save output to a file instead of writing it to stdout. The default format
 .TP
 .BR "\-o, \-\-output\-file " <filename>
 Save output to a file instead of writing it to stdout. The default format


@@ -233,7 +238,8 @@ as SCK, and probe 0 as CS# signal.
 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
 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 --protocol-decoders
+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
 option.
 .sp
 The decoders are specified by their ID, as shown in the


@@ -248,7 +254,7 @@ parameter.
 Example:
 .sp
  $
 Example:
 .sp
  $

-.B "sigrok\-cli \-i <file.sr> \-a i2c:sda=4,scl=7,rtc8564"
+.B "sigrok\-cli \-i <file.sr> \-a i2c:sda=4:scl=7,rtc8564"

 .br
 .B "              \-s i2c,rtc8564"
 .sp
 .br
 .B "              \-s i2c,rtc8564"
 .sp


@@ -270,15 +276,13 @@ option (you cannot specify them in the
 .B \-s
 option).
 .TP
 .B \-s
 option).
 .TP

-.BR "\-\-protocol\-decoder\-annotation " <annotations>
+.BR "\-A, \-\-protocol\-decoder\-annotations " <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
 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

-display, by specifying its id:
+display, by specifying its ID:

 .sp
  $
 .sp
  $

-.B "sigrok\-cli \-i <file.sr> \-a i2c,i2cfilter,edid"
-.br
-.B "              \-\-protocol\-decoder\-annotation i2c"
+.B "sigrok\-cli \-i <file.sr> \-a 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:
 .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:


@@ -286,7 +290,7 @@ which of them to show by specifying its short description like this:
  $
 .B "sigrok\-cli \-i <file.sr> \-a i2c,i2cfilter,edid"
 .br
  $
 .B "sigrok\-cli \-i <file.sr> \-a i2c,i2cfilter,edid"
 .br

-.B "              \-\-protocol\-decoder\-annotation i2c=rawhex"
+.B "              \-A i2c=rawhex"

 .sp
 You can also select multiple protocol decoders, with an optional selected
 annotation format each, by separating them with commas:
 .sp
 You can also select multiple protocol decoders, with an optional selected
 annotation format each, by separating them with commas:


@@ -294,7 +298,7 @@ annotation format each, by separating them with commas:
  $
 .B "sigrok\-cli \-i <file.sr> \-a i2c,i2cfilter,edid"
 .br
  $
 .B "sigrok\-cli \-i <file.sr> \-a i2c,i2cfilter,edid"
 .br

-.B "              \-\-protocol\-decoder\-annotation i2c=rawhex,edid"
+.B "              \-A i2c=rawhex,edid"

 .TP
 .BR "\-\-time " <ms>
 Sample for
 .TP
 .BR "\-\-time " <ms>
 Sample for