Manuel Subredu > Rsync-Config-0.3.1 > Rsync::Config

Download:
Rsync-Config-0.3.1.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.3.1   Source  

NAME ^

Rsync::Config - rsync configuration generator

VERSION ^

0.3.1

DESCRIPTION ^

Rsync::Config is a module who can be used to create rsync configuration files. A configuration file (from Rsync::Config point of view) is made by atoms and modules with atoms. A atom is the smallest piece from the configuration file. This module inherits from Rsync::Config::Module .

INHERITANCE ^

Objects from Rsync::Config inherits as in the next scheme

                         /--- Rsync::Config::Module --- Rsync::Config
 Rsync::Config::Renderer 
                         \--- Rsync::Config::Blank
                               /  \
        Rsync::Config::Atom ---    --- Rsync::Config::Comment

SYNOPSIS ^

 use Rsync::Config;
 use Rsync::Config::Atom;
 use Rsync::Config::Module;

 sub main {
   my ($conf, $module);

   $conf = new Rsync::Config();
   $conf->add_comment('Main configuration file for our rsync daemon');
   $conf->add_atom('read only','yes');
   $conf->add_atom('chroot','yes');

   $module = new Rsync::Config::Module(name => 'cpan');
   $module->add_atom('path','/var/ftp/pub/mirrors/ftp.cpan.org/');
   $module->add_atom('comment', 'CPAN mirror');

   $conf->add_module($module);
   $conf->to_file('/etc/rsyncd.conf');
 }

SUBROUTINES/METHODS ^

new(%opt)

The class contructor.

add_module_obj($module)

Adds the $module (a instance of Rsync::Config::Module) to the internal list of modules. Returns the $module object.

add_module($module_name)

Add a new module name $module_name to the internal list of modules. Returns the newly created object.

modules()

In scalar context, the number of existing modules is returned. In list context a array with all modules is returned.

modules_no()

Returns the current number of modules.

module_exists($module_name)

Search trough the list of modules and check if a module with name $module_name exists. Returns the corresponding object or undef (if a module with the specified name does not exists)

to_string()

Returns the string representation for this configuration file.

to_file($filename)

Writes the configuration into the file specified by $filename.

If the file already exists, the content of that file will be lost.

DEPENDENCIES ^

Scalar::Util, English, Exception::Class, CLASS.

DIAGNOSTICS ^

Invalid call: not an object !

Self-explanatory

Invalid call: not an module object !

Occurs when the parameter is not a instance of Rsync::Config::Module

Already have a module named ...

Occurs when one is trying to add a module with a name that already exists

Missing filename!

Occurs when filename was not specified.

Cannot open ...

Occurs when the file could not be created

CONFIGURATION AND ENVIRONMENT ^

This module does not use any configuration files or environment variables.

INCOMPATIBILITIES ^

None known to the author

BUGS AND LIMITATIONS ^

None known to the author

SEE ALSO ^

Rsync::Config::Module, Rsync::Config::Atom, Rsync::Config::Blank, Rsync::Config::Comment, Rsync::Config::Renderer.

AUTHOR ^

Manuel SUBREDU <diablo@packages.ro>.

LICENSE AND COPYRIGHT ^

Copyright (c) 2006, Manuel SUBREDU <diablo@packages.ro>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: