.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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 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.
.\"
.\" 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 "MooseX::App::Meta::Role::Attribute::Option 3pm"
.TH MooseX::App::Meta::Role::Attribute::Option 3pm "2014-08-24" "perl v5.20.1" "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"
MooseX::App::Meta::Role::Attribute::Option \- Meta attribute role for options
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This meta attribute role will automatically be applied to all attributes
that should be used as options.
.SH "ACCESSORS"
.IX Header "ACCESSORS"
In your app and command classes you can
use the following attributes in option or parameter definitions.
.PP
.Vb 11
\& option \*(Aqmyoption\*(Aq => (
\&     is                 => \*(Aqrw\*(Aq,
\&     isa                => \*(AqArrayRef[Str]\*(Aq,
\&     documentation      => \*(AqMy special option\*(Aq,
\&     cmd_flag           => \*(Aqmyopt\*(Aq,
\&     cmd_aliases        => [qw(mopt localopt)],
\&     cmd_tags           => [qw(Important!)],
\&     cmd_env            => \*(AqMY_OPTION\*(Aq,
\&     cmd_position       => 1,
\&     cmd_split          => qr/,/,
\& );
.Ve
.SS "cmd_flag"
.IX Subsection "cmd_flag"
Use this name instead of the attribute name as the option name
.SS "cmd_type"
.IX Subsection "cmd_type"
Option to mark if this attribute should be used as an option or parameter value.
.PP
Allowed values are:
.IP "\(bu" 4
option \- Command line option
.IP "\(bu" 4
proto \- Command line option that should be processed prior to other
options (eg. a config-file option that sets other attribues) Usually only 
used for plugin developmemt
.IP "\(bu" 4
parameter \- Positional parameter command line value
.SS "cmd_env"
.IX Subsection "cmd_env"
Environment variable name (only uppercase letters, numeric and underscores
allowed). If variable was not specified otherwise the value will be
taken from \f(CW%ENV\fR.
.SS "cmd_aliases"
.IX Subsection "cmd_aliases"
Arrayref of alternative option names
.SS "cmd_tags"
.IX Subsection "cmd_tags"
Extra option tags displayed in the usage information (in brackets)
.SS "cmd_position"
.IX Subsection "cmd_position"
Override the order of the parameters in the usage message.
.SS "cmd_split"
.IX Subsection "cmd_split"
Splits multiple values at the given separator string or regular expression. 
Only works in conjunction with an 'ArrayRef[*]' type constraint (isa).
.SH "METHODS"
.IX Header "METHODS"
These methods are only of interest to plugin authors.
.SS "cmd_name_possible"
.IX Subsection "cmd_name_possible"
.Vb 1
\& my @names = $attribute\->cmd_name_possible();
.Ve
.PP
Returns a list of all possible option names.
.SS "cmd_name_primary"
.IX Subsection "cmd_name_primary"
.Vb 1
\& my $name = $attribute\->cmd_name_primary();
.Ve
.PP
Returns the primary option name
.SS "cmd_usage_name"
.IX Subsection "cmd_usage_name"
.Vb 1
\& my $name = $attribute\->cmd_usage_name();
.Ve
.PP
Returns the name as used by the usage text
.SS "cmd_usage_description"
.IX Subsection "cmd_usage_description"
.Vb 1
\& my $name = $attribute\->cmd_usage_description();
.Ve
.PP
Returns the description as used by the usage text
.SS "cmd_tags_list"
.IX Subsection "cmd_tags_list"
.Vb 1
\& my @tags = $attribute\->cmd_tags_list();
.Ve
.PP
Returns a list of tags
.SS "cmd_is_bool"
.IX Subsection "cmd_is_bool"
.Vb 1
\& my $bool = $attribute\->cmd_is_bool();
.Ve
.PP
Returns true, false or undef depending on the type constraint and default
of the attribute:
.IP "\(bu" 4
undef: Does not have a boolean type constraint
.IP "\(bu" 4
true: Has a boolean type constraint
.IP "\(bu" 4
false: Has a boolean type constraint, and a true default value
.SS "cmd_type_constraint_check"
.IX Subsection "cmd_type_constraint_check"
.Vb 1
\& $attribute\->cmd_type_constraint_check($value)
.Ve
.PP
Checks the type constraint. Returns an error message if the check fails
.SS "cmd_type_constraint_description"
.IX Subsection "cmd_type_constraint_description"
.Vb 1
\& $attribute\->cmd_type_constraint_description($type_constraint,$singular)
.Ve
.PP
Creates a description of the selected type constraint.