summaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
authorcliechti <cliechti@f19166aa-fa4f-0410-85c2-fa1106f25c8a>2009-08-10 23:59:27 +0000
committercliechti <cliechti@f19166aa-fa4f-0410-85c2-fa1106f25c8a>2009-08-10 23:59:27 +0000
commit181a22550658cb4654d1ff84c0f579b0fe360dc8 (patch)
treef511895019a1fd3caf4069df01905598562f1495 /documentation
parenta7710696a2ec4abe12bd5658189841592ab0c6c1 (diff)
downloadpyserial-181a22550658cb4654d1ff84c0f579b0fe360dc8.tar.gz
minor doc updates
git-svn-id: http://svn.code.sf.net/p/pyserial/code/trunk/pyserial@336 f19166aa-fa4f-0410-85c2-fa1106f25c8a
Diffstat (limited to 'documentation')
-rw-r--r--documentation/examples.rst9
-rw-r--r--documentation/pyserial.rst2
2 files changed, 5 insertions, 6 deletions
diff --git a/documentation/examples.rst b/documentation/examples.rst
index f6d69d8..429f86a 100644
--- a/documentation/examples.rst
+++ b/documentation/examples.rst
@@ -163,21 +163,20 @@ tcp_serial_redirect.py_
.. _tcp_serial_redirect.py: http://pyserial.svn.sourceforge.net/viewvc/*checkout*/pyserial/trunk/pyserial/examples/tcp_serial_redirect.py
-Single port TCP/IP - serial bridge (RFC 2217)
+Single-port TCP/IP - serial bridge (RFC 2217)
=============================================
Simple cross platform :rfc:`2217` serial port server. It uses threads and is
portable (runs on POSIX, Windows, etc).
-- The port settings and control lines (RTS/DTR) can changed at any time using
- :rfc:`2217` requests. The status lines (DSR/CTS/RI/CD) are polled every
+- The port settings and control lines (RTS/DTR) can be changed at any time
+ using :rfc:`2217` requests. The status lines (DSR/CTS/RI/CD) are polled every
second and notifications are sent to the client.
- Telnet character IAC (0xff) needs to be doubled in data stream. IAC followed
by an other value is interpreted as Telnet command sequence.
- Telnet negotiation commands are sent when connecting to the server.
- RTS/DTR are activated on client connect and deactivated on disconnect.
- Default port settings are set again when client disconnects.
-- modem status lines (CTS/DSR/RI/CD) are polled periodically and the server
- automatically sends NOTIFY_MODEMSTATE events.
+
::
Usage: rfc2217_server.py [options] port
diff --git a/documentation/pyserial.rst b/documentation/pyserial.rst
index 4e936d1..0bc6522 100644
--- a/documentation/pyserial.rst
+++ b/documentation/pyserial.rst
@@ -40,7 +40,7 @@ Features
translation etc. (which are many times enabled for POSIX.) This makes this
module universally useful.
- Compatible with :mod:`io` library (Python 2.6+)
-- RFC2217 client (experimental)
+- RFC 2217 client (experimental), server provided in the examples.
Requirements