NAME

INN::SM - Perl extension to use the storage API of InterNetNews.

SYNOPSIS

  use INN::SM;

DESCRIPTION

INN::SM provides a perl interface to the storage manager of InterNetNews.

Version 0.16 is provided as a gzipped tarball.
INN::SM::read_inn_conf
The contents of inn.conf are read, and assigned to corresponding variables in inn:: package. Further the version number (say x.y.z) of INN is stored in the variable inn::inn_version after translating it into the integer x*10000+y*100+z.

INN::SM::open_overview
Overview database is opened for succeeding use. Under INN 2.3.x, this subroutine allways fails, and generates a warning message.

INN::SM::read_overview token
Overview data associated with the token is returned. Under INN 2.3.x, this subroutine allways fails, and generates a warning message.

INN::SM::close_overview
Overview database is closed. Under INN 2.3.x, this subroutine allways fails, and generates warning message.

INN::SM::delete_articles token, [token ...]
The articles associated with tokens are deleted.

INN::SM::sm_init [boolean]
The storage manager is initialized. If boolean is given and true value, read/write open mode is enabled, which is required for INN::SM::delete_articles to work.

INN::SM::read_article token
The raw content of the article associated with the token is returned.

INN::SM::open_article token
The article associated with the token is opened. The pointer to a data structure for reading the article is returned. Under INN 2.3.x, this subroutine allways fails, and generates a warning message.

INN::SM::read_artline pointer
pointer must be the return value of INN::SM::open_article. The contents of next line (including the trailing newline) of the associated article, is returned. Under INN 2.3.x, this subroutine allways fails, and generates a warning message.

INN::SM::close_article pointer
pointer must be the return value of INN::SM::open_article. The pointer is discarded. Under INN 2.3.x, this subroutine allways fails, and generates a warning message.

INN::SM::sm_shutdown
The storage manager is shut down.

AUTHOR

Kiyokazu SUTO <suto@merry.xmath.ous.ac.jp> stole most codes from frontends/sm.c in the source tree of InterNetNews (inn-STABLE_2_2-1999-06-03_03-01.tar.gz and inn-BETA-20000505.tar.gz) and rearranged them for use in Perl programs.

SEE ALSO

innd(8), sm(8), libstorage(3), perl(1).

Any questions or comments about this page are greatly appreciated.

Almost all contents in this site are written by Kiyokazu SUTO (i.e. me) unless especially noted. I want to put all of them into the PUBLIC DOMAIN, even though some lawyers mention that it is impossible in my country.