.\" -*- 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::Base 3pm"
.TH Module::Install::Base 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::Base \- Base class for Module::Install extensions
.SH SYNOPSIS
.IX Header "SYNOPSIS"
In a \fBModule::Install\fR extension:
.PP
.Vb 2
\&    use Module::Install::Base ();
\&    @ISA = qw(Module::Install::Base);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module provide essential methods for all \fBModule::Install\fR
extensions, in particular the common constructor \f(CW\*(C`new\*(C'\fR and method
dispatcher \f(CW\*(C`AUTOLOAD\*(C'\fR.
.SH METHODS
.IX Header "METHODS"
.IP new(%args) 4
.IX Item "new(%args)"
Constructor \-\- need to preserve at least _top
.IP AUTOLOAD 4
.IX Item "AUTOLOAD"
The main dispatcher \- copy extensions if missing
.IP \fB_top()\fR 4
.IX Item "_top()"
Returns the top-level \fBModule::Install\fR object.
.IP \fBadmin()\fR 4
.IX Item "admin()"
Returns the \f(CW\*(C`_top\*(C'\fR object's associated \fBModule::Install::Admin\fR object
on the first run (i.e. when there was no \fIinc/\fR when the program
started); on subsequent (user-side) runs, returns a fake admin object
with an empty \f(CW\*(C`AUTOLOAD\*(C'\fR method that does nothing at all.
.IP \fBis_admin()\fR 4
.IX Item "is_admin()"
Tells whether this is the first run of the installer (on
author's side). That is when there was no \fIinc/\fR at
program start. True if that's the case. False, otherwise.
.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>