lib/libc/gen/fts.3

   1 .\" Copyright (c) 1989, 1991, 1993, 1994
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)fts.3       8.5 (Berkeley) 4/16/94
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd January 7, 2005
  32 .Dt FTS 3
  33 .Os
  34 .Sh NAME
  35 .Nm fts
  36 .Nd traverse a file hierarchy
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/types.h
  41 .In sys/stat.h
  42 .In fts.h
  43 .Ft FTS *
  44 .Fn fts_open "char * const *path_argv" "int options" "int (*compar)(const FTSENT * const *, const FTSENT * const *)"
  45 .Ft FTSENT *
  46 .Fn fts_read "FTS *ftsp"
  47 .Ft FTSENT *
  48 .Fn fts_children "FTS *ftsp" "int options"
  49 .Ft int
  50 .Fn fts_set "FTS *ftsp" "FTSENT *f" "int options"
  51 .Ft void
  52 .Fn fts_set_clientptr "FTS *ftsp" "void *clientdata"
  53 .Ft void *
  54 .Fn fts_get_clientptr "FTS *ftsp"
  55 .Ft FTS *
  56 .Fn fts_get_stream "FTSENT *f"
  57 .Ft int
  58 .Fn fts_close "FTS *ftsp"
  59 .Sh DESCRIPTION
  60 The
  61 .Nm
  62 functions are provided for traversing
  63 .Ux
  64 file hierarchies.
  65 A simple overview is that the
  66 .Fn fts_open
  67 function returns a
  68 .Dq handle
  69 on a file hierarchy, which is then supplied to
  70 the other
  71 .Nm
  72 functions.
  73 The function
  74 .Fn fts_read
  75 returns a pointer to a structure describing one of the files in the file
  76 hierarchy.
  77 The function
  78 .Fn fts_children
  79 returns a pointer to a linked list of structures, each of which describes
  80 one of the files contained in a directory in the hierarchy.
  81 In general, directories are visited two distinguishable times; in pre-order
  82 (before any of their descendants are visited) and in post-order (after all
  83 of their descendants have been visited).
  84 Files are visited once.
  85 It is possible to walk the hierarchy
  86 .Dq logically
  87 (ignoring symbolic links)
  88 or physically (visiting symbolic links), order the walk of the hierarchy or
  89 prune and/or re-visit portions of the hierarchy.
  90 .Pp
  91 Two structures are defined (and typedef'd) in the include file
  92 .In fts.h .
  93 The first is
  94 .Vt FTS ,
  95 the structure that represents the file hierarchy itself.
  96 The second is
  97 .Vt FTSENT ,
  98 the structure that represents a file in the file
  99 hierarchy.
 100 Normally, an
 101 .Vt FTSENT
 102 structure is returned for every file in the file
 103 hierarchy.
 104 In this manual page,
 105 .Dq file
 106 and
 107 .Dq Vt FTSENT No structure
 108 are generally
 109 interchangeable.
 110 .Pp
 111 The
 112 .Vt FTS
 113 structure contains space for a single pointer, which may be used to
 114 store application data or per-hierarchy state.
 115 The
 116 .Fn fts_set_clientptr
 117 and
 118 .Fn fts_get_clientptr
 119 functions may be used to set and retrieve this pointer.
 120 This is likely to be useful only when accessed from the sort
 121 comparison function, which can determine the original
 122 .Vt FTS
 123 stream of its arguments using the
 124 .Fn fts_get_stream
 125 function.
 126 The two
 127 .Li get
 128 functions are also available as macros of the same name.
 129 .Pp
 130 The
 131 .Vt FTSENT
 132 structure contains at least the following fields, which are
 133 described in greater detail below:
 134 .Bd -literal
 135 typedef struct _ftsent {
 136         u_short fts_info;               /* flags for FTSENT structure */
 137         char *fts_accpath;              /* access path */
 138         char *fts_path;                 /* root path */
 139         u_short fts_pathlen;            /* strlen(fts_path) */
 140         char *fts_name;                 /* file name */
 141         u_short fts_namelen;            /* strlen(fts_name) */
 142         short fts_level;                /* depth (\-1 to N) */
 143         int fts_errno;                  /* file errno */
 144         long fts_number;                /* local numeric value */
 145         void *fts_pointer;              /* local address value */
 146         int64_t fts_bignum;             /* local 64-bit numeric value */
 147         struct ftsent *fts_parent;      /* parent directory */
 148         struct ftsent *fts_link;        /* next file structure */
 149         struct ftsent *fts_cycle;       /* cycle structure */
 150         struct stat *fts_statp;         /* stat(2) information */
 151 } FTSENT;
 152 .Ed
 153 .Pp
 154 These fields are defined as follows:
 155 .Bl -tag -width "fts_namelen"
 156 .It Fa fts_info
 157 One of the following values describing the returned
 158 .Vt FTSENT
 159 structure and
 160 the file it represents.
 161 With the exception of directories without errors
 162 .Pq Dv FTS_D ,
 163 all of these
 164 entries are terminal, that is, they will not be revisited, nor will any
 165 of their descendants be visited.
 166 .Bl  -tag -width FTS_DEFAULT
 167 .It Dv FTS_D
 168 A directory being visited in pre-order.
 169 .It Dv FTS_DC
 170 A directory that causes a cycle in the tree.
 171 (The
 172 .Fa fts_cycle
 173 field of the
 174 .Vt FTSENT
 175 structure will be filled in as well.)
 176 .It Dv FTS_DEFAULT
 177 Any
 178 .Vt FTSENT
 179 structure that represents a file type not explicitly described
 180 by one of the other
 181 .Fa fts_info
 182 values.
 183 .It Dv FTS_DNR
 184 A directory which cannot be read.
 185 This is an error return, and the
 186 .Fa fts_errno
 187 field will be set to indicate what caused the error.
 188 .It Dv FTS_DOT
 189 A file named
 190 .Ql .\&
 191 or
 192 .Ql ..\&
 193 which was not specified as a file name to
 194 .Fn fts_open
 195 (see
 196 .Dv FTS_SEEDOT ) .
 197 .It Dv FTS_DP
 198 A directory being visited in post-order.
 199 The contents of the
 200 .Vt FTSENT
 201 structure will be unchanged from when
 202 it was returned in pre-order, i.e., with the
 203 .Fa fts_info
 204 field set to
 205 .Dv FTS_D .
 206 .It Dv FTS_ERR
 207 This is an error return, and the
 208 .Fa fts_errno
 209 field will be set to indicate what caused the error.
 210 .It Dv FTS_F
 211 A regular file.
 212 .It Dv FTS_NS
 213 A file for which no
 214 .Xr stat 2
 215 information was available.
 216 The contents of the
 217 .Fa fts_statp
 218 field are undefined.
 219 This is an error return, and the
 220 .Fa fts_errno
 221 field will be set to indicate what caused the error.
 222 .It Dv FTS_NSOK
 223 A file for which no
 224 .Xr stat 2
 225 information was requested.
 226 The contents of the
 227 .Fa fts_statp
 228 field are undefined.
 229 .It Dv FTS_SL
 230 A symbolic link.
 231 .It Dv FTS_SLNONE
 232 A symbolic link with a non-existent target.
 233 The contents of the
 234 .Fa fts_statp
 235 field reference the file characteristic information for the symbolic link
 236 itself.
 237 .El
 238 .It Fa fts_accpath
 239 A path for accessing the file from the current directory.
 240 .It Fa fts_path
 241 The path for the file relative to the root of the traversal.
 242 This path contains the path specified to
 243 .Fn fts_open
 244 as a prefix.
 245 .It Fa fts_pathlen
 246 The length of the string referenced by
 247 .Fa fts_path .
 248 .It Fa fts_name
 249 The name of the file.
 250 .It Fa fts_namelen
 251 The length of the string referenced by
 252 .Fa fts_name .
 253 .It Fa fts_level
 254 The depth of the traversal, numbered from \-1 to N, where this file
 255 was found.
 256 The
 257 .Vt FTSENT
 258 structure representing the parent of the starting point (or root)
 259 of the traversal is numbered
 260 .Dv FTS_ROOTPARENTLEVEL
 261 (\-1), and the
 262 .Vt FTSENT
 263 structure for the root
 264 itself is numbered
 265 .Dv FTS_ROOTLEVEL
 266 (0).
 267 .It Fa fts_errno
 268 Upon return of a
 269 .Vt FTSENT
 270 structure from the
 271 .Fn fts_children
 272 or
 273 .Fn fts_read
 274 functions, with its
 275 .Fa fts_info
 276 field set to
 277 .Dv FTS_DNR ,
 278 .Dv FTS_ERR
 279 or
 280 .Dv FTS_NS ,
 281 the
 282 .Fa fts_errno
 283 field contains the value of the external variable
 284 .Va errno
 285 specifying the cause of the error.
 286 Otherwise, the contents of the
 287 .Fa fts_errno
 288 field are undefined.
 289 .It Fa fts_number
 290 This field is provided for the use of the application program and is
 291 not modified by the
 292 .Nm
 293 functions.
 294 It is initialized to 0.
 295 Note that this field is overlaid by
 296 .Fa fts_bignum .
 297 .It Fa fts_pointer
 298 This field is provided for the use of the application program and is
 299 not modified by the
 300 .Nm
 301 functions.
 302 It is initialized to
 303 .Dv NULL .
 304 Note that this field is overlaid by
 305 .Fa fts_bignum .
 306 .It Fa fts_bignum
 307 This field is provided for the use of the application program and is
 308 not modified by the
 309 .Nm
 310 functions.
 311 It is initialized to 0.
 312 Note that this field overlays
 313 .Fa fts_number
 314 and
 315 .Fa fts_pointer .
 316 .It Fa fts_parent
 317 A pointer to the
 318 .Vt FTSENT
 319 structure referencing the file in the hierarchy
 320 immediately above the current file, i.e., the directory of which this
 321 file is a member.
 322 A parent structure for the initial entry point is provided as well,
 323 however, only the
 324 .Fa fts_level ,
 325 .Fa fts_bignum ,
 326 .Fa fts_number
 327 and
 328 .Fa fts_pointer
 329 fields are guaranteed to be initialized.
 330 .It Fa fts_link
 331 Upon return from the
 332 .Fn fts_children
 333 function, the
 334 .Fa fts_link
 335 field points to the next structure in the NULL-terminated linked list of
 336 directory members.
 337 Otherwise, the contents of the
 338 .Fa fts_link
 339 field are undefined.
 340 .It Fa fts_cycle
 341 If a directory causes a cycle in the hierarchy (see
 342 .Dv FTS_DC ) ,
 343 either because
 344 of a hard link between two directories, or a symbolic link pointing to a
 345 directory, the
 346 .Fa fts_cycle
 347 field of the structure will point to the
 348 .Vt FTSENT
 349 structure in the hierarchy that references the same file as the current
 350 .Vt FTSENT
 351 structure.
 352 Otherwise, the contents of the
 353 .Fa fts_cycle
 354 field are undefined.
 355 .It Fa fts_statp
 356 A pointer to
 357 .Xr stat 2
 358 information for the file.
 359 .El
 360 .Pp
 361 A single buffer is used for all of the paths of all of the files in the
 362 file hierarchy.
 363 Therefore, the
 364 .Fa fts_path
 365 and
 366 .Fa fts_accpath
 367 fields are guaranteed to be
 368 .Dv NUL Ns -terminated
 369 .Em only
 370 for the file most recently returned by
 371 .Fn fts_read .
 372 To use these fields to reference any files represented by other
 373 .Vt FTSENT
 374 structures will require that the path buffer be modified using the
 375 information contained in that
 376 .Vt FTSENT
 377 structure's
 378 .Fa fts_pathlen
 379 field.
 380 Any such modifications should be undone before further calls to
 381 .Fn fts_read
 382 are attempted.
 383 The
 384 .Fa fts_name
 385 field is always
 386 .Dv NUL Ns -terminated .
 387 .Pp
 388 Note that the use of
 389 .Fa fts_bignum
 390 is mutually exclusive with the use of
 391 .Fa fts_number
 392 or
 393 .Fa fts_pointer .
 394 .Sh FTS_OPEN
 395 The
 396 .Fn fts_open
 397 function takes a pointer to an array of character pointers naming one
 398 or more paths which make up a logical file hierarchy to be traversed.
 399 The array must be terminated by a
 400 .Dv NULL
 401 pointer.
 402 .Pp
 403 There are
 404 a number of options, at least one of which (either
 405 .Dv FTS_LOGICAL
 406 or
 407 .Dv FTS_PHYSICAL )
 408 must be specified.
 409 The options are selected by
 410 .Em or Ns 'ing
 411 the following values:
 412 .Bl -tag -width "FTS_PHYSICAL"
 413 .It Dv FTS_COMFOLLOW
 414 This option causes any symbolic link specified as a root path to be
 415 followed immediately whether or not
 416 .Dv FTS_LOGICAL
 417 is also specified.
 418 .It Dv FTS_LOGICAL
 419 This option causes the
 420 .Nm
 421 routines to return
 422 .Vt FTSENT
 423 structures for the targets of symbolic links
 424 instead of the symbolic links themselves.
 425 If this option is set, the only symbolic links for which
 426 .Vt FTSENT
 427 structures
 428 are returned to the application are those referencing non-existent files.
 429 Either
 430 .Dv FTS_LOGICAL
 431 or
 432 .Dv FTS_PHYSICAL
 433 .Em must
 434 be provided to the
 435 .Fn fts_open
 436 function.
 437 .It Dv FTS_NOCHDIR
 438 As a performance optimization, the
 439 .Nm
 440 functions change directories as they walk the file hierarchy.
 441 This has the side-effect that an application cannot rely on being
 442 in any particular directory during the traversal.
 443 The
 444 .Dv FTS_NOCHDIR
 445 option turns off this optimization, and the
 446 .Nm
 447 functions will not change the current directory.
 448 Note that applications should not themselves change their current directory
 449 and try to access files unless
 450 .Dv FTS_NOCHDIR
 451 is specified and absolute
 452 pathnames were provided as arguments to
 453 .Fn fts_open .
 454 .It Dv FTS_NOSTAT
 455 By default, returned
 456 .Vt FTSENT
 457 structures reference file characteristic information (the
 458 .Fa statp
 459 field) for each file visited.
 460 This option relaxes that requirement as a performance optimization,
 461 allowing the
 462 .Nm
 463 functions to set the
 464 .Fa fts_info
 465 field to
 466 .Dv FTS_NSOK
 467 and leave the contents of the
 468 .Fa statp
 469 field undefined.
 470 .It Dv FTS_PHYSICAL
 471 This option causes the
 472 .Nm
 473 routines to return
 474 .Vt FTSENT
 475 structures for symbolic links themselves instead
 476 of the target files they point to.
 477 If this option is set,
 478 .Vt FTSENT
 479 structures for all symbolic links in the
 480 hierarchy are returned to the application.
 481 Either
 482 .Dv FTS_LOGICAL
 483 or
 484 .Dv FTS_PHYSICAL
 485 .Em must
 486 be provided to the
 487 .Fn fts_open
 488 function.
 489 .It Dv FTS_SEEDOT
 490 By default, unless they are specified as path arguments to
 491 .Fn fts_open ,
 492 any files named
 493 .Ql .\&
 494 or
 495 .Ql ..\&
 496 encountered in the file hierarchy are ignored.
 497 This option causes the
 498 .Nm
 499 routines to return
 500 .Vt FTSENT
 501 structures for them.
 502 .It Dv FTS_XDEV
 503 This option prevents
 504 .Nm
 505 from descending into directories that have a different device number
 506 than the file from which the descent began.
 507 .El
 508 .Pp
 509 The argument
 510 .Fn compar
 511 specifies a user-defined function which may be used to order the traversal
 512 of the hierarchy.
 513 It
 514 takes two pointers to pointers to
 515 .Vt FTSENT
 516 structures as arguments and
 517 should return a negative value, zero, or a positive value to indicate
 518 if the file referenced by its first argument comes before, in any order
 519 with respect to, or after, the file referenced by its second argument.
 520 The
 521 .Fa fts_accpath ,
 522 .Fa fts_path
 523 and
 524 .Fa fts_pathlen
 525 fields of the
 526 .Vt FTSENT
 527 structures may
 528 .Em never
 529 be used in this comparison.
 530 If the
 531 .Fa fts_info
 532 field is set to
 533 .Dv FTS_NS
 534 or
 535 .Dv FTS_NSOK ,
 536 the
 537 .Fa fts_statp
 538 field may not either.
 539 If the
 540 .Fn compar
 541 argument is
 542 .Dv NULL ,
 543 the directory traversal order is in the order listed in
 544 .Fa path_argv
 545 for the root paths, and in the order listed in the directory for
 546 everything else.
 547 .Sh FTS_READ
 548 The
 549 .Fn fts_read
 550 function returns a pointer to an
 551 .Vt FTSENT
 552 structure describing a file in
 553 the hierarchy.
 554 Directories (that are readable and do not cause cycles) are visited at
 555 least twice, once in pre-order and once in post-order.
 556 All other files are visited at least once.
 557 (Hard links between directories that do not cause cycles or symbolic
 558 links to symbolic links may cause files to be visited more than once,
 559 or directories more than twice.)
 560 .Pp
 561 If all the members of the hierarchy have been returned,
 562 .Fn fts_read
 563 returns
 564 .Dv NULL
 565 and sets the external variable
 566 .Va errno
 567 to 0.
 568 If an error unrelated to a file in the hierarchy occurs,
 569 .Fn fts_read
 570 returns
 571 .Dv NULL
 572 and sets
 573 .Va errno
 574 appropriately.
 575 If an error related to a returned file occurs, a pointer to an
 576 .Vt FTSENT
 577 structure is returned, and
 578 .Va errno
 579 may or may not have been set (see
 580 .Fa fts_info ) .
 581 .Pp
 582 The
 583 .Vt FTSENT
 584 structures returned by
 585 .Fn fts_read
 586 may be overwritten after a call to
 587 .Fn fts_close
 588 on the same file hierarchy stream, or, after a call to
 589 .Fn fts_read
 590 on the same file hierarchy stream unless they represent a file of type
 591 directory, in which case they will not be overwritten until after a call to
 592 .Fn fts_read
 593 after the
 594 .Vt FTSENT
 595 structure has been returned by the function
 596 .Fn fts_read
 597 in post-order.
 598 .Sh FTS_CHILDREN
 599 The
 600 .Fn fts_children
 601 function returns a pointer to an
 602 .Vt FTSENT
 603 structure describing the first entry in a NULL-terminated linked list of
 604 the files in the directory represented by the
 605 .Vt FTSENT
 606 structure most recently returned by
 607 .Fn fts_read .
 608 The list is linked through the
 609 .Fa fts_link
 610 field of the
 611 .Vt FTSENT
 612 structure, and is ordered by the user-specified comparison function, if any.
 613 Repeated calls to
 614 .Fn fts_children
 615 will recreate this linked list.
 616 .Pp
 617 As a special case, if
 618 .Fn fts_read
 619 has not yet been called for a hierarchy,
 620 .Fn fts_children
 621 will return a pointer to the files in the logical directory specified to
 622 .Fn fts_open ,
 623 i.e., the arguments specified to
 624 .Fn fts_open .
 625 Otherwise, if the
 626 .Vt FTSENT
 627 structure most recently returned by
 628 .Fn fts_read
 629 is not a directory being visited in pre-order,
 630 or the directory does not contain any files,
 631 .Fn fts_children
 632 returns
 633 .Dv NULL
 634 and sets
 635 .Va errno
 636 to zero.
 637 If an error occurs,
 638 .Fn fts_children
 639 returns
 640 .Dv NULL
 641 and sets
 642 .Va errno
 643 appropriately.
 644 .Pp
 645 The
 646 .Vt FTSENT
 647 structures returned by
 648 .Fn fts_children
 649 may be overwritten after a call to
 650 .Fn fts_children ,
 651 .Fn fts_close
 652 or
 653 .Fn fts_read
 654 on the same file hierarchy stream.
 655 .Pp
 656 .Em Option
 657 may be set to the following value:
 658 .Bl -tag -width FTS_NAMEONLY
 659 .It Dv FTS_NAMEONLY
 660 Only the names of the files are needed.
 661 The contents of all the fields in the returned linked list of structures
 662 are undefined with the exception of the
 663 .Fa fts_name
 664 and
 665 .Fa fts_namelen
 666 fields.
 667 .El
 668 .Sh FTS_SET
 669 The function
 670 .Fn fts_set
 671 allows the user application to determine further processing for the
 672 file
 673 .Fa f
 674 of the stream
 675 .Fa ftsp .
 676 The
 677 .Fn fts_set
 678 function
 679 returns 0 on success, and \-1 if an error occurs.
 680 .Em Option
 681 must be set to one of the following values:
 682 .Bl -tag -width FTS_PHYSICAL
 683 .It Dv FTS_AGAIN
 684 Re-visit the file; any file type may be re-visited.
 685 The next call to
 686 .Fn fts_read
 687 will return the referenced file.
 688 The
 689 .Fa fts_stat
 690 and
 691 .Fa fts_info
 692 fields of the structure will be reinitialized at that time,
 693 but no other fields will have been changed.
 694 This option is meaningful only for the most recently returned
 695 file from
 696 .Fn fts_read .
 697 Normal use is for post-order directory visits, where it causes the
 698 directory to be re-visited (in both pre and post-order) as well as all
 699 of its descendants.
 700 .It Dv FTS_FOLLOW
 701 The referenced file must be a symbolic link.
 702 If the referenced file is the one most recently returned by
 703 .Fn fts_read ,
 704 the next call to
 705 .Fn fts_read
 706 returns the file with the
 707 .Fa fts_info
 708 and
 709 .Fa fts_statp
 710 fields reinitialized to reflect the target of the symbolic link instead
 711 of the symbolic link itself.
 712 If the file is one of those most recently returned by
 713 .Fn fts_children ,
 714 the
 715 .Fa fts_info
 716 and
 717 .Fa fts_statp
 718 fields of the structure, when returned by
 719 .Fn fts_read ,
 720 will reflect the target of the symbolic link instead of the symbolic link
 721 itself.
 722 In either case, if the target of the symbolic link does not exist the
 723 fields of the returned structure will be unchanged and the
 724 .Fa fts_info
 725 field will be set to
 726 .Dv FTS_SLNONE .
 727 .Pp
 728 If the target of the link is a directory, the pre-order return, followed
 729 by the return of all of its descendants, followed by a post-order return,
 730 is done.
 731 .It Dv FTS_SKIP
 732 No descendants of this file are visited.
 733 The file may be one of those most recently returned by either
 734 .Fn fts_children
 735 or
 736 .Fn fts_read .
 737 .El
 738 .Sh FTS_CLOSE
 739 The
 740 .Fn fts_close
 741 function closes a file hierarchy stream
 742 .Fa ftsp
 743 and restores the current directory to the directory from which
 744 .Fn fts_open
 745 was called to open
 746 .Fa ftsp .
 747 The
 748 .Fn fts_close
 749 function
 750 returns 0 on success, and \-1 if an error occurs.
 751 .Sh ERRORS
 752 The function
 753 .Fn fts_open
 754 may fail and set
 755 .Va errno
 756 for any of the errors specified for the library functions
 757 .Xr open 2
 758 and
 759 .Xr malloc 3 .
 760 .Pp
 761 The function
 762 .Fn fts_close
 763 may fail and set
 764 .Va errno
 765 for any of the errors specified for the library functions
 766 .Xr chdir 2
 767 and
 768 .Xr close 2 .
 769 .Pp
 770 The functions
 771 .Fn fts_read
 772 and
 773 .Fn fts_children
 774 may fail and set
 775 .Va errno
 776 for any of the errors specified for the library functions
 777 .Xr chdir 2 ,
 778 .Xr malloc 3 ,
 779 .Xr opendir 3 ,
 780 .Xr readdir 3
 781 and
 782 .Xr stat 2 .
 783 .Pp
 784 In addition,
 785 .Fn fts_children ,
 786 .Fn fts_open
 787 and
 788 .Fn fts_set
 789 may fail and set
 790 .Va errno
 791 as follows:
 792 .Bl -tag -width Er
 793 .It Bq Er EINVAL
 794 The options were invalid.
 795 .El
 796 .Sh SEE ALSO
 797 .Xr find 1 ,
 798 .Xr chdir 2 ,
 799 .Xr stat 2 ,
 800 .Xr ftw 3 ,
 801 .Xr qsort 3
 802 .Sh HISTORY
 803 The
 804 .Nm
 805 interface was first introduced in
 806 .Bx 4.4 .
 807 The
 808 .Fn fts_get_clientptr ,
 809 .Fn fts_get_stream ,
 810 and
 811 .Fn fts_set_clientptr
 812 functions were introduced in
 813 .Fx 5.0 ,
 814 principally to provide for alternative interfaces to the
 815 .Nm
 816 functionality using different data structures.