.\" 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 "String::License::Naming::SPDX 3pm" .TH String::License::Naming::SPDX 3pm "2023-01-15" "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" String::License::Naming::SPDX \- licenses as named by SPDX .SH "VERSION" .IX Header "VERSION" Version v0.0.2 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use String::License::Naming::SPDX; \& \& my $spdx = String::License::Naming::SPDX\->new; \& \& my $license = [ grep { /^(Expat|Perl)$/ } $spdx\->list_licenses ]; # => is_deeply [\*(AqPerl\*(Aq] .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" String::License::Naming enumerates supported licenses matching an ordered set of naming schemes, or enumerates the names of supported license naming schemes. .PP Some licenses are known by different names. E.g. the license \*(L"\s-1MIT\*(R"\s0 according to \s-1SPDX\s0 is named \*(L"Expat\*(R" in Debian. .PP Some licenses are not always represented. E.g. \*(L"Perl\*(R" is a (discouraged) license in Debian while it is a relationship of several licenses with \s-1SPDX\s0 (and that expression is recommended in Debian as well). .PP By default, licenses are matched using naming schemes \f(CW\*(C`[ \*(Aqspdx\*(Aq, \*(Aqinternal\*(Aq ]\*(C'\fR, which lists all supported licenses, preferrably by their \s-1SPDX\s0 name or as fallback by an internal name. .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .IP "new" 4 .IX Item "new" Constructs and returns a String::License::Naming object. .Sp Includes all licenses defined by \s-1SPDX,\s0 and presents them by their \s-1SPDX\s0 shortname. .SH "FUNCTIONS" .IX Header "FUNCTIONS" .IP "list_schemes" 4 .IX Item "list_schemes" Returns a list of license naming schemes in use. .IP "list_licenses" 4 .IX Item "list_licenses" Returns a list of all licensing patterns covered by \s-1SPDX,\s0 each labeled by \s-1SPDX\s0 shortname. .SH "AUTHOR" .IX Header "AUTHOR" Jonas Smedegaard \f(CW\*(C`\*(C'\fR .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" .Vb 1 \& Copyright © 2023 Jonas Smedegaard .Ve .PP This program is free software: you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 Affero General Public License as published by the Free Software Foundation, either version 3, or (at your option) any later version. .PP This program is distributed in the hope that it will be useful, but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the \s-1GNU\s0 Affero General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 Affero General Public License along with this program. If not, see . .SH "POD ERRORS" .IX Header "POD ERRORS" Hey! \fBThe above document had some coding errors, which are explained below:\fR .IP "Around line 90:" 4 .IX Item "Around line 90:" \&'=item' outside of any '=over'