debian man page for software::license

Software::License(3pm)					User Contributed Perl Documentation				    Software::License(3pm)

NAME
       Software::License - packages that provide templated software licenses

VERSION
       version 0.103004

SYNOPSIS
	 my $license = Software::License::Discordian->new({
	   holder => 'Ricardo Signes',
	 });

	 print $output_fh $license->fulltext;

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

   new_from_short_name
	my $license = Software::License -> new_from_short_name(
	  { short_name => 'GPL-1', %arg }
	);

       This constructor will return the correct subclass depending on "short_name" value.

   year
   holder
       These methods are attribute readers.

   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.

   summary
       This method returns a summary of the license. This summary must contains refer to a file containing the whole license. On Debian system,
       the file containing the whole license will be in "/usr/share/common-licenses/" directory.

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
       o   register licenses with aliases to allow $registry->get('gpl', 2);

SEE ALSO
       The specific license:

       o   Software::License::AGPL_3

       o   Software::License::Apache_1_1

       o   Software::License::Apache_2_0

       o   Software::License::Artistic_1_0

       o   Software::License::Artistic_2_0

       o   Software::License::BSD

       o   Software::License::CC0

       o   Software::License::FreeBSD

       o   Software::License::GFDL_1_2

       o   Software::License::GPL_1

       o   Software::License::GPL_2

       o   Software::License::GPL_3

       o   Software::License::LGPL_2_1

       o   Software::License::LGPL_3_0

       o   Software::License::MIT

       o   Software::License::Mozilla_1_0

       o   Software::License::Mozilla_1_1

       o   Software::License::None

       o   Software::License::OpenSSL

       o   Software::License::Perl_5

       o   Software::License::QPL_1_0

       o   Software::License::SSLeay

       o   Software::License::Sun

       o   Software::License::Zlib

AUTHOR
       Ricardo Signes <rjbs@cpan.org>

COPYRIGHT AND LICENSE
       This software is copyright (c) 2011 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.14.2							    2012-03-23						    Software::License(3pm)