Config::Model::Backend::ShellVar (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Config::Model::Backend::ShellVar.3pm".)

NAME

Config::Model::Backend::ShellVar - Read and write config as a "SHELLVAR" data structure

VERSION

version 2.106

SYNOPSIS

 use Config::Model;

 my $model = Config::Model->new;
 $model->create_config_class (
    name    => "MyClass",
    element => [ 
        [qw/foo bar/] => {qw/type leaf value_type string/}
    ],

   read_config  => [
        { 
            backend => 'ShellVar',
            config_dir => '/tmp',
            file  => 'foo.conf',
            auto_create => 1,
        }
    ],
 );

 my $inst = $model->instance(root_class_name => 'MyClass' );
 my $root = $inst->config_root ;

 $root->load('foo=FOO1 bar=BAR1' );

 $inst->write_back ;

File "foo.conf" now contains:

 ## This file was written by Config::Model
 ## You may modify the content of this file. Configuration 
 ## modifications will be preserved. Modifications in
 ## comments may be mangled.
 ##
 foo="FOO1"

 bar="BAR1"

DESCRIPTION

This module is used directly by Config::Model to read or write the content of a configuration tree written with "SHELLVAR" syntax in "Config::Model" configuration tree.

Note that undefined values are skipped for list element. I.e. if a list element contains "('a',undef,'b')", the data structure contains 'a','b'.

CONSTRUCTOR

new ( node => $node_obj, name => 'shellvar' ) ;

Inherited from Config::Model::Backend::Any. The constructor is called by Config::Model::BackendMgr.

read ( io_handle => ... )

Of all parameters passed to this read call-back, only "io_handle" is used. This parameter must be IO::File object already opened for read.

It can also be undef. In which case "read()" returns 0.

When a file is read, "read()" returns 1.

write ( io_handle => ... )

Of all parameters passed to this write call-back, only "io_handle" is used. This parameter must be IO::File object already opened for write.

"write()" returns 1.

AUTHOR

Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO

Config::Model, Config::Model::BackendMgr, Config::Model::Backend::Any,

AUTHOR

Dominique Dumont

COPYRIGHT AND LICENSE

This software is Copyright (c) 2005-2017 by Dominique Dumont.

This is free software, licensed under:

  The GNU Lesser General Public License, Version 2.1, February 1999