.\" 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
.    \}
.\}
.\"
.\" 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 "Dist::Zilla::Role::PotFile 3pm"
.TH Dist::Zilla::Role::PotFile 3pm "2018-07-08" "perl v5.26.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"
.IX Header "Name"
Dist::Zilla::Plugin::PotFile \- Something finds or creates a gettext language translation template file
.SH "Synopsis"
.IX Header "Synopsis"
.Vb 1
\&  with \*(AqDist::Zilla::Role::PotFile\*(Aq;
\&
\&  # ...
\&
\&  sub execute {
\&      my $self = shift;
\&      my $pot_file = $self\->pot_file(%params);
\&  }
.Ve
.SH "Description"
.IX Header "Description"
This role provides a utility method for finding or creating a
\&\s-1GNU\s0 gettext <http://www.gnu.org/software/gettext/>\-style language translation
template.
.SS "Instance Methods"
.IX Subsection "Instance Methods"
\fI\f(CI\*(C`pot_file\*(C'\fI\fR
.IX Subsection "pot_file"
.PP
.Vb 1
\&  $self\->pot_file(%params);
.Ve
.PP
Finds or creates a temporary
\&\s-1GNU\s0 gettext <http://www.gnu.org/software/gettext/>\-style language translation
file. It works in this order:
.IP "\(bu" 4
If the \f(CW\*(C`pot_file\*(C'\fR parameter is passed a value and the named file exists, it
will be returned.
.IP "\(bu" 4
If the file stored in the language directory, as specified for the
\&\f(CW\*(C`LocaleTextDomain\*(C'\fR plugin, with the
name of the distribution and ending in \fI.pot\fR, it will be returned. This is
the default location for a template file created by the
\&\f(CW\*(C`msg\-scan\*(C'\fR command.
.IP "\(bu" 4
The sources will be scanned for localizable strings and a temporary template
file created. This file will automatically be deleted at program exit.
.PP
The supported parameters are:
.ie n .IP """pot_file""" 4
.el .IP "\f(CWpot_file\fR" 4
.IX Item "pot_file"
A path to an existing translation template file. If this file does not exist,
an exception will be thrown.
.ie n .IP """xgettext""" 4
.el .IP "\f(CWxgettext\fR" 4
.IX Item "xgettext"
Path to the \f(CW\*(C`xgettext\*(C'\fR application. Defaults to just \f(CW\*(C`xgettext\*(C'\fR
(\f(CW\*(C`xgettext.exe\*(C'\fR on Windows), which should work if it's in your path.
.ie n .IP """encoding""" 4
.el .IP "\f(CWencoding\fR" 4
.IX Item "encoding"
Encoding to assume when scanning for localizable strings. Defaults to
\&\f(CW\*(C`UTF\-8\*(C'\fR.
.ie n .IP """copyright_holder""" 4
.el .IP "\f(CWcopyright_holder\fR" 4
.IX Item "copyright_holder"
The name of the translation copyright holder. Defaults to the copyright holder
configured for Dist::Zilla.
.ie n .IP """bugs_email""" 4
.el .IP "\f(CWbugs_email\fR" 4
.IX Item "bugs_email"
Email address for reporting translation bugs. Defaults to the email address of
the first author known to Dist::Zilla, if available and parseable by
Email::Address::XS.
.SH "Author"
.IX Header "Author"
David E. Wheeler <david@justatheory.com>
.SH "Contributor"
.IX Header "Contributor"
Charles McGarvey <ccm@cpan.org>
.SH "Copyright and License"
.IX Header "Copyright and License"
This software is copyright (c) 2012\-2017 by David E. Wheeler.
.PP
This is free software; you can redistribute it and/or modify it under the same
terms as the Perl 5 programming language system itself.