.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" 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 .\" ======================================================================== .\" .IX Title "Alien::Build::Log 3" .TH Alien::Build::Log 3 2023-07-25 "perl v5.38.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 Alien::Build::Log \- Alien::Build logging .SH VERSION .IX Header "VERSION" version 2.80 .SH SYNOPSIS .IX Header "SYNOPSIS" Create your custom log class: .PP .Vb 1 \& package Alien::Build::Log::MyLog; \& \& use parent qw( Alien::Build::Log ); \& \& sub log \& { \& my(undef, %opt) = @_; \& my($package, $filename, $line) = @{ $opt{caller} }; \& my $message = $opt{message}; \& \& ...; \& } .Ve .PP override log class: .PP .Vb 1 \& % env ALIEN_BUILD_LOG=Alien::Build::Log::MyLog cpanm Alien::libfoo .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" .SH CONSTRUCTORS .IX Header "CONSTRUCTORS" .SS new .IX Subsection "new" .Vb 1 \& my $log = Alien::Build::Log\->new; .Ve .PP Create an instance of the log class. .SS default .IX Subsection "default" .Vb 1 \& my $log = Alien::Build::Log\->default; .Ve .PP Return singleton instance of log class used by Alien::Build. .SH METHODS .IX Header "METHODS" .SS set_log_class .IX Subsection "set_log_class" .Vb 1 \& Alien::Build::Log\->set_log_class($class); .Ve .PP Set the default log class used by Alien::Build. This method will also reset the default instance used by Alien::Build. If not specified, Alien::Build::Log::Default will be used. .SS log .IX Subsection "log" .Vb 1 \& $log\->log(%options); .Ve .PP Overridable method which does the actual work of the log class. Options: .IP caller 4 .IX Item "caller" Array references containing the package, file and line number of where the log was called. .IP message 4 .IX Item "message" The message to log. .SH ENVIRONMENT .IX Header "ENVIRONMENT" .IP ALIEN_BUILD_LOG 4 .IX Item "ALIEN_BUILD_LOG" The default log class used by Alien::Build. .SH AUTHOR .IX Header "AUTHOR" Author: Graham Ollis .PP Contributors: .PP Diab Jerius (DJERIUS) .PP Roy Storey (KIWIROY) .PP Ilya Pavlov .PP David Mertens (run4flat) .PP Mark Nunberg (mordy, mnunberg) .PP Christian Walde (Mithaldu) .PP Brian Wightman (MidLifeXis) .PP Zaki Mughal (zmughal) .PP mohawk (mohawk2, ETJ) .PP Vikas N Kumar (vikasnkumar) .PP Flavio Poletti (polettix) .PP Salvador Fandiño (salva) .PP Gianni Ceccarelli (dakkar) .PP Pavel Shaydo (zwon, trinitum) .PP Kang-min Liu (劉康民, gugod) .PP Nicholas Shipp (nshp) .PP Juan Julián Merelo Guervós (JJ) .PP Joel Berger (JBERGER) .PP Petr Písař (ppisar) .PP Lance Wicks (LANCEW) .PP Ahmad Fatoum (a3f, ATHREEF) .PP José Joaquín Atria (JJATRIA) .PP Duke Leto (LETO) .PP Shoichi Kaji (SKAJI) .PP Shawn Laffan (SLAFFAN) .PP Paul Evans (leonerd, PEVANS) .PP Håkon Hægland (hakonhagland, HAKONH) .PP nick nauwelaerts (INPHOBIA) .PP Florian Weimer .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2011\-2022 by Graham Ollis. .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.