.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Config::Model::Describe 3pm"
.TH Config::Model::Describe 3pm "2014-09-24" "perl v5.20.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Config::Model::Describe \- Provide a description of a node element
.SH "VERSION"
.IX Header "VERSION"
version 2.061
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& 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       => \*(Aqleaf\*(Aq,
\&            value_type => \*(Aqstring\*(Aq
\&        },
\&    ]
\& );
\& $model \->create_config_class (
\&    name => "MyClass",
\&
\&    element => [
\&
\&        [qw/foo bar/] => {
\&            type       => \*(Aqleaf\*(Aq,
\&            value_type => \*(Aqstring\*(Aq
\&        },
\&        hash_of_nodes => {
\&            type       => \*(Aqhash\*(Aq,     # hash id
\&            index_type => \*(Aqstring\*(Aq,
\&            cargo      => {
\&                type              => \*(Aqnode\*(Aq,
\&                config_class_name => \*(AqFoo\*(Aq
\&            },
\&        },
\&    ],
\& ) ;
\&
\& my $inst = $model\->instance(root_class_name => \*(AqMyClass\*(Aq );
\&
\& my $root = $inst\->config_root ;
\&
\& # put data
\& my $step = \*(Aqfoo=FOO hash_of_nodes:fr foo=bonjour \-
\&   hash_of_nodes:en foo=hello \*(Aq;
\& $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"
.Ve
.SH "DESCRIPTION"
.IX Header "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.
.PP
For instance (as shown by \f(CW\*(C`fstab\*(C'\fR example:
.PP
.Vb 6
\& 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
.Ve
.PP
This module is also used by the \f(CW\*(C`ll\*(C'\fR command of Config::Model::TermUI.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.SS "new ( )"
.IX Subsection "new ( )"
No parameter. The constructor should be used only by
Config::Model::Node.
.SH "Methods"
.IX Header "Methods"
.SS "describe(...)"
.IX Subsection "describe(...)"
Return a description string.
.PP
Parameters are:
.IP "node" 4
.IX Item "node"
Reference to a Config::Model::Node object. Mandatory
.IP "element" 4
.IX Item "element"
Describe only this element from the node. Optional. All elements are
described if omitted.
.IP "pattern" 4
.IX Item "pattern"
Describe the element matching the regexp ref. Example:
.Sp
.Vb 1
\& describe => ( pattern => qr/^foo/ )
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Dominique Dumont, (ddumont at cpan dot org)
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Config::Model,Config::Model::Node,Config::Model::ObjTreeScanner
.SH "AUTHOR"
.IX Header "AUTHOR"
Dominique Dumont
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2014 by Dominique Dumont.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The GNU Lesser General Public License, Version 2.1, February 1999
.Ve