.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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 "Log::Report::Extract::PerlPPI 3pm"
.TH Log::Report::Extract::PerlPPI 3pm "2011-08-23" "perl v5.14.2" "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"
Log::Report::Extract::PerlPPI \- Collect translatable strings from Perl using PPI
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\& my $ppi = Log::Report::Extract::PerlPPI\->new
\&  ( lexicon => \*(Aq/usr/share/locale\*(Aq
\&  );
\& $ppi\->process(\*(Aqlib/My/Pkg.pm\*(Aq);  # many times
\& $ppi\->showStats;   # to dispatchers which accept TRACE or INFO
\& $ppi\->write;       # also cleans processing memory.
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module helps maintaining the \s-1POT\s0 files, updating the list of
message-ids which are kept in them.  After initiation, the \fIprocess()\fR
method needs to be called with all files which changed since last processing
and the existing \s-1PO\s0 files will get updated accordingly.  If no translations
exist yet, one \f(CW\*(C`textdomain/xx.po\*(C'\fR file will be created.
.SH "METHODS"
.IX Header "METHODS"
.SS "Constructors"
.IX Subsection "Constructors"
.IP "Log::Report::Extract::PerlPPI\->\fBnew\fR(\s-1OPTIONS\s0)" 4
.IX Item "Log::Report::Extract::PerlPPI->new(OPTIONS)"
.Vb 3
\& \-Option \-\-Default
\&  charset  \*(Aqutf\-8\*(Aq
\&  lexicon  <required>
.Ve
.RS 4
.IP "charset => \s-1STRING\s0" 2
.IX Item "charset => STRING"
The character-set used in the \s-1PO\s0 files.
.IP "lexicon => \s-1DIRECTORY\s0" 2
.IX Item "lexicon => DIRECTORY"
The place where the lexicon is kept.  When no lexicon is defined yet,
this will be the directory where an \f(CW\*(C`domain/xx.po\*(C'\fR file will be created.
.RE
.RS 4
.RE
.SS "Accessors"
.IX Subsection "Accessors"
.ie n .IP "$obj\->\fBcharset\fR" 4
.el .IP "\f(CW$obj\fR\->\fBcharset\fR" 4
.IX Item "$obj->charset"
Returns the character-set used inside the \s-1POT\s0 files.
.ie n .IP "$obj\->\fBdomains\fR" 4
.el .IP "\f(CW$obj\fR\->\fBdomains\fR" 4
.IX Item "$obj->domains"
Returns a sorted list of all known domain names.
.ie n .IP "$obj\->\fBindex\fR" 4
.el .IP "\f(CW$obj\fR\->\fBindex\fR" 4
.IX Item "$obj->index"
Returns the Log::Report::Lexicon::Index object, which is listing
the files in the lexicon directory tree.
.SS "Processors"
.IX Subsection "Processors"
.ie n .IP "$obj\->\fBprocess\fR(\s-1FILENAME\s0, \s-1OPTIONS\s0)" 4
.el .IP "\f(CW$obj\fR\->\fBprocess\fR(\s-1FILENAME\s0, \s-1OPTIONS\s0)" 4
.IX Item "$obj->process(FILENAME, OPTIONS)"
Update the domains mentioned in the \s-1FILENAME\s0.  All textdomains defined
in the file will get updated automatically, but not written before
all files where processed.
.Sp
.Vb 2
\& \-Option \-\-Default
\&  charset  \*(Aqiso\-8859\-1\*(Aq
.Ve
.RS 4
.IP "charset => \s-1STRING\s0" 2
.IX Item "charset => STRING"
.RE
.RS 4
.RE
.PD 0
.ie n .IP "$obj\->\fBshowStats\fR([DOMAINs])" 4
.el .IP "\f(CW$obj\fR\->\fBshowStats\fR([DOMAINs])" 4
.IX Item "$obj->showStats([DOMAINs])"
.PD
Show a status about the \s-1DOMAIN\s0 (by default all domains).  At least mode
verbose is required to see this.
.ie n .IP "$obj\->\fBwrite\fR([\s-1DOMAIN\s0])" 4
.el .IP "\f(CW$obj\fR\->\fBwrite\fR([\s-1DOMAIN\s0])" 4
.IX Item "$obj->write([DOMAIN])"
Update the information of the files related to \s-1DOMAIN\s0, by default all
processed \s-1DOMAINS\s0.  All information known about the \s-1DOMAIN\s0 is removed
from the cache.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is part of Log-Report distribution version 0.94,
built on August 23, 2011. Website: \fIhttp://perl.overmeer.net/log\-report/\fR
.SH "LICENSE"
.IX Header "LICENSE"
Copyrights 2007\-2011 by Mark Overmeer. For other contributors see ChangeLog.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See \fIhttp://www.perl.com/perl/misc/Artistic.html\fR