config::model::describe(3pm) [debian man page]

Config::Model::Describe(3pm)				User Contributed Perl Documentation			      Config::Model::Describe(3pm)

NAME

       Config::Model::Describe - Provide a description of a node element

VERSION

       version 2.021

SYNOPSIS

	use Config::Model;
	use Log::Log4perl qw(:easy);
	Log::Log4perl->easy_init($WARN);

	# define configuration tree object
	my $model = Config::Model->new;
	 $model->create_config_class(
	   name    => "Foo",
	   element => [
	       [qw/foo bar/] => {
		   type       => 'leaf',
		   value_type => 'string'
	       },
	   ]
	);
	$model ->create_config_class (
	   name => "MyClass",

	   element => [

	       [qw/foo bar/] => {
		   type       => 'leaf',
		   value_type => 'string'
	       },
	       hash_of_nodes => {
		   type       => 'hash',     # hash id
		   index_type => 'string',
		   cargo      => {
		       type		 => 'node',
		       config_class_name => 'Foo'
		   },
	       },
	   ],
	) ;

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

	my $root = $inst->config_root ;

	# put data
	my $step = 'foo=FOO hash_of_nodes:fr foo=bonjour -
	  hash_of_nodes:en foo=hello ';
	$root->load( step => $step );

	print $root->describe ;

	### prints
	# name	       value	    type	 comment
	# foo	       FOO	    string
	# bar	       [undef]	    string
	# hash_of_nodes <Foo>	     node hash	  keys: "en" "fr"

DESCRIPTION

       This module is used directly by Config::Model::Node to describe a node element. This module returns a human readable string that shows the
       content of a configuration node.

       For instance (as shown by "fstab" example:

	name	     value	  type	       comment
	fs_spec      [undef]	  string       mandatory
	fs_vfstype   [undef]	  enum	       choice: auto davfs ext2 ext3 swap proc iso9660 vfat ignore, mandatory
	fs_file      [undef]	  string       mandatory
	fs_freq      0		  boolean
	fs_passno    0		  integer

       This module is also used by the "ll" command of Config::Model::TermUI.

CONSTRUCTOR

   new ( )
       No parameter. The constructor should be used only by Config::Model::Node.

Methods
   describe(...)
       Return a description string.

       Parameters are:

       node
	   Reference to a Config::Model::Node object. Mandatory

       element
	   Describe only this element from the node. Optional. All elements are described if omitted.

AUTHOR

       Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO

       Config::Model,Config::Model::Node,Config::Model::ObjTreeScanner

perl v5.14.2							    2012-11-09					      Config::Model::Describe(3pm)

Check Out this Related Man Page

Config::Model::Backend::ShellVar(3pm)			User Contributed Perl Documentation		     Config::Model::Backend::ShellVar(3pm)

NAME

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

VERSION

       version 2.021

SYNOPSIS

	use Config::Model;
	use Log::Log4perl qw(:easy);
	Log::Log4perl->easy_init($WARN);

	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 will contain
       'a','b'.

CONSTRUCTOR

   new ( node => $node_obj, name => 'shellvar' ) ;
       Inherited from Config::Model::Backend::Any. The constructor will be called by Config::Model::AutoRead.

   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 this case, "read()" will return 0.

       When a file is read,  "read()" will return 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()" will return 1.

AUTHOR

       Dominique Dumont, (ddumont at cpan dot org)

SEE ALSO

       Config::Model, Config::Model::AutoRead, Config::Model::Backend::Any,

perl v5.14.2							    2012-11-09				     Config::Model::Backend::ShellVar(3pm)

Linux and UNIX Man Pages

config::model::describe(3pm) [debian man page]

Check Out this Related Man Page