1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the PACKAGE package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: PACKAGE VERSION\n"
10 "POT-Creation-Date: 2015-01-21 20:35+0900\n"
11 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
20 #: build/C/man3/closedir.3:31
26 #: build/C/man3/closedir.3:31
32 #: build/C/man3/closedir.3:31 build/C/man3/dirfd.3:25 build/C/man2/getdents.2:30 build/C/man3/getdirentries.3:27 build/C/man3/opendir.3:32 build/C/man2/readdir.2:30 build/C/man3/readdir.3:36 build/C/man3/rewinddir.3:31 build/C/man3/scandir.3:62 build/C/man3/seekdir.3:31 build/C/man3/telldir.3:30
34 msgid "Linux Programmer's Manual"
38 #: build/C/man3/closedir.3:32 build/C/man3/dirfd.3:26 build/C/man2/getdents.2:31 build/C/man3/getdirentries.3:28 build/C/man3/opendir.3:33 build/C/man2/readdir.2:31 build/C/man3/readdir.3:37 build/C/man3/rewinddir.3:32 build/C/man3/scandir.3:63 build/C/man3/seekdir.3:32 build/C/man3/telldir.3:31
44 #: build/C/man3/closedir.3:34
45 msgid "closedir - close a directory"
49 #: build/C/man3/closedir.3:34 build/C/man3/dirfd.3:28 build/C/man2/getdents.2:33 build/C/man3/getdirentries.3:30 build/C/man3/opendir.3:35 build/C/man2/readdir.2:33 build/C/man3/readdir.3:39 build/C/man3/rewinddir.3:34 build/C/man3/scandir.3:66 build/C/man3/seekdir.3:35 build/C/man3/telldir.3:33
55 #: build/C/man3/closedir.3:37 build/C/man3/opendir.3:38 build/C/man3/rewinddir.3:37
57 msgid "B<#include E<lt>sys/types.hE<gt>>\n"
61 #: build/C/man3/closedir.3:39 build/C/man3/opendir.3:40 build/C/man3/readdir.3:42 build/C/man3/rewinddir.3:39 build/C/man3/scandir.3:69 build/C/man3/seekdir.3:38 build/C/man3/telldir.3:36
63 msgid "B<#include E<lt>dirent.hE<gt>>\n"
67 #: build/C/man3/closedir.3:41
69 msgid "B<int closedir(DIR *>I<dirp>B<);>\n"
73 #: build/C/man3/closedir.3:42 build/C/man3/dirfd.3:54 build/C/man2/getdents.2:41 build/C/man3/getdirentries.3:43 build/C/man3/opendir.3:63 build/C/man2/readdir.2:42 build/C/man3/readdir.3:61 build/C/man3/rewinddir.3:42 build/C/man3/scandir.3:118 build/C/man3/seekdir.3:49 build/C/man3/telldir.3:47
79 #: build/C/man3/closedir.3:55
81 "The B<closedir>() function closes the directory stream associated with "
82 "I<dirp>. A successful call to B<closedir>() also closes the underlying "
83 "file descriptor associated with I<dirp>. The directory stream descriptor "
84 "I<dirp> is not available after this call."
88 #: build/C/man3/closedir.3:55 build/C/man3/dirfd.3:69 build/C/man2/getdents.2:142 build/C/man3/getdirentries.3:56 build/C/man3/opendir.3:83 build/C/man2/readdir.2:91 build/C/man3/readdir.3:119 build/C/man3/rewinddir.3:49 build/C/man3/scandir.3:184 build/C/man3/seekdir.3:60 build/C/man3/telldir.3:52
94 #: build/C/man3/closedir.3:62
96 "The B<closedir>() function returns 0 on success. On error, -1 is returned, "
97 "and I<errno> is set appropriately."
101 #: build/C/man3/closedir.3:62 build/C/man3/dirfd.3:74 build/C/man2/getdents.2:148 build/C/man3/getdirentries.3:62 build/C/man3/opendir.3:92 build/C/man2/readdir.2:97 build/C/man3/readdir.3:143 build/C/man3/scandir.3:200 build/C/man3/telldir.3:60
107 #: build/C/man3/closedir.3:63 build/C/man2/getdents.2:149 build/C/man3/opendir.3:96 build/C/man2/readdir.2:98 build/C/man3/readdir.3:144 build/C/man3/scandir.3:213 build/C/man3/telldir.3:61
113 #: build/C/man3/closedir.3:67 build/C/man3/readdir.3:147 build/C/man3/telldir.3:64
114 msgid "Invalid directory stream descriptor I<dirp>."
118 #: build/C/man3/closedir.3:67 build/C/man3/dirfd.3:92 build/C/man2/getdents.2:165 build/C/man3/getdirentries.3:69 build/C/man3/opendir.3:118 build/C/man2/readdir.2:114 build/C/man3/readdir.3:156 build/C/man3/rewinddir.3:58 build/C/man3/scandir.3:229 build/C/man3/seekdir.3:69 build/C/man3/telldir.3:69
120 msgid "CONFORMING TO"
124 #: build/C/man3/closedir.3:69
125 msgid "SVr4, POSIX.1-2001, 4.3BSD."
129 #: build/C/man3/closedir.3:69 build/C/man3/dirfd.3:104 build/C/man2/getdents.2:282 build/C/man3/getdirentries.3:77 build/C/man3/opendir.3:140 build/C/man2/readdir.2:127 build/C/man3/readdir.3:265 build/C/man3/rewinddir.3:60 build/C/man3/scandir.3:283 build/C/man3/seekdir.3:83 build/C/man3/telldir.3:95
135 #: build/C/man3/closedir.3:76
137 "B<close>(2), B<opendir>(3), B<readdir>(3), B<rewinddir>(3), B<scandir>(3), "
138 "B<seekdir>(3), B<telldir>(3)"
142 #: build/C/man3/dirfd.3:25
148 #: build/C/man3/dirfd.3:25
154 #: build/C/man3/dirfd.3:25 build/C/man2/getdents.2:30 build/C/man2/readdir.2:30
160 #: build/C/man3/dirfd.3:28
161 msgid "dirfd - get directory stream file descriptor"
165 #: build/C/man3/dirfd.3:30
166 msgid "B<#include E<lt>sys/types.hE<gt>>"
170 #: build/C/man3/dirfd.3:32 build/C/man3/getdirentries.3:32
171 msgid "B<#include E<lt>dirent.hE<gt>>"
175 #: build/C/man3/dirfd.3:34
176 msgid "B<int dirfd(DIR *>I<dirp>B<);>"
180 #: build/C/man3/dirfd.3:38 build/C/man3/getdirentries.3:39 build/C/man3/opendir.3:48 build/C/man3/readdir.3:52 build/C/man3/scandir.3:96 build/C/man3/seekdir.3:45 build/C/man3/telldir.3:43
181 msgid "Feature Test Macro Requirements for glibc (see B<feature_test_macros>(7)):"
185 #: build/C/man3/dirfd.3:41
190 #: build/C/man3/dirfd.3:46 build/C/man3/scandir.3:105
191 msgid "_BSD_SOURCE || _SVID_SOURCE"
195 #: build/C/man3/dirfd.3:48 build/C/man3/scandir.3:107
196 msgid "|| /* Since glibc 2.10: */"
200 #: build/C/man3/dirfd.3:50 build/C/man3/scandir.3:109
201 msgid "(_POSIX_C_SOURCE\\ E<gt>=\\ 200809L || _XOPEN_SOURCE\\ E<gt>=\\ 700)"
205 #: build/C/man3/dirfd.3:59
207 "The function B<dirfd>() returns the file descriptor associated with the "
208 "directory stream I<dirp>."
212 #: build/C/man3/dirfd.3:69
214 "This descriptor is the one used internally by the directory stream. As a "
215 "result, it is useful only for functions which do not depend on or alter the "
216 "file position, such as B<fstat>(2) and B<fchdir>(2). It will be "
217 "automatically closed when B<closedir>(3) is called."
221 #: build/C/man3/dirfd.3:74
223 "On success, a nonnegative file descriptor is returned. On error, -1 is "
224 "returned, and I<errno> is set to indicate the cause of the error."
229 #: build/C/man3/dirfd.3:79
231 "POSIX.1-2008 specifies two errors, neither of which is returned by the "
232 "current implementation."
236 #: build/C/man3/dirfd.3:79 build/C/man2/getdents.2:156 build/C/man2/readdir.2:105
242 #: build/C/man3/dirfd.3:83
243 msgid "I<dirp> does not refer to a valid directory stream."
247 #: build/C/man3/dirfd.3:83
253 #: build/C/man3/dirfd.3:87
255 "The implementation does not support the association of a file descriptor "
260 #: build/C/man3/dirfd.3:87 build/C/man3/getdirentries.3:64 build/C/man3/readdir.3:147 build/C/man3/rewinddir.3:53 build/C/man3/seekdir.3:64 build/C/man3/telldir.3:64
266 #: build/C/man3/dirfd.3:88 build/C/man3/getdirentries.3:65 build/C/man3/readdir.3:148 build/C/man3/rewinddir.3:54 build/C/man3/seekdir.3:65 build/C/man3/telldir.3:65
268 msgid "Multithreading (see pthreads(7))"
272 #: build/C/man3/dirfd.3:92
273 msgid "The B<dirfd>() function is thread-safe."
276 #. It is present in libc5 (since 5.1.2) and in glibc2.
278 #: build/C/man3/dirfd.3:96
280 "POSIX.1-2008. This function was a BSD extension, present in 4.3BSD-Reno, "
285 #: build/C/man3/dirfd.3:96 build/C/man2/getdents.2:168 build/C/man3/opendir.3:123 build/C/man2/readdir.2:116 build/C/man3/readdir.3:158 build/C/man3/scandir.3:252 build/C/man3/seekdir.3:71 build/C/man3/telldir.3:71
291 #: build/C/man3/dirfd.3:104
293 "The prototype for B<dirfd>() is available only if B<_BSD_SOURCE> or "
294 "B<_SVID_SOURCE> is defined."
298 #: build/C/man3/dirfd.3:112
300 "B<open>(2), B<closedir>(3), B<opendir>(3), B<readdir>(3), B<rewinddir>(3), "
301 "B<scandir>(3), B<seekdir>(3), B<telldir>(3)"
305 #: build/C/man2/getdents.2:30
311 #: build/C/man2/getdents.2:30
317 #: build/C/man2/getdents.2:33
318 msgid "getdents - get directory entries"
322 #: build/C/man2/getdents.2:37
325 "B<int getdents(unsigned int >I<fd>B<, struct linux_dirent *>I<dirp>B<,>\n"
326 "B< unsigned int >I<count>B<);>\n"
330 #: build/C/man2/getdents.2:41 build/C/man2/readdir.2:42
331 msgid "I<Note>: There is no glibc wrapper for this system call; see NOTES."
335 #: build/C/man2/getdents.2:47
337 "This is not the function you are interested in. Look at B<readdir>(3) for "
338 "the POSIX conforming C library interface. This page documents the bare "
339 "kernel system call interface."
343 #: build/C/man2/getdents.2:60
345 "The system call B<getdents>() reads several I<linux_dirent> structures from "
346 "the directory referred to by the open file descriptor I<fd> into the buffer "
347 "pointed to by I<dirp>. The argument I<count> specifies the size of that "
352 #: build/C/man2/getdents.2:64
353 msgid "The I<linux_dirent> structure is declared as follows:"
357 #: build/C/man2/getdents.2:79
360 "struct linux_dirent {\n"
361 " unsigned long d_ino; /* Inode number */\n"
362 " unsigned long d_off; /* Offset to next I<linux_dirent> */\n"
363 " unsigned short d_reclen; /* Length of this I<linux_dirent> */\n"
364 " char d_name[]; /* Filename (null-terminated) */\n"
365 " /* length is actually (d_reclen - 2 -\n"
366 " offsetof(struct linux_dirent, d_name)) */\n"
368 " char pad; // Zero padding byte\n"
369 " char d_type; // File type (only since Linux\n"
370 " // 2.6.4); offset is (d_reclen - 1)\n"
375 #: build/C/man2/getdents.2:81
381 #: build/C/man2/getdents.2:94
383 "I<d_ino> is an inode number. I<d_off> is the distance from the start of the "
384 "directory to the start of the next I<linux_dirent>. I<d_reclen> is the size "
385 "of this entire I<linux_dirent>. I<d_name> is a null-terminated filename."
389 #: build/C/man2/getdents.2:99
391 "I<d_type> is a byte at the end of the structure that indicates the file "
392 "type. It contains one of the following values (defined in "
393 "I<E<lt>dirent.hE<gt>>):"
397 #: build/C/man2/getdents.2:99 build/C/man3/readdir.3:200
403 #: build/C/man2/getdents.2:102 build/C/man3/readdir.3:203
404 msgid "This is a block device."
408 #: build/C/man2/getdents.2:102 build/C/man3/readdir.3:203
414 #: build/C/man2/getdents.2:105 build/C/man3/readdir.3:206
415 msgid "This is a character device."
419 #: build/C/man2/getdents.2:105 build/C/man3/readdir.3:206
425 #: build/C/man2/getdents.2:108 build/C/man3/readdir.3:209
426 msgid "This is a directory."
430 #: build/C/man2/getdents.2:108 build/C/man3/readdir.3:209
436 #: build/C/man2/getdents.2:111 build/C/man3/readdir.3:212
437 msgid "This is a named pipe (FIFO)."
441 #: build/C/man2/getdents.2:111 build/C/man3/readdir.3:212
447 #: build/C/man2/getdents.2:114 build/C/man3/readdir.3:215
448 msgid "This is a symbolic link."
452 #: build/C/man2/getdents.2:114 build/C/man3/readdir.3:215
458 #: build/C/man2/getdents.2:117 build/C/man3/readdir.3:218
459 msgid "This is a regular file."
463 #: build/C/man2/getdents.2:117 build/C/man3/readdir.3:218
469 #: build/C/man2/getdents.2:120 build/C/man3/readdir.3:221
470 msgid "This is a UNIX domain socket."
474 #: build/C/man2/getdents.2:120 build/C/man3/readdir.3:221
476 msgid "B<DT_UNKNOWN>"
479 #. The glibc manual says that on some systems this is the only
482 #: build/C/man2/getdents.2:123 build/C/man3/readdir.3:226
483 msgid "The file type is unknown."
487 #: build/C/man2/getdents.2:133
489 "The I<d_type> field is implemented since Linux 2.6.4. It occupies a space "
490 "that was previously a zero-filled padding byte in the I<linux_dirent> "
491 "structure. Thus, on kernels before 2.6.3, attempting to access this field "
492 "always provides the value 0 (B<DT_UNKNOWN>)."
496 #. The same sentence is in getdents.2
498 #: build/C/man2/getdents.2:142 build/C/man3/readdir.3:240
500 "Currently, only some filesystems (among them: Btrfs, ext2, ext3, and ext4) "
501 "have full support for returning the file type in I<d_type>. All "
502 "applications must properly handle a return of B<DT_UNKNOWN>."
506 #: build/C/man2/getdents.2:148
508 "On success, the number of bytes read is returned. On end of directory, 0 is "
509 "returned. On error, -1 is returned, and I<errno> is set appropriately."
513 #: build/C/man2/getdents.2:153 build/C/man2/readdir.2:102
514 msgid "Invalid file descriptor I<fd>."
518 #: build/C/man2/getdents.2:153 build/C/man2/readdir.2:102
524 #: build/C/man2/getdents.2:156 build/C/man2/readdir.2:105
525 msgid "Argument points outside the calling process's address space."
529 #: build/C/man2/getdents.2:159 build/C/man2/readdir.2:108
530 msgid "Result buffer is too small."
534 #: build/C/man2/getdents.2:159 build/C/man3/opendir.3:106 build/C/man2/readdir.2:108 build/C/man3/scandir.3:201
540 #: build/C/man2/getdents.2:162 build/C/man2/readdir.2:111
541 msgid "No such directory."
545 #: build/C/man2/getdents.2:162 build/C/man3/opendir.3:112 build/C/man2/readdir.2:111 build/C/man3/scandir.3:207 build/C/man3/scandir.3:217
551 #: build/C/man2/getdents.2:165 build/C/man2/readdir.2:114
552 msgid "File descriptor does not refer to a directory."
555 #. SVr4 documents additional ENOLINK, EIO error conditions.
557 #: build/C/man2/getdents.2:168
562 #: build/C/man2/getdents.2:177
564 "Glibc does not provide a wrapper for this system call; call it using "
565 "B<syscall>(2). You will need to define the I<linux_dirent> structure "
566 "yourself. However, you probably want to use B<readdir>(3) instead."
570 #: build/C/man2/getdents.2:180
571 msgid "This call supersedes B<readdir>(2)."
575 #: build/C/man2/getdents.2:193
577 "The original Linux B<getdents>() system call did not handle large "
578 "filesystems and large file offsets. Consequently, Linux 2.4 added "
579 "B<getdents64>(), with wider types for the I<d_ino> and I<d_off> fields "
580 "employed in the I<linux_dirent> structure."
584 #: build/C/man2/getdents.2:193 build/C/man3/scandir.3:259
589 #. FIXME The example program needs to be revised, since it uses the older
590 #. getdents() system call and the structure with smaller field widths.
592 #: build/C/man2/getdents.2:200
594 "The program below demonstrates the use of B<getdents>(). The following "
595 "output shows an example of what we see when running this program on an ext2 "
600 #: build/C/man2/getdents.2:213
603 "$B< ./a.out /testfs/>\n"
604 "--------------- nread=120 ---------------\n"
605 "inode# file type d_reclen d_off d_name\n"
606 " 2 directory 16 12 .\n"
607 " 2 directory 16 24 ..\n"
608 " 11 directory 24 44 lost+found\n"
609 " 12 regular 16 56 a\n"
610 " 228929 directory 16 68 sub\n"
611 " 16353 directory 16 80 sub2\n"
612 " 130817 directory 16 4096 sub3\n"
616 #: build/C/man2/getdents.2:215
618 msgid "Program source"
622 #: build/C/man2/getdents.2:226
625 "#define _GNU_SOURCE\n"
626 "#include E<lt>dirent.hE<gt> /* Defines DT_* constants */\n"
627 "#include E<lt>fcntl.hE<gt>\n"
628 "#include E<lt>stdio.hE<gt>\n"
629 "#include E<lt>unistd.hE<gt>\n"
630 "#include E<lt>stdlib.hE<gt>\n"
631 "#include E<lt>sys/stat.hE<gt>\n"
632 "#include E<lt>sys/syscall.hE<gt>\n"
636 #: build/C/man2/getdents.2:229
639 "#define handle_error(msg) \\e\n"
640 " do { perror(msg); exit(EXIT_FAILURE); } while (0)\n"
644 #: build/C/man2/getdents.2:236
647 "struct linux_dirent {\n"
650 " unsigned short d_reclen;\n"
656 #: build/C/man2/getdents.2:238
658 msgid "#define BUF_SIZE 1024\n"
662 #: build/C/man2/getdents.2:247
666 "main(int argc, char *argv[])\n"
669 " char buf[BUF_SIZE];\n"
670 " struct linux_dirent *d;\n"
676 #: build/C/man2/getdents.2:251
679 " fd = open(argc E<gt> 1 ? argv[1] : \".\", O_RDONLY | O_DIRECTORY);\n"
681 " handle_error(\"open\");\n"
685 #: build/C/man2/getdents.2:256
689 " nread = syscall(SYS_getdents, fd, buf, BUF_SIZE);\n"
690 " if (nread == -1)\n"
691 " handle_error(\"getdents\");\n"
695 #: build/C/man2/getdents.2:259
703 #: build/C/man2/getdents.2:278
706 " printf(\"--------------- nread=%d ---------------\\en\", nread);\n"
707 " printf(\"inode# file type d_reclen d_off d_name\\en\");\n"
708 " for (bpos = 0; bpos E<lt> nread;) {\n"
709 " d = (struct linux_dirent *) (buf + bpos);\n"
710 " printf(\"%8ld \", d-E<gt>d_ino);\n"
711 " d_type = *(buf + bpos + d-E<gt>d_reclen - 1);\n"
712 " printf(\"%-10s \", (d_type == DT_REG) ? \"regular\" :\n"
713 " (d_type == DT_DIR) ? \"directory\" :\n"
714 " (d_type == DT_FIFO) ? \"FIFO\" :\n"
715 " (d_type == DT_SOCK) ? \"socket\" :\n"
716 " (d_type == DT_LNK) ? \"symlink\" :\n"
717 " (d_type == DT_BLK) ? \"block dev\" :\n"
718 " (d_type == DT_CHR) ? \"char dev\" : "
720 " printf(\"%4d %10lld %s\\en\", d-E<gt>d_reclen,\n"
721 " (long long) d-E<gt>d_off, d-E<gt>d_name);\n"
722 " bpos += d-E<gt>d_reclen;\n"
728 #: build/C/man2/getdents.2:281
731 " exit(EXIT_SUCCESS);\n"
736 #: build/C/man2/getdents.2:284
737 msgid "B<readdir>(2), B<readdir>(3)"
741 #: build/C/man3/getdirentries.3:27
743 msgid "GETDIRENTRIES"
747 #: build/C/man3/getdirentries.3:27
753 #: build/C/man3/getdirentries.3:27 build/C/man3/opendir.3:32 build/C/man3/scandir.3:62
759 #: build/C/man3/getdirentries.3:30
760 msgid "getdirentries - get directory entries in a filesystem-independent format"
764 #: build/C/man3/getdirentries.3:35
766 "B<ssize_t getdirentries(int >I<fd>B<, char *>I<buf>B<, size_t >I<nbytes> B<, "
767 "off_t *>I<basep>B<);>"
771 #: build/C/man3/getdirentries.3:43
772 msgid "B<getdirentries>(): _BSD_SOURCE || _SVID_SOURCE"
776 #: build/C/man3/getdirentries.3:56
778 "Read directory entries from the directory specified by I<fd> into I<buf>. "
779 "At most I<nbytes> are read. Reading starts at offset I<*basep>, and "
780 "I<*basep> is updated with the new position after reading."
784 #: build/C/man3/getdirentries.3:62
786 "B<getdirentries>() returns the number of bytes read or zero when at the end "
787 "of the directory. If an error occurs, -1 is returned, and I<errno> is set "
792 #: build/C/man3/getdirentries.3:64
793 msgid "See the Linux library source code for details."
797 #: build/C/man3/getdirentries.3:69
798 msgid "The B<getdirentries>() function is thread-safe."
802 #: build/C/man3/getdirentries.3:77
804 "Not in POSIX.1-2001. Present on the BSDs, and a few other systems. Use "
805 "B<opendir>(3) and B<readdir>(3) instead."
809 #: build/C/man3/getdirentries.3:79
810 msgid "B<lseek>(2), B<open>(2)"
814 #: build/C/man3/opendir.3:32
820 #: build/C/man3/opendir.3:32
826 #: build/C/man3/opendir.3:35
827 msgid "opendir, fdopendir - open a directory"
831 #: build/C/man3/opendir.3:43
834 "B<DIR *opendir(const char *>I<name>B<);>\n"
835 "B<DIR *fdopendir(int >I<fd>B<);>\n"
839 #: build/C/man3/opendir.3:51
840 msgid "B<fdopendir>():"
844 #: build/C/man3/opendir.3:54
846 msgid "Since glibc 2.10:"
850 #: build/C/man3/opendir.3:57
851 msgid "_XOPEN_SOURCE\\ E<gt>=\\ 700 || _POSIX_C_SOURCE\\ E<gt>=\\ 200809L"
855 #: build/C/man3/opendir.3:57
857 msgid "Before glibc 2.10:"
861 #: build/C/man3/opendir.3:60
866 #: build/C/man3/opendir.3:69
868 "The B<opendir>() function opens a directory stream corresponding to the "
869 "directory I<name>, and returns a pointer to the directory stream. The "
870 "stream is positioned at the first entry in the directory."
874 #: build/C/man3/opendir.3:83
876 "The B<fdopendir>() function is like B<opendir>(), but returns a directory "
877 "stream for the directory referred to by the open file descriptor I<fd>. "
878 "After a successful call to B<fdopendir>(), I<fd> is used internally by the "
879 "implementation, and should not otherwise be used by the application."
883 #: build/C/man3/opendir.3:92
885 "The B<opendir>() and B<fdopendir>() functions return a pointer to the "
886 "directory stream. On error, NULL is returned, and I<errno> is set "
891 #: build/C/man3/opendir.3:93
897 #: build/C/man3/opendir.3:96
898 msgid "Permission denied."
902 #: build/C/man3/opendir.3:100
903 msgid "I<fd> is not a valid file descriptor opened for reading."
907 #: build/C/man3/opendir.3:100
913 #: build/C/man3/opendir.3:103
914 msgid "Too many file descriptors in use by process."
918 #: build/C/man3/opendir.3:103
924 #: build/C/man3/opendir.3:106
925 msgid "Too many files are currently open in the system."
929 #: build/C/man3/opendir.3:109
930 msgid "Directory does not exist, or I<name> is an empty string."
934 #: build/C/man3/opendir.3:109 build/C/man3/scandir.3:204
940 #: build/C/man3/opendir.3:112 build/C/man3/scandir.3:207
941 msgid "Insufficient memory to complete the operation."
945 #: build/C/man3/opendir.3:115
946 msgid "I<name> is not a directory."
950 #: build/C/man3/opendir.3:115 build/C/man3/scandir.3:223
956 #: build/C/man3/opendir.3:118
957 msgid "B<fdopendir>() is available in glibc since version 2.4."
961 #: build/C/man3/opendir.3:123
963 "B<opendir>() is present on SVr4, 4.3BSD, and specified in POSIX.1-2001. "
964 "B<fdopendir>() is specified in POSIX.1-2008."
968 #: build/C/man3/opendir.3:126
970 "The underlying file descriptor of the directory stream can be obtained using "
975 #: build/C/man3/opendir.3:140
977 "The B<opendir>() function sets the close-on-exec flag for the file "
978 "descriptor underlying the I<DIR *>. The B<fdopendir>() function leaves the "
979 "setting of the close-on-exec flag unchanged for the file descriptor, I<fd>. "
980 "POSIX.1-200x leaves it unspecified whether a successful call to "
981 "B<fdopendir>() will set the close-on-exec flag for the file descriptor, "
986 #: build/C/man3/opendir.3:148
988 "B<open>(2), B<closedir>(3), B<dirfd>(3), B<readdir>(3), B<rewinddir>(3), "
989 "B<scandir>(3), B<seekdir>(3), B<telldir>(3)"
993 #: build/C/man2/readdir.2:30 build/C/man3/readdir.3:36
999 #: build/C/man2/readdir.2:30 build/C/man3/readdir.3:36
1005 #: build/C/man2/readdir.2:33
1006 msgid "readdir - read directory entry"
1010 #: build/C/man2/readdir.2:38
1013 "B<int readdir(unsigned int >I<fd>B<, struct old_linux_dirent *>I<dirp>B<,>\n"
1014 "B< unsigned int >I<count>B<);>\n"
1018 #: build/C/man2/readdir.2:50
1020 "This is not the function you are interested in. Look at B<readdir>(3) for "
1021 "the POSIX conforming C library interface. This page documents the bare "
1022 "kernel system call interface, which is superseded by B<getdents>(2)."
1026 #: build/C/man2/readdir.2:64
1028 "B<readdir>() reads one I<old_linux_dirent> structure from the directory "
1029 "referred to by the file descriptor I<fd> into the buffer pointed to by "
1030 "I<dirp>. The argument I<count> is ignored; at most one I<old_linux_dirent> "
1031 "structure is read."
1035 #: build/C/man2/readdir.2:68
1036 msgid "The I<old_linux_dirent> structure is declared as follows:"
1040 #: build/C/man2/readdir.2:77
1043 "struct old_linux_dirent {\n"
1044 " long d_ino; /* inode number */\n"
1045 " off_t d_off; /* offset to this I<old_linux_dirent> */\n"
1046 " unsigned short d_reclen; /* length of this I<d_name> */\n"
1047 " char d_name[NAME_MAX+1]; /* filename (null-terminated) */\n"
1052 #: build/C/man2/readdir.2:91
1054 "I<d_ino> is an inode number. I<d_off> is the distance from the start of the "
1055 "directory to this I<old_linux_dirent>. I<d_reclen> is the size of "
1056 "I<d_name>, not counting the terminating null byte (\\(aq\\e0\\(aq). "
1057 "I<d_name> is a null-terminated filename."
1061 #: build/C/man2/readdir.2:97
1063 "On success, 1 is returned. On end of directory, 0 is returned. On error, "
1064 "-1 is returned, and I<errno> is set appropriately."
1068 #: build/C/man2/readdir.2:116
1069 msgid "This system call is Linux-specific."
1073 #: build/C/man2/readdir.2:125
1075 "Glibc does not provide a wrapper for this system call; call it using "
1076 "B<syscall>(2). You will need to define the I<old_linux_dirent> structure "
1077 "yourself. However, probably you should use B<readdir>(3) instead."
1081 #: build/C/man2/readdir.2:127
1082 msgid "This system call does not exist on x86-64."
1086 #: build/C/man2/readdir.2:129
1087 msgid "B<getdents>(2), B<readdir>(3)"
1091 #: build/C/man3/readdir.3:39
1092 msgid "readdir, readdir_r - read a directory"
1096 #: build/C/man3/readdir.3:44
1098 msgid "B<struct dirent *readdir(DIR *>I<dirp>B<);>\n"
1102 #: build/C/man3/readdir.3:47
1105 "B<int readdir_r(DIR *>I<dirp>B<, struct dirent *>I<entry>B<, struct dirent "
1106 "**>I<result>B<);>\n"
1110 #: build/C/man3/readdir.3:56
1111 msgid "B<readdir_r>():"
1115 #: build/C/man3/readdir.3:59
1117 "_POSIX_C_SOURCE\\ E<gt>=\\ 1 || _XOPEN_SOURCE || _BSD_SOURCE || _SVID_SOURCE "
1122 #: build/C/man3/readdir.3:69
1124 "The B<readdir>() function returns a pointer to a I<dirent> structure "
1125 "representing the next directory entry in the directory stream pointed to by "
1126 "I<dirp>. It returns NULL on reaching the end of the directory stream or if "
1127 "an error occurred."
1131 #: build/C/man3/readdir.3:73
1132 msgid "On Linux, the I<dirent> structure is defined as follows:"
1136 #: build/C/man3/readdir.3:84
1140 " ino_t d_ino; /* inode number */\n"
1141 " off_t d_off; /* not an offset; see NOTES */\n"
1142 " unsigned short d_reclen; /* length of this record */\n"
1143 " unsigned char d_type; /* type of file; not supported\n"
1144 " by all filesystem types */\n"
1145 " char d_name[256]; /* filename */\n"
1150 #: build/C/man3/readdir.3:98
1152 "The only fields in the I<dirent> structure that are mandated by POSIX.1 are: "
1153 "I<d_name>[], of unspecified size, with at most B<NAME_MAX> characters "
1154 "preceding the terminating null byte (\\(aq\\e0\\(aq); and (as an XSI "
1155 "extension) I<d_ino>. The other fields are unstandardized, and not present "
1156 "on all systems; see NOTES below for some further details."
1160 #: build/C/man3/readdir.3:104
1162 "The data returned by B<readdir>() may be overwritten by subsequent calls to "
1163 "B<readdir>() for the same directory stream."
1167 #: build/C/man3/readdir.3:119
1169 "The B<readdir_r>() function is a reentrant version of B<readdir>(). It "
1170 "reads the next directory entry from the directory stream I<dirp>, and "
1171 "returns it in the caller-allocated buffer pointed to by I<entry>. (See "
1172 "NOTES for information on allocating this buffer.) A pointer to the returned "
1173 "item is placed in I<*result>; if the end of the directory stream was "
1174 "encountered, then NULL is instead returned in I<*result>."
1178 #: build/C/man3/readdir.3:134
1180 "On success, B<readdir>() returns a pointer to a I<dirent> structure. (This "
1181 "structure may be statically allocated; do not attempt to B<free>(3) it.) "
1182 "If the end of the directory stream is reached, NULL is returned and I<errno> "
1183 "is not changed. If an error occurs, NULL is returned and I<errno> is set "
1188 #: build/C/man3/readdir.3:143
1190 "The B<readdir_r>() function returns 0 on success. On error, it returns a "
1191 "positive error number (listed under ERRORS). If the end of the directory "
1192 "stream is reached, B<readdir_r>() returns 0, and returns NULL in "
1197 #: build/C/man3/readdir.3:152
1198 msgid "The B<readdir>() function is not thread-safe."
1202 #: build/C/man3/readdir.3:156
1203 msgid "The B<readdir_r>() function is thread-safe."
1207 #: build/C/man3/readdir.3:158 build/C/man3/rewinddir.3:60
1208 msgid "SVr4, 4.3BSD, POSIX.1-2001."
1212 #: build/C/man3/readdir.3:174
1214 "Only the fields I<d_name> and I<d_ino> are specified in POSIX.1-2001. The "
1215 "remaining fields are available on many, but not all systems. Under glibc, "
1216 "programs can check for the availability of the fields not defined in POSIX.1 "
1217 "by testing whether the macros B<_DIRENT_HAVE_D_NAMLEN>, "
1218 "B<_DIRENT_HAVE_D_RECLEN>, B<_DIRENT_HAVE_D_OFF>, or B<_DIRENT_HAVE_D_TYPE> "
1222 #. https://lwn.net/Articles/544298/
1224 #: build/C/man3/readdir.3:187
1226 "The value returned in I<d_off> is the same as would be returned by calling "
1227 "B<telldir>(3) at the current position in the directory stream. Be aware "
1228 "that despite its type and name, the I<d_off> field is seldom any kind of "
1229 "directory offset on modern filesystems. Applications should treat this "
1230 "field as an opaque value, making no assumptions about its contents; see also "
1235 #: build/C/man3/readdir.3:200
1237 "Other than Linux, the I<d_type> field is available mainly only on BSD "
1238 "systems. This field makes it possible to avoid the expense of calling "
1239 "B<lstat>(2) if further actions depend on the type of the file. If the "
1240 "B<_BSD_SOURCE> feature test macro is defined, then glibc defines the "
1241 "following macro constants for the value returned in I<d_type>:"
1245 #: build/C/man3/readdir.3:231
1247 "If the file type could not be determined, the value B<DT_UNKNOWN> is "
1248 "returned in I<d_type>."
1252 #: build/C/man3/readdir.3:250
1254 "Since POSIX.1 does not specify the size of the I<d_name> field, and other "
1255 "nonstandard fields may precede that field within the I<dirent> structure, "
1256 "portable applications that use B<readdir_r>() should allocate the buffer "
1257 "whose address is passed in I<entry> as follows:"
1261 #: build/C/man3/readdir.3:258
1264 "name_max = pathconf(dirpath, _PC_NAME_MAX);\n"
1265 "if (name_max == -1) /* Limit not defined, or error */\n"
1266 " name_max = 255; /* Take a guess */\n"
1267 "len = offsetof(struct dirent, d_name) + name_max + 1;\n"
1268 "entryp = malloc(len);\n"
1272 #: build/C/man3/readdir.3:265
1273 msgid "(POSIX.1 requires that I<d_name> is the last field in a I<struct dirent>.)"
1277 #: build/C/man3/readdir.3:276
1279 "B<getdents>(2), B<read>(2), B<closedir>(3), B<dirfd>(3), B<ftw>(3), "
1280 "B<offsetof>(3), B<opendir>(3), B<rewinddir>(3), B<scandir>(3), "
1281 "B<seekdir>(3), B<telldir>(3)"
1285 #: build/C/man3/rewinddir.3:31
1291 #: build/C/man3/rewinddir.3:31 build/C/man3/telldir.3:30
1297 #: build/C/man3/rewinddir.3:34
1298 msgid "rewinddir - reset directory stream"
1302 #: build/C/man3/rewinddir.3:41
1304 msgid "B<void rewinddir(DIR *>I<dirp>B<);>\n"
1308 #: build/C/man3/rewinddir.3:49
1310 "The B<rewinddir>() function resets the position of the directory stream "
1311 "I<dirp> to the beginning of the directory."
1315 #: build/C/man3/rewinddir.3:53
1316 msgid "The B<rewinddir>() function returns no value."
1320 #: build/C/man3/rewinddir.3:58
1321 msgid "The B<rewinddir>() function is thread-safe."
1325 #: build/C/man3/rewinddir.3:66
1327 "B<closedir>(3), B<opendir>(3), B<readdir>(3), B<scandir>(3), B<seekdir>(3), "
1332 #: build/C/man3/scandir.3:62
1338 #: build/C/man3/scandir.3:62
1344 #: build/C/man3/scandir.3:66
1346 "scandir, scandirat, alphasort, versionsort - scan a directory for matching "
1351 #: build/C/man3/scandir.3:71
1353 msgid "B<int scandir(const char *>I<dirp>B<, struct dirent ***>I<namelist>B<,>\n"
1357 #: build/C/man3/scandir.3:74 build/C/man3/scandir.3:90
1360 "B<int (*>I<filter>B<)(const struct dirent *),>\n"
1361 "B<int (*>I<compar>B<)(const struct dirent **, const struct dirent **));>\n"
1365 #: build/C/man3/scandir.3:77
1368 "B<int alphasort(const struct dirent **>I<a>B<, const struct dirent "
1373 #: build/C/man3/scandir.3:79
1376 "B<int versionsort(const struct dirent **>I<a>B<, const struct dirent "
1381 #: build/C/man3/scandir.3:82
1384 "B<#include E<lt>fcntl.hE<gt>> /* Definition of AT_* constants */\n"
1385 "B<#include E<lt>dirent.hE<gt>>\n"
1389 #: build/C/man3/scandir.3:86
1391 "B<int scandirat(int >I<dirfd>B<, const char *>I<dirp>B<,> B<struct dirent "
1392 "***>I<namelist>B<,>"
1396 #: build/C/man3/scandir.3:100
1397 msgid "B<scandir>(), B<alphasort>():"
1401 #: build/C/man3/scandir.3:115
1402 msgid "B<versionsort>(): _GNU_SOURCE"
1406 #: build/C/man3/scandir.3:118
1407 msgid "B<scandirat>(): _GNU_SOURCE"
1411 #: build/C/man3/scandir.3:133
1413 "The B<scandir>() function scans the directory I<dirp>, calling I<filter>() "
1414 "on each directory entry. Entries for which I<filter>() returns nonzero are "
1415 "stored in strings allocated via B<malloc>(3), sorted using B<qsort>(3) with "
1416 "the comparison function I<compar>(), and collected in array I<namelist> "
1417 "which is allocated via B<malloc>(3). If I<filter> is NULL, all entries are "
1422 #: build/C/man3/scandir.3:145
1424 "The B<alphasort>() and B<versionsort>() functions can be used as the "
1425 "comparison function I<compar>(). The former sorts directory entries using "
1426 "B<strcoll>(3), the latter using B<strverscmp>(3) on the strings "
1427 "I<(*a)-E<gt>d_name> and I<(*b)-E<gt>d_name>."
1431 #: build/C/man3/scandir.3:145
1437 #: build/C/man3/scandir.3:151
1439 "The B<scandirat>() function operates in exactly the same way as "
1440 "B<scandir>(), except for the differences described here."
1444 #: build/C/man3/scandir.3:161
1446 "If the pathname given in I<dirp> is relative, then it is interpreted "
1447 "relative to the directory referred to by the file descriptor I<dirfd> "
1448 "(rather than relative to the current working directory of the calling "
1449 "process, as is done by B<scandir>() for a relative pathname)."
1453 #: build/C/man3/scandir.3:173
1455 "If I<dirp> is relative and I<dirfd> is the special value B<AT_FDCWD>, then "
1456 "I<dirp> is interpreted relative to the current working directory of the "
1457 "calling process (like B<scandir>())."
1461 #: build/C/man3/scandir.3:179
1462 msgid "If I<dirp> is absolute, then I<dirfd> is ignored."
1466 #: build/C/man3/scandir.3:184
1467 msgid "See B<openat>(2) for an explanation of the need for B<scandirat>()."
1471 #: build/C/man3/scandir.3:192
1473 "The B<scandir>() function returns the number of directory entries "
1474 "selected. On error, -1 is returned, with I<errno> set to indicate the cause "
1479 #: build/C/man3/scandir.3:200
1481 "The B<alphasort>() and B<versionsort>() functions return an integer less "
1482 "than, equal to, or greater than zero if the first argument is considered to "
1483 "be respectively less than, equal to, or greater than the second."
1487 #: build/C/man3/scandir.3:204
1488 msgid "The path in I<dirp> does not exist."
1492 #: build/C/man3/scandir.3:210
1493 msgid "The path in I<dirp> is not a directory."
1497 #: build/C/man3/scandir.3:213
1498 msgid "The following additional errors can occur for B<scandirat>():"
1502 #: build/C/man3/scandir.3:217
1503 msgid "I<dirfd> is not a valid file descriptor."
1507 #: build/C/man3/scandir.3:223
1509 "I<dirp> is a relative path and I<dirfd> is a file descriptor referring to a "
1510 "file other than a directory."
1514 #: build/C/man3/scandir.3:226
1515 msgid "B<versionsort>() was added to glibc in version 2.1."
1519 #: build/C/man3/scandir.3:229
1520 msgid "B<scandirat>() was added to glibc in version 2.15."
1524 #: build/C/man3/scandir.3:233
1525 msgid "B<alphasort>(), B<scandir>(): 4.3BSD, POSIX.1-2008."
1533 #. are from 4.3BSD, and have been available under Linux since libc4.
1534 #. Libc4 and libc5 use the more precise prototype
1537 #. int alphasort(const struct dirent ** a,
1538 #. const struct dirent **b);
1541 #. but glibc 2.0 returns to the imprecise BSD prototype.
1543 #: build/C/man3/scandir.3:252
1544 msgid "B<versionsort>() and B<scandirat>() are GNU extensions."
1548 #: build/C/man3/scandir.3:259
1550 "Since glibc 2.1, B<alphasort>() calls B<strcoll>(3); earlier it used "
1555 #: build/C/man3/scandir.3:264
1558 "#define _SVID_SOURCE\n"
1559 "/* print files in current directory in reverse order */\n"
1560 "#include E<lt>dirent.hE<gt>\n"
1564 #: build/C/man3/scandir.3:270
1570 " struct dirent **namelist;\n"
1575 #: build/C/man3/scandir.3:282
1578 " n = scandir(\".\", &namelist, NULL, alphasort);\n"
1580 " perror(\"scandir\");\n"
1583 " printf(\"%s\\en\", namelist[n]-E<gt>d_name);\n"
1584 " free(namelist[n]);\n"
1586 " free(namelist);\n"
1592 #: build/C/man3/scandir.3:293
1594 "B<closedir>(3), B<fnmatch>(3), B<opendir>(3), B<readdir>(3), "
1595 "B<rewinddir>(3), B<seekdir>(3), B<strcmp>(3), B<strcoll>(3), "
1596 "B<strverscmp>(3), B<telldir>(3)"
1600 #: build/C/man3/seekdir.3:31
1606 #: build/C/man3/seekdir.3:31
1612 #: build/C/man3/seekdir.3:35
1614 "seekdir - set the position of the next readdir() call in the directory "
1619 #: build/C/man3/seekdir.3:40
1621 msgid "B<void seekdir(DIR *>I<dirp>B<, long >I<loc>B<);>\n"
1625 #: build/C/man3/seekdir.3:49
1626 msgid "B<seekdir>(): _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE"
1630 #: build/C/man3/seekdir.3:60
1632 "The B<seekdir>() function sets the location in the directory stream from "
1633 "which the next B<readdir>(2) call will start. The I<loc> argument should "
1634 "be a value returned by a previous call to B<telldir>(3)."
1638 #: build/C/man3/seekdir.3:64
1639 msgid "The B<seekdir>() function returns no value."
1643 #: build/C/man3/seekdir.3:69
1644 msgid "The B<seekdir>() function is thread-safe."
1648 #: build/C/man3/seekdir.3:71 build/C/man3/telldir.3:71
1649 msgid "4.3BSD, POSIX.1-2001."
1653 #: build/C/man3/seekdir.3:83
1655 "In glibc up to version 2.1.1, the type of the I<loc> argument was I<off_t>. "
1656 "POSIX.1-2001 specifies I<long>, and this is the type used since glibc "
1657 "2.1.2. See B<telldir>(3) for information on why you should be careful in "
1658 "making any assumptions about the value in this argument."
1662 #: build/C/man3/seekdir.3:90
1664 "B<lseek>(2), B<closedir>(3), B<opendir>(3), B<readdir>(3), B<rewinddir>(3), "
1665 "B<scandir>(3), B<telldir>(3)"
1669 #: build/C/man3/telldir.3:30
1675 #: build/C/man3/telldir.3:33
1676 msgid "telldir - return current location in directory stream"
1680 #: build/C/man3/telldir.3:38
1682 msgid "B<long telldir(DIR *>I<dirp>B<);>\n"
1686 #: build/C/man3/telldir.3:47
1687 msgid "B<telldir>(): _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE"
1691 #: build/C/man3/telldir.3:52
1693 "The B<telldir>() function returns the current location associated with the "
1694 "directory stream I<dirp>."
1698 #: build/C/man3/telldir.3:60
1700 "On success, the B<telldir>() function returns the current location in the "
1701 "directory stream. On error, -1 is returned, and I<errno> is set "
1706 #: build/C/man3/telldir.3:69
1707 msgid "The B<telldir>() function is thread-safe."
1711 #: build/C/man3/telldir.3:79
1713 "In glibc up to version 2.1.1, the return type of B<telldir>() was "
1714 "I<off_t>. POSIX.1-2001 specifies I<long>, and this is the type used since "
1718 #. https://lwn.net/Articles/544298/
1720 #: build/C/man3/telldir.3:95
1722 "In early filesystems, the value returned by B<telldir>() was a simple file "
1723 "offset within a directory. Modern filesystems use tree or hash structures, "
1724 "rather than flat tables, to represent directories. On such filesystems, the "
1725 "value returned by B<telldir>() (and used internally by B<readdir>(3)) is a "
1726 "\"cookie\" that is used by the implementation to derive a position within a "
1727 "directory. Application programs should treat this strictly as an opaque "
1728 "value, making I<no> assumptions about its contents."
1732 #: build/C/man3/telldir.3:101
1734 "B<closedir>(3), B<opendir>(3), B<readdir>(3), B<rewinddir>(3), "
1735 "B<scandir>(3), B<seekdir>(3)"