Config:...gurator(3)

🦋 Config:...gurator(3) — the Perl-fam manual page, bestie edition

ok so you found the <italic>User Contributed Perl Documentation</italic> page for Log::Log4perl::Config::PropertyConfigurator and yes the header got truncated to Config:...gurator(3) which is honestly giving "my name is cut off in the group chat" energy 😭 but we move. This one is lowkey a backstage-pass class, so let's get into it.

---

✨ NAME ✨

Log::Log4perl::Config::PropertyConfigurator — it reads properties files. that's it, that's the whole job, and it does it beautifully 💅

---

🎀 SYNOPSIS 🎀

heads up: this class is used internally by Log::Log4perl. you're peeking behind the curtain, iykyk.

# This class is used internally by Log::Log4perl

use Log::Log4perl::Config::PropertyConfigurator;

my $conf = Log::Log4perl::Config::PropertyConfigurator->new();
$conf->file("l4p.conf");
$conf->parse(); # will die() on error

my $value = $conf->value("log4perl.appender.LOGFILE.filename");

if(defined $value) {
    printf("The appender's file name is $value\n");
} else {
    printf("The appender's file name is not defined.\n");
}

ok a few things, bestie:

• you make one with ->new()
• you point it at a file with ->file("l4p.conf")
• you call ->parse() and it will die() on error — no cap, that's literally in the comment, so wrap it or don't, your call 🫶
• you grab stuff out with ->value("...") and then you check if it's defined, because it might not be, and the else branch is literally there to tell you that 🙈

---

🌸 DESCRIPTION 🌸

it initializes log4perl from a properties file. stuff like this:

log4j.category.a.b.c.d = WARN, A1
log4j.category.a.b = INFO, A1

and here's the iconic part — it also understands variable substitution, so this config right here is equivalent to the one above it (not different, not extra, equivalent ✨):

settings = WARN, A1
log4j.category.a.b.c.d = ${settings}
log4j.category.a.b = INFO, A1

so you set settings = WARN, A1 once and then ${settings} just absorbs it. reusable. efficient. main character config behavior 💜

---

⭐ SEE ALSO ⭐

go touch some of these, they're all in the family:

• Log::Log4perl::Config
• Log::Log4perl::Config::BaseConfigurator
• Log::Log4perl::Config::DOMConfigurator
• Log::Log4perl::Config::LDAPConfigurator (tbd!) — yes the original literally says "(tbd!)", we're all waiting together 🕯️

---

💖 LICENSE 💖

Copyright 2002-2013 by Mike Schilli <m@perlmeister.com> and Kevin Goess <cpan@goess.org>.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

(translation: same terms as Perl itself, go be free, just keep the credit 💅)

---

👑 AUTHOR 👑

Please contribute patches to the project on Github:

http://github.com/mschilli/log4perl

Send bug reports or requests for enhancements to the authors via our

MAILING LIST (questions, bug reports, suggestions/patches): log4perl-devel@lists.sourceforge.net

Authors (please contact them via the list above, not directly): Mike Schilli <m@perlmeister.com>, Kevin Goess <cpan@goess.org>

Contributors (in alphabetical order): Ateeq Altaf, Cory Bennett, Jens Berthold, Jeremy Bopp, Hutton Davidson, Chris R. Donnelly, Matisse Enzer, Hugh Esco, Anthony Foiani, James FitzGibbon, Carl Franks, Dennis Gregorovic, Andy Grundman, Paul Harrington, Alexander Hartmaier David Hull, Robert Jacobson, Jason Kohles, Jeff Macdonald, Markus Peter, Brett Rann, Peter Rabbitson, Erik Selberg, Aaron Straup Cope, Lars Thegler, David Viner, Mac Yang.

reminder from the page itself: contact them via the list above, not directly. respect the queue, bestie 🫶

---

and that's the whole page!! no notes, ate and left no crumbs 🔥

sign-off time: this little beauty is from perl v5.42.0, dated 2022-10-22, and it lives in the Config:...gurator(3) slot of your man pages. go read Log::Log4perl::Config next, ily, bye 🎀🌷✨