From e67d3eadf2dbf75289f5d71970cd330d2c68bb98 Mon Sep 17 00:00:00 2001
From: Sean Middleditch <sean@middleditch.us>
Date: Mon, 2 Nov 2009 16:04:47 -0800
Subject: more man pages

---
 telnet_begin_compress2.3 | 20 ++++++++++++++++++++
 telnet_printf.3          | 22 ++++++++++++++++++++++
 telnet_raw_printf.3      | 22 ++++++++++++++++++++++
 3 files changed, 64 insertions(+)
 create mode 100644 telnet_begin_compress2.3
 create mode 100644 telnet_printf.3
 create mode 100644 telnet_raw_printf.3

diff --git a/telnet_begin_compress2.3 b/telnet_begin_compress2.3
new file mode 100644
index 0000000..7f701ae
--- /dev/null
+++ b/telnet_begin_compress2.3
@@ -0,0 +1,20 @@
+.TH telnet_begin_compress2 3 LIBTELNET "" "TELNET Library"
+
+.SH NAME
+\fBtelnet_begin_compress2\fP - begin sending compressed data via MCCP2
+
+.SH SYNOPSIS
+.PP
+\fB#include <libtelnet.h>\fP
+.sp
+.B "void telnet_begin_compress2(telnet_t *\fBtelnet\fR);"
+
+.SH DESCRIPTION
+.PP
+The \fBtelnet_begin_compress2\fI function will enable the sending of compressed data using the MCCP2 protocol.  Before enabling the sending of compressed data, libtelnet will first attempt negotiation of the MCCP2 feature.
+
+The parameter \fItelnet\fP is a state tracker instance created by a prior call to \fBtelnet_init\fP.
+
+.SH SEE ALSO
+.PP
+\fBlibtelnet\fR(3)
diff --git a/telnet_printf.3 b/telnet_printf.3
new file mode 100644
index 0000000..db9b25e
--- /dev/null
+++ b/telnet_printf.3
@@ -0,0 +1,22 @@
+.TH telnet_printf 3 LIBTELNET "" "TELNET Library"
+
+.SH NAME
+\fBtelnet_printf\fP - send formatted text
+
+.SH SYNOPSIS
+.PP
+\fB#include <libtelnet.h>\fP
+.sp
+.B "void telnet_printf(telnet_t *\fBtelnet\fR, unsigned char \fBcmd\fR, unsigned char \fIopt\fR);"
+
+.SH DESCRIPTION
+.PP
+The \fBtelnet_printf\fP function sends formatted data across the connection.  Formatting is the same as in \fBprint\fP(3), and the result is sent to \fBtelnet_send\fP.  Note in particular that this means that the data sent by \fBtelnet_printf\fP is escaped..
+
+The parameter \fItelnet\fP is a state tracker instance created by a prior call to \fBtelnet_init\fP.
+
+The parameter \fIfmt\fP is a format string, as used by \fBprintf\fP.
+
+.SH SEE ALSO
+.PP
+\fBlibtelnet\fR(3), \fBtelnet_send\fR(3), \fBtelnet_raw_printf\fR(3)
diff --git a/telnet_raw_printf.3 b/telnet_raw_printf.3
new file mode 100644
index 0000000..a0044b8
--- /dev/null
+++ b/telnet_raw_printf.3
@@ -0,0 +1,22 @@
+.TH telnet_raw_printf 3 LIBTELNET "" "TELNET Library"
+
+.SH NAME
+\fBtelnet_raw_printf\fP - send formatted text without TELNET escaping
+
+.SH SYNOPSIS
+.PP
+\fB#include <libtelnet.h>\fP
+.sp
+.B "void telnet_raw_printf(telnet_t *\fBtelnet\fR, unsigned char \fBcmd\fR, unsigned char \fIopt\fR);"
+
+.SH DESCRIPTION
+.PP
+The \fBtelnet_raw_printf\fP function sends formatted data across the connection.  Formatting is the same as in \fBprint\fP(3), and the result is passed on through a SEND callback event with no further processing.  Note in particular that this means that data send by \fBtelnet_raw_printf\fP is not escaped.
+
+The parameter \fItelnet\fP is a state tracker instance created by a prior call to \fBtelnet_init\fP.
+
+The parameter \fIfmt\fP is a format string, as used by \fBprintf\fP.
+
+.SH SEE ALSO
+.PP
+\fBlibtelnet\fR(3), \fBtelnet_send\fR(3), \fBtelnet_printf\fR(3)
-- 
cgit v1.2.3