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-23 22:24+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:77
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/closedir.3:77 build/C/man3/dirfd.3:113 build/C/man2/getdents.2:285 build/C/man3/getdirentries.3:80 build/C/man3/opendir.3:149 build/C/man2/readdir.2:130 build/C/man3/readdir.3:277 build/C/man3/rewinddir.3:67 build/C/man3/scandir.3:294 build/C/man3/seekdir.3:91 build/C/man3/telldir.3:102
148 #: build/C/man3/closedir.3:85 build/C/man3/dirfd.3:121 build/C/man2/getdents.2:293 build/C/man3/getdirentries.3:88 build/C/man3/opendir.3:157 build/C/man2/readdir.2:138 build/C/man3/readdir.3:285 build/C/man3/rewinddir.3:75 build/C/man3/scandir.3:302 build/C/man3/seekdir.3:99 build/C/man3/telldir.3:110
150 "This page is part of release 3.78 of the Linux I<man-pages> project. A "
151 "description of the project, information about reporting bugs, and the latest "
152 "version of this page, can be found at "
153 "\\%http://www.kernel.org/doc/man-pages/."
157 #: build/C/man3/dirfd.3:25
163 #: build/C/man3/dirfd.3:25
169 #: build/C/man3/dirfd.3:25 build/C/man2/getdents.2:30 build/C/man2/readdir.2:30
175 #: build/C/man3/dirfd.3:28
176 msgid "dirfd - get directory stream file descriptor"
180 #: build/C/man3/dirfd.3:30
181 msgid "B<#include E<lt>sys/types.hE<gt>>"
185 #: build/C/man3/dirfd.3:32 build/C/man3/getdirentries.3:32
186 msgid "B<#include E<lt>dirent.hE<gt>>"
190 #: build/C/man3/dirfd.3:34
191 msgid "B<int dirfd(DIR *>I<dirp>B<);>"
195 #: 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
196 msgid "Feature Test Macro Requirements for glibc (see B<feature_test_macros>(7)):"
200 #: build/C/man3/dirfd.3:41
205 #: build/C/man3/dirfd.3:46 build/C/man3/scandir.3:105
206 msgid "_BSD_SOURCE || _SVID_SOURCE"
210 #: build/C/man3/dirfd.3:48 build/C/man3/scandir.3:107
211 msgid "|| /* Since glibc 2.10: */"
215 #: build/C/man3/dirfd.3:50 build/C/man3/scandir.3:109
216 msgid "(_POSIX_C_SOURCE\\ E<gt>=\\ 200809L || _XOPEN_SOURCE\\ E<gt>=\\ 700)"
220 #: build/C/man3/dirfd.3:59
222 "The function B<dirfd>() returns the file descriptor associated with the "
223 "directory stream I<dirp>."
227 #: build/C/man3/dirfd.3:69
229 "This descriptor is the one used internally by the directory stream. As a "
230 "result, it is useful only for functions which do not depend on or alter the "
231 "file position, such as B<fstat>(2) and B<fchdir>(2). It will be "
232 "automatically closed when B<closedir>(3) is called."
236 #: build/C/man3/dirfd.3:74
238 "On success, a nonnegative file descriptor is returned. On error, -1 is "
239 "returned, and I<errno> is set to indicate the cause of the error."
244 #: build/C/man3/dirfd.3:79
246 "POSIX.1-2008 specifies two errors, neither of which is returned by the "
247 "current implementation."
251 #: build/C/man3/dirfd.3:79 build/C/man2/getdents.2:156 build/C/man2/readdir.2:105
257 #: build/C/man3/dirfd.3:83
258 msgid "I<dirp> does not refer to a valid directory stream."
262 #: build/C/man3/dirfd.3:83
268 #: build/C/man3/dirfd.3:87
270 "The implementation does not support the association of a file descriptor "
275 #: 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
281 #: 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
283 msgid "Multithreading (see pthreads(7))"
287 #: build/C/man3/dirfd.3:92
288 msgid "The B<dirfd>() function is thread-safe."
291 #. It is present in libc5 (since 5.1.2) and in glibc2.
293 #: build/C/man3/dirfd.3:96
295 "POSIX.1-2008. This function was a BSD extension, present in 4.3BSD-Reno, "
300 #: 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
306 #: build/C/man3/dirfd.3:104
308 "The prototype for B<dirfd>() is available only if B<_BSD_SOURCE> or "
309 "B<_SVID_SOURCE> is defined."
313 #: build/C/man3/dirfd.3:113
315 "B<open>(2), B<closedir>(3), B<opendir>(3), B<readdir>(3), B<rewinddir>(3), "
316 "B<scandir>(3), B<seekdir>(3), B<telldir>(3)"
320 #: build/C/man2/getdents.2:30
326 #: build/C/man2/getdents.2:30
332 #: build/C/man2/getdents.2:33
333 msgid "getdents - get directory entries"
337 #: build/C/man2/getdents.2:37
340 "B<int getdents(unsigned int >I<fd>B<, struct linux_dirent *>I<dirp>B<,>\n"
341 "B< unsigned int >I<count>B<);>\n"
345 #: build/C/man2/getdents.2:41 build/C/man2/readdir.2:42
346 msgid "I<Note>: There is no glibc wrapper for this system call; see NOTES."
350 #: build/C/man2/getdents.2:47
352 "This is not the function you are interested in. Look at B<readdir>(3) for "
353 "the POSIX conforming C library interface. This page documents the bare "
354 "kernel system call interface."
358 #: build/C/man2/getdents.2:60
360 "The system call B<getdents>() reads several I<linux_dirent> structures from "
361 "the directory referred to by the open file descriptor I<fd> into the buffer "
362 "pointed to by I<dirp>. The argument I<count> specifies the size of that "
367 #: build/C/man2/getdents.2:64
368 msgid "The I<linux_dirent> structure is declared as follows:"
372 #: build/C/man2/getdents.2:79
375 "struct linux_dirent {\n"
376 " unsigned long d_ino; /* Inode number */\n"
377 " unsigned long d_off; /* Offset to next I<linux_dirent> */\n"
378 " unsigned short d_reclen; /* Length of this I<linux_dirent> */\n"
379 " char d_name[]; /* Filename (null-terminated) */\n"
380 " /* length is actually (d_reclen - 2 -\n"
381 " offsetof(struct linux_dirent, d_name)) */\n"
383 " char pad; // Zero padding byte\n"
384 " char d_type; // File type (only since Linux\n"
385 " // 2.6.4); offset is (d_reclen - 1)\n"
390 #: build/C/man2/getdents.2:81
396 #: build/C/man2/getdents.2:94
398 "I<d_ino> is an inode number. I<d_off> is the distance from the start of the "
399 "directory to the start of the next I<linux_dirent>. I<d_reclen> is the size "
400 "of this entire I<linux_dirent>. I<d_name> is a null-terminated filename."
404 #: build/C/man2/getdents.2:99
406 "I<d_type> is a byte at the end of the structure that indicates the file "
407 "type. It contains one of the following values (defined in "
408 "I<E<lt>dirent.hE<gt>>):"
412 #: build/C/man2/getdents.2:99 build/C/man3/readdir.3:200
418 #: build/C/man2/getdents.2:102 build/C/man3/readdir.3:203
419 msgid "This is a block device."
423 #: build/C/man2/getdents.2:102 build/C/man3/readdir.3:203
429 #: build/C/man2/getdents.2:105 build/C/man3/readdir.3:206
430 msgid "This is a character device."
434 #: build/C/man2/getdents.2:105 build/C/man3/readdir.3:206
440 #: build/C/man2/getdents.2:108 build/C/man3/readdir.3:209
441 msgid "This is a directory."
445 #: build/C/man2/getdents.2:108 build/C/man3/readdir.3:209
451 #: build/C/man2/getdents.2:111 build/C/man3/readdir.3:212
452 msgid "This is a named pipe (FIFO)."
456 #: build/C/man2/getdents.2:111 build/C/man3/readdir.3:212
462 #: build/C/man2/getdents.2:114 build/C/man3/readdir.3:215
463 msgid "This is a symbolic link."
467 #: build/C/man2/getdents.2:114 build/C/man3/readdir.3:215
473 #: build/C/man2/getdents.2:117 build/C/man3/readdir.3:218
474 msgid "This is a regular file."
478 #: build/C/man2/getdents.2:117 build/C/man3/readdir.3:218
484 #: build/C/man2/getdents.2:120 build/C/man3/readdir.3:221
485 msgid "This is a UNIX domain socket."
489 #: build/C/man2/getdents.2:120 build/C/man3/readdir.3:221
491 msgid "B<DT_UNKNOWN>"
494 #. The glibc manual says that on some systems this is the only
497 #: build/C/man2/getdents.2:123 build/C/man3/readdir.3:226
498 msgid "The file type is unknown."
502 #: build/C/man2/getdents.2:133
504 "The I<d_type> field is implemented since Linux 2.6.4. It occupies a space "
505 "that was previously a zero-filled padding byte in the I<linux_dirent> "
506 "structure. Thus, on kernels before 2.6.3, attempting to access this field "
507 "always provides the value 0 (B<DT_UNKNOWN>)."
511 #. The same sentence is in getdents.2
513 #: build/C/man2/getdents.2:142 build/C/man3/readdir.3:240
515 "Currently, only some filesystems (among them: Btrfs, ext2, ext3, and ext4) "
516 "have full support for returning the file type in I<d_type>. All "
517 "applications must properly handle a return of B<DT_UNKNOWN>."
521 #: build/C/man2/getdents.2:148
523 "On success, the number of bytes read is returned. On end of directory, 0 is "
524 "returned. On error, -1 is returned, and I<errno> is set appropriately."
528 #: build/C/man2/getdents.2:153 build/C/man2/readdir.2:102
529 msgid "Invalid file descriptor I<fd>."
533 #: build/C/man2/getdents.2:153 build/C/man2/readdir.2:102
539 #: build/C/man2/getdents.2:156 build/C/man2/readdir.2:105
540 msgid "Argument points outside the calling process's address space."
544 #: build/C/man2/getdents.2:159 build/C/man2/readdir.2:108
545 msgid "Result buffer is too small."
549 #: build/C/man2/getdents.2:159 build/C/man3/opendir.3:106 build/C/man2/readdir.2:108 build/C/man3/scandir.3:201
555 #: build/C/man2/getdents.2:162 build/C/man2/readdir.2:111
556 msgid "No such directory."
560 #: 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
566 #: build/C/man2/getdents.2:165 build/C/man2/readdir.2:114
567 msgid "File descriptor does not refer to a directory."
570 #. SVr4 documents additional ENOLINK, EIO error conditions.
572 #: build/C/man2/getdents.2:168
577 #: build/C/man2/getdents.2:177
579 "Glibc does not provide a wrapper for this system call; call it using "
580 "B<syscall>(2). You will need to define the I<linux_dirent> structure "
581 "yourself. However, you probably want to use B<readdir>(3) instead."
585 #: build/C/man2/getdents.2:180
586 msgid "This call supersedes B<readdir>(2)."
590 #: build/C/man2/getdents.2:193
592 "The original Linux B<getdents>() system call did not handle large "
593 "filesystems and large file offsets. Consequently, Linux 2.4 added "
594 "B<getdents64>(), with wider types for the I<d_ino> and I<d_off> fields "
595 "employed in the I<linux_dirent> structure."
599 #: build/C/man2/getdents.2:193 build/C/man3/scandir.3:259
604 #. FIXME The example program needs to be revised, since it uses the older
605 #. getdents() system call and the structure with smaller field widths.
607 #: build/C/man2/getdents.2:200
609 "The program below demonstrates the use of B<getdents>(). The following "
610 "output shows an example of what we see when running this program on an ext2 "
615 #: build/C/man2/getdents.2:213
618 "$B< ./a.out /testfs/>\n"
619 "--------------- nread=120 ---------------\n"
620 "inode# file type d_reclen d_off d_name\n"
621 " 2 directory 16 12 .\n"
622 " 2 directory 16 24 ..\n"
623 " 11 directory 24 44 lost+found\n"
624 " 12 regular 16 56 a\n"
625 " 228929 directory 16 68 sub\n"
626 " 16353 directory 16 80 sub2\n"
627 " 130817 directory 16 4096 sub3\n"
631 #: build/C/man2/getdents.2:215
633 msgid "Program source"
637 #: build/C/man2/getdents.2:226
640 "#define _GNU_SOURCE\n"
641 "#include E<lt>dirent.hE<gt> /* Defines DT_* constants */\n"
642 "#include E<lt>fcntl.hE<gt>\n"
643 "#include E<lt>stdio.hE<gt>\n"
644 "#include E<lt>unistd.hE<gt>\n"
645 "#include E<lt>stdlib.hE<gt>\n"
646 "#include E<lt>sys/stat.hE<gt>\n"
647 "#include E<lt>sys/syscall.hE<gt>\n"
651 #: build/C/man2/getdents.2:229
654 "#define handle_error(msg) \\e\n"
655 " do { perror(msg); exit(EXIT_FAILURE); } while (0)\n"
659 #: build/C/man2/getdents.2:236
662 "struct linux_dirent {\n"
665 " unsigned short d_reclen;\n"
671 #: build/C/man2/getdents.2:238
673 msgid "#define BUF_SIZE 1024\n"
677 #: build/C/man2/getdents.2:247
681 "main(int argc, char *argv[])\n"
684 " char buf[BUF_SIZE];\n"
685 " struct linux_dirent *d;\n"
691 #: build/C/man2/getdents.2:251
694 " fd = open(argc E<gt> 1 ? argv[1] : \".\", O_RDONLY | O_DIRECTORY);\n"
696 " handle_error(\"open\");\n"
700 #: build/C/man2/getdents.2:256
704 " nread = syscall(SYS_getdents, fd, buf, BUF_SIZE);\n"
705 " if (nread == -1)\n"
706 " handle_error(\"getdents\");\n"
710 #: build/C/man2/getdents.2:259
718 #: build/C/man2/getdents.2:278
721 " printf(\"--------------- nread=%d ---------------\\en\", nread);\n"
722 " printf(\"inode# file type d_reclen d_off d_name\\en\");\n"
723 " for (bpos = 0; bpos E<lt> nread;) {\n"
724 " d = (struct linux_dirent *) (buf + bpos);\n"
725 " printf(\"%8ld \", d-E<gt>d_ino);\n"
726 " d_type = *(buf + bpos + d-E<gt>d_reclen - 1);\n"
727 " printf(\"%-10s \", (d_type == DT_REG) ? \"regular\" :\n"
728 " (d_type == DT_DIR) ? \"directory\" :\n"
729 " (d_type == DT_FIFO) ? \"FIFO\" :\n"
730 " (d_type == DT_SOCK) ? \"socket\" :\n"
731 " (d_type == DT_LNK) ? \"symlink\" :\n"
732 " (d_type == DT_BLK) ? \"block dev\" :\n"
733 " (d_type == DT_CHR) ? \"char dev\" : "
735 " printf(\"%4d %10lld %s\\en\", d-E<gt>d_reclen,\n"
736 " (long long) d-E<gt>d_off, d-E<gt>d_name);\n"
737 " bpos += d-E<gt>d_reclen;\n"
743 #: build/C/man2/getdents.2:281
746 " exit(EXIT_SUCCESS);\n"
751 #: build/C/man2/getdents.2:285
752 msgid "B<readdir>(2), B<readdir>(3)"
756 #: build/C/man3/getdirentries.3:27
758 msgid "GETDIRENTRIES"
762 #: build/C/man3/getdirentries.3:27
768 #: build/C/man3/getdirentries.3:27 build/C/man3/opendir.3:32 build/C/man3/scandir.3:62
774 #: build/C/man3/getdirentries.3:30
775 msgid "getdirentries - get directory entries in a filesystem-independent format"
779 #: build/C/man3/getdirentries.3:35
781 "B<ssize_t getdirentries(int >I<fd>B<, char *>I<buf>B<, size_t >I<nbytes> B<, "
782 "off_t *>I<basep>B<);>"
786 #: build/C/man3/getdirentries.3:43
787 msgid "B<getdirentries>(): _BSD_SOURCE || _SVID_SOURCE"
791 #: build/C/man3/getdirentries.3:56
793 "Read directory entries from the directory specified by I<fd> into I<buf>. "
794 "At most I<nbytes> are read. Reading starts at offset I<*basep>, and "
795 "I<*basep> is updated with the new position after reading."
799 #: build/C/man3/getdirentries.3:62
801 "B<getdirentries>() returns the number of bytes read or zero when at the end "
802 "of the directory. If an error occurs, -1 is returned, and I<errno> is set "
807 #: build/C/man3/getdirentries.3:64
808 msgid "See the Linux library source code for details."
812 #: build/C/man3/getdirentries.3:69
813 msgid "The B<getdirentries>() function is thread-safe."
817 #: build/C/man3/getdirentries.3:77
819 "Not in POSIX.1-2001. Present on the BSDs, and a few other systems. Use "
820 "B<opendir>(3) and B<readdir>(3) instead."
824 #: build/C/man3/getdirentries.3:80
825 msgid "B<lseek>(2), B<open>(2)"
829 #: build/C/man3/opendir.3:32
835 #: build/C/man3/opendir.3:32
841 #: build/C/man3/opendir.3:35
842 msgid "opendir, fdopendir - open a directory"
846 #: build/C/man3/opendir.3:43
849 "B<DIR *opendir(const char *>I<name>B<);>\n"
850 "B<DIR *fdopendir(int >I<fd>B<);>\n"
854 #: build/C/man3/opendir.3:51
855 msgid "B<fdopendir>():"
859 #: build/C/man3/opendir.3:54
861 msgid "Since glibc 2.10:"
865 #: build/C/man3/opendir.3:57
866 msgid "_XOPEN_SOURCE\\ E<gt>=\\ 700 || _POSIX_C_SOURCE\\ E<gt>=\\ 200809L"
870 #: build/C/man3/opendir.3:57
872 msgid "Before glibc 2.10:"
876 #: build/C/man3/opendir.3:60
881 #: build/C/man3/opendir.3:69
883 "The B<opendir>() function opens a directory stream corresponding to the "
884 "directory I<name>, and returns a pointer to the directory stream. The "
885 "stream is positioned at the first entry in the directory."
889 #: build/C/man3/opendir.3:83
891 "The B<fdopendir>() function is like B<opendir>(), but returns a directory "
892 "stream for the directory referred to by the open file descriptor I<fd>. "
893 "After a successful call to B<fdopendir>(), I<fd> is used internally by the "
894 "implementation, and should not otherwise be used by the application."
898 #: build/C/man3/opendir.3:92
900 "The B<opendir>() and B<fdopendir>() functions return a pointer to the "
901 "directory stream. On error, NULL is returned, and I<errno> is set "
906 #: build/C/man3/opendir.3:93
912 #: build/C/man3/opendir.3:96
913 msgid "Permission denied."
917 #: build/C/man3/opendir.3:100
918 msgid "I<fd> is not a valid file descriptor opened for reading."
922 #: build/C/man3/opendir.3:100
928 #: build/C/man3/opendir.3:103
929 msgid "Too many file descriptors in use by process."
933 #: build/C/man3/opendir.3:103
939 #: build/C/man3/opendir.3:106
940 msgid "Too many files are currently open in the system."
944 #: build/C/man3/opendir.3:109
945 msgid "Directory does not exist, or I<name> is an empty string."
949 #: build/C/man3/opendir.3:109 build/C/man3/scandir.3:204
955 #: build/C/man3/opendir.3:112 build/C/man3/scandir.3:207
956 msgid "Insufficient memory to complete the operation."
960 #: build/C/man3/opendir.3:115
961 msgid "I<name> is not a directory."
965 #: build/C/man3/opendir.3:115 build/C/man3/scandir.3:223
971 #: build/C/man3/opendir.3:118
972 msgid "B<fdopendir>() is available in glibc since version 2.4."
976 #: build/C/man3/opendir.3:123
978 "B<opendir>() is present on SVr4, 4.3BSD, and specified in POSIX.1-2001. "
979 "B<fdopendir>() is specified in POSIX.1-2008."
983 #: build/C/man3/opendir.3:126
985 "The underlying file descriptor of the directory stream can be obtained using "
990 #: build/C/man3/opendir.3:140
992 "The B<opendir>() function sets the close-on-exec flag for the file "
993 "descriptor underlying the I<DIR *>. The B<fdopendir>() function leaves the "
994 "setting of the close-on-exec flag unchanged for the file descriptor, I<fd>. "
995 "POSIX.1-200x leaves it unspecified whether a successful call to "
996 "B<fdopendir>() will set the close-on-exec flag for the file descriptor, "
1001 #: build/C/man3/opendir.3:149
1003 "B<open>(2), B<closedir>(3), B<dirfd>(3), B<readdir>(3), B<rewinddir>(3), "
1004 "B<scandir>(3), B<seekdir>(3), B<telldir>(3)"
1008 #: build/C/man2/readdir.2:30 build/C/man3/readdir.3:36
1014 #: build/C/man2/readdir.2:30 build/C/man3/readdir.3:36
1020 #: build/C/man2/readdir.2:33
1021 msgid "readdir - read directory entry"
1025 #: build/C/man2/readdir.2:38
1028 "B<int readdir(unsigned int >I<fd>B<, struct old_linux_dirent *>I<dirp>B<,>\n"
1029 "B< unsigned int >I<count>B<);>\n"
1033 #: build/C/man2/readdir.2:50
1035 "This is not the function you are interested in. Look at B<readdir>(3) for "
1036 "the POSIX conforming C library interface. This page documents the bare "
1037 "kernel system call interface, which is superseded by B<getdents>(2)."
1041 #: build/C/man2/readdir.2:64
1043 "B<readdir>() reads one I<old_linux_dirent> structure from the directory "
1044 "referred to by the file descriptor I<fd> into the buffer pointed to by "
1045 "I<dirp>. The argument I<count> is ignored; at most one I<old_linux_dirent> "
1046 "structure is read."
1050 #: build/C/man2/readdir.2:68
1051 msgid "The I<old_linux_dirent> structure is declared as follows:"
1055 #: build/C/man2/readdir.2:77
1058 "struct old_linux_dirent {\n"
1059 " long d_ino; /* inode number */\n"
1060 " off_t d_off; /* offset to this I<old_linux_dirent> */\n"
1061 " unsigned short d_reclen; /* length of this I<d_name> */\n"
1062 " char d_name[NAME_MAX+1]; /* filename (null-terminated) */\n"
1067 #: build/C/man2/readdir.2:91
1069 "I<d_ino> is an inode number. I<d_off> is the distance from the start of the "
1070 "directory to this I<old_linux_dirent>. I<d_reclen> is the size of "
1071 "I<d_name>, not counting the terminating null byte (\\(aq\\e0\\(aq). "
1072 "I<d_name> is a null-terminated filename."
1076 #: build/C/man2/readdir.2:97
1078 "On success, 1 is returned. On end of directory, 0 is returned. On error, "
1079 "-1 is returned, and I<errno> is set appropriately."
1083 #: build/C/man2/readdir.2:116
1084 msgid "This system call is Linux-specific."
1088 #: build/C/man2/readdir.2:125
1090 "Glibc does not provide a wrapper for this system call; call it using "
1091 "B<syscall>(2). You will need to define the I<old_linux_dirent> structure "
1092 "yourself. However, probably you should use B<readdir>(3) instead."
1096 #: build/C/man2/readdir.2:127
1097 msgid "This system call does not exist on x86-64."
1101 #: build/C/man2/readdir.2:130
1102 msgid "B<getdents>(2), B<readdir>(3)"
1106 #: build/C/man3/readdir.3:39
1107 msgid "readdir, readdir_r - read a directory"
1111 #: build/C/man3/readdir.3:44
1113 msgid "B<struct dirent *readdir(DIR *>I<dirp>B<);>\n"
1117 #: build/C/man3/readdir.3:47
1120 "B<int readdir_r(DIR *>I<dirp>B<, struct dirent *>I<entry>B<, struct dirent "
1121 "**>I<result>B<);>\n"
1125 #: build/C/man3/readdir.3:56
1126 msgid "B<readdir_r>():"
1130 #: build/C/man3/readdir.3:59
1132 "_POSIX_C_SOURCE\\ E<gt>=\\ 1 || _XOPEN_SOURCE || _BSD_SOURCE || _SVID_SOURCE "
1137 #: build/C/man3/readdir.3:69
1139 "The B<readdir>() function returns a pointer to a I<dirent> structure "
1140 "representing the next directory entry in the directory stream pointed to by "
1141 "I<dirp>. It returns NULL on reaching the end of the directory stream or if "
1142 "an error occurred."
1146 #: build/C/man3/readdir.3:73
1147 msgid "On Linux, the I<dirent> structure is defined as follows:"
1151 #: build/C/man3/readdir.3:84
1155 " ino_t d_ino; /* inode number */\n"
1156 " off_t d_off; /* not an offset; see NOTES */\n"
1157 " unsigned short d_reclen; /* length of this record */\n"
1158 " unsigned char d_type; /* type of file; not supported\n"
1159 " by all filesystem types */\n"
1160 " char d_name[256]; /* filename */\n"
1165 #: build/C/man3/readdir.3:98
1167 "The only fields in the I<dirent> structure that are mandated by POSIX.1 are: "
1168 "I<d_name>[], of unspecified size, with at most B<NAME_MAX> characters "
1169 "preceding the terminating null byte (\\(aq\\e0\\(aq); and (as an XSI "
1170 "extension) I<d_ino>. The other fields are unstandardized, and not present "
1171 "on all systems; see NOTES below for some further details."
1175 #: build/C/man3/readdir.3:104
1177 "The data returned by B<readdir>() may be overwritten by subsequent calls to "
1178 "B<readdir>() for the same directory stream."
1182 #: build/C/man3/readdir.3:119
1184 "The B<readdir_r>() function is a reentrant version of B<readdir>(). It "
1185 "reads the next directory entry from the directory stream I<dirp>, and "
1186 "returns it in the caller-allocated buffer pointed to by I<entry>. (See "
1187 "NOTES for information on allocating this buffer.) A pointer to the returned "
1188 "item is placed in I<*result>; if the end of the directory stream was "
1189 "encountered, then NULL is instead returned in I<*result>."
1193 #: build/C/man3/readdir.3:134
1195 "On success, B<readdir>() returns a pointer to a I<dirent> structure. (This "
1196 "structure may be statically allocated; do not attempt to B<free>(3) it.) "
1197 "If the end of the directory stream is reached, NULL is returned and I<errno> "
1198 "is not changed. If an error occurs, NULL is returned and I<errno> is set "
1203 #: build/C/man3/readdir.3:143
1205 "The B<readdir_r>() function returns 0 on success. On error, it returns a "
1206 "positive error number (listed under ERRORS). If the end of the directory "
1207 "stream is reached, B<readdir_r>() returns 0, and returns NULL in "
1212 #: build/C/man3/readdir.3:152
1213 msgid "The B<readdir>() function is not thread-safe."
1217 #: build/C/man3/readdir.3:156
1218 msgid "The B<readdir_r>() function is thread-safe."
1222 #: build/C/man3/readdir.3:158 build/C/man3/rewinddir.3:60
1223 msgid "SVr4, 4.3BSD, POSIX.1-2001."
1227 #: build/C/man3/readdir.3:174
1229 "Only the fields I<d_name> and I<d_ino> are specified in POSIX.1-2001. The "
1230 "remaining fields are available on many, but not all systems. Under glibc, "
1231 "programs can check for the availability of the fields not defined in POSIX.1 "
1232 "by testing whether the macros B<_DIRENT_HAVE_D_NAMLEN>, "
1233 "B<_DIRENT_HAVE_D_RECLEN>, B<_DIRENT_HAVE_D_OFF>, or B<_DIRENT_HAVE_D_TYPE> "
1237 #. https://lwn.net/Articles/544298/
1239 #: build/C/man3/readdir.3:187
1241 "The value returned in I<d_off> is the same as would be returned by calling "
1242 "B<telldir>(3) at the current position in the directory stream. Be aware "
1243 "that despite its type and name, the I<d_off> field is seldom any kind of "
1244 "directory offset on modern filesystems. Applications should treat this "
1245 "field as an opaque value, making no assumptions about its contents; see also "
1250 #: build/C/man3/readdir.3:200
1252 "Other than Linux, the I<d_type> field is available mainly only on BSD "
1253 "systems. This field makes it possible to avoid the expense of calling "
1254 "B<lstat>(2) if further actions depend on the type of the file. If the "
1255 "B<_BSD_SOURCE> feature test macro is defined, then glibc defines the "
1256 "following macro constants for the value returned in I<d_type>:"
1260 #: build/C/man3/readdir.3:231
1262 "If the file type could not be determined, the value B<DT_UNKNOWN> is "
1263 "returned in I<d_type>."
1267 #: build/C/man3/readdir.3:250
1269 "Since POSIX.1 does not specify the size of the I<d_name> field, and other "
1270 "nonstandard fields may precede that field within the I<dirent> structure, "
1271 "portable applications that use B<readdir_r>() should allocate the buffer "
1272 "whose address is passed in I<entry> as follows:"
1276 #: build/C/man3/readdir.3:258
1279 "name_max = pathconf(dirpath, _PC_NAME_MAX);\n"
1280 "if (name_max == -1) /* Limit not defined, or error */\n"
1281 " name_max = 255; /* Take a guess */\n"
1282 "len = offsetof(struct dirent, d_name) + name_max + 1;\n"
1283 "entryp = malloc(len);\n"
1287 #: build/C/man3/readdir.3:265
1288 msgid "(POSIX.1 requires that I<d_name> is the last field in a I<struct dirent>.)"
1292 #: build/C/man3/readdir.3:277
1294 "B<getdents>(2), B<read>(2), B<closedir>(3), B<dirfd>(3), B<ftw>(3), "
1295 "B<offsetof>(3), B<opendir>(3), B<rewinddir>(3), B<scandir>(3), "
1296 "B<seekdir>(3), B<telldir>(3)"
1300 #: build/C/man3/rewinddir.3:31
1306 #: build/C/man3/rewinddir.3:31 build/C/man3/telldir.3:30
1312 #: build/C/man3/rewinddir.3:34
1313 msgid "rewinddir - reset directory stream"
1317 #: build/C/man3/rewinddir.3:41
1319 msgid "B<void rewinddir(DIR *>I<dirp>B<);>\n"
1323 #: build/C/man3/rewinddir.3:49
1325 "The B<rewinddir>() function resets the position of the directory stream "
1326 "I<dirp> to the beginning of the directory."
1330 #: build/C/man3/rewinddir.3:53
1331 msgid "The B<rewinddir>() function returns no value."
1335 #: build/C/man3/rewinddir.3:58
1336 msgid "The B<rewinddir>() function is thread-safe."
1340 #: build/C/man3/rewinddir.3:67
1342 "B<closedir>(3), B<opendir>(3), B<readdir>(3), B<scandir>(3), B<seekdir>(3), "
1347 #: build/C/man3/scandir.3:62
1353 #: build/C/man3/scandir.3:62
1359 #: build/C/man3/scandir.3:66
1361 "scandir, scandirat, alphasort, versionsort - scan a directory for matching "
1366 #: build/C/man3/scandir.3:71
1368 msgid "B<int scandir(const char *>I<dirp>B<, struct dirent ***>I<namelist>B<,>\n"
1372 #: build/C/man3/scandir.3:74 build/C/man3/scandir.3:90
1375 "B<int (*>I<filter>B<)(const struct dirent *),>\n"
1376 "B<int (*>I<compar>B<)(const struct dirent **, const struct dirent **));>\n"
1380 #: build/C/man3/scandir.3:77
1383 "B<int alphasort(const struct dirent **>I<a>B<, const struct dirent "
1388 #: build/C/man3/scandir.3:79
1391 "B<int versionsort(const struct dirent **>I<a>B<, const struct dirent "
1396 #: build/C/man3/scandir.3:82
1399 "B<#include E<lt>fcntl.hE<gt>> /* Definition of AT_* constants */\n"
1400 "B<#include E<lt>dirent.hE<gt>>\n"
1404 #: build/C/man3/scandir.3:86
1406 "B<int scandirat(int >I<dirfd>B<, const char *>I<dirp>B<,> B<struct dirent "
1407 "***>I<namelist>B<,>"
1411 #: build/C/man3/scandir.3:100
1412 msgid "B<scandir>(), B<alphasort>():"
1416 #: build/C/man3/scandir.3:115
1417 msgid "B<versionsort>(): _GNU_SOURCE"
1421 #: build/C/man3/scandir.3:118
1422 msgid "B<scandirat>(): _GNU_SOURCE"
1426 #: build/C/man3/scandir.3:133
1428 "The B<scandir>() function scans the directory I<dirp>, calling I<filter>() "
1429 "on each directory entry. Entries for which I<filter>() returns nonzero are "
1430 "stored in strings allocated via B<malloc>(3), sorted using B<qsort>(3) with "
1431 "the comparison function I<compar>(), and collected in array I<namelist> "
1432 "which is allocated via B<malloc>(3). If I<filter> is NULL, all entries are "
1437 #: build/C/man3/scandir.3:145
1439 "The B<alphasort>() and B<versionsort>() functions can be used as the "
1440 "comparison function I<compar>(). The former sorts directory entries using "
1441 "B<strcoll>(3), the latter using B<strverscmp>(3) on the strings "
1442 "I<(*a)-E<gt>d_name> and I<(*b)-E<gt>d_name>."
1446 #: build/C/man3/scandir.3:145
1452 #: build/C/man3/scandir.3:151
1454 "The B<scandirat>() function operates in exactly the same way as "
1455 "B<scandir>(), except for the differences described here."
1459 #: build/C/man3/scandir.3:161
1461 "If the pathname given in I<dirp> is relative, then it is interpreted "
1462 "relative to the directory referred to by the file descriptor I<dirfd> "
1463 "(rather than relative to the current working directory of the calling "
1464 "process, as is done by B<scandir>() for a relative pathname)."
1468 #: build/C/man3/scandir.3:173
1470 "If I<dirp> is relative and I<dirfd> is the special value B<AT_FDCWD>, then "
1471 "I<dirp> is interpreted relative to the current working directory of the "
1472 "calling process (like B<scandir>())."
1476 #: build/C/man3/scandir.3:179
1477 msgid "If I<dirp> is absolute, then I<dirfd> is ignored."
1481 #: build/C/man3/scandir.3:184
1482 msgid "See B<openat>(2) for an explanation of the need for B<scandirat>()."
1486 #: build/C/man3/scandir.3:192
1488 "The B<scandir>() function returns the number of directory entries "
1489 "selected. On error, -1 is returned, with I<errno> set to indicate the cause "
1494 #: build/C/man3/scandir.3:200
1496 "The B<alphasort>() and B<versionsort>() functions return an integer less "
1497 "than, equal to, or greater than zero if the first argument is considered to "
1498 "be respectively less than, equal to, or greater than the second."
1502 #: build/C/man3/scandir.3:204
1503 msgid "The path in I<dirp> does not exist."
1507 #: build/C/man3/scandir.3:210
1508 msgid "The path in I<dirp> is not a directory."
1512 #: build/C/man3/scandir.3:213
1513 msgid "The following additional errors can occur for B<scandirat>():"
1517 #: build/C/man3/scandir.3:217
1518 msgid "I<dirfd> is not a valid file descriptor."
1522 #: build/C/man3/scandir.3:223
1524 "I<dirp> is a relative path and I<dirfd> is a file descriptor referring to a "
1525 "file other than a directory."
1529 #: build/C/man3/scandir.3:226
1530 msgid "B<versionsort>() was added to glibc in version 2.1."
1534 #: build/C/man3/scandir.3:229
1535 msgid "B<scandirat>() was added to glibc in version 2.15."
1539 #: build/C/man3/scandir.3:233
1540 msgid "B<alphasort>(), B<scandir>(): 4.3BSD, POSIX.1-2008."
1548 #. are from 4.3BSD, and have been available under Linux since libc4.
1549 #. Libc4 and libc5 use the more precise prototype
1552 #. int alphasort(const struct dirent ** a,
1553 #. const struct dirent **b);
1556 #. but glibc 2.0 returns to the imprecise BSD prototype.
1558 #: build/C/man3/scandir.3:252
1559 msgid "B<versionsort>() and B<scandirat>() are GNU extensions."
1563 #: build/C/man3/scandir.3:259
1565 "Since glibc 2.1, B<alphasort>() calls B<strcoll>(3); earlier it used "
1570 #: build/C/man3/scandir.3:264
1573 "#define _SVID_SOURCE\n"
1574 "/* print files in current directory in reverse order */\n"
1575 "#include E<lt>dirent.hE<gt>\n"
1579 #: build/C/man3/scandir.3:270
1585 " struct dirent **namelist;\n"
1590 #: build/C/man3/scandir.3:282
1593 " n = scandir(\".\", &namelist, NULL, alphasort);\n"
1595 " perror(\"scandir\");\n"
1598 " printf(\"%s\\en\", namelist[n]-E<gt>d_name);\n"
1599 " free(namelist[n]);\n"
1601 " free(namelist);\n"
1607 #: build/C/man3/scandir.3:294
1609 "B<closedir>(3), B<fnmatch>(3), B<opendir>(3), B<readdir>(3), "
1610 "B<rewinddir>(3), B<seekdir>(3), B<strcmp>(3), B<strcoll>(3), "
1611 "B<strverscmp>(3), B<telldir>(3)"
1615 #: build/C/man3/seekdir.3:31
1621 #: build/C/man3/seekdir.3:31
1627 #: build/C/man3/seekdir.3:35
1629 "seekdir - set the position of the next readdir() call in the directory "
1634 #: build/C/man3/seekdir.3:40
1636 msgid "B<void seekdir(DIR *>I<dirp>B<, long >I<loc>B<);>\n"
1640 #: build/C/man3/seekdir.3:49
1641 msgid "B<seekdir>(): _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE"
1645 #: build/C/man3/seekdir.3:60
1647 "The B<seekdir>() function sets the location in the directory stream from "
1648 "which the next B<readdir>(2) call will start. The I<loc> argument should "
1649 "be a value returned by a previous call to B<telldir>(3)."
1653 #: build/C/man3/seekdir.3:64
1654 msgid "The B<seekdir>() function returns no value."
1658 #: build/C/man3/seekdir.3:69
1659 msgid "The B<seekdir>() function is thread-safe."
1663 #: build/C/man3/seekdir.3:71 build/C/man3/telldir.3:71
1664 msgid "4.3BSD, POSIX.1-2001."
1668 #: build/C/man3/seekdir.3:83
1670 "In glibc up to version 2.1.1, the type of the I<loc> argument was I<off_t>. "
1671 "POSIX.1-2001 specifies I<long>, and this is the type used since glibc "
1672 "2.1.2. See B<telldir>(3) for information on why you should be careful in "
1673 "making any assumptions about the value in this argument."
1677 #: build/C/man3/seekdir.3:91
1679 "B<lseek>(2), B<closedir>(3), B<opendir>(3), B<readdir>(3), B<rewinddir>(3), "
1680 "B<scandir>(3), B<telldir>(3)"
1684 #: build/C/man3/telldir.3:30
1690 #: build/C/man3/telldir.3:33
1691 msgid "telldir - return current location in directory stream"
1695 #: build/C/man3/telldir.3:38
1697 msgid "B<long telldir(DIR *>I<dirp>B<);>\n"
1701 #: build/C/man3/telldir.3:47
1702 msgid "B<telldir>(): _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE"
1706 #: build/C/man3/telldir.3:52
1708 "The B<telldir>() function returns the current location associated with the "
1709 "directory stream I<dirp>."
1713 #: build/C/man3/telldir.3:60
1715 "On success, the B<telldir>() function returns the current location in the "
1716 "directory stream. On error, -1 is returned, and I<errno> is set "
1721 #: build/C/man3/telldir.3:69
1722 msgid "The B<telldir>() function is thread-safe."
1726 #: build/C/man3/telldir.3:79
1728 "In glibc up to version 2.1.1, the return type of B<telldir>() was "
1729 "I<off_t>. POSIX.1-2001 specifies I<long>, and this is the type used since "
1733 #. https://lwn.net/Articles/544298/
1735 #: build/C/man3/telldir.3:95
1737 "In early filesystems, the value returned by B<telldir>() was a simple file "
1738 "offset within a directory. Modern filesystems use tree or hash structures, "
1739 "rather than flat tables, to represent directories. On such filesystems, the "
1740 "value returned by B<telldir>() (and used internally by B<readdir>(3)) is a "
1741 "\"cookie\" that is used by the implementation to derive a position within a "
1742 "directory. Application programs should treat this strictly as an opaque "
1743 "value, making I<no> assumptions about its contents."
1747 #: build/C/man3/telldir.3:102
1749 "B<closedir>(3), B<opendir>(3), B<readdir>(3), B<rewinddir>(3), "
1750 "B<scandir>(3), B<seekdir>(3)"