sigrok-cli_cross.nsi.in: Bump Python version to 3.6.

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

diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1
index 2e60c9f4bc02c8cf7a9969752ce468153d21a020..5e5df36877cc6cd5671a20da170be30e99101336 100644 (file)
--- a/doc/sigrok-cli.1
+++ b/doc/sigrok-cli.1
@@ -181,7 +181,7 @@ A rising or falling value on the pin. An
 effectively corresponds to
 .BR 01 .
 .br
-.BR "c" :
+.BR "e" :
 Any kind of change on a pin (either a rising or a falling edge).
 .sp
 Not every device supports all of these trigger types. Use the \fB\-\-show\fP
@@ -311,6 +311,43 @@ annotation each, by separating them with commas:
 .br
 .B "              \-A i2c=data-read:data-write,edid"
 .TP
+.BR "\-M, \-\-protocol\-decoder\-meta " <pdname>
+When given, show protocol decoder meta output instead of annotations.
+The argument is the name of the decoder whose meta output to show.
+.sp
+ $
+.B "sigrok\-cli \-i <file.sr> \-M i2c"
+.sp
+Not every decoder generates meta output.
+.TP
+.BR "\-B, \-\-protocol\-decoder\-binary " <binaryspec>
+When given, decoder "raw" data of various kinds is written to stdout instead
+of annotations (this could be raw binary UART/SPI bytes, or WAV files, PCAP
+files, PNG files, or anything else; this is entirely dependent on the
+decoder and what kinds of binary output make sense for that decoder).
+.sp
+No other information is printed to stdout, so this is
+suitable for piping into other programs or saving to a file.
+.sp
+Protocol decoders that support binary output publish a list of binary
+classes, for example the UART decoder might have "TX" and "RX". To
+select TX for output, the argument to this option would be:
+.sp
+ $
+.B "sigrok\-cli \-i <file.sr> \-B uart=tx"
+.br
+.sp
+If only the protocol decoder is specified, without binary class, all classes
+are written to stdout:
+.sp
+ $
+.B "sigrok\-cli \-i <file.sr> \-B uart"
+.sp
+(this is only useful in rare cases, generally you would specify a certain
+binary class you're interested in)
+.sp
+Not every decoder generates binary output.
+.TP
 .BR "\-l, \-\-loglevel " <level>
 Set the libsigrok and libsigrokdecode loglevel. At the moment \fBsigrok-cli\fP
 doesn't support setting the two loglevels independently. The higher the
@@ -342,10 +379,14 @@ need a serial port specified:
  $
 .B "sigrok\-cli \-\-driver ols:conn=/dev/ttyACM0 \-\-show
 .sp
-To view the documentation for a protocol decoder:
+This also works for protocol decoders, input modules and output modules:
 .sp
  $
-.B "sigrok\-cli \-\-protocol-decoders i2c \-\-show
+.B "sigrok\-cli \-\-protocol\-decoders i2c \-\-show
+ $
+.B "sigrok\-cli \-\-input\-format csv \-\-show
+ $
+.B "sigrok\-cli \-\-output\-format bits \-\-show
 .TP
 .B "\-\-scan"
 Scan for devices that can be detected automatically.
@@ -404,6 +445,11 @@ frames, then quit.
 .BR "\-\-continuous"
 Sample continuously until stopped. Not all devices support this.
 .TP
+.BR "\-\-get " <variable>
+Get the value of
+.B <variable>
+from the specified device and print it.
+.TP
 .BR "\-\-set"
 Set one or more variables specified with the \fB\-\-config\fP option, without
 doing any acquisition.