diff Doc/lib/libtelnetlib.tex @ 19760:96da985cde98 legacy-trunk

Patch #416079: fix the debug string output when receiving telnet commands. added all the telnet options known to arpa/telnet.h added all the options registered with IANA as of today added the possibility for the user to have it's own option negotiation callback
author Martin v. Löwis <martin@v.loewis.de>
date Thu, 06 Sep 2001 08:51:38 +0000
parents c1e413ef9817
children bc02c3b09626
line wrap: on
line diff
--- a/Doc/lib/libtelnetlib.tex	Thu Sep 06 08:24:40 2001 +0000
+++ b/Doc/lib/libtelnetlib.tex	Thu Sep 06 08:51:38 2001 +0000
@@ -9,7 +9,12 @@
 
 The \module{telnetlib} module provides a \class{Telnet} class that
 implements the Telnet protocol.  See \rfc{854} for details about the
-protocol.
+protocol. In addition, it provides symbolic constants for the protocol
+characters (IAC/DONT/DO/WONT/WILL), and for the telnet options. The
+symbolic names of the telnet options follow the definitions in
+\code{arpa/telnet.h}, with the leading \code{TELOPT_} removed. For
+symbolic names of options which are traditionally not included in
+\code{arpa/telnet.h}, see the module source itself.
 
 
 \begin{classdesc}{Telnet}{\optional{host\optional{, port}}}
@@ -158,6 +163,13 @@
 results are indeterministic, and may depend on the I/O timing.
 \end{methoddesc}
 
+\begin{methoddesc}{set_option_negotiation_callback}{callback}
+Each time a telnet option is read on the input flow, this
+\var{callback} (if set) is called with the following parameters :
+callback(telnet socket, command (DO/DONT/WILL/WONT), option).  No other
+action is done afterwards by telnetlib.
+\end{methoddesc}
+
 
 \subsection{Telnet Example \label{telnet-example}}
 \sectionauthor{Peter Funk}{pf@artcom-gmbh.de}