aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSean Middleditch <sean@middleditch.us>2009-11-02 16:19:16 -0800
committerSean Middleditch <sean@middleditch.us>2009-11-02 16:19:16 -0800
commitb34236e099f5d741f8901f6bfe27591c7cbc98d2 (patch)
treed247ac7ec1e3a666300731d387d9910e04902125
parente67d3eadf2dbf75289f5d71970cd330d2c68bb98 (diff)
man pages for telnet-client, telnet-chatd, and telnet-proxy
-rw-r--r--Makefile.am4
-rw-r--r--telnet-chatd.115
-rw-r--r--telnet-client.115
-rw-r--r--telnet-proxy.117
4 files changed, 50 insertions, 1 deletions
diff --git a/Makefile.am b/Makefile.am
index 193ecf8..4957c63 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -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
diff --git a/telnet-chatd.1 b/telnet-chatd.1
new file mode 100644
index 0000000..014a1e4
--- /dev/null
+++ b/telnet-chatd.1
@@ -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)
diff --git a/telnet-client.1 b/telnet-client.1
new file mode 100644
index 0000000..8f6e954
--- /dev/null
+++ b/telnet-client.1
@@ -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)
diff --git a/telnet-proxy.1 b/telnet-proxy.1
new file mode 100644
index 0000000..8768f78
--- /dev/null
+++ b/telnet-proxy.1
@@ -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)