.\" 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 "File::Find::Object 3"
.TH File::Find::Object 3 "2008-01-07" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
File::Find::Object \- An object oriented File::Find replacement
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use File::Find::Object;
\&    my $tree = File::Find::Object->new({}, @dir);
.Ve
.PP
.Vb 3
\&    while (my $r = $tree->next()) {
\&        print $r ."\en";
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
File::Find::Object does same job as File::Find but works like an object and 
with an iterator. As File::Find is not object oriented, one cannot perform
multiple searches in the same application. The second problem of File::Find 
is its file processing: after starting its main loop, one cannot easilly wait 
for another event an so get the next result.
.PP
With File::Find::Object you can get the next file by calling the \fInext()\fR 
function, but setting a callback is still possible.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.Sh "new"
.IX Subsection "new"
.Vb 1
\&    my $ffo = File::Find::Object->new( { options }, @targets);
.Ve
.PP
Create a new File::Find::Object object. \f(CW@targets\fR is the list of 
directories or files which the object should explore.
.PP
\fIoptions\fR
.IX Subsection "options"
.IP "depth" 4
.IX Item "depth"
Boolean \- returns the directory content before the directory itself.
.IP "nocrossfs" 4
.IX Item "nocrossfs"
Boolean \- doesn't continue on filesystems different than the parent.
.IP "followlink" 4
.IX Item "followlink"
Boolean \- follow symlinks when they point to a directory.
.Sp
You can safely set this option to true as File::Find::Object does not follow 
the link if it detects a loop.
.IP "filter" 4
.IX Item "filter"
Function reference \- should point to a function returning \s-1TRUE\s0 or \s-1FALSE\s0. This 
function is called with the filename to filter, if the function return \s-1FALSE\s0, 
the file is skipped.
.IP "callback" 4
.IX Item "callback"
Function reference \- should point to a function, which would be called each 
time a new file is returned. The function is called with the current filename 
as an argument.
.Sh "next"
.IX Subsection "next"
Returns the next file found by the File::Find::Object. It returns undef once
the scan is completed.
.Sh "item"
.IX Subsection "item"
Returns the current filename found by the File::Find::Object object, i.e: the
last value returned by \fInext()\fR.
.Sh "$ff\->set_traverse_to([@children])"
.IX Subsection "$ff->set_traverse_to([@children])"
Sets the children to traverse to from the current node. Useful for pruning
items to traverse.
.Sh "$ff\->\fIprune()\fP"
.IX Subsection "$ff->prune()"
Prunes the current directory. Equivalent to \f(CW$ff\fR\->set_traverse_to([]).
.ie n .Sh "[@children] = $ff\fP\->\fIget_traverse_to()"
.el .Sh "[@children] = \f(CW$ff\fP\->\fIget_traverse_to()\fP"
.IX Subsection "[@children] = $ff->get_traverse_to()"
Retrieves the children that will be traversed to.
.ie n .Sh "[@files] = $ff\fP\->\fIget_current_node_files_list()"
.el .Sh "[@files] = \f(CW$ff\fP\->\fIget_current_node_files_list()\fP"
.IX Subsection "[@files] = $ff->get_current_node_files_list()"
Gets all the files that appear in the current directory. This value is
constant for every node, and is useful to use as the basis of the argument
for \f(CW\*(C`set_traverse_to()\*(C'\fR.
.SH "BUGS"
.IX Header "BUGS"
No bugs are known, but it doesn't mean there aren't any.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
There's an article about this module in the Perl Advent Calendar of 2006:
<http://perladvent.pm.org/2006/2/>.
.PP
File::Find is the core module for traversing files in perl, which has
several limitations.
.PP
File::Next, File::Find::Iterator, File::Walker and the unmaintained
File::FTS are alternatives to this module.
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (C) 2005, 2006 by Olivier Thauvin
.PP
This package is free software; you can redistribute it and/or modify it under 
the following terms:
.PP
1. The \s-1GNU\s0 General Public License Version 2.0 \- 
http://www.opensource.org/licenses/gpl\-license.php
.PP
2. The Artistic License Version 2.0 \-
http://www.perlfoundation.org/legal/licenses/artistic\-2_0.html
.PP
3. At your option \- any later version of either or both of these licenses.