.\" -*- 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 "Software::License 3pm" .TH Software::License 3pm 2024-02-14 "perl v5.38.2" "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 Software::License \- packages that provide templated software licenses .SH VERSION .IX Header "VERSION" version 0.104006 .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 3 \& my $license = Software::License::Discordian\->new({ \& holder => \*(AqRicardo Signes\*(Aq, \& }); \& \& print $output_fh $license\->fulltext; .Ve .SH "PERL VERSION" .IX Header "PERL VERSION" This module is part of CPAN toolchain, or is treated as such. As such, it follows the agreement of the Perl Toolchain Gang to require no newer version of perl than one released in the last ten years. This version may change by agreement of the Toolchain Gang, but for now is governed by the Lancaster Consensus of 2013 and the Lyon Amendment of 2023 (described at the linked-to document). .PP Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl. .SH METHODS .IX Header "METHODS" .SS new .IX Subsection "new" .Vb 1 \& my $license = $subclass\->new(\e%arg); .Ve .PP This method returns a new license object for the given license class. Valid arguments are: .IP holder 4 .IX Item "holder" the holder of the copyright; required .IP year 4 .IX Item "year" the year of copyright; defaults to current year .IP program 4 .IX Item "program" the name of software for use in the middle of a sentence .IP Program 4 .IX Item "Program" the name of software for use in the beginning of a sentence .PP \&\f(CW\*(C`program\*(C'\fR and \f(CW\*(C`Program\*(C'\fR arguments may be specified both, either one or none. Each argument, if not specified, is defaulted to another one, or to properly capitalized "this program", if both arguments are omitted. .SS year .IX Subsection "year" .SS holder .IX Subsection "holder" These methods are attribute readers. .SS program .IX Subsection "program" Name of software for using in the middle of a sentence. .PP The method returns value of \f(CW\*(C`program\*(C'\fR constructor argument (if it evaluates as true, i. e. defined, non-empty, non-zero), or value of \f(CW\*(C`Program\*(C'\fR constructor argument (if it is true), or "this program" as the last resort. .SS Program .IX Subsection "Program" Name of software for using in the middle of a sentence. .PP The method returns value of \f(CW\*(C`Program\*(C'\fR constructor argument (if it is true), or value of \f(CW\*(C`program\*(C'\fR constructor argument (if it is true), or "This program" as the last resort. .SS name .IX Subsection "name" This method returns the name of the license, suitable for shoving in the middle of a sentence, generally with a leading capitalized "The." .SS url .IX Subsection "url" This method returns the URL at which a canonical text of the license can be found, if one is available. If possible, this will point at plain text, but it may point to an HTML resource. .SS notice .IX Subsection "notice" This method returns a snippet of text, usually a few lines, indicating the copyright holder and year of copyright, as well as an indication of the license under which the software is distributed. .SS license .IX Subsection "license" This method returns the full text of the license. .SS fulltext .IX Subsection "fulltext" This method returns the complete text of the license, preceded by the copyright notice. .SS version .IX Subsection "version" This method returns the version of the license. If the license is not versioned, this method will return false. .SS meta_name .IX Subsection "meta_name" This method returns the string that should be used for this license in the CPAN META.yml file, according to the CPAN Meta spec v1, or undef if there is no known string to use. .PP This method may also be invoked as \f(CW\*(C`meta_yml_name\*(C'\fR for legacy reasons. .SS meta2_name .IX Subsection "meta2_name" This method returns the string that should be used for this license in the CPAN META.json or META.yml file, according to the CPAN Meta spec v2, or undef if there is no known string to use. If this method does not exist, and \&\f(CW\*(C`meta_name\*(C'\fR returns open_source, restricted, unrestricted, or unknown, that value will be used. .SS spdx_expression .IX Subsection "spdx_expression" This method should return the string with the spdx identifier as indicated by .SH "LOOKING UP LICENSE CLASSES" .IX Header "LOOKING UP LICENSE CLASSES" If you have an entry in a \fIMETA.yml\fR or \fIMETA.json\fR file, or similar metadata, and want to look up the Software::License class to use, there are useful tools in Software::LicenseUtils. .SH TODO .IX Header "TODO" .IP \(bu 4 register licenses with aliases to allow \f(CW$registry\fR\->get('gpl', 2); .SH "SEE ALSO" .IX Header "SEE ALSO" The specific license: .IP \(bu 4 Software::License::AGPL_3 .IP \(bu 4 Software::License::Apache_1_1 .IP \(bu 4 Software::License::Apache_2_0 .IP \(bu 4 Software::License::Artistic_1_0 .IP \(bu 4 Software::License::Artistic_1_0_Perl .IP \(bu 4 Software::License::Artistic_2_0 .IP \(bu 4 Software::License::BSD .IP \(bu 4 Software::License::CC0_1_0 .IP \(bu 4 Software::License::Custom .IP \(bu 4 Software::License::EUPL_1_1 .IP \(bu 4 Software::License::EUPL_1_2 .IP \(bu 4 Software::License::FreeBSD .IP \(bu 4 Software::License::GFDL_1_2 .IP \(bu 4 Software::License::GFDL_1_3 .IP \(bu 4 Software::License::GPL_1 .IP \(bu 4 Software::License::GPL_2 .IP \(bu 4 Software::License::GPL_3 .IP \(bu 4 Software::License::LGPL_2_1 .IP \(bu 4 Software::License::LGPL_3_0 .IP \(bu 4 Software::License::MIT .IP \(bu 4 Software::License::Mozilla_1_0 .IP \(bu 4 Software::License::Mozilla_1_1 .IP \(bu 4 Software::License::Mozilla_2_0 .IP \(bu 4 Software::License::None .IP \(bu 4 Software::License::OpenSSL .IP \(bu 4 Software::License::Perl_5 .IP \(bu 4 Software::License::PostgreSQL .IP \(bu 4 Software::License::QPL_1_0 .IP \(bu 4 Software::License::SSLeay .IP \(bu 4 Software::License::Sun .IP \(bu 4 Software::License::Zlib .PP Extra licenses are maintained on CPAN in separate modules. .PP The App::Software::License module comes with a script software-license , which provides a command-line interface to Software::License. .SH AUTHOR .IX Header "AUTHOR" Ricardo Signes .SH CONTRIBUTORS .IX Header "CONTRIBUTORS" .IP \(bu 4 Alex Kapranoff .IP \(bu 4 Andrew Grangaard .IP \(bu 4 Axel Beckert .IP \(bu 4 Bernardo Rechea .IP \(bu 4 Bernhard Amann .IP \(bu 4 bowtie .IP \(bu 4 Brian Cassidy .IP \(bu 4 Brian Phillips .IP \(bu 4 Craig Scrivner .IP \(bu 4 Curtis Brandt .IP \(bu 4 Dave Rolsky .IP \(bu 4 David E. Wheeler .IP \(bu 4 David Golden .IP \(bu 4 Dominique Dumont .IP \(bu 4 Dylan William Hardison .IP \(bu 4 Flavio Poletti .IP \(bu 4 Florian Ragwitz .IP \(bu 4 Graham Knop .IP \(bu 4 Justin Baker .IP \(bu 4 jvolkening .IP \(bu 4 Kang-min Liu .IP \(bu 4 Karen Etheridge .IP \(bu 4 Kenichi Ishigaki .IP \(bu 4 Kivanc Yazan .IP \(bu 4 Leon Timmermans .IP \(bu 4 magnolia .IP \(bu 4 Marcel Telka .IP \(bu 4 mikegrb .IP \(bu 4 Neil Bowers .IP \(bu 4 Nicolas Rochelemagne .IP \(bu 4 Olivier Mengué .IP \(bu 4 Pablo Rodríguez González .IP \(bu 4 Petr Písař .IP \(bu 4 Ricardo Signes .IP \(bu 4 Shlomi Fish .IP \(bu 4 srchulo .IP \(bu 4 Syohei YOSHIDA .IP \(bu 4 Tomasz Konojacki .IP \(bu 4 Van de Bugger .IP \(bu 4 Wesley Schwengle .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2024 by Ricardo Signes. .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.