.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
.\"
.\" 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 "SHARYANTO::File::Util 3pm"
.TH SHARYANTO::File::Util 3pm "2013-09-11" "perl v5.18.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"
SHARYANTO::File::Util \- File\-related utilities
.SH "VERSION"
.IX Header "VERSION"
version 0.56
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use SHARYANTO::File::Util qw(file_exists l_abs_path dir_empty);
\&
\& print "file exists" if file_exists("/path/to/file/or/dir");
\& print "absolute path = ", l_abs_path("foo");
\& print "dir exists and is empty" if dir_empty("/path/to/dir");
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
None are exported by default, but they are exportable.
.SS "file_exists($path) => \s-1BOOL\s0"
.IX Subsection "file_exists($path) => BOOL"
This routine is just like the \fB\-e\fR test, except that it assume symlinks with
non-existent target as existing. If \f(CW\*(C`sym\*(C'\fR is a symlink to a non-existing
target:
.PP
.Vb 1
\& \-e "sym"             # false, Perl performs stat() which follows symlink
.Ve
.PP
but:
.PP
.Vb 2
\& \-l "sym"             # true, Perl performs lstat()
\& \-e _                 # false
.Ve
.PP
This function performs the following test:
.PP
.Vb 1
\& !(\-l "sym") && (\-e _) || (\-l _)
.Ve
.SS "l_abs_path($path) => \s-1STR\s0"
.IX Subsection "l_abs_path($path) => STR"
Just like \fICwd::abs_path()\fR, except that it will not follow symlink if \f(CW$path\fR is
symlink (but it will follow symlinks for the parent paths).
.PP
Example:
.PP
.Vb 1
\& use Cwd qw(getcwd abs_path);
\&
\& say getcwd();              # /home/steven
\& # s is a symlink to /tmp/foo
\& say abs_path("s");         # /tmp/foo
\& say l_abs_path("s");       # /home/steven/s
\& # s2 is a symlink to /tmp
\& say abs_path("s2/foo");    # /tmp/foo
\& say l_abs_path("s2/foo");  # /tmp/foo
.Ve
.PP
Mnemonic: l_abs_path \-> abs_path is analogous to lstat \-> stat.
.PP
Note: currently uses hardcoded \f(CW\*(C`/\*(C'\fR as path separator.
.SS "dir_empty($dir) => \s-1BOOL\s0"
.IX Subsection "dir_empty($dir) => BOOL"
Will return true if \f(CW$dir\fR exists and is empty.
.PP
None are exported by default, but they are exportable.
.SH "FAQ"
.IX Header "FAQ"
.SS "Where is \fIfile_empty()\fP?"
.IX Subsection "Where is file_empty()?"
For checking if some path exists, is a regular file, and is empty (content is
zero-length), you can simply use the \f(CW\*(C`\-z\*(C'\fR filetest operator.
.SH "AUTHOR"
.IX Header "AUTHOR"
Steven Haryanto <stevenharyanto@gmail.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2013 by Steven Haryanto.
.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.