.\" Copyright (c) 1993 Michael Haardt (u31b3hs@pool.informatik.rwth-aachen.de)
.\" and copyright (c) 1999 Andries Brouwer (aeb@cwi.nl)
.\" and copyright (c) 2006 Justin Pryzby <justinpryzby@users.sf.net>
.\" and copyright (c) 2006 Michael Kerrisk <mtk-manpages@gmx.net>
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, write to the Free
.\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
.\" USA.
.\"
.\" Modified Sun Jul 25 11:02:22 1993 by Rik Faith (faith@cs.unc.edu)
.\" 2006-05-24, Justin Pryzby <justinpryzby@users.sf.net>
.\"  	document FTW_ACTIONRETVAL; include .SH "RETURN VALUE"; 
.\" 2006-05-24, Justin Pryzby <justinpryzby@users.sf.net> and
.\"	Michael Kerrisk <mtk-manpages@gmx.net>
.\" 	reorganized and rewrote much of the page
.\" 2006-05-24, Michael Kerrisk <mtk-manpages@gmx.net>
.\"	Added an example program.
.\"
.\" Japanese Version Copyright (c) 1998 NAKANO Takeo all rights reserved.
.\" Translated 1998-04-28, NAKANO Takeo <nakano@apm.seikei.ac.jp>
.\" Updated & Modified 1999-09-14, NAKANO Takeo <nakano@apm.seikei.ac.jp>
.\" Updated & Modified 2005-11-04, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
.\" Updated 2006-07-26, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.36
.\"
.\" WORD:       file descriptor         եǥץ
.\"
.TH FTW 3 2006-05-24 "Linux" "Linux Programmer's Manual"
.SH ̾
ftw, nftw \- եĥ꡼⤭ޤ
.SH 
.nf
.B #include <ftw.h>
.sp
.BI "int ftw(const char *" dirpath , 
.BR "        int (*" fn ") (const char *" fpath ", const struct stat *" sb , 
.BI "                   int " typeflag ),
.BI "        int " nopenfd );
.sp
.B #define _XOPEN_SOURCE 500
.B #include <ftw.h>
.sp
.BI "int nftw(const char *" dirpath , 
.BI "        int (*" fn ") (const char *" fpath ", const struct stat *" sb , 
.BI "                   int " typeflag ", struct FTW *" ftwbuf ),
.BI "        int " nopenfd ", int " flags );
.fi
.SH 
.BR ftw ()
ϡ
.I dirpath
ǻꤵ줿ǥ쥯ȥʲΥǥ쥯ȥĥ꡼Τ⤭ޤꡢ
ĥ꡼ǥȥ꤬դ뤴Ȥˡ
.IR fn ()
ƤӽФ
ǥեȤǤϡǥ쥯ȥꤽΤΤΥǥ쥯ȥˤե
֥ǥ쥯ȥ˽ (Ԥõ; pre-order traversal)

ƤӽФץѲǽʥեǥץȤڤä
ޤʤ褦ˤ뤿ᡢ
.BR ftw ()
Ʊ˥ץ󤹤ǥ쥯ȥκ
.I nopenfd
ǻꤹ뤳ȤǤ롣
õοͤۤȡ
ĤΥǥ쥯ȥĤƤ¾Υǥ쥯ȥ򥪡ץľ
ˤʤΤǡ
.BR ftw ()
ư٤ʤ롣
.BR ftw ()
ϡǥ쥯ȥĥ꡼γ 1 ٥ˤĤ
ǤĤΥեǥץѤʤ

ǥ쥯ȥĥ꡼ǸĤäȥˡ
.BR ftw ()

.IR fpath ,
.IR sb ,
.I typeflag
 3ĤȤ
.IR fn ()
ƤӽФ
.I fpath
ϥȥ
.I dirpath
Хѥ̾Ǥ롣
.I sb

.I fpath
Ф
.BR stat (2)
θƤӽФ֤
.I stat
¤ΤؤΥݥ󥿤Ǥ롣
.I typeflag
ǡʲͤΤ줫ĤǤ:
.TP
.B FTW_F
.I fpath
̾ΥեǤ
.TP
.B FTW_D
.I fpath
ǥ쥯ȥǤ
.TP
.B FTW_DNR
.I fpath
ɤ߹ߤǤʤǥ쥯ȥǤ
.TP
.B FTW_NS
ܥå󥯤ǤϤʤ
.I fpath
Ф
.BR stat (2)
ƤӽФԤ
.sp
.I fpath
ܥå󥯤ǡ
.BR stat (2)
Ԥ硢
.B FTW_NS

.B FTW_SL
() Τɤ餬
.I typeflag
Ϥ뤫̤ǤȡPOSIX.1-2001 ˤϽ񤫤Ƥ롣
.PP
ĥ꡼õߤ᤿ϡ
.IR fn ()
 0 ʳ֤ͤɤ
