.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) .\" .\" 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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . 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 >0, 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 .\" .\" Required to disable full justification in groff 1.23.0. .if n .ds AD l .\" ======================================================================== .\" .IX Title "Log::Report::Minimal 3" .TH Log::Report::Minimal 3 2025-12-12 "perl v5.42.0" "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::Report::Minimal \- simulate Log::Report functions simple .SH INHERITANCE .IX Header "INHERITANCE" .Vb 2 \& Log::Report::Minimal \& is an Exporter .Ve .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 2 \& # See Log::Report, most functions get "hollow" behavior \& use Log::Report::Optional mode => \*(AqDEBUG\*(Aq; .Ve .SH DESCRIPTION .IX Header "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 \f(CW\*(C`Log::Report\*(C'\fR in an \f(CW\*(C`::Optional\*(C'\fR way, the main script determines whether it wants the \f(CW\*(C`::Minimal\*(C'\fR or full\-blown feature set. .SH FUNCTIONS .IX Header "FUNCTIONS" .IP "\fBtextdomain\fR( <[$name],$config>|<$name, \*(AqDELETE\*(Aq|\*(AqEXISTS\*(Aq>|$domain )" 4 .IX Item "textdomain( <[$name],$config>|<$name, 'DELETE'|'EXISTS'>|$domain )" .SS "Report Production and Configuration" .IX Subsection "Report Production and Configuration" .ie n .IP "\fBdispatcher\fR( <$type, $name, %options>|<$command, @names> )" 4 .el .IP "\fBdispatcher\fR( <$type, \f(CW$name\fR, \f(CW%options\fR>|<$command, \f(CW@names\fR> )" 4 .IX Item "dispatcher( <$type, $name, %options>|<$command, @names> )" Not supported. .ie n .IP "\fBreport\fR( [\e%options], $reason, $message| )" 4 .el .IP "\fBreport\fR( [\e%options], \f(CW$reason\fR, \f(CW$message\fR| )" 4 .IX Item "report( [%options], $reason, $message| )" Be warned that \f(CW%options\fR is a HASH here. .Sp .Vb 3 \& \-Option \-\-Default \& errno $! or 1 \& is_fatal .Ve .RS 4 .IP "errno => INTEGER" 2 .IX Item "errno => INTEGER" .PD 0 .IP "is_fatal => BOOLEAN" 2 .IX Item "is_fatal => BOOLEAN" .PD .RE .RS 4 .RE .ie n .IP "\fBtry\fR(CODE, %options)" 4 .el .IP "\fBtry\fR(CODE, \f(CW%options\fR)" 4 .IX Item "try(CODE, %options)" .SS "Abbreviations for \fBreport()\fP" .IX Subsection "Abbreviations for report()" .IP \fBalert\fR($message) 4 .IX Item "alert($message)" .IP \fBassert\fR($message) 4 .IX Item "assert($message)" .IP \fBerror\fR($message) 4 .IX Item "error($message)" .IP \fBfailure\fR($message) 4 .IX Item "failure($message)" .IP \fBfault\fR($message) 4 .IX Item "fault($message)" .IP \fBinfo\fR($message) 4 .IX Item "info($message)" .IP \fBmistake\fR($message) 4 .IX Item "mistake($message)" .IP \fBnotice\fR($message) 4 .IX Item "notice($message)" .IP \fBpanic\fR($message) 4 .IX Item "panic($message)" .IP \fBtrace\fR($message) 4 .IX Item "trace($message)" .IP \fBwarning\fR($message) 4 .IX Item "warning($message)" .SS "Language Translations" .IX Subsection "Language Translations" No translations, no Log::Report::Message objects returned. .IP \fBN_\|_\fR($msgid) 4 .IX Item "N__($msgid)" .ie n .IP "\fBN_\|_n\fR($single_msgid, $plural_msgid)" 4 .el .IP "\fBN_\|_n\fR($single_msgid, \f(CW$plural_msgid\fR)" 4 .IX Item "N__n($single_msgid, $plural_msgid)" .IP \fBN_\|_w\fR(STRING) 4 .IX Item "N__w(STRING)" .IP \fB_\|_\fR($msgid) 4 .IX Item "__($msgid)" .ie n .IP "\fB_\|_n\fR($msgid, $plural_msgid, $count, PAIRS)" 4 .el .IP "\fB_\|_n\fR($msgid, \f(CW$plural_msgid\fR, \f(CW$count\fR, PAIRS)" 4 .IX Item "__n($msgid, $plural_msgid, $count, PAIRS)" .ie n .IP "\fB_\|_nx\fR($msgid, $plural_msgid, $count, PAIRS)" 4 .el .IP "\fB_\|_nx\fR($msgid, \f(CW$plural_msgid\fR, \f(CW$count\fR, PAIRS)" 4 .IX Item "__nx($msgid, $plural_msgid, $count, PAIRS)" .IP "\fB_\|_x\fR($msgid, PAIRS)" 4 .IX Item "__x($msgid, PAIRS)" .ie n .IP "\fB_\|_xn\fR($single_msgid, $plural_msgid, $count, PAIRS)" 4 .el .IP "\fB_\|_xn\fR($single_msgid, \f(CW$plural_msgid\fR, \f(CW$count\fR, PAIRS)" 4 .IX Item "__xn($single_msgid, $plural_msgid, $count, PAIRS)" .SS Configuration .IX Subsection "Configuration" .ie n .IP "$obj\->\fBimport\fR( [$domain], %options )" 4 .el .IP "\f(CW$obj\fR\->\fBimport\fR( [$domain], \f(CW%options\fR )" 4 .IX Item "$obj->import( [$domain], %options )" See Log::Report subroutine import. .SH DIAGNOSTICS .IX Header "DIAGNOSTICS" .ie n .IP "Error: even length parameter list for _\|_x at $where" 4 .el .IP "Error: even length parameter list for _\|_x at \f(CW$where\fR" 4 .IX Item "Error: even length parameter list for __x at $where" Cast by _\|\fB_x()\fR .IP "Error: odd length parameter list with \*(Aq$msg\*(Aq" 4 .IX Item "Error: odd length parameter list with '$msg'" Cast by \fBreport()\fR .IP "Error: syntax flag must be either SHORT or REPORT, not \`$flag\*(Aq" 4 .IX Item "Error: syntax flag must be either SHORT or REPORT, not `$flag'" Cast by \fBimport()\fR .IP "Error: token \*(Aq$token\*(Aq not recognized as reason" 4 .IX Item "Error: token '$token' not recognized as reason" Cast by \fBreport()\fR .SH "SEE ALSO" .IX Header "SEE ALSO" This module is part of Log\-Report\-Optional version 1.08, built on September 08, 2025. Website: \fIhttp://perl.overmeer.net/CPAN/\fR .SH LICENSE .IX Header "LICENSE" For contributors see file ChangeLog. .PP This software is copyright (c) 2013\-2025 by Mark Overmeer. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.