| |
Software::License - phpMan
Software::License(3pm) User Contributed Perl Documentation Software::License(3pm)
NAME
Software::License - packages that provide templated software licenses
VERSION
version 0.104006
SYNOPSIS
my $license = Software::License::Discordian->new({
holder => 'Ricardo Signes',
});
print $output_fh $license->fulltext;
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 <https://github.com/Perl-Toolchain-
Gang/toolchain-site/blob/master/lancaster-consensus.md> of 2013 and the Lyon Amendment of
2023 (described at the linked-to document).
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.
METHODS
new
my $license = $subclass->new(\%arg);
This method returns a new license object for the given license class. Valid arguments
are:
holder
the holder of the copyright; required
year
the year of copyright; defaults to current year
program
the name of software for use in the middle of a sentence
Program
the name of software for use in the beginning of a sentence
"program" and "Program" 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.
year
holder
These methods are attribute readers.
program
Name of software for using in the middle of a sentence.
The method returns value of "program" constructor argument (if it evaluates as true, i. e.
defined, non-empty, non-zero), or value of "Program" constructor argument (if it is true),
or "this program" as the last resort.
Program
Name of software for using in the middle of a sentence.
The method returns value of "Program" constructor argument (if it is true), or value of
"program" constructor argument (if it is true), or "This program" as the last resort.
name
This method returns the name of the license, suitable for shoving in the middle of a
sentence, generally with a leading capitalized "The."
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.
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.
license
This method returns the full text of the license.
fulltext
This method returns the complete text of the license, preceded by the copyright notice.
version
This method returns the version of the license. If the license is not versioned, this
method will return false.
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.
This method may also be invoked as "meta_yml_name" for legacy reasons.
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 "meta_name" returns open_source, restricted,
unrestricted, or unknown, that value will be used.
spdx_expression
This method should return the string with the spdx identifier as indicated by
<https://spdx.org/licenses/>
LOOKING UP LICENSE CLASSES
If you have an entry in a META.yml or META.json file, or similar metadata, and want to
look up the Software::License class to use, there are useful tools in
Software::LicenseUtils.
TODO
· register licenses with aliases to allow $registry->get('gpl', 2);
SEE ALSO
The specific license:
· Software::License::AGPL_3
· Software::License::Apache_1_1
· Software::License::Apache_2_0
· Software::License::Artistic_1_0
· Software::License::Artistic_1_0_Perl
· Software::License::Artistic_2_0
· Software::License::BSD
· Software::License::CC0_1_0
· Software::License::Custom
· Software::License::EUPL_1_1
· Software::License::EUPL_1_2
· Software::License::FreeBSD
· Software::License::GFDL_1_2
· Software::License::GFDL_1_3
· Software::License::GPL_1
· Software::License::GPL_2
· Software::License::GPL_3
· Software::License::LGPL_2_1
· Software::License::LGPL_3_0
· Software::License::MIT
· Software::License::Mozilla_1_0
· Software::License::Mozilla_1_1
· Software::License::Mozilla_2_0
· Software::License::None
· Software::License::OpenSSL
· Software::License::Perl_5
· Software::License::PostgreSQL
· Software::License::QPL_1_0
· Software::License::SSLeay
· Software::License::Sun
· Software::License::Zlib
Extra licenses are maintained on CPAN in separate modules.
The App::Software::License module comes with a script software-license
<https://metacpan.org/pod/distribution/App-Software-License/script/software-license>,
which provides a command-line interface to Software::License.
AUTHOR
Ricardo Signes <cpan AT semiotic.systems>
CONTRIBUTORS
· Alex Kapranoff <kappa AT yandex.ru>
· Andrew Grangaard <granny-github AT ofb.net>
· Axel Beckert <abe AT deuxchevaux.org>
· Bernardo Rechea <brbpub AT gmail.com>
· Bernhard Amann <bernhard AT icsi.edu>
· bowtie <bowtie AT cpan.org>
· Brian Cassidy <bricas AT cpan.org>
· Brian Phillips <bphillips AT digitalriver.com>
· Craig Scrivner <scrivner AT geology.edu>
· Curtis Brandt <curtis AT cpan.org>
· Dave Rolsky <autarch AT urth.org>
· David E. Wheeler <david AT justatheory.com>
· David Golden <dagolden AT cpan.org>
· Dominique Dumont <dod AT debian.org>
· Dylan William Hardison <dylan AT hardison.net>
· Flavio Poletti <flavio AT polettix.it>
· Florian Ragwitz <rafl AT debian.org>
· Graham Knop <haarg AT haarg.org>
· Justin Baker <me AT jbaker.dev>
· jvolkening <jdv AT base2bio.com>
· Kang-min Liu <gugod AT gugod.org>
· Karen Etheridge <ether AT cpan.org>
· Kenichi Ishigaki <ishigaki AT cpan.org>
· Kivanc Yazan <kivancyazan AT gmail.com>
· Leon Timmermans <fawaka AT gmail.com>
· magnolia <magnolia.k AT me.com>
· Marcel Telka <marcel AT telka.sk>
· mikegrb <mgreb AT linode.com>
· Neil Bowers <neil AT bowers.com>
· Nicolas Rochelemagne <rochelemagne AT cpanel.net>
· Olivier Mengue <dolmen AT cpan.org>
· Pablo Rodriguez Gonzalez <pablo.rodriguez.gonzalez AT gmail.com>
· Petr PisaX <ppisar AT redhat.com>
· Ricardo Signes <rjbs AT semiotic.systems>
· Shlomi Fish <shlomif AT iglu.il>
· srchulo <violapiratejunky AT gmail.com>
· Syohei YOSHIDA <syohex AT gmail.com>
· Tomasz Konojacki <me AT xenu.pl>
· Van de Bugger <van.de.bugger AT gmail.com>
· Wesley Schwengle <wesley AT schwengle.net>
COPYRIGHT AND LICENSE
This software is copyright (c) 2024 by Ricardo Signes.
This is free software; you can redistribute it and/or modify it under the same terms as
the Perl 5 programming language system itself.
perl v5.20.2 2024-02-09 Software::License(3pm)
|
