Update the manpage.

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

diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1
index 400152eab29840b94c2844df11cb5d81e6da563c..c2e80734af466406af286f3743b613ef0ac52a8c 100644 (file)
--- a/doc/sigrok-cli.1
+++ b/doc/sigrok-cli.1
@@ -1,4 +1,4 @@
-.TH SIGROK\-CLI 1 "Jan 31, 2014"
+.TH SIGROK\-CLI 1 "May 04, 2014"

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


@@ -42,7 +42,7 @@ Some USB devices don't use a unique VendorID/ProductID combination, and thus
 need that specified as well. This also uses the \fBconn\fP option, using
 either \fBVendorID.ProductID\fP or \fBbus.address\fP:
 .sp
 need that specified as well. This also uses the \fBconn\fP option, using
 either \fBVendorID.ProductID\fP or \fBbus.address\fP:
 .sp

-.RB "  $ " "sigrok\-cli \-\-driver=nexus-osciprime:conn=04b4.8613"
+.RB "  $ " "sigrok\-cli \-\-driver=uni-t-ut61e:conn=1a86.e008"

 .TP
 .BR "\-c, \-\-config " <device>
 A colon-separated list of device options, where each option takes the form
 .TP
 .BR "\-c, \-\-config " <device>
 A colon-separated list of device options, where each option takes the form


@@ -119,33 +119,33 @@ will display 128 bits per line, in hexadecimal:
  0:ffff ffff ffff ffff ffff ffff ffff ffff
  1:ff00 ff00 ff00 ff00 ff00 ff00 ff00 ff00
 .sp
  0:ffff ffff ffff ffff ffff ffff ffff ffff
  1:ff00 ff00 ff00 ff00 ff00 ff00 ff00 ff00
 .sp

-The lines always start with the probe number (or name, if defined), followed by a colon. If no format is specified, it defaults to
+The lines always start with the channel number (or name, if defined), followed by a colon. If no format is specified, it defaults to

 .BR bits:width=64 ,
 like this:
 .sp
  0:11111111 11111111 11111111 11111111 [...]
  1:11111111 00000000 11111111 00000000 [...]
 .TP
 .BR bits:width=64 ,
 like this:
 .sp
  0:11111111 11111111 11111111 11111111 [...]
  1:11111111 00000000 11111111 00000000 [...]
 .TP

-.BR "\-p, \-\-probes " <probelist>
-A comma-separated list of probes to be used in the session.
+.BR "\-C, \-\-channels " <channellist>
+A comma-separated list of channels to be used in the session.

 .sp
 .sp

-Note that sigrok always names the probes according to how they're shown on
-the enclosure of the hardware. If your logic analyzer numbers the probes 0-15,
-that's how you must specify them with this option. An oscilloscope's probes
+Note that sigrok always names the channels according to how they're shown on
+the enclosure of the hardware. If your logic analyzer numbers the channels 0-15,
+that's how you must specify them with this option. An oscilloscope's channels

 would generally be referred to as "CH1", "CH2", and so on.
 would generally be referred to as "CH1", "CH2", and so on.

-Use the \fB\-\-show\fP option to see a list of probe names for your device.
+Use the \fB\-\-show\fP option to see a list of channel names for your device.

 .sp
 .sp

-The default is to use all the probes available on a device. You can name
-a probe like this:
+The default is to use all the channels available on a device. You can name
+a channel like this:

 .BR "1=CLK" .
 .BR "1=CLK" .

-A range of probes can also be given, in the form
+A range of channels can also be given, in the form

 .BR "1\-5" .
 .sp
 Example:
 .sp
 .RB "  $ " "sigrok\-cli \-\-driver fx2lafw \-\-samples 100"
 .br
 .BR "1\-5" .
 .sp
 Example:
 .sp
 .RB "  $ " "sigrok\-cli \-\-driver fx2lafw \-\-samples 100"
 .br

