NAME
Rsync::Config::Renderer
VERSION
0.1
DESCRIPTION
Rsync::Config::Renderer is used as a base class for Rsync::Config::Atom and Rsync::Config::Module.
SYNOPSIS
use Rsync::Config::Renderer;
use base qw(Rsync::Config::Renderer);SUBROUTINES/METHODS
new()
Class contructor. Accepts a options hash as a parameter. The hash can contain the following options:
The indent option is used as a multiplicator. This means that if you set indent to 3 and indent_char to q{ }, indent_string will be ' ' (3 spaces).
indent($new_indent)
If $new_indent is undefined, this method will return the current indent value. If $new_indent is defined, the new value is set and $self is returned. This method can be used only in a class instance.
indent_char($new_indent_char)
If $new_indent_char is undefined, this method will return the current indent char value. If $new_indent_char is defined, the new value is set and $self is returned. This method can be used only in a class instance.
indent_string($indent, $indent_char)
Returns a string with the current indentation. If $indent and $indent_char are defined, they have higher precedence over the internal values. This method can also be called as a function.
DEPENDENCIES
Rsync::Config::Renderer depends on the following modules:
DIAGNOSTICS
All tests are located in the t directory .
PERL CRITIC
This module is perl critic level 1 compliant.
CONFIGURATION AND ENVIRONMENT
This module does not use any configuration files or environment variables. The used modules however may use such things. Please refer to each module man page for more information.
INCOMPATIBILITIES
None known to the author
BUGS AND LIMITATIONS
No bugs known to the author
SEE ALSO
Rsync::Config::Exceptions Rsync::Config::Module Rsync::Config::Atom Rsync::Config
AUTHOR
Subredu Manuel <diablo@packages.ro>
LICENSE AND COPYRIGHT
Copyright (C) 2006 Subredu Manuel. All Rights Reserved. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The LICENSE file contains the full text of the license.