David Cantrell > App-Rsnapshot-1.999_00002 > App::Rsnapshot::Config

Download:
App-Rsnapshot-1.999_00002.tar.gz

Dependencies

Annotate this POD

Module Version: 1.0   Source  

NAME ^

App::Rsnapshot::Config - parse the config file; OO interface to read it

SYNOPSIS ^

    my $config = App::Rsnapshot::Config->new('/etc/rsnapshot.conf');

    ...

    my $rsync = $config->externalprograms()->rsync();
    my $rsyncbinary = $rsync->binary();
    my $rsyncargs   = [
        $rsync->shortargs()->values(),
        $srync->longargs()->values()
    ];

DESCRIPTION ^

Parses an XML config file, and provides a nice objecty interface to get at information in it. Note that it does only minimal verification of the XML schema or anything like that.

METHODS ^

new

Constructor, takes a filename (with path) and returns an App::Rsnapshot::Config::Node object representing the root of the XML document tree.

BUGS/WARNINGS/LIMITATIONS ^

This uses App::Rsnapshot::XML::Tiny, so is subject to all of its bugs and foibles. Bug reports are most welcome.

SOURCE CODE REPOSITORY ^

http://www.cantrell.org.uk/cgit/cgit.cgi/rsnapshot-ng/

AUTHOR, COPYRIGHT and LICENCE ^

Copyright 2009 David Cantrell <david@cantrell.org.uk>

This software is free-as-in-speech software, and may be used, distributed, and modified under the terms of either the GNU General Public Licence version 2 or the Artistic Licence. It's up to you which one you use. The full text of the licences can be found in the files GPL2.txt and ARTISTIC.txt, respectively.

CONSPIRACY ^

This module is also free-as-in-mason software.

syntax highlighting: