File: //usr/local/share/man/man3/Test::File::ShareDir::Object::Inc.3pm
.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. 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 "Test::File::ShareDir::Object::Inc 3"
.TH Test::File::ShareDir::Object::Inc 3 "2017-03-01" "perl v5.26.3" "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"
Test::File::ShareDir::Object::Inc \- Shared tempdir object code to inject into @INC
.SH "VERSION"
.IX Header "VERSION"
version 1.001002
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Test::File::ShareDir::Object::Inc;
\&
\& my $inc = Test::File::ShareDir::Object::Inc\->new();
\&
\& $inc\->tempdir() # add files to here
\&
\& $inc\->module_tempdir() # or here
\&
\& $inc\->dist_tempdir() # or here
\&
\& $inc\->add_to_inc;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class doesn't do very much on its own.
.PP
It simply exists to facilitate \f(CW\*(C`tempdir\*(C'\fR creation,
and the injection of those \f(CW\*(C`tempdir\*(C'\fR's into \f(CW@INC\fR
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """add_to_inc"""
.el .SS "\f(CWadd_to_inc\fP"
.IX Subsection "add_to_inc"
\&\fB\s-1DEPRECATED:\s0\fR Use \f(CW\*(C`register\*(C'\fR instead.
.ie n .SS """register"""
.el .SS "\f(CWregister\fP"
.IX Subsection "register"
.Vb 1
\& $instance\->register;
.Ve
.PP
Allows this \f(CW\*(C`Inc\*(C'\fR to be used.
.PP
Presently, this injects the associated \f(CW\*(C`tempdir\*(C'\fR into \f(CW@INC\fR
.PP
\&\fISince 1.001000\fR
.ie n .SS """clear"""
.el .SS "\f(CWclear\fP"
.IX Subsection "clear"
.Vb 1
\& $instance\->clear();
.Ve
.PP
Prevents this \f(CW\*(C`Inc\*(C'\fR from being used.
.PP
Presently, this removes the \f(CW\*(C`tempdir\*(C'\fR from \f(CW@INC\fR
.PP
\&\fISince 1.001000\fR
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.ie n .SS """tempdir"""
.el .SS "\f(CWtempdir\fP"
.IX Subsection "tempdir"
A path to a \f(CW\*(C`tempdir\*(C'\fR of some description.
.ie n .SS """module_tempdir"""
.el .SS "\f(CWmodule_tempdir\fP"
.IX Subsection "module_tempdir"
The \f(CW\*(C`module\*(C'\fR \f(CW\*(C`ShareDir\*(C'\fR base directory within the \f(CW\*(C`tempdir\*(C'\fR
.ie n .SS """dist_tempdir"""
.el .SS "\f(CWdist_tempdir\fP"
.IX Subsection "dist_tempdir"
The \f(CW\*(C`dist\*(C'\fR \f(CW\*(C`ShareDir\*(C'\fR base directory within the \f(CW\*(C`tempdir\*(C'\fR
.SH "AUTHOR"
.IX Header "AUTHOR"
Kent Fredric <kentnl@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2017 by Kent Fredric <kentnl@cpan.org>.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.