.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.48)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Software::License::Custom 3"
.TH Software::License::Custom 3 2026-10-26 "perl v5.44.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 DESCRIPTION
.IX Header "DESCRIPTION"
This module extends Software::License to give the possibility of specifying
all aspects related to a software license in a custom file.  This allows for
setting custom dates, notices, etc. while still preserving compatibility with
all places where Software::License is used, e.g. Dist::Zilla.
.PP
In this way, you should be able to customise some aspects of the licensing
messages that would otherwise be difficult to tinker, e.g. adding a note
in the notice, setting multiple years for the copyright notice or set multiple
authors and/or copyright holders.
.PP
The license details should be put inside a file that contains different
sections. Each section has the following format:
.PP
Each section is terminated by the header of the following section or by
the end of the file. Example:
.PP
.Vb 10
\&   _\|_[ NAME ]_\|_
\&   The Foo\-Bar License
\&   _\|_URL_\|_
\&   http://www.example.com/foo\-bar.txt
\&   _\|_[ META_NAME ]_\|_
\&   foo_bar_meta
\&   _\|_{ META2_NAME }_\|_
\&   foo_bar_meta2
\&   _\|_{ SPDX_EXPRESSION }_\|_
\&   foo_bar_spdx_expression
\&   _\|_[ NOTICE ]_\|_
\&   Copyright (C) 2000\-2002 by P.R. Evious
\&   Copyright (C) {{$self\->year}} by {{$self\->holder}}.
\&
\&   This is free software, licensed under {{$self\->name}}.
\&
\&   _\|_[ LICENSE ]_\|_
\&               The Foo\-Bar License
\&
\&   Well... this is only some sample text.  Verily... only sample text!!!
\&
\&   Yes, spanning more lines and more paragraphs.
.Ve
.PP
The different formats for specifying the section name in the example
above are only examples, you\*(Aqre invited to use a consistent approach.
.PP
.Vb 1
\&   my $slc = Software::License::Custom\->new({filename => \*(AqLEGAL\*(Aq});
.Ve
.PP
Create a new object. Arguments are passed through an anonymous hash, the
following keys are allowed:
.PP
.Vb 1
\&  filename \- the file where the custom software license details are stored
.Ve
.PP
.Vb 1
\&   $slc\->load_sections_from(\*(AqMY\-LEGAL\-ASPECTS\*(Aq);
.Ve
.PP
Loads the different sections of the license from the provided filename.
.PP
Returns the input object.
.PP
.Vb 1
\&   my $notice_template_reference = $slc\->section_data(\*(AqNOTICE\*(Aq);
.Ve
.PP
Returns a reference to a textual template that can be fed to
Text::Template (it could be simple text), according to what is
currently loaded in the object.
.SH "MORE METHODS"
.IX Header "MORE METHODS"
The following methods, found in all software license classes, look up and
render the template with the capitalized form of their name.  In other words,
the \f(CW\*(C`license\*(C'\fR method looks in the \f(CW\*(C`LICENSE\*(C'\fR template.
.PP
For now, the \f(CW\*(C`meta_name\*(C'\fR and \f(CW\*(C`meta2_name\*(C'\fR methods return \f(CW\*(C`custom\*(C'\fR if called
on the class.  This may become fatal in the future.
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 70:" 4
.IX Item "Around line 70:"
Unknown directive: =method
.IP "Around line 93:" 4
.IX Item "Around line 93:"
Unknown directive: =method
.IP "Around line 128:" 4
.IX Item "Around line 128:"
Unknown directive: =method