.\" Automatically generated by Pod::Man 4.14 (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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 "Module::Install::AutoLicense 3pm" .TH Module::Install::AutoLicense 3pm "2022-11-30" "perl v5.36.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" Module::Install::AutoLicense \- A Module::Install extension to automagically generate LICENSE files .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& # In Makefile.PL \& \& use inc::Module::Install; \& author \*(AqVestan Pants\*(Aq; \& license \*(Aqperl\*(Aq; \& auto_license; .Ve .PP An appropriate \f(CW\*(C`LICENSE\*(C'\fR file will be generated for your distribution. .SH "DESCRIPTION" .IX Header "DESCRIPTION" Module::Install::AutoLicense is a Module::Install extension that generates a \f(CW\*(C`LICENSE\*(C'\fR file automatically whenever the author runs \f(CW\*(C`Makefile.PL\*(C'\fR. On the user side it does nothing. .PP When \f(CW\*(C`make distclean\*(C'\fR is invoked by the author, the \f(CW\*(C`LICENSE\*(C'\fR is removed. .PP The appropriate license to determined from the meta provided with the \f(CW\*(C`license\*(C'\fR command and the holder of the license from the \f(CW\*(C`author\*(C'\fR command. .PP Software::License is used to generate the \f(CW\*(C`LICENSE\*(C'\fR file. .SH "COMMANDS" .IX Header "COMMANDS" This plugin adds the following Module::Install command: .ie n .IP """auto_license""" 4 .el .IP "\f(CWauto_license\fR" 4 .IX Item "auto_license" Does nothing on the user-side. On the author-side it will generate a \f(CW\*(C`LICENSE\*(C'\fR file according to the previously supplied \f(CW\*(C`license\*(C'\fR command. The \f(CW\*(C`holder\*(C'\fR of the license is determined from the \f(CW\*(C`author\*(C'\fR meta or may be specified using the \f(CW\*(C`holder\*(C'\fR parameter. .Sp .Vb 1 \& auto_license( holder => \*(AqVestan Pants and Ivor Biggun\*(Aq ); .Ve .Sp It is important to note that the \f(CW\*(C`auto_license\*(C'\fR must follow \f(CW\*(C`author\*(C'\fR and \f(CW\*(C`license\*(C'\fR commands in the \f(CW\*(C`Makefile.PL\*(C'\fR ( as demonstrated in the \s-1SYNOPSIS\s0 above ), otherwise the meta these commands provide will be unavailable to \f(CW\*(C`auto_license\*(C'\fR. Call it a feature. .SH "AUTHOR" .IX Header "AUTHOR" Chris \f(CW\*(C`BinGOs\*(C'\fR Williams .SH "LICENSE" .IX Header "LICENSE" Copyright © Chris Williams .PP 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 details. .SH "SEE ALSO" .IX Header "SEE ALSO" Module::Install .PP Software::License