mirror of https://gerrit.osmocom.org/libtelnet
initial man pages, bump to 0.13
This commit is contained in:
parent
8739165d93
commit
eccc4a4bfe
|
@ -1,6 +1,8 @@
|
|||
pkgconfigdir = $(libdir)/pkgconfig
|
||||
pkgconfig_DATA = libtelnet.pc
|
||||
|
||||
dist_man_MANS = libtelnet.3 telnet_init.3 telnet_free.3
|
||||
|
||||
libtelnet_includedir = $(includedir)
|
||||
libtelnet_include_HEADERS = libtelnet.h
|
||||
|
||||
|
|
4
NEWS
4
NEWS
|
@ -1,3 +1,7 @@
|
|||
Version 0.13
|
||||
============
|
||||
* added basic man pages
|
||||
|
||||
Version 0.12
|
||||
============
|
||||
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
AC_INIT([libtelnet], [0.12], [http://github.com/elanthis/libtelnet/tree/master])
|
||||
AC_INIT([libtelnet], [0.13], [http://github.com/elanthis/libtelnet/tree/master])
|
||||
|
||||
AM_INIT_AUTOMAKE
|
||||
|
||||
|
|
|
@ -0,0 +1,41 @@
|
|||
.TH libtelnet 3 LIBTELNET "" "TELNET Library"
|
||||
|
||||
.SH NAME
|
||||
\fBlibtelnet\fP - TELNET protocol processing library
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fB#include <libtelnet.h>\fP
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
\fBlibtelnet\fP is a library for handling the TELNET protocol. It includes
|
||||
routines for parsing incoming data from a remote peer as well as formatting
|
||||
data to send to the remote peer.
|
||||
|
||||
\fBlibtelnet\fP uses a callback-oriented API, allowing application-specific
|
||||
handling of various events. The callback system is also used for buffering
|
||||
outgoing protocol data, allowing the application to maintain control over the
|
||||
actual socket connection.
|
||||
|
||||
Features supported include the full TELNET protocol, Q-method option
|
||||
negotiation, ZMP, MCCP2, MSSP, and NEW-ENVIRON.
|
||||
|
||||
.SH CONFORMS TO
|
||||
.PP
|
||||
RFC854 - http://www.faqs.org/rfcs/rfc854.html
|
||||
.br
|
||||
RFC855 - http://www.faqs.org/rfcs/rfc855.html
|
||||
.br
|
||||
RFC1091 - http://www.faqs.org/rfcs/rfc1091.html
|
||||
.br
|
||||
RFC1143 - http://www.faqs.org/rfcs/rfc1143.html
|
||||
.br
|
||||
RFC1408 - http://www.faqs.org/rfcs/rfc1408.html
|
||||
.br
|
||||
RFC1572 - http://www.faqs.org/rfcs/rfc1572.html
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBtelnet_init\fR(3), \fBtelnet_free\fR(3), \fBtelnet_send\fR,
|
||||
\fBtelnet_recv\fR
|
|
@ -0,0 +1,19 @@
|
|||
.TH telnet_init 3 LIBTELNET "" "TELNET Library"
|
||||
|
||||
.SH NAME
|
||||
\fBtelnet_free\fP - release resources for TELNET state tracker
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fB#include <libtelnet.h>\fP
|
||||
.sp
|
||||
.B "void telnet_free( telnet_t *\fItelnet\fP );"
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
The \fBtelnet_free\fP function deallocates resources associated with a prior
|
||||
call to \fBtelnet_init\fP.
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBlibtelnet\fR(3), \fBtelnet_init\fR(3)
|
|
@ -0,0 +1,41 @@
|
|||
.TH telnet_init 3 LIBTELNET "" "TELNET Library"
|
||||
|
||||
.SH NAME
|
||||
\fBtelnet_init\fP - initialize a new TELNET connection processor
|
||||
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\fB#include <libtelnet.h>\fP
|
||||
.sp
|
||||
.B "telnet_t *telnet_init( const telnet_telopt_t *\fItelopts\fP, telnet_event_handler_t \fIeh\fP, unsigned char \fIflags\fP, void *\fIuser_data\fP );"
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
The \fBtelnet_init\fP function initializes a new TELNET connection processor
|
||||
and returns a pointer to the state tracker.
|
||||
|
||||
The parameter \fItelopts\fP is an array of telnet_telopt_t structures, which
|
||||
defines the list of TELNET options your application supports. This array must
|
||||
include a final entry with all structure element set to 0 to indicate the end
|
||||
of the array.
|
||||
|
||||
The parameter \fIeh\fP is a pointer to a function to handle all events
|
||||
generated by the TELNET processor.
|
||||
|
||||
The parameter \fIflags\fP is a set of flags controlling libtelnet's behavior.
|
||||
|
||||
The paramater \fIuser_data\fP is an opaque pointer that will be passed to
|
||||
the \fIeh\fP function when called.
|
||||
|
||||
.SH RETURN VALUES
|
||||
.PP
|
||||
The return value is a pointer to the libtelnet state tracker, which must be
|
||||
passed to all other libtelnet functions regarding this connection. If
|
||||
\fBtelnet_init\fP fails for any reason, it will return NULL instead.
|
||||
|
||||
This value must be passed to \fBtelnet_free\fP after the connection is closed
|
||||
to free resources used internally by libtelnet.
|
||||
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\fBlibtelnet\fR(3), \fBtelnet_free\fR(3)
|
Loading…
Reference in New Issue