summaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
authorChris Liechti <cliechti@gmx.net>2016-12-08 18:23:03 +0100
committerChris Liechti <cliechti@gmx.net>2016-12-08 18:23:03 +0100
commitd8af918473df1d0c0b0867aadd1c731531091ffa (patch)
tree4ec9f8750b8cab04ce35fb1e3e666bc8fbe96220 /documentation
parentcab3dabc81ecbf010d81ff38433db99c1f6d667c (diff)
downloadpyserial-git-d8af918473df1d0c0b0867aadd1c731531091ffa.tar.gz
docs: add an other example for spy://
Diffstat (limited to 'documentation')
-rw-r--r--documentation/url_handlers.rst11
1 files changed, 10 insertions, 1 deletions
diff --git a/documentation/url_handlers.rst b/documentation/url_handlers.rst
index 81e6ff8..a425bb5 100644
--- a/documentation/url_handlers.rst
+++ b/documentation/url_handlers.rst
@@ -197,6 +197,15 @@ Outputs::
000002.284 RX 00F0 F0 F1 F2 F3 F4 F5 F6 F7 F8 F9 FA FB FC FD FE FF ................
000002.284 BRK send_break 0.25
+An other example, on POSIX, open a second terminal window and find out it's
+device (e.g. with the ``ps`` command in the TTY column), assumed to be
+``/dev/pts/2`` here, double quotes are used so that the ampersand in the URL is
+not interpreted by the shell::
+
+ python -m serial.tools.miniterm "spy:///dev/ttyUSB0?file=/dev/pts/2&color" 115200
+
+The spy output will be live in the second terminal window.
+
.. versionadded:: 3.0
@@ -204,7 +213,7 @@ Outputs::
==========
This handler allows to select alternate implementations of the native serial port.
-Currently only the Posix platform provides alternative implementations.
+Currently only the POSIX platform provides alternative implementations.
``PosixPollSerial``
Poll based read implementation. Not all systems support poll properly.