.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" 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 "Locale::XGettext::Util::Flag 3pm"
.TH Locale::XGettext::Util::Flag 3pm "2023-02-05" "perl v5.36.0" "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"
Locale::XGettext::Util::Flag \- A Flag Specification Used By xgettext
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Locale::XGettext::Util::Flag;
\&
\&    $keyword = Locale::XGettext::Flag\->new(function => \*(Aq_\|_x\*(Aq,
\&                                           arg => 1,
\&                                           flag => \*(Aqperl\-brace\-format\*(Aq,
\&                                           no => 0,
\&                                           pass => 0);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The module encapsulates a keflagyword specification for xgettext like
string extractors.  It is only interesting for authors of extractors
based on Locale::XGettext.
.SH "CONSTRUCTORS"
.IX Header "CONSTRUCTORS"
.IP "\fBnew \s-1ARGS\s0\fR" 4
.IX Item "new ARGS"
Creates a new flag definition.  \fB\s-1ARGS\s0\fR must be a has (or a sequence of
key-value pairs) with the following items:
.RS 4
.IP "\fBfunction\fR" 8
.IX Item "function"
The name of the function resp. keyword.  This is mandatory.
.IP "\fBarg\fR" 8
.IX Item "arg"
An integer \fBN\fR greater than 0 for the argument number.
.IP "\fBflag\fR" 8
.IX Item "flag"
The name of the flag to be applied, for example \*(L"perl-brace-format\*(R"
or \*(L"no-perl-brace-format\*(R".  A possible prefix of \*(L"no\-\*(R" or \*(L"pass\-\*(R"
is stripped off and interpreted accordingly but only if \*(L"pass\*(R" or
\&\*(L"no\*(R" were not explicitly specified.
.IP "\fBno\fR" 8
.IX Item "no"
The entry should be marked with \*(L"no-FLAG\*(R" instead of \*(L"\s-1FLAG\*(R".\s0
.IP "\fBpass\fR" 8
.IX Item "pass"
As if \*(L"pass-FLAG\*(R" had been specified on the command-line.  This is
ignored by Locale::XGettext.
.RE
.RS 4
.RE
.IP "\fBnewFromString \s-1COMMAND_LINE_ARG\s0\fR" 4
.IX Item "newFromString COMMAND_LINE_ARG"
\&\fB\s-1COMMAND_LINE_ARG\s0\fR has the same semantcis as the argument to
\&\*(L"\-\-flag\*(R" of \fBxgettext\fR\|(1).  Note that a prefix of \*(L"pass\-\*(R" is
ignored by Locale::XGettext!
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBfunction\fR" 4
.IX Item "function"
Get the function name for the keyword.
.IP "\fBarg\fR" 4
.IX Item "arg"
Get the position of the argument.
.IP "\fBflag\fR" 4
.IX Item "flag"
The flag (for example \*(L"perl-brace-format\*(R", \*(L"c\-format\*(R", etc.)
.IP "\fBno\fR" 4
.IX Item "no"
True if entry should be marked as \*(L"no-FLAG\*(R".
.IP "\fBpass\fR" 4
.IX Item "pass"
True if flag was preceded by \*(L"pass\-\*(R".  Ignored by Locale::XGettext.
.IP "\fBdump\fR" 4
.IX Item "dump"
Dump the flag definition into a string suitable for an argument
to the xgettext option '\-\-flag'.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2016\-2017 Guido Flohr <guido.flohr@cantanea.com>,
all rights reserved.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Locale::XGettext, \fBxgettext\fR\|(1), \fBperl\fR\|(1)