1Software::License(3)  User Contributed Perl Documentation Software::License(3)
2
3
4

NAME

6       Software::License - packages that provide templated software licenses
7

VERSION

9       version 0.104001
10

SYNOPSIS

12         my $license = Software::License::Discordian->new({
13           holder => 'Ricardo Signes',
14         });
15
16         print $output_fh $license->fulltext;
17

METHODS

19   new
20         my $license = $subclass->new(\%arg);
21
22       This method returns a new license object for the given license class.
23       Valid arguments are:
24
25       holder
26           the holder of the copyright; required
27
28       year
29           the year of copyright; defaults to current year
30
31       program
32           the name of software for use in the middle of a sentence
33
34       Program
35           the name of software for use in the beginning of a sentence
36
37       "program" and "Program" arguments may be specified both, either one or
38       none.  Each argument, if not specified, is defaulted to another one, or
39       to properly capitalized "this program", if both arguments are omitted.
40
41   year
42   holder
43       These methods are attribute readers.
44
45   program
46       Name of software for using in the middle of a sentence.
47
48       The method returns value of "program" constructor argument (if it
49       evaluates as true, i. e.  defined, non-empty, non-zero), or value of
50       "Program" constructor argument (if it is true), or "this program" as
51       the last resort.
52
53   Program
54       Name of software for using in the middle of a sentence.
55
56       The method returns value of "Program" constructor argument (if it is
57       true), or value of "program" constructor argument (if it is true), or
58       "This program" as the last resort.
59
60   name
61       This method returns the name of the license, suitable for shoving in
62       the middle of a sentence, generally with a leading capitalized "The."
63
64   url
65       This method returns the URL at which a canonical text of the license
66       can be found, if one is available.  If possible, this will point at
67       plain text, but it may point to an HTML resource.
68
69   notice
70       This method returns a snippet of text, usually a few lines, indicating
71       the copyright holder and year of copyright, as well as an indication of
72       the license under which the software is distributed.
73
74   license
75       This method returns the full text of the license.
76
77   fulltext
78       This method returns the complete text of the license, preceded by the
79       copyright notice.
80
81   version
82       This method returns the version of the license.  If the license is not
83       versioned, this method will return false.
84
85   meta_name
86       This method returns the string that should be used for this license in
87       the CPAN META.yml file, according to the CPAN Meta spec v1, or undef if
88       there is no known string to use.
89
90       This method may also be invoked as "meta_yml_name" for legacy reasons.
91
92   meta2_name
93       This method returns the string that should be used for this license in
94       the CPAN META.json or META.yml file, according to the CPAN Meta spec
95       v2, or undef if there is no known string to use.  If this method does
96       not exist, and "meta_name" returns open_source, restricted,
97       unrestricted, or unknown, that value will be used.
98
99   spdx_expression
100       This method should return the string with the spdx identifier as
101       indicated by <https://spdx.org/licenses/>
102

LOOKING UP LICENSE CLASSES

104       If you have an entry in a META.yml or META.json file, or similar
105       metadata, and want to look up the Software::License class to use, there
106       are useful tools in Software::LicenseUtils.
107

TODO

109       •   register licenses with aliases to allow $registry->get('gpl', 2);
110

SEE ALSO

112       The specific license:
113
114       •   Software::License::AGPL_3
115
116       •   Software::License::Apache_1_1
117
118       •   Software::License::Apache_2_0
119
120       •   Software::License::Artistic_1_0
121
122       •   Software::License::Artistic_2_0
123
124       •   Software::License::BSD
125
126       •   Software::License::CC0_1_0
127
128       •   Software::License::Custom
129
130       •   Software::License::EUPL_1_1
131
132       •   Software::License::EUPL_1_2
133
134       •   Software::License::FreeBSD
135
136       •   Software::License::GFDL_1_2
137
138       •   Software::License::GFDL_1_3
139
140       •   Software::License::GPL_1
141
142       •   Software::License::GPL_2
143
144       •   Software::License::GPL_3
145
146       •   Software::License::LGPL_2_1
147
148       •   Software::License::LGPL_3_0
149
150       •   Software::License::MIT
151
152       •   Software::License::Mozilla_1_0
153
154       •   Software::License::Mozilla_1_1
155
156       •   Software::License::Mozilla_2_0
157
158       •   Software::License::None
159
160       •   Software::License::OpenSSL
161
162       •   Software::License::Perl_5
163
164       •   Software::License::PostgreSQL
165
166       •   Software::License::QPL_1_0
167
168       •   Software::License::SSLeay
169
170       •   Software::License::Sun
171
172       •   Software::License::Zlib
173
174       Extra licenses are maintained on CPAN in separate modules.
175
176       The App::Software::License module comes with a script software-license
177       <https://metacpan.org/pod/distribution/App-Software-
178       License/script/software-license>, which provides a command-line
179       interface to Software::License.
180

AUTHOR

182       Ricardo Signes <rjbs@semiotic.systems>
183

CONTRIBUTORS

185       •   Alex Kapranoff <kappa@yandex.ru>
186
187       •   Andrew Grangaard <granny-github@ofb.net>
188
189       •   Axel Beckert <abe@deuxchevaux.org>
190
191       •   Bernardo Rechea <brbpub@gmail.com>
192
193       •   Bernhard Amann <bernhard@icsi.berkeley.edu>
194
195       •   bowtie <bowtie@cpan.org>
196
197       •   Brian Cassidy <bricas@cpan.org>
198
199       •   Brian Phillips <bphillips@digitalriver.com>
200
201       •   Craig Scrivner <scrivner@geology.cwu.edu>
202
203       •   Curtis Brandt <curtis@cpan.org>
204
205       •   Dave Rolsky <autarch@urth.org>
206
207       •   David E. Wheeler <david@justatheory.com>
208
209       •   David Golden <dagolden@cpan.org>
210
211       •   Dominique Dumont <dod@debian.org>
212
213       •   Dylan William Hardison <dylan@hardison.net>
214
215       •   Flavio Poletti <flavio@polettix.it>
216
217       •   Florian Ragwitz <rafl@debian.org>
218
219       •   Graham Knop <haarg@haarg.org>
220
221       •   Kang-min Liu <gugod@gugod.org>
222
223       •   Karen Etheridge <ether@cpan.org>
224
225       •   Kenichi Ishigaki <ishigaki@cpan.org>
226
227       •   Kivanc Yazan <kivancyazan@gmail.com>
228
229       •   Leon Timmermans <fawaka@gmail.com>
230
231       •   magnolia <magnolia.k@me.com>
232
233       •   mikegrb <mgreb@linode.com>
234
235       •   Neil Bowers <neil@bowers.com>
236
237       •   Nicolas Rochelemagne <rochelemagne@cpanel.net>
238
239       •   Olivier Mengué <dolmen@cpan.org>
240
241       •   Pablo Rodríguez González <pablo.rodriguez.gonzalez@gmail.com>
242
243       •   Shlomi Fish <shlomif@iglu.org.il>
244
245       •   Syohei YOSHIDA <syohex@gmail.com>
246
247       •   Tomasz Konojacki <me@xenu.pl>
248
249       •   Van de Bugger <van.de.bugger@gmail.com>
250
251       •   Wesley Schwengle <wesley@schwengle.net>
252

254       This software is copyright (c) 2021 by Ricardo Signes.
255
256       This is free software; you can redistribute it and/or modify it under
257       the same terms as the Perl 5 programming language system itself.
258
259
260
261perl v5.34.0                      2022-01-21              Software::License(3)
Impressum