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