File: Minimal.pod

package info (click to toggle)
liblog-report-optional-perl 1.01-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 132 kB
  • ctags: 53
  • sloc: perl: 448; makefile: 2
file content (135 lines) | stat: -rw-r--r-- 2,404 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
=encoding utf8

=head1 NAME

Log::Report::Minimal - simulate Log::Report functions simple

=head1 INHERITANCE

 Log::Report::Minimal
   is a Exporter

=head1 SYNOPSIS

 # See Log::Report, most functions get "hollow" behavior
 use Log::Report::Optional mode => 'DEBUG';

=head1 DESCRIPTION

This module implements the functions provided by Log::Report, but then
as simple as possible: no support for translations, no dispatchers, no
smart exceptions.  The package uses C<Log::Report> in an C<::Optional>
way, the main script determines whether it wants the C<::Minimal> or
full-blown feature set.

=head1 FUNCTIONS

=over 4

=item B<textdomain>( $domain, [$configuration] )

=back

=head2 Report Production and Configuration

=over 4

=item B<dispatcher>( <$type, $name, %options>|<$command, @names> )

Not supported.

=item B<report>( [$options], $reason, $message|<STRING,$params> )

Be warned that %options is a HASH here.

 -Option  --Default
  errno     $! or 1
  is_fatal  <depends on reason>

=over 2

=item errno => INTEGER

=item is_fatal => BOOLEAN

=back

=item B<try>(CODE, %options)

=back

=head2 Abbreviations for report()

=over 4

=item B<alert>($message)

=item B<assert>($message)

=item B<error>($message)

=item B<failure>($message)

=item B<fault>($message)

=item B<info>($message)

=item B<mistake>($message)

=item B<notice>($message)

=item B<panic>($message)

=item B<trace>($message)

=item B<warning>($message)

=back

=head2 Language Translations

No translations, no L<Log::Report::Message> objects returned.

=over 4

=item B<N__>($msgid)

=item B<N__n>($single_msgid, $plural_msgid)

=item B<N__w>(STRING)

=item B<__>($msgid)

=item B<__n>($msgid, $plural_msgid, $count, PAIRS)

=item B<__nx>($msgid, $plural_msgid, $count, PAIRS)

=item B<__x>($msgid, PAIRS)

=item B<__xn>($single_msgid, $plural_msgid, $count, PAIRS)

=back

=head2 Configuration

=over 4

=item $obj-E<gt>B<import>( [$domain], %options )

See Log::Report subroutine import.

=back

=head1 SEE ALSO

This module is part of Log-Report-Optional distribution version 1.01,
built on March 10, 2014. Website: F<http://perl.overmeer.net/log-report/>

=head1 LICENSE

Copyrights 2013-2014 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 F<http://www.perl.com/perl/misc/Artistic.html>