File: //usr/local/ssl/local/share/man/man3/lib::restrict.3
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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. | will give a
.\" real vertical bar. \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "lib::restrict 3"
.TH lib::restrict 3 "2006-10-20" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
lib::restrict \- Perl extension for restricting what goes into @INC
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use lib::restrict qw(foo bar baz), $restiction;
.Ve
.PP
.Vb 1
\& use lib::restrict qw(foo bar baz);
.Ve
.PP
.Vb 1
\& no lib::restrict qw(foo bar baz);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
lib::restrict useage and functionality is the same as 'use lib' and 'no lib' (because it \s-1ISA\s0 lib::) with an additional feature described below.
.ie n .SH "RESTRICTING WHAT GOES INTO @INC"
.el .SH "RESTRICTING WHAT GOES INTO \f(CW@INC\fP"
.IX Header "RESTRICTING WHAT GOES INTO @INC"
If the last item passed to use lib::restrict is all digits or an array ref of items
that are all digits then only paths passed that are owned by those uids are used.
.PP
.Vb 2
\& # add /foo and /bar only if owned by root
\& use lib::restrict '/foo', '/bar', 0;
.Ve
.PP
or
.PP
.Vb 2
\& # add /foo and /bar only if owned by root, effective uid, or real uid
\& use lib::restrict '/foo', '/bar', [0, $>, $<];
.Ve
.PP
This means if you are adding a directory that is all digits it has to go somewhere besides the end.
.PP
.Vb 2
\& # add the path 123 if owned by root *not* add the paths 123 and 0
\& use lib::restrict '123', '0';
.Ve
.PP
This is not true if its the only argument:
.PP
.Vb 1
\& use lib::restrict '123'; # treats 123 as a path not a uid
.Ve
.PP
Any items that are non numeric are simply ignored:
.PP
.Vb 1
\& use lib::restrict '/foo', '/bar', '/baz'; # adds those 3 paths
.Ve
.PP
.Vb 1
\& use lib::restrict '/foo', '/bar', [qw( /baz 0 123 /wop)]; # adds /foo and /bar if its owned by root or uid 123
.Ve
.PP
In addition the last item can be a code reference that accepts tha filename as
its only argument and returns true if its ok to add and false to not add it.
.ie n .SH "CONTROLLING BEHAVIOR VIA %ENV"
.el .SH "CONTROLLING BEHAVIOR VIA \f(CW%ENV\fP"
.IX Header "CONTROLLING BEHAVIOR VIA %ENV"
If true, \f(CW$ENV\fR{'lib::restrict\-quiet'}, stiffles the carp when a path is denied.
.PP
Set \f(CW$ENV\fR{'lib::restrict\-!\-d_ok_in'} to an array ref of absolute paths (will be made absolute if relative).
Any paths passed to lib::restrict that do not exist but whose parent is in that list will be allowed and the uid/code ref check ignored.
.PP
In other words if you
.PP
.Vb 3
\& local $ENV{'lib::restrict-!-d_ok_in'} = ['/foo'];
\& # assuming neither exists yet
\& use lib::restrict qw(/foo/bar /foo/baz/wop, $restriction);
.Ve
.PP
/foo/bar made it because /foo, its parent is in the list.
.PP
/foo/baz/wop did not because it parent, /foo/baz, is not in the list
.SH "SEE ALSO"
.IX Header "SEE ALSO"
lib
.SH "AUTHOR"
.IX Header "AUTHOR"
Daniel Muey, <http://drmuey.com/cpan_contact.pl>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2006 by Daniel Muey
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.6 or,
at your option, any later version of Perl 5 you may have available.