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: 2013-07-15 16:07+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:36 build/C/man3/scandirat.3:25 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:37 build/C/man3/scandirat.3:26 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:39 build/C/man3/scandirat.3:28 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:42 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:65 build/C/man3/scandirat.3:44 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:92 build/C/man3/scandirat.3:78 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:108 build/C/man3/scandirat.3:85 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/scandirat.3:92 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:87 build/C/man2/getdents.2:165 build/C/man3/getdirentries.3:64 build/C/man3/opendir.3:118 build/C/man2/readdir.2:114 build/C/man3/readdir.3:156 build/C/man3/rewinddir.3:53 build/C/man3/scandir.3:121 build/C/man3/scandirat.3:105 build/C/man3/seekdir.3:64 build/C/man3/telldir.3:64
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:99 build/C/man2/getdents.2:282 build/C/man3/getdirentries.3:72 build/C/man3/opendir.3:140 build/C/man2/readdir.2:127 build/C/man3/readdir.3:265 build/C/man3/rewinddir.3:55 build/C/man3/scandir.3:177 build/C/man3/scandirat.3:112 build/C/man3/seekdir.3:78 build/C/man3/telldir.3:90
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:108 build/C/man2/getdents.2:285 build/C/man3/getdirentries.3:75 build/C/man3/opendir.3:149 build/C/man2/readdir.2:130 build/C/man3/readdir.3:277 build/C/man3/rewinddir.3:62 build/C/man3/scandir.3:189 build/C/man3/scandirat.3:116 build/C/man3/seekdir.3:86 build/C/man3/telldir.3:97
148 #: build/C/man3/closedir.3:84 build/C/man3/dirfd.3:115 build/C/man2/getdents.2:292 build/C/man3/getdirentries.3:82 build/C/man3/opendir.3:156 build/C/man2/readdir.2:137 build/C/man3/readdir.3:284 build/C/man3/rewinddir.3:69 build/C/man3/scandir.3:196 build/C/man3/scandirat.3:123 build/C/man3/seekdir.3:93 build/C/man3/telldir.3:104
150 "This page is part of release 3.52 of the Linux I<man-pages> project. A "
151 "description of the project, and information about reporting bugs, can be "
152 "found at \\%http://www.kernel.org/doc/man-pages/."
156 #: build/C/man3/dirfd.3:25
162 #: build/C/man3/dirfd.3:25 build/C/man3/scandir.3:36
168 #: build/C/man3/dirfd.3:25 build/C/man2/getdents.2:30 build/C/man2/readdir.2:30 build/C/man3/scandirat.3:25
174 #: build/C/man3/dirfd.3:28
175 msgid "dirfd - get directory stream file descriptor"
179 #: build/C/man3/dirfd.3:30
180 msgid "B<#include E<lt>sys/types.hE<gt>>"
184 #: build/C/man3/dirfd.3:32 build/C/man3/getdirentries.3:32
185 msgid "B<#include E<lt>dirent.hE<gt>>"
189 #: build/C/man3/dirfd.3:34
190 msgid "B<int dirfd(DIR *>I<dirp>B<);>"
194 #: 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:57 build/C/man3/seekdir.3:45 build/C/man3/telldir.3:43
195 msgid "Feature Test Macro Requirements for glibc (see B<feature_test_macros>(7)):"
199 #: build/C/man3/dirfd.3:41
204 #: build/C/man3/dirfd.3:46
205 msgid "_BSD_SOURCE || _SVID_SOURCE"
209 #: build/C/man3/dirfd.3:48
210 msgid "|| /* Since glibc 2.10: */"
214 #: build/C/man3/dirfd.3:50
215 msgid "(_POSIX_C_SOURCE\\ E<gt>=\\ 200809L || _XOPEN_SOURCE\\ E<gt>=\\ 700)"
219 #: build/C/man3/dirfd.3:59
221 "The function B<dirfd>() returns the file descriptor associated with the "
222 "directory stream I<dirp>."
226 #: build/C/man3/dirfd.3:69
228 "This descriptor is the one used internally by the directory stream. As a "
229 "result, it is useful only for functions which do not depend on or alter the "
230 "file position, such as B<fstat>(2) and B<fchdir>(2). It will be "
231 "automatically closed when B<closedir>(3) is called."
235 #: build/C/man3/dirfd.3:74
237 "On success, a nonnegative file descriptor is returned. On error, -1 is "
238 "returned, and I<errno> is set to indicate the cause of the error."
243 #: build/C/man3/dirfd.3:79
245 "POSIX.1-2008 specifies two errors, neither of which is returned by the "
246 "current implementation."
250 #: build/C/man3/dirfd.3:79 build/C/man2/getdents.2:156 build/C/man2/readdir.2:105
256 #: build/C/man3/dirfd.3:83
257 msgid "I<dirp> does not refer to a valid directory stream."
261 #: build/C/man3/dirfd.3:83
267 #: build/C/man3/dirfd.3:87
269 "The implementation does not support the association of a file descriptor "
273 #. It is present in libc5 (since 5.1.2) and in glibc2.
275 #: build/C/man3/dirfd.3:91
277 "POSIX.1-2008. This function was a BSD extension, present in 4.3BSD-Reno, "
282 #: build/C/man3/dirfd.3:91 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/scandirat.3:107 build/C/man3/seekdir.3:66 build/C/man3/telldir.3:66
288 #: build/C/man3/dirfd.3:99
290 "The prototype for B<dirfd>() is available only if B<_BSD_SOURCE> or "
291 "B<_SVID_SOURCE> is defined."
295 #: build/C/man3/dirfd.3:108
297 "B<open>(2), B<closedir>(3), B<opendir>(3), B<readdir>(3), B<rewinddir>(3), "
298 "B<scandir>(3), B<seekdir>(3), B<telldir>(3)"
302 #: build/C/man2/getdents.2:30
308 #: build/C/man2/getdents.2:30
314 #: build/C/man2/getdents.2:33
315 msgid "getdents - get directory entries"
319 #: build/C/man2/getdents.2:37
322 "B<int getdents(unsigned int >I<fd>B<, struct linux_dirent *>I<dirp>B<,>\n"
323 "B< unsigned int >I<count>B<);>\n"
327 #: build/C/man2/getdents.2:41 build/C/man2/readdir.2:42
328 msgid "I<Note>: There is no glibc wrapper for this system call; see NOTES."
332 #: build/C/man2/getdents.2:47
334 "This is not the function you are interested in. Look at B<readdir>(3) for "
335 "the POSIX conforming C library interface. This page documents the bare "
336 "kernel system call interface."
340 #: build/C/man2/getdents.2:60
342 "The system call B<getdents>() reads several I<linux_dirent> structures from "
343 "the directory referred to by the open file descriptor I<fd> into the buffer "
344 "pointed to by I<dirp>. The argument I<count> specifies the size of that "
349 #: build/C/man2/getdents.2:64
350 msgid "The I<linux_dirent> structure is declared as follows:"
354 #: build/C/man2/getdents.2:79
357 "struct linux_dirent {\n"
358 " unsigned long d_ino; /* Inode number */\n"
359 " unsigned long d_off; /* Offset to next I<linux_dirent> */\n"
360 " unsigned short d_reclen; /* Length of this I<linux_dirent> */\n"
361 " char d_name[]; /* Filename (null-terminated) */\n"
362 " /* length is actually (d_reclen - 2 -\n"
363 " offsetof(struct linux_dirent, d_name)) */\n"
365 " char pad; // Zero padding byte\n"
366 " char d_type; // File type (only since Linux\n"
367 " // 2.6.4); offset is (d_reclen - 1)\n"
372 #: build/C/man2/getdents.2:81
378 #: build/C/man2/getdents.2:94
380 "I<d_ino> is an inode number. I<d_off> is the distance from the start of the "
381 "directory to the start of the next I<linux_dirent>. I<d_reclen> is the size "
382 "of this entire I<linux_dirent>. I<d_name> is a null-terminated filename."
386 #: build/C/man2/getdents.2:99
388 "I<d_type> is a byte at the end of the structure that indicates the file "
389 "type. It contains one of the following values (defined in "
390 "I<E<lt>dirent.hE<gt>>):"
394 #: build/C/man2/getdents.2:99 build/C/man3/readdir.3:200
400 #: build/C/man2/getdents.2:102 build/C/man3/readdir.3:203
401 msgid "This is a block device."
405 #: build/C/man2/getdents.2:102 build/C/man3/readdir.3:203
411 #: build/C/man2/getdents.2:105 build/C/man3/readdir.3:206
412 msgid "This is a character device."
416 #: build/C/man2/getdents.2:105 build/C/man3/readdir.3:206
422 #: build/C/man2/getdents.2:108 build/C/man3/readdir.3:209
423 msgid "This is a directory."
427 #: build/C/man2/getdents.2:108 build/C/man3/readdir.3:209
433 #: build/C/man2/getdents.2:111 build/C/man3/readdir.3:212
434 msgid "This is a named pipe (FIFO)."
438 #: build/C/man2/getdents.2:111 build/C/man3/readdir.3:212
444 #: build/C/man2/getdents.2:114 build/C/man3/readdir.3:215
445 msgid "This is a symbolic link."
449 #: build/C/man2/getdents.2:114 build/C/man3/readdir.3:215
455 #: build/C/man2/getdents.2:117 build/C/man3/readdir.3:218
456 msgid "This is a regular file."
460 #: build/C/man2/getdents.2:117 build/C/man3/readdir.3:218
466 #: build/C/man2/getdents.2:120 build/C/man3/readdir.3:221
467 msgid "This is a UNIX domain socket."
471 #: build/C/man2/getdents.2:120 build/C/man3/readdir.3:221
473 msgid "B<DT_UNKNOWN>"
476 #. The glibc manual says that on some systems this is the only
479 #: build/C/man2/getdents.2:123 build/C/man3/readdir.3:226
480 msgid "The file type is unknown."
484 #: build/C/man2/getdents.2:133
486 "The I<d_type> field is implemented since Linux 2.6.4. It occupies a space "
487 "that was previously a zero-filled padding byte in the I<linux_dirent> "
488 "structure. Thus, on kernels before 2.6.3, attempting to access this field "
489 "always provides the value 0 (B<DT_UNKNOWN>)."
493 #. The same sentence is in getdents.2
495 #: build/C/man2/getdents.2:142 build/C/man3/readdir.3:240
497 "Currently, only some file systems (among them: Btrfs, ext2, ext3, and ext4) "
498 "have full support for returning the file type in I<d_type>. All "
499 "applications must properly handle a return of B<DT_UNKNOWN>."
503 #: build/C/man2/getdents.2:148
505 "On success, the number of bytes read is returned. On end of directory, 0 is "
506 "returned. On error, -1 is returned, and I<errno> is set appropriately."
510 #: build/C/man2/getdents.2:153 build/C/man2/readdir.2:102
511 msgid "Invalid file descriptor I<fd>."
515 #: build/C/man2/getdents.2:153 build/C/man2/readdir.2:102
521 #: build/C/man2/getdents.2:156 build/C/man2/readdir.2:105
522 msgid "Argument points outside the calling process's address space."
526 #: build/C/man2/getdents.2:159 build/C/man2/readdir.2:108
527 msgid "Result buffer is too small."
531 #: build/C/man2/getdents.2:159 build/C/man3/opendir.3:106 build/C/man2/readdir.2:108 build/C/man3/scandir.3:109
537 #: build/C/man2/getdents.2:162 build/C/man2/readdir.2:111
538 msgid "No such directory."
542 #: build/C/man2/getdents.2:162 build/C/man3/opendir.3:112 build/C/man2/readdir.2:111 build/C/man3/scandir.3:115 build/C/man3/scandirat.3:96
548 #: build/C/man2/getdents.2:165 build/C/man2/readdir.2:114
549 msgid "File descriptor does not refer to a directory."
552 #. SVr4 documents additional ENOLINK, EIO error conditions.
554 #: build/C/man2/getdents.2:168
559 #: build/C/man2/getdents.2:177
561 "Glibc does not provide a wrapper for this system call; call it using "
562 "B<syscall>(2). You will need to define the I<linux_dirent> structure "
563 "yourself. However, you probably want to use B<readdir>(3) instead."
567 #: build/C/man2/getdents.2:180
568 msgid "This call supersedes B<readdir>(2)."
572 #: build/C/man2/getdents.2:193
574 "The original Linux B<getdents>() system call did not handle large file "
575 "systems and large file offsets. Consequently, Linux 2.4 added "
576 "B<getdents64>(), with wider types for the I<d_ino> and I<d_off> fields "
577 "employed in the I<linux_dirent> structure."
581 #: build/C/man2/getdents.2:193 build/C/man3/scandir.3:153
586 #. FIXME: This program uses the older getdents() system call
587 #. and the structure with smaller field widths.
589 #: build/C/man2/getdents.2:200
591 "The program below demonstrates the use of B<getdents>(). The following "
592 "output shows an example of what we see when running this program on an ext2 "
597 #: build/C/man2/getdents.2:213
600 "$B< ./a.out /testfs/>\n"
601 "--------------- nread=120 ---------------\n"
602 "i-node# file type d_reclen d_off d_name\n"
603 " 2 directory 16 12 .\n"
604 " 2 directory 16 24 ..\n"
605 " 11 directory 24 44 lost+found\n"
606 " 12 regular 16 56 a\n"
607 " 228929 directory 16 68 sub\n"
608 " 16353 directory 16 80 sub2\n"
609 " 130817 directory 16 4096 sub3\n"
613 #: build/C/man2/getdents.2:215
615 msgid "Program source"
619 #: build/C/man2/getdents.2:226
622 "#define _GNU_SOURCE\n"
623 "#include E<lt>dirent.hE<gt> /* Defines DT_* constants */\n"
624 "#include E<lt>fcntl.hE<gt>\n"
625 "#include E<lt>stdio.hE<gt>\n"
626 "#include E<lt>unistd.hE<gt>\n"
627 "#include E<lt>stdlib.hE<gt>\n"
628 "#include E<lt>sys/stat.hE<gt>\n"
629 "#include E<lt>sys/syscall.hE<gt>\n"
633 #: build/C/man2/getdents.2:229
636 "#define handle_error(msg) \\e\n"
637 " do { perror(msg); exit(EXIT_FAILURE); } while (0)\n"
641 #: build/C/man2/getdents.2:236
644 "struct linux_dirent {\n"
647 " unsigned short d_reclen;\n"
653 #: build/C/man2/getdents.2:238
655 msgid "#define BUF_SIZE 1024\n"
659 #: build/C/man2/getdents.2:247
663 "main(int argc, char *argv[])\n"
666 " char buf[BUF_SIZE];\n"
667 " struct linux_dirent *d;\n"
673 #: build/C/man2/getdents.2:251
676 " fd = open(argc E<gt> 1 ? argv[1] : \".\", O_RDONLY | O_DIRECTORY);\n"
678 " handle_error(\"open\");\n"
682 #: build/C/man2/getdents.2:256
686 " nread = syscall(SYS_getdents, fd, buf, BUF_SIZE);\n"
687 " if (nread == -1)\n"
688 " handle_error(\"getdents\");\n"
692 #: build/C/man2/getdents.2:259
700 #: build/C/man2/getdents.2:278
703 " printf(\"--------------- nread=%d ---------------\\en\", nread);\n"
704 " printf(\"i-node# file type d_reclen d_off d_name\\en\");\n"
705 " for (bpos = 0; bpos E<lt> nread;) {\n"
706 " d = (struct linux_dirent *) (buf + bpos);\n"
707 " printf(\"%8ld \", d-E<gt>d_ino);\n"
708 " d_type = *(buf + bpos + d-E<gt>d_reclen - 1);\n"
709 " printf(\"%-10s \", (d_type == DT_REG) ? \"regular\" :\n"
710 " (d_type == DT_DIR) ? \"directory\" :\n"
711 " (d_type == DT_FIFO) ? \"FIFO\" :\n"
712 " (d_type == DT_SOCK) ? \"socket\" :\n"
713 " (d_type == DT_LNK) ? \"symlink\" :\n"
714 " (d_type == DT_BLK) ? \"block dev\" :\n"
715 " (d_type == DT_CHR) ? \"char dev\" : "
717 " printf(\"%4d %10lld %s\\en\", d-E<gt>d_reclen,\n"
718 " (long long) d-E<gt>d_off, d-E<gt>d_name);\n"
719 " bpos += d-E<gt>d_reclen;\n"
725 #: build/C/man2/getdents.2:281
728 " exit(EXIT_SUCCESS);\n"
733 #: build/C/man2/getdents.2:285
734 msgid "B<readdir>(2), B<readdir>(3)"
738 #: build/C/man3/getdirentries.3:27
740 msgid "GETDIRENTRIES"
744 #: build/C/man3/getdirentries.3:27
750 #: build/C/man3/getdirentries.3:27 build/C/man3/opendir.3:32 build/C/man3/scandir.3:36
756 #: build/C/man3/getdirentries.3:30
757 msgid "getdirentries - get directory entries in a file system-independent format"
761 #: build/C/man3/getdirentries.3:35
763 "B<ssize_t getdirentries(int >I<fd>B<, char *>I<buf>B<, size_t >I<nbytes> B<, "
764 "off_t *>I<basep>B<);>"
768 #: build/C/man3/getdirentries.3:43
769 msgid "B<getdirentries>(): _BSD_SOURCE || _SVID_SOURCE"
773 #: build/C/man3/getdirentries.3:56
775 "Read directory entries from the directory specified by I<fd> into I<buf>. "
776 "At most I<nbytes> are read. Reading starts at offset I<*basep>, and "
777 "I<*basep> is updated with the new position after reading."
781 #: build/C/man3/getdirentries.3:62
783 "B<getdirentries>() returns the number of bytes read or zero when at the end "
784 "of the directory. If an error occurs, -1 is returned, and I<errno> is set "
789 #: build/C/man3/getdirentries.3:64
790 msgid "See the Linux library source code for details."
794 #: build/C/man3/getdirentries.3:72
796 "Not in POSIX.1-2001. Present on the BSDs, and a few other systems. Use "
797 "B<opendir>(3) and B<readdir>(3) instead."
801 #: build/C/man3/getdirentries.3:75
802 msgid "B<lseek>(2), B<open>(2)"
806 #: build/C/man3/opendir.3:32
812 #: build/C/man3/opendir.3:32
818 #: build/C/man3/opendir.3:35
819 msgid "opendir, fdopendir - open a directory"
823 #: build/C/man3/opendir.3:43
826 "B<DIR *opendir(const char *>I<name>B<);>\n"
827 "B<DIR *fdopendir(int >I<fd>B<);>\n"
831 #: build/C/man3/opendir.3:51
832 msgid "B<fdopendir>():"
836 #: build/C/man3/opendir.3:54
838 msgid "Since glibc 2.10:"
842 #: build/C/man3/opendir.3:57
843 msgid "_XOPEN_SOURCE\\ E<gt>=\\ 700 || _POSIX_C_SOURCE\\ E<gt>=\\ 200809L"
847 #: build/C/man3/opendir.3:57
849 msgid "Before glibc 2.10:"
853 #: build/C/man3/opendir.3:60
858 #: build/C/man3/opendir.3:69
860 "The B<opendir>() function opens a directory stream corresponding to the "
861 "directory I<name>, and returns a pointer to the directory stream. The "
862 "stream is positioned at the first entry in the directory."
866 #: build/C/man3/opendir.3:83
868 "The B<fdopendir>() function is like B<opendir>(), but returns a directory "
869 "stream for the directory referred to by the open file descriptor I<fd>. "
870 "After a successful call to B<fdopendir>(), I<fd> is used internally by the "
871 "implementation, and should not otherwise be used by the application."
875 #: build/C/man3/opendir.3:92
877 "The B<opendir>() and B<fdopendir>() functions return a pointer to the "
878 "directory stream. On error, NULL is returned, and I<errno> is set "
883 #: build/C/man3/opendir.3:93
889 #: build/C/man3/opendir.3:96
890 msgid "Permission denied."
894 #: build/C/man3/opendir.3:100
895 msgid "I<fd> is not a valid file descriptor opened for reading."
899 #: build/C/man3/opendir.3:100
905 #: build/C/man3/opendir.3:103
906 msgid "Too many file descriptors in use by process."
910 #: build/C/man3/opendir.3:103
916 #: build/C/man3/opendir.3:106
917 msgid "Too many files are currently open in the system."
921 #: build/C/man3/opendir.3:109
922 msgid "Directory does not exist, or I<name> is an empty string."
926 #: build/C/man3/opendir.3:109 build/C/man3/scandir.3:112
932 #: build/C/man3/opendir.3:112 build/C/man3/scandir.3:115
933 msgid "Insufficient memory to complete the operation."
937 #: build/C/man3/opendir.3:115
938 msgid "I<name> is not a directory."
942 #: build/C/man3/opendir.3:115 build/C/man3/scandir.3:118 build/C/man3/scandirat.3:102
948 #: build/C/man3/opendir.3:118
949 msgid "B<fdopendir>() is available in glibc since version 2.4."
953 #: build/C/man3/opendir.3:123
955 "B<opendir>() is present on SVr4, 4.3BSD, and specified in POSIX.1-2001. "
956 "B<fdopendir>() is specified in POSIX.1-2008."
960 #: build/C/man3/opendir.3:126
962 "The underlying file descriptor of the directory stream can be obtained using "
967 #: build/C/man3/opendir.3:140
969 "The B<opendir>() function sets the close-on-exec flag for the file "
970 "descriptor underlying the I<DIR *>. The B<fdopendir>() function leaves the "
971 "setting of the close-on-exec flag unchanged for the file descriptor, I<fd>. "
972 "POSIX.1-200x leaves it unspecified whether a successful call to "
973 "B<fdopendir>() will set the close-on-exec flag for the file descriptor, "
978 #: build/C/man3/opendir.3:149
980 "B<open>(2), B<closedir>(3), B<dirfd>(3), B<readdir>(3), B<rewinddir>(3), "
981 "B<scandir>(3), B<seekdir>(3), B<telldir>(3)"
985 #: build/C/man2/readdir.2:30 build/C/man3/readdir.3:36
991 #: build/C/man2/readdir.2:30 build/C/man3/readdir.3:36
997 #: build/C/man2/readdir.2:33
998 msgid "readdir - read directory entry"
1002 #: build/C/man2/readdir.2:38
1005 "B<int readdir(unsigned int >I<fd>B<, struct old_linux_dirent *>I<dirp>B<,>\n"
1006 "B< unsigned int >I<count>B<);>\n"
1010 #: build/C/man2/readdir.2:50
1012 "This is not the function you are interested in. Look at B<readdir>(3) for "
1013 "the POSIX conforming C library interface. This page documents the bare "
1014 "kernel system call interface, which is superseded by B<getdents>(2)."
1018 #: build/C/man2/readdir.2:64
1020 "B<readdir>() reads one I<old_linux_dirent> structure from the directory "
1021 "referred to by the file descriptor I<fd> into the buffer pointed to by "
1022 "I<dirp>. The argument I<count> is ignored; at most one I<old_linux_dirent> "
1023 "structure is read."
1027 #: build/C/man2/readdir.2:68
1028 msgid "The I<old_linux_dirent> structure is declared as follows:"
1032 #: build/C/man2/readdir.2:77
1035 "struct old_linux_dirent {\n"
1036 " long d_ino; /* inode number */\n"
1037 " off_t d_off; /* offset to this I<old_linux_dirent> */\n"
1038 " unsigned short d_reclen; /* length of this I<d_name> */\n"
1039 " char d_name[NAME_MAX+1]; /* filename (null-terminated) */\n"
1044 #: build/C/man2/readdir.2:91
1046 "I<d_ino> is an inode number. I<d_off> is the distance from the start of the "
1047 "directory to this I<old_linux_dirent>. I<d_reclen> is the size of "
1048 "I<d_name>, not counting the terminating null byte (\\(aq\\e0\\(aq). "
1049 "I<d_name> is a null-terminated filename."
1053 #: build/C/man2/readdir.2:97
1055 "On success, 1 is returned. On end of directory, 0 is returned. On error, "
1056 "-1 is returned, and I<errno> is set appropriately."
1060 #: build/C/man2/readdir.2:116
1061 msgid "This system call is Linux-specific."
1065 #: build/C/man2/readdir.2:125
1067 "Glibc does not provide a wrapper for this system call; call it using "
1068 "B<syscall>(2). You will need to define the I<old_linux_dirent> structure "
1069 "yourself. However, probably you should use B<readdir>(3) instead."
1073 #: build/C/man2/readdir.2:127
1074 msgid "This system call does not exist on x86-64."
1078 #: build/C/man2/readdir.2:130
1079 msgid "B<getdents>(2), B<readdir>(3)"
1083 #: build/C/man3/readdir.3:39
1084 msgid "readdir, readdir_r - read a directory"
1088 #: build/C/man3/readdir.3:44
1090 msgid "B<struct dirent *readdir(DIR *>I<dirp>B<);>\n"
1094 #: build/C/man3/readdir.3:47
1097 "B<int readdir_r(DIR *>I<dirp>B<, struct dirent *>I<entry>B<, struct dirent "
1098 "**>I<result>B<);>\n"
1102 #: build/C/man3/readdir.3:56
1103 msgid "B<readdir_r>():"
1107 #: build/C/man3/readdir.3:59
1109 "_POSIX_C_SOURCE\\ E<gt>=\\ 1 || _XOPEN_SOURCE || _BSD_SOURCE || _SVID_SOURCE "
1114 #: build/C/man3/readdir.3:69
1116 "The B<readdir>() function returns a pointer to a I<dirent> structure "
1117 "representing the next directory entry in the directory stream pointed to by "
1118 "I<dirp>. It returns NULL on reaching the end of the directory stream or if "
1119 "an error occurred."
1123 #: build/C/man3/readdir.3:73
1124 msgid "On Linux, the I<dirent> structure is defined as follows:"
1128 #: build/C/man3/readdir.3:84
1132 " ino_t d_ino; /* inode number */\n"
1133 " off_t d_off; /* not an offset; see NOTES */\n"
1134 " unsigned short d_reclen; /* length of this record */\n"
1135 " unsigned char d_type; /* type of file; not supported\n"
1136 " by all file system types */\n"
1137 " char d_name[256]; /* filename */\n"
1142 #: build/C/man3/readdir.3:98
1144 "The only fields in the I<dirent> structure that are mandated by POSIX.1 are: "
1145 "I<d_name>[], of unspecified size, with at most B<NAME_MAX> characters "
1146 "preceding the terminating null byte (\\(aq\\e0\\(aq); and (as an XSI "
1147 "extension) I<d_ino>. The other fields are unstandardized, and not present "
1148 "on all systems; see NOTES below for some further details."
1152 #: build/C/man3/readdir.3:104
1154 "The data returned by B<readdir>() may be overwritten by subsequent calls to "
1155 "B<readdir>() for the same directory stream."
1159 #: build/C/man3/readdir.3:119
1161 "The B<readdir_r>() function is a reentrant version of B<readdir>(). It "
1162 "reads the next directory entry from the directory stream I<dirp>, and "
1163 "returns it in the caller-allocated buffer pointed to by I<entry>. (See "
1164 "NOTES for information on allocating this buffer.) A pointer to the returned "
1165 "item is placed in I<*result>; if the end of the directory stream was "
1166 "encountered, then NULL is instead returned in I<*result>."
1170 #: build/C/man3/readdir.3:134
1172 "On success, B<readdir>() returns a pointer to a I<dirent> structure. (This "
1173 "structure may be statically allocated; do not attempt to B<free>(3) it.) "
1174 "If the end of the directory stream is reached, NULL is returned and I<errno> "
1175 "is not changed. If an error occurs, NULL is returned and I<errno> is set "
1180 #: build/C/man3/readdir.3:143
1182 "The B<readdir_r>() function returns 0 on success. On error, it returns a "
1183 "positive error number (listed under ERRORS). If the end of the directory "
1184 "stream is reached, B<readdir_r>() returns 0, and returns NULL in "
1189 #: build/C/man3/readdir.3:147
1195 #: build/C/man3/readdir.3:148
1197 msgid "Multithreading (see pthreads(7))"
1201 #: build/C/man3/readdir.3:152
1202 msgid "The B<readdir>() function is not thread-safe."
1206 #: build/C/man3/readdir.3:156
1207 msgid "The B<readdir_r>() function is thread-safe."
1211 #: build/C/man3/readdir.3:158 build/C/man3/rewinddir.3:55
1212 msgid "SVr4, 4.3BSD, POSIX.1-2001."
1216 #: build/C/man3/readdir.3:174
1218 "Only the fields I<d_name> and I<d_ino> are specified in POSIX.1-2001. The "
1219 "remaining fields are available on many, but not all systems. Under glibc, "
1220 "programs can check for the availability of the fields not defined in POSIX.1 "
1221 "by testing whether the macros B<_DIRENT_HAVE_D_NAMLEN>, "
1222 "B<_DIRENT_HAVE_D_RECLEN>, B<_DIRENT_HAVE_D_OFF>, or B<_DIRENT_HAVE_D_TYPE> "
1226 #. https://lwn.net/Articles/544298/
1228 #: build/C/man3/readdir.3:187
1230 "The value returned in I<d_off> is the same as would be returned by calling "
1231 "B<telldir>(3) at the current position in the directory stream. Be aware "
1232 "that despite its type and name, the I<d_off> field is seldom any kind of "
1233 "directory offset on modern file systems. Applications should treat this "
1234 "field as an opaque value, making no assumptions about its contents; see also "
1239 #: build/C/man3/readdir.3:200
1241 "Other than Linux, the I<d_type> field is available mainly only on BSD "
1242 "systems. This field makes it possible to avoid the expense of calling "
1243 "B<lstat>(2) if further actions depend on the type of the file. If the "
1244 "B<_BSD_SOURCE> feature test macro is defined, then glibc defines the "
1245 "following macro constants for the value returned in I<d_type>:"
1249 #: build/C/man3/readdir.3:231
1251 "If the file type could not be determined, the value B<DT_UNKNOWN> is "
1252 "returned in I<d_type>."
1256 #: build/C/man3/readdir.3:250
1258 "Since POSIX.1 does not specify the size of the I<d_name> field, and other "
1259 "nonstandard fields may precede that field within the I<dirent> structure, "
1260 "portable applications that use B<readdir_r>() should allocate the buffer "
1261 "whose address is passed in I<entry> as follows:"
1265 #: build/C/man3/readdir.3:258
1268 "name_max = pathconf(dirpath, _PC_NAME_MAX);\n"
1269 "if (name_max == -1) /* Limit not defined, or error */\n"
1270 " name_max = 255; /* Take a guess */\n"
1271 "len = offsetof(struct dirent, d_name) + name_max + 1;\n"
1272 "entryp = malloc(len);\n"
1276 #: build/C/man3/readdir.3:265
1277 msgid "(POSIX.1 requires that I<d_name> is the last field in a I<struct dirent>.)"
1281 #: build/C/man3/readdir.3:277
1283 "B<getdents>(2), B<read>(2), B<closedir>(3), B<dirfd>(3), B<ftw>(3), "
1284 "B<offsetof>(3), B<opendir>(3), B<rewinddir>(3), B<scandir>(3), "
1285 "B<seekdir>(3), B<telldir>(3)"
1289 #: build/C/man3/rewinddir.3:31
1295 #: build/C/man3/rewinddir.3:31
1301 #: build/C/man3/rewinddir.3:34
1302 msgid "rewinddir - reset directory stream"
1306 #: build/C/man3/rewinddir.3:41
1308 msgid "B<void rewinddir(DIR *>I<dirp>B<);>\n"
1312 #: build/C/man3/rewinddir.3:49
1314 "The B<rewinddir>() function resets the position of the directory stream "
1315 "I<dirp> to the beginning of the directory."
1319 #: build/C/man3/rewinddir.3:53
1320 msgid "The B<rewinddir>() function returns no value."
1324 #: build/C/man3/rewinddir.3:62
1326 "B<closedir>(3), B<opendir>(3), B<readdir>(3), B<scandir>(3), B<seekdir>(3), "
1331 #: build/C/man3/scandir.3:36
1337 #: build/C/man3/scandir.3:39
1338 msgid "scandir, alphasort, versionsort - scan a directory for matching entries"
1342 #: build/C/man3/scandir.3:44
1344 msgid "B<int scandir(const char *>I<dirp>B<, struct dirent ***>I<namelist>B<,>\n"
1348 #: build/C/man3/scandir.3:47 build/C/man3/scandirat.3:42
1351 "B<int (*>I<filter>B<)(const struct dirent *),>\n"
1352 "B<int (*>I<compar>B<)(const struct dirent **, const struct dirent **));>\n"
1356 #: build/C/man3/scandir.3:50
1358 msgid "B<int alphasort(const void *>I<a>B<, const void *>I<b>B<);>\n"
1362 #: build/C/man3/scandir.3:52
1364 msgid "B<int versionsort(const void *>I<a>B<, const void *>I<b>B<);>\n"
1368 #: build/C/man3/scandir.3:62
1369 msgid "B<scandir>(), B<alphasort>(): _BSD_SOURCE || _SVID_SOURCE"
1373 #: build/C/man3/scandir.3:65
1374 msgid "B<versionsort>(): _GNU_SOURCE"
1378 #: build/C/man3/scandir.3:80
1380 "The B<scandir>() function scans the directory I<dirp>, calling I<filter>() "
1381 "on each directory entry. Entries for which I<filter>() returns nonzero are "
1382 "stored in strings allocated via B<malloc>(3), sorted using B<qsort>(3) with "
1383 "the comparison function I<compar>(), and collected in array I<namelist> "
1384 "which is allocated via B<malloc>(3). If I<filter> is NULL, all entries are "
1389 #: build/C/man3/scandir.3:92
1391 "The B<alphasort>() and B<versionsort>() functions can be used as the "
1392 "comparison function I<compar>(). The former sorts directory entries using "
1393 "B<strcoll>(3), the latter using B<strverscmp>(3) on the strings "
1394 "I<(*a)-E<gt>d_name> and I<(*b)-E<gt>d_name>."
1398 #: build/C/man3/scandir.3:100
1400 "The B<scandir>() function returns the number of directory entries "
1401 "selected. On error, -1 is returned, with I<errno> set to indicate the cause "
1406 #: build/C/man3/scandir.3:108
1408 "The B<alphasort>() and B<versionsort>() functions return an integer less "
1409 "than, equal to, or greater than zero if the first argument is considered to "
1410 "be respectively less than, equal to, or greater than the second."
1414 #: build/C/man3/scandir.3:112
1415 msgid "The path in I<dirp> does not exist."
1419 #: build/C/man3/scandir.3:118
1420 msgid "The path in I<dirp> is not a directory."
1424 #: build/C/man3/scandir.3:121
1425 msgid "B<versionsort>() was added to glibc in version 2.1."
1429 #: build/C/man3/scandir.3:128
1431 "B<alphasort>() and B<scandir>() are specified in POSIX.1-2008, and are "
1432 "widely available. B<versionsort>() is a GNU extension."
1436 #: build/C/man3/scandir.3:135
1438 "The functions B<scandir>() and B<alphasort>() are from 4.3BSD, and have "
1439 "been available under Linux since libc4. Libc4 and libc5 use the more "
1444 #: build/C/man3/scandir.3:139
1447 " int alphasort(const struct dirent ** a,\n"
1448 " const struct dirent **b);\n"
1452 #: build/C/man3/scandir.3:142
1453 msgid "but glibc 2.0 returns to the imprecise BSD prototype."
1457 #: build/C/man3/scandir.3:146
1459 "The function B<versionsort>() is a GNU extension, available since glibc "
1464 #: build/C/man3/scandir.3:153
1466 "Since glibc 2.1, B<alphasort>() calls B<strcoll>(3); earlier it used "
1471 #: build/C/man3/scandir.3:158
1474 "#define _SVID_SOURCE\n"
1475 "/* print files in current directory in reverse order */\n"
1476 "#include E<lt>dirent.hE<gt>\n"
1480 #: build/C/man3/scandir.3:164
1486 " struct dirent **namelist;\n"
1491 #: build/C/man3/scandir.3:176
1494 " n = scandir(\".\", &namelist, NULL, alphasort);\n"
1496 " perror(\"scandir\");\n"
1499 " printf(\"%s\\en\", namelist[n]-E<gt>d_name);\n"
1500 " free(namelist[n]);\n"
1502 " free(namelist);\n"
1508 #: build/C/man3/scandir.3:189
1510 "B<closedir>(3), B<fnmatch>(3), B<opendir>(3), B<readdir>(3), "
1511 "B<rewinddir>(3), B<scandirat>(3), B<seekdir>(3), B<strcmp>(3), "
1512 "B<strcoll>(3), B<strverscmp>(3), B<telldir>(3)"
1516 #: build/C/man3/scandirat.3:25
1522 #: build/C/man3/scandirat.3:25
1528 #: build/C/man3/scandirat.3:28
1529 msgid "scandirat - scan a directory relative to a directory file descriptor"
1533 #: build/C/man3/scandirat.3:31
1535 msgid "B<#define _GNU_SOURCE> /* See feature_test_macros(7) */\n"
1539 #: build/C/man3/scandirat.3:34
1542 "B<#include E<lt>fcntl.hE<gt>> /* Definition of AT_* constants */\n"
1543 "B<#include E<lt>dirent.hE<gt>>\n"
1547 #: build/C/man3/scandirat.3:38
1549 "B<int scandirat(int >I<dirfd>B<, const char *>I<dirp>B<,> B<struct dirent "
1550 "***>I<namelist>B<,>"
1554 #: build/C/man3/scandirat.3:50
1556 "The B<scandirat>() system call operates in exactly the same way as "
1557 "B<scandir>(3), except for the differences described in this manual page."
1561 #: build/C/man3/scandirat.3:60
1563 "If the pathname given in I<dirp> is relative, then it is interpreted "
1564 "relative to the directory referred to by the file descriptor I<dirfd> "
1565 "(rather than relative to the current working directory of the calling "
1566 "process, as is done by B<scandir>(3) for a relative pathname)."
1570 #: build/C/man3/scandirat.3:72
1572 "If I<dirp> is relative and I<dirfd> is the special value B<AT_FDCWD>, then "
1573 "I<dirp> is interpreted relative to the current working directory of the "
1574 "calling process (like B<scandir>(3))."
1578 #: build/C/man3/scandirat.3:78
1579 msgid "If I<dirp> is absolute, then I<dirfd> is ignored."
1583 #: build/C/man3/scandirat.3:85
1585 "On success, B<scandirat>() returns the number of directory entries "
1586 "selected. On error, -1 is returned and I<errno> is set to indicate the "
1591 #: build/C/man3/scandirat.3:92
1593 "The same errors that occur for B<scandir>(3) can also occur for "
1594 "B<scandirat>(). The following additional errors can occur for "
1599 #: build/C/man3/scandirat.3:96
1600 msgid "I<dirfd> is not a valid file descriptor."
1604 #: build/C/man3/scandirat.3:102
1606 "I<dirp> is a relative path and I<dirfd> is a file descriptor referring to a "
1607 "file other than a directory."
1611 #: build/C/man3/scandirat.3:105
1612 msgid "B<scandirat>() was added to glibc in version 2.15."
1616 #: build/C/man3/scandirat.3:107
1617 msgid "This function is a GNU extension."
1621 #: build/C/man3/scandirat.3:112
1622 msgid "See B<openat>(2) for an explanation of the need for B<scandirat>()."
1626 #: build/C/man3/scandirat.3:116
1627 msgid "B<openat>(2), B<scandir>(3), B<path_resolution>(7)"
1631 #: build/C/man3/seekdir.3:31
1637 #: build/C/man3/seekdir.3:31 build/C/man3/telldir.3:30
1643 #: build/C/man3/seekdir.3:35
1645 "seekdir - set the position of the next readdir() call in the directory "
1650 #: build/C/man3/seekdir.3:40
1652 msgid "B<void seekdir(DIR *>I<dirp>B<, long >I<loc>B<);>\n"
1656 #: build/C/man3/seekdir.3:49
1657 msgid "B<seekdir>(): _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE"
1661 #: build/C/man3/seekdir.3:60
1663 "The B<seekdir>() function sets the location in the directory stream from "
1664 "which the next B<readdir>(2) call will start. The I<loc> argument should "
1665 "be a value returned by a previous call to B<telldir>(3)."
1669 #: build/C/man3/seekdir.3:64
1670 msgid "The B<seekdir>() function returns no value."
1674 #: build/C/man3/seekdir.3:66 build/C/man3/telldir.3:66
1675 msgid "4.3BSD, POSIX.1-2001."
1679 #: build/C/man3/seekdir.3:78
1681 "In glibc up to version 2.1.1, the type of the I<loc> argument was I<off_t>. "
1682 "POSIX.1-2001 specifies I<long>, and this is the type used since glibc "
1683 "2.1.2. See B<telldir>(3) for information on why you should be careful in "
1684 "making any assumptions about the value in this argument."
1688 #: build/C/man3/seekdir.3:86
1690 "B<lseek>(2), B<closedir>(3), B<opendir>(3), B<readdir>(3), B<rewinddir>(3), "
1691 "B<scandir>(3), B<telldir>(3)"
1695 #: build/C/man3/telldir.3:30
1701 #: build/C/man3/telldir.3:33
1702 msgid "telldir - return current location in directory stream"
1706 #: build/C/man3/telldir.3:38
1708 msgid "B<long telldir(DIR *>I<dirp>B<);>\n"
1712 #: build/C/man3/telldir.3:47
1713 msgid "B<telldir>(): _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE"
1717 #: build/C/man3/telldir.3:52
1719 "The B<telldir>() function returns the current location associated with the "
1720 "directory stream I<dirp>."
1724 #: build/C/man3/telldir.3:60
1726 "On success, the B<telldir>() function returns the current location in the "
1727 "directory stream. On error, -1 is returned, and I<errno> is set "
1732 #: build/C/man3/telldir.3:74
1734 "In glibc up to version 2.1.1, the return type of B<telldir>() was "
1735 "I<off_t>. POSIX.1-2001 specifies I<long>, and this is the type used since "
1739 #. https://lwn.net/Articles/544298/
1741 #: build/C/man3/telldir.3:90
1743 "In early file systems, the value returned by B<telldir>() was a simple file "
1744 "offset within a directory. Modern file systems use tree or hash structures, "
1745 "rather than flat tables, to represent directories. On such file systems, "
1746 "the value returned by B<telldir>() (and used internally by B<readdir>(3)) "
1747 "is a \"cookie\" that is used by the implementation to derive a position "
1748 "within a directory. Application programs should treat this strictly as an "
1749 "opaque value, making I<no> assumptions about its contents."
1753 #: build/C/man3/telldir.3:97
1755 "B<closedir>(3), B<opendir>(3), B<readdir>(3), B<rewinddir>(3), "
1756 "B<scandir>(3), B<seekdir>(3)"