man pages for telnet-client, telnet-chatd, and telnet-proxy

This commit is contained in:
Sean Middleditch 2009-11-02 16:19:16 -08:00
parent e67d3eadf2
commit b34236e099
4 changed files with 50 additions and 1 deletions

View File

@ -2,7 +2,9 @@ pkgconfigdir = $(libdir)/pkgconfig
pkgconfig_DATA = libtelnet.pc
dist_man_MANS = libtelnet.3 telnet_init.3 telnet_free.3 telnet_send.3 \
telnet_recv.3 telnet_iac.3 telnet_negotiate.3
telnet_recv.3 telnet_iac.3 telnet_negotiate.3 telnet_printf.3 \
telnet_raw_printf.3 telnet_being_compress2.3 \
telnet-proxy.1 telnet-client.1 telnet-chatd.1
libtelnet_includedir = $(includedir)
libtelnet_include_HEADERS = libtelnet.h

15
telnet-chatd.1 Normal file
View File

@ -0,0 +1,15 @@
.TH telnet-chatd 1 LIBTELNET "" "TELNET Library"
.SH NAME
telnet-chatd \- simplistic TELNET chat server
.SH SYNOPSIS
\fBtelnet-chatd\fR <\fBlisten port\fR>
.SH DESCRIPTION
\fBtelnet-chatd\fR is an extremely simplistic TELNET chat server. It is designed primarily as a test for TELNET clients and proxies.
It is not recommended to use \fBtelnet-chatd\fR in any kind of production capacity.
.SH SEE ALSO
\fBtelnet-client\fR(1), \fBtelnet-proxy\fR(1), \fBtelnet\fR(1)

15
telnet-client.1 Normal file
View File

@ -0,0 +1,15 @@
.TH telnet-client 1 LIBTELNET "" "TELNET Library"
.SH NAME
telnet-client \- simplistic TELNET client
.SH SYNOPSIS
\fBtelnet-client\fR <\fBremote address\fR> <\fBremote port\fR>
.SH DESCRIPTION
\fBtelnet-client\fR is an extremely simplistic TELNET client, designed solely as a test of libtelnet functionality and for testing simple TELNET servers or proxies.
\fBtelnet-client\fR should not be used for real work.
.SH SEE ALSO
\fBtelnet-chatd\fR(1), \fBtelnet-proxy\fR(1), \fBtelnet\fR(1)

17
telnet-proxy.1 Normal file
View File

@ -0,0 +1,17 @@
.TH telnet-proxy 1 LIBTELNET "" "TELNET Library"
.SH NAME
telnet-proxy \- create a TELNET debugging proxy
.SH SYNOPSIS
\fBtelnet-proxy\fR <\fBremote address\fR> <\fBremote port\fR> <\fBlocal port\fR>
.SH DESCRIPTION
\fBtelnet-proxy\fR creates a single-connection proxy listening on \fIlocal port\fR which forwards connections to \fIremote address\fR on port \fIremote port\fR. All TELNET commands will be logged to \fBstdout\fR for debugging purposes.
Only a single active connection is allowed at any given time. However, after a client has disconnected, another client may connect through the proxy.
\fBtelnet-proxy\fR is capable of transparently decoding and reencoding streams compressed with MCCP2. It also includes specialized decoders and debug output for NEW-ENVIRON, TTYPE, ZMP, and MSSP subnegotiation commands.
.SH SEE ALSO
\fBtelnet-chatd\fR(1), \fBtelnet-client\fR(1), \fBtelnet\fR(1)