X-Git-Url: https://sigrok.org/gitweb/?p=sigrok-cli.git;a=blobdiff_plain;f=doc%2Fsigrok-cli.1;h=e5f84f1fd6a016f2f1d9d6dd11d11212db8094cc;hp=a8b1f83f96363d74931da025fc8d0e02c02862a5;hb=1a0be0e3eb0145c4eca5854132ce144b3197273d;hpb=85f2ddbb7b5bddc1326af1e9ed76b327ee3d10fe diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1 index a8b1f83..e5f84f1 100644 --- 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" -.B sigrok\-cli \fR[\fB\-hVlDiIoOdptwas\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\-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\-d\fR|\fB\-\-device\fR device] [\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\-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 decoderlist] [\fB\-s\fR|\fB\-\-protocol\-decoder\-stack\fR stack] [\fB\-\-protocol\-decoder\-annotation\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 @@ -43,6 +43,29 @@ number, the more debug output will be printed. Valid loglevels are List all logic analyzer devices found on the system. This actively scans for devices (USB, serial port, and others). .TP +.BR "\-d, \-\-device " +The device to use for acquisition. It can be specified by ID as reported by +.BR "\-\-list\-devices" , +or by the name of the driver as reported by +.BR \-\-version . +.sp +A device can optionally be followed by a colon-separated list of device +options, where each option takes the form +.BR key=value . +For example, to set the samplerate on the first device you might specify +.sp +.RB " $ " "sigrok\-cli \-d 0:samplerate=1m" +.sp +Samplerate is an option common to most devices. The argument specifies the +samplerate in Hz. You can also specify the samplerate in kHz, MHz or GHz. +The following are all equivalent: +.sp +.RB " $ " "sigrok\-cli \-\-samples 100 \-d 0:samplerate=1000000" +.sp +.RB " $ " "sigrok\-cli \-\-samples 100 \-d 0:samplerate=1m" +.sp +.RB " $ " "sigrok\-cli \-\-samples 100 \-d ""0:samplerate=1 MHz"" +.TP .BR "\-i, \-\-input\-file " Load input from a file instead of a hardware device. If the .B \-\-input\-format @@ -99,29 +122,6 @@ like this: 1:11111111 11111111 11111111 11111111 [...] 2:11111111 00000000 11111111 00000000 [...] .TP -.BR "\-d, \-\-device " -The device to use for acquisition. It can be specified by ID as reported by -.BR "\-\-list\-devices" , -or by the name of the driver as reported by -.BR \-\-version . -.sp -A device can optionally be followed by a colon-separated list of device -options, where each option takes the form -.BR key=value . -For example, to set the samplerate on the first device you might specify -.sp -.RB " $ " "sigrok\-cli \-d 0:samplerate=1m" -.sp -Samplerate is an option common to most devices. The argument specifies the -samplerate in Hz. You can also specify the samplerate in kHz, MHz or GHz. -The following are all equivalent: -.sp -.RB " $ " "sigrok\-cli \-\-samples 100 \-d 0:samplerate=1000000" -.sp -.RB " $ " "sigrok\-cli \-\-samples 100 \-d 0:samplerate=1m" -.sp -.RB " $ " "sigrok\-cli \-\-samples 100 \-d ""0:samplerate=1 MHz"" -.TP .BR "\-p, \-\-probes " A comma-separated list of probes to be used in the session. .sp @@ -232,7 +232,10 @@ as SCK, and probe 0 as CS# signal. .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. +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 @@ -268,6 +271,32 @@ option (you cannot specify them in the .B \-s option). .TP +.BR "\-\-protocol\-decoder\-annotation " +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: +.sp + $ +.B "sigrok\-cli \-i \-a i2c,i2cfilter,edid" +.br +.B " \-\-protocol\-decoder\-annotation 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 + $ +.B "sigrok\-cli \-i \-a i2c,i2cfilter,edid" +.br +.B " \-\-protocol\-decoder\-annotation i2c=rawhex" +.sp +You can also select multiple protocol decoders, with an optional selected +annotation format each, by separating them with commas: +.sp + $ +.B "sigrok\-cli \-i \-a i2c,i2cfilter,edid" +.br +.B " \-\-protocol\-decoder\-annotation i2c=rawhex,edid" +.TP .BR "\-\-time " Sample for .B