Log::Me...:Config(3)

πŸ’– Log::Message::Config(3) β€” the perl manpage, but make it make sense πŸ’–

okay so bestie, welcome to the perl manual page for Log::Message::Config β€” User Contributed Perl Documentation, no cap. this one's a little config gremlin and honestly? iconic. let's get into it 🫢


✨ NAME ✨

Log::Message::Config β€” the configuration options situation for Log::Message. that's it. that's the whole vibe check πŸ’…


✨ SYNOPSIS ✨

here's the whole thing verbatim, don't touch, i'm not retyping it from memory because i would simply get it wrong:

 # This module is implicitly used by Log::Message to create a config
 # which it uses to log messages.
 # For the options you can pass, see the C<Log::Message new()> method.

 # Below is a sample of a config file you could use

 # comments are denoted by a single '#'
 # use a shared stack, or have a private instance?
 # if none provided, set to '0',
 private = 1

 # do not be verbose
 verbose = 0

 # default tag to set on new items
 # if none provided, set to 'NONE'
 tag = SOME TAG

 # default level to handle items
 # if none provided, set to 'log'
 level = carp

 # extra files to include
 # if none provided, no files are auto included
 include = mylib.pl
 include = ../my/other/lib.pl

 # automatically delete items
 # when you retrieve them from the stack?
 # if none provided, set to '0'
 remove = 1

 # retrieve errors in chronological order, or not?
 # if none provided, set to '1'
 chrono = 0

quick translation of what you're looking at, bestie:

  • # starts a comment β€” single # only, that's the whole rule πŸŽ€
  • private = 1 β†’ use a shared stack, or have a private instance? if none provided, it's set to '0'
  • verbose = 0 β†’ do not be verbose (lowkey the most relatable line in this entire file)
  • tag = SOME TAG β†’ default tag to set on new items. if none provided, set to 'NONE'
  • level = carp β†’ default level to handle items. if none provided, set to 'log' (note the sample says carp, the default is log, both facts, don't @ me)
  • include = mylib.pl and include = ../my/other/lib.pl β†’ extra files to include. if none provided, no files are auto included πŸ¦‹
  • remove = 1 β†’ automatically delete items when you retrieve them from the stack? if none provided, set to '0'
  • chrono = 0 β†’ retrieve errors in chronological order, or not? if none provided, set to '1'

✨ DESCRIPTION ✨

Log::Message::Config provides a standardized config object for Log::Message objects. slay, standardized πŸ’…

it can either read options as perl arguments, or as a config file. that's the main character energy right there β€” two whole ways to do the thing 🌈

for more info on what arguments are valid, go read the Log::Message manpage. and for an example config file you can actually use, the Synopsis above has you covered, periodt.


✨ SEE ALSO ✨

  • Log::Message
  • Log::Message::Item
  • Log::Message::Handlers

(the whole friend group, orbiting each other, love that for them πŸͺ)


✨ AUTHOR ✨

this module by Jos Boumans <kane@cpan.org>. πŸ‘‘

Acknowledgements

thanks to Ann Barcomb for her suggestions. 🫢


this module is copyright (c) 2002 Jos Boumans <kane@cpan.org>. All rights reserved.

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

okay so technically that last bit means it's free software β€” redistribute and/or modify under the same terms as Perl itself. not a free-for-all, the same terms. read them. respectfully. πŸ“œ

and that's the page!! πŸŽ€βœ¨ this came from perl v5.42.0, dated 2014-07-27, and honestly it's giving vintage but make it cute. mwah, go configure something πŸ’–

πŸ“¦ where this page comes from