Log::Message::Simple



Log::Message::Simple

NAME
SYNOPSIS
DESCRIPTION
FUNCTIONS
CLASS METHODS
GLOBAL VARIABLES

NAME

Log::Message::Simple − Simplified interface to Log::Message

SYNOPSIS

    use Log::Message::Simple qw[msg error debug
                                carp croak cluck confess];
    use Log::Message::Simple qw[:STD :CARP];
    ### standard reporting functionality
    msg(    "Connecting to database",           $verbose );
    error(  "Database connection failed: $@",   $verbose );
    debug(  "Connection arguments were: $args", $debug );
    ### standard carp functionality
    carp(   "Wrong arguments passed: @_" );
    croak(  "Fatal: wrong arguments passed: @_" );
    cluck(  "Wrong arguments passed −− including stacktrace: @_" );
    confess("Fatal: wrong arguments passed −− including stacktrace: @_" );
    ### retrieve individual message
    my @stack = Log::Message::Simple−>stack;
    my @stack = Log::Message::Simple−>flush;
    ### retrieve the entire stack in printable form
    my $msgs  = Log::Message::Simple−>stack_as_string;
    my $trace = Log::Message::Simple−>stack_as_string(1);
    ### redirect output
    local $Log::Message::Simple::MSG_FH     = \*STDERR;
    local $Log::Message::Simple::ERROR_FH   = \*STDERR;
    local $Log::Message::Simple::DEBUG_FH   = \*STDERR;
    ### force a stacktrace on error
    local $Log::Message::Simple::STACKTRACE_ON_ERROR = 1

DESCRIPTION

This module provides standardized logging facilities using the "Log::Message" module.

FUNCTIONS

msg("message string" [,VERBOSE])
Records a message on the stack, and prints it to "STDOUT" (or actually $MSG_FH, see the "GLOBAL VARIABLES" section below), if the "VERBOSE" option is true. The "VERBOSE" option defaults to false.

Exported by default, or using the ":STD" tag.

debug("message string" [,VERBOSE])
Records a debug message on the stack, and prints it to "STDOUT" (or actually $DEBUG_FH, see the "GLOBAL VARIABLES" section below), if the "VERBOSE" option is true. The "VERBOSE" option defaults to false.

Exported by default, or using the ":STD" tag.

error("error string" [,VERBOSE])
Records an error on the stack, and prints it to "STDERR" (or actually $ERROR_FH, see the "GLOBAL VARIABLES" sections below), if the "VERBOSE" option is true. The "VERBOSE" options defaults to true.

Exported by default, or using the ":STD" tag.

carp();
Provides functionality equal to "Carp::carp()" while still logging to the stack.

Exported by using the ":CARP" tag.

croak();
Provides functionality equal to "Carp::croak()" while still logging to the stack.

Exported by using the ":CARP" tag.

confess();
Provides functionality equal to "Carp::confess()" while still logging to the stack.

Exported by using the ":CARP" tag.

cluck();
Provides functionality equal to "Carp::cluck()" while still logging to the stack.

Exported by using the ":CARP" tag.

CLASS METHODS

Log::Message::Simple−>stack()
Retrieves all the items on the stack. Since "Log::Message::Simple" is implemented using "Log::Message", consult its manpage for the function "retrieve" to see what is returned and how to use the items.

Log::Message::Simple−>stack_as_string([ TRACE ])
Returns the whole stack as a printable string. If the "TRACE" option is true all items are returned with "Carp::longmess" output, rather than just the message. "TRACE" defaults to false.

Log::Message::Simple−>flush()
Removes all the items from the stack and returns them. Since "Log::Message::Simple" is implemented using "Log::Message", consult its manpage for the function "retrieve" to see what is returned and how to use the items.

GLOBAL VARIABLES

$ERROR_FH

This is the filehandle all the messages sent to "error()" are being printed. This defaults to *STDERR.

$MSG_FH

This is the filehandle all the messages sent to "msg()" are being printed. This default to *STDOUT.

$DEBUG_FH

This is the filehandle all the messages sent to "debug()" are being printed. This default to *STDOUT.

$STACKTRACE_ON_ERROR

If this option is set to "true", every call to "error()" will generate a stacktrace using "Carp::shortmess()". Defaults to "false"



More Linux Commands

manpages/ciphers.1ssl.html
ciphers(1ssl) SSL cipher display and cipher list tool.......
The ciphers command converts textual OpenSSL cipher lists into ordered SSL cipher preference lists. It can be used as a test tool to determine the appropriate c

manpages/ldap_search_st.3.html
ldap_search_st(3) - Perform an LDAP search operation........
These routines are used to perform LDAP search operations. The ldap_search_ext_s() routine does the search synchronously (i.e., not returning until the operatio

manpages/FcUtf8Len.3.html
FcUtf8Len(3) - count UTF-8 encoded chars - Linux man page...
Counts the number of Unicode chars in len bytes of src. Places that count in nchar. wchar contains 1, 2 or 4 depending on the number of bytes needed to hold the

manpages/iscsi-iname.8.html
iscsi-iname(8) iSCSI initiator name generation tool.........
iscsi-iname generates a unique iSCSI node name on every invocation. OPTIONS [-h|--help] Display help [-p=]prefix Use the prefix passed in instead of the default

manpages/esd.1.html
esd(1) The Enlightened Sound Daemon - Linux manual page.....
Starts up EsounD, which provides a sound mixing server. USAGE esd [options] -d DEVICE force esd to use sound device DEVICE -b run server in 8 bit sound mode -r

manpages/dnsdomainname.1.html
dnsdomainname(1) - show the system's DNS domain name........
Hostname is the program that is used to either set or display the current host, domain or node name of the system. These names are used by many of the networkin

manpages/mvins_wstr.3ncurses.html
mvins_wstr(3ncurses) - insert a wide-character string into a
These routines insert a wchar_t character string (as many characters as will fit on the line) before the character under the cursor. All characters to the right

manpages/Tcl_AsyncInvoke.3.html
Tcl_AsyncInvoke(3) - handle asynchronous events (Man Page)
These procedures provide a safe mechanism for dealing with asynchronous events such as signals. If an event such as a signal occurs while a Tcl script is being

manpages/jcf-dump-4.6.1.html
jcf-dump-4.6(1) - print information about Java class files
This is a class file examiner, similar to javap. It will print information about a number of classes, which are specified by class name or file name. OPTIONS -c

manpages/INFINITY.3.html
INFINITY(3) - floating-point constants - Linux manual page
The macro INFINITY expands to a float constant representing positive infinity. The macro NAN expands to a float constant representing a quiet NaN (when supporte

manpages/log1pl.3.html
log1pl(3) - logarithm of 1 plus argument - Linux man page...
log1p(x) returns a value equivalent to log (1 + x) It is computed in a way that is accurate even if the value of x is near zero. RETURN VALUE On success, these

manpages/amor.6.html
amor(6) - A KDE creature for your desktop - Linux man page
AMOR stands for Amusing Misuse Of Resources. It provides several different characters who prance around your X screen doing tricks and giving you tips. AMOR is





We can't live, work or learn in freedom unless the software we use is free.