[catagits/Gitalist.git] / local-lib5 / man / man3 / Config::General::Interpolated.3pm

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "General::Interpolated 3"
.TH General::Interpolated 3 "2009-07-19" "perl v5.8.7" "User Contributed Perl Documentation"
.SH "NAME"
Config::General::Interpolated \- Parse variables within Config files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\& use Config::General;
\& $conf = new Config::General(
\&    \-ConfigFile      => 'configfile',
\&    \-InterPolateVars => 1
\& );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is an internal module which makes it possible to interpolate
Perl style variables in your config file (i.e. \f(CW$variable\fR
or \f(CW\*(C`${variable}\*(C'\fR).
.PP
Normally you don't call it directly.
.SH "VARIABLES"
.IX Header "VARIABLES"
Variables can be defined everywhere in the config and can be used
afterwards as the value of an option. Variables cannot be used as
keys or as part of keys.
.PP
If you define a variable inside
a block or a named block then it is only visible within this block or
within blocks which are defined inside this block. Well \- let's take a
look to an example:
.PP
.Vb 14
\& # sample config which uses variables
\& basedir   = /opt/ora
\& user      = t_space
\& sys       = unix
\& <table intern>
\&     instance  = INTERN
\&     owner     = $user                 # "t_space"
\&     logdir    = $basedir/log          # "/opt/ora/log"
\&     sys       = macos
\&     <procs>
\&         misc1   = ${sys}_${instance}  # macos_INTERN
\&         misc2   = $user               # "t_space"
\&     </procs>
\& </table>
.Ve
.PP
This will result in the following structure:
.PP
.Vb 16
\& {
\&     'basedir' => '/opt/ora',
\&     'user'    => 't_space'
\&     'sys'     => 'unix',
\&     'table'   => {
\&          'intern' => {
\&                'sys'      => 'macos',
\&                'logdir'   => '/opt/ora/log',
\&                'instance' => 'INTERN',
\&                'owner' => 't_space',
\&                'procs' => {
\&                     'misc1' => 'macos_INTERN',
\&                     'misc2' => 't_space'
\&            }
\&         }
\&     }
.Ve
.PP
As you can see, the variable \fBsys\fR has been defined twice. Inside
the <procs> block a variable ${sys} has been used, which then were
interpolated into the value of \fBsys\fR defined inside the <table>
block, not the sys variable one level above. If sys were not defined
inside the <table> block then the \*(L"global\*(R" variable \fBsys\fR would have
been used instead with the value of \*(L"unix\*(R".
.PP
Variables inside double quotes will be interpolated, but variables
inside single quotes will \fBnot\fR interpolated. This is the same
behavior as you know of Perl itself.
.PP
In addition you can surround variable names with curly braces to
avoid misinterpretation by the parser.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Config::General
.SH "AUTHORS"
.IX Header "AUTHORS"
.Vb 3
\& Thomas Linden <tlinden |AT| cpan.org>
\& Autrijus Tang <autrijus@autrijus.org>
\& Wei\-Hon Chen <plasmaball@pchome.com.tw>
.Ve
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2001 by Wei-Hon Chen <plasmaball@pchome.com.tw>.
Copyright 2002\-2009 by Thomas Linden <tlinden |AT| cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See <http://www.perl.com/perl/misc/Artistic.html>
.SH "VERSION"
.IX Header "VERSION"
2.11
Commit	Line	Data
3fea05b9	1	.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
	2	.\"
	3	.\" Standard preamble:
	4	.\" ========================================================================
	5	.de Sh \" Subsection heading
	6	.br
	7	.if t .Sp
	8	.ne 5
	9	.PP
	10	\fB\\$1\fR
	11	.PP
	12	..
	13	.de Sp \" Vertical space (when we can't use .PP)
	14	.if t .sp .5v
	15	.if n .sp
	16	..
	17	.de Vb \" Begin verbatim text
	18	.ft CW
	19	.nf
	20	.ne \\$1
	21	..
	22	.de Ve \" End verbatim text
	23	.ft R
	24	.fi
	25	..
	26	.\" Set up some character translations and predefined strings. \*(-- will
	27	.\" give an unbreakable dash, \(PI will give pi, \(L" will give a left
	28	.\" double quote, and \*(R" will give a right double quote. \| will give a
	29	.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
	30	.\" do unbreakable dashes and therefore won't be available. \(C` and \(C'
	31	.\" expand to `' in nroff, nothing in troff, for use with C<>.
	32	.tr \(W-\|\(bv\(Tr
	33	.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
	34	.ie n \{\
	35	. ds -- \(*W-
	36	. ds PI pi
	37	. if (\n(.H=4u)&(1m=24u) .ds -- \(W\h'-12u'\(W\h'-12u'-\" diablo 10 pitch
	38	. if (\n(.H=4u)&(1m=20u) .ds -- \(W\h'-12u'\(W\h'-8u'-\" diablo 12 pitch
	39	. ds L" ""
	40	. ds R" ""
	41	. ds C` ""
	42	. ds C' ""
	43	'br\}
	44	.el\{\
	45	. ds -- \\|\(em\\|
	46	. ds PI \(*p
	47	. ds L" ``
	48	. ds R" ''
	49	'br\}
	50	.\"
	51	.\" If the F register is turned on, we'll generate index entries on stderr for
	52	.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
	53	.\" entries marked with X<> in POD. Of course, you'll have to process the
	54	.\" output yourself in some meaningful fashion.
	55	.if \nF \{\
	56	. de IX
	57	. tm Index:\\$1\t\\n%\t"\\$2"
	58	..
	59	. nr % 0
	60	. rr F
	61	.\}
	62	.\"
	63	.\" For nroff, turn off justification. Always turn off hyphenation; it makes
	64	.\" way too many mistakes in technical documents.
65	.hy 0
66	.if n .na
67	.\"
68	.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69	.\" Fear. Run. Save yourself. No user-serviceable parts.
70	. \" fudge factors for nroff and troff
71	.if n \{\
72	. ds #H 0
73	. ds #V .8m
74	. ds #F .3m
75	. ds #[ \f1
76	. ds #] \fP
77	.\}
78	.if t \{\
79	. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80	. ds #V .6m
81	. ds #F 0
82	. ds #[ \&
83	. ds #] \&
84	.\}
85	. \" simple accents for nroff and troff
86	.if n \{\
87	. ds ' \&
88	. ds ` \&
89	. ds ^ \&
90	. ds , \&
91	. ds ~ ~
92	. ds /
93	.\}
94	.if t \{\
95	. ds ' \\k:\h'-(\\n(.wu8/10-\(#H)'\'\h"\|\\n:u"
96	. ds ` \\k:\h'-(\\n(.wu8/10-\(#H)'\`\h'\|\\n:u'
97	. ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'^\h'\|\\n:u'
98	. ds , \\k:\h'-(\\n(.wu*8/10)',\h'\|\\n:u'
99	. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'\|\\n:u'
100	. ds / \\k:\h'-(\\n(.wu8/10-\(#H)'\z\(sl\h'\|\\n:u'
101	.\}
102	. \" troff and (daisy-wheel) nroff accents
103	.ds : \\k:\h'-(\\n(.wu8/10-\(#H+.1m+\(#F)'\v'-\(#V'\z.\h'.2m+\(#F'.\h'\|\\n:u'\v'\(#V'
104	.ds 8 \h'\(#H'\(b\h'-\*(#H'
105	.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\(#H)/2u'\v'-.3n'\(#[\z\(de\v'.3n'\h'\|\\n:u'\*(#]
106	.ds d- \h'\(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\(#H'
107	.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'\|\\n:u'
108	.ds th \(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u2/3)'\s-1o\s+1\*(#]
109	.ds Th \(#[\s+2I\s-2\h'-\w'I'u3/5'\v'-.3m'o\v'.3m'\*(#]
110	.ds ae a\h'-(\w'a'u*4/10)'e
111	.ds Ae A\h'-(\w'A'u*4/10)'E
112	. \" corrections for vroff
113	.if v .ds ~ \\k:\h'-(\\n(.wu9/10-\(#H)'\s-2\u~\d\s+2\h'\|\\n:u'
114	.if v .ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'\v'-.4m'^\v'.4m'\h'\|\\n:u'
115	. \" for low resolution devices (crt and lpr)
116	.if \n(.H>23 .if \n(.V>19 \
117	\{\
118	. ds : e
119	. ds 8 ss
120	. ds o a
121	. ds d- d\h'-1'\(ga
122	. ds D- D\h'-1'\(hy
123	. ds th \o'bp'
124	. ds Th \o'LP'
125	. ds ae ae
126	. ds Ae AE
127	.\}
128	.rm #[ #] #H #V #F C
129	.\" ========================================================================
130	.\"
131	.IX Title "General::Interpolated 3"
132	.TH General::Interpolated 3 "2009-07-19" "perl v5.8.7" "User Contributed Perl Documentation"
133	.SH "NAME"
134	Config::General::Interpolated \- Parse variables within Config files
135	.SH "SYNOPSIS"
136	.IX Header "SYNOPSIS"
137	.Vb 5
138	\& use Config::General;
139	\& $conf = new Config::General(
140	\& \-ConfigFile => 'configfile',
141	\& \-InterPolateVars => 1
142	\& );
143	.Ve
144	.SH "DESCRIPTION"
145	.IX Header "DESCRIPTION"
146	This is an internal module which makes it possible to interpolate
147	Perl style variables in your config file (i.e. \f(CW$variable\fR
148	or \f(CW\(C`${variable}\(C'\fR).
149	.PP
150	Normally you don't call it directly.
151	.SH "VARIABLES"
152	.IX Header "VARIABLES"
153	Variables can be defined everywhere in the config and can be used
154	afterwards as the value of an option. Variables cannot be used as
155	keys or as part of keys.
156	.PP
157	If you define a variable inside
158	a block or a named block then it is only visible within this block or
159	within blocks which are defined inside this block. Well \- let's take a
160	look to an example:
161	.PP
162	.Vb 14
163	\& # sample config which uses variables
164	\& basedir = /opt/ora
165	\& user = t_space
166	\& sys = unix
167	\& <table intern>
168	\& instance = INTERN
169	\& owner = $user # "t_space"
170	\& logdir = $basedir/log # "/opt/ora/log"
171	\& sys = macos
172	\& <procs>
173	\& misc1 = ${sys}_${instance} # macos_INTERN
174	\& misc2 = $user # "t_space"
175	\& </procs>
176	\& </table>
177	.Ve
178	.PP
179	This will result in the following structure:
180	.PP
181	.Vb 16
182	\& {
183	\& 'basedir' => '/opt/ora',
184	\& 'user' => 't_space'
185	\& 'sys' => 'unix',
186	\& 'table' => {
187	\& 'intern' => {
188	\& 'sys' => 'macos',
189	\& 'logdir' => '/opt/ora/log',
190	\& 'instance' => 'INTERN',
191	\& 'owner' => 't_space',
192	\& 'procs' => {
193	\& 'misc1' => 'macos_INTERN',
194	\& 'misc2' => 't_space'
195	\& }
196	\& }
197	\& }
198	.Ve
199	.PP
200	As you can see, the variable \fBsys\fR has been defined twice. Inside
201	the <procs> block a variable ${sys} has been used, which then were
202	interpolated into the value of \fBsys\fR defined inside the <table>
203	block, not the sys variable one level above. If sys were not defined
204	inside the <table> block then the \(L"global\(R" variable \fBsys\fR would have
205	been used instead with the value of \(L"unix\(R".
206	.PP
207	Variables inside double quotes will be interpolated, but variables
208	inside single quotes will \fBnot\fR interpolated. This is the same
209	behavior as you know of Perl itself.
210	.PP
211	In addition you can surround variable names with curly braces to
212	avoid misinterpretation by the parser.
213	.SH "SEE ALSO"
214	.IX Header "SEE ALSO"
215	Config::General
216	.SH "AUTHORS"
217	.IX Header "AUTHORS"
218	.Vb 3
219	\& Thomas Linden <tlinden \|AT\| cpan.org>
220	\& Autrijus Tang <autrijus@autrijus.org>
221	\& Wei\-Hon Chen <plasmaball@pchome.com.tw>
222	.Ve
223	.SH "COPYRIGHT"
224	.IX Header "COPYRIGHT"
225	Copyright 2001 by Wei-Hon Chen <plasmaball@pchome.com.tw>.
226	Copyright 2002\-2009 by Thomas Linden <tlinden \|AT\| cpan.org>.
227	.PP
228	This program is free software; you can redistribute it and/or
229	modify it under the same terms as Perl itself.
230	.PP
231	See <http://www.perl.com/perl/misc/Artistic.html>
232	.SH "VERSION"
233	.IX Header "VERSION"
234	2.11