Config::Model::Describe(3pm)

1Config::Model::DescribeU(s3e)r Contributed Perl DocumentaCtoinofnig::Model::Describe(3)
2
3
4

NAME

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

VERSION

9       version 1.205
10

SYNOPSIS

12        use Config::Model ;
13
14        # create your config model
15        my $model = Config::Model -> new ;
16        $model->create_config_class( ... ) ;
17
18        # create instance
19        my $inst = $model->instance (root_class_name => 'FooBar',
20                                     instance_name => 'test1');
21
22        # create root of config
23        my $root = $inst -> config_root ;
24
25        print $root->describe ;
26
27        # or
28
29        print $root->describe(element => 'foo' ) ;
30

DESCRIPTION

32       This module is used directly by Config::Model::Node to describe a node
33       element. This module returns a human readable string that shows the
34       content of a configuration node.
35
36       For instance (as showns by "fstab" example:
37
38        name         value        type         comment
39        fs_spec      [undef]      string       mandatory
40        fs_vfstype   [undef]      enum         choice: auto davfs ext2 ext3 swap proc iso9660 vfat ignore, mandatory
41        fs_file      [undef]      string       mandatory
42        fs_freq      0            boolean
43        fs_passno    0            integer
44
45       This module is also used by the "ll" command of Config::Model::TermUI.
46

CONSTRUCTOR

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

Methods

53   describe(...)
54       Return a description string.
55
56       Parameters are:
57
58       node
59           Reference to a Config::Model::Node object. Mandatory
60
61       element
62           Describe only this element from the node. Optional. All elements
63           are described if omitted.
64

AUTHOR

66       Dominique Dumont, (ddumont at cpan dot org)
67