cli: Make --protocol-decoder-annotations plural.
[sigrok-cli.git] / doc / sigrok-cli.1
1 .TH SIGROK\-CLI 1 "May 29, 2012"
2 .SH "NAME"
3 sigrok\-cli \- Command-line client for the sigrok logic analyzer software
4 .SH "SYNOPSIS"
5 .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]
6 .SH "DESCRIPTION"
7 .B sigrok\-cli
8 is a cross-platform command line utility for the
9 .B sigrok
10 logic analyzer software.
11 .PP
12 The command-line frontend for sigrok cannot display graphical output, but is
13 still sufficient to run through the whole process of hardware initialization,
14 acquisition, protocol decoding and saving the session.
15 .PP
16 It is useful for running on remote or embedded systems, netbooks, PDAs,
17 and for various other use-cases. It can display samples on standard output or
18 save them in various file formats.
19 .SH "OPTIONS"
20 .TP
21 .B "\-h, \-\-help"
22 Show a help text and exit.
23 .TP
24 .B "\-V, \-\-version"
25 Show
26 .B sigrok-cli
27 version, and information about supported hardware drivers, input file
28 formats, output file formats, and protocol decoders.
29 .TP
30 .BR "\-l, \-\-loglevel " <level>
31 Set the libsigrok and libsigrokdecode loglevel. At the moment
32 .B sigrok-cli
33 doesn't support setting the two loglevels independently. The higher the
34 number, the more debug output will be printed. Valid loglevels are
35 .BR 0 " (NONE),"
36 .BR 1 " (ERR),"
37 .BR 2 " (WARN),"
38 .BR 3 " (INFO),"
39 .BR 4 " (DBG), and"
40 .BR 5 " (SPEW)."
41 .TP
42 .B "\-D, \-\-list\-devices"
43 List all logic analyzer devices found on the system. This actively scans for
44 devices (USB, serial port, and others).
45 .TP
46 .BR "\-d, \-\-device " <device>
47 The device to use for acquisition. It can be specified by ID as reported by
48 .BR "\-\-list\-devices" ,
49 or by the name of the driver as reported by
50 .BR \-\-version .
51 .sp
52 A device can optionally be followed by a colon-separated list of device
53 options, where each option takes the form
54 .BR key=value .
55 For example, to set the samplerate on the first device you might specify
56 .sp
57 .RB "  $ " "sigrok\-cli \-d 0:samplerate=1m"
58 .sp
59 Samplerate is an option common to most devices. The argument specifies the
60 samplerate in Hz. You can also specify the samplerate in kHz, MHz or GHz.
61 The following are all equivalent:
62 .sp
63 .RB "  $ " "sigrok\-cli \-\-samples 100 \-d 0:samplerate=1000000"
64 .sp
65 .RB "  $ " "sigrok\-cli \-\-samples 100 \-d 0:samplerate=1m"
66 .sp
67 .RB "  $ " "sigrok\-cli \-\-samples 100 \-d ""0:samplerate=1 MHz""
68 .TP
69 .BR "\-i, \-\-input\-file " <filename>
70 Load input from a file instead of a hardware device. If the
71 .B \-\-input\-format
72 option is not supplied, sigrok-cli attempts to autodetect the file format of
73 the input file.
74 .TP
75 .BR "\-I, \-\-input\-format " <format>
76 When loading an input file, assume it's in the specified format. If this
77 option is not supplied (in addition to
78 .BR \-\-input\-file ),
79 sigrok-cli attempts to autodetect the file format of the input file.
80 .TP
81 .BR "\-o, \-\-output\-file " <filename>
82 Save output to a file instead of writing it to stdout. The default format
83 used when saving is the sigrok session file format. This can be changed with
84 the
85 .B \-\-output\-format
86 option.
87 .TP
88 .BR "\-O, \-\-output\-format " <formatname>
89 Set the output format to use. Use the
90 .B \-V
91 option to see a list of available output formats. The format name may
92 optionally be followed by a colon-separated list of options, where each
93 option takes the form
94 .BR "key=value" .
95 .sp
96 Supported formats currently include
97 .BR bits ,
98 .BR hex ,
99 .BR ascii ,
100 .BR binary ,
101 .BR vcd ,
102 .BR ols ,
103 .BR gnuplot ,
104 .BR chronovu-la8 ", and"
105 .BR csv .
106 .sp
107 The
108 .B bits
109 or
110 .B hex
111 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
112 .B hex:width=128
113 will display 128 bits per line, in hexadecimal:
114 .sp
115  1:ffff ffff ffff ffff ffff ffff ffff ffff
116  2:ff00 ff00 ff00 ff00 ff00 ff00 ff00 ff00
117 .sp
118 The lines always start with the probe number (or name, if defined), followed by a colon. If no format is specified, it defaults to
119 .BR bits:width=64 ,
120 like this:
121 .sp
122  1:11111111 11111111 11111111 11111111 [...]
123  2:11111111 00000000 11111111 00000000 [...]
124 .TP
125 .BR "\-p, \-\-probes " <probelist>
126 A comma-separated list of probes to be used in the session.
127 .sp
128 The default is to use all the probes available on a device. You can name
129 a probe like this:
130 .BR "1=CLK" .
131 A range of probes can also be given, in the form
132 .BR "1\-5" .
133 .sp
134 Example:
135 .sp
136  $
137 .B "sigrok\-cli \-\-samples 100 \-\-probes 1=CLK,2\-4,7"
138 .br
139  CLK:11111111 11111111 11111111 11111111 [...]
140    2:11111111 11111111 11111111 11111111 [...]
141    3:11111111 11111111 11111111 11111111 [...]
142    4:11111111 11111111 11111111 11111111 [...]
143    7:11111111 11111111 11111111 11111111 [...]
144 .sp
145 The comma-separated list is processed from left to right, i.e. items farther
146 to the right override previous items. For example
147 .B "1=CS,1=MISO"
148 will set the name of probe 1 to
149 .BR "MISO" .
150 .sp
151 Also, while
152 .B "5=MOSI,6=MISO"
153 will only select probes 5 and 6, and set their names to MISO and MOSI, the
154 command line
155 .B "5=MOSI,6=MISO,1\-8"
156 will select probes 1\-8 (including 5 and 6, of course), but the names specified
157 for probes 5 and 6 will be reset to the defaults by the
158 .B "1\-8"
159 probe selection.
160 .TP
161 .BR "\-t, \-\-triggers " <triggerlist>
162 A comma-separated list of triggers to use, of the form
163 .BR "<probe>=<trigger>" .
164 You can use the name or number of the probe, and the trigger itself is a
165 series of characters:
166 .sp
167 .BR "0 or 1" :
168 A low or high value on the pin.
169 .br
170 .BR "r or f" :
171 A rising or falling value on the pin. An
172 .B r
173 effectively corresponds to
174 .BR 01 .
175 .br
176 .BR "c" :
177 Any kind of change on a pin (either a rising or a falling edge).
178 .sp
179 Not every device supports all of these trigger types. Use the
180 .B "\-d <device>"
181 argument (with no other arguments) to see which triggers your device supports.
182 .TP
183 .BR "\-w, \-\-wait-trigger"
184 Don't output any sample data (even if it's actually received from the logic
185 analyzer) before the trigger condition is met. In other words, do not output
186 any pre-trigger data. This option is useful if you don't care about the data
187 that came before the trigger (but the logic analyzer hardware delivers this
188 data to sigrok nonetheless).
189 .TP
190 .BR "\-a, \-\-protocol\-decoders " <list>
191 This option allows the user to specify a comma-separated list of protocol
192 decoders to be used in this session. The decoders are specified by their
193 ID, as shown in the
194 .B \-\-version
195 output.
196 .sp
197 Example:
198 .sp
199  $
200 .B "sigrok\-cli \-i <file.sr> \-a i2c"
201 .sp
202 Each protocol decoder can optionally be followed by a colon-separated list
203 of options, where each option takes the form
204 .BR "key=value" .
205 .sp
206 Example:
207 .sp
208  $
209 .B "sigrok\-cli \-i <file.sr> \-a uart:baudrate=115200:parity=odd"
210 .sp
211 The list of supported options depends entirely on the protocol decoder. Every
212 protocol decoder has different options it supports.
213 .sp
214 Any "options" specified for a protocol decoder which are not actually
215 supported options, will be interpreted as being probe name/number assignments.
216 .sp
217 Example:
218 .sp
219  $
220 .B "sigrok\-cli \-i <file.sr>"
221 .br
222 .B "              \-a spi:wordsize=9:miso=1:mosi=5:sck=3:cs=0"
223 .sp
224 In this example,
225 .B wordsize
226 is an option supported by the
227 .B spi
228 protocol decoder. Additionally, the user tells sigrok to decode the SPI
229 protocol using probe 1 as MISO signal for SPI, probe 5 as MOSI, probe 3
230 as SCK, and probe 0 as CS# signal.
231 .TP
232 .BR "\-s, \-\-protocol\-decoder\-stack " <stack>
233 This option allows the user to specify a protocol decoder stack, i.e.
234 the way in which one protocol decoder's output gets piped into another
235 protocol decoder. If not specified, the stack will be set up in the same
236 order in which the protocol decoders were given with the
237 .B \-\-protocol-decoders
238 option.
239 .sp
240 The decoders are specified by their ID, as shown in the
241 .B \-\-version
242 output. In addition to the
243 .B \-s
244 option, all protocol decoders that are used in a stack, must also be specified
245 (together with their options, if any) using the
246 .B \-a
247 parameter.
248 .sp
249 Example:
250 .sp
251  $
252 .B "sigrok\-cli \-i <file.sr> \-a i2c:sda=4,scl=7,rtc8564"
253 .br
254 .B "              \-s i2c,rtc8564"
255 .sp
256 In this example, the
257 .B \-s
258 option specifies that the output of the
259 .BR i2c " decoder"
260 is piped into the
261 .BR rtc8564 " decoder,"
262 i.e., the
263 .BR rtc8564 " decoder"
264 is stacked on top of the
265 .BR i2c " decoder."
266 .sp
267 The respective protocol decoder options and probe name/number assignments
268 must be given using the
269 .B \-a
270 option (you cannot specify them in the
271 .B \-s
272 option).
273 .TP
274 .BR "\-A, \-\-protocol\-decoder\-annotations " <annotations>
275 By default, only the stack's topmost protocol decoder's annotation output is
276 shown. With this option another decoder's annotation can be selected for
277 display, by specifying its ID:
278 .sp
279  $
280 .B "sigrok\-cli \-i <file.sr> \-a i2c,i2cfilter,edid -A i2c"
281 .sp
282 If a protocol decoder has multiple annotation formats, you can also specify
283 which of them to show by specifying its short description like this:
284 .sp
285  $
286 .B "sigrok\-cli \-i <file.sr> \-a i2c,i2cfilter,edid"
287 .br
288 .B "              \-A i2c=rawhex"
289 .sp
290 You can also select multiple protocol decoders, with an optional selected
291 annotation format each, by separating them with commas:
292 .sp
293  $
294 .B "sigrok\-cli \-i <file.sr> \-a i2c,i2cfilter,edid"
295 .br
296 .B "              \-A i2c=rawhex,edid"
297 .TP
298 .BR "\-\-time " <ms>
299 Sample for
300 .B <ms>
301 milliseconds, then quit. You can optionally follow the number by
302 .B s
303 to state the number of seconds to sample instead. For example,
304 .B "\-\-time 2s"
305 will sample for two seconds.
306 .TP
307 .BR "\-\-samples " <numsamples>
308 Acquire
309 .B <numsamples>
310 samples, then quit.
311 .TP
312 .BR "\-\-continuous"
313 Sample continuously until stopped. Not all devices support this.
314 .SH "EXAMPLES"
315 In order to get exactly 100 samples from the (only) detected logic analyzer
316 hardware, run the following command:
317 .TP
318 .B "  sigrok\-cli \-\-samples 100"
319 .TP
320 If you want to sample data for 3 seconds, use:
321 .TP
322 .B "  sigrok\-cli \-\-time 3000"
323 .TP
324 Alternatively, you can also use:
325 .TP
326 .B "  sigrok\-cli \-\-time 3s"
327 .TP
328 To capture data from 4 probes lasting 100ms at 10 MHz starting at the trigger condition 1:high, 2:rising, 3:low, 4:high, use:
329 .TP
330 .B "  sigrok\-cli -d 0:samplerate=10m \-O bits \-p 1\-4 \-\-time 100 \\\\"
331 .B "      \-\-wait\-trigger \-\-triggers 1=1,2=r,3=0,4=1 "
332 .SH "EXIT STATUS"
333 .B sigrok\-cli
334 exits with 0 on success, 1 on most failures.
335 .SH "SEE ALSO"
336 \fBsigrok\-qt\fP(1),
337 \fBsigrok\-gtk\fP(1)
338 .SH "BUGS"
339 Please report any bugs on the sigrok\-devel mailing list
340 .RB "(" sigrok\-devel@lists.souceforge.net ")."
341 .SH "LICENSE"
342 .B sigrok\-cli
343 is covered by the GNU General Public License (GPL). Some portions are
344 licensed under the "GPL v2 or later", some under "GPL v3 or later".
345 .SH "AUTHORS"
346 Please see the individual source code files.
347 .PP
348 This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
349 It is licensed under the terms of the GNU GPL (version 2 or later).