.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "Module::Install::Admin 3pm"
.TH Module::Install::Admin 3pm 2024-03-06 "perl v5.38.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 NAME
Module::Install::Admin \- Author\-side manager for Module::Install
.SH SYNOPSIS
.IX Header "SYNOPSIS"
In a \fBModule::Install\fR extension module:
.PP
.Vb 4
\&    sub extension_method {
\&        my $self = shift;
\&        $self\->admin\->some_method(@args);
\&    }
.Ve
.PP
As an one-liner:
.PP
.Vb 1
\&    % perl "\-MModule::Install::Admin" \-e\*(Aq&some_method(@args);\*(Aq
.Ve
.PP
The two snippets above are really shorthands for
.PP
.Vb 1
\&    $some_obj\->some_method(@args)
.Ve
.PP
where \f(CW$some_obj\fR is the singleton object of a class under the
\&\f(CW\*(C`Module::Install::Admin::*\*(C'\fR namespace that provides the method
\&\f(CW\*(C`some_method\*(C'\fR.  See "METHODS" for a list of built-in methods.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module implements the internal mechanism for initializing,
including and managing extensions, and should only be of interest to
extension developers; it is \fInever\fR included under a distribution's
\&\fIinc/\fR directory, nor are any of the \fBModule::Install::Admin::*\fR
extensions.
.PP
For normal usage of \fBModule::Install\fR, please see Module::Install
and "COOKBOOK / EXAMPLES" in Module::Install instead.
.SS Bootstrapping
.IX Subsection "Bootstrapping"
When someone runs a \fIMakefile.PL\fR that has \f(CW\*(C`use inc::Module::Install\*(C'\fR,
and there is no \fIinc/\fR in the current directory, \fBModule::Install\fR
will load this module bootstrap itself, through the steps below:
.IP \(bu 4
First, \fIModule/Install.pm\fR is POD-stripped and copied from \f(CW@INC\fR to
\&\fIinc/\fR.  This should only happen on the author's side, never on the
end-user side.
.IP \(bu 4
Reload \fIinc/Module/Install.pm\fR if the current file is somewhere else.
This ensures that the included version of \fIinc/Module/Install.pm\fR is
always preferred over the installed version.
.IP \(bu 4
Look at \fIinc/Module/Install/*.pm\fR and load all of them.
.IP \(bu 4
Set up a \f(CW\*(C`main::AUTOLOAD\*(C'\fR function to delegate missing function calls
to \f(CW\*(C`Module::Install::Admin::load\*(C'\fR \-\- again, this should only happen
at the author's side.
.IP \(bu 4
Provide a \f(CW\*(C`Module::Install::purge_self\*(C'\fR function for removing included
files under \fIinc/\fR.
.SH METHODS
.IX Header "METHODS"
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Module::Install
.SH AUTHORS
.IX Header "AUTHORS"
Audrey Tang <autrijus@autrijus.org>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2003, 2004 by Audrey Tang <autrijus@autrijus.org>.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.PP
See <http://www.perl.com/perl/misc/Artistic.html>