1Software::License(3) User Contributed Perl Documentation Software::License(3)
2
3
4
6 Software::License - packages that provide templated software licenses
7
9 version 0.104004
10
12 my $license = Software::License::Discordian->new({
13 holder => 'Ricardo Signes',
14 });
15
16 print $output_fh $license->fulltext;
17
19 This module is part of CPAN toolchain, or is treated as such. As such,
20 it follows the agreement of the Perl Toolchain Gang to require no newer
21 version of perl than one released in the last ten years. This version
22 may change by agreement of the Toolchain Gang, but for now is governed
23 by the Lancaster Consensus <https://github.com/Perl-Toolchain-
24 Gang/toolchain-site/blob/master/lancaster-consensus.md> of 2013 and the
25 Lyon Amendment of 2023 (described at the linked-to document).
26
27 Although it may work on older versions of perl, no guarantee is made
28 that the minimum required version will not be increased. The version
29 may be increased for any reason, and there is no promise that patches
30 will be accepted to lower the minimum required perl.
31
33 new
34 my $license = $subclass->new(\%arg);
35
36 This method returns a new license object for the given license class.
37 Valid arguments are:
38
39 holder
40 the holder of the copyright; required
41
42 year
43 the year of copyright; defaults to current year
44
45 program
46 the name of software for use in the middle of a sentence
47
48 Program
49 the name of software for use in the beginning of a sentence
50
51 "program" and "Program" arguments may be specified both, either one or
52 none. Each argument, if not specified, is defaulted to another one, or
53 to properly capitalized "this program", if both arguments are omitted.
54
55 year
56 holder
57 These methods are attribute readers.
58
59 program
60 Name of software for using in the middle of a sentence.
61
62 The method returns value of "program" constructor argument (if it
63 evaluates as true, i. e. defined, non-empty, non-zero), or value of
64 "Program" constructor argument (if it is true), or "this program" as
65 the last resort.
66
67 Program
68 Name of software for using in the middle of a sentence.
69
70 The method returns value of "Program" constructor argument (if it is
71 true), or value of "program" constructor argument (if it is true), or
72 "This program" as the last resort.
73
74 name
75 This method returns the name of the license, suitable for shoving in
76 the middle of a sentence, generally with a leading capitalized "The."
77
78 url
79 This method returns the URL at which a canonical text of the license
80 can be found, if one is available. If possible, this will point at
81 plain text, but it may point to an HTML resource.
82
83 notice
84 This method returns a snippet of text, usually a few lines, indicating
85 the copyright holder and year of copyright, as well as an indication of
86 the license under which the software is distributed.
87
88 license
89 This method returns the full text of the license.
90
91 fulltext
92 This method returns the complete text of the license, preceded by the
93 copyright notice.
94
95 version
96 This method returns the version of the license. If the license is not
97 versioned, this method will return false.
98
99 meta_name
100 This method returns the string that should be used for this license in
101 the CPAN META.yml file, according to the CPAN Meta spec v1, or undef if
102 there is no known string to use.
103
104 This method may also be invoked as "meta_yml_name" for legacy reasons.
105
106 meta2_name
107 This method returns the string that should be used for this license in
108 the CPAN META.json or META.yml file, according to the CPAN Meta spec
109 v2, or undef if there is no known string to use. If this method does
110 not exist, and "meta_name" returns open_source, restricted,
111 unrestricted, or unknown, that value will be used.
112
113 spdx_expression
114 This method should return the string with the spdx identifier as
115 indicated by <https://spdx.org/licenses/>
116
118 If you have an entry in a META.yml or META.json file, or similar
119 metadata, and want to look up the Software::License class to use, there
120 are useful tools in Software::LicenseUtils.
121
123 • register licenses with aliases to allow $registry->get('gpl', 2);
124
126 The specific license:
127
128 • Software::License::AGPL_3
129
130 • Software::License::Apache_1_1
131
132 • Software::License::Apache_2_0
133
134 • Software::License::Artistic_1_0
135
136 • Software::License::Artistic_1_0_Perl
137
138 • Software::License::Artistic_2_0
139
140 • Software::License::BSD
141
142 • Software::License::CC0_1_0
143
144 • Software::License::Custom
145
146 • Software::License::EUPL_1_1
147
148 • Software::License::EUPL_1_2
149
150 • Software::License::FreeBSD
151
152 • Software::License::GFDL_1_2
153
154 • Software::License::GFDL_1_3
155
156 • Software::License::GPL_1
157
158 • Software::License::GPL_2
159
160 • Software::License::GPL_3
161
162 • Software::License::LGPL_2_1
163
164 • Software::License::LGPL_3_0
165
166 • Software::License::MIT
167
168 • Software::License::Mozilla_1_0
169
170 • Software::License::Mozilla_1_1
171
172 • Software::License::Mozilla_2_0
173
174 • Software::License::None
175
176 • Software::License::OpenSSL
177
178 • Software::License::Perl_5
179
180 • Software::License::PostgreSQL
181
182 • Software::License::QPL_1_0
183
184 • Software::License::SSLeay
185
186 • Software::License::Sun
187
188 • Software::License::Zlib
189
190 Extra licenses are maintained on CPAN in separate modules.
191
192 The App::Software::License module comes with a script software-license
193 <https://metacpan.org/pod/distribution/App-Software-
194 License/script/software-license>, which provides a command-line
195 interface to Software::License.
196
198 Ricardo Signes <rjbs@semiotic.systems>
199
201 • Alex Kapranoff <kappa@yandex.ru>
202
203 • Andrew Grangaard <granny-github@ofb.net>
204
205 • Axel Beckert <abe@deuxchevaux.org>
206
207 • Bernardo Rechea <brbpub@gmail.com>
208
209 • Bernhard Amann <bernhard@icsi.berkeley.edu>
210
211 • bowtie <bowtie@cpan.org>
212
213 • Brian Cassidy <bricas@cpan.org>
214
215 • Brian Phillips <bphillips@digitalriver.com>
216
217 • Craig Scrivner <scrivner@geology.cwu.edu>
218
219 • Curtis Brandt <curtis@cpan.org>
220
221 • Dave Rolsky <autarch@urth.org>
222
223 • David E. Wheeler <david@justatheory.com>
224
225 • David Golden <dagolden@cpan.org>
226
227 • Dominique Dumont <dod@debian.org>
228
229 • Dylan William Hardison <dylan@hardison.net>
230
231 • Flavio Poletti <flavio@polettix.it>
232
233 • Florian Ragwitz <rafl@debian.org>
234
235 • Graham Knop <haarg@haarg.org>
236
237 • Justin Baker <me@jbaker.dev>
238
239 • Kang-min Liu <gugod@gugod.org>
240
241 • Karen Etheridge <ether@cpan.org>
242
243 • Kenichi Ishigaki <ishigaki@cpan.org>
244
245 • Kivanc Yazan <kivancyazan@gmail.com>
246
247 • Leon Timmermans <fawaka@gmail.com>
248
249 • magnolia <magnolia.k@me.com>
250
251 • Marcel Telka <marcel@telka.sk>
252
253 • mikegrb <mgreb@linode.com>
254
255 • Neil Bowers <neil@bowers.com>
256
257 • Nicolas Rochelemagne <rochelemagne@cpanel.net>
258
259 • Olivier Mengué <dolmen@cpan.org>
260
261 • Pablo Rodríguez González <pablo.rodriguez.gonzalez@gmail.com>
262
263 • Petr Písař <ppisar@redhat.com>
264
265 • Shlomi Fish <shlomif@iglu.org.il>
266
267 • srchulo <violapiratejunky@gmail.com>
268
269 • Syohei YOSHIDA <syohex@gmail.com>
270
271 • Tomasz Konojacki <me@xenu.pl>
272
273 • Van de Bugger <van.de.bugger@gmail.com>
274
275 • Wesley Schwengle <wesley@schwengle.net>
276
278 This software is copyright (c) 2023 by Ricardo Signes.
279
280 This is free software; you can redistribute it and/or modify it under
281 the same terms as the Perl 5 programming language system itself.
282
283
284
285perl v5.38.0 2023-07-21 Software::License(3)