1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
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<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
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.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
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
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/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(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/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'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/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(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/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 \
129 .\" ========================================================================
131 .IX Title "Template::Stash::XS 3"
132 .TH Template::Stash::XS 3 "2009-04-07" "perl v5.8.7" "User Contributed Perl Documentation"
134 Template::Stash::XS \- High\-speed variable stash written in C
136 .IX Header "SYNOPSIS"
139 \& use Template::Stash::XS;
143 \& my $stash = Template::Stash::XS\->new(\e%vars);
144 \& my $tt2 = Template\->new({ STASH => $stash });
147 .IX Header "DESCRIPTION"
148 The Template:Stash::XS module is an implementation of the
149 Template::Stash written in C. The \*(L"\s-1XS\s0\*(R" in the name refers to Perl's
150 \&\s-1XS\s0 extension system for interfacing Perl to C code. It works just
151 like the regular Perl implementation of Template::Stash but runs about
154 The easiest way to use the \s-1XS\s0 stash is to configure the Template
155 Toolkit to use it by default. You can do this at installation time
156 (when you run \f(CW\*(C`perl Makefile.PL\*(C'\fR) by answering 'y' to the questions:
159 \& Do you want to build the XS Stash module? y
160 \& Do you want to use the XS Stash by default? y
163 See the \fI\s-1INSTALL\s0\fR file distributed with the Template Toolkit for further
164 details on installation.
166 If you don't elect to use the \s-1XS\s0 stash by default then you should use
167 the \f(CW\*(C`STASH\*(C'\fR configuration item when you create a new Template object.
168 This should reference an \s-1XS\s0 stash object that you have created
173 \& use Template::Stash::XS;
177 \& my $stash = Template::Stash::XS\->new(\e%vars);
178 \& my $tt2 = Template\->new({ STASH => $stash });
181 Alternately, you can set the \f(CW$Template::Config::STASH\fR package
186 \& use Template::Config;
190 \& $Template::Config::STASH = 'Template::Stash::XS';
194 \& my $tt2 = Template\->new();
197 The \s-1XS\s0 stash will then be automatically used.
199 If you want to use the \s-1XS\s0 stash by default and don't want to
200 re-install the Template Toolkit, then you can manually modify the
201 \&\f(CW\*(C`Template/Config.pm\*(C'\fR module near line 42 to read:
204 \& $STASH = 'Template::Stash::XS';
208 Please report bugs to the Template Toolkit mailing list
209 templates@template\-toolkit.org
212 Andy Wardley <abw@wardley.org> <http://wardley.org/>
214 Doug Steinwand <dsteinwand@citysearch.com>
216 .IX Header "COPYRIGHT"
217 Copyright (C) 1996\-2009 Andy Wardley. All Rights Reserved.
219 This module is free software; you can redistribute it and/or
220 modify it under the same terms as Perl itself.
222 .IX Header "SEE ALSO"