.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "libinn_clientlib 3"
.TH libinn_clientlib 3 2024-04-01 "INN 2.7.2" "InterNetNews Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
clientlib \- NNTP clientlib part of InterNetNews library
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    #include <inn/libinn.h>
\&
\&    extern FILE *ser_rd_fp;
\&    extern FILE *ser_wr_fp;
\&    extern char ser_line[];
\&
\&    extern char *getserverbyfile(char *file UNUSED);
\&    extern int server_init(char *host, int port);
\&    extern int handle_server_response(int response, char *host);
\&    extern void put_server(const char *text);
\&    extern int get_server(char *buff, int buffsize);
\&    extern void close_server(void);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The routines described in this manual page are part of the InterNetNews
library, libinn(3).  They are replacements for the \fIclientlib\fR part of
the NNTP distribution, and are intended to be used in building news clients.
.PP
The \fBgetserverbyfile\fR function retrieves the value of the \fIserver\fR parameter
in \fIinn.conf\fR (or the value of the \f(CW\*(C`NNTPSERVER\*(C'\fR environment variable if set)
as the name of the local NNTP server.  It returns a pointer to static space.
The \fIfile\fR parameter is ignored (\fIinn.conf\fR is forced).
.PP
The \fBserver_init\fR function opens a connection to the NNTP server at
the specified \fIhost\fR, in reader mode.  It returns the server's response
code or \f(CW\*(C`\-1\*(C'\fR on error.  If a connection was made, then \fIser_rd_fp\fR and
\&\fIser_wr_fp\fR can be used to read from and write to the server, respectively,
and \fIser_line\fR will contain the server's response (though you should use
the more convenient \fBput_server\fR and \fBget_server\fR functions instead).
.PP
The \fBhandle_server_response\fR function decodes the \fIresponse\fR code,
which comes from the server on \fIhost\fR.  If the client is authorized,
it returns \f(CW\*(C`0\*(C'\fR.  A client that is only allowed to read is authorized,
but \fBhandle_server_response\fR will print a message on the standard output.
If the client is not authorized to talk to the server, then a message is
printed and the routine returns \f(CW\*(C`\-1\*(C'\fR.
.PP
The \fBput_server\fR function sends \fItext\fR to the server, adding the necessary
NNTP line terminators, and flushing the I/O buffer.
.PP
The \fBget_server\fR function reads a line of text from the server into \fIbuff\fR,
reading at most \fIbuffsize\fR characters.  Any trailing \f(CW\*(C`\er\en\*(C'\fR terminators
are stripped off.  \fBget_server\fR returns \f(CW\*(C`\-1\*(C'\fR on error, \f(CW\*(C`0\*(C'\fR on success.
.PP
The \fBclose_server\fR function sends a \f(CW\*(C`QUIT\*(C'\fR command to the server and
closes the connection.
.SH HISTORY
.IX Header "HISTORY"
Written by Rich $alz <rsalz@uunet.uu.net> for InterNetNews.  Rewritten into
POD by Julien Elie.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
libinn(3).