.\" Automatically generated by Pod::Man 4.14 (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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "libinn_clientlib 3" .TH libinn_clientlib 3 "2022-07-10" "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 \& \& 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, \fBlibinn\fR\|(3). They are replacements for the \fIclientlib\fR part of the \s-1NNTP\s0 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 \s-1NNTP\s0 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 \s-1NNTP\s0 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(CW0\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 \&\s-1NNTP\s0 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(CW0\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 \f(CW$alz\fR for InterNetNews. Rewritten into \&\s-1POD\s0 by Julien Elie. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBlibinn\fR\|(3).