Add built local::lib
[catagits/Gitalist.git] / local-lib5 / man / man3 / Template::Timer.3pm
diff --git a/local-lib5/man/man3/Template::Timer.3pm b/local-lib5/man/man3/Template::Timer.3pm
new file mode 100644 (file)
index 0000000..ff8c1fb
--- /dev/null
@@ -0,0 +1,205 @@
+.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
+.\"
+.\" 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" ''
+'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.
+.ie \nF \{\
+.    de IX
+.    tm Index:\\$1\t\\n%\t"\\$2"
+..
+.    nr % 0
+.    rr F
+.\}
+.el \{\
+.    de IX
+..
+.\}
+.\"
+.\" 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 "Timer 3"
+.TH Timer 3 "2009-03-07" "perl v5.8.7" "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"
+Template::Timer \- Rudimentary profiling for Template Toolkit
+.SH "VERSION"
+.IX Header "VERSION"
+Version 1.00
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+Template::Timer provides inline timings of the template processing
+througout your code.  It's an overridden version of Template::Context
+that wraps the \f(CW\*(C`process()\*(C'\fR and \f(CW\*(C`include()\*(C'\fR methods.
+.PP
+Using Template::Timer is simple.
+.PP
+.Vb 1
+\&    use Template::Timer;
+\&
+\&    my %config = ( # Whatever your config is
+\&        INCLUDE_PATH    => \*(Aq/my/template/path\*(Aq,
+\&        COMPILE_EXT     => \*(Aq.ttc\*(Aq,
+\&        COMPILE_DIR     => \*(Aq/tmp/tt\*(Aq,
+\&    );
+\&
+\&    if ( $development_mode ) {
+\&        $config{ CONTEXT } = Template::Timer\->new( %config );
+\&    }
+\&
+\&    my $template = Template\->new( \e%config );
+.Ve
+.PP
+Now when you process templates, \s-1HTML\s0 comments will get embedded in your
+output, which you can easily grep for.  The nesting level is also shown.
+.PP
+.Vb 5
+\&    <!\-\- TIMER START: L1 process mainmenu/mainmenu.ttml \-\->
+\&    <!\-\- TIMER START: L2 include mainmenu/cssindex.tt \-\->
+\&    <!\-\- TIMER START: L3 process mainmenu/cssindex.tt \-\->
+\&    <!\-\- TIMER END:   L3 process mainmenu/cssindex.tt (17.279 ms) \-\->
+\&    <!\-\- TIMER END:   L2 include mainmenu/cssindex.tt (17.401 ms) \-\->
+\&
+\&    ....
+\&
+\&    <!\-\- TIMER END:   L3 process mainmenu/footer.tt (3.016 ms) \-\->
+\&    <!\-\- TIMER END:   L2 include mainmenu/footer.tt (3.104 ms) \-\->
+\&    <!\-\- TIMER END:   L1 process mainmenu/mainmenu.ttml (400.409 ms) \-\->
+.Ve
+.PP
+Note that since \s-1INCLUDE\s0 is a wrapper around \s-1PROCESS\s0, calls to INCLUDEs
+will be doubled up, and slightly longer than the \s-1PROCESS\s0 call.
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+Andy Lester, \f(CW\*(C`<andy at petdance.com>\*(C'\fR
+.SH "BUGS"
+.IX Header "BUGS"
+Please report any bugs or feature requests to
+\&\f(CW\*(C`bug\-template\-timer at rt.cpan.org\*(C'\fR, or through the web interface at
+<http://rt.cpan.org>.  I will be notified, and then you'll automatically
+be notified of progress on your bug as I make changes.
+.SH "ACKNOWLEDGEMENTS"
+.IX Header "ACKNOWLEDGEMENTS"
+Thanks to
+Randal Schwartz,
+Bill Moseley,
+and to Gavin Estey for the original code.
+.SH "COPYRIGHT & LICENSE"
+.IX Header "COPYRIGHT & LICENSE"
+This library is free software; you can redistribute it and/or modify
+it under the terms of either the \s-1GNU\s0 Public License v3, or the Artistic
+License 2.0.
+.PP
+.Vb 1
+\&    * http://www.gnu.org/copyleft/gpl.html
+\&
+\&    * http://www.opensource.org/licenses/artistic\-license\-2.0.php
+.Ve