.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" 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 "action 3pm"
.TH action 3pm "2009-04-21" "perl v5.10.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"
OpaL::action \- Perl extension for easier handling of what information that
should be presented when a action is made.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use OpaL::action qw(functionnames);
.Ve
.PP
No functions or variables are exported automaticly so you have to specify
them here.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
OpaL::action is a module to allow some better bugtracking and information to
be sent to the user/developer.
.PP
All functions are autoloaded so they will not be loaded into memory if you
have not used them before.
.PP
There are 5 different levels of the information/action.
.IP "1." 4
critical
.IP "2." 4
error
.IP "3." 4
warning
.IP "4." 4
message
.IP "5." 4
debug
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.IP "\fBsetQuitLevel\fR" 4
.IX Item "setQuitLevel"
You can set on what errorlevel the program should exit if an error occur.
The default level is 2 and you canges it like this:
.Sp
\&\s-1USAGE:\s0
    \f(CW\*(C`setQuitLevel\*(C'\fR(level);
.IP "\fBsetErrorHandler\fR" 4
.IX Item "setErrorHandler"
You can set an alternative error handler function (no arguments). The default
one is exit.
.Sp
\&\s-1USAGE:\s0
    \f(CW\*(C`setErrorHandler\*(C'\fR(\efuncname);
.IP "\fBsetDebugLevel\fR" 4
.IX Item "setDebugLevel"
You can set on what errorlevel the program should output messages if an error
occur. The debug level indicates what type of information that should be
presented to the user.
.Sp
\&\s-1USAGE:\s0
    \f(CW\*(C`setDebugLevel\*(C'\fR(level);
.IP "\fBgetQuitLevel\fR" 4
.IX Item "getQuitLevel"
You can set on what errorlevel the program should exit if an error occur.
.Sp
\&\s-1USAGE:\s0
    \f(CW$foo\fR = \f(CW\*(C`getQuitLevel\*(C'\fR;
.IP "\fBgetDebugLevel\fR" 4
.IX Item "getDebugLevel"
You can get the debuglevel on which the program should output messages, if an
error occurs.
.Sp
\&\s-1USAGE:\s0
    \f(CW$foo\fR = \f(CW\*(C`getDebugLevel\*(C'\fR;
.IP "\fBpdebug\fR" 4
.IX Item "pdebug"
You can set on what errorlevel the program should exit if an error occur.
With the pdebug method you can present information and mark it with a
debuglevel using:
.Sp
\&\s-1USAGE:\s0
    \f(CW\*(C`pdebug\*(C'\fR(level, \*(L"A sample informational text.\*(R" [,funcref]);
.IP "\fBaction\fR" 4
.IX Item "action"
With this function you can handle and print a message if a function does
not work correctly.
.Sp
It will exit the program and print a message with the error level before if
the action returns true and if the action_critic is lower or equal to the set
error level.
.Sp
If the debug level is high enough it will present the message but without the
trailing error message.
.Sp
\&\s-1USAGE:\s0
    \f(CW\*(C`action\*(C'\fR(some_action,
           \*(L"A sample informational text about the action.\*(R",
            how_critical [,funcref]);
.Sp
The last parameter (how_critical) is optional.
.IP "\fBcmdaction\fR" 4
.IX Item "cmdaction"
Actually the same as \fBaction\fR with the difference that it executes a external
command instead.
.Sp
It is almost identical to action(system\*(L"a command to execute\*(R", ...);
.Sp
\&\s-1USAGE:\s0
    \f(CW\*(C`cmdaction\*(C'\fR(\*(L"a command to execute.\*(R",
              \*(L"A sample informational text about the action.\*(R",
               how_critical,
	       how_quiet [,funcref]);
.Sp
The two last parameter (how_critical) is optional.
The last parameter tells how quiet the executing command should be:
  0 \- extremely quiet (ie: >& /dev/null)
  1 \- quiet           (ie: >& /dev/null)
  2 \- everything sent to stdout.
=back
.SH "AUTHOR"
.IX Header "AUTHOR"
Ola Lundqvist <ola@inguza.com>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIperl\fR\|(1).
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 415:" 4
.IX Item "Around line 415:"
You forgot a '=back' before '=head1'