(ͤ
.BR ftw ()
ȤͤȤʤ)
ʳξ
.BR ftw ()
ϥĥ꡼Τõ³٤ƤΥĥ꡼õȤ
0 ֤õ
.RB ( malloc (3)
μԤʤɤ) 顼 \-1 ֤
.PP
.BR ftw ()
ưŪʥǡ¤ѤΤǡĥ꡼õǤͣˡ 
0 ʳͤ
.IR fn ()
֤ͤȤ뤳ȤǤ롣ߤ򰷤ˤϡ
㤨ȯߤޡƤơ 0 ʳ֤ͤ褦ˤ
ʥˤ꡼򵯤õλǤ褦ˤˤϡ
ʥϥɥ
.IR fn ()
å륰Хʥե饰򥻥åȤ褦ˤФ褤
ץλʳϡ
.BR longjmp (3)
Ѥʤȡ
.SS nftw()
ؿ
.BR nftw ()

.BR ftw ()
Ʊ
.I flags
ɲäȡ
.IR fn ()
ΰ
.I ftwbuf
ɲäۤʤ롣


.I flags
ϲΥե饰 0 İʾ¤äΤǤ:
.TP
.BR FTW_ACTIONRETVAL " (glibc 2.3.3 ʹ)"
Υե饰 glibc ͭǤ롣
Υե饰򥻥åȤȡ
.BR nftw ()

.IR fn ()
֤ͤΰѤ롣
.IR fn ()
ϰʲͤΤ줫Ĥ֤ɬפ롣
.RS
.TP
.B FTW_CONTINUE
.BR nftw ()
̤̾³롣
.TP
.B FTW_SKIP_SIBLINGS
.IR fn ()
֤ͤ硢Υȥη (ƱؤΥȥ)
νϥåפ졢ƥǥ쥯ȥ³νԤ롣
.\" If \fBFTW_DEPTH\fP
.\" is set, the entry's parent directory is processed next (with
.\" \fIflag\fP set to \fBFTW_DP\fP).
.TP
.B FTW_SKIP_SUBTREE
.IR fn ()
ƤӽФ줿ȥ꤬ǥ쥯ȥ
.RI ( typeflag

.BR FTW_D )
ξˡ֤ͤ
.IR fn ()
ΰȤϤ줿ǥ쥯ȥΥȥνԤʤʤ롣
.BR nftw ()
ϽΥǥ쥯ȥη (ƱؤΥȥ) ³롣
.TP
.B FTW_STOP
.B nftw ()
ϡ֤
.B FTW_STOP
Ǥ롣
.PP
¾֤ͤϾ迷ưбդǽ롣
.IR fn ()
Ͼ嵭ΥꥹȤˤͰʳ֤ʤ褦ˤ٤Ǥ롣

.I <ftw.h>

.B FTW_ACTIONRETVAL
褦ˤˤϡ
ǽޥ _GNU_SOURCE ʤФʤʤ
.RE
.TP
.B FTW_CHDIR
åȤȡǥ쥯ȥƤ
Υǥ쥯ȥ
.BR chdir (2)
롣Υե饰ϡ
.I fpath
°ǥ쥯ȥDz餫ư¹Ԥɬפ
Ǥ롣
.TP
.B FTW_DEPTH
åȤȡ꤬õ (post-order traversal) Ԥ
Ĥޤꡢǥ쥯ȥꤽΤΤȤ
.IR fn ()
ƽФϡΥǥ쥯ȥ˴ޤޤեȥ֥ǥ쥯ȥ
ФΡָǡ׹Ԥ
(ǥեȤǤϡǥ쥯ȥ꼫Ȥνϥǥ쥯ȥΥȥ
ˡ׹Ԥʤ)
.TP
.B FTW_MOUNT
åȤȡƱե륷ƥõоݤȤ
(ĤޤꡢޥȥݥȤޤȤϤʤ)
.TP
.B FTW_PHYS
åȤȡܥå󥯤éʤ (餯餬
̾˾ޤư)åȤƤʤȥܥå󥯤
é뤬Ʊե뤬𤵤뤳ȤϤʤ
.sp
.B FTW_PHYS
åȤ줺
.B FTW_DEPTH
åȤȡʬȤФ륷ܥå󥯤۲˻
ǥ쥯ȥФ
.IR fn ()
ƤӽФ뤳ȤϷ褷Ƥʤ
.LP
ǥ쥯ȥĥ꡼Υȥˡ
.BR nftw ()
 4Ĥΰ
.IR fn ()
ƤӽФ
.I fpath

.I sb

