Module...icense(3pm)

πŸ“¦
version 0.10 Β· 7 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu questing

πŸ’– Module::Install::AutoLicense β€” the manual, but make it cute πŸ’–

okay bestie, so this is the page for Module::Install::AutoLicense, living in section 3pm of the User Contributed Perl Documentation. it's a Module::Install extension, it writes your LICENSE file for you, and honestly? iconic behaviour. no cap. πŸŽ€


✨ NAME ✨

Module::Install::AutoLicense β€” a Module::Install extension that automagically generates LICENSE files. yes, automagically. that's the actual word and it's giving main character energy. πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

lowkey the whole vibe is right here:

# In Makefile.PL

use inc::Module::Install;
author 'Vestan Pants';
license 'perl';
auto_license;

and boom β€” an appropriate LICENSE file gets generated for your distribution. that's it. that's the flex. ✨


🌸 DESCRIPTION 🌸

so Module::Install::AutoLicense is a Module::Install extension that generates a LICENSE file automatically whenever the author runs Makefile.PL. on the user side? it literally does nothing. not a thing. it's just there, chilling. πŸ’€

when the author invokes make distclean, the LICENSE gets removed. bye bestie, we hardly knew ye. 🫢

the appropriate license is determined from the meta provided with the license command, and the holder of the license comes from the author command. teamwork, fr fr.

and the actual LICENSE file generation? that's handled by Software::License. we stan a delegation moment. πŸ‘‘


πŸ‘‘ COMMANDS πŸ‘‘

this plugin adds the following Module::Install command, and there's exactly one, so let's give it the attention it deserves:

  • auto_license β€” does nothing on the user-side. on the author-side it will generate a LICENSE file according to the previously supplied license command. the holder of the license is determined from the author meta, or you can specify it yourself using the holder parameter, like so:
auto_license( holder => 'Vestan Pants and Ivor Biggun' );
important note, bestie, do NOT skip this: the auto_license command must follow the author and license commands in the Makefile.PL (as demonstrated in the SYNOPSIS above). if it doesn't, the meta that those commands provide will be unavailable to auto_license. and like... that's just how it is. call it a feature. 😭 (the original says to call it a feature, and honestly? sure. call it a feature. πŸ’…)

πŸ’œ AUTHOR πŸ’œ

Chris "BinGOs" Williams 🫢


πŸŽ€ LICENSE πŸŽ€

Copyright Β© Chris Williams

this module may be used, modified, and distributed under the same terms as Perl itself. please see the license that came with your Perl distribution for the details. go read it, it's good for you. πŸ“–βœ¨


🌈 SEE ALSO 🌈

  • Module::Install
  • Software::License

and that's the whole page, bestie!! this was perl v5.36.0, dated 2022-11-30, and the page itself is Module...icense(3pm) from the User Contributed Perl Documentation. mwah. πŸ’–πŸ’…βœ¨

πŸ“¦ where this page comes from