Man page of Software::LicenseUtils

Software::LicenseUtils

Section: User Contributed Perl Documentation (3pm)

Updated: 2014-09-27

Index?action=index Return to Main Contents


NAME

Software::LicenseUtils - little useful bits of code for licensey things

VERSION

version 0.103010

METHODS

guess_license_from_pod

  my @guesses = Software::LicenseUtils->guess_license_from_pod($pm_text);

Given text containing POD, like a .pm file, this method will attempt to guess at the license under which the code is available. This method will either a list of Software::License classes (or instances) or false.

Calling this method in scalar context is a fatal error.

guess_license_from_meta

  my @guesses = Software::LicenseUtils->guess_license_from_meta($meta_str);

Given the content of the META.(yml|json) file found in a CPAN distribution, this method makes a guess as to which licenses may apply to the distribution. It will return a list of zero or more Software::License instances or classes.

guess_license_from_meta_key

  my @guesses = Software::LicenseUtils->guess_license_from_meta_key($key, $v);

This method returns zero or more Software::License classes known to use
 $key
as their META key. If
 $v
is supplied, it specifies whether to treat
 $key
as a v1 or v2 meta entry. Any value other than 1 or 2 will raise an exception.

new_from_short_name

  my $license_object = Software::LicenseUtils->new_from_short_name( {
     short_name => 'GPL-1',
     holder => 'X. Ample'
  }) ;

Create a new Software::License object from the license specified with
 "short_name"
. Known short license names are
 "GPL-*"
,
 "LGPL-*"
,
 "Artistic"
and
 "Artistic-*"
. If the short name is not know, this method will try to create a license object with
 "Software::License::"
and the specified short name (e.g.
 "Software::License::MIT"
with
 "short_name => 'MIT'"
.

AUTHOR

Ricardo Signes <rjbs@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 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.


Index

NAME

VERSION

METHODS

guess_license_from_pod

guess_license_from_meta

guess_license_from_meta_key

new_from_short_name

AUTHOR

COPYRIGHT AND LICENSE