.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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 "Sub::Install 3"
.TH Sub::Install 3 2026-04-21 "perl v5.42.2" "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 SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Sub::Install;
\&
\&  Sub::Install::install_sub({
\&    code => sub { ... },
\&    into => $package,
\&    as   => $subname
\&  });
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module makes it easy to install subroutines into packages without the
unsightly mess of \f(CW\*(C`no strict\*(C'\fR or typeglobs lying about where just anyone can
see them.
.PP
.Vb 5
\&  Sub::Install::install_sub({
\&   code => \e&subroutine,
\&   into => "Finance::Shady",
\&   as   => \*(Aqlaunder\*(Aq,
\&  });
.Ve
.PP
This routine installs a given code reference into a package as a normal
subroutine.  The above is equivalent to:
.PP
.Vb 2
\&  no strict \*(Aqrefs\*(Aq;
\&  *{"Finance::Shady" . \*(Aq::\*(Aq . "launder"} = \e&subroutine;
.Ve
.PP
If \f(CW\*(C`into\*(C'\fR is not given, the sub is installed into the calling package.
.PP
If \f(CW\*(C`code\*(C'\fR is not a code reference, it is looked for as an existing sub in the
package named in the \f(CW\*(C`from\*(C'\fR parameter.  If \f(CW\*(C`from\*(C'\fR is not given, it will look
in the calling package.
.PP
If \f(CW\*(C`as\*(C'\fR is not given, and if \f(CW\*(C`code\*(C'\fR is a name, \f(CW\*(C`as\*(C'\fR will default to \f(CW\*(C`code\*(C'\fR.
If \f(CW\*(C`as\*(C'\fR is not given, but if \f(CW\*(C`code\*(C'\fR is a code ref, Sub::Install will try to
find the name of the given code ref and use that as \f(CW\*(C`as\*(C'\fR.
.PP
That means that this code:
.PP
.Vb 6
\&  Sub::Install::install_sub({
\&    code => \*(Aqtwitch\*(Aq,
\&    from => \*(AqPerson::InPain\*(Aq,
\&    into => \*(AqPerson::Teenager\*(Aq,
\&    as   => \*(Aqdance\*(Aq,
\&  });
.Ve
.PP
is the same as:
.PP
.Vb 1
\&  package Person::Teenager;
\&
\&  Sub::Install::install_sub({
\&    code => Person::InPain\->can(\*(Aqtwitch\*(Aq),
\&    as   => \*(Aqdance\*(Aq,
\&  });
.Ve
.PP
This routine behaves exactly like \f(CW"install_sub"\fR, but does not emit a
warning if warnings are on and the destination is already defined.
.PP
This routine is provided to allow Sub::Install compatibility with
Sub::Installer.  It installs \f(CW\*(C`install_sub\*(C'\fR and \f(CW\*(C`reinstall_sub\*(C'\fR methods into
the package named by its argument.
.PP
.Vb 2
\& Sub::Install::install_installers(\*(AqCode::Builder\*(Aq); # just for us, please
\& Code::Builder\->install_sub({ name => $code_ref });
\&
\& Sub::Install::install_installers(\*(AqUNIVERSAL\*(Aq); # feeling lucky, punk?
\& Anything::At::All\->install_sub({ name => $code_ref });
.Ve
.PP
The installed installers are similar, but not identical, to those provided by
Sub::Installer.  They accept a single hash as an argument.  The key/value pairs
are used as the \f(CW\*(C`as\*(C'\fR and \f(CW\*(C`code\*(C'\fR parameters to the \f(CW\*(C`install_sub\*(C'\fR routine
detailed above.  The package name on which the method is called is used as the
\&\f(CW\*(C`into\*(C'\fR parameter.
.PP
Unlike Sub::Installer\*(Aqs \f(CW\*(C`install_sub\*(C'\fR will not eval strings into code, but
will look for named code in the calling package.
.SH EXPORTS
.IX Header "EXPORTS"
Sub::Install exports \f(CW\*(C`install_sub\*(C'\fR and \f(CW\*(C`reinstall_sub\*(C'\fR only if they are
requested.
.SS exporter
.IX Subsection "exporter"
Sub::Install has a never\-exported subroutine called \f(CW\*(C`exporter\*(C'\fR, which is used
to implement its \f(CW\*(C`import\*(C'\fR routine.  It takes a hashref of named arguments,
only one of which is currently recognize: \f(CW\*(C`exports\*(C'\fR.  This must be an arrayref
of subroutines to offer for export.
.PP
This routine is mainly for Sub::Install\*(Aqs own consumption.  Instead, consider
Sub::Exporter.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP Sub::Installer 4
.IX Item "Sub::Installer"
This module is (obviously) a reaction to Damian Conway\*(Aqs Sub::Installer, which
does the same thing, but does it by getting its greasy fingers all over
UNIVERSAL.  I was really happy about the idea of making the installation of
coderefs less ugly, but I couldn\*(Aqt bring myself to replace the ugliness of
typeglobs and loosened strictures with the ugliness of UNIVERSAL methods.
.IP Sub::Exporter 4
.IX Item "Sub::Exporter"
This is a complete Exporter.pm replacement, built atop Sub::Install.
.SH "EXTRA CREDITS"
.IX Header "EXTRA CREDITS"
Several of the tests are adapted from tests that shipped with Damian Conway\*(Aqs
Sub\-Installer distribution.
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 26:" 4
.IX Item "Around line 26:"
Unknown directive: =func
.IP "Around line 68:" 4
.IX Item "Around line 68:"
Unknown directive: =func
.IP "Around line 197:" 4
.IX Item "Around line 197:"
Unknown directive: =func