.\" Automatically generated by Pod::Man 4.14 (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 .. .\" 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 "lib::abs 3pm" .TH lib::abs 3pm "2022-11-19" "perl v5.36.0" "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" lib::abs \- "lib" that makes relative path absolute to caller. .SH "SYNOPSIS" .IX Header "SYNOPSIS" Simple use like \f(CW\*(C`use lib ...\*(C'\fR: .PP .Vb 2 \& use lib::abs qw(./mylibs1 ../mylibs2); \& use lib::abs \*(Aqmylibs\*(Aq; \& \& # if your path may not exists and it is ok, then: \& use lib::abs \-soft => qw(./mylibs1 ../mylibs2); .Ve .PP Extended syntax (glob) .PP .Vb 1 \& use lib::abs \*(Aqmodules/*/lib\*(Aq; .Ve .PP There are also may be used helper function from lib::abs (see example/ex4): .PP .Vb 3 \& use lib::abs; \& # ... \& my $path = lib::abs::path(\*(Aq../path/relative/to/me\*(Aq); # returns absolute path .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The main reason of this library is transformate relative paths to absolute at the \f(CW\*(C`BEGIN\*(C'\fR stage, and push transformed to \f(CW@INC\fR. Relative path basis is not the current working directory, but the location of file, where the statement is (caller file). When using common \f(CW\*(C`lib\*(C'\fR, relative paths stays relative to curernt working directory, .PP .Vb 3 \& # For ex: \& # script: /opt/scripts/my.pl \& use lib::abs \*(Aq../lib\*(Aq; \& \& # We run \`/opt/scripts/my.pl\` having cwd /home/mons \& # The @INC will contain \*(Aq/opt/lib\*(Aq; \& \& # We run \`./my.pl\` having cwd /opt \& # The @INC will contain \*(Aq/opt/lib\*(Aq; \& \& # We run \`../my.pl\` having cwd /opt/lib \& # The @INC will contain \*(Aq/opt/lib\*(Aq; .Ve .PP Also this module is useful when writing tests, when you want to load strictly the module from ../lib, respecting the test file. .PP .Vb 2 \& # t/00\-test.t \& use lib::abs \*(Aq../lib\*(Aq; .Ve .PP Also this is useful, when you running under \f(CW\*(C`mod_perl\*(C'\fR, use something like \f(CW\*(C`Apache::StatINC\*(C'\fR, and your application may change working directory. So in case of chdir \f(CW\*(C`StatINC\*(C'\fR fails to reload module if the \f(CW@INC\fR contain relative paths. .SH "RATIONALE" .IX Header "RATIONALE" Q: We already have \f(CW\*(C`FindBin\*(C'\fR and \f(CW\*(C`lib\*(C'\fR, why we need this module? .PP A: There are several reasons: .ie n .IP "1) ""FindBin"" could find path incorrectly under ""mod_perl""" 4 .el .IP "1) \f(CWFindBin\fR could find path incorrectly under \f(CWmod_perl\fR" 4 .IX Item "1) FindBin could find path incorrectly under mod_perl" .PD 0 .ie n .IP "2) ""FindBin"" works relatively to executed binary instead of relatively to caller" 4 .el .IP "2) \f(CWFindBin\fR works relatively to executed binary instead of relatively to caller" 4 .IX Item "2) FindBin works relatively to executed binary instead of relatively to caller" .ie n .IP "3) Perl is linguistic language, and \`use lib::abs ""...""\*(Aq semantically more clear and looks more beautiful than \`use FindBin; use lib ""$FindBin::Bin/../lib"";\*(Aq" 4 .el .IP "3) Perl is linguistic language, and \f(CW\`use lib::abs ``...''\*(Aq\fR semantically more clear and looks more beautiful than \f(CW\`use FindBin; use lib ``$FindBin::Bin/../lib'';\*(Aq\fR" 4 .IX Item "3) Perl is linguistic language, and use lib::abs ""..."" semantically more clear and looks more beautiful than use FindBin; use lib ""$FindBin::Bin/../lib"";" .ie n .IP "4) ""FindBin"" b work incorrectly, if will be called not from executed binary (see comparison for details)" 4 .el .IP "4) \f(CWFindBin\fR b work incorrectly, if will be called not from executed binary (see comparison for details)" 4 .IX Item "4) FindBin b work incorrectly, if will be called not from executed binary (see comparison for details)" .PD .SH "BUGS" .IX Header "BUGS" None known .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2007\-2020 by Mons Anderson. .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. .SH "AUTHOR" .IX Header "AUTHOR" Mons Anderson, \f(CW\*(C`\*(C'\fR .SH "CONTRIBUTORS" .IX Header "CONTRIBUTORS" Oleg Kostyuk, \f(CW\*(C`\*(C'\fR