-.B "               \-\-probes 1=CLK,2\-4,7"
+.B "               \-\-channels 1=CLK,2\-4,7"

 .br
  CLK:11111111 11111111 11111111 11111111 [...]
    2:11111111 11111111 11111111 11111111 [...]
 .br
  CLK:11111111 11111111 11111111 11111111 [...]
    2:11111111 11111111 11111111 11111111 [...]


@@ -155,31 +155,21 @@ Example:
 .sp
 The comma-separated list is processed from left to right, i.e. items farther
 to the right override previous items. For example
 .sp
 The comma-separated list is processed from left to right, i.e. items farther
 to the right override previous items. For example

-.B "1=CS,1=MISO"
-will set the name of probe 1 to
+.B "1=CS,CS=MISO"
+will set the name of channel 1 to

 .BR "MISO" .
 .BR "MISO" .

-.sp
-Also, while
-.B "5=MOSI,6=MISO"
-will only select probes 5 and 6, and set their names to MISO and MOSI, the
-command line
-.B "5=MOSI,6=MISO,1\-8"
-will select probes 1\-8 (including 5 and 6, of course), but the names specified
-for probes 5 and 6 will be reset to the defaults by the
-.B "1\-8"
-probe selection.

 .TP
 .BR "\-g, \-\-channel\-group "<channel\ group>
 Specify the channel group to operate on.
 
 Some devices organize channels into groups, the settings of which can
 only be changed as a group. The list of channel groups, if any, is displayed
 .TP
 .BR "\-g, \-\-channel\-group "<channel\ group>
 Specify the channel group to operate on.
 
 Some devices organize channels into groups, the settings of which can
 only be changed as a group. The list of channel groups, if any, is displayed

-with the \-\-show command.
+with the \fB\-\-show\fP command.

 .TP
 .BR "\-t, \-\-triggers " <triggerlist>
 A comma-separated list of triggers to use, of the form
 .TP
 .BR "\-t, \-\-triggers " <triggerlist>
 A comma-separated list of triggers to use, of the form

-.BR "<probe>=<trigger>" .
-You can use the name or number of the probe, and the trigger itself is a
+.BR "<channel>=<trigger>" .
+You can use the name or number of the channel, and the trigger itself is a

 series of characters:
 .sp
 .BR "0 or 1" :
 series of characters:
 .sp
 .BR "0 or 1" :


@@ -231,22 +221,22 @@ The list of supported options depends entirely on the protocol decoder. Every
 protocol decoder has different options it supports.
 .sp
 Any "options" specified for a protocol decoder which are not actually
 protocol decoder has different options it supports.
 .sp
 Any "options" specified for a protocol decoder which are not actually

-supported options, will be interpreted as being probe name/number assignments.
+supported options, will be interpreted as being channel name/number assignments.

 .sp
 Example:
 .sp
  $
 .B "sigrok\-cli \-i <file.sr>"
 .br
 .sp
 Example:
 .sp
  $
 .B "sigrok\-cli \-i <file.sr>"
 .br

-.B "              \-P spi:wordsize=9:miso=1:mosi=5:sck=3:cs=0"
+.B "              \-P spi:wordsize=9:miso=1:mosi=5:clk=3:cs=0"

 .sp
 In this example,
 .B wordsize
 is an option supported by the
 .B spi
 protocol decoder. Additionally, the user tells sigrok to decode the SPI
 .sp
 In this example,
 .B wordsize
 is an option supported by the
 .B spi
 protocol decoder. Additionally, the user tells sigrok to decode the SPI

-protocol using probe 1 as MISO signal for SPI, probe 5 as MOSI, probe 3
-as SCK, and probe 0 as CS# signal.
+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 " <stack>
 This option allows the user to specify a protocol decoder stack, i.e.
 .TP
 .BR "\-S, \-\-protocol\-decoder\-stack " <stack>
 This option allows the user to specify a protocol decoder stack, i.e.


@@ -262,13 +252,13 @@ 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 \-S
 option, all protocol decoders that are used in a stack, must also be specified
 (together with their options, if any) using the

-.B \-A
+.B \-P

 parameter.
 .sp
 Example:
 .sp
  $
 parameter.
 .sp
 Example:
 .sp
  $

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

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


