XMLTV::Supplement man page

XMLTV::Supplement — Supplementary file loader for XMLTV grabbers

Description

Utility library that loads supplementary files for xmltv-grabbers and other programs in the xmltv-distribution.

Supplementary files can be loaded either via http or from a local file, depending on the configuration of the module. The default is to load the files from http://supplement.xmltv.org. This can be changed by setting the environment variable XMLTV_SUPPLEMENT to the new root-directory or root-url for supplementary files.

Exported Functions

All these functions are exported on demand.

GetSupplement

Load a supplement file and return it as a string. Takes two parameters: directory and filename.

my $content = GetSupplement( 'tv_grab_uk_rt', 'channel_ids' );

GetSupplement will always return a string with the content. If it fails to get the content, it prints an error-message and aborts the program.

GetSupplementLines

Load a supplement file and return it as an array. Any comments or blank lines will be removed. Takes two parameters: directory and filename.

my $content = GetSupplementLines( 'tv_grab_uk_rt', 'channel_ids' );

GetSupplementLines will always return an array with the content. If it fails to get the content, it prints an error-message and aborts the program.

GetSupplementFile
Get the supplement file from the local machine
GetSupplementUrl
Get the supplement file from a URL
GetSupplementDir
Get the base directory containing supplementary files.
e.g. $ENV{HOME}/.xmltv/supplement
SetSupplementRoot

Set the root directory for loading supplementary files.

SetSupplementRoot( '/usr/share/xmltv' );
SetSupplementRoot( 'http://my.server.org/xmltv' );
GetSupplementRoot
Get the root directory for loading supplementary files.

Caching

The module stores all downloaded files in a cache. The cache is stored on disk in ~/.xmltv/supplement on Unix and in CSIDL_LOCAL_APPDATA//xmltv/supplement on Windows.

If a file has been downloaded less than 1 hour ago, the file from the cache is used without contacting the server. Otherwise, if the file has been downloaded more than 1 hour ago, then the module checks with the server to see if an updated file is available and downloads it if necessary.

If the server does not respond or returns an error-message, a warning is printed to STDERR and the file from the cache is used.

Environment Variables

The XMLTV_SUPPLEMENT environment variable can be used to tell the module where the supplementary files are found.

XMLTV_SUPPLEMENT=/usr/share/xmltv
XMLTV_SUPPLEMENT=http://supplementary.xmltv.se

The XMLTV_SUPPLEMENT_VERBOSE environment variable can be used to get more debug output from XMLTV::Supplement.

XMLTV_SUPPLEMENT_VERBOSE=1

Info

2016-09-30 perl v5.24.0 User Contributed Perl Documentation