.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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 >0, 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Rex::Config 3pm"
.TH Rex::Config 3pm "2018-02-01" "perl v5.26.1" "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"
Rex::Config \- Handles the configuration.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module holds all configuration parameters for Rex.
.PP
With this module you can specify own configuration parameters for your modules.
.SH "EXPORTED METHODS"
.IX Header "EXPORTED METHODS"
.ie n .SS "register_set_handler($handler_name, $code)"
.el .SS "register_set_handler($handler_name, \f(CW$code\fP)"
.IX Subsection "register_set_handler($handler_name, $code)"
Register a handler that gets called by \fIset\fR.
.PP
.Vb 4
\& Rex::Config\->register_set_handler("foo", sub {
\&   my ($value) = @_;
\&   print "The user set foo \-> $value\en";
\& });
.Ve
.PP
And now you can use this handler in your \fIRexfile\fR like this:
.PP
.Vb 1
\& set foo => "bar";
.Ve
.ie n .SS "register_config_handler($topic, $code)"
.el .SS "register_config_handler($topic, \f(CW$code\fP)"
.IX Subsection "register_config_handler($topic, $code)"
With this function it is possible to register own sections in the users config file ($HOME/.rex/config.yml).
.PP
Example:
.PP
.Vb 4
\& Rex::Config\->register_config_handler("foo", sub {
\&  my ($param) = @_;
\&  print "bar is: " . $param\->{bar} . "\en";
\& });
.Ve
.PP
And now the user can set this in his configuration file:
.PP
.Vb 5
\& base:
\&   user: theuser
\&   password: thepassw0rd
\& foo:
\&   bar: baz
.Ve