@@ -283,7 +273,7 @@ i.e., the
 is stacked on top of the
 .BR i2c " decoder."
 .sp
 is stacked on top of the
 .BR i2c " decoder."
 .sp

-The respective protocol decoder options and probe name/number assignments
+The respective protocol decoder options and channel name/number assignments

 must be given using the
 .B \-P
 option (you cannot specify them in the
 must be given using the
 .B \-P
 option (you cannot specify them in the


@@ -367,13 +357,9 @@ Example:
 .br
  The following devices were found:
 .br
 .br
  The following devices were found:
 .br

- Demo device with 8 probes: 0 1 2 3 4 5 6 7
-.br
- ChronoVu LA8 with 8 probes: 0 1 2 3 4 5 6 7
-.br
- ALSA: HDA ATI SB ALC270 Analog with 2 probes: Ch_0 Ch_1
+ demo - Demo device with 12 channels: D0 D1 D2 D3 D4 D5 D6 D7 A0 A1 A2 A3

 .br
 .br

- Saleae Logic with 8 probes: 0 1 2 3 4 5 6 7
+ fx2lafw:conn=3.26 - CWAV USBee SX with 8 channels: 0 1 2 3 4 5 6 7

 .sp
 However, not all devices are auto-detectable (e.g. serial port based ones).
 For those you'll have to provide a \fBconn\fP option, see above.
 .sp
 However, not all devices are auto-detectable (e.g. serial port based ones).
 For those you'll have to provide a \fBconn\fP option, see above.


@@ -383,16 +369,15 @@ For those you'll have to provide a \fBconn\fP option, see above.
 .br
  The following devices were found:
 .br
 .br
  The following devices were found:
 .br

- Digitek DT4000ZC with 1 probe: P1
+ Digitek DT4000ZC with 1 channel: P1

 .TP
 .BR "\-\-time " <ms>
 Sample for
 .B <ms>
 milliseconds, then quit.
 .sp
 .TP
 .BR "\-\-time " <ms>
 Sample for
 .B <ms>
 milliseconds, then quit.
 .sp

-You can optionally follow the number by \fBs\fP, \fBms\fP, \fBus\fP, or
-\fBns\fP to specify the time to sample in seconds, milliseconds, microseconds,
-or nanoseconds, respectively.
+You can optionally follow the number by \fBs\fP to specify the time to
+sample in seconds.

 .sp
 For example,
 .B "\-\-time 2s"
 .sp
 For example,
 .B "\-\-time 2s"


@@ -431,12 +416,12 @@ Alternatively, you can also use:
 .TP
 .B "  sigrok\-cli \-\-driver fx2lafw \-\-time 3s"
 .TP
 .TP
 .B "  sigrok\-cli \-\-driver fx2lafw \-\-time 3s"
 .TP

-To capture data from the first 4 probes using the Openbench Logic Sniffer lasting 100ms at 10 MHz starting at the trigger condition
+To capture data from the first 4 channels using the Openbench Logic Sniffer lasting 100ms at 10 MHz starting at the trigger condition

 0:high, 1:rising, 2:low, 3:high, use:
 .TP
 .nf
 \fBsigrok\-cli \-\-driver ols:conn=/dev/ttyACM0 \-\-config samplerate=10m \\\fP
 0:high, 1:rising, 2:low, 3:high, use:
 .TP
 .nf
 \fBsigrok\-cli \-\-driver ols:conn=/dev/ttyACM0 \-\-config samplerate=10m \\\fP

-\fB\-\-output\-format bits \-\-probes 0\-3 \-\-wait\-trigger \\\fP
+\fB\-\-output\-format bits \-\-channels 0\-3 \-\-wait\-trigger \\\fP

 \fB\-\-triggers 0=1,1=r,2=0,3=1 \-\-time 100\fP
 .TP
 To turn on internal logging on a Lascar EL-USB series device:
 \fB\-\-triggers 0=1,1=r,2=0,3=1 \-\-time 100\fP
 .TP
 To turn on internal logging on a Lascar EL-USB series device: