GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  LOG::REPORT::UTIL (3)

.ds Aq ’

NAME

Log::Report::Util - helpful routines to Log::Report

CONTENTS

INHERITANCE



 Log::Report::Util
   is a Exporter



DESCRIPTION

This module collects a few functions and definitions which are shared between different components in the Log::Report infrastructure. They should not be needed for end-user applications, although this man-page may contain some useful background information.

FUNCTIONS

    Reasons

<B>expand_reasonsB>($reasons) Returns a sub-set of all existing message reason labels, based on the content $reasons string. The following rules apply:
REASONS = BLOCK [ ’,’ BLOCKS]
BLOCK = ’-’ TO | FROM ’-’ TO | ONE | SOURCE
FROM,TO,ONE
= ’TRACE’ | ’ASSERT’ | ,,, | ’PANIC
SOURCE = ’USER’ | ’PROGRAM’ | ’SYSTEM’ | ’ALL

The SOURCE specification group all reasons which are usually related to the problem: report about problems caused by the user, reported by the program, or with system interaction.

example: of expended REASONS



 WARNING-FAULT # == WARNING,MISTAKE,ERROR,FAULT
 -INFO         # == TRACE-INFO
 ALERT-        # == ALERT,FAILURE,PANIC
 USER          # == MISTAKE,ERROR
 ALL           # == TRACE-PANIC



<B>is_fatalB>($reason) Returns true if the $reason is severe enough to cause an exception (or program termination).
<B>is_reasonB>($name) Returns true if the STRING is one of the predefined REASONS.
<B>use_errnoB>($reason)

    Modes

Run-modes are explained in Log::Report::Dispatcher.
<B>mode_acceptsB>($mode) Returns something acceptable by expand_reasons()
<B>mode_numberB>($name|$mode) Returns the $mode as number.
<B>must_show_locationB>($mode, $reason)
<B>must_show_stackB>($mode, $reason)

    Other

<B>escape_charsB>(STRING) Replace all escape characters into their readable counterpart. For instance, a new-line is replaced by backslash-n.
<B>parse_localeB>(STRING) Decompose a locale string.

For simplicity of the caller’s code, the capatization of the returned fields is standardized to the preferred, although the match is case- insensitive as required by the RFC. The territory in returned in capitals (ISO3166), the language is lower-case (ISO639), the script as upper-case first, the character-set as lower-case, and the modifier and variant unchanged.

In LIST context, four elements are returned: language, territory, character-set (codeset), and modifier. Those four are important for the usual unix translationg infrastructure. Only the country is obligatory, the others can be undef. It may also return C and POSIX.

In SCALAR context, a HASH is returned which can contain more information: language, script, territory, variant, codeset, and modifiers. The variant (RFC3066 is probably never used)

<B>pkg2domainB>( $package, [$domain, $filename, $line] ) With $domain, $filename and $line, this registers a location where the textdomain is specified. Each $package can only belong to one $domain.

Without these parameters, the registered domain for the $package is returned.

<B>to_htmlB>($string) [1.02] Escape HTML volatile characters.
<B>unescape_charsB>(STRING) Replace all backslash-something escapes by their escape character. For instance, backslash-t is replaced by a tab character.

SYNOPSYS



 my ($language, $territory, $charset, $modifier)
    = parse_locale nl_BE.utf-8@home;

 my @take = expand_reasons INFO-ERROR,PANIC;



SEE ALSO

This module is part of Log-Report-Optional distribution version 1.02, built on January 18, 2016. Website: http://perl.overmeer.net/log-report/

LICENSE

Copyrights 2013-2016 by [Mark Overmeer]. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://www.perl.com/perl/misc/Artistic.html

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 LOG::REPORT::UTIL (3) 2016-01-18

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.