.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "Agent::Tag::Priority 3pm"
.TH Agent::Tag::Priority 3pm "2016-09-17" "perl v5.22.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::Agent::Tag::Priority \- a log priority tag string
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& Not intended to be used directly
\& Inherits from Log::Agent::Tag.
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class represents a log priority tag string.
.SH "CREATION ROUTINE PARAMETERS"
.IX Header "CREATION ROUTINE PARAMETERS"
The following parameters are defined, in alphabetical order:
.ie n .IP """\-display"" => \fIstring\fR" 4
.el .IP "\f(CW\-display\fR => \fIstring\fR" 4
.IX Item "-display => string"
Specifies the priority/level string to display, with minimal variable
substitution.  For instance:
.Sp
.Vb 1
\& \-display => \*(Aq[$priority/$level]\*(Aq
.Ve
.Sp
The defined variables are documented in the \fB\s-1DISPLAY VARIABLES\s0\fR section
underneath.
.ie n .IP """\-level"" => \fIlevel\fR" 4
.el .IP "\f(CW\-level\fR => \fIlevel\fR" 4
.IX Item "-level => level"
This parameter is internally added by \f(CW\*(C`Log::Agent\*(C'\fR when computing the
priority tag, since only it knows the level of the current message.
.ie n .IP """\-postfix"" => \fIflag\fR" 4
.el .IP "\f(CW\-postfix\fR => \fIflag\fR" 4
.IX Item "-postfix => flag"
Whether tag should be placed after or before the log message.
By default, it is prepended to the log message, i.e. this parameter is false.
.ie n .IP """\-priority"" => \fIprio\fR" 4
.el .IP "\f(CW\-priority\fR => \fIprio\fR" 4
.IX Item "-priority => prio"
This parameter is internally added by \f(CW\*(C`Log::Agent\*(C'\fR when computing the
priority tag, since only it knows the priority of the current message.
.ie n .IP """\-separator"" => \fIstring\fR" 4
.el .IP "\f(CW\-separator\fR => \fIstring\fR" 4
.IX Item "-separator => string"
The separation string between the tag and the log message.
A single space by default.
.SH "DISPLAY VARIABLES"
.IX Header "DISPLAY VARIABLES"
The \f(CW\*(C`\-display\*(C'\fR switch understands a few variables that can be substituted
in the supplied string.  Both \f(CW$var\fR and \f(CW\*(C`${var}\*(C'\fR forms are supported.
Unknown variables are left untouched.
.ie n .IP "$priority" 4
.el .IP "\f(CW$priority\fR" 4
.IX Item "$priority"
The full priority name of the logged message, e.g. \*(L"warning\*(R" or \*(L"error\*(R".
.ie n .IP "$level" 4
.el .IP "\f(CW$level\fR" 4
.IX Item "$level"
The associated priority level of the logged message, a number.  For instance,
the level associated to \*(L"warning\*(R" is \f(CW4\fR.  See Log::Agent::Priorities
for the default name \-> level mapping.
.SH "AUTHOR"
.IX Header "AUTHOR"
Raphael Manfredi \fI<Raphael_Manfredi@pobox.com>\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fILog::Agent::Tag\fR\|(3), \fILog::Agent::Message\fR\|(3), \fILog::Agent::Priorities\fR\|(3).