@@ -45,8 +45,8 @@ The CLI utility ``telnetlib3-client`` is provided for connecting to servers and
4545``telnetlib3-server `` for hosting a server.
4646
4747Both tools accept the argument ``--shell=my_module.fn_shell `` describing a python module path to a
48- function of signature ``async def shell(reader, writer) ``. The server also provides `` --pty-exec ``
49- argument to host stand-alone programs.
48+ function of signature ``async def shell(reader, writer) ``. The server also provides a
49+ `` --pty-exec `` argument allowing it to act as a telnet server for any CLI/TUI programs.
5050
5151::
5252
@@ -59,7 +59,7 @@ argument to host stand-alone programs.
5959 # automatic script communicates with a server
6060 telnetlib3-client --shell bin.client_wargame.shell 1984.ws 666
6161
62- # run a server bound with the default shell bound to 127.0.0.1 6023
62+ # run a default shell server bound to 127.0.0.1 6023
6363 telnetlib3-server
6464
6565 # or custom ip, port and shell
@@ -112,6 +112,22 @@ connected to a TCP socket without any telnet negotiation may require "raw" mode
112112
113113 telnetlib3-client --raw-mode area52.tk 5200 --encoding=atascii
114114
115+ Go-Ahead (GA)
116+ ~~~~~~~~~~~~~
117+
118+ When a client does not negotiate Suppress Go-Ahead (SGA), the server sends
119+ ``IAC GA `` after output to signal that the client may transmit. This is
120+ correct behavior for MUD clients like Mudlet that expect prompt detection
121+ via GA.
122+
123+ If GA causes unwanted output for your use case, disable it::
124+
125+ telnetlib3-server --never-send-ga
126+
127+ For PTY shells, GA is sent after 500ms of output idle time to avoid
128+ injecting GA in the middle of streaming output.
129+
130+
115131Asyncio Protocol
116132----------------
117133
@@ -139,8 +155,10 @@ To migrate code, change import statements:
139155 # NEW imports:
140156 import telnetlib3
141157
142- This library *also * provides an additional client (and server) API through a similar interface but
143- offering more advanced negotiation features and options. See `sync API documentation `_ for more.
158+ ``telnetlib3 `` did not provide server support, while this library also provides
159+ both client and server support through a similar Blocking API interface.
160+
161+ See `sync API documentation `_ for details.
144162
145163Quick Example
146164=============
0 commit comments