.BR ftw ()
ƱǤ롣
.I typeflag
ˤϡ
.BR ftw ()
ǼͤΤ줫ޤϰʲͤΤ줫Ϥ:
.TP
.B FTW_DP
.I fpath
ǥ쥯ȥǡ
.I flags

.B FTW_DEPTH
ꤵƤ
.I fpath
۲Υեȥ֥ǥ쥯ȥƽäƤ롣
.TP
.B FTW_SL
.I fpath
ܥå󥯤ǡ \fBFTW_PHYS\fP  \fIflags\fP 
åȤƤ
.TP
.B FTW_SLN
.I fpath
ܥå󥯤ǡ¸ߤʤեؤƤ
(줬åȤΤ
.B FTW_PHYS
åȤƤʤǤ)
.LP
.BR nftw ()

.IR fn ()
ƤӽФݤϤ 4Ĥΰ
.I FTW
ι¤ΤǤ롣
.in +0.25i
.nf

struct FTW {
    int base;
    int level;
};

.fi
.in -0.25i
.I base
ϡե̾ (basename ) Ρ
.I fpath
Ϥѥ̾ǤΥեåȤǤ롣
.I level
ϥǥ쥯ȥĥ꡼Ǥ
.I fpath
ο򼨤ϥǥ쥯ȥĥ꡼Υȥå (root) 
ͤǤ
.RI ( dirpath
Ͽ 0 Ǥ)
.SH ֤
δؿϡ 0 򡢥顼ȯ \-1 ֤

.BR fn ()
 0 ʳ֤硢ǥ쥯ȥĥ꡼õλ
.BR fn ()
֤ͤ
.BR ftw ()

.BR nftw ()
η̤Ȥ֤

.BR nftw ()

.B FTW_ACTIONRETVAL
ե饰դǸƤФ줿硢ĥ꡼õλ뤿
.IR fn ()
ѤǤ롢 0 ͤ
.B FTW_STOP
Ǥꡢ
ͤ
.BR nftw ()
֤ͤȤ֤롣
.SH 
.BR nftw ()
ؿȡ
.BR ftw ()
ˤ
.B FTW_SL
ϡSUSv1 Ƴ줿
.LP
.BR ftw ()

.B FTW_SL
ڻȤʤƥ䡢
¸ߤʤեؤƤ륷ܥå󥯤ξˤΤ
.B FTW_SL
Ȥƥࡢޤ
.BR ftw ()
ƤΥܥå󥯤Ф
.B FTW_SL
Ȥƥ⤢롣
ͽ¬ǽư򤵤뤿ˤϡ
.BR nftw ()
Ȥȡ
.LP
Linux Ǥϡ libc4, libc5, glibc 2.0.6 
stat Ǥ뤬ǥ쥯ȥǤϤʤ֥ȡ
(ե, ܥå, fifo )
ФƤϤ٤
.B FTW_F
Ȥ

.BR nftw ()
ؿ glibc 2.1 ʹߤѤǤ롣

.B FTW_ACTIONRETVAL
 glibc ͭǤ롣
.SH 
POSIX.1-2001, SVr4, SUSv1.
.SH 
ʲΥץϡܤΥޥɥ饤̾˻ĥѥʲ
ǥ쥯ȥĥ꡼õ롣ꤵʤäϡ
ȥǥ쥯ȥʲõ롣
ơΥեˤĤ͡ξɽ롣
ܤΥޥɥ饤ʸꤹ뤳Ȥǡ
.BR nftw ()
ƤӽФݤ
.I flags
Ϥͤ椹뤳ȤǤ롣
.nf

#define _XOPEN_SOURCE 500
#include <ftw.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

static int
display_info(const char *fpath, const struct stat *sb, 
             int tflag, struct FTW *ftwbuf)
{
    printf("%-3s %2d %7lld   %-40s %d %s\\n",
        (tflag == FTW_D) ?   "d"   : (tflag == FTW_DNR) ? "dnr" :
        (tflag == FTW_DP) ?  "dp"  : (tflag == FTW_F) ?   "f" :
        (tflag == FTW_DP) ?  "dp"  : (tflag == FTW_SL) ?  "sl" :
        (tflag == FTW_SLN) ? "sln" : "???",
        ftwbuf->level, (long long) sb->st_size,
        fpath, ftwbuf->base, fpath + ftwbuf->base);
    return 0;           /* To tell nftw() to continue */
}

int
main(int argc, char *argv[])
{
    int flags = 0;

    if (argc > 2 && strchr(argv[2], 'd') != NULL)
        flags |= FTW_DEPTH;
    if (argc > 2 && strchr(argv[2], 'p') != NULL)
        flags |= FTW_PHYS;

    nftw((argc < 2) ? "." : argv[1], display_info, 20, flags);
    exit(EXIT_SUCCESS);
}
.fi
.SH Ϣ
.BR stat (2),
.BR fts (3),
.BR readdir (3)