Update the manpage.
[sigrok-cli.git] / doc / sigrok-cli.1
1 .TH SIGROK\-CLI 1 "May 04, 2014"
2 .SH "NAME"
3 sigrok\-cli \- Command-line client for the sigrok software
4 .SH "SYNOPSIS"
5 .B sigrok\-cli [OPTIONS] [COMMAND]
6 .SH "DESCRIPTION"
7 \fBsigrok\-cli\fP is a cross-platform command line utility for the
8 \fBsigrok\fP software.
9 .PP
10 It cannot display graphical output, but is still sufficient to run through
11 the whole process of hardware initialization, acquisition, protocol decoding
12 and saving the session.
13 .PP
14 It is useful for running on remote or embedded systems, netbooks, PDAs,
15 and for various other use-cases. It can display samples on standard output or
16 save them in various file formats.
17 .SH OPTIONS
18 .TP
19 .B "\-h, \-\-help"
20 Show a help text and exit.
21 .TP
22 .B "\-V, \-\-version"
23 Show
24 .B sigrok-cli
25 version, and information about supported hardware drivers, input file
26 formats, output file formats, and protocol decoders.
27 .TP
28 \fB\-d, \-\-driver\fP <drivername>
29 A driver must always be selected (unless doing a global scan). Use the
30 \fB-V\fP option to get a list of available drivers.
31 .sp
32 Drivers can take options, in the form \fBkey=value\fP
33 separated by colons.
34 .sp
35 Drivers communicating with hardware via a serial port always need the port
36 specified as the \fBconn\fP option. For example, to use the
37 Openbench Logic Sniffer:
38 .sp
39 .RB "  $ " "sigrok\-cli \-\-driver=ols:conn=/dev/ttyACM0"
40 .sp
41 Some USB devices don't use a unique VendorID/ProductID combination, and thus
42 need that specified as well. This also uses the \fBconn\fP option, using
43 either \fBVendorID.ProductID\fP or \fBbus.address\fP:
44 .sp
45 .RB "  $ " "sigrok\-cli \-\-driver=uni-t-ut61e:conn=1a86.e008"
46 .TP
47 .BR "\-c, \-\-config " <device>
48 A colon-separated list of device options, where each option takes the form
49 .BR key=value .
50 For example, to set the samplerate to 1MHz on a device supported by the
51 fx2lafw driver, you might specify
52 .sp
53 .RB "  $ " "sigrok\-cli \-\-driver=fx2lafw \-\-config samplerate=1m"
54 .sp
55 Samplerate is an option common to most logic analyzers. The argument specifies
56 the samplerate in Hz. You can also specify the samplerate in kHz, MHz or GHz.
57 The following are all equivalent:
58 .sp
59 .RB "  $ " "sigrok\-cli \-\-driver fx2lafw \-\-config samplerate=1000000"
60 .sp
61 .RB "  $ " "sigrok\-cli \-\-driver fx2lafw \-\-config samplerate=1m"
62 .sp
63 .RB "  $ " "sigrok\-cli \-\-driver fx2lafw \-\-config \(dqsamplerate=1 MHz\(dq"
64 .TP
65 .BR "\-i, \-\-input\-file " <filename>
66 Load input from a file instead of a hardware device. If the
67 .B \-\-input\-format
68 option is not supplied, sigrok-cli attempts to autodetect the file format of
69 the input file.
70 .TP
71 .BR "\-I, \-\-input\-format " <format>
72 When loading an input file, assume it's in the specified format. If this
73 option is not supplied (in addition to
74 .BR \-\-input\-file ),
75 sigrok-cli attempts to autodetect the file format of the input file. Use the
76 .B \-V
77 option to see a list of available input formats.
78 .sp
79 The format name may optionally be followed by a colon-separated list of
80 options, where each option takes the form
81 .BR "key=value" .
82 .TP
83 .BR "\-o, \-\-output\-file " <filename>
84 Save output to a file instead of writing it to stdout. The default format
85 used when saving is the sigrok session file format. This can be changed with
86 the
87 .B \-\-output\-format
88 option.
89 .TP
90 .BR "\-O, \-\-output\-format " <formatname>
91 Set the output format to use. Use the
92 .B \-V
93 option to see a list of available output formats.
94 .sp
95 The format name may optionally be followed by a colon-separated list of
96 options, where each option takes the form
97 .BR "key=value" .
98 .sp
99 Supported formats currently include
100 .BR bits ,
101 .BR hex ,
102 .BR ascii ,
103 .BR binary ,
104 .BR vcd ,
105 .BR ols ,
106 .BR gnuplot ,
107 .BR chronovu-la8 ,
108 .BR csv ", and"
109 .BR analog .
110 .sp
111 The
112 .B bits
113 or
114 .B hex
115 formats, for an ASCII bit or ASCII hexadecimal display, can take a "width" option, specifying the number of samples (in bits) to display per line. Thus
116 .B hex:width=128
117 will display 128 bits per line, in hexadecimal:
118 .sp
119  0:ffff ffff ffff ffff ffff ffff ffff ffff
120  1:ff00 ff00 ff00 ff00 ff00 ff00 ff00 ff00
121 .sp
122 The lines always start with the channel number (or name, if defined), followed by a colon. If no format is specified, it defaults to
123 .BR bits:width=64 ,
124 like this:
125 .sp
126  0:11111111 11111111 11111111 11111111 [...]
127  1:11111111 00000000 11111111 00000000 [...]
128 .TP
129 .BR "\-C, \-\-channels " <channellist>
130 A comma-separated list of channels to be used in the session.
131 .sp
132 Note that sigrok always names the channels according to how they're shown on
133 the enclosure of the hardware. If your logic analyzer numbers the channels 0-15,
134 that's how you must specify them with this option. An oscilloscope's channels
135 would generally be referred to as "CH1", "CH2", and so on.
136 Use the \fB\-\-show\fP option to see a list of channel names for your device.
137 .sp
138 The default is to use all the channels available on a device. You can name
139 a channel like this:
140 .BR "1=CLK" .
141 A range of channels can also be given, in the form
142 .BR "1\-5" .
143 .sp
144 Example:
145 .sp
146 .RB "  $ " "sigrok\-cli \-\-driver fx2lafw \-\-samples 100"
147 .br
148 .B "               \-\-channels 1=CLK,2\-4,7"
149 .br
150  CLK:11111111 11111111 11111111 11111111 [...]
151    2:11111111 11111111 11111111 11111111 [...]
152    3:11111111 11111111 11111111 11111111 [...]
153    4:11111111 11111111 11111111 11111111 [...]
154    7:11111111 11111111 11111111 11111111 [...]
155 .sp
156 The comma-separated list is processed from left to right, i.e. items farther
157 to the right override previous items. For example
158 .B "1=CS,CS=MISO"
159 will set the name of channel 1 to
160 .BR "MISO" .
161 .TP
162 .BR "\-g, \-\-channel\-group "<channel\ group>
163 Specify the channel group to operate on.
164
165 Some devices organize channels into groups, the settings of which can
166 only be changed as a group. The list of channel groups, if any, is displayed
167 with the \fB\-\-show\fP command.
168 .TP
169 .BR "\-t, \-\-triggers " <triggerlist>
170 A comma-separated list of triggers to use, of the form
171 .BR "<channel>=<trigger>" .
172 You can use the name or number of the channel, and the trigger itself is a
173 series of characters:
174 .sp
175 .BR "0 or 1" :
176 A low or high value on the pin.
177 .br
178 .BR "r or f" :
179 A rising or falling value on the pin. An
180 .B r
181 effectively corresponds to
182 .BR 01 .
183 .br
184 .BR "c" :
185 Any kind of change on a pin (either a rising or a falling edge).
186 .sp
187 Not every device supports all of these trigger types. Use the \fB\-\-show\fP
188 command to see which triggers your device supports.
189 .TP
190 .BR "\-w, \-\-wait-trigger"
191 Don't output any sample data (even if it's actually received from the
192 hardware) before the trigger condition is met. In other words, do not output
193 any pre-trigger data. This option is useful if you don't care about the data
194 that came before the trigger (but the hardware delivers this data to sigrok
195 nonetheless).
196 .TP
197 .BR "\-P, \-\-protocol\-decoders " <list>
198 This option allows the user to specify a comma-separated list of protocol
199 decoders to be used in this session. The decoders are specified by their
200 ID, as shown in the
201 .B \-\-version
202 output.
203 .sp
204 Example:
205 .sp
206  $
207 .B "sigrok\-cli \-i <file.sr> \-P i2c"
208 .sp
209 Each protocol decoder can optionally be followed by a colon-separated list
210 of options, where each option takes the form
211 .BR "key=value" .
212 .sp
213 Example:
214 .sp
215  $
216 .B "sigrok\-cli \-i <file.sr> "
217 .br
218 .B "              \-P uart:baudrate=115200:parity_type=odd"
219 .sp
220 The list of supported options depends entirely on the protocol decoder. Every
221 protocol decoder has different options it supports.
222 .sp
223 Any "options" specified for a protocol decoder which are not actually
224 supported options, will be interpreted as being channel name/number assignments.
225 .sp
226 Example:
227 .sp
228  $
229 .B "sigrok\-cli \-i <file.sr>"
230 .br
231 .B "              \-P spi:wordsize=9:miso=1:mosi=5:clk=3:cs=0"
232 .sp
233 In this example,
234 .B wordsize
235 is an option supported by the
236 .B spi
237 protocol decoder. Additionally, the user tells sigrok to decode the SPI
238 protocol using channel 1 as MISO signal for SPI, channel 5 as MOSI, channel 3
239 as CLK, and channel 0 as CS# signal.
240 .TP
241 .BR "\-S, \-\-protocol\-decoder\-stack " <stack>
242 This option allows the user to specify a protocol decoder stack, i.e.
243 the way in which one protocol decoder's output gets piped into another
244 protocol decoder. If not specified, the stack will be set up in the same
245 order in which the protocol decoders were given with the
246 .B \-\-protocol-decoders
247 option.
248 .sp
249 The decoders are specified by their ID, as shown in the
250 .B \-\-version
251 output. In addition to the
252 .B \-S
253 option, all protocol decoders that are used in a stack, must also be specified
254 (together with their options, if any) using the
255 .B \-P
256 parameter.
257 .sp
258 Example:
259 .sp
260  $
261 .B "sigrok\-cli \-i <file.sr> \-P i2c:sda=4:scl=7,rtc8564"
262 .br
263 .B "              \-S i2c,rtc8564"
264 .sp
265 In this example, the
266 .B \-S
267 option specifies that the output of the
268 .BR i2c " decoder"
269 is piped into the
270 .BR rtc8564 " decoder,"
271 i.e., the
272 .BR rtc8564 " decoder"
273 is stacked on top of the
274 .BR i2c " decoder."
275 .sp
276 The respective protocol decoder options and channel name/number assignments
277 must be given using the
278 .B \-P
279 option (you cannot specify them in the
280 .B \-S
281 option).
282 .TP
283 .BR "\-A, \-\-protocol\-decoder\-annotations " <annotations>
284 By default, only the stack's topmost protocol decoder's annotation output is
285 shown. With this option another decoder's annotation can be selected for
286 display, by specifying its ID:
287 .sp
288  $
289 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid -A i2c"
290 .sp
291 If a protocol decoder has multiple annotations, you can also specify
292 which one of them to show by specifying its short description like this:
293 .sp
294  $
295 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
296 .br
297 .B "              \-A i2c=data-read"
298 .sp
299 Select multiple annotations by separating them with a colon:
300 .sp
301  $
302 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
303 .br
304 .B "              \-A i2c=data-read:data-write"
305 .sp
306 You can also select multiple protocol decoders, with an optional selected
307 annotation each, by separating them with commas:
308 .sp
309  $
310 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
311 .br
312 .B "              \-A i2c=data-read:data-write,edid"
313 .TP
314 .BR "\-l, \-\-loglevel " <level>
315 Set the libsigrok and libsigrokdecode loglevel. At the moment \fBsigrok-cli\fP
316 doesn't support setting the two loglevels independently. The higher the
317 number, the more debug output will be printed. Valid loglevels are:
318 .sp
319 \fB0\fP   None
320 .br
321 \fB1\fP   Error
322 .br
323 \fB2\fP   Warnings
324 .br
325 \fB3\fP   Informational
326 .br
327 \fB4\fP   Debug
328 .br
329 \fB5\fP   Spew
330 .TP
331 .B "\-\-show"
332 .br
333 Show information about the selected option. For example, to see options for a
334 connected fx2lafw device:
335 .sp
336  $
337 .B "sigrok\-cli \-\-driver fx2lafw \-\-show
338 .sp
339 In order to properly get device options for your hardware, some drivers might
340 need a serial port specified:
341 .sp
342  $
343 .B "sigrok\-cli \-\-driver ols:conn=/dev/ttyACM0 \-\-show
344 .sp
345 To view the documentation for a protocol decoder:
346 .sp
347  $
348 .B "sigrok\-cli \-\-protocol-decoders i2c \-\-show
349 .TP
350 .B "\-\-scan"
351 Scan for devices that can be detected automatically.
352 .sp
353 Example:
354 .sp
355  $
356 .B "sigrok\-cli \-\-scan
357 .br
358  The following devices were found:
359 .br
360  demo - Demo device with 12 channels: D0 D1 D2 D3 D4 D5 D6 D7 A0 A1 A2 A3
361 .br
362  fx2lafw:conn=3.26 - CWAV USBee SX with 8 channels: 0 1 2 3 4 5 6 7
363 .sp
364 However, not all devices are auto-detectable (e.g. serial port based ones).
365 For those you'll have to provide a \fBconn\fP option, see above.
366 .sp
367  $
368 .B "sigrok\-cli \-\-driver digitek-dt4000zc:conn=/dev/ttyUSB0 \-\-scan
369 .br
370  The following devices were found:
371 .br
372  Digitek DT4000ZC with 1 channel: P1
373 .TP
374 .BR "\-\-time " <ms>
375 Sample for
376 .B <ms>
377 milliseconds, then quit.
378 .sp
379 You can optionally follow the number by \fBs\fP to specify the time to
380 sample in seconds.
381 .sp
382 For example,
383 .B "\-\-time 2s"
384 will sample for two seconds.
385 .TP
386 .BR "\-\-samples " <numsamples>
387 Acquire
388 .B <numsamples>
389 samples, then quit.
390 .sp
391 You can optionally follow the number by \fBk\fP, \fBm\fP, or \fBg\fP to
392 specify the number of samples in kilosamples, megasamples, or gigasamples,
393 respectively.
394 .sp
395 For example,
396 .B "\-\-samples 3m"
397 will acquire 3000000 samples.
398 .TP
399 .BR "\-\-continuous"
400 Sample continuously until stopped. Not all devices support this.
401 .TP
402 .BR "\-\-set"
403 Set one or more variables specified with the \fB\-\-config\fP option, without
404 doing any acquisition.
405 .SH EXAMPLES
406 In order to get exactly 100 samples from the connected fx2lafw-supported logic
407 analyzer hardware, run the following command:
408 .TP
409 .B "  sigrok\-cli \-\-driver fx2lafw \-\-samples 100"
410 .TP
411 If you want to sample data for 3 seconds (3000 ms), use:
412 .TP
413 .B "  sigrok\-cli \-\-driver fx2lafw \-\-time 3000"
414 .TP
415 Alternatively, you can also use:
416 .TP
417 .B "  sigrok\-cli \-\-driver fx2lafw \-\-time 3s"
418 .TP
419 To capture data from the first 4 channels using the Openbench Logic Sniffer lasting 100ms at 10 MHz starting at the trigger condition
420 0:high, 1:rising, 2:low, 3:high, use:
421 .TP
422 .nf
423 \fBsigrok\-cli \-\-driver ols:conn=/dev/ttyACM0 \-\-config samplerate=10m \\\fP
424 \fB\-\-output\-format bits \-\-channels 0\-3 \-\-wait\-trigger \\\fP
425 \fB\-\-triggers 0=1,1=r,2=0,3=1 \-\-time 100\fP
426 .TP
427 To turn on internal logging on a Lascar EL-USB series device:
428 .TP
429 \fBsigrok\-cli \-\-driver lascar\-el\-usb:conn=10c4.0002 \\\fP
430 \fB\-\-config datalog=on \-\-set\fP
431 .SH "EXIT STATUS"
432 .B sigrok\-cli
433 exits with 0 on success, 1 on most failures.
434 .SH "SEE ALSO"
435 \fBpulseview\fP(1)
436 .SH "BUGS"
437 Please report any bugs via Bugzilla
438 .RB "(" http://sigrok.org/bugzilla ")"
439 or on the sigrok\-devel mailing list
440 .RB "(" sigrok\-devel@lists.souceforge.net ")."
441 .SH "LICENSE"
442 .B sigrok\-cli
443 is covered by the GNU General Public License (GPL). Some portions are
444 licensed under the "GPL v2 or later", some under "GPL v3 or later".
445 .SH "AUTHORS"
446 Please see the individual source code files.
447 .PP
448 This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
449 It is licensed under the terms of the GNU GPL (version 2 or later).