.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 "Software::LicenseMoreUtils 3pm"
.TH Software::LicenseMoreUtils 3pm "2020-11-21" "perl v5.32.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"
Software::LicenseMoreUtils \- More utilities and a summary for Software::License
.SH "VERSION"
.IX Header "VERSION"
version 1.005
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Software::LicenseMoreUtils;
\&
\& my $lic = Software::LicenseMoreUtils\->new_from_short_name({
\&    short_name => \*(AqApache\-2.0\*(Aq, # or GPL\-2+, Artistic\-2 ...
\&    holder => \*(AqX. Ample\*(Aq
\& });
\&
\& # On Debian, return a license summary, returns license text elsewhere
\& my $text = $lic\->summary_or_text;
\&
\& # returns license full text
\& my $text = $lic\->text;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides more utilities for Software::License:
.IP "\(bu" 4
Method \*(L"new_from_short_name\*(R" returns a
Software::LicenseMoreUtils::LicenseWithSummary object that provides all
functionalities of \f(CW\*(C`Software::License::*\*(C'\fR objects and a summary on
some Linux distribution (see below).
.IP "\(bu" 4
\&\*(L"new_from_short_name\*(R" accepts more short names than
Software::LicenseUtils
.IP "\(bu" 4
\&\*(L"new_from_short_name\*(R" accepts \*(L"or any later version\*(R" variant of \s-1GPL\s0
licenses. When a short name like \f(CW\*(C`GPL\-3+\*(C'\fR is used, the license
summary contains \*(L"or (at your option) any later version\*(R" statement.
.IP "\(bu" 4
Software::License::LGPL\-2 license is also provided. Even though
license \f(CW\*(C`LGPL\-2.1\*(C'\fR is preferred over \f(CW\*(C`LGPL\-2\*(C'\fR, some software in
Debian use \f(CW\*(C`LGPL\-2\*(C'\fR.
.SH "License summary"
.IX Header "License summary"
In some distribution like Debian, all packages should come with the
full text of the licenses of the package software.
.PP
To avoid many duplication of long license text, the text of the most
common licenses are provided in \f(CW\*(C`/usr/share/common\-licenses\*(C'\fR
directory. Then the license text of a package need only to provide a
summary of the license that refer to the location of the common
license.
.PP
All summaries are provided for Debian (so for Ubuntu). Other
distributions are welcome to send pull request for their license
summaries.
.SH "Methods"
.IX Header "Methods"
.SS "new_from_short_name"
.IX Subsection "new_from_short_name"
.Vb 4
\& my $license_object = Software::LicenseMoreUtils\->new_from_short_name({
\&      short_name => \*(AqGPL\-1\*(Aq,
\&      holder => \*(AqX. Ample\*(Aq
\& }) ;
.Ve
.PP
Returns a new Software::LicenseMoreUtils::LicenseWithSummary object
which is a Software::License wrapped with a summary. This is a
drop-in replacement for the Software::License object as all methods
are delegated to the underlying Software::License object.
.PP
Known short license names are \f(CW\*(C`GPL\-*\*(C'\fR, \f(CW\*(C`LGPL\-*\*(C'\fR , and their \*(L"or
later version\*(R" variant \f(CW\*(C`GPL\-*+\*(C'\fR, \f(CW\*(C`LGPL\-*+\*(C'\fR \f(CW\*(C`Artistic\*(C'\fR and
\&\f(CW\*(C`Artistic\-*\*(C'\fR. Unlike vanilla Software::License, this module
accepts license name with \*(L"\-\*(R" (e.g. \f(CW\*(C`GPL\-2\*(C'\fR) along with \*(L"_\*(R"
(e.g. "\f(CW\*(C`GPL_2\*(C'\fR")
.PP
If the short name is not known, this method tries to create a license
object with \f(CW\*(C`Software::License\*(C'\fR and the specified short name
(e.g. \f(CW\*(C`Software::License::MIT\*(C'\fR with \f(CW\*(C`short_name => \*(AqMIT\*(Aq\*(C'\fR or
\&\f(CW\*(C`Software::License::Apache_2_0\*(C'\fR with \f(CW\*(C`short_name => \*(AqApache\-2.0\*(Aq\*(C'\fR).
.SH "AUTHOR"
.IX Header "AUTHOR"
Dominique Dumont
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2018 by Dominique Dumont.
.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.