.\" Automatically generated by Pod::Man 2.28 (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 "File::Fu::Base 3pm" .TH File::Fu::Base 3pm "2015-12-08" "perl v5.20.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" File::Fu::Base \- nothing to see here .SH "SYNOPSIS" .IX Header "SYNOPSIS" .SS "clone" .IX Subsection "clone" .Vb 1 \& my $obj = $obj\->clone; .Ve .SS "clonedo" .IX Subsection "clonedo" .Vb 1 \& $clone = $self\->clonedo($action, @args); .Ve .SS "error" .IX Subsection "error" .Vb 1 \& $package\->error($op); .Ve .SH "Filetests" .IX Header "Filetests" .SS "r w x o R W X O e z s f d l p S b c t u g k T B M A C" .IX Subsection "r w x o R W X O e z s f d l p S b c t u g k T B M A C" See perldoc \-f \-x .SH "File::Spec stuff" .IX Header "File::Spec stuff" This needs to be redone. .SS "is_absolute" .IX Subsection "is_absolute" .SS "relative" .IX Subsection "relative" Get a relative name. .PP .Vb 1 \& my $rel = $abs\->relative; .Ve .PP Also, with optional relative-to directory: .PP .Vb 1 \& my $rel = $abs\->relative($to); .Ve .SS "relative_to" .IX Subsection "relative_to" Same as \fIrelative()\fR, but requires the \f(CW$dir\fR argument. .PP .Vb 1 \& my $rel = $abs\->relative_to($dir); .Ve .SS "resolve" .IX Subsection "resolve" Fully resolve any symlinks; .PP .Vb 1 \& my $path = $path\->resolve; .Ve .SS "relative_symlink" .IX Subsection "relative_symlink" Where \f(CW$path\fR and \f(CW$linkname\fR are both relative to the current directory. .PP .Vb 1 \& $path\->relative_symlink($linkname); .Ve .SS "utime" .IX Subsection "utime" Update the file timestamps. .PP .Vb 1 \& $file\->utime($atime, $mtime); .Ve .PP Optionally, set both to the same time. .PP .Vb 1 \& $file\->utime($time); .Ve .PP Also see \fItouch()\fR. .SS "chmod" .IX Subsection "chmod" .Vb 1 \& $path\->chmod($mode); .Ve .SS "rename" .IX Subsection "rename" Calls the builtin \fIrename()\fR on the \f(CW$path\fR and returns a new object with that name. .PP .Vb 1 \& $path = $path\->rename($newname); .Ve .SH "Stat Object" .IX Header "Stat Object" The \fIstat()\fR and \fIlstat()\fR methods both return a File::stat object. .SS "stat" .IX Subsection "stat" .Vb 1 \& my $st = $obj\->stat; .Ve .SS "lstat" .IX Subsection "lstat" Same as stat, but does not dereference symlinks. .PP .Vb 1 \& my $st = $obj\->lstat; .Ve .SS "is_same" .IX Subsection "is_same" Returns true if the two paths are the same. This is by string equality, then (if both paths exist) by device+inode equality. .PP .Vb 1 \& $bool = $path\->is_same($other); .Ve .SH "AUTHOR" .IX Header "AUTHOR" Eric Wilhelm @ .PP http://scratchcomputing.com/ .SH "BUGS" .IX Header "BUGS" If you found this module on \s-1CPAN,\s0 please report any bugs or feature requests through the web interface at . I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. .PP If you pulled this development version from my /svn/, please contact me directly. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (C) 2008 Eric L. Wilhelm, All Rights Reserved. .SH "NO WARRANTY" .IX Header "NO WARRANTY" Absolutely, positively \s-1NO WARRANTY,\s0 neither express or implied, is offered with this software. You use this software at your own risk. In case of loss, no person or entity owes you anything whatsoever. You have been warned. .SH "LICENSE" .IX Header "LICENSE" This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.