From e4b7762f74a449c7184be68b0cfd1672b2094168 Mon Sep 17 00:00:00 2001 From: Gerhard Sittig Date: Wed, 10 Oct 2018 09:36:13 +0200 Subject: [PATCH] doc: discuss protocol decoder stacks in the manpage The previous version mentioned comma-separated lists of decoders, which is correct but also was easy to miss. Add a discussion and examples on stacking decoders as well as creating multiple decoder stacks. --- doc/sigrok-cli.1 | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1 index cbd9f87..8fbb3a1 100644 --- a/doc/sigrok-cli.1 +++ b/doc/sigrok-cli.1 @@ -229,6 +229,30 @@ is an option supported by the protocol decoder. Additionally, the user tells sigrok to decode the SPI protocol using channel 1 as MISO signal for SPI, channel 5 as MOSI, channel 3 as CLK, and channel 0 as CS# signal. +.br +.sp +When multiple decoders are specified in the same +.BR -P +option, they will be stacked on top of each other in the specified order. +.sp +Example: +.sp + $ +.B "sigrok\-cli \-i \-P i2c,eeprom24xx" +.br + $ +.B "sigrok\-cli \-i \-P uart:baudrate=31250,midi" +.sp +When multiple +.BR -P +options are specified, each of them creates one decoder stack, which +executes in parallel to other decoder stacks. +.sp +Example: +.sp + $ +.B "sigrok\-cli \-i \-P uart:tx=D0:rx=D1 \-P timing:data=D2" +.sp .TP .BR "\-A, \-\-protocol\-decoder\-annotations " By default, only the stack's topmost protocol decoder's annotation output is -- 2.11.4.GIT