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-02-04 23:32+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/man5/filesystems.5:26
26 #: build/C/man5/filesystems.5:26
32 #: build/C/man5/filesystems.5:26 build/C/man3/fts.3:40 build/C/man3/ftw.3:35 build/C/man2/getxattr.2:25 build/C/man3/isfdtype.3:26 build/C/man2/listxattr.2:25 build/C/man2/mount.2:40 build/C/man7/path_resolution.7:25 build/C/man2/removexattr.2:25 build/C/man2/setxattr.2:25 build/C/man2/spu_create.2:25 build/C/man2/spu_run.2:26 build/C/man7/spufs.7:27 build/C/man2/stat.2:40 build/C/man2/statfs.2:28 build/C/man3/statvfs.3:30 build/C/man2/sysfs.2:27 build/C/man2/umount.2:30 build/C/man2/ustat.2:30
38 #: build/C/man5/filesystems.5:26 build/C/man3/fts.3:40 build/C/man3/ftw.3:35 build/C/man3/getfsent.3:27 build/C/man3/getmntent.3:32 build/C/man2/getxattr.2:25 build/C/man3/isfdtype.3:26 build/C/man2/listxattr.2:25 build/C/man2/mount.2:40 build/C/man7/path_resolution.7:25 build/C/man2/removexattr.2:25 build/C/man2/setxattr.2:25 build/C/man2/spu_create.2:25 build/C/man2/spu_run.2:26 build/C/man7/spufs.7:27 build/C/man2/stat.2:40 build/C/man2/statfs.2:28 build/C/man3/statvfs.3:30 build/C/man2/sysfs.2:27 build/C/man2/umount.2:30 build/C/man2/ustat.2:30
40 msgid "Linux Programmer's Manual"
44 #: build/C/man5/filesystems.5:28 build/C/man3/fts.3:41 build/C/man3/ftw.3:36 build/C/man3/getfsent.3:28 build/C/man3/getmntent.3:33 build/C/man2/getxattr.2:26 build/C/man3/isfdtype.3:27 build/C/man2/listxattr.2:26 build/C/man2/mount.2:41 build/C/man7/path_resolution.7:26 build/C/man2/removexattr.2:26 build/C/man2/setxattr.2:26 build/C/man2/spu_create.2:26 build/C/man2/spu_run.2:27 build/C/man7/spufs.7:28 build/C/man2/stat.2:41 build/C/man2/statfs.2:29 build/C/man3/statvfs.3:31 build/C/man2/sysfs.2:28 build/C/man2/umount.2:31 build/C/man2/ustat.2:31
50 #: build/C/man5/filesystems.5:32
52 "filesystems - Linux filesystem types: minix, ext, ext2, ext3, ext4, "
53 "Reiserfs, XFS, JFS, xia, msdos, umsdos, vfat, ntfs, proc, nfs, iso9660, "
54 "hpfs, sysv, smb, ncpfs"
58 #: build/C/man5/filesystems.5:32 build/C/man3/fts.3:61 build/C/man3/ftw.3:55 build/C/man3/getfsent.3:42 build/C/man3/getmntent.3:65 build/C/man2/getxattr.2:42 build/C/man3/isfdtype.3:55 build/C/man2/listxattr.2:41 build/C/man2/mount.2:51 build/C/man7/path_resolution.7:28 build/C/man2/removexattr.2:39 build/C/man2/setxattr.2:42 build/C/man2/spu_create.2:40 build/C/man2/spu_run.2:39 build/C/man7/spufs.7:30 build/C/man2/stat.2:97 build/C/man2/statfs.2:37 build/C/man3/statvfs.3:39 build/C/man2/sysfs.2:36 build/C/man2/umount.2:41 build/C/man2/ustat.2:43
64 #: build/C/man5/filesystems.5:45
66 "When, as is customary, the B<proc> filesystem is mounted on I</proc>, you "
67 "can find in the file I</proc/filesystems> which filesystems your kernel "
68 "currently supports; see B<proc>(5) for more details. If you need a "
69 "currently unsupported filesystem, insert the corresponding module or "
70 "recompile the kernel."
74 #: build/C/man5/filesystems.5:50
75 msgid "In order to use a filesystem, you have to I<mount> it; see B<mount>(8)."
79 #: build/C/man5/filesystems.5:52
80 msgid "Below a short description of a few of the available filesystems."
84 #: build/C/man5/filesystems.5:52
90 #: build/C/man5/filesystems.5:59
92 "is the filesystem used in the Minix operating system, the first to run under "
93 "Linux. It has a number of shortcomings, including a 64MB partition size "
94 "limit, short filenames, and a single timestamp. It remains useful for "
95 "floppies and RAM disks."
99 #: build/C/man5/filesystems.5:59
105 #: build/C/man5/filesystems.5:68
107 "is an elaborate extension of the B<minix> filesystem. It has been "
108 "completely superseded by the second version of the extended filesystem "
109 "(B<ext2>) and has been removed from the kernel (in 2.1.21)."
113 #: build/C/man5/filesystems.5:68
119 #: build/C/man5/filesystems.5:78
121 "is the high performance disk filesystem used by Linux for fixed disks as "
122 "well as removable media. The second extended filesystem was designed as an "
123 "extension of the extended filesystem (B<ext>). B<ext2> offers the best "
124 "performance (in terms of speed and CPU usage) of the filesystems supported "
129 #: build/C/man5/filesystems.5:78
135 #: build/C/man5/filesystems.5:83
137 "is a journaling version of the ext2 filesystem. It is easy to switch back "
138 "and forth between ext2 and ext3."
142 #: build/C/man5/filesystems.5:83
148 #: build/C/man5/filesystems.5:88
150 "is a set of upgrades to ext3 including substantial performance and "
151 "reliability enhancements, plus large increases in volume, file, and "
152 "directory size limits."
156 #: build/C/man5/filesystems.5:88
162 #: build/C/man5/filesystems.5:92
164 "is a journaling filesystem, designed by Hans Reiser, that was integrated "
165 "into Linux in kernel 2.4.1."
169 #: build/C/man5/filesystems.5:92
175 #: build/C/man5/filesystems.5:96
177 "is a journaling filesystem, developed by SGI, that was integrated into Linux "
182 #: build/C/man5/filesystems.5:96
188 #: build/C/man5/filesystems.5:100
190 "is a journaling filesystem, developed by IBM, that was integrated into Linux "
195 #: build/C/man5/filesystems.5:100
201 #: build/C/man5/filesystems.5:110
203 "was designed and implemented to be a stable, safe filesystem by extending "
204 "the Minix filesystem code. It provides the basic most requested features "
205 "without undue complexity. The B<xia> filesystem is no longer actively "
206 "developed or maintained. It was removed from the kernel in 2.1.21."
210 #: build/C/man5/filesystems.5:110
216 #: build/C/man5/filesystems.5:116
218 "is the filesystem used by DOS, Windows, and some OS/2 computers. B<msdos> "
219 "filenames can be no longer than 8 characters, followed by an optional period "
220 "and 3 character extension."
224 #: build/C/man5/filesystems.5:116
230 #: build/C/man5/filesystems.5:123
232 "is an extended DOS filesystem used by Linux. It adds capability for long "
233 "filenames, UID/GID, POSIX permissions, and special files (devices, named "
234 "pipes, etc.) under the DOS filesystem, without sacrificing compatibility "
239 #: build/C/man5/filesystems.5:123
245 #: build/C/man5/filesystems.5:127
247 "is an extended DOS filesystem used by Microsoft Windows95 and Windows NT. "
248 "VFAT adds the capability to use long filenames under the MSDOS filesystem."
252 #: build/C/man5/filesystems.5:127
258 #: build/C/man5/filesystems.5:132
260 "replaces Microsoft Window's FAT filesystems (VFAT, FAT32). It has "
261 "reliability, performance, and space-utilization enhancements plus features "
262 "like ACLs, journaling, encryption, and so on."
266 #: build/C/man5/filesystems.5:132
272 #: build/C/man5/filesystems.5:140
274 "is a pseudo filesystem which is used as an interface to kernel data "
275 "structures rather than reading and interpreting I</dev/kmem>. In "
276 "particular, its files do not take disk space. See B<proc>(5)."
280 #: build/C/man5/filesystems.5:140
286 #: build/C/man5/filesystems.5:143
287 msgid "is a CD-ROM filesystem type conforming to the ISO 9660 standard."
291 #: build/C/man5/filesystems.5:144
293 msgid "B<High Sierra>"
297 #: build/C/man5/filesystems.5:151
299 "Linux supports High Sierra, the precursor to the ISO 9660 standard for "
300 "CD-ROM filesystems. It is automatically recognized within the B<iso9660> "
301 "filesystem support under Linux."
305 #: build/C/man5/filesystems.5:151
307 msgid "B<Rock Ridge>"
311 #: build/C/man5/filesystems.5:162
313 "Linux also supports the System Use Sharing Protocol records specified by the "
314 "Rock Ridge Interchange Protocol. They are used to further describe the "
315 "files in the B<iso9660> filesystem to a UNIX host, and provide information "
316 "such as long filenames, UID/GID, POSIX permissions, and devices. It is "
317 "automatically recognized within the B<iso9660> filesystem support under "
322 #: build/C/man5/filesystems.5:163
328 #: build/C/man5/filesystems.5:168
330 "is the High Performance Filesystem, used in OS/2. This filesystem is "
331 "read-only under Linux due to the lack of available documentation."
335 #: build/C/man5/filesystems.5:168
341 #: build/C/man5/filesystems.5:172
343 "is an implementation of the SystemV/Coherent filesystem for Linux. It "
344 "implements all of Xenix FS, SystemV/386 FS, and Coherent FS."
348 #: build/C/man5/filesystems.5:172
354 #: build/C/man5/filesystems.5:175
355 msgid "is the network filesystem used to access disks located on remote computers."
359 #: build/C/man5/filesystems.5:175
365 #: build/C/man5/filesystems.5:179
367 "is a network filesystem that supports the SMB protocol, used by Windows for "
368 "Workgroups, Windows NT, and Lan Manager."
372 #: build/C/man5/filesystems.5:186
374 "To use B<smb> fs, you need a special mount program, which can be found in "
375 "the ksmbfs package, found at E<.UR "
376 "ftp://sunsite.unc.edu\\:/pub\\:/Linux\\:/system\\:/Filesystems\\:/smbfs> "
381 #: build/C/man5/filesystems.5:186
387 #: build/C/man5/filesystems.5:190
389 "is a network filesystem that supports the NCP protocol, used by Novell "
394 #: build/C/man5/filesystems.5:196
396 "To use B<ncpfs>, you need special programs, which can be found at E<.UR "
397 "ftp://linux01.gwdg.de\\:/pub\\:/ncpfs> E<.UE .>"
401 #: build/C/man5/filesystems.5:196 build/C/man3/fts.3:790 build/C/man3/ftw.3:422 build/C/man3/getfsent.3:139 build/C/man3/getmntent.3:220 build/C/man2/getxattr.2:141 build/C/man3/isfdtype.3:102 build/C/man2/listxattr.2:153 build/C/man2/mount.2:488 build/C/man7/path_resolution.7:237 build/C/man2/removexattr.2:110 build/C/man2/setxattr.2:152 build/C/man2/spu_create.2:270 build/C/man2/spu_run.2:264 build/C/man7/spufs.7:766 build/C/man2/stat.2:920 build/C/man2/statfs.2:314 build/C/man3/statvfs.3:188 build/C/man2/umount.2:176 build/C/man2/ustat.2:118
407 #: build/C/man5/filesystems.5:201
408 msgid "B<proc>(5), B<fsck>(8), B<mkfs>(8), B<mount>(8)"
412 #: build/C/man5/filesystems.5:201 build/C/man3/fts.3:796 build/C/man3/ftw.3:426 build/C/man3/getfsent.3:142 build/C/man3/getmntent.3:224 build/C/man2/getxattr.2:151 build/C/man3/isfdtype.3:104 build/C/man2/listxattr.2:163 build/C/man2/mount.2:495 build/C/man7/path_resolution.7:242 build/C/man2/removexattr.2:120 build/C/man2/setxattr.2:162 build/C/man2/spu_create.2:275 build/C/man2/spu_run.2:269 build/C/man7/spufs.7:773 build/C/man2/stat.2:930 build/C/man2/statfs.2:318 build/C/man3/statvfs.3:190 build/C/man2/sysfs.2:104 build/C/man2/umount.2:181 build/C/man2/ustat.2:121
418 #: build/C/man5/filesystems.5:209 build/C/man3/fts.3:804 build/C/man3/ftw.3:434 build/C/man3/getfsent.3:150 build/C/man3/getmntent.3:232 build/C/man2/getxattr.2:159 build/C/man3/isfdtype.3:112 build/C/man2/listxattr.2:171 build/C/man2/mount.2:503 build/C/man7/path_resolution.7:250 build/C/man2/removexattr.2:128 build/C/man2/setxattr.2:170 build/C/man2/spu_create.2:283 build/C/man2/spu_run.2:277 build/C/man7/spufs.7:781 build/C/man2/stat.2:938 build/C/man2/statfs.2:326 build/C/man3/statvfs.3:198 build/C/man2/sysfs.2:112 build/C/man2/umount.2:189 build/C/man2/ustat.2:129
420 "This page is part of release 3.79 of the Linux I<man-pages> project. A "
421 "description of the project, information about reporting bugs, and the latest "
422 "version of this page, can be found at "
423 "\\%http://www.kernel.org/doc/man-pages/."
427 #: build/C/man3/fts.3:40
433 #: build/C/man3/fts.3:40
439 #: build/C/man3/fts.3:44
441 "fts, fts_open, fts_read, fts_children, fts_set, fts_close - traverse a file "
446 #: build/C/man3/fts.3:44 build/C/man3/ftw.3:38 build/C/man3/getfsent.3:30 build/C/man3/getmntent.3:36 build/C/man2/getxattr.2:28 build/C/man3/isfdtype.3:29 build/C/man2/listxattr.2:28 build/C/man2/mount.2:43 build/C/man2/removexattr.2:28 build/C/man2/setxattr.2:28 build/C/man2/spu_create.2:28 build/C/man2/spu_run.2:29 build/C/man2/stat.2:43 build/C/man2/statfs.2:31 build/C/man3/statvfs.3:33 build/C/man2/sysfs.2:30 build/C/man2/umount.2:33 build/C/man2/ustat.2:33
452 #: build/C/man3/fts.3:49
455 "B<#include E<lt>sys/types.hE<gt>>\n"
456 "B<#include E<lt>sys/stat.hE<gt>>\n"
457 "B<#include E<lt>fts.hE<gt>>\n"
461 #: build/C/man3/fts.3:52
464 "B<FTS *fts_open(char * const *>I<path_argv>B<, int >I<options>B<, >\n"
465 "B< int (*>I<compar>B<)(const FTSENT **, const FTSENT **));>\n"
469 #: build/C/man3/fts.3:54
471 msgid "B<FTSENT *fts_read(FTS *>I<ftsp>B<);>\n"
475 #: build/C/man3/fts.3:56
477 msgid "B<FTSENT *fts_children(FTS *>I<ftsp>B<, int >I<options>B<);>\n"
481 #: build/C/man3/fts.3:58
483 msgid "B<int fts_set(FTS *>I<ftsp>B<, FTSENT *>I<f>B<, int >I<options>B<);>\n"
487 #: build/C/man3/fts.3:60
489 msgid "B<int fts_close(FTS *>I<ftsp>B<);>\n"
493 #: build/C/man3/fts.3:87
495 "The fts functions are provided for traversing file hierarchies. A simple "
496 "overview is that the B<fts_open>() function returns a \"handle\" on a file "
497 "hierarchy, which is then supplied to the other fts functions. The function "
498 "B<fts_read>() returns a pointer to a structure describing one of the files "
499 "in the file hierarchy. The function B<fts_children>() returns a pointer to "
500 "a linked list of structures, each of which describes one of the files "
501 "contained in a directory in the hierarchy. In general, directories are "
502 "visited two distinguishable times; in preorder (before any of their "
503 "descendants are visited) and in postorder (after all of their descendants "
504 "have been visited). Files are visited once. It is possible to walk the "
505 "hierarchy \"logically\" (visiting the files that symbolic links point to) "
506 "or physically (visiting the symbolic links themselves), order the walk of "
507 "the hierarchy or prune and/or revisit portions of the hierarchy."
511 #: build/C/man3/fts.3:108
513 "Two structures are defined (and typedef'd) in the include file "
514 "I<E<lt>fts.hE<gt>>. The first is I<FTS>, the structure that represents the "
515 "file hierarchy itself. The second is I<FTSENT>, the structure that "
516 "represents a file in the file hierarchy. Normally, an I<FTSENT> structure "
517 "is returned for every file in the file hierarchy. In this manual page, "
518 "\"file\" and \"FTSENT structure\" are generally interchangeable. The "
519 "I<FTSENT> structure contains at least the following fields, which are "
520 "described in greater detail below:"
524 #: build/C/man3/fts.3:127
527 "typedef struct _ftsent {\n"
528 " unsigned short fts_info; /* flags for FTSENT structure */\n"
529 " char *fts_accpath; /* access path */\n"
530 " char *fts_path; /* root path */\n"
531 " short fts_pathlen; /* strlen(fts_path) */\n"
532 " char *fts_name; /* filename */\n"
533 " short fts_namelen; /* strlen(fts_name) */\n"
534 " short fts_level; /* depth (-1 to N) */\n"
535 " int fts_errno; /* file errno */\n"
536 " long fts_number; /* local numeric value */\n"
537 " void *fts_pointer; /* local address value */\n"
538 " struct ftsent *fts_parent; /* parent directory */\n"
539 " struct ftsent *fts_link; /* next file structure */\n"
540 " struct ftsent *fts_cycle; /* cycle structure */\n"
541 " struct stat *fts_statp; /* stat(2) information */\n"
545 #. .Bl -tag -width "fts_namelen"
547 #: build/C/man3/fts.3:132
548 msgid "These fields are defined as follows:"
552 #: build/C/man3/fts.3:132
557 #. .Bl -tag -width FTS_DEFAULT
559 #: build/C/man3/fts.3:144
561 "One of the following flags describing the returned I<FTSENT> structure and "
562 "the file it represents. With the exception of directories without errors "
563 "(B<FTS_D>), all of these entries are terminal, that is, they will not be "
564 "revisited, nor will any of their descendants be visited."
568 #: build/C/man3/fts.3:145
574 #: build/C/man3/fts.3:148
575 msgid "A directory being visited in preorder."
579 #: build/C/man3/fts.3:148
585 #: build/C/man3/fts.3:156
587 "A directory that causes a cycle in the tree. (The I<fts_cycle> field of the "
588 "I<FTSENT> structure will be filled in as well.)"
592 #: build/C/man3/fts.3:156
594 msgid "B<FTS_DEFAULT>"
598 #: build/C/man3/fts.3:164
600 "Any I<FTSENT> structure that represents a file type not explicitly described "
601 "by one of the other I<fts_info> values."
605 #: build/C/man3/fts.3:164
611 #: build/C/man3/fts.3:170
613 "A directory which cannot be read. This is an error return, and the "
614 "I<fts_errno> field will be set to indicate what caused the error."
618 #: build/C/man3/fts.3:170
624 #: build/C/man3/fts.3:180
626 "A file named \".\" or \"..\" which was not specified as a filename to "
627 "B<fts_open>() (see B<FTS_SEEDOT>)."
631 #: build/C/man3/fts.3:180
637 #: build/C/man3/fts.3:190
639 "A directory being visited in postorder. The contents of the I<FTSENT> "
640 "structure will be unchanged from when it was returned in preorder, that is, "
641 "with the I<fts_info> field set to B<FTS_D>."
645 #: build/C/man3/fts.3:190
651 #: build/C/man3/fts.3:195
653 "This is an error return, and the I<fts_errno> field will be set to indicate "
654 "what caused the error."
658 #: build/C/man3/fts.3:195
664 #: build/C/man3/fts.3:198
665 msgid "A regular file."
669 #: build/C/man3/fts.3:198
675 #: build/C/man3/fts.3:209
677 "A file for which no B<stat>(2) information was available. The contents of "
678 "the I<fts_statp> field are undefined. This is an error return, and the "
679 "I<fts_errno> field will be set to indicate what caused the error."
683 #: build/C/man3/fts.3:209
689 #: build/C/man3/fts.3:217
691 "A file for which no B<stat>(2) information was requested. The contents of "
692 "the I<fts_statp> field are undefined."
696 #: build/C/man3/fts.3:217
702 #: build/C/man3/fts.3:220
703 msgid "A symbolic link."
707 #: build/C/man3/fts.3:220
709 msgid "B<FTS_SLNONE>"
714 #: build/C/man3/fts.3:228
716 "A symbolic link with a nonexistent target. The contents of the I<fts_statp> "
717 "field reference the file characteristic information for the symbolic link "
722 #: build/C/man3/fts.3:229
724 msgid "I<fts_accpath>"
728 #: build/C/man3/fts.3:232
729 msgid "A path for accessing the file from the current directory."
733 #: build/C/man3/fts.3:232
739 #: build/C/man3/fts.3:238
741 "The path for the file relative to the root of the traversal. This path "
742 "contains the path specified to B<fts_open>() as a prefix."
746 #: build/C/man3/fts.3:238
748 msgid "I<fts_pathlen>"
752 #: build/C/man3/fts.3:242
753 msgid "The length of the string referenced by I<fts_path>."
757 #: build/C/man3/fts.3:242
763 #: build/C/man3/fts.3:245
764 msgid "The name of the file."
768 #: build/C/man3/fts.3:245
770 msgid "I<fts_namelen>"
774 #: build/C/man3/fts.3:249
775 msgid "The length of the string referenced by I<fts_name>."
779 #: build/C/man3/fts.3:249
785 #: build/C/man3/fts.3:260
787 "The depth of the traversal, numbered from -1 to N, where this file was "
788 "found. The I<FTSENT> structure representing the parent of the starting "
789 "point (or root) of the traversal is numbered -1, and the I<FTSENT> "
790 "structure for the root itself is numbered 0."
794 #: build/C/man3/fts.3:260
800 #: build/C/man3/fts.3:283
802 "Upon return of a I<FTSENT> structure from the B<fts_children>() or "
803 "B<fts_read>() functions, with its I<fts_info> field set to B<FTS_DNR>, "
804 "B<FTS_ERR> or B<FTS_NS>, the I<fts_errno> field contains the value of the "
805 "external variable I<errno> specifying the cause of the error. Otherwise, "
806 "the contents of the I<fts_errno> field are undefined."
810 #: build/C/man3/fts.3:283
812 msgid "I<fts_number>"
816 #: build/C/man3/fts.3:289
818 "This field is provided for the use of the application program and is not "
819 "modified by the fts functions. It is initialized to 0."
823 #: build/C/man3/fts.3:289
825 msgid "I<fts_pointer>"
829 #: build/C/man3/fts.3:296
831 "This field is provided for the use of the application program and is not "
832 "modified by the fts functions. It is initialized to NULL."
836 #: build/C/man3/fts.3:296
838 msgid "I<fts_parent>"
842 #: build/C/man3/fts.3:310
844 "A pointer to the I<FTSENT> structure referencing the file in the hierarchy "
845 "immediately above the current file, that is, the directory of which this "
846 "file is a member. A parent structure for the initial entry point is "
847 "provided as well, however, only the I<fts_level>, I<fts_number> and "
848 "I<fts_pointer> fields are guaranteed to be initialized."
852 #: build/C/man3/fts.3:310
858 #: build/C/man3/fts.3:321
860 "Upon return from the B<fts_children>() function, the I<fts_link> field "
861 "points to the next structure in the NULL-terminated linked list of directory "
862 "members. Otherwise, the contents of the I<fts_link> field are undefined."
866 #: build/C/man3/fts.3:321
872 #: build/C/man3/fts.3:337
874 "If a directory causes a cycle in the hierarchy (see B<FTS_DC>), either "
875 "because of a hard link between two directories, or a symbolic link pointing "
876 "to a directory, the I<fts_cycle> field of the structure will point to the "
877 "I<FTSENT> structure in the hierarchy that references the same file as the "
878 "current I<FTSENT> structure. Otherwise, the contents of the I<fts_cycle> "
879 "field are undefined."
883 #: build/C/man3/fts.3:337
890 #: build/C/man3/fts.3:343
891 msgid "A pointer to B<stat>(2) information for the file."
895 #: build/C/man3/fts.3:370
897 "A single buffer is used for all of the paths of all of the files in the file "
898 "hierarchy. Therefore, the I<fts_path> and I<fts_accpath> fields are "
899 "guaranteed to be null-terminated I<only> for the file most recently returned "
900 "by B<fts_read>(). To use these fields to reference any files represented by "
901 "other I<FTSENT> structures will require that the path buffer be modified "
902 "using the information contained in that I<FTSENT> structure's I<fts_pathlen> "
903 "field. Any such modifications should be undone before further calls to "
904 "B<fts_read>() are attempted. The I<fts_name> field is always "
909 #: build/C/man3/fts.3:370
915 #: build/C/man3/fts.3:377
917 "The B<fts_open>() function takes a pointer to an array of character "
918 "pointers naming one or more paths which make up a logical file hierarchy to "
919 "be traversed. The array must be terminated by a null pointer."
922 #. .Bl -tag -width "FTS_PHYSICAL"
924 #: build/C/man3/fts.3:387
926 "There are a number of options, at least one of which (either B<FTS_LOGICAL> "
927 "or B<FTS_PHYSICAL>) must be specified. The options are selected by ORing "
928 "the following values:"
932 #: build/C/man3/fts.3:387
934 msgid "B<FTS_COMFOLLOW>"
938 #: build/C/man3/fts.3:393
940 "This option causes any symbolic link specified as a root path to be followed "
941 "immediately whether or not B<FTS_LOGICAL> is also specified."
945 #: build/C/man3/fts.3:393
947 msgid "B<FTS_LOGICAL>"
951 #: build/C/man3/fts.3:412
953 "This option causes the fts routines to return I<FTSENT> structures for the "
954 "targets of symbolic links instead of the symbolic links themselves. If this "
955 "option is set, the only symbolic links for which I<FTSENT> structures are "
956 "returned to the application are those referencing nonexistent files. Either "
957 "B<FTS_LOGICAL> or B<FTS_PHYSICAL> I<must> be provided to the B<fts_open>() "
962 #: build/C/man3/fts.3:412
964 msgid "B<FTS_NOCHDIR>"
968 #: build/C/man3/fts.3:428
970 "As a performance optimization, the fts functions change directories as they "
971 "walk the file hierarchy. This has the side-effect that an application "
972 "cannot rely on being in any particular directory during the traversal. The "
973 "B<FTS_NOCHDIR> option turns off this optimization, and the fts functions "
974 "will not change the current directory. Note that applications should not "
975 "themselves change their current directory and try to access files unless "
976 "B<FTS_NOCHDIR> is specified and absolute pathnames were provided as "
977 "arguments to B<fts_open>()."
981 #: build/C/man3/fts.3:428
983 msgid "B<FTS_NOSTAT>"
987 #: build/C/man3/fts.3:444
989 "By default, returned I<FTSENT> structures reference file characteristic "
990 "information (the I<statp> field) for each file visited. This option relaxes "
991 "that requirement as a performance optimization, allowing the fts functions "
992 "to set the I<fts_info> field to B<FTS_NSOK> and leave the contents of the "
993 "I<statp> field undefined."
997 #: build/C/man3/fts.3:444
999 msgid "B<FTS_PHYSICAL>"
1003 #: build/C/man3/fts.3:463
1005 "This option causes the fts routines to return I<FTSENT> structures for "
1006 "symbolic links themselves instead of the target files they point to. If "
1007 "this option is set, I<FTSENT> structures for all symbolic links in the "
1008 "hierarchy are returned to the application. Either B<FTS_LOGICAL> or "
1009 "B<FTS_PHYSICAL> I<must> be provided to the B<fts_open>() function."
1013 #: build/C/man3/fts.3:463
1015 msgid "B<FTS_SEEDOT>"
1019 #: build/C/man3/fts.3:476
1021 "By default, unless they are specified as path arguments to B<fts_open>(), "
1022 "any files named \".\" or \"..\" encountered in the file hierarchy are "
1023 "ignored. This option causes the fts routines to return I<FTSENT> structures "
1028 #: build/C/man3/fts.3:476
1035 #: build/C/man3/fts.3:482
1037 "This option prevents fts from descending into directories that have a "
1038 "different device number than the file from which the descent began."
1042 #: build/C/man3/fts.3:521
1044 "The argument B<compar>() specifies a user-defined function which may be "
1045 "used to order the traversal of the hierarchy. It takes two pointers to "
1046 "pointers to I<FTSENT> structures as arguments and should return a negative "
1047 "value, zero, or a positive value to indicate if the file referenced by its "
1048 "first argument comes before, in any order with respect to, or after, the "
1049 "file referenced by its second argument. The I<fts_accpath>, I<fts_path> and "
1050 "I<fts_pathlen> fields of the I<FTSENT> structures may I<never> be used in "
1051 "this comparison. If the I<fts_info> field is set to B<FTS_NS> or "
1052 "B<FTS_NSOK>, the I<fts_statp> field may not either. If the B<compar>() "
1053 "argument is NULL, the directory traversal order is in the order listed in "
1054 "I<path_argv> for the root paths, and in the order listed in the directory "
1055 "for everything else."
1059 #: build/C/man3/fts.3:521
1065 #: build/C/man3/fts.3:534
1067 "The B<fts_read>() function returns a pointer to an I<FTSENT> structure "
1068 "describing a file in the hierarchy. Directories (that are readable and do "
1069 "not cause cycles) are visited at least twice, once in preorder and once in "
1070 "postorder. All other files are visited at least once. (Hard links between "
1071 "directories that do not cause cycles or symbolic links to symbolic links may "
1072 "cause files to be visited more than once, or directories more than twice.)"
1076 #: build/C/man3/fts.3:555
1078 "If all the members of the hierarchy have been returned, B<fts_read>() "
1079 "returns NULL and sets the external variable I<errno> to 0. If an error "
1080 "unrelated to a file in the hierarchy occurs, B<fts_read>() returns NULL and "
1081 "sets I<errno> appropriately. If an error related to a returned file occurs, "
1082 "a pointer to an I<FTSENT> structure is returned, and I<errno> may or may not "
1083 "have been set (see I<fts_info>)."
1087 #: build/C/man3/fts.3:572
1089 "The I<FTSENT> structures returned by B<fts_read>() may be overwritten after "
1090 "a call to B<fts_close>() on the same file hierarchy stream, or, after a "
1091 "call to B<fts_read>() on the same file hierarchy stream unless they "
1092 "represent a file of type directory, in which case they will not be "
1093 "overwritten until after a call to B<fts_read>() after the I<FTSENT> "
1094 "structure has been returned by the function B<fts_read>() in postorder."
1098 #: build/C/man3/fts.3:572
1100 msgid "fts_children()"
1104 #: build/C/man3/fts.3:590
1106 "The B<fts_children>() function returns a pointer to an I<FTSENT> structure "
1107 "describing the first entry in a NULL-terminated linked list of the files in "
1108 "the directory represented by the I<FTSENT> structure most recently returned "
1109 "by B<fts_read>(). The list is linked through the I<fts_link> field of the "
1110 "I<FTSENT> structure, and is ordered by the user-specified comparison "
1111 "function, if any. Repeated calls to B<fts_children>() will re-create this "
1116 #: build/C/man3/fts.3:618
1118 "As a special case, if B<fts_read>() has not yet been called for a "
1119 "hierarchy, B<fts_children>() will return a pointer to the files in the "
1120 "logical directory specified to B<fts_open>(), that is, the arguments "
1121 "specified to B<fts_open>(). Otherwise, if the I<FTSENT> structure most "
1122 "recently returned by B<fts_read>() is not a directory being visited in "
1123 "preorder, or the directory does not contain any files, B<fts_children>() "
1124 "returns NULL and sets I<errno> to zero. If an error occurs, "
1125 "B<fts_children>() returns NULL and sets I<errno> appropriately."
1129 #: build/C/man3/fts.3:629
1131 "The I<FTSENT> structures returned by B<fts_children>() may be overwritten "
1132 "after a call to B<fts_children>(), B<fts_close>() or B<fts_read>() on the "
1133 "same file hierarchy stream."
1136 #. .Bl -tag -width FTS_NAMEONLY
1138 #: build/C/man3/fts.3:633
1139 msgid "I<Option> may be set to the following value:"
1143 #: build/C/man3/fts.3:633
1145 msgid "B<FTS_NAMEONLY>"
1150 #: build/C/man3/fts.3:643
1152 "Only the names of the files are needed. The contents of all the fields in "
1153 "the returned linked list of structures are undefined with the exception of "
1154 "the I<fts_name> and I<fts_namelen> fields."
1158 #: build/C/man3/fts.3:643
1163 #. .Bl -tag -width FTS_PHYSICAL
1165 #: build/C/man3/fts.3:658
1167 "The function B<fts_set>() allows the user application to determine further "
1168 "processing for the file I<f> of the stream I<ftsp>. The B<fts_set>() "
1169 "function returns 0 on success, and -1 if an error occurs. I<Option> must be "
1170 "set to one of the following values:"
1174 #: build/C/man3/fts.3:658
1176 msgid "B<FTS_AGAIN>"
1180 #: build/C/man3/fts.3:676
1182 "Revisit the file; any file type may be revisited. The next call to "
1183 "B<fts_read>() will return the referenced file. The I<fts_stat> and "
1184 "I<fts_info> fields of the structure will be reinitialized at that time, but "
1185 "no other fields will have been changed. This option is meaningful only for "
1186 "the most recently returned file from B<fts_read>(). Normal use is for "
1187 "postorder directory visits, where it causes the directory to be revisited "
1188 "(in both preorder and postorder) as well as all of its descendants."
1192 #: build/C/man3/fts.3:676
1194 msgid "B<FTS_FOLLOW>"
1198 #: build/C/man3/fts.3:704
1200 "The referenced file must be a symbolic link. If the referenced file is the "
1201 "one most recently returned by B<fts_read>(), the next call to B<fts_read>() "
1202 "returns the file with the I<fts_info> and I<fts_statp> fields reinitialized "
1203 "to reflect the target of the symbolic link instead of the symbolic link "
1204 "itself. If the file is one of those most recently returned by "
1205 "B<fts_children>(), the I<fts_info> and I<fts_statp> fields of the structure, "
1206 "when returned by B<fts_read>(), will reflect the target of the symbolic link "
1207 "instead of the symbolic link itself. In either case, if the target of the "
1208 "symbolic link does not exist, the fields of the returned structure will be "
1209 "unchanged and the I<fts_info> field will be set to B<FTS_SLNONE>."
1213 #: build/C/man3/fts.3:708
1215 "If the target of the link is a directory, the preorder return, followed by "
1216 "the return of all of its descendants, followed by a postorder return, is "
1221 #: build/C/man3/fts.3:708
1228 #: build/C/man3/fts.3:716
1230 "No descendants of this file are visited. The file may be one of those most "
1231 "recently returned by either B<fts_children>() or B<fts_read>()."
1235 #: build/C/man3/fts.3:716
1241 #: build/C/man3/fts.3:729
1243 "The B<fts_close>() function closes a file hierarchy stream I<ftsp> and "
1244 "restores the current directory to the directory from which B<fts_open>() "
1245 "was called to open I<ftsp>. The B<fts_close>() function returns 0 on "
1246 "success, and -1 if an error occurs."
1250 #: build/C/man3/fts.3:729 build/C/man2/getxattr.2:106 build/C/man3/isfdtype.3:83 build/C/man2/listxattr.2:127 build/C/man2/mount.2:318 build/C/man2/removexattr.2:83 build/C/man2/setxattr.2:110 build/C/man2/spu_create.2:172 build/C/man2/spu_run.2:153 build/C/man2/stat.2:522 build/C/man2/statfs.2:162 build/C/man3/statvfs.3:101 build/C/man2/sysfs.2:79 build/C/man2/umount.2:104 build/C/man2/ustat.2:79
1256 #: build/C/man3/fts.3:738
1258 "The function B<fts_open>() may fail and set I<errno> for any of the errors "
1259 "specified for B<open>(2) and B<malloc>(3)."
1263 #: build/C/man3/fts.3:747
1265 "The function B<fts_close>() may fail and set I<errno> for any of the errors "
1266 "specified for B<chdir>(2) and B<close>(2)."
1270 #: build/C/man3/fts.3:761
1272 "The functions B<fts_read>() and B<fts_children>() may fail and set "
1273 "I<errno> for any of the errors specified for B<chdir>(2), B<malloc>(3), "
1274 "B<opendir>(3), B<readdir>(3), and B<stat>(2)."
1278 #: build/C/man3/fts.3:770
1280 "In addition, B<fts_children>(), B<fts_open>(), and B<fts_set>() may fail "
1281 "and set I<errno> as follows:"
1285 #: build/C/man3/fts.3:770 build/C/man2/mount.2:354 build/C/man2/spu_create.2:186 build/C/man2/spu_run.2:174 build/C/man2/stat.2:585 build/C/man2/sysfs.2:84 build/C/man2/umount.2:125 build/C/man2/umount.2:129 build/C/man2/ustat.2:84
1291 #: build/C/man3/fts.3:773
1292 msgid "The options were invalid."
1296 #: build/C/man3/fts.3:773 build/C/man3/ftw.3:339 build/C/man2/getxattr.2:130 build/C/man2/listxattr.2:142 build/C/man2/mount.2:412 build/C/man2/removexattr.2:99 build/C/man2/setxattr.2:141 build/C/man2/spu_create.2:246 build/C/man2/spu_run.2:188 build/C/man2/stat.2:595 build/C/man2/umount.2:156
1302 #: build/C/man3/fts.3:775
1303 msgid "These functions are available in Linux since glibc2."
1307 #: build/C/man3/fts.3:775 build/C/man3/ftw.3:342 build/C/man3/getfsent.3:115 build/C/man3/getmntent.3:202 build/C/man2/getxattr.2:133 build/C/man3/isfdtype.3:88 build/C/man2/listxattr.2:145 build/C/man2/mount.2:423 build/C/man2/removexattr.2:102 build/C/man2/setxattr.2:144 build/C/man2/spu_create.2:250 build/C/man2/spu_run.2:192 build/C/man2/stat.2:599 build/C/man2/statfs.2:218 build/C/man3/statvfs.3:164 build/C/man2/sysfs.2:92 build/C/man2/umount.2:162 build/C/man2/ustat.2:94
1309 msgid "CONFORMING TO"
1313 #: build/C/man3/fts.3:777
1318 #: build/C/man3/fts.3:777 build/C/man2/statfs.2:305 build/C/man2/sysfs.2:101
1323 #. https://sourceware.org/bugzilla/show_bug.cgi?id=15838
1324 #. https://sourceware.org/bugzilla/show_bug.cgi?id=11460
1325 #. The following statement is years old, and seems no closer to
1326 #. being true -- mtk
1329 #. utility is expected to be included in a future
1333 #: build/C/man3/fts.3:790
1335 "All of the APIs described in this man page are not safe when compiling a "
1336 "program using the LFS APIs (e.g., when compiling with "
1337 "I<-D_FILE_OFFSET_BITS=64>)."
1341 #: build/C/man3/fts.3:796
1342 msgid "B<find>(1), B<chdir>(2), B<stat>(2), B<ftw>(3), B<qsort>(3)"
1346 #: build/C/man3/ftw.3:35
1352 #: build/C/man3/ftw.3:35
1358 #: build/C/man3/ftw.3:38
1359 msgid "ftw, nftw - file tree walk"
1363 #: build/C/man3/ftw.3:41
1365 msgid "B<#include E<lt>ftw.hE<gt>>\n"
1369 #: build/C/man3/ftw.3:46
1372 "B<int ftw(const char *>I<dirpath>B<,>\n"
1373 "B< int (*>I<fn>B<) (const char *>I<fpath>B<, const struct stat "
1375 "B< int >I<typeflag>B<),>\n"
1376 "B< int >I<nopenfd>B<);>\n"
1380 #: build/C/man3/ftw.3:49
1383 "B<#define _XOPEN_SOURCE 500> /* See feature_test_macros(7) */\n"
1384 "B<#include E<lt>ftw.hE<gt>>\n"
1388 #: build/C/man3/ftw.3:54
1391 "B<int nftw(const char *>I<dirpath>B<,>\n"
1392 "B< int (*>I<fn>B<) (const char *>I<fpath>B<, const struct stat "
1394 "B< int >I<typeflag>B<, struct FTW *>I<ftwbuf>B<),>\n"
1395 "B< int >I<nopenfd>B<, int >I<flags>B<);>\n"
1399 #: build/C/man3/ftw.3:62
1401 "B<ftw>() walks through the directory tree that is located under the "
1402 "directory I<dirpath>, and calls I<fn>() once for each entry in the tree. By "
1403 "default, directories are handled before the files and subdirectories they "
1404 "contain (preorder traversal)."
1408 #: build/C/man3/ftw.3:75
1410 "To avoid using up all of the calling process's file descriptors, I<nopenfd> "
1411 "specifies the maximum number of directories that B<ftw>() will hold open "
1412 "simultaneously. When the search depth exceeds this, B<ftw>() will become "
1413 "slower because directories have to be closed and reopened. B<ftw>() uses "
1414 "at most one file descriptor for each level in the directory tree."
1418 #: build/C/man3/ftw.3:104
1420 "For each entry found in the tree, B<ftw>() calls I<fn>() with three "
1421 "arguments: I<fpath>, I<sb>, and I<typeflag>. I<fpath> is the pathname of "
1422 "the entry, and is expressed either as a pathname relative to the calling "
1423 "process's current working directory at the time of the call to B<ftw>(), if "
1424 "I<dirpath> was expressed as a relative pathname, or as an absolute pathname, "
1425 "if I<dirpath> was expressed as an absolute pathname. I<sb> is a pointer to "
1426 "the I<stat> structure returned by a call to B<stat>(2) for I<fpath>. "
1427 "I<typeflag> is an integer that has one of the following values:"
1431 #: build/C/man3/ftw.3:104
1437 #: build/C/man3/ftw.3:108
1438 msgid "I<fpath> is a regular file."
1442 #: build/C/man3/ftw.3:108
1448 #: build/C/man3/ftw.3:112
1449 msgid "I<fpath> is a directory."
1453 #: build/C/man3/ftw.3:112
1459 #: build/C/man3/ftw.3:116
1460 msgid "I<fpath> is a directory which can't be read."
1464 #: build/C/man3/ftw.3:116
1470 #: build/C/man3/ftw.3:130
1472 "The B<stat>(2) call failed on I<fpath>, which is not a symbolic link. The "
1473 "probable cause for this is that the caller had read permission on the parent "
1474 "directory, so that the filename I<fpath> could be seen, but did not have "
1475 "execute permission, so that the file could not be reached for B<stat>(2)."
1479 #: build/C/man3/ftw.3:139
1481 "If I<fpath> is a symbolic link and B<stat>(2) failed, POSIX.1-2001 states "
1482 "that it is undefined whether B<FTW_NS> or B<FTW_SL> (see below) is passed "
1487 #: build/C/man3/ftw.3:150
1489 "To stop the tree walk, I<fn>() returns a nonzero value; this value will "
1490 "become the return value of B<ftw>(). As long as I<fn>() returns 0, B<ftw>() "
1491 "will continue either until it has traversed the entire tree, in which case "
1492 "it will return zero, or until it encounters an error (such as a B<malloc>(3) "
1493 "failure), in which case it will return -1."
1497 #: build/C/man3/ftw.3:160
1499 "Because B<ftw>() uses dynamic data structures, the only safe way to exit "
1500 "out of a tree walk is to return a nonzero value from I<fn>(). To allow a "
1501 "signal to terminate the walk without causing a memory leak, have the handler "
1502 "set a global flag that is checked by I<fn>(). I<Don't> use B<longjmp>(3) "
1503 "unless the program is going to terminate."
1507 #: build/C/man3/ftw.3:160
1513 #: build/C/man3/ftw.3:167
1515 "The function B<nftw>() is the same as B<ftw>(), except that it has one "
1516 "additional argument, I<flags>, and calls I<fn>() with one more argument, "
1521 #: build/C/man3/ftw.3:170
1523 "This I<flags> argument is formed by ORing zero or more of the following "
1528 #: build/C/man3/ftw.3:170
1530 msgid "B<FTW_ACTIONRETVAL> (since glibc 2.3.3)"
1534 #: build/C/man3/ftw.3:179
1536 "If this glibc-specific flag is set, then B<nftw>() handles the return value "
1537 "from I<fn>() differently. I<fn>() should return one of the following "
1542 #: build/C/man3/ftw.3:180
1544 msgid "B<FTW_CONTINUE>"
1548 #: build/C/man3/ftw.3:185
1549 msgid "Instructs B<nftw>() to continue normally."
1553 #: build/C/man3/ftw.3:185
1555 msgid "B<FTW_SKIP_SIBLINGS>"
1558 #. If \fBFTW_DEPTH\fP
1559 #. is set, the entry's parent directory is processed next (with
1560 #. \fIflag\fP set to \fBFTW_DP\fP).
1562 #: build/C/man3/ftw.3:193
1564 "If I<fn>() returns this value, then siblings of the current entry will be "
1565 "skipped, and processing continues in the parent."
1569 #: build/C/man3/ftw.3:193
1571 msgid "B<FTW_SKIP_SUBTREE>"
1575 #: build/C/man3/ftw.3:201
1577 "If I<fn>() is called with an entry that is a directory (I<typeflag> is "
1578 "B<FTW_D>), this return value will prevent objects within that directory from "
1579 "being passed as arguments to I<fn>(). B<nftw>() continues processing with "
1580 "the next sibling of the directory."
1584 #: build/C/man3/ftw.3:201
1590 #: build/C/man3/ftw.3:207
1591 msgid "Causes B<nftw>() to return immediately with the return value B<FTW_STOP>."
1595 #: build/C/man3/ftw.3:210
1597 "Other return values could be associated with new actions in the future; "
1598 "I<fn>() should not return values other than those listed above."
1602 #: build/C/man3/ftw.3:219
1604 "The feature test macro B<_GNU_SOURCE> must be defined (before including "
1605 "I<any> header files) in order to obtain the definition of "
1606 "B<FTW_ACTIONRETVAL> from I<E<lt>ftw.hE<gt>>."
1610 #: build/C/man3/ftw.3:220
1612 msgid "B<FTW_CHDIR>"
1616 #: build/C/man3/ftw.3:231
1618 "If set, do a B<chdir>(2) to each directory before handling its contents. "
1619 "This is useful if the program needs to perform some action in the directory "
1620 "in which I<fpath> resides. (Specifying this flag has no effect on the "
1621 "pathname that is passed in the I<fpath> argument of I<fn>.)"
1625 #: build/C/man3/ftw.3:231
1627 msgid "B<FTW_DEPTH>"
1631 #: build/C/man3/ftw.3:237
1633 "If set, do a post-order traversal, that is, call I<fn>() for the directory "
1634 "itself I<after> handling the contents of the directory and its "
1635 "subdirectories. (By default, each directory is handled I<before> its "
1640 #: build/C/man3/ftw.3:237
1642 msgid "B<FTW_MOUNT>"
1646 #: build/C/man3/ftw.3:241
1647 msgid "If set, stay within the same filesystem (i.e., do not cross mount points)."
1651 #: build/C/man3/ftw.3:241
1657 #: build/C/man3/ftw.3:246
1659 "If set, do not follow symbolic links. (This is what you want.) If not set, "
1660 "symbolic links are followed, but no file is reported twice."
1664 #: build/C/man3/ftw.3:251
1666 "If B<FTW_PHYS> is not set, but B<FTW_DEPTH> is set, then the function "
1667 "I<fn>() is never called for a directory that would be a descendant of "
1672 #: build/C/man3/ftw.3:266
1674 "For each entry in the directory tree, B<nftw>() calls I<fn>() with four "
1675 "arguments. I<fpath> and I<sb> are as for B<ftw>(). I<typeflag> may receive "
1676 "any of the same values as with B<ftw>(), or any of the following values:"
1680 #: build/C/man3/ftw.3:266
1686 #: build/C/man3/ftw.3:280
1688 "I<fpath> is a directory, and B<FTW_DEPTH> was specified in I<flags>. (If "
1689 "B<FTW_DEPTH> was not specified in I<flags>, then directories will always be "
1690 "visited with I<typeflag> set to B<FTW_D>.) All of the files and "
1691 "subdirectories within I<fpath> have been processed."
1695 #: build/C/man3/ftw.3:280
1700 #. To obtain the definition of this constant from
1704 #. must be defined, or
1705 #. .BR _XOPEN_SOURCE
1706 #. must be defined with a value of 500 or more.
1708 #: build/C/man3/ftw.3:291
1709 msgid "I<fpath> is a symbolic link, and B<FTW_PHYS> was set in I<flags>."
1713 #: build/C/man3/ftw.3:291
1719 #: build/C/man3/ftw.3:296
1721 "I<fpath> is a symbolic link pointing to a nonexistent file. (This occurs "
1722 "only if B<FTW_PHYS> is not set.)"
1726 #: build/C/man3/ftw.3:302
1728 "The fourth argument that B<nftw>() supplies when calling I<fn>() is a "
1729 "structure of type I<FTW>:"
1733 #: build/C/man3/ftw.3:309
1743 #: build/C/man3/ftw.3:322
1745 "I<base> is the offset of the filename (i.e., basename component) in the "
1746 "pathname given in I<fpath>. I<level> is the depth of I<fpath> in the "
1747 "directory tree, relative to the root of the tree (I<dirpath>, which has "
1752 #: build/C/man3/ftw.3:322 build/C/man3/getfsent.3:99 build/C/man3/getmntent.3:175 build/C/man2/getxattr.2:100 build/C/man3/isfdtype.3:72 build/C/man2/listxattr.2:121 build/C/man2/mount.2:313 build/C/man2/removexattr.2:78 build/C/man2/setxattr.2:105 build/C/man2/spu_create.2:165 build/C/man2/spu_run.2:102 build/C/man2/stat.2:517 build/C/man2/statfs.2:157 build/C/man3/statvfs.3:96 build/C/man2/sysfs.2:67 build/C/man2/umount.2:99 build/C/man2/ustat.2:70
1754 msgid "RETURN VALUE"
1758 #: build/C/man3/ftw.3:324
1759 msgid "These functions return 0 on success, and -1 if an error occurs."
1763 #: build/C/man3/ftw.3:331
1765 "If I<fn>() returns nonzero, then the tree walk is terminated and the value "
1766 "returned by I<fn>() is returned as the result of B<ftw>() or B<nftw>()."
1770 #: build/C/man3/ftw.3:339
1772 "If B<nftw>() is called with the B<FTW_ACTIONRETVAL> flag, then the only "
1773 "nonzero value that should be used by I<fn>() to terminate the tree walk is "
1774 "B<FTW_STOP>, and that value is returned as the result of B<nftw>()."
1778 #: build/C/man3/ftw.3:342
1779 msgid "B<nftw>() is available under glibc since version 2.1."
1783 #: build/C/man3/ftw.3:347
1784 msgid "POSIX.1-2001, SVr4, SUSv1. POSIX.1-2008 marks B<ftw>() as obsolete."
1788 #: build/C/man3/ftw.3:347 build/C/man3/getfsent.3:127 build/C/man3/getmntent.3:208 build/C/man3/isfdtype.3:98 build/C/man2/mount.2:426 build/C/man2/spu_create.2:254 build/C/man2/spu_run.2:196 build/C/man2/stat.2:743 build/C/man2/statfs.2:224 build/C/man3/statvfs.3:166 build/C/man2/sysfs.2:94 build/C/man2/umount.2:165 build/C/man2/ustat.2:98
1794 #: build/C/man3/ftw.3:351
1796 "POSIX.1-2001 note that the results are unspecified if I<fn> does not "
1797 "preserve the current working directory."
1801 #: build/C/man3/ftw.3:357
1803 "The function B<nftw>() and the use of B<FTW_SL> with B<ftw>() were "
1804 "introduced in SUSv1."
1808 #: build/C/man3/ftw.3:367
1810 "On some systems B<ftw>() will never use B<FTW_SL>, on other systems "
1811 "B<FTW_SL> occurs only for symbolic links that do not point to an existing "
1812 "file, and again on other systems B<ftw>() will use B<FTW_SL> for each "
1813 "symbolic link. For predictable control, use B<nftw>()."
1817 #: build/C/man3/ftw.3:370
1819 "B<FTW_F> is returned for all objects (files, symbolic links, FIFOs, etc.) "
1820 "that can be stat'ed but are not a directory."
1824 #: build/C/man3/ftw.3:372
1825 msgid "B<FTW_ACTIONRETVAL> is glibc-specific."
1829 #: build/C/man3/ftw.3:372 build/C/man2/spu_create.2:265 build/C/man2/spu_run.2:207 build/C/man7/spufs.7:759 build/C/man2/stat.2:855
1835 #: build/C/man3/ftw.3:381
1837 "The following program traverses the directory tree under the path named in "
1838 "its first command-line argument, or under the current directory if no "
1839 "argument is supplied. It displays various information about each file. The "
1840 "second command-line argument can be used to specify characters that control "
1841 "the value assigned to the I<flags> argument when calling B<nftw>()."
1845 #: build/C/man3/ftw.3:381
1847 msgid "Program source"
1851 #: build/C/man3/ftw.3:389
1854 "#define _XOPEN_SOURCE 500\n"
1855 "#include E<lt>ftw.hE<gt>\n"
1856 "#include E<lt>stdio.hE<gt>\n"
1857 "#include E<lt>stdlib.hE<gt>\n"
1858 "#include E<lt>string.hE<gt>\n"
1859 "#include E<lt>stdint.hE<gt>\n"
1863 #: build/C/man3/ftw.3:403
1867 "display_info(const char *fpath, const struct stat *sb,\n"
1868 " int tflag, struct FTW *ftwbuf)\n"
1870 " printf(\"%-3s %2d %7jd %-40s %d %s\\en\",\n"
1871 " (tflag == FTW_D) ? \"d\" : (tflag == FTW_DNR) ? \"dnr\" :\n"
1872 " (tflag == FTW_DP) ? \"dp\" : (tflag == FTW_F) ? \"f\" :\n"
1873 " (tflag == FTW_NS) ? \"ns\" : (tflag == FTW_SL) ? \"sl\" :\n"
1874 " (tflag == FTW_SLN) ? \"sln\" : \"???\",\n"
1875 " ftwbuf-E<gt>level, (intmax_t) sb-E<gt>st_size,\n"
1876 " fpath, ftwbuf-E<gt>base, fpath + ftwbuf-E<gt>base);\n"
1877 " return 0; /* To tell nftw() to continue */\n"
1882 #: build/C/man3/ftw.3:408
1886 "main(int argc, char *argv[])\n"
1892 #: build/C/man3/ftw.3:413
1895 " if (argc E<gt> 2 && strchr(argv[2], \\(aqd\\(aq) != NULL)\n"
1896 " flags |= FTW_DEPTH;\n"
1897 " if (argc E<gt> 2 && strchr(argv[2], \\(aqp\\(aq) != NULL)\n"
1898 " flags |= FTW_PHYS;\n"
1902 #: build/C/man3/ftw.3:421
1905 " if (nftw((argc E<lt> 2) ? \".\" : argv[1], display_info, 20, flags)\n"
1907 " perror(\"nftw\");\n"
1908 " exit(EXIT_FAILURE);\n"
1910 " exit(EXIT_SUCCESS);\n"
1915 #: build/C/man3/ftw.3:426
1916 msgid "B<stat>(2), B<fts>(3), B<readdir>(3)"
1920 #: build/C/man3/getfsent.3:27
1926 #: build/C/man3/getfsent.3:27
1932 #: build/C/man3/getfsent.3:27
1938 #: build/C/man3/getfsent.3:30
1939 msgid "getfsent, getfsspec, getfsfile, setfsent, endfsent - handle fstab entries"
1943 #: build/C/man3/getfsent.3:32
1944 msgid "B<#include E<lt>fstab.hE<gt>>"
1948 #: build/C/man3/getfsent.3:34
1949 msgid "B<void endfsent(void);>"
1953 #: build/C/man3/getfsent.3:36
1954 msgid "B<struct fstab *getfsent(void);>"
1958 #: build/C/man3/getfsent.3:38
1959 msgid "B<struct fstab *getfsfile(const char *>I<mount_point>B<);>"
1963 #: build/C/man3/getfsent.3:40
1964 msgid "B<struct fstab *getfsspec(const char *>I<special_file>B<);>"
1968 #: build/C/man3/getfsent.3:42
1969 msgid "B<int setfsent(void);>"
1973 #: build/C/man3/getfsent.3:48
1975 "These functions read from the file I</etc/fstab>. The I<struct fstab> is "
1980 #: build/C/man3/getfsent.3:60
1984 " char *fs_spec; /* block device name */\n"
1985 " char *fs_file; /* mount point */\n"
1986 " char *fs_vfstype; /* file-system type */\n"
1987 " char *fs_mntops; /* mount options */\n"
1988 " const char *fs_type; /* rw/rq/ro/sw/xx option */\n"
1989 " int fs_freq; /* dump frequency, in days */\n"
1990 " int fs_passno; /* pass number on parallel dump */\n"
1995 #: build/C/man3/getfsent.3:68
1997 "Here the field I<fs_type> contains (on a *BSD system) one of the five "
1998 "strings \"rw\", \"rq\", \"ro\", \"sw\", \"xx\" (read-write, read-write with "
1999 "quota, read-only, swap, ignore)."
2003 #: build/C/man3/getfsent.3:72
2005 "The function B<setfsent>() opens the file when required and positions it at "
2010 #: build/C/man3/getfsent.3:77
2012 "The function B<getfsent>() parses the next line from the file. (After "
2013 "opening it when required.)"
2017 #: build/C/man3/getfsent.3:81
2018 msgid "The function B<endfsent>() closes the file when required."
2022 #: build/C/man3/getfsent.3:90
2024 "The function B<getfsspec>() searches the file from the start and returns "
2025 "the first entry found for which the I<fs_spec> field matches the "
2026 "I<special_file> argument."
2030 #: build/C/man3/getfsent.3:99
2032 "The function B<getfsfile>() searches the file from the start and returns "
2033 "the first entry found for which the I<fs_file> field matches the "
2034 "I<mount_point> argument."
2040 #. function appeared in 4.0BSD; the other four functions appeared in 4.3BSD.
2042 #: build/C/man3/getfsent.3:115
2044 "Upon success, the functions B<getfsent>(), B<getfsfile>(), and "
2045 "B<getfsspec>() return a pointer to a I<struct fstab>, while B<setfsent>() "
2046 "returns 1. Upon failure or end-of-file, these functions return NULL and 0, "
2051 #: build/C/man3/getfsent.3:127
2053 "These functions are not in POSIX.1-2001. Several operating systems have "
2054 "them, for example, *BSD, SunOS, Digital UNIX, AIX (which also has a "
2055 "B<getfstype>()). HP-UX has functions of the same names, that however use a "
2056 "I<struct checklist> instead of a I<struct fstab>, and calls these functions "
2057 "obsolete, superseded by B<getmntent>(3)."
2061 #: build/C/man3/getfsent.3:129
2062 msgid "These functions are not thread-safe."
2066 #: build/C/man3/getfsent.3:139
2068 "Since Linux allows mounting a block special device in several places, and "
2069 "since several devices can have the same mount point, where the last device "
2070 "with a given mount point is the interesting one, while B<getfsfile>() and "
2071 "B<getfsspec>() only return the first occurrence, these two functions are "
2072 "not suitable for use under Linux."
2076 #: build/C/man3/getfsent.3:142
2077 msgid "B<getmntent>(3), B<fstab>(5)"
2081 #: build/C/man3/getmntent.3:32
2087 #: build/C/man3/getmntent.3:32
2093 #: build/C/man3/getmntent.3:36
2095 "getmntent, setmntent, addmntent, endmntent, hasmntopt, getmntent_r - get "
2096 "filesystem descriptor file entry"
2100 #: build/C/man3/getmntent.3:40
2103 "B<#include E<lt>stdio.hE<gt>>\n"
2104 "B<#include E<lt>mntent.hE<gt>>\n"
2108 #: build/C/man3/getmntent.3:42
2110 msgid "B<FILE *setmntent(const char *>I<filename>B<, const char *>I<type>B<);>\n"
2114 #: build/C/man3/getmntent.3:44
2116 msgid "B<struct mntent *getmntent(FILE *>I<stream>B<);>\n"
2120 #: build/C/man3/getmntent.3:46
2122 msgid "B<int addmntent(FILE *>I<stream>B<, const struct mntent *>I<mnt>B<);>\n"
2126 #: build/C/man3/getmntent.3:48
2128 msgid "B<int endmntent(FILE *>I<streamp>B<);>\n"
2132 #: build/C/man3/getmntent.3:50
2134 msgid "B<char *hasmntopt(const struct mntent *>I<mnt>B<, const char *>I<opt>B<);>\n"
2138 #: build/C/man3/getmntent.3:53
2141 "/* GNU extension */\n"
2142 "B<#include E<lt>mntent.hE<gt>>\n"
2146 #: build/C/man3/getmntent.3:56
2149 "B<struct mntent *getmntent_r(FILE *>I<streamp>B<, struct mntent "
2151 "B< char *>I<buf>B<, int >I<buflen>B<);>\n"
2155 #: build/C/man3/getmntent.3:61 build/C/man3/isfdtype.3:40 build/C/man2/stat.2:68
2156 msgid "Feature Test Macro Requirements for glibc (see B<feature_test_macros>(7)):"
2160 #: build/C/man3/getmntent.3:65
2161 msgid "B<getmntent_r>(): _BSD_SOURCE || _SVID_SOURCE"
2165 #: build/C/man3/getmntent.3:70
2167 "These routines are used to access the filesystem description file "
2168 "I</etc/fstab> and the mounted filesystem description file I</etc/mtab>."
2172 #: build/C/man3/getmntent.3:84
2174 "The B<setmntent>() function opens the filesystem description file "
2175 "I<filename> and returns a file pointer which can be used by B<getmntent>(). "
2176 "The argument I<type> is the type of access required and can take the same "
2177 "values as the I<mode> argument of B<fopen>(3)."
2181 #: build/C/man3/getmntent.3:96
2183 "The B<getmntent>() function reads the next line of the filesystem "
2184 "description file from I<stream> and returns a pointer to a structure "
2185 "containing the broken out fields from a line in the file. The pointer "
2186 "points to a static area of memory which is overwritten by subsequent calls "
2187 "to B<getmntent>()."
2191 #: build/C/man3/getmntent.3:106
2193 "The B<addmntent>() function adds the I<mntent> structure I<mnt> to the end "
2194 "of the open I<stream>."
2198 #: build/C/man3/getmntent.3:112
2200 "The B<endmntent>() function closes the I<stream> associated with the "
2201 "filesystem description file."
2205 #: build/C/man3/getmntent.3:129
2207 "The B<hasmntopt>() function scans the I<mnt_opts> field (see below) of the "
2208 "I<mntent> structure I<mnt> for a substring that matches I<opt>. See "
2209 "I<E<lt>mntent.hE<gt>> and B<mount>(8) for valid mount options."
2213 #: build/C/man3/getmntent.3:143
2215 "The reentrant B<getmntent_r>() function is similar to B<getmntent>(), but "
2216 "stores the I<struct mount> in the provided I<*mntbuf> and stores the strings "
2217 "pointed to by the entries in that struct in the provided array I<buf> of "
2222 #: build/C/man3/getmntent.3:149
2223 msgid "The I<mntent> structure is defined in I<E<lt>mntent.hE<gt>> as follows:"
2227 #: build/C/man3/getmntent.3:160
2231 " char *mnt_fsname; /* name of mounted filesystem */\n"
2232 " char *mnt_dir; /* filesystem path prefix */\n"
2233 " char *mnt_type; /* mount type (see mntent.h) */\n"
2234 " char *mnt_opts; /* mount options (see mntent.h) */\n"
2235 " int mnt_freq; /* dump frequency in days */\n"
2236 " int mnt_passno; /* pass number on parallel fsck */\n"
2241 #: build/C/man3/getmntent.3:175
2243 "Since fields in the mtab and fstab files are separated by whitespace, octal "
2244 "escapes are used to represent the four characters space (\\e040), tab "
2245 "(\\e011), newline (\\e012) and backslash (\\e134) in those files when they "
2246 "occur in one of the four strings in a I<mntent> structure. The routines "
2247 "B<addmntent>() and B<getmntent>() will convert from string representation "
2248 "to escaped representation and back."
2252 #: build/C/man3/getmntent.3:184
2254 "The B<getmntent>() and B<getmntent_r>() functions return a pointer to the "
2255 "I<mntent> structure or NULL on failure."
2259 #: build/C/man3/getmntent.3:188
2260 msgid "The B<addmntent>() function returns 0 on success and 1 on failure."
2264 #: build/C/man3/getmntent.3:192
2265 msgid "The B<endmntent>() function always returns 1."
2269 #: build/C/man3/getmntent.3:197
2271 "The B<hasmntopt>() function returns the address of the substring if a match "
2272 "is found and NULL otherwise."
2276 #: build/C/man3/getmntent.3:197 build/C/man2/spu_create.2:240
2282 #: build/C/man3/getmntent.3:201
2285 "/etc/fstab filesystem description file\n"
2286 "/etc/mtab mounted filesystem description file\n"
2290 #: build/C/man3/getmntent.3:208
2292 "The nonreentrant functions are from SunOS 4.1.3. A routine B<getmntent_r>() "
2293 "was introduced in HP-UX 10, but it returns an int. The prototype shown "
2294 "above is glibc-only."
2298 #: build/C/man3/getmntent.3:220
2300 "System V also has a B<getmntent>() function but the calling sequence "
2301 "differs, and the returned structure is different. Under System V "
2302 "I</etc/mnttab> is used. 4.4BSD and Digital UNIX have a routine "
2303 "B<getmntinfo>(), a wrapper around the system call B<getfsstat>()."
2307 #: build/C/man3/getmntent.3:224
2308 msgid "B<fopen>(3), B<fstab>(5), B<mount>(8)"
2312 #: build/C/man2/getxattr.2:25
2318 #: build/C/man2/getxattr.2:25
2324 #: build/C/man2/getxattr.2:28
2325 msgid "getxattr, lgetxattr, fgetxattr - retrieve an extended attribute value"
2329 #: build/C/man2/getxattr.2:33 build/C/man2/listxattr.2:33 build/C/man2/removexattr.2:33 build/C/man2/setxattr.2:33
2332 "B<#include E<lt>sys/types.hE<gt>>\n"
2333 "B<#include E<lt>sys/xattr.hE<gt>>\n"
2337 #: build/C/man2/getxattr.2:40
2340 "B<ssize_t getxattr(const char\\ *>I<path>B<, const char\\ *>I<name>B<,>\n"
2341 "B< void\\ *>I<value>B<, size_t >I<size>B<);>\n"
2342 "B<ssize_t lgetxattr(const char\\ *>I<path>B<, const char\\ *>I<name>B<,>\n"
2343 "B< void\\ *>I<value>B<, size_t >I<size>B<);>\n"
2344 "B<ssize_t fgetxattr(int >I<fd>B<, const char\\ *>I<name>B<,>\n"
2345 "B< void\\ *>I<value>B<, size_t >I<size>B<);>\n"
2349 #: build/C/man2/getxattr.2:53 build/C/man2/setxattr.2:53
2351 "Extended attributes are I<name>:I<value> pairs associated with inodes "
2352 "(files, directories, symbolic links, etc.). They are extensions to the "
2353 "normal attributes which are associated with all inodes in the system (i.e., "
2354 "the B<stat>(2) data). A complete overview of extended attributes concepts "
2355 "can be found in B<attr>(5)."
2359 #: build/C/man2/getxattr.2:65
2361 "B<getxattr>() retrieves the I<value> of the extended attribute identified "
2362 "by I<name> and associated with the given I<path> in the filesystem. The "
2363 "length of the attribute I<value> is returned."
2367 #: build/C/man2/getxattr.2:71
2369 "B<lgetxattr>() is identical to B<getxattr>(), except in the case of a "
2370 "symbolic link, where the link itself is interrogated, not the file that it "
2375 #: build/C/man2/getxattr.2:81
2377 "B<fgetxattr>() is identical to B<getxattr>(), only the open file referred "
2378 "to by I<fd> (as returned by B<open>(2)) is interrogated in place of "
2383 #: build/C/man2/getxattr.2:89
2385 "An extended attribute I<name> is a simple null-terminated string. The name "
2386 "includes a namespace prefix; there may be several, disjoint namespaces "
2387 "associated with an individual inode. The value of an extended attribute is "
2388 "a chunk of arbitrary textual or binary data of specified length."
2392 #: build/C/man2/getxattr.2:96
2394 "An empty buffer of I<size> zero can be passed into these calls to return the "
2395 "current size of the named extended attribute, which can be used to estimate "
2396 "the size of a buffer which is sufficiently large to hold the value "
2397 "associated with the extended attribute."
2401 #: build/C/man2/getxattr.2:100
2403 "The interface is designed to allow guessing of initial buffer sizes, and to "
2404 "enlarge buffers when the return value indicates that the buffer provided was "
2409 #: build/C/man2/getxattr.2:106
2411 "On success, a nonnegative number is returned indicating the size of the "
2412 "extended attribute value. On failure, -1 is returned and I<errno> is set "
2417 #: build/C/man2/getxattr.2:107 build/C/man2/removexattr.2:84 build/C/man2/setxattr.2:119
2423 #: build/C/man2/getxattr.2:116
2425 "The named attribute does not exist, or the process has no access to this "
2426 "attribute. (B<ENOATTR> is defined to be a synonym for B<ENODATA> in "
2427 "I<E<lt>attr/xattr.hE<gt>>.)"
2431 #: build/C/man2/getxattr.2:116 build/C/man2/listxattr.2:128 build/C/man2/removexattr.2:92 build/C/man2/setxattr.2:131
2437 #: build/C/man2/getxattr.2:119 build/C/man2/listxattr.2:131 build/C/man2/removexattr.2:95
2438 msgid "Extended attributes are not supported by the filesystem, or are disabled."
2442 #: build/C/man2/getxattr.2:119 build/C/man2/listxattr.2:131
2448 #: build/C/man2/getxattr.2:126
2449 msgid "The I<size> of the I<value> buffer is too small to hold the result."
2453 #: build/C/man2/getxattr.2:130 build/C/man2/listxattr.2:142 build/C/man2/removexattr.2:99 build/C/man2/setxattr.2:141
2454 msgid "In addition, the errors documented in B<stat>(2) can also occur."
2458 #: build/C/man2/getxattr.2:133 build/C/man2/listxattr.2:145 build/C/man2/removexattr.2:102 build/C/man2/setxattr.2:144
2460 "These system calls have been available on Linux since kernel 2.4; glibc "
2461 "support is provided since version 2.3."
2465 #. Andreas Gruenbacher,
2466 #. .RI < a.gruenbacher@computer.org >
2467 #. and the SGI XFS development team,
2468 #. .RI < linux-xfs@oss.sgi.com >.
2469 #. Please send any bug reports or comments to these addresses.
2471 #: build/C/man2/getxattr.2:141 build/C/man2/listxattr.2:153 build/C/man2/removexattr.2:110 build/C/man2/setxattr.2:152
2472 msgid "These system calls are Linux-specific."
2476 #: build/C/man2/getxattr.2:151
2478 "B<getfattr>(1), B<setfattr>(1), B<listxattr>(2), B<open>(2), "
2479 "B<removexattr>(2), B<setxattr>(2), B<stat>(2), B<attr>(5), B<symlink>(7)"
2483 #: build/C/man3/isfdtype.3:26
2489 #: build/C/man3/isfdtype.3:26
2495 #: build/C/man3/isfdtype.3:29
2496 msgid "isfdtype - test file type of a file descriptor"
2500 #: build/C/man3/isfdtype.3:33
2503 "B<#include E<lt>sys/stat.hE<gt>>\n"
2504 "B<#include E<lt>sys/socket.hE<gt>>\n"
2508 #: build/C/man3/isfdtype.3:35
2510 msgid "B<int isfdtype(int >I<fd>B<, int >I<fdtype>B<);>\n"
2514 #: build/C/man3/isfdtype.3:43
2515 msgid "B<isfdtype>():"
2519 #: build/C/man3/isfdtype.3:46
2521 msgid "Since glibc 2.20:"
2525 #: build/C/man3/isfdtype.3:49
2526 msgid "_DEFAULT_SOURCE"
2530 #: build/C/man3/isfdtype.3:49
2532 msgid "Before glibc 2.20:"
2536 #: build/C/man3/isfdtype.3:52
2537 msgid "_BSD_SOURCE || _SVID_SOURCE"
2541 #: build/C/man3/isfdtype.3:72
2543 "The B<isfdtype>() function tests whether the file descriptor I<fd> refers "
2544 "to a file of type I<fdtype>. The I<fdtype> argument specifies one of the "
2545 "B<S_IF*> constants defined in I<E<lt>sys/stat.hE<gt>> and documented in "
2546 "B<stat>(2) (e.g., B<S_IFREG>)."
2550 #: build/C/man3/isfdtype.3:83
2552 "The B<isfdtype>() function returns 1 if the file descriptor I<fd> is of "
2553 "type I<fdtype> and 0 if it is not. On error, -1 is returned and I<errno> is "
2554 "set to indicate the cause."
2558 #: build/C/man3/isfdtype.3:88
2560 "The B<isfdtype>() function can fail with any of the same errors as "
2565 #: build/C/man3/isfdtype.3:98
2567 "The B<isfdtype>() function is not specified in any standard, but did appear "
2568 "in the draft POSIX.1g standard. It is present on OpenBSD and Tru64 UNIX "
2569 "(where the required header file in both cases is just "
2570 "I<E<lt>sys/stat.hE<gt>>, as shown in the POSIX.1g draft), and possibly other "
2575 #: build/C/man3/isfdtype.3:102
2576 msgid "Portable applications should use B<fstat>(3) instead."
2580 #: build/C/man3/isfdtype.3:104
2585 #: build/C/man2/listxattr.2:25
2591 #: build/C/man2/listxattr.2:25 build/C/man2/removexattr.2:25 build/C/man2/setxattr.2:25
2597 #: build/C/man2/listxattr.2:28
2598 msgid "listxattr, llistxattr, flistxattr - list extended attribute names"
2602 #: build/C/man2/listxattr.2:39
2605 "B<ssize_t listxattr(const char\\ *>I<path>B<, char\\ *>I<list>B<, size_t "
2607 "B<ssize_t llistxattr(const char\\ *>I<path>B<, char\\ *>I<list>B<, size_t "
2609 "B<ssize_t flistxattr(int >I<fd>B<, char\\ *>I<list>B<, size_t "
2614 #: build/C/man2/listxattr.2:50
2616 "Extended attributes are name:value pairs associated with inodes (files, "
2617 "directories, symbolic links, etc.). They are extensions to the normal "
2618 "attributes which are associated with all inodes in the system (i.e., the "
2619 "B<stat>(2) data). A complete overview of extended attributes concepts can "
2620 "be found in B<attr>(5)."
2624 #: build/C/man2/listxattr.2:66
2626 "B<listxattr>() retrieves the list of extended attribute names associated "
2627 "with the given I<path> in the filesystem. The retrieved list is placed in "
2628 "I<list>, a caller-allocated buffer whose size (in bytes) is specified in the "
2629 "argument I<size>. The list is the set of (null-terminated) names, one after "
2630 "the other. Names of extended attributes to which the calling process does "
2631 "not have access may be omitted from the list. The length of the attribute "
2632 "name I<list> is returned."
2636 #: build/C/man2/listxattr.2:73
2638 "B<llistxattr>() is identical to B<listxattr>(), except in the case of a "
2639 "symbolic link, where the list of names of extended attributes associated "
2640 "with the link itself is retrieved, not the file that it refers to."
2644 #: build/C/man2/listxattr.2:83
2646 "B<flistxattr>() is identical to B<listxattr>(), only the open file referred "
2647 "to by I<fd> (as returned by B<open>(2)) is interrogated in place of "
2652 #: build/C/man2/listxattr.2:89
2654 "A single extended attribute I<name> is a simple null-terminated string. The "
2655 "name includes a namespace prefix; there may be several, disjoint namespaces "
2656 "associated with an individual inode."
2660 #: build/C/man2/listxattr.2:95
2662 "An empty buffer of I<size> zero can be passed into these calls to return the "
2663 "current size of the list of extended attribute names, which can be used to "
2664 "estimate the size of a buffer which is sufficiently large to hold the list "
2669 #: build/C/man2/listxattr.2:95
2675 #: build/C/man2/listxattr.2:100
2677 "The I<list> of names is returned as an unordered array of null-terminated "
2678 "character strings (attribute names are separated by null bytes "
2679 "(\\(aq\\e0\\(aq)), like this:"
2683 #: build/C/man2/listxattr.2:105
2685 msgid "user.name1\\e0system.name1\\e0user.name2\\e0\n"
2689 #: build/C/man2/listxattr.2:113
2691 "Filesystems like ext2, ext3 and XFS which implement POSIX ACLs using "
2692 "extended attributes, might return a I<list> like this:"
2696 #: build/C/man2/listxattr.2:118
2698 msgid "system.posix_acl_access\\e0system.posix_acl_default\\e0\n"
2702 #: build/C/man2/listxattr.2:127
2704 "On success, a nonnegative number is returned indicating the size of the "
2705 "extended attribute name list. On failure, -1 is returned and I<errno> is "
2706 "set appropriately."
2710 #: build/C/man2/listxattr.2:138
2711 msgid "The I<size> of the I<list> buffer is too small to hold the result."
2715 #: build/C/man2/listxattr.2:163
2717 "B<getfattr>(1), B<setfattr>(1), B<getxattr>(2), B<open>(2), "
2718 "B<removexattr>(2), B<setxattr>(2), B<stat>(2), B<attr>(5), B<symlink>(7)"
2722 #: build/C/man2/mount.2:40
2728 #: build/C/man2/mount.2:40
2734 #: build/C/man2/mount.2:43
2735 msgid "mount - mount filesystem"
2739 #: build/C/man2/mount.2:46 build/C/man2/umount.2:36
2741 msgid "B<#include E<lt>sys/mount.hE<gt>>\n"
2745 #: build/C/man2/mount.2:50
2748 "B<int mount(const char *>I<source>B<, const char *>I<target>B<,>\n"
2749 "B< const char *>I<filesystemtype>B<, unsigned long "
2750 ">I<mountflags>B<,>\n"
2751 "B< const void *>I<data>B<);>\n"
2755 #: build/C/man2/mount.2:58
2757 "B<mount>() attaches the filesystem specified by I<source> (which is often a "
2758 "device name, but can also be a directory name or a dummy) to the directory "
2759 "specified by I<target>."
2763 #: build/C/man2/mount.2:62
2765 "Appropriate privilege (Linux: the B<CAP_SYS_ADMIN> capability) is required "
2766 "to mount filesystems."
2769 #. Multiple mounts on same mount point: since 2.3.99pre7.
2771 #: build/C/man2/mount.2:67
2773 "Since Linux 2.4 a single filesystem can be visible at multiple mount points, "
2774 "and multiple mounts can be stacked on the same mount point."
2778 #: build/C/man2/mount.2:76
2780 "Values for the I<filesystemtype> argument supported by the kernel are listed "
2781 "in I</proc/filesystems> (e.g., \"minix\", \"ext2\", \"ext3\", \"jfs\", "
2782 "\"xfs\", \"reiserfs\", \"msdos\", \"proc\", \"nfs\", \"iso9660\"). Further "
2783 "types may become available when the appropriate modules are loaded."
2786 #. (as defined in \fI<linux/fs.h>\fP for libc4 and libc5
2787 #. and in \fI<sys/mount.h>\fP for glibc2)
2788 #. FIXME 2.6.15 added flags for "shared subtree" functionality:
2789 #. MS_UNBINDABLE, MS_PRIVATE, MS_SHARED, MS_SLAVE
2792 #. All mounts are private by default. Previously shared mounts
2793 #. can be remarked PRIVATE.
2795 #. Mount points that are marked SHARED propagate mount events
2796 #. to one another after bing cloned.
2798 #. A previously shared mount point can be marked SALVE, meaning
2799 #. it receives propagated events, but does not propagate events.
2801 #. mounts cannot be bound into other places, and will not be
2802 #. propagated into new subtrees
2803 #. mount --make-rshared ==> MS_SHARED | MS_REC
2805 #. These settings are visible in proc/mountinfo
2807 #. These need to be documented on this page.
2809 #. Documentation/filesystems/sharedsubtree.txt
2811 #. http://lwn.net/Articles/159077/
2813 #. http://myweb.sudhaa.com:2022/~ram/sharedsubtree/paper/sharedsubtree.1.pdf
2814 #. Shared-Subtree Concept, Implementation, and Applications in Linux
2815 #. Al Viro viro@ftp.linux.org.uk
2816 #. Ram Pai linuxram@us.ibm.com
2818 #. http://foss.in/2005/slides/sharedsubtree1.pdf
2819 #. Shared Subtree Concept and Implementation in the Linux Kernel
2822 #. http://www.ibm.com/developerworks/linux/library/l-mount-namespaces/index.html
2823 #. Applying mount namespaces
2825 #. Uncover practical applications for advanced Linux mounts features
2826 #. Serge E. Hallyn (sergeh@us.ibm.com), Software Engineer, IBM
2827 #. Ram Pai (linuxram@us.ibm.com), Software Engineer, IBM
2828 #. Date: 17 Sep 2007
2830 #. FIXME 2.6.25 Added MS_I_VERSION, which needs to be documented.
2832 #: build/C/man2/mount.2:130
2834 "The I<mountflags> argument may have the magic number 0xC0ED (B<MS_MGC_VAL>) "
2835 "in the top 16 bits (this was required in kernel versions prior to 2.4, but "
2836 "is no longer required and ignored if specified), and various mount flags in "
2837 "the low order 16 bits:"
2841 #: build/C/man2/mount.2:130
2843 msgid "B<MS_BIND> (Linux 2.4 onward)"
2846 #. since 2.4.0-test9
2847 #. with the exception of the "hidden" MS_REC mountflags bit
2849 #: build/C/man2/mount.2:149
2851 "Perform a bind mount, making a file or a directory subtree visible at "
2852 "another point within a filesystem. Bind mounts may cross filesystem "
2853 "boundaries and span B<chroot>(2) jails. The I<filesystemtype> and I<data> "
2854 "arguments are ignored. Up until Linux 2.6.26, I<mountflags> was also "
2855 "ignored (the bind mount has the same mount options as the underlying mount "
2860 #: build/C/man2/mount.2:149
2862 msgid "B<MS_DIRSYNC> (since Linux 2.5.19)"
2866 #: build/C/man2/mount.2:155
2868 "Make directory changes on this filesystem synchronous. (This property can "
2869 "be obtained for individual directories or subtrees using B<chattr>(1).)"
2873 #: build/C/man2/mount.2:155
2875 msgid "B<MS_MANDLOCK>"
2878 #. FIXME Describe the MS_MOVE flag in more detail
2880 #: build/C/man2/mount.2:162
2882 "Permit mandatory locking on files in this filesystem. (Mandatory locking "
2883 "must still be enabled on a per-file basis, as described in B<fcntl>(2).)"
2887 #: build/C/man2/mount.2:162
2893 #: build/C/man2/mount.2:173
2895 "Move a subtree. I<source> specifies an existing mount point and I<target> "
2896 "specifies the new location. The move is atomic: at no point is the subtree "
2897 "unmounted. The I<filesystemtype>, I<mountflags>, and I<data> arguments are "
2902 #: build/C/man2/mount.2:173
2904 msgid "B<MS_NOATIME>"
2908 #: build/C/man2/mount.2:176
2909 msgid "Do not update access times for (all types of) files on this filesystem."
2913 #: build/C/man2/mount.2:176
2919 #: build/C/man2/mount.2:179
2920 msgid "Do not allow access to devices (special files) on this filesystem."
2924 #: build/C/man2/mount.2:179
2926 msgid "B<MS_NODIRATIME>"
2930 #: build/C/man2/mount.2:188
2932 "Do not update access times for directories on this filesystem. This flag "
2933 "provides a subset of the functionality provided by B<MS_NOATIME>; that is, "
2934 "B<MS_NOATIME> implies B<MS_NODIRATIME>."
2938 #: build/C/man2/mount.2:188
2940 msgid "B<MS_NOEXEC>"
2943 #. (Possibly useful for a filesystem that contains non-Linux executables.
2944 #. Often used as a security feature, e.g., to make sure that restricted
2945 #. users cannot execute files uploaded using ftp or so.)
2947 #: build/C/man2/mount.2:194
2948 msgid "Do not allow programs to be executed from this filesystem."
2952 #: build/C/man2/mount.2:194
2954 msgid "B<MS_NOSUID>"
2957 #. (This is a security feature to prevent users executing set-user-ID and
2958 #. set-group-ID programs from removable disk devices.)
2960 #: build/C/man2/mount.2:200
2962 "Do not honor set-user-ID and set-group-ID bits when executing programs from "
2967 #: build/C/man2/mount.2:200
2969 msgid "B<MS_RDONLY>"
2973 #. FIXME Document MS_REC, available since 2.4.11.
2974 #. This flag has meaning in conjunction with MS_BIND and
2975 #. also with the shared subtree flags.
2977 #: build/C/man2/mount.2:207
2978 msgid "Mount filesystem read-only."
2982 #: build/C/man2/mount.2:207
2984 msgid "B<MS_RELATIME> (since Linux 2.6.20)"
2987 #. Matthew Garrett notes in the patch that added this behavior
2988 #. that this lets utilities such as tmpreaper (which deletes
2989 #. files based on last access time) work correctly.
2991 #: build/C/man2/mount.2:228
2993 "When a file on this filesystem is accessed, update the file's last access "
2994 "time (atime) only if the current value of atime is less than or equal to the "
2995 "file's last modification time (mtime) or last status change time (ctime). "
2996 "This option is useful for programs, such as B<mutt>(1), that need to know "
2997 "when a file has been read since it was last modified. Since Linux 2.6.30, "
2998 "the kernel defaults to the behavior provided by this flag (unless "
2999 "B<MS_NOATIME> was specified), and the B<MS_STRICTATIME> flag is required to "
3000 "obtain traditional semantics. In addition, since Linux 2.6.30, the file's "
3001 "last access time is always updated if it is more than 1 day old."
3005 #: build/C/man2/mount.2:228
3007 msgid "B<MS_REMOUNT>"
3011 #: build/C/man2/mount.2:251
3013 "Remount an existing mount. This allows you to change the I<mountflags> and "
3014 "I<data> of an existing mount without having to unmount and remount the "
3015 "filesystem. I<target> should be the same value specified in the initial "
3016 "B<mount>() call; I<source> and I<filesystemtype> are ignored. The "
3017 "I<mountflags> and I<data> arguments should match the values used in the "
3018 "original B<mount>() call, except for those parameters that are being "
3019 "deliberately changed."
3023 #: build/C/man2/mount.2:266
3025 "The following I<mountflags> can be changed: B<MS_RDONLY>, B<MS_SYNCHRONOUS>, "
3026 "B<MS_MANDLOCK>; before kernel 2.6.16, the following could also be changed: "
3027 "B<MS_NOATIME> and B<MS_NODIRATIME>; and, additionally, before kernel 2.4.10, "
3028 "the following could also be changed: B<MS_NOSUID>, B<MS_NODEV>, "
3033 #: build/C/man2/mount.2:266
3035 msgid "B<MS_SILENT> (since Linux 2.6.17)"
3039 #: build/C/man2/mount.2:274
3041 "Suppress the display of certain (I<printk>()) warning messages in the "
3042 "kernel log. This flag supersedes the misnamed and obsolete B<MS_VERBOSE> "
3043 "flag (available since Linux 2.4.12), which has the same meaning."
3047 #: build/C/man2/mount.2:274
3049 msgid "B<MS_STRICTATIME> (since Linux 2.6.30)"
3053 #: build/C/man2/mount.2:284
3055 "Always update the last access time (atime) when files on this filesystem are "
3056 "accessed. (This was the default behavior before Linux 2.6.30.) Specifying "
3057 "this flag overrides the effect of setting the B<MS_NOATIME> and "
3058 "B<MS_RELATIME> flags."
3062 #: build/C/man2/mount.2:284
3064 msgid "B<MS_SYNCHRONOUS>"
3068 #: build/C/man2/mount.2:292
3070 "Make writes on this filesystem synchronous (as though the B<O_SYNC> flag to "
3071 "B<open>(2) was specified for all file opens to this filesystem)."
3075 #: build/C/man2/mount.2:304
3077 "From Linux 2.4 onward, the B<MS_NODEV>, B<MS_NOEXEC>, and B<MS_NOSUID> flags "
3078 "are settable on a per-mount-point basis. From kernel 2.6.16 onward, "
3079 "B<MS_NOATIME> and B<MS_NODIRATIME> are also settable on a per-mount-point "
3080 "basis. The B<MS_RELATIME> flag is also settable on a per-mount-point basis."
3084 #: build/C/man2/mount.2:313
3086 "The I<data> argument is interpreted by the different filesystems. Typically "
3087 "it is a string of comma-separated options understood by this filesystem. "
3088 "See B<mount>(8) for details of the options available for each filesystem "
3093 #: build/C/man2/mount.2:318 build/C/man2/stat.2:522 build/C/man2/statfs.2:162 build/C/man3/statvfs.3:101 build/C/man2/umount.2:104
3095 "On success, zero is returned. On error, -1 is returned, and I<errno> is set "
3100 #: build/C/man2/mount.2:324 build/C/man2/umount.2:110
3102 "The error values given below result from filesystem type independent "
3103 "errors. Each filesystem type may have its own special errors and its own "
3104 "special behavior. See the Linux kernel source code for details."
3108 #: build/C/man2/mount.2:324 build/C/man2/spu_create.2:173 build/C/man2/stat.2:523 build/C/man2/statfs.2:163 build/C/man3/statvfs.3:102
3113 #. mtk: Probably: write permission is required for MS_BIND, with
3114 #. the error EPERM if not present; CAP_DAC_OVERRIDE is required.
3116 #: build/C/man2/mount.2:339
3118 "A component of a path was not searchable. (See also B<path_resolution>(7).) "
3119 "Or, mounting a read-only filesystem was attempted without giving the "
3120 "B<MS_RDONLY> flag. Or, the block device I<source> is located on a "
3121 "filesystem mounted with the B<MS_NODEV> option."
3125 #: build/C/man2/mount.2:339 build/C/man2/umount.2:117
3131 #: build/C/man2/mount.2:351
3133 "I<source> is already mounted. Or, it cannot be remounted read-only, because "
3134 "it still holds files open for writing. Or, it cannot be mounted on "
3135 "I<target> because I<target> is still busy (it is the working directory of "
3136 "some thread, the mount point of another device, has open files, etc.)."
3140 #: build/C/man2/mount.2:351 build/C/man2/spu_create.2:181 build/C/man2/spu_run.2:158 build/C/man2/stat.2:534 build/C/man2/statfs.2:175 build/C/man3/statvfs.3:114 build/C/man2/sysfs.2:80 build/C/man2/umount.2:121 build/C/man2/ustat.2:80
3146 #: build/C/man2/mount.2:354
3147 msgid "One of the pointer arguments points outside the user address space."
3151 #: build/C/man2/mount.2:369
3153 "I<source> had an invalid superblock. Or, a remount (B<MS_REMOUNT>) was "
3154 "attempted, but I<source> was not already mounted on I<target>. Or, a move "
3155 "(B<MS_MOVE>) was attempted, but I<source> was not a mount point, or was "
3160 #: build/C/man2/mount.2:369 build/C/man2/spu_create.2:192 build/C/man2/stat.2:537 build/C/man2/statfs.2:187 build/C/man3/statvfs.3:126
3166 #: build/C/man2/mount.2:376
3168 "Too many links encountered during pathname resolution. Or, a move was "
3169 "attempted, while I<target> is a descendant of I<source>."
3173 #: build/C/man2/mount.2:376 build/C/man2/spu_create.2:196
3179 #: build/C/man2/mount.2:380
3180 msgid "(In case no block device is required:) Table of dummy devices is full."
3184 #: build/C/man2/mount.2:380 build/C/man2/spu_create.2:199 build/C/man2/stat.2:540 build/C/man2/statfs.2:192 build/C/man3/statvfs.3:131 build/C/man2/umount.2:143
3186 msgid "B<ENAMETOOLONG>"
3190 #: build/C/man2/mount.2:384 build/C/man2/umount.2:147
3191 msgid "A pathname was longer than B<MAXPATHLEN>."
3195 #: build/C/man2/mount.2:384 build/C/man2/spu_create.2:206
3201 #: build/C/man2/mount.2:388
3202 msgid "I<filesystemtype> not configured in the kernel."
3206 #: build/C/man2/mount.2:388 build/C/man2/spu_create.2:210 build/C/man2/stat.2:544 build/C/man2/statfs.2:197 build/C/man3/statvfs.3:136 build/C/man2/umount.2:147
3212 #: build/C/man2/mount.2:391 build/C/man2/umount.2:150
3213 msgid "A pathname was empty or had a nonexistent component."
3217 #: build/C/man2/mount.2:391 build/C/man2/spu_create.2:215 build/C/man2/spu_run.2:179 build/C/man2/stat.2:551 build/C/man2/statfs.2:203 build/C/man3/statvfs.3:142 build/C/man2/umount.2:150
3223 #: build/C/man2/mount.2:394 build/C/man2/umount.2:153
3224 msgid "The kernel could not allocate a free page to copy filenames or data into."
3228 #: build/C/man2/mount.2:394
3234 #: build/C/man2/mount.2:398
3235 msgid "I<source> is not a block device (and a device was required)."
3239 #: build/C/man2/mount.2:398 build/C/man2/spu_create.2:228 build/C/man2/stat.2:554 build/C/man2/stat.2:589 build/C/man2/statfs.2:209 build/C/man3/statvfs.3:148
3245 #: build/C/man2/mount.2:404
3246 msgid "I<target>, or a prefix of I<source>, is not a directory."
3250 #: build/C/man2/mount.2:404
3256 #: build/C/man2/mount.2:409
3257 msgid "The major number of the block device I<source> is out of range."
3261 #: build/C/man2/mount.2:409 build/C/man2/spu_create.2:233 build/C/man2/umount.2:153
3267 #: build/C/man2/mount.2:412 build/C/man2/umount.2:156
3268 msgid "The caller does not have the required privileges."
3271 #. FIXME . Definitions of the so-far-undocumented MS_UNBINDABLE, MS_PRIVATE,
3272 #. MS_SHARED, and MS_SLAVE were (also) only added to glibc headers in 2.12.
3274 #: build/C/man2/mount.2:423
3276 "The definitions of B<MS_DIRSYNC>, B<MS_MOVE>, B<MS_REC>, B<MS_RELATIME>, and "
3277 "B<MS_STRICTATIME> were added to glibc headers in version 2.12."
3281 #: build/C/man2/mount.2:426
3283 "This function is Linux-specific and should not be used in programs intended "
3288 #: build/C/man2/mount.2:435
3290 "The original B<MS_SYNC> flag was renamed B<MS_SYNCHRONOUS> in 1.1.69 when a "
3291 "different B<MS_SYNC> was added to I<E<lt>mman.hE<gt>>."
3294 #. The change is in patch-2.4.0-prerelease.
3296 #: build/C/man2/mount.2:444
3298 "Before Linux 2.4 an attempt to execute a set-user-ID or set-group-ID program "
3299 "on a filesystem mounted with B<MS_NOSUID> would fail with B<EPERM>. Since "
3300 "Linux 2.4 the set-user-ID and set-group-ID bits are just silently ignored in "
3305 #: build/C/man2/mount.2:444
3307 msgid "Per-process namespaces"
3311 #: build/C/man2/mount.2:455
3313 "Starting with kernel 2.4.19, Linux provides per-process mount namespaces. A "
3314 "mount namespace is the set of filesystem mounts that are visible to a "
3315 "process. Mount-point namespaces can be (and usually are) shared between "
3316 "multiple processes, and changes to the namespace (i.e., mounts and unmounts) "
3317 "by one process are visible to all other processes sharing the same "
3318 "namespace. (The pre-2.4.19 Linux situation can be considered as one in "
3319 "which a single namespace was shared by every process on the system.)"
3323 #: build/C/man2/mount.2:461
3325 "A child process created by B<fork>(2) shares its parent's mount namespace; "
3326 "the mount namespace is preserved across an B<execve>(2)."
3330 #: build/C/man2/mount.2:481
3332 "A process can obtain a private mount namespace if: it was created using the "
3333 "B<clone>(2) B<CLONE_NEWNS> flag, in which case its new namespace is "
3334 "initialized to be a I<copy> of the namespace of the process that called "
3335 "B<clone>(2); or it calls B<unshare>(2) with the B<CLONE_NEWNS> flag, which "
3336 "causes the caller's mount namespace to obtain a private copy of the "
3337 "namespace that it was previously sharing with other processes, so that "
3338 "future mounts and unmounts by the caller are invisible to other processes "
3339 "(except child processes that the caller subsequently creates) and vice "
3344 #: build/C/man2/mount.2:488
3346 "The Linux-specific I</proc/PID/mounts> file exposes the list of mount points "
3347 "in the mount namespace of the process with the specified ID; see B<proc>(5) "
3352 #: build/C/man2/mount.2:495
3354 "B<umount>(2), B<namespaces>(7), B<path_resolution>(7), B<lsblk>(8), "
3355 "B<mount>(8), B<umount>(8)"
3359 #: build/C/man7/path_resolution.7:25
3361 msgid "PATH_RESOLUTION"
3365 #: build/C/man7/path_resolution.7:25
3371 #: build/C/man7/path_resolution.7:28
3372 msgid "path_resolution - how a pathname is resolved to a file"
3376 #: build/C/man7/path_resolution.7:31
3378 "Some UNIX/Linux system calls have as parameter one or more filenames. A "
3379 "filename (or pathname) is resolved as follows."
3383 #: build/C/man7/path_resolution.7:31
3385 msgid "Step 1: start of the resolution process"
3389 #: build/C/man7/path_resolution.7:50
3391 "If the pathname starts with the \\(aq/\\(aq character, the starting lookup "
3392 "directory is the root directory of the calling process. (A process inherits "
3393 "its root directory from its parent. Usually this will be the root directory "
3394 "of the file hierarchy. A process may get a different root directory by use "
3395 "of the B<chroot>(2) system call. A process may get an entirely private "
3396 "mount namespace in case it\\(emor one of its ancestors\\(emwas started by an "
3397 "invocation of the B<clone>(2) system call that had the B<CLONE_NEWNS> flag "
3398 "set.) This handles the \\(aq/\\(aq part of the pathname."
3402 #: build/C/man7/path_resolution.7:58
3404 "If the pathname does not start with the \\(aq/\\(aq character, the starting "
3405 "lookup directory of the resolution process is the current working directory "
3406 "of the process. (This is also inherited from the parent. It can be changed "
3407 "by use of the B<chdir>(2) system call.)"
3411 #: build/C/man7/path_resolution.7:61
3413 "Pathnames starting with a \\(aq/\\(aq character are called absolute "
3414 "pathnames. Pathnames not starting with a \\(aq/\\(aq are called relative "
3419 #: build/C/man7/path_resolution.7:61
3421 msgid "Step 2: walk along the path"
3425 #: build/C/man7/path_resolution.7:66
3427 "Set the current lookup directory to the starting lookup directory. Now, for "
3428 "each nonfinal component of the pathname, where a component is a substring "
3429 "delimited by \\(aq/\\(aq characters, this component is looked up in the "
3430 "current lookup directory."
3434 #: build/C/man7/path_resolution.7:72
3436 "If the process does not have search permission on the current lookup "
3437 "directory, an B<EACCES> error is returned (\"Permission denied\")."
3441 #: build/C/man7/path_resolution.7:77
3443 "If the component is not found, an B<ENOENT> error is returned (\"No such "
3444 "file or directory\")."
3448 #: build/C/man7/path_resolution.7:82
3450 "If the component is found, but is neither a directory nor a symbolic link, "
3451 "an B<ENOTDIR> error is returned (\"Not a directory\")."
3455 #: build/C/man7/path_resolution.7:86
3457 "If the component is found and is a directory, we set the current lookup "
3458 "directory to that directory, and go to the next component."
3462 #. presently: max recursion depth during symlink resolution: 5
3463 #. max total number of symbolic links followed: 40
3464 #. _POSIX_SYMLOOP_MAX is 8
3466 #: build/C/man7/path_resolution.7:110
3468 "If the component is found and is a symbolic link (symlink), we first resolve "
3469 "this symbolic link (with the current lookup directory as starting lookup "
3470 "directory). Upon error, that error is returned. If the result is not a "
3471 "directory, an B<ENOTDIR> error is returned. If the resolution of the "
3472 "symlink is successful and returns a directory, we set the current lookup "
3473 "directory to that directory, and go to the next component. Note that the "
3474 "resolution process here involves recursion. In order to protect the kernel "
3475 "against stack overflow, and also to protect against denial of service, there "
3476 "are limits on the maximum recursion depth, and on the maximum number of "
3477 "symbolic links followed. An B<ELOOP> error is returned when the maximum is "
3478 "exceeded (\"Too many levels of symbolic links\")."
3482 #: build/C/man7/path_resolution.7:110
3484 msgid "Step 3: find the final entry"
3488 #: build/C/man7/path_resolution.7:122
3490 "The lookup of the final component of the pathname goes just like that of all "
3491 "other components, as described in the previous step, with two differences: "
3492 "(i) the final component need not be a directory (at least as far as the path "
3493 "resolution process is concerned\\(emit may have to be a directory, or a "
3494 "nondirectory, because of the requirements of the specific system call), and "
3495 "(ii) it is not necessarily an error if the component is not found\\(emmaybe "
3496 "we are just creating it. The details on the treatment of the final entry "
3497 "are described in the manual pages of the specific system calls."
3501 #: build/C/man7/path_resolution.7:122
3507 #: build/C/man7/path_resolution.7:126
3509 "By convention, every directory has the entries \".\" and \"..\", which refer "
3510 "to the directory itself and to its parent directory, respectively."
3514 #: build/C/man7/path_resolution.7:130
3516 "The path resolution process will assume that these entries have their "
3517 "conventional meanings, regardless of whether they are actually present in "
3518 "the physical filesystem."
3522 #: build/C/man7/path_resolution.7:132
3523 msgid "One cannot walk down past the root: \"/..\" is the same as \"/\"."
3527 #: build/C/man7/path_resolution.7:132
3529 msgid "Mount points"
3533 #: build/C/man7/path_resolution.7:136
3535 "After a \"mount dev path\" command, the pathname \"path\" refers to the root "
3536 "of the filesystem hierarchy on the device \"dev\", and no longer to whatever "
3537 "it referred to earlier."
3541 #: build/C/man7/path_resolution.7:140
3543 "One can walk out of a mounted filesystem: \"path/..\" refers to the parent "
3544 "directory of \"path\", outside of the filesystem hierarchy on \"dev\"."
3548 #: build/C/man7/path_resolution.7:140
3550 msgid "Trailing slashes"
3554 #: build/C/man7/path_resolution.7:146
3556 "If a pathname ends in a \\(aq/\\(aq, that forces resolution of the preceding "
3557 "component as in Step 2: it has to exist and resolve to a directory. "
3558 "Otherwise, a trailing \\(aq/\\(aq is ignored. (Or, equivalently, a pathname "
3559 "with a trailing \\(aq/\\(aq is equivalent to the pathname obtained by "
3560 "appending \\(aq.\\(aq to it.)"
3564 #: build/C/man7/path_resolution.7:146
3566 msgid "Final symlink"
3570 #: build/C/man7/path_resolution.7:155
3572 "If the last component of a pathname is a symbolic link, then it depends on "
3573 "the system call whether the file referred to will be the symbolic link or "
3574 "the result of path resolution on its contents. For example, the system call "
3575 "B<lstat>(2) will operate on the symlink, while B<stat>(2) operates on the "
3576 "file pointed to by the symlink."
3580 #: build/C/man7/path_resolution.7:155
3582 msgid "Length limit"
3586 #: build/C/man7/path_resolution.7:162
3588 "There is a maximum length for pathnames. If the pathname (or some "
3589 "intermediate pathname obtained while resolving symbolic links) is too long, "
3590 "an B<ENAMETOOLONG> error is returned (\"Filename too long\")."
3594 #: build/C/man7/path_resolution.7:162
3596 msgid "Empty pathname"
3600 #: build/C/man7/path_resolution.7:169
3602 "In the original UNIX, the empty pathname referred to the current directory. "
3603 "Nowadays POSIX decrees that an empty pathname must not be resolved "
3604 "successfully. Linux returns B<ENOENT> in this case."
3608 #: build/C/man7/path_resolution.7:169
3614 #: build/C/man7/path_resolution.7:182
3616 "The permission bits of a file consist of three groups of three bits, cf.\\& "
3617 "B<chmod>(1) and B<stat>(2). The first group of three is used when the "
3618 "effective user ID of the calling process equals the owner ID of the file. "
3619 "The second group of three is used when the group ID of the file either "
3620 "equals the effective group ID of the calling process, or is one of the "
3621 "supplementary group IDs of the calling process (as set by B<setgroups>(2)). "
3622 "When neither holds, the third group is used."
3626 #: build/C/man7/path_resolution.7:186
3628 "Of the three bits used, the first bit determines read permission, the second "
3629 "write permission, and the last execute permission in case of ordinary files, "
3630 "or search permission in case of directories."
3634 #: build/C/man7/path_resolution.7:191
3636 "Linux uses the fsuid instead of the effective user ID in permission checks. "
3637 "Ordinarily the fsuid will equal the effective user ID, but the fsuid can be "
3638 "changed by the system call B<setfsuid>(2)."
3642 #: build/C/man7/path_resolution.7:199
3644 "(Here \"fsuid\" stands for something like \"filesystem user ID\". The "
3645 "concept was required for the implementation of a user space NFS server at a "
3646 "time when processes could send a signal to a process with the same effective "
3647 "user ID. It is obsolete now. Nobody should use B<setfsuid>(2).)"
3650 #. FIXME . say something about filesystem mounted read-only ?
3652 #: build/C/man7/path_resolution.7:205
3654 "Similarly, Linux uses the fsgid (\"filesystem group ID\") instead of the "
3655 "effective group ID. See B<setfsgid>(2)."
3659 #: build/C/man7/path_resolution.7:205
3661 msgid "Bypassing permission checks: superuser and capabilities"
3664 #. (but for exec at least one x bit must be set) -- AEB
3665 #. but there is variation across systems on this point: for
3666 #. example, HP-UX and Tru64 are as described by AEB. However,
3667 #. on some implementations (e.g., Solaris, FreeBSD),
3668 #. access(X_OK) by superuser will report success, regardless
3669 #. of the file's execute permission bits. -- MTK (Oct 05)
3671 #: build/C/man7/path_resolution.7:216
3673 "On a traditional UNIX system, the superuser (I<root>, user ID 0) is "
3674 "all-powerful, and bypasses all permissions restrictions when accessing "
3679 #: build/C/man7/path_resolution.7:224
3681 "On Linux, superuser privileges are divided into capabilities (see "
3682 "B<capabilities>(7)). Two capabilities are relevant for file permissions "
3683 "checks: B<CAP_DAC_OVERRIDE> and B<CAP_DAC_READ_SEARCH>. (A process has "
3684 "these capabilities if its fsuid is 0.)"
3688 #: build/C/man7/path_resolution.7:230
3690 "The B<CAP_DAC_OVERRIDE> capability overrides all permission checking, but "
3691 "grants execute permission only when at least one of the file's three execute "
3692 "permission bits is set."
3695 #. FIXME . say something about immutable files
3696 #. FIXME . say something about ACLs
3698 #: build/C/man7/path_resolution.7:237
3700 "The B<CAP_DAC_READ_SEARCH> capability grants read and search permission on "
3701 "directories, and read permission on ordinary files."
3705 #: build/C/man7/path_resolution.7:242
3706 msgid "B<readlink>(2), B<capabilities>(7), B<credentials>(7), B<symlink>(7)"
3710 #: build/C/man2/removexattr.2:25
3716 #: build/C/man2/removexattr.2:28
3717 msgid "removexattr, lremovexattr, fremovexattr - remove an extended attribute"
3721 #: build/C/man2/removexattr.2:37
3724 "B<int removexattr(const char\\ *>I<path>B<, const char\\ *>I<name>B<);>\n"
3725 "B<int lremovexattr(const char\\ *>I<path>B<, const char\\ *>I<name>B<);>\n"
3726 "B<int fremovexattr(int >I<fd>B<, const char\\ *>I<name>B<);>\n"
3730 #: build/C/man2/removexattr.2:49
3732 "Extended attributes are I<name>:value pairs associated with inodes (files, "
3733 "directories, symbolic links, etc.). They are extensions to the normal "
3734 "attributes which are associated with all inodes in the system (i.e., the "
3735 "B<stat>(2) data). A complete overview of extended attributes concepts can "
3736 "be found in B<attr>(5)."
3740 #: build/C/man2/removexattr.2:56
3742 "B<removexattr>() removes the extended attribute identified by I<name> and "
3743 "associated with the given I<path> in the filesystem."
3747 #: build/C/man2/removexattr.2:62
3749 "B<lremovexattr>() is identical to B<removexattr>(), except in the case of a "
3750 "symbolic link, where the extended attribute is removed from the link itself, "
3751 "not the file that it refers to."
3755 #: build/C/man2/removexattr.2:72
3757 "B<fremovexattr>() is identical to B<removexattr>(), only the extended "
3758 "attribute is removed from the open file referred to by I<fd> (as returned by "
3759 "B<open>(2)) in place of I<path>."
3763 #: build/C/man2/removexattr.2:78
3765 "An extended attribute name is a simple null-terminated string. The I<name> "
3766 "includes a namespace prefix; there may be several, disjoint namespaces "
3767 "associated with an individual inode."
3771 #: build/C/man2/removexattr.2:83 build/C/man2/setxattr.2:110
3773 "On success, zero is returned. On failure, -1 is returned and I<errno> is "
3774 "set appropriately."
3778 #: build/C/man2/removexattr.2:92
3780 "The named attribute does not exist. (B<ENOATTR> is defined to be a synonym "
3781 "for B<ENODATA> in I<E<lt>attr/xattr.hE<gt>>.)"
3785 #: build/C/man2/removexattr.2:120
3787 "B<getfattr>(1), B<setfattr>(1), B<getxattr>(2), B<listxattr>(2), B<open>(2), "
3788 "B<setxattr>(2), B<stat>(2), B<attr>(5), B<symlink>(7)"
3792 #: build/C/man2/setxattr.2:25
3798 #: build/C/man2/setxattr.2:28
3799 msgid "setxattr, lsetxattr, fsetxattr - set an extended attribute value"
3803 #: build/C/man2/setxattr.2:40
3806 "B<int setxattr(const char\\ *>I<path>B<, const char\\ *>I<name>B<,>\n"
3807 "B< const void\\ *>I<value>B<, size_t >I<size>B<, int "
3809 "B<int lsetxattr(const char\\ *>I<path>B<, const char\\ *>I<name>B<,>\n"
3810 "B< const void\\ *>I<value>B<, size_t >I<size>B<, int "
3812 "B<int fsetxattr(int >I<fd>B<, const char\\ *>I<name>B<,>\n"
3813 "B< const void\\ *>I<value>B<, size_t >I<size>B<, int "
3818 #: build/C/man2/setxattr.2:67
3820 "B<setxattr>() sets the I<value> of the extended attribute identified by "
3821 "I<name> and associated with the given I<path> in the filesystem. The "
3822 "I<size> of the I<value> must be specified."
3826 #: build/C/man2/setxattr.2:73
3828 "B<lsetxattr>() is identical to B<setxattr>(), except in the case of a "
3829 "symbolic link, where the extended attribute is set on the link itself, not "
3830 "the file that it refers to."
3834 #: build/C/man2/setxattr.2:83
3836 "B<fsetxattr>() is identical to B<setxattr>(), only the extended attribute "
3837 "is set on the open file referred to by I<fd> (as returned by B<open>(2)) in "
3842 #: build/C/man2/setxattr.2:93
3844 "An extended attribute name is a simple null-terminated string. The I<name> "
3845 "includes a namespace prefix; there may be several, disjoint namespaces "
3846 "associated with an individual inode. The I<value> of an extended attribute "
3847 "is a chunk of arbitrary textual or binary data of specified length."
3851 #: build/C/man2/setxattr.2:105
3853 "The I<flags> argument can be used to refine the semantics of the operation. "
3854 "B<XATTR_CREATE> specifies a pure create, which fails if the named attribute "
3855 "exists already. B<XATTR_REPLACE> specifies a pure replace operation, which "
3856 "fails if the named attribute does not already exist. By default (no flags), "
3857 "the extended attribute will be created if need be, or will simply replace "
3858 "the value if the attribute exists."
3862 #: build/C/man2/setxattr.2:111
3868 #: build/C/man2/setxattr.2:115
3870 "Disk quota limits meant that there is insufficient space remaining to store "
3871 "the extended attribute."
3875 #: build/C/man2/setxattr.2:115 build/C/man2/spu_create.2:178
3881 #: build/C/man2/setxattr.2:119
3882 msgid "B<XATTR_CREATE> was specified, and the attribute exists already."
3886 #: build/C/man2/setxattr.2:128
3888 "B<XATTR_REPLACE> was specified, and the attribute does not exist. "
3889 "(B<ENOATTR> is defined to be a synonym for B<ENODATA> in "
3890 "I<E<lt>attr/xattr.hE<gt>>.)"
3894 #: build/C/man2/setxattr.2:128 build/C/man2/spu_create.2:218
3900 #: build/C/man2/setxattr.2:131
3901 msgid "There is insufficient space remaining to store the extended attribute."
3905 #: build/C/man2/setxattr.2:137
3907 "Extended attributes are not supported by the filesystem, or are disabled, "
3908 "I<errno> is set to B<ENOTSUP>."
3912 #: build/C/man2/setxattr.2:162
3914 "B<getfattr>(1), B<setfattr>(1), B<getxattr>(2), B<listxattr>(2), B<open>(2), "
3915 "B<removexattr>(2), B<stat>(2), B<attr>(5), B<symlink>(7)"
3919 #: build/C/man2/spu_create.2:25
3925 #: build/C/man2/spu_create.2:25 build/C/man2/spu_run.2:26
3931 #: build/C/man2/spu_create.2:28
3932 msgid "spu_create - create a new spu context"
3936 #: build/C/man2/spu_create.2:32
3939 "B<#include E<lt>sys/types.hE<gt>>\n"
3940 "B<#include E<lt>sys/spu.hE<gt>>\n"
3944 #: build/C/man2/spu_create.2:36
3947 "B<int spu_create(const char *>I<pathname>B<, int >I<flags>B<, mode_t "
3949 "B<int spu_create(const char *>I<pathname>B<, int >I<flags>B<, mode_t "
3951 "B< int >I<neighbor_fd>B<);>\n"
3955 #: build/C/man2/spu_create.2:40 build/C/man2/spu_run.2:39
3956 msgid "I<Note>: There is no glibc wrapper for this system call; see NOTES."
3960 #: build/C/man2/spu_create.2:59
3962 "The B<spu_create>() system call is used on PowerPC machines that implement "
3963 "the Cell Broadband Engine Architecture in order to access Synergistic "
3964 "Processor Units (SPUs). It creates a new logical context for an SPU in "
3965 "I<pathname> and returns a file descriptor associated with it. I<pathname> "
3966 "must refer to a nonexistent directory in the mount point of the SPU "
3967 "filesystem (B<spufs>). If B<spu_create>() is successful, a directory is "
3968 "created at I<pathname> and it is populated with the files described in "
3973 #: build/C/man2/spu_create.2:78
3975 "When a context is created, the returned file descriptor can only be passed "
3976 "to B<spu_run>(2), used as the I<dirfd> argument to the B<*at> family of "
3977 "system calls (e.g., B<openat>(2)), or closed; other operations are not "
3978 "defined. A logical SPU context is destroyed (along with all files created "
3979 "within the context's I<pathname> directory) once the last reference to the "
3980 "context has gone; this usually occurs when the file descriptor returned by "
3981 "B<spu_create>() is closed."
3985 #: build/C/man2/spu_create.2:83
3987 "The I<flags> argument can be zero or any bitwise OR-ed combination of the "
3988 "following constants:"
3992 #: build/C/man2/spu_create.2:83
3994 msgid "B<SPU_CREATE_EVENTS_ENABLED>"
3998 #: build/C/man2/spu_create.2:89
4000 "Rather than using signals for reporting DMA errors, use the I<event> "
4001 "argument to B<spu_run>(2)."
4005 #: build/C/man2/spu_create.2:89
4007 msgid "B<SPU_CREATE_GANG>"
4011 #: build/C/man2/spu_create.2:97
4013 "Create an SPU gang instead of a context. (A gang is a group of SPU contexts "
4014 "that are functionally related to each other and which share common "
4015 "scheduling parameters\\(empriority and policy. In the future, gang "
4016 "scheduling may be implemented causing the group to be switched in and out as "
4021 #: build/C/man2/spu_create.2:104
4023 "A new directory will be created at the location specified by the I<pathname> "
4024 "argument. This gang may be used to hold other SPU contexts, by providing a "
4025 "pathname that is within the gang directory to further calls to "
4030 #: build/C/man2/spu_create.2:104
4032 msgid "B<SPU_CREATE_NOSCHED>"
4036 #: build/C/man2/spu_create.2:110
4038 "Create a context that is not affected by the SPU scheduler. Once the "
4039 "context is run, it will not be scheduled out until it is destroyed by the "
4044 #: build/C/man2/spu_create.2:121
4046 "Because the context cannot be removed from the SPU, some functionality is "
4047 "disabled for B<SPU_CREATE_NOSCHED> contexts. Only a subset of the files "
4048 "will be available in this context directory in B<spufs>. Additionally, "
4049 "B<SPU_CREATE_NOSCHED> contexts cannot dump a core file when crashing."
4053 #: build/C/man2/spu_create.2:127
4055 "Creating B<SPU_CREATE_NOSCHED> contexts requires the B<CAP_SYS_NICE> "
4060 #: build/C/man2/spu_create.2:127
4062 msgid "B<SPU_CREATE_ISOLATE>"
4066 #: build/C/man2/spu_create.2:134
4068 "Create an isolated SPU context. Isolated contexts are protected from some "
4069 "PPE (PowerPC Processing Element) operations, such as access to the SPU "
4070 "local store and the NPC register."
4074 #: build/C/man2/spu_create.2:140
4076 "Creating B<SPU_CREATE_ISOLATE> contexts also requires the "
4077 "B<SPU_CREATE_NOSCHED> flag."
4081 #: build/C/man2/spu_create.2:140
4083 msgid "B<SPU_CREATE_AFFINITY_SPU>"
4087 #: build/C/man2/spu_create.2:148
4089 "Create a context with affinity to another SPU context. This affinity "
4090 "information is used within the SPU scheduling algorithm. Using this flag "
4091 "requires that a file descriptor referring to the other SPU context be passed "
4092 "in the I<neighbor_fd> argument."
4096 #: build/C/man2/spu_create.2:148
4098 msgid "B<SPU_CREATE_AFFINITY_MEM>"
4102 #: build/C/man2/spu_create.2:153
4104 "Create a context with affinity to system memory. This affinity information "
4105 "is used within the SPU scheduling algorithm."
4109 #: build/C/man2/spu_create.2:165
4111 "The I<mode> argument (minus any bits set in the process's B<umask>(2)) "
4112 "specifies the permissions used for creating the new directory in B<spufs>. "
4113 "See B<stat>(2) for a full list of the possible I<mode> values."
4117 #: build/C/man2/spu_create.2:172
4119 "On success, B<spu_create>() returns a new file descriptor. On error, -1 is "
4120 "returned, and I<errno> is set to one of the error codes listed below."
4124 #: build/C/man2/spu_create.2:178
4125 msgid "The current user does not have write access to the B<spufs>(7) mount point."
4129 #: build/C/man2/spu_create.2:181
4130 msgid "An SPU context already exists at the given pathname."
4134 #: build/C/man2/spu_create.2:186
4136 "I<pathname> is not a valid string pointer in the calling process's address "
4141 #: build/C/man2/spu_create.2:192
4143 "I<pathname> is not a directory in the B<spufs>(7) mount point, or invalid "
4144 "flags have been provided."
4148 #: build/C/man2/spu_create.2:196
4149 msgid "Too many symbolic links were found while resolving I<pathname>."
4153 #: build/C/man2/spu_create.2:199
4154 msgid "The process has reached its maximum open files limit."
4158 #: build/C/man2/spu_create.2:203 build/C/man2/stat.2:544
4159 msgid "I<pathname> is too long."
4163 #: build/C/man2/spu_create.2:203
4169 #: build/C/man2/spu_create.2:206
4170 msgid "The system has reached the global open files limit."
4174 #: build/C/man2/spu_create.2:210
4176 "An isolated context was requested, but the hardware does not support SPU "
4181 #: build/C/man2/spu_create.2:215
4182 msgid "Part of I<pathname> could not be resolved."
4186 #: build/C/man2/spu_create.2:218
4187 msgid "The kernel could not allocate all resources required."
4191 #: build/C/man2/spu_create.2:223
4193 "There are not enough SPU resources available to create a new context or the "
4194 "user-specific limit for the number of SPU contexts has been reached."
4198 #: build/C/man2/spu_create.2:223 build/C/man2/spu_run.2:183 build/C/man2/statfs.2:206 build/C/man3/statvfs.3:145 build/C/man2/ustat.2:88
4204 #: build/C/man2/spu_create.2:228 build/C/man2/spu_run.2:188
4206 "The functionality is not provided by the current system, because either the "
4207 "hardware does not provide SPUs or the spufs module is not loaded."
4211 #: build/C/man2/spu_create.2:233
4212 msgid "A part of I<pathname> is not a directory."
4216 #: build/C/man2/spu_create.2:240
4218 "The I<SPU_CREATE_NOSCHED> flag has been given, but the user does not have "
4219 "the B<CAP_SYS_NICE> capability."
4223 #: build/C/man2/spu_create.2:246
4225 "I<pathname> must point to a location beneath the mount point of B<spufs>. "
4226 "By convention, it gets mounted in I</spu>."
4230 #: build/C/man2/spu_create.2:250
4231 msgid "The B<spu_create>() system call was added to Linux in kernel 2.6.16."
4235 #: build/C/man2/spu_create.2:254
4237 "This call is Linux-specific and implemented only on the PowerPC "
4238 "architecture. Programs using this system call are not portable."
4242 #: build/C/man2/spu_create.2:265
4244 "Glibc does not provide a wrapper for this system call; call it using "
4245 "B<syscall>(2). Note however, that B<spu_create>() is meant to be used from "
4246 "libraries that implement a more abstract interface to SPUs, not to be used "
4247 "from regular applications. See E<.UR "
4248 "http://www.bsc.es\\:/projects\\:/deepcomputing\\:/linuxoncell/> E<.UE> for "
4249 "the recommended libraries."
4253 #: build/C/man2/spu_create.2:270
4254 msgid "See B<spu_run>(2) for an example of the use of B<spu_create>()"
4258 #: build/C/man2/spu_create.2:275
4259 msgid "B<close>(2), B<spu_run>(2), B<capabilities>(7), B<spufs>(7)"
4263 #: build/C/man2/spu_run.2:26
4269 #: build/C/man2/spu_run.2:29
4270 msgid "spu_run - execute an SPU context"
4274 #: build/C/man2/spu_run.2:32
4276 msgid "B<#include E<lt>sys/spu.hE<gt>>\n"
4280 #: build/C/man2/spu_run.2:35
4283 "B<int spu_run(int >I<fd>B<, unsigned int *>I<npc>B<, unsigned int "
4288 #: build/C/man2/spu_run.2:53
4290 "The B<spu_run>() system call is used on PowerPC machines that implement the "
4291 "Cell Broadband Engine Architecture in order to access Synergistic Processor "
4292 "Units (SPUs). The I<fd> argument is a file descriptor returned by "
4293 "B<spu_create>(2) that refers to a specific SPU context. When the context "
4294 "gets scheduled to a physical SPU, it starts execution at the instruction "
4295 "pointer passed in I<npc>."
4299 #: build/C/man2/spu_run.2:62
4301 "Execution of SPU code happens synchronously, meaning that B<spu_run>() "
4302 "blocks while the SPU is still running. If there is a need to execute SPU "
4303 "code in parallel with other code on either the main CPU or other SPUs, a new "
4304 "thread of execution must be created first (e.g., using "
4305 "B<pthread_create>(3))."
4309 #: build/C/man2/spu_run.2:72
4311 "When B<spu_run>() returns, the current value of the SPU program counter is "
4312 "written to I<npc>, so successive calls to B<spu_run>() can use the same "
4317 #: build/C/man2/spu_run.2:82
4319 "The I<event> argument provides a buffer for an extended status code. If the "
4320 "SPU context was created with the B<SPU_CREATE_EVENTS_ENABLED> flag, then "
4321 "this buffer is populated by the Linux kernel before B<spu_run>() returns."
4325 #: build/C/man2/spu_run.2:84
4326 msgid "The status code may be one (or more) of the following constants:"
4330 #: build/C/man2/spu_run.2:84
4332 msgid "B<SPE_EVENT_DMA_ALIGNMENT>"
4336 #: build/C/man2/spu_run.2:87
4337 msgid "A DMA alignment error occurred."
4341 #: build/C/man2/spu_run.2:87
4343 msgid "B<SPE_EVENT_INVALID_DMA>"
4347 #: build/C/man2/spu_run.2:90
4348 msgid "An invalid MFC DMA command was attempted."
4352 #: build/C/man2/spu_run.2:90
4354 msgid "B<SPE_EVENT_SPE_DATA_STORAGE>"
4358 #: build/C/man2/spu_run.2:93
4359 msgid "A DMA storage error occurred."
4363 #: build/C/man2/spu_run.2:93
4365 msgid "B<SPE_EVENT_SPE_ERROR>"
4369 #: build/C/man2/spu_run.2:96
4370 msgid "An illegal instruction was executed."
4374 #: build/C/man2/spu_run.2:102
4376 "NULL is a valid value for the I<event> argument. In this case, the events "
4377 "will not be reported to the calling process."
4381 #: build/C/man2/spu_run.2:111
4383 "On success, B<spu_run>() returns the value of the I<spu_status> register. "
4384 "On error, it returns -1 and sets I<errno> to one of the error codes listed "
4389 #: build/C/man2/spu_run.2:120
4391 "The I<spu_status> register value is a bit mask of status codes and "
4392 "optionally a 14-bit code returned from the B<stop-and-signal> instruction on "
4393 "the SPU. The bit masks for the status codes are:"
4397 #: build/C/man2/spu_run.2:120
4403 #: build/C/man2/spu_run.2:125
4404 msgid "SPU was stopped by a B<stop-and-signal> instruction."
4408 #: build/C/man2/spu_run.2:125
4414 #: build/C/man2/spu_run.2:130
4415 msgid "SPU was stopped by a B<halt> instruction."
4419 #: build/C/man2/spu_run.2:130
4425 #: build/C/man2/spu_run.2:133
4426 msgid "SPU is waiting for a channel."
4430 #: build/C/man2/spu_run.2:133
4436 #: build/C/man2/spu_run.2:136
4437 msgid "SPU is in single-step mode."
4441 #: build/C/man2/spu_run.2:136
4447 #: build/C/man2/spu_run.2:139
4448 msgid "SPU has tried to execute an invalid instruction."
4452 #: build/C/man2/spu_run.2:139
4458 #: build/C/man2/spu_run.2:142
4459 msgid "SPU has tried to access an invalid channel."
4463 #: build/C/man2/spu_run.2:142
4465 msgid "B<0x3fff0000>"
4469 #: build/C/man2/spu_run.2:148
4471 "The bits masked with this value contain the code returned from a "
4472 "B<stop-and-signal> instruction. These bits are valid only if the 0x02 bit "
4477 #: build/C/man2/spu_run.2:153
4479 "If B<spu_run>() has not returned an error, one or more bits among the lower "
4480 "eight ones are always set."
4484 #: build/C/man2/spu_run.2:154 build/C/man2/stat.2:530 build/C/man2/stat.2:581 build/C/man2/statfs.2:170 build/C/man3/statvfs.3:109
4490 #: build/C/man2/spu_run.2:158
4491 msgid "I<fd> is not a valid file descriptor."
4495 #: build/C/man2/spu_run.2:164
4497 "I<npc> is not a valid pointer, or I<event> is non-NULL and an invalid "
4502 #: build/C/man2/spu_run.2:164 build/C/man2/statfs.2:181 build/C/man3/statvfs.3:120
4508 #: build/C/man2/spu_run.2:174
4510 "A signal occurred while B<spu_run>() was in progress; see B<signal>(7). "
4511 "The I<npc> value has been updated to the new program counter value if "
4516 #: build/C/man2/spu_run.2:179
4517 msgid "I<fd> is not a valid file descriptor returned from B<spu_create>(2)."
4521 #: build/C/man2/spu_run.2:183
4523 "There was not enough memory available to handle a page fault resulting from "
4524 "a Memory Flow Controller (MFC) direct memory access."
4528 #: build/C/man2/spu_run.2:192
4529 msgid "The B<spu_run>() system call was added to Linux in kernel 2.6.16."
4533 #: build/C/man2/spu_run.2:196
4535 "This call is Linux-specific and implemented only by the PowerPC "
4536 "architecture. Programs using this system call are not portable."
4540 #: build/C/man2/spu_run.2:207
4542 "Glibc does not provide a wrapper for this system call; call it using "
4543 "B<syscall>(2). Note however, that B<spu_run>() is meant to be used from "
4544 "libraries that implement a more abstract interface to SPUs, not to be used "
4545 "from regular applications. See E<.UR "
4546 "http://www.bsc.es\\:/projects\\:/deepcomputing\\:/linuxoncell/> E<.UE> for "
4547 "the recommended libraries."
4551 #: build/C/man2/spu_run.2:212
4553 "The following is an example of running a simple, one-instruction SPU program "
4554 "with the B<spu_run>() system call."
4558 #: build/C/man2/spu_run.2:220
4561 "#include E<lt>stdlib.hE<gt>\n"
4562 "#include E<lt>stdint.hE<gt>\n"
4563 "#include E<lt>unistd.hE<gt>\n"
4564 "#include E<lt>stdio.hE<gt>\n"
4565 "#include E<lt>sys/types.hE<gt>\n"
4566 "#include E<lt>fcntl.hE<gt>\n"
4570 #: build/C/man2/spu_run.2:223
4573 "#define handle_error(msg) \\e\n"
4574 " do { perror(msg); exit(EXIT_FAILURE); } while (0)\n"
4578 #: build/C/man2/spu_run.2:228
4583 " int context, fd, spu_status;\n"
4584 " uint32_t instruction, npc;\n"
4588 #: build/C/man2/spu_run.2:232
4591 " context = spu_create(\"/spu/example-context\", 0, 0755);\n"
4592 " if (context == -1)\n"
4593 " handle_error(\"spu_create\");\n"
4597 #: build/C/man2/spu_run.2:237
4600 " /* write a \\(aqstop 0x1234\\(aq instruction to the SPU\\(aqs\n"
4601 " * local store memory\n"
4603 " instruction = 0x00001234;\n"
4607 #: build/C/man2/spu_run.2:242
4610 " fd = open(\"/spu/example-context/mem\", O_RDWR);\n"
4612 " handle_error(\"open\");\n"
4613 " write(fd, &instruction, sizeof(instruction));\n"
4617 #: build/C/man2/spu_run.2:248
4620 " /* set npc to the starting instruction address of the\n"
4621 " * SPU program. Since we wrote the instruction at the\n"
4622 " * start of the mem file, the entry point will be 0x0\n"
4628 #: build/C/man2/spu_run.2:252
4631 " spu_status = spu_run(context, &npc, NULL);\n"
4632 " if (spu_status == -1)\n"
4633 " handle_error(\"open\");\n"
4637 #: build/C/man2/spu_run.2:258
4640 " /* we should see a status code of 0x1234002:\n"
4641 " * 0x00000002 (spu was stopped due to stop-and-signal)\n"
4642 " * | 0x12340000 (the stop-and-signal code)\n"
4644 " printf(\"SPU Status: 0x%08x\\en\", spu_status);\n"
4648 #: build/C/man2/spu_run.2:261 build/C/man2/stat.2:919
4651 " exit(EXIT_SUCCESS);\n"
4656 #: build/C/man2/spu_run.2:269
4657 msgid "B<close>(2), B<spu_create>(2), B<capabilities>(7), B<spufs>(7)"
4661 #: build/C/man7/spufs.7:27
4667 #: build/C/man7/spufs.7:27
4673 #: build/C/man7/spufs.7:30
4674 msgid "spufs - SPU filesystem"
4678 #: build/C/man7/spufs.7:34
4680 "The SPU filesystem is used on PowerPC machines that implement the Cell "
4681 "Broadband Engine Architecture in order to access Synergistic Processor Units "
4686 #: build/C/man7/spufs.7:43
4688 "The filesystem provides a name space similar to POSIX shared memory or "
4689 "message queues. Users that have write permissions on the filesystem can use "
4690 "B<spu_create>(2) to establish SPU contexts under the B<spufs> root "
4695 #: build/C/man7/spufs.7:50
4697 "Every SPU context is represented by a directory containing a predefined set "
4698 "of files. These files can be used for manipulating the state of the logical "
4699 "SPU. Users can change permissions on the files, but can't add or remove "
4704 #: build/C/man7/spufs.7:50
4706 msgid "Mount options"
4710 #: build/C/man7/spufs.7:51
4712 msgid "B<uid=E<lt>uidE<gt>>"
4716 #: build/C/man7/spufs.7:54
4717 msgid "Set the user owning the mount point; the default is 0 (root)."
4721 #: build/C/man7/spufs.7:54
4723 msgid "B<gid=E<lt>gidE<gt>>"
4727 #: build/C/man7/spufs.7:57
4728 msgid "Set the group owning the mount point; the default is 0 (root)."
4732 #: build/C/man7/spufs.7:57
4734 msgid "B<mode=E<lt>modeE<gt>>"
4738 #: build/C/man7/spufs.7:63
4740 "Set the mode of the top-level directory in B<spufs>, as an octal mode "
4741 "string. The default is 0775."
4745 #: build/C/man7/spufs.7:63
4751 #: build/C/man7/spufs.7:75
4753 "The files in B<spufs> mostly follow the standard behavior for regular system "
4754 "calls like B<read>(2) or B<write>(2), but often support only a subset of "
4755 "the operations supported on regular filesystems. This list details the "
4756 "supported operations and the deviations from the standard behavior described "
4757 "in the respective man pages."
4761 #: build/C/man7/spufs.7:97
4763 "All files that support the B<read>(2) operation also support B<readv>(2) "
4764 "and all files that support the B<write>(2) operation also support "
4765 "B<writev>(2). All files support the B<access>(2) and B<stat>(2) family of "
4766 "operations, but for the latter call, the only fields of the returned I<stat> "
4767 "structure that contain reliable information are I<st_mode>, I<st_nlink>, "
4768 "I<st_uid>, and I<st_gid>."
4772 #: build/C/man7/spufs.7:106
4774 "All files support the B<chmod>(2)/B<fchmod>(2) and B<chown>(2)/B<fchown>(2) "
4775 "operations, but will not be able to grant permissions that contradict the "
4776 "possible operations (e.g., read access on the I<wbox> file)."
4780 #: build/C/man7/spufs.7:108
4781 msgid "The current set of files is:"
4785 #: build/C/man7/spufs.7:108
4787 msgid "I</capabilities>"
4791 #: build/C/man7/spufs.7:113
4793 "Contains a comma-delimited string representing the capabilities of this SPU "
4794 "context. Possible capabilities are:"
4798 #: build/C/man7/spufs.7:114
4804 #: build/C/man7/spufs.7:117
4805 msgid "This context may be scheduled."
4809 #: build/C/man7/spufs.7:117
4815 #: build/C/man7/spufs.7:120
4816 msgid "This context can be run in single-step mode, for debugging."
4820 #: build/C/man7/spufs.7:122
4821 msgid "New capabilities flags may be added in the future."
4825 #: build/C/man7/spufs.7:123
4831 #: build/C/man7/spufs.7:132
4833 "the contents of the local storage memory of the SPU. This can be accessed "
4834 "like a regular shared memory file and contains both code and data in the "
4835 "address space of the SPU. The possible operations on an open I<mem> file "
4840 #: build/C/man7/spufs.7:133
4842 msgid "B<read>(2), B<pread>(2), B<write>(2), B<pwrite>(2), B<lseek>(2)"
4846 #: build/C/man7/spufs.7:144
4848 "These operate as usual, with the exception that B<lseek>(2), B<write>(2), "
4849 "and B<pwrite>(2) are not supported beyond the end of the file. The file "
4850 "size is the size of the local storage of the SPU, which is normally 256 "
4855 #: build/C/man7/spufs.7:144 build/C/man7/spufs.7:706 build/C/man7/spufs.7:725
4861 #: build/C/man7/spufs.7:153
4863 "Mapping I<mem> into the process address space provides access to the SPU "
4864 "local storage within the process address space. Only B<MAP_SHARED> mappings "
4869 #: build/C/man7/spufs.7:154
4875 #: build/C/man7/spufs.7:161
4877 "Contains the saved general-purpose registers of the SPU context. This file "
4878 "contains the 128-bit values of each register, from register 0 to register "
4879 "127, in order. This allows the general-purpose registers to be inspected "
4884 #: build/C/man7/spufs.7:165
4886 "Reading to or writing from this file requires that the context is scheduled "
4887 "out, so use of this file is not recommended in normal program operation."
4891 #: build/C/man7/spufs.7:171
4893 "The I<regs> file is not present on contexts that have been created with the "
4894 "B<SPU_CREATE_NOSCHED> flag."
4898 #: build/C/man7/spufs.7:171
4904 #: build/C/man7/spufs.7:181
4906 "The first SPU-to-CPU communication mailbox. This file is read-only and can "
4907 "be read in units of 4 bytes. The file can be used only in nonblocking mode "
4908 "- even B<poll>(2) cannot be used to block on this file. The only possible "
4909 "operation on an open I<mbox> file is:"
4913 #: build/C/man7/spufs.7:182 build/C/man7/spufs.7:222 build/C/man7/spufs.7:317 build/C/man7/spufs.7:381 build/C/man7/spufs.7:418 build/C/man7/spufs.7:463 build/C/man7/spufs.7:517 build/C/man7/spufs.7:632 build/C/man7/spufs.7:676 build/C/man7/spufs.7:754
4919 #: build/C/man7/spufs.7:200
4921 "If I<count> is smaller than four, B<read>(2) returns -1 and sets I<errno> "
4922 "to B<EINVAL>. If there is no data available in the mailbox (i.e., the SPU "
4923 "has not sent a mailbox message), the return value is set to -1 and I<errno> "
4924 "is set to B<EAGAIN>. When data has been read successfully, four bytes are "
4925 "placed in the data buffer and the value four is returned."
4929 #: build/C/man7/spufs.7:201
4935 #: build/C/man7/spufs.7:217
4937 "The second SPU-to-CPU communication mailbox. This file is similar to the "
4938 "first mailbox file, but can be read in blocking I/O mode, thus calling "
4939 "B<read>(2) on an open I<ibox> file will block until the SPU has written "
4940 "data to its interrupt mailbox channel (unless the file has been opened with "
4941 "B<O_NONBLOCK>, see below). Also, B<poll>(2) and similar system calls can "
4942 "be used to monitor for the presence of mailbox data."
4946 #: build/C/man7/spufs.7:221
4947 msgid "The possible operations on an open I<ibox> file are:"
4951 #: build/C/man7/spufs.7:239
4953 "If I<count> is smaller than four, B<read>(2) returns -1 and sets I<errno> "
4954 "to B<EINVAL>. If there is no data available in the mailbox and the file "
4955 "descriptor has been opened with B<O_NONBLOCK>, the return value is set to -1 "
4956 "and I<errno> is set to B<EAGAIN>."
4960 #: build/C/man7/spufs.7:247
4962 "If there is no data available in the mailbox and the file descriptor has "
4963 "been opened without B<O_NONBLOCK>, the call will block until the SPU writes "
4964 "to its interrupt mailbox channel. When data has been read successfully, "
4965 "four bytes are placed in the data buffer and the value four is returned."
4969 #: build/C/man7/spufs.7:247 build/C/man7/spufs.7:295 build/C/man7/spufs.7:685
4975 #: build/C/man7/spufs.7:254
4977 "Poll on the I<ibox> file returns I<(POLLIN | POLLRDNORM)> whenever data is "
4978 "available for reading."
4982 #: build/C/man7/spufs.7:255
4988 #: build/C/man7/spufs.7:267
4990 "The CPU-to-SPU communication mailbox. It is write-only and can be written "
4991 "in units of four bytes. If the mailbox is full, B<write>(2) will block, "
4992 "and B<poll>(2) can be used to block until the mailbox is available for "
4993 "writing again. The possible operations on an open I<wbox> file are:"
4997 #: build/C/man7/spufs.7:268 build/C/man7/spufs.7:392 build/C/man7/spufs.7:432 build/C/man7/spufs.7:476 build/C/man7/spufs.7:527 build/C/man7/spufs.7:638 build/C/man7/spufs.7:652 build/C/man7/spufs.7:749
5003 #: build/C/man7/spufs.7:286
5005 "If I<count> is smaller than four, B<write>(2) returns -1 and sets I<errno> "
5006 "to B<EINVAL>. If there is no space available in the mailbox and the file "
5007 "descriptor has been opened with B<O_NONBLOCK>, the return value is set to -1 "
5008 "and I<errno> is set to B<EAGAIN>."
5012 #: build/C/man7/spufs.7:295
5014 "If there is no space available in the mailbox and the file descriptor has "
5015 "been opened without B<O_NONBLOCK>, the call will block until the SPU reads "
5016 "from its PPE (PowerPC Processing Element) mailbox channel. When data has "
5017 "been written successfully, the system call returns four as its function "
5022 #: build/C/man7/spufs.7:302
5024 "A poll on the I<wbox> file returns I<(POLLOUT | POLLWRNORM)> whenever space "
5025 "is available for writing."
5029 #: build/C/man7/spufs.7:303
5031 msgid "I</mbox_stat>, I</ibox_stat>, I</wbox_stat>"
5035 #: build/C/man7/spufs.7:316
5037 "These are read-only files that contain the length of the current queue of "
5038 "each mailbox\\(emthat is, how many words can be read from I<mbox> or I<ibox> "
5039 "or how many words can be written to I<wbox> without blocking. The files can "
5040 "be read only in four-byte units and return a big-endian binary integer "
5041 "number. The only possible operation on an open I<*box_stat> file is:"
5045 #: build/C/man7/spufs.7:337
5047 "If I<count> is smaller than four, B<read>(2) returns -1 and sets I<errno> "
5048 "to B<EINVAL>. Otherwise, a four-byte value is placed in the data buffer. "
5049 "This value is the number of elements that can be read from (for I<mbox_stat> "
5050 "and I<ibox_stat>) or written to (for I<wbox_stat>) the respective mailbox "
5051 "without blocking or returning an B<EAGAIN> error."
5055 #: build/C/man7/spufs.7:338
5058 "I</npc>, I</decr>, I</decr_status>, I</spu_tag_mask>, I</event_mask>, "
5059 "I</event_status>, I</srr0>, I</lslr>"
5063 #: build/C/man7/spufs.7:350
5065 "Internal registers of the SPU. These files contain an ASCII string "
5066 "representing the hex value of the specified register. Reads and writes on "
5067 "these files (except for I<npc>, see below) require that the SPU context be "
5068 "scheduled out, so frequent access to these files is not recommended for "
5069 "normal program operation."
5073 #: build/C/man7/spufs.7:352
5074 msgid "The contents of these files are:"
5078 #: build/C/man7/spufs.7:353
5084 #: build/C/man7/spufs.7:356
5085 msgid "Next Program Counter - valid only when the SPU is in a stopped state."
5089 #: build/C/man7/spufs.7:356
5095 #: build/C/man7/spufs.7:359
5096 msgid "SPU Decrementer"
5100 #: build/C/man7/spufs.7:359
5102 msgid "I<decr_status>"
5106 #: build/C/man7/spufs.7:362
5107 msgid "Decrementer Status"
5111 #: build/C/man7/spufs.7:362
5113 msgid "I<spu_tag_mask>"
5117 #: build/C/man7/spufs.7:365
5118 msgid "MFC tag mask for SPU DMA"
5122 #: build/C/man7/spufs.7:365
5124 msgid "I<event_mask>"
5128 #: build/C/man7/spufs.7:368
5129 msgid "Event mask for SPU interrupts"
5133 #: build/C/man7/spufs.7:368
5135 msgid "I<event_status>"
5139 #: build/C/man7/spufs.7:371
5140 msgid "Number of SPU events pending (read-only)"
5144 #: build/C/man7/spufs.7:371
5150 #: build/C/man7/spufs.7:374
5151 msgid "Interrupt Return address register"
5155 #: build/C/man7/spufs.7:374
5161 #: build/C/man7/spufs.7:377
5162 msgid "Local Store Limit Register"
5166 #: build/C/man7/spufs.7:380
5167 msgid "The possible operations on these files are:"
5171 #: build/C/man7/spufs.7:388
5173 "Reads the current register value. If the register value is larger than the "
5174 "buffer passed to the B<read>(2) system call, subsequent reads will continue "
5175 "reading from the same buffer, until the end of the buffer is reached."
5179 #: build/C/man7/spufs.7:392
5181 "When a complete string has been read, all subsequent read operations will "
5182 "return zero bytes and a new file descriptor needs to be opened to read a new "
5187 #: build/C/man7/spufs.7:402 build/C/man7/spufs.7:537
5189 "A B<write>(2) operation on the file sets the register to the value given in "
5190 "the string. The string is parsed from the beginning until the first "
5191 "nonnumeric character or the end of the buffer. Subsequent writes to the "
5192 "same file descriptor overwrite the previous setting."
5196 #: build/C/man7/spufs.7:409
5198 "Except for the I<npc> file, these files are not present on contexts that "
5199 "have been created with the B<SPU_CREATE_NOSCHED> flag."
5203 #: build/C/man7/spufs.7:410
5209 #: build/C/man7/spufs.7:417
5211 "This file provides access to the Floating Point Status and Control Register "
5212 "(fcpr) as a binary, four-byte file. The operations on the I<fpcr> file are:"
5216 #: build/C/man7/spufs.7:432
5218 "If I<count> is smaller than four, B<read>(2) returns -1 and sets I<errno> "
5219 "to B<EINVAL>. Otherwise, a four-byte value is placed in the data buffer; "
5220 "this is the current value of the I<fpcr> register."
5224 #: build/C/man7/spufs.7:446
5226 "If I<count> is smaller than four, B<write>(2) returns -1 and sets I<errno> "
5227 "to B<EINVAL>. Otherwise, a four-byte value is copied from the data buffer, "
5228 "updating the value of the I<fpcr> register."
5232 #: build/C/man7/spufs.7:447
5234 msgid "I</signal1>, I</signal2>"
5238 #: build/C/man7/spufs.7:462
5240 "The files provide access to the two signal notification channels of an SPU. "
5241 "These are read-write files that operate on four-byte words. Writing to one "
5242 "of these files triggers an interrupt on the SPU. The value written to the "
5243 "signal files can be read from the SPU through a channel read or from host "
5244 "user space through the file. After the value has been read by the SPU, it "
5245 "is reset to zero. The possible operations on an open I<signal1> or "
5246 "I<signal2> file are:"
5250 #: build/C/man7/spufs.7:476
5252 "If I<count> is smaller than four, B<read>(2) returns -1 and sets I<errno> "
5253 "to B<EINVAL>. Otherwise, a four-byte value is placed in the data buffer; "
5254 "this is the current value of the specified signal notification register."
5258 #: build/C/man7/spufs.7:497
5260 "If I<count> is smaller than four, B<write>(2) returns -1 and sets I<errno> "
5261 "to B<EINVAL>. Otherwise, a four-byte value is copied from the data buffer, "
5262 "updating the value of the specified signal notification register. The "
5263 "signal notification register will either be replaced with the input data or "
5264 "will be updated to the bitwise OR operation of the old value and the input "
5265 "data, depending on the contents of the I<signal1_type> or I<signal2_type> "
5266 "files respectively."
5270 #: build/C/man7/spufs.7:498
5272 msgid "I</signal1_type>, I</signal2_type>"
5276 #: build/C/man7/spufs.7:516
5278 "These two files change the behavior of the I<signal1> and I<signal2> "
5279 "notification files. They contain a numeric ASCII string which is read as "
5280 "either \"1\" or \"0\". In mode 0 (overwrite), the hardware replaces the "
5281 "contents of the signal channel with the data that is written to it. In mode "
5282 "1 (logical OR), the hardware accumulates the bits that are subsequently "
5283 "written to it. The possible operations on an open I<signal1_type> or "
5284 "I<signal2_type> file are:"
5288 #: build/C/man7/spufs.7:527
5290 "When the count supplied to the B<read>(2) call is shorter than the required "
5291 "length for the digit (plus a newline character), subsequent reads from the "
5292 "same file descriptor will complete the string. When a complete string has "
5293 "been read, all subsequent read operations will return zero bytes and a new "
5294 "file descriptor needs to be opened to read the value again."
5298 #: build/C/man7/spufs.7:538
5300 msgid "I</mbox_info>, I</ibox_info>, I</wbox_info>, I</dma_into>, I</proxydma_info>"
5304 #: build/C/man7/spufs.7:557
5306 "Read-only files that contain the saved state of the SPU mailboxes and DMA "
5307 "queues. This allows the SPU status to be inspected, mainly for debugging. "
5308 "The I<mbox_info> and I<ibox_info> files each contain the four-byte mailbox "
5309 "message that has been written by the SPU. If no message has been written to "
5310 "these mailboxes, then contents of these files is undefined. The "
5311 "I<mbox_stat>, I<ibox_stat> and I<wbox_stat> files contain the available "
5316 #: build/C/man7/spufs.7:566
5318 "The I<wbox_info> file contains an array of four-byte mailbox messages, which "
5319 "have been sent to the SPU. With current CBEA machines, the array is four "
5320 "items in length, so up to 4 * 4 = 16 bytes can be read from this file. If "
5321 "any mailbox queue entry is empty, then the bytes read at the corresponding "
5322 "location are undefined."
5326 #: build/C/man7/spufs.7:571
5328 "The I<dma_info> file contains the contents of the SPU MFC DMA queue, "
5329 "represented as the following structure:"
5333 #: build/C/man7/spufs.7:582
5336 "struct spu_dma_info {\n"
5337 " uint64_t dma_info_type;\n"
5338 " uint64_t dma_info_mask;\n"
5339 " uint64_t dma_info_status;\n"
5340 " uint64_t dma_info_stall_and_notify;\n"
5341 " uint64_t dma_info_atomic_command_status;\n"
5342 " struct mfc_cq_sr dma_info_command_data[16];\n"
5347 #: build/C/man7/spufs.7:590
5349 "The last member of this data structure is the actual DMA queue, containing "
5350 "16 entries. The I<mfc_cq_sr> structure is defined as:"
5354 #: build/C/man7/spufs.7:599
5357 "struct mfc_cq_sr {\n"
5358 " uint64_t mfc_cq_data0_RW;\n"
5359 " uint64_t mfc_cq_data1_RW;\n"
5360 " uint64_t mfc_cq_data2_RW;\n"
5361 " uint64_t mfc_cq_data3_RW;\n"
5366 #: build/C/man7/spufs.7:607
5368 "The I<proxydma_info> file contains similar information, but describes the "
5369 "proxy DMA queue (i.e., DMAs initiated by entities outside the SPU) instead. "
5370 "The file is in the following format:"
5374 #: build/C/man7/spufs.7:616
5377 "struct spu_proxydma_info {\n"
5378 " uint64_t proxydma_info_type;\n"
5379 " uint64_t proxydma_info_mask;\n"
5380 " uint64_t proxydma_info_status;\n"
5381 " struct mfc_cq_sr proxydma_info_command_data[8];\n"
5386 #: build/C/man7/spufs.7:622
5388 "Accessing these files requires that the SPU context is scheduled out - "
5389 "frequent use can be inefficient. These files should not be used for normal "
5390 "program operation."
5394 #: build/C/man7/spufs.7:626
5396 "These files are not present on contexts that have been created with the "
5397 "B<SPU_CREATE_NOSCHED> flag."
5401 #: build/C/man7/spufs.7:626
5407 #: build/C/man7/spufs.7:631
5409 "This file provides access to the SPU Run Control and SPU status registers, "
5410 "as an ASCII string. The following operations are supported:"
5414 #: build/C/man7/spufs.7:638
5416 "Reads from the I<cntl> file will return an ASCII string with the hex value "
5417 "of the SPU Status register."
5421 #: build/C/man7/spufs.7:643
5422 msgid "Writes to the I<cntl> file will set the context's SPU Run Control register."
5426 #: build/C/man7/spufs.7:644
5432 #: build/C/man7/spufs.7:651
5434 "Provides access to the Memory Flow Controller of the SPU. Reading from the "
5435 "file returns the contents of the SPU's MFC Tag Status register, and writing "
5436 "to the file initiates a DMA from the MFC. The following operations are "
5441 #: build/C/man7/spufs.7:656
5443 "Writes to this file need to be in the format of a MFC DMA command, defined "
5448 #: build/C/man7/spufs.7:668
5451 "struct mfc_dma_command {\n"
5452 " int32_t pad; /* reserved */\n"
5453 " uint32_t lsa; /* local storage address */\n"
5454 " uint64_t ea; /* effective address */\n"
5455 " uint16_t size; /* transfer size */\n"
5456 " uint16_t tag; /* command tag */\n"
5457 " uint16_t class; /* class ID */\n"
5458 " uint16_t cmd; /* command opcode */\n"
5463 #: build/C/man7/spufs.7:676
5465 "Writes are required to be exactly I<sizeof(struct mfc_dma_command)> bytes in "
5466 "size. The command will be sent to the SPU's MFC proxy queue, and the tag "
5467 "stored in the kernel (see below)."
5471 #: build/C/man7/spufs.7:685
5473 "Reads the contents of the tag status register. If the file is opened in "
5474 "blocking mode (i.e., without B<O_NONBLOCK>), then the read will block until "
5475 "a DMA tag (as performed by a previous write) is complete. In nonblocking "
5476 "mode, the MFC tag status register will be returned without waiting."
5480 #: build/C/man7/spufs.7:698
5482 "Calling B<poll>(2) on the I<mfc> file will block until a new DMA can be "
5483 "started (by checking for B<POLLOUT>) or until a previously started DMA (by "
5484 "checking for B<POLLIN>) has been completed."
5488 #: build/C/man7/spufs.7:704
5490 "I</mss> Provides access to the MFC MultiSource Synchronization (MSS) "
5491 "facility. By B<mmap>(2)-ing this file, processes can access the MSS area of "
5496 #: build/C/man7/spufs.7:706 build/C/man7/spufs.7:724
5497 msgid "The following operations are supported:"
5501 #: build/C/man7/spufs.7:715
5503 "Mapping B<mss> into the process address space gives access to the SPU MSS "
5504 "area within the process address space. Only B<MAP_SHARED> mappings are "
5509 #: build/C/man7/spufs.7:716
5515 #: build/C/man7/spufs.7:722
5517 "Provides access to the whole problem-state mapping of the SPU. Applications "
5518 "can use this area to interface to the SPU, rather than writing to individual "
5519 "register files in B<spufs>."
5523 #: build/C/man7/spufs.7:733
5525 "Mapping B<psmap> gives a process a direct map of the SPU problem state "
5526 "area. Only B<MAP_SHARED> mappings are supported."
5530 #: build/C/man7/spufs.7:734
5536 #: build/C/man7/spufs.7:740
5538 "Read-only file containing the physical SPU number that the SPU context is "
5539 "running on. When the context is not running, this file contains the string "
5544 #: build/C/man7/spufs.7:742
5545 msgid "The physical SPU number is given by an ASCII hex string."
5549 #: build/C/man7/spufs.7:742
5551 msgid "I</object-id>"
5555 #: build/C/man7/spufs.7:748
5557 "Allows applications to store (or retrieve) a single 64-bit ID into the "
5558 "context. This ID is later used by profiling tools to uniquely identify the "
5563 #: build/C/man7/spufs.7:754
5565 "By writing an ASCII hex value into this file, applications can set the "
5566 "object ID of the SPU context. Any previous value of the object ID is "
5571 #: build/C/man7/spufs.7:758
5573 "Reading this file gives an ASCII hex string representing the object ID for "
5578 #: build/C/man7/spufs.7:760
5580 msgid "I</etc/fstab> entry"
5584 #. Arnd Bergmann <arndb@de.ibm.com>, Mark Nutter <mnutter@us.ibm.com>,
5585 #. Ulrich Weigand <Ulrich.Weigand@de.ibm.com>, Jeremy Kerr <jk@ozlabs.org>
5587 #: build/C/man7/spufs.7:766
5588 msgid "none \t/spu \tspufs \tgid=spu \t0\t0"
5592 #: build/C/man7/spufs.7:771
5593 msgid "B<close>(2), B<spu_create>(2), B<spu_run>(2), B<capabilities>(7)"
5597 #: build/C/man7/spufs.7:773
5598 msgid "I<The Cell Broadband Engine Architecture (CBEA) specification>"
5602 #: build/C/man2/stat.2:40
5608 #: build/C/man2/stat.2:40
5614 #: build/C/man2/stat.2:43
5615 msgid "stat, fstat, lstat, fstatat - get file status"
5619 #: build/C/man2/stat.2:46 build/C/man2/ustat.2:36
5621 msgid "B<#include E<lt>sys/types.hE<gt>>\n"
5625 #: build/C/man2/stat.2:48
5627 msgid "B<#include E<lt>sys/stat.hE<gt>>\n"
5631 #: build/C/man2/stat.2:50
5633 msgid "B<#include E<lt>unistd.hE<gt>>\n"
5637 #: build/C/man2/stat.2:52
5639 msgid "B<int stat(const char *>I<pathname>B<, struct stat *>I<buf>B<);>\n"
5643 #: build/C/man2/stat.2:54
5645 msgid "B<int fstat(int >I<fd>B<, struct stat *>I<buf>B<);>\n"
5649 #: build/C/man2/stat.2:56
5651 msgid "B<int lstat(const char *>I<pathname>B<, struct stat *>I<buf>B<);>\n"
5655 #: build/C/man2/stat.2:59
5658 "B<#include E<lt>fcntl.hE<gt> >/* Definition of AT_* constants */\n"
5659 "B<#include E<lt>sys/stat.hE<gt>>\n"
5663 #: build/C/man2/stat.2:63
5666 "B<int fstatat(int >I<dirfd>B<, const char *>I<pathname>B<, struct stat "
5668 "B< int >I<flags>B<);>\n"
5672 #: build/C/man2/stat.2:73
5677 #: build/C/man2/stat.2:75
5678 msgid "/* glibc 2.19 and earlier */ _BSD_SOURCE ||"
5682 #: build/C/man2/stat.2:77
5683 msgid "/* Since glibc 2.20 */_DEFAULT_SOURCE ||"
5687 #: build/C/man2/stat.2:80
5688 msgid "_XOPEN_SOURCE\\ E<gt>=\\ 500 || _XOPEN_SOURCE\\ &&\\ _XOPEN_SOURCE_EXTENDED"
5692 #: build/C/man2/stat.2:82
5693 msgid "|| /* Since glibc 2.10: */ _POSIX_C_SOURCE\\ E<gt>=\\ 200112L"
5697 #: build/C/man2/stat.2:85
5698 msgid "B<fstatat>():"
5702 #: build/C/man2/stat.2:88
5704 msgid "Since glibc 2.10:"
5708 #: build/C/man2/stat.2:91
5709 msgid "_XOPEN_SOURCE\\ E<gt>=\\ 700 || _POSIX_C_SOURCE\\ E<gt>=\\ 200809L"
5713 #: build/C/man2/stat.2:91
5715 msgid "Before glibc 2.10:"
5719 #: build/C/man2/stat.2:94
5720 msgid "_ATFILE_SOURCE"
5724 #: build/C/man2/stat.2:109
5726 "These functions return information about a file, in the buffer pointed to by "
5727 "I<stat>. No permissions are required on the file itself, but\\(emin the "
5728 "case of B<stat>(), B<fstatat>(), and B<lstat>()\\(emexecute (search) "
5729 "permission is required on all of the directories in I<pathname> that lead to "
5734 #: build/C/man2/stat.2:118
5736 "B<stat>() and B<fstatat>() retrieve information about the file pointed to "
5737 "by I<pathname>; the differences for B<fstatat>() are described below."
5741 #: build/C/man2/stat.2:126
5743 "B<lstat>() is identical to B<stat>(), except that if I<pathname> is a "
5744 "symbolic link, then it returns information about the link itself, not the "
5745 "file that it refers to."
5749 #: build/C/man2/stat.2:133
5751 "B<fstat>() is identical to B<stat>(), except that the file about which "
5752 "information is to be retrieved is specified by the file descriptor I<fd>."
5756 #: build/C/man2/stat.2:137
5758 "All of these system calls return a I<stat> structure, which contains the "
5763 #: build/C/man2/stat.2:151
5767 " dev_t st_dev; /* ID of device containing file */\n"
5768 " ino_t st_ino; /* inode number */\n"
5769 " mode_t st_mode; /* protection */\n"
5770 " nlink_t st_nlink; /* number of hard links */\n"
5771 " uid_t st_uid; /* user ID of owner */\n"
5772 " gid_t st_gid; /* group ID of owner */\n"
5773 " dev_t st_rdev; /* device ID (if special file) */\n"
5774 " off_t st_size; /* total size, in bytes */\n"
5775 " blksize_t st_blksize; /* blocksize for filesystem I/O */\n"
5776 " blkcnt_t st_blocks; /* number of 512B blocks allocated */\n"
5780 #: build/C/man2/stat.2:155
5783 " /* Since Linux 2.6, the kernel supports nanosecond\n"
5784 " precision for the following timestamp fields.\n"
5785 " For the details before Linux 2.6, see NOTES. */\n"
5789 #: build/C/man2/stat.2:159
5792 " struct timespec st_atim; /* time of last access */\n"
5793 " struct timespec st_mtim; /* time of last modification */\n"
5794 " struct timespec st_ctim; /* time of last status change */\n"
5798 #: build/C/man2/stat.2:164
5801 "#define st_atime st_atim.tv_sec /* Backward compatibility */\n"
5802 "#define st_mtime st_mtim.tv_sec\n"
5803 "#define st_ctime st_ctim.tv_sec\n"
5808 #: build/C/man2/stat.2:177
5810 "I<Note:> the order of fields in the I<stat> structure varies somewhat across "
5811 "architectures. In addition, the definition above does not show the padding "
5812 "bytes that may be present between some fields on various architectures. "
5813 "Consult the the glibc and kernel source code if you need to know the "
5818 #: build/C/man2/stat.2:186
5820 "The I<st_dev> field describes the device on which this file resides. (The "
5821 "B<major>(3) and B<minor>(3) macros may be useful to decompose the device "
5822 "ID in this field.)"
5826 #: build/C/man2/stat.2:190
5827 msgid "The I<st_rdev> field describes the device that this file (inode) represents."
5831 #: build/C/man2/stat.2:197
5833 "The I<st_size> field gives the size of the file (if it is a regular file or "
5834 "a symbolic link) in bytes. The size of a symbolic link is the length of the "
5835 "pathname it contains, without a terminating null byte."
5839 #: build/C/man2/stat.2:204
5841 "The I<st_blocks> field indicates the number of blocks allocated to the file, "
5842 "512-byte units. (This may be smaller than I<st_size>/512 when the file has "
5847 #: build/C/man2/stat.2:210
5849 "The I<st_blksize> field gives the \"preferred\" blocksize for efficient "
5850 "filesystem I/O. (Writing to a file in smaller chunks may cause an "
5851 "inefficient read-modify-rewrite.)"
5855 #: build/C/man2/stat.2:231
5857 "Not all of the Linux filesystems implement all of the time fields. Some "
5858 "filesystem types allow mounting in such a way that file and/or directory "
5859 "accesses do not cause an update of the I<st_atime> field. (See I<noatime>, "
5860 "I<nodiratime>, and I<relatime> in B<mount>(8), and related information in "
5861 "B<mount>(2).) In addition, I<st_atime> is not updated if a file is opened "
5862 "with the B<O_NOATIME>; see B<open>(2)."
5866 #: build/C/man2/stat.2:246
5868 "The field I<st_atime> is changed by file accesses, for example, by "
5869 "B<execve>(2), B<mknod>(2), B<pipe>(2), B<utime>(2), and B<read>(2) (of more "
5870 "than zero bytes). Other routines, like B<mmap>(2), may or may not update "
5875 #: build/C/man2/stat.2:265
5877 "The field I<st_mtime> is changed by file modifications, for example, by "
5878 "B<mknod>(2), B<truncate>(2), B<utime>(2), and B<write>(2) (of more than "
5879 "zero bytes). Moreover, I<st_mtime> of a directory is changed by the "
5880 "creation or deletion of files in that directory. The I<st_mtime> field is "
5881 "I<not> changed for changes in owner, group, hard link count, or mode."
5885 #: build/C/man2/stat.2:270
5887 "The field I<st_ctime> is changed by writing or by setting inode information "
5888 "(i.e., owner, group, link count, mode, etc.)."
5892 #: build/C/man2/stat.2:274
5894 "The following mask values are defined for the file type component of the "
5899 #: build/C/man2/stat.2:277
5901 msgid "S_IFMT\t0170000\tbit mask for the file type bit fields\n"
5905 #: build/C/man2/stat.2:279
5907 msgid "S_IFSOCK\t0140000\tsocket\n"
5911 #: build/C/man2/stat.2:280
5913 msgid "S_IFLNK\t0120000\tsymbolic link\n"
5917 #: build/C/man2/stat.2:281
5919 msgid "S_IFREG\t0100000\tregular file\n"
5923 #: build/C/man2/stat.2:282
5925 msgid "S_IFBLK\t0060000\tblock device\n"
5929 #: build/C/man2/stat.2:283
5931 msgid "S_IFDIR\t0040000\tdirectory\n"
5935 #: build/C/man2/stat.2:284
5937 msgid "S_IFCHR\t0020000\tcharacter device\n"
5941 #: build/C/man2/stat.2:285
5943 msgid "S_IFIFO\t0010000\tFIFO\n"
5947 #: build/C/man2/stat.2:290
5948 msgid "Thus, to test for a regular file (for example), one could write:"
5952 #: build/C/man2/stat.2:297
5955 "stat(pathname, &sb);\n"
5956 "if ((sb.st_mode & S_IFMT) == S_IFREG) {\n"
5957 " /* Handle regular file */\n"
5962 #: build/C/man2/stat.2:304
5964 "Because tests of the above form are common, additional macros are defined by "
5965 "POSIX to allow the test of the file type in I<st_mode> to be written more "
5970 #: build/C/man2/stat.2:305
5972 msgid "B<S_ISREG>(m)"
5976 #: build/C/man2/stat.2:308
5977 msgid "is it a regular file?"
5981 #: build/C/man2/stat.2:308
5983 msgid "B<S_ISDIR>(m)"
5987 #: build/C/man2/stat.2:311
5992 #: build/C/man2/stat.2:311
5994 msgid "B<S_ISCHR>(m)"
5998 #: build/C/man2/stat.2:314
5999 msgid "character device?"
6003 #: build/C/man2/stat.2:314
6005 msgid "B<S_ISBLK>(m)"
6009 #: build/C/man2/stat.2:317
6010 msgid "block device?"
6014 #: build/C/man2/stat.2:317
6016 msgid "B<S_ISFIFO>(m)"
6020 #: build/C/man2/stat.2:320
6021 msgid "FIFO (named pipe)?"
6025 #: build/C/man2/stat.2:320
6027 msgid "B<S_ISLNK>(m)"
6031 #: build/C/man2/stat.2:323
6032 msgid "symbolic link? (Not in POSIX.1-1996.)"
6036 #: build/C/man2/stat.2:323
6038 msgid "B<S_ISSOCK>(m)"
6042 #: build/C/man2/stat.2:326
6043 msgid "socket? (Not in POSIX.1-1996.)"
6047 #: build/C/man2/stat.2:329
6048 msgid "The preceding code snippet could thus be rewritten as:"
6052 #: build/C/man2/stat.2:336
6055 "stat(pathname, &sb);\n"
6056 "if (S_ISREG(sb.st_mode)) {\n"
6057 " /* Handle regular file */\n"
6062 #: build/C/man2/stat.2:360
6064 "The definitions of most of the above file type test macros are provided if "
6065 "any of the following feature test macros is defined: B<_BSD_SOURCE> (in "
6066 "glibc 2.19 and earlier), B<_SVID_SOURCE> (in glibc 2.19 and earlier), or "
6067 "B<_DEFAULT_SOURCE> (in glibc 2.20 and later). In addition, definitions of "
6068 "all of the above macros except B<S_IFSOCK> and B<S_ISSOCK>() are provided "
6069 "if B<_XOPEN_SOURCE> is defined. The definition of B<S_IFSOCK> can also be "
6070 "exposed by defining B<_XOPEN_SOURCE> with a value of 500 or greater."
6074 #: build/C/man2/stat.2:372
6076 "The definition of B<S_ISSOCK>() is exposed if any of the following feature "
6077 "test macros is defined: B<_BSD_SOURCE> (in glibc 2.19 and earlier), "
6078 "B<_DEFAULT_SOURCE> (in glibc 2.20 and later), B<_XOPEN_SOURCE> with a value "
6079 "of 500 or greater, or B<_POSIX_C_SOURCE> with a value of 200112L or greater."
6083 #: build/C/man2/stat.2:377
6085 "The following mask values are defined for the file permissions component of "
6086 "the I<st_mode> field:"
6090 #: build/C/man2/stat.2:380
6092 msgid "S_ISUID\t0004000\tset-user-ID bit\n"
6096 #: build/C/man2/stat.2:381
6098 msgid "S_ISGID\t0002000\tset-group-ID bit (see below)\n"
6102 #: build/C/man2/stat.2:382
6104 msgid "S_ISVTX\t0001000\tsticky bit (see below)\n"
6108 #: build/C/man2/stat.2:384
6110 msgid "S_IRWXU\t 00700\tmask for file owner permissions\n"
6114 #: build/C/man2/stat.2:385
6116 msgid "S_IRUSR\t 00400\towner has read permission\n"
6120 #: build/C/man2/stat.2:386
6122 msgid "S_IWUSR\t 00200\towner has write permission\n"
6126 #: build/C/man2/stat.2:387
6128 msgid "S_IXUSR\t 00100\towner has execute permission\n"
6132 #: build/C/man2/stat.2:389
6134 msgid "S_IRWXG\t 00070\tmask for group permissions\n"
6138 #: build/C/man2/stat.2:390
6140 msgid "S_IRGRP\t 00040\tgroup has read permission\n"
6144 #: build/C/man2/stat.2:391
6146 msgid "S_IWGRP\t 00020\tgroup has write permission\n"
6150 #: build/C/man2/stat.2:392
6152 msgid "S_IXGRP\t 00010\tgroup has execute permission\n"
6156 #: build/C/man2/stat.2:394
6158 msgid "S_IRWXO\t 00007\tT{\n"
6162 #: build/C/man2/stat.2:395
6164 msgid "mask for permissions for others (not in group)\n"
6168 #: build/C/man2/stat.2:396 build/C/man2/stat.2:695 build/C/man2/stat.2:703 build/C/man2/stat.2:714 build/C/man2/stat.2:726 build/C/man2/stat.2:731 build/C/man2/stat.2:734 build/C/man2/stat.2:738
6174 #: build/C/man2/stat.2:397
6176 msgid "S_IROTH\t 00004\tothers have read permission\n"
6180 #: build/C/man2/stat.2:398
6182 msgid "S_IWOTH\t 00002\tothers have write permission\n"
6186 #: build/C/man2/stat.2:399
6188 msgid "S_IXOTH\t 00001\tothers have execute permission\n"
6192 #: build/C/man2/stat.2:416
6194 "The set-group-ID bit (B<S_ISGID>) has several special uses. For a "
6195 "directory, it indicates that BSD semantics is to be used for that directory: "
6196 "files created there inherit their group ID from the directory, not from the "
6197 "effective group ID of the creating process, and directories created there "
6198 "will also get the B<S_ISGID> bit set. For a file that does not have the "
6199 "group execution bit (B<S_IXGRP>) set, the set-group-ID bit indicates "
6200 "mandatory file/record locking."
6204 #: build/C/man2/stat.2:425
6206 "The sticky bit (B<S_ISVTX>) on a directory means that a file in that "
6207 "directory can be renamed or deleted only by the owner of the file, by the "
6208 "owner of the directory, and by a privileged process."
6212 #: build/C/man2/stat.2:425
6218 #: build/C/man2/stat.2:431
6220 "The B<fstatat>() system call operates in exactly the same way as B<stat>(), "
6221 "except for the differences described here."
6225 #: build/C/man2/stat.2:441
6227 "If the pathname given in I<pathname> is relative, then it is interpreted "
6228 "relative to the directory referred to by the file descriptor I<dirfd> "
6229 "(rather than relative to the current working directory of the calling "
6230 "process, as is done by B<stat>() for a relative pathname)."
6234 #: build/C/man2/stat.2:453
6236 "If I<pathname> is relative and I<dirfd> is the special value B<AT_FDCWD>, "
6237 "then I<pathname> is interpreted relative to the current working directory of "
6238 "the calling process (like B<stat>())."
6242 #: build/C/man2/stat.2:459
6243 msgid "If I<pathname> is absolute, then I<dirfd> is ignored."
6247 #: build/C/man2/stat.2:462
6249 "I<flags> can either be 0, or include one or more of the following flags "
6254 #: build/C/man2/stat.2:462
6256 msgid "B<AT_EMPTY_PATH> (since Linux 2.6.39)"
6259 #. commit 65cfc6722361570bfe255698d9cd4dccaf47570d
6260 #. Before glibc 2.16, defining _ATFILE_SOURCE sufficed
6262 #: build/C/man2/stat.2:485
6264 "If I<pathname> is an empty string, operate on the file referred to by "
6265 "I<dirfd> (which may have been obtained using the B<open>(2) B<O_PATH> "
6266 "flag). If I<dirfd> is B<AT_FDCWD>, the call operates on the current working "
6267 "directory. In this case, I<dirfd> can refer to any type of file, not just a "
6268 "directory. This flag is Linux-specific; define B<_GNU_SOURCE> to obtain its "
6273 #: build/C/man2/stat.2:485
6275 msgid "B<AT_NO_AUTOMOUNT> (since Linux 2.6.38)"
6278 #. Before glibc 2.16, defining _ATFILE_SOURCE sufficed
6280 #: build/C/man2/stat.2:501
6282 "Don't automount the terminal (\"basename\") component of I<pathname> if it "
6283 "is a directory that is an automount point. This allows the caller to gather "
6284 "attributes of an automount point (rather than the location it would mount). "
6285 "This flag can be used in tools that scan directories to prevent "
6286 "mass-automounting of a directory of automount points. The "
6287 "B<AT_NO_AUTOMOUNT> flag has no effect if the mount point has already been "
6288 "mounted over. This flag is Linux-specific; define B<_GNU_SOURCE> to obtain "
6293 #: build/C/man2/stat.2:501
6295 msgid "B<AT_SYMLINK_NOFOLLOW>"
6299 #: build/C/man2/stat.2:512
6301 "If I<pathname> is a symbolic link, do not dereference it: instead return "
6302 "information about the link itself, like B<lstat>(). (By default, "
6303 "B<fstatat>() dereferences symbolic links, like B<stat>().)"
6307 #: build/C/man2/stat.2:517
6308 msgid "See B<openat>(2) for an explanation of the need for B<fstatat>()."
6312 #: build/C/man2/stat.2:530
6314 "Search permission is denied for one of the directories in the path prefix of "
6315 "I<pathname>. (See also B<path_resolution>(7).)"
6319 #: build/C/man2/stat.2:534
6320 msgid "I<fd> is bad."
6324 #: build/C/man2/stat.2:537
6325 msgid "Bad address."
6329 #: build/C/man2/stat.2:540
6330 msgid "Too many symbolic links encountered while traversing the path."
6334 #: build/C/man2/stat.2:551
6336 "A component of I<pathname> does not exist, or I<pathname> is an empty "
6341 #: build/C/man2/stat.2:554
6342 msgid "Out of memory (i.e., kernel memory)."
6346 #: build/C/man2/stat.2:559
6347 msgid "A component of the path prefix of I<pathname> is not a directory."
6351 #: build/C/man2/stat.2:559 build/C/man2/statfs.2:215 build/C/man3/statvfs.3:154
6353 msgid "B<EOVERFLOW>"
6357 #: build/C/man2/stat.2:578
6359 "I<pathname> or I<fd> refers to a file whose size, inode number, or number of "
6360 "blocks cannot be represented in, respectively, the types I<off_t>, I<ino_t>, "
6361 "or I<blkcnt_t>. This error can occur when, for example, an application "
6362 "compiled on a 32-bit platform without I<-D_FILE_OFFSET_BITS=64> calls "
6363 "B<stat>() on a file whose size exceeds I<(1E<lt>E<lt>31)-1> bytes."
6367 #: build/C/man2/stat.2:581
6368 msgid "The following additional errors can occur for B<fstatat>():"
6372 #: build/C/man2/stat.2:585
6373 msgid "I<dirfd> is not a valid file descriptor."
6377 #: build/C/man2/stat.2:589
6378 msgid "Invalid flag specified in I<flags>."
6382 #: build/C/man2/stat.2:595
6384 "I<pathname> is relative and I<dirfd> is a file descriptor referring to a "
6385 "file other than a directory."
6389 #: build/C/man2/stat.2:599
6391 "B<fstatat>() was added to Linux in kernel 2.6.16; library support was added "
6392 "to glibc in version 2.4."
6395 #. SVr4 documents additional
6397 #. error conditions EINTR, ENOLINK, and EOVERFLOW. SVr4
6398 #. documents additional
6402 #. error conditions EINTR, EMULTIHOP, ENOLINK, and EOVERFLOW.
6404 #: build/C/man2/stat.2:612
6405 msgid "B<stat>(), B<fstat>(), B<lstat>(): SVr4, 4.3BSD, POSIX.1-2001, POSIX.1.2008."
6409 #: build/C/man2/stat.2:615
6410 msgid "B<fstatat>(): POSIX.1-2008."
6414 #: build/C/man2/stat.2:629
6416 "According to POSIX.1-2001, B<lstat>() on a symbolic link need return valid "
6417 "information only in the I<st_size> field and the file-type component of the "
6418 "I<st_mode> field of the I<stat> structure. POSIX.1-2008 tightens the "
6419 "specification, requiring B<lstat>() to return valid information in all "
6420 "fields except the permission bits in I<st_mode>."
6424 #: build/C/man2/stat.2:649
6426 "Use of the I<st_blocks> and I<st_blksize> fields may be less portable. "
6427 "(They were introduced in BSD. The interpretation differs between systems, "
6428 "and possibly on a single system when NFS mounts are involved.) If you need "
6429 "to obtain the definition of the I<blkcnt_t> or I<blksize_t> types from "
6430 "I<E<lt>sys/stat.hE<gt>>, then define B<_XOPEN_SOURCE> with the value 500 or "
6431 "greater (before including I<any> header files)."
6435 #: build/C/man2/stat.2:667
6437 "POSIX.1-1990 did not describe the B<S_IFMT>, B<S_IFSOCK>, B<S_IFLNK>, "
6438 "B<S_IFREG>, B<S_IFBLK>, B<S_IFDIR>, B<S_IFCHR>, B<S_IFIFO>, B<S_ISVTX> "
6439 "constants, but instead demanded the use of the macros B<S_ISDIR>(), and so "
6440 "on. The B<S_IF*> constants are present in POSIX.1-2001 and later."
6444 #: build/C/man2/stat.2:675
6446 "The B<S_ISLNK>() and B<S_ISSOCK>() macros are not in POSIX.1-1996, but "
6447 "both are present in POSIX.1-2001; the former is from SVID 4, the latter from "
6452 #: build/C/man2/stat.2:685
6454 "UNIX\\ V7 (and later systems) had B<S_IREAD>, B<S_IWRITE>, B<S_IEXEC>, where "
6455 "POSIX prescribes the synonyms B<S_IRUSR>, B<S_IWUSR>, B<S_IXUSR>."
6459 #: build/C/man2/stat.2:685
6461 msgid "Other systems"
6465 #: build/C/man2/stat.2:687
6466 msgid "Values that have been (or are) in use on various systems:"
6470 #: build/C/man2/stat.2:690
6472 msgid "hex\tname\tls\toctal\tdescription\n"
6476 #: build/C/man2/stat.2:691
6478 msgid "f000\tS_IFMT\t\t170000\tmask for file type\n"
6482 #: build/C/man2/stat.2:692
6484 msgid "0000\t\t\t000000\tT{\n"
6488 #: build/C/man2/stat.2:693
6490 msgid "SCO out-of-service inode; BSD unknown type; SVID-v2 and XPG2\n"
6494 #: build/C/man2/stat.2:694
6496 msgid "have both 0 and 0100000 for ordinary file\n"
6500 #: build/C/man2/stat.2:696
6502 msgid "1000\tS_IFIFO\tp|\t010000\tFIFO (named pipe)\n"
6506 #: build/C/man2/stat.2:697
6508 msgid "2000\tS_IFCHR\tc\t020000\tcharacter special (V7)\n"
6512 #: build/C/man2/stat.2:698
6514 msgid "3000\tS_IFMPC\t\t030000\tmultiplexed character special (V7)\n"
6518 #: build/C/man2/stat.2:699
6520 msgid "4000\tS_IFDIR\td/\t040000\tdirectory (V7)\n"
6524 #: build/C/man2/stat.2:700
6526 msgid "5000\tS_IFNAM\t\t050000\tT{\n"
6530 #: build/C/man2/stat.2:701
6532 msgid "XENIX named special file with two subtypes, distinguished by\n"
6536 #: build/C/man2/stat.2:702
6538 msgid "I<st_rdev> values 1, 2\n"
6542 #: build/C/man2/stat.2:704
6544 msgid "0001\tS_INSEM\ts\t000001\tXENIX semaphore subtype of IFNAM\n"
6548 #: build/C/man2/stat.2:705
6550 msgid "0002\tS_INSHD\tm\t000002\tXENIX shared data subtype of IFNAM\n"
6554 #: build/C/man2/stat.2:706
6556 msgid "6000\tS_IFBLK\tb\t060000\tblock special (V7)\n"
6560 #: build/C/man2/stat.2:707
6562 msgid "7000\tS_IFMPB\t\t070000\tmultiplexed block special (V7)\n"
6566 #: build/C/man2/stat.2:708
6568 msgid "8000\tS_IFREG\t-\t100000\tregular (V7)\n"
6572 #: build/C/man2/stat.2:709
6574 msgid "9000\tS_IFCMP\t\t110000\tVxFS compressed\n"
6578 #: build/C/man2/stat.2:710
6580 msgid "9000\tS_IFNWK\tn\t110000\tnetwork special (HP-UX)\n"
6584 #: build/C/man2/stat.2:711
6586 msgid "a000\tS_IFLNK\tl@\t120000\tsymbolic link (BSD)\n"
6590 #: build/C/man2/stat.2:712
6592 msgid "b000\tS_IFSHAD\t\t130000\tT{\n"
6596 #: build/C/man2/stat.2:713
6598 msgid "Solaris shadow inode for ACL (not seen by user space)\n"
6602 #: build/C/man2/stat.2:715
6604 msgid "c000\tS_IFSOCK\ts=\t140000\tsocket (BSD; also \"S_IFSOC\" on VxFS)\n"
6608 #: build/C/man2/stat.2:716
6610 msgid "d000\tS_IFDOOR\tDE<gt>\t150000\tSolaris door\n"
6614 #: build/C/man2/stat.2:717
6616 msgid "e000\tS_IFWHT\tw%\t160000\tBSD whiteout (not used for inode)\n"
6620 #: build/C/man2/stat.2:718
6622 msgid "0200\tS_ISVTX\t\t001000\tT{\n"
6626 #: build/C/man2/stat.2:719
6628 msgid "sticky bit: save swapped text even after use (V7)\n"
6632 #: build/C/man2/stat.2:720 build/C/man2/stat.2:722 build/C/man2/stat.2:724 build/C/man2/stat.2:729
6638 #: build/C/man2/stat.2:721
6640 msgid "reserved (SVID-v2)\n"
6644 #: build/C/man2/stat.2:723
6646 msgid "On nondirectories: don't cache this file (SunOS)\n"
6650 #: build/C/man2/stat.2:725
6652 msgid "On directories: restricted deletion flag (SVID-v4.2)\n"
6656 #: build/C/man2/stat.2:727
6658 msgid "0400\tS_ISGID\t\t002000\tT{\n"
6662 #: build/C/man2/stat.2:728
6664 msgid "set-group-ID on execution (V7)\n"
6668 #: build/C/man2/stat.2:730
6670 msgid "for directories: use BSD semantics for propagation of GID\n"
6674 #: build/C/man2/stat.2:732
6676 msgid "0400\tS_ENFMT\t\t002000\tT{\n"
6680 #: build/C/man2/stat.2:733
6682 msgid "System V file locking enforcement (shared with S_ISGID)\n"
6686 #: build/C/man2/stat.2:735
6688 msgid "0800\tS_ISUID\t\t004000\tset-user-ID on execution (V7)\n"
6692 #: build/C/man2/stat.2:736
6694 msgid "0800\tS_CDF\t\t004000\tT{\n"
6698 #: build/C/man2/stat.2:737
6700 msgid "directory is a context dependent file (HP-UX)\n"
6704 #: build/C/man2/stat.2:743
6705 msgid "A sticky command appeared in Version 32V AT&T UNIX."
6709 #: build/C/man2/stat.2:750
6711 "On Linux, B<lstat>() will generally not trigger automounter action, whereas "
6712 "B<stat>() will (but see B<fstatat>(2))."
6716 #: build/C/man2/stat.2:758
6718 "For most files under the I</proc> directory, B<stat>() does not return the "
6719 "file size in the I<st_size> field; instead the field is returned with the "
6724 #: build/C/man2/stat.2:758
6726 msgid "Timestamp fields"
6730 #: build/C/man2/stat.2:769
6732 "Older kernels and older standards did not support nanosecond timestamp "
6733 "fields. Instead, there were three timestamp fields\\(emI<st_atime>, "
6734 "I<st_mtime>, and I<st_ctime>\\(emtyped as I<time_t> that recorded timestamps "
6735 "with one-second precision."
6739 #: build/C/man2/stat.2:791
6741 "Since kernel 2.5.48, the I<stat> structure supports nanosecond resolution "
6742 "for the three file timestamp fields. The nanosecond components of each "
6743 "timestamp are available via names of the form I<st_atim.tv_nsec> if the "
6744 "B<_BSD_SOURCE> or B<_SVID_SOURCE> feature test macro is defined. Nanosecond "
6745 "timestamps are nowadays standardized, starting with POSIX.1-2008, and, "
6746 "starting with version 2.12, glibc also exposes the nanosecond component "
6747 "names if B<_POSIX_C_SOURCE> is defined with the value 200809L or greater, or "
6748 "B<_XOPEN_SOURCE> is defined with the value 700 or greater. If none of the "
6749 "aforementioned macros are defined, then the nanosecond values are exposed "
6750 "with names of the form I<st_atimensec>."
6753 #. commit ef7f38359ea8b3e9c7f2cae9a4d4935f55ca9e80
6755 #: build/C/man2/stat.2:798
6757 "Nanosecond timestamps are supported on XFS, JFS, Btrfs, and ext4 (since "
6758 "Linux 2.6.23). Nanosecond timestamps are not supported in ext2, ext3, and "
6759 "Reiserfs. On filesystems that do not support subsecond timestamps, the "
6760 "nanosecond fields are returned with the value 0."
6764 #: build/C/man2/stat.2:798
6766 msgid "Underlying kernel interface"
6770 #. A note from Andries Brouwer, July 2007
6772 #. > Is the story not rather more complicated for some calls like
6775 #. Yes and no, mostly no. See /usr/include/sys/stat.h .
6777 #. The idea is here not so much that syscalls change, but that
6778 #. the definitions of struct stat and of the types dev_t and mode_t change.
6779 #. This means that libc (even if it does not call the kernel
6780 #. but only calls some internal function) must know what the
6781 #. format of dev_t or of struct stat is.
6782 #. The communication between the application and libc goes via
6783 #. the include file <sys/stat.h> that defines a _STAT_VER and
6784 #. _MKNOD_VER describing the layout of the data that user space
6785 #. uses. Each (almost each) occurrence of stat() is replaced by
6786 #. an occurrence of xstat() where the first parameter of xstat()
6787 #. is this version number _STAT_VER.
6789 #. Now, also the definitions used by the kernel change.
6790 #. But glibc copes with this in the standard way, and the
6791 #. struct stat as returned by the kernel is repacked into
6792 #. the struct stat as expected by the application.
6793 #. Thus, _STAT_VER and this setup cater for the application-libc
6794 #. interface, rather than the libc-kernel interface.
6796 #. (Note that the details depend on gcc being used as c compiler.)
6798 #: build/C/man2/stat.2:850
6800 "Over time, increases in the size of the I<stat> structure have led to three "
6801 "successive versions of B<stat>(): I<sys_stat>() (slot I<__NR_oldstat>), "
6802 "I<sys_newstat>() (slot I<__NR_stat>), and I<sys_stat64()> (new in kernel "
6803 "2.4; slot I<__NR_stat64>). The glibc B<stat>() wrapper function hides "
6804 "these details from applications, invoking the most recent version of the "
6805 "system call provided by the kernel, and repacking the returned information "
6806 "if required for old binaries. Similar remarks apply for B<fstat>() and "
6811 #: build/C/man2/stat.2:855
6813 "The underlying system call employed by the glibc B<fstatat>() wrapper "
6814 "function is actually called B<fstatat64>()."
6818 #: build/C/man2/stat.2:861
6820 "The following program calls B<stat>() and displays selected fields in the "
6821 "returned I<stat> structure."
6825 #: build/C/man2/stat.2:868
6828 "#include E<lt>sys/types.hE<gt>\n"
6829 "#include E<lt>sys/stat.hE<gt>\n"
6830 "#include E<lt>time.hE<gt>\n"
6831 "#include E<lt>stdio.hE<gt>\n"
6832 "#include E<lt>stdlib.hE<gt>\n"
6836 #: build/C/man2/stat.2:873
6840 "main(int argc, char *argv[])\n"
6842 " struct stat sb;\n"
6846 #: build/C/man2/stat.2:878
6849 " if (argc != 2) {\n"
6850 " fprintf(stderr, \"Usage: %s E<lt>pathnameE<gt>\\en\", argv[0]);\n"
6851 " exit(EXIT_FAILURE);\n"
6856 #: build/C/man2/stat.2:883
6859 " if (stat(argv[1], &sb) == -1) {\n"
6860 " perror(\"stat\");\n"
6861 " exit(EXIT_FAILURE);\n"
6866 #: build/C/man2/stat.2:885
6868 msgid " printf(\"File type: \");\n"
6872 #: build/C/man2/stat.2:896
6875 " switch (sb.st_mode & S_IFMT) {\n"
6876 " case S_IFBLK: printf(\"block device\\en\"); break;\n"
6877 " case S_IFCHR: printf(\"character device\\en\"); break;\n"
6878 " case S_IFDIR: printf(\"directory\\en\"); break;\n"
6879 " case S_IFIFO: printf(\"FIFO/pipe\\en\"); break;\n"
6880 " case S_IFLNK: printf(\"symlink\\en\"); break;\n"
6881 " case S_IFREG: printf(\"regular file\\en\"); break;\n"
6882 " case S_IFSOCK: printf(\"socket\\en\"); break;\n"
6883 " default: printf(\"unknown?\\en\"); break;\n"
6888 #: build/C/man2/stat.2:898
6890 msgid " printf(\"I-node number: %ld\\en\", (long) sb.st_ino);\n"
6894 #: build/C/man2/stat.2:901
6897 " printf(\"Mode: %lo (octal)\\en\",\n"
6898 " (unsigned long) sb.st_mode);\n"
6902 #: build/C/man2/stat.2:905
6905 " printf(\"Link count: %ld\\en\", (long) sb.st_nlink);\n"
6906 " printf(\"Ownership: UID=%ld GID=%ld\\en\",\n"
6907 " (long) sb.st_uid, (long) sb.st_gid);\n"
6911 #: build/C/man2/stat.2:912
6914 " printf(\"Preferred I/O block size: %ld bytes\\en\",\n"
6915 " (long) sb.st_blksize);\n"
6916 " printf(\"File size: %lld bytes\\en\",\n"
6917 " (long long) sb.st_size);\n"
6918 " printf(\"Blocks allocated: %lld\\en\",\n"
6919 " (long long) sb.st_blocks);\n"
6923 #: build/C/man2/stat.2:916
6926 " printf(\"Last status change: %s\", ctime(&sb.st_ctime));\n"
6927 " printf(\"Last file access: %s\", ctime(&sb.st_atime));\n"
6928 " printf(\"Last file modification: %s\", ctime(&sb.st_mtime));\n"
6932 #: build/C/man2/stat.2:930
6934 "B<ls>(1), B<stat>(1), B<access>(2), B<chmod>(2), B<chown>(2), "
6935 "B<readlink>(2), B<utime>(2), B<capabilities>(7), B<symlink>(7)"
6939 #: build/C/man2/statfs.2:28
6945 #: build/C/man2/statfs.2:28
6951 #: build/C/man2/statfs.2:31
6952 msgid "statfs, fstatfs - get filesystem statistics"
6956 #: build/C/man2/statfs.2:33
6957 msgid "B<#include E<lt>sys/vfs.hE<gt> >/* or E<lt>sys/statfs.hE<gt> */"
6961 #: build/C/man2/statfs.2:35
6962 msgid "B<int statfs(const char *>I<path>B<, struct statfs *>I<buf>B<);>"
6966 #: build/C/man2/statfs.2:37
6967 msgid "B<int fstatfs(int >I<fd>B<, struct statfs *>I<buf>B<);>"
6971 #: build/C/man2/statfs.2:47
6973 "The function B<statfs>() returns information about a mounted filesystem. "
6974 "I<path> is the pathname of any file within the mounted filesystem. I<buf> "
6975 "is a pointer to a I<statfs> structure defined approximately as follows:"
6979 #: build/C/man2/statfs.2:55
6982 "#if __WORDSIZE == 32\t\t/* System word size */\n"
6983 "# define __SWORD_TYPE int\n"
6984 "#else /* __WORDSIZE == 64 */\n"
6985 "# define __SWORD_TYPE\t\tlong int\n"
6990 #: build/C/man2/statfs.2:70
6994 " __SWORD_TYPE f_type; /* type of filesystem (see below) */\n"
6995 " __SWORD_TYPE f_bsize; /* optimal transfer block size */\n"
6996 " fsblkcnt_t f_blocks; /* total data blocks in filesystem */\n"
6997 " fsblkcnt_t f_bfree; /* free blocks in fs */\n"
6998 " fsblkcnt_t f_bavail; /* free blocks available to\n"
6999 " unprivileged user */\n"
7000 " fsfilcnt_t f_files; /* total file nodes in filesystem */\n"
7001 " fsfilcnt_t f_ffree; /* free file nodes in fs */\n"
7002 " fsid_t f_fsid; /* filesystem id */\n"
7003 " __SWORD_TYPE f_namelen; /* maximum length of filenames */\n"
7004 " __SWORD_TYPE f_frsize; /* fragment size (since Linux 2.6) */\n"
7005 " __SWORD_TYPE f_spare[5];\n"
7010 #: build/C/man2/statfs.2:72
7012 msgid "Filesystem types:\n"
7016 #: build/C/man2/statfs.2:142
7019 " ADFS_SUPER_MAGIC 0xadf5\n"
7020 " AFFS_SUPER_MAGIC 0xADFF\n"
7021 " BDEVFS_MAGIC 0x62646576\n"
7022 " BEFS_SUPER_MAGIC 0x42465331\n"
7023 " BFS_MAGIC 0x1BADFACE\n"
7024 " BINFMTFS_MAGIC 0x42494e4d\n"
7025 " BTRFS_SUPER_MAGIC 0x9123683E\n"
7026 " CGROUP_SUPER_MAGIC 0x27e0eb\n"
7027 " CIFS_MAGIC_NUMBER 0xFF534D42\n"
7028 " CODA_SUPER_MAGIC 0x73757245\n"
7029 " COH_SUPER_MAGIC 0x012FF7B7\n"
7030 " CRAMFS_MAGIC 0x28cd3d45\n"
7031 " DEBUGFS_MAGIC 0x64626720\n"
7032 " DEVFS_SUPER_MAGIC 0x1373\n"
7033 " DEVPTS_SUPER_MAGIC 0x1cd1\n"
7034 " EFIVARFS_MAGIC 0xde5e81e4\n"
7035 " EFS_SUPER_MAGIC 0x00414A53\n"
7036 " EXT_SUPER_MAGIC 0x137D\n"
7037 " EXT2_OLD_SUPER_MAGIC 0xEF51\n"
7038 " EXT2_SUPER_MAGIC 0xEF53\n"
7039 " EXT3_SUPER_MAGIC 0xEF53\n"
7040 " EXT4_SUPER_MAGIC 0xEF53\n"
7041 " FUSE_SUPER_MAGIC 0x65735546\n"
7042 " FUTEXFS_SUPER_MAGIC 0xBAD1DEA\n"
7043 " HFS_SUPER_MAGIC 0x4244\n"
7044 " HOSTFS_SUPER_MAGIC 0x00c0ffee\n"
7045 " HPFS_SUPER_MAGIC 0xF995E849\n"
7046 " HUGETLBFS_MAGIC 0x958458f6\n"
7047 " ISOFS_SUPER_MAGIC 0x9660\n"
7048 " JFFS2_SUPER_MAGIC 0x72b6\n"
7049 " JFS_SUPER_MAGIC 0x3153464a\n"
7050 " MINIX_SUPER_MAGIC 0x137F /* orig. minix */\n"
7051 " MINIX_SUPER_MAGIC2 0x138F /* 30 char minix */\n"
7052 " MINIX2_SUPER_MAGIC 0x2468 /* minix V2 */\n"
7053 " MINIX2_SUPER_MAGIC2 0x2478 /* minix V2, 30 char names */\n"
7054 " MINIX3_SUPER_MAGIC 0x4d5a /* minix V3 fs, 60 char names */\n"
7055 " MQUEUE_MAGIC 0x19800202\n"
7056 " MSDOS_SUPER_MAGIC 0x4d44\n"
7057 " NCP_SUPER_MAGIC 0x564c\n"
7058 " NFS_SUPER_MAGIC 0x6969\n"
7059 " NILFS_SUPER_MAGIC 0x3434\n"
7060 " NTFS_SB_MAGIC 0x5346544e\n"
7061 " OPENPROM_SUPER_MAGIC 0x9fa1\n"
7062 " PIPEFS_MAGIC 0x50495045\n"
7063 " PROC_SUPER_MAGIC 0x9fa0\n"
7064 " PSTOREFS_MAGIC 0x6165676C\n"
7065 " QNX4_SUPER_MAGIC 0x002f\n"
7066 " QNX6_SUPER_MAGIC 0x68191122\n"
7067 " RAMFS_MAGIC 0x858458f6\n"
7068 " REISERFS_SUPER_MAGIC 0x52654973\n"
7069 " ROMFS_MAGIC 0x7275\n"
7070 " SELINUX_MAGIC 0xf97cff8c\n"
7071 " SMACK_MAGIC 0x43415d53\n"
7072 " SMB_SUPER_MAGIC 0x517B\n"
7073 " SOCKFS_MAGIC 0x534F434B\n"
7074 " SQUASHFS_MAGIC 0x73717368\n"
7075 " SYSFS_MAGIC 0x62656572\n"
7076 " SYSV2_SUPER_MAGIC 0x012FF7B6\n"
7077 " SYSV4_SUPER_MAGIC 0x012FF7B5\n"
7078 " TMPFS_MAGIC 0x01021994\n"
7079 " UDF_SUPER_MAGIC 0x15013346\n"
7080 " UFS_MAGIC 0x00011954\n"
7081 " USBDEVICE_SUPER_MAGIC 0x9fa2\n"
7082 " V9FS_MAGIC 0x01021997\n"
7083 " VXFS_SUPER_MAGIC 0xa501FCF5\n"
7084 " XENFS_SUPER_MAGIC 0xabba1974\n"
7085 " XENIX_SUPER_MAGIC 0x012FF7B4\n"
7086 " XFS_SUPER_MAGIC 0x58465342\n"
7087 " _XIAFS_SUPER_MAGIC 0x012FD16D\n"
7091 #: build/C/man2/statfs.2:148
7093 "Most of these MAGIC constants are defined in I</usr/include/linux/magic.h>, "
7094 "and some are hardcoded in kernel sources."
7098 #: build/C/man2/statfs.2:152
7099 msgid "Nobody knows what I<f_fsid> is supposed to contain (but see below)."
7103 #: build/C/man2/statfs.2:157
7105 "Fields that are undefined for a particular filesystem are set to 0. "
7106 "B<fstatfs>() returns the same information about an open file referenced by "
7111 #: build/C/man2/statfs.2:170
7113 "(B<statfs>()) Search permission is denied for a component of the path "
7114 "prefix of I<path>. (See also B<path_resolution>(7).)"
7118 #: build/C/man2/statfs.2:175
7119 msgid "(B<fstatfs>()) I<fd> is not a valid open file descriptor."
7123 #: build/C/man2/statfs.2:181
7124 msgid "I<buf> or I<path> points to an invalid address."
7128 #: build/C/man2/statfs.2:184 build/C/man3/statvfs.3:123
7129 msgid "This call was interrupted by a signal."
7133 #: build/C/man2/statfs.2:184 build/C/man3/statvfs.3:123
7139 #: build/C/man2/statfs.2:187 build/C/man3/statvfs.3:126
7140 msgid "An I/O error occurred while reading from the filesystem."
7144 #: build/C/man2/statfs.2:192
7146 "(B<statfs>()) Too many symbolic links were encountered in translating "
7151 #: build/C/man2/statfs.2:197
7152 msgid "(B<statfs>()) I<path> is too long."
7156 #: build/C/man2/statfs.2:203
7157 msgid "(B<statfs>()) The file referred to by I<path> does not exist."
7161 #: build/C/man2/statfs.2:206 build/C/man3/statvfs.3:145
7162 msgid "Insufficient kernel memory was available."
7166 #: build/C/man2/statfs.2:209 build/C/man3/statvfs.3:148
7167 msgid "The filesystem does not support this call."
7171 #: build/C/man2/statfs.2:215
7172 msgid "(B<statfs>()) A component of the path prefix of I<path> is not a directory."
7176 #: build/C/man2/statfs.2:218 build/C/man3/statvfs.3:157
7177 msgid "Some values were too large to be represented in the returned struct."
7181 #: build/C/man2/statfs.2:224
7183 "Linux-specific. The Linux B<statfs>() was inspired by the 4.4BSD one (but "
7184 "they do not use the same structure)."
7188 #: build/C/man2/statfs.2:246
7190 "The original Linux B<statfs>() and B<fstatfs>() system calls were not "
7191 "designed with extremely large file sizes in mind. Subsequently, Linux 2.6 "
7192 "added new B<statfs64>() and B<fstatfs64>() system calls that employ a new "
7193 "structure, I<statfs64>. The new structure contains the same fields as the "
7194 "original I<statfs> structure, but the sizes of various fields are increased, "
7195 "to accommodate large file sizes. The glibc B<statfs>() and B<fstatfs>() "
7196 "wrapper functions transparently deal with the kernel differences."
7200 #: build/C/man2/statfs.2:251
7202 "Some systems have only I<E<lt>sys/vfs.hE<gt>>, other systems also have "
7203 "I<E<lt>sys/statfs.hE<gt>>, where the former includes the latter. So it "
7204 "seems including the former is the best choice."
7208 #: build/C/man2/statfs.2:261
7210 "LSB has deprecated the library calls B<statfs>() and B<fstatfs>() and "
7211 "tells us to use B<statvfs>(2) and B<fstatvfs>(2) instead."
7215 #: build/C/man2/statfs.2:261
7217 msgid "The f_fsid field"
7221 #: build/C/man2/statfs.2:286
7223 "Solaris, Irix and POSIX have a system call B<statvfs>(2) that returns a "
7224 "I<struct statvfs> (defined in I<E<lt>sys/statvfs.hE<gt>>) containing an "
7225 "I<unsigned long> I<f_fsid>. Linux, SunOS, HP-UX, 4.4BSD have a system call "
7226 "B<statfs>() that returns a I<struct statfs> (defined in "
7227 "I<E<lt>sys/vfs.hE<gt>>) containing a I<fsid_t> I<f_fsid>, where I<fsid_t> "
7228 "is defined as I<struct { int val[2]; }>. The same holds for FreeBSD, except "
7229 "that it uses the include file I<E<lt>sys/mount.hE<gt>>."
7233 #: build/C/man2/statfs.2:299
7235 "The general idea is that I<f_fsid> contains some random stuff such that the "
7236 "pair (I<f_fsid>,I<ino>) uniquely determines a file. Some operating systems "
7237 "use (a variation on) the device number, or the device number combined with "
7238 "the filesystem type. Several operating systems restrict giving out the "
7239 "I<f_fsid> field to the superuser only (and zero it for unprivileged users), "
7240 "because this field is used in the filehandle of the filesystem when "
7241 "NFS-exported, and giving it out is a security concern."
7245 #: build/C/man2/statfs.2:305
7247 "Under some operating systems, the I<fsid> can be used as the second argument "
7248 "to the B<sysfs>(2) system call."
7251 #. broken in commit ff0c7d15f9787b7e8c601533c015295cc68329f8
7252 #. fixed in commit d70ef97baf048412c395bb5d65791d8fe133a52b
7254 #: build/C/man2/statfs.2:314
7256 "From Linux 2.6.38 up to and including Linux 3.1, B<fstatfs>() failed with "
7257 "the error B<ENOSYS> for file descriptors created by B<pipe>(2)."
7261 #: build/C/man2/statfs.2:318
7262 msgid "B<stat>(2), B<statvfs>(2), B<path_resolution>(7)"
7266 #: build/C/man3/statvfs.3:30
7272 #: build/C/man3/statvfs.3:30
7278 #: build/C/man3/statvfs.3:33
7279 msgid "statvfs, fstatvfs - get filesystem statistics"
7283 #: build/C/man3/statvfs.3:35
7284 msgid "B<#include E<lt>sys/statvfs.hE<gt>>"
7288 #: build/C/man3/statvfs.3:37
7289 msgid "B<int statvfs(const char *>I<path>B<, struct statvfs *>I<buf>B<);>"
7293 #: build/C/man3/statvfs.3:39
7294 msgid "B<int fstatvfs(int >I<fd>B<, struct statvfs *>I<buf>B<);>"
7298 #: build/C/man3/statvfs.3:49
7300 "The function B<statvfs>() returns information about a mounted filesystem. "
7301 "I<path> is the pathname of any file within the mounted filesystem. I<buf> "
7302 "is a pointer to a I<statvfs> structure defined approximately as follows:"
7306 #: build/C/man3/statvfs.3:65
7309 "struct statvfs {\n"
7310 " unsigned long f_bsize; /* filesystem block size */\n"
7311 " unsigned long f_frsize; /* fragment size */\n"
7312 " fsblkcnt_t f_blocks; /* size of fs in f_frsize units */\n"
7313 " fsblkcnt_t f_bfree; /* # free blocks */\n"
7314 " fsblkcnt_t f_bavail; /* # free blocks for unprivileged users */\n"
7315 " fsfilcnt_t f_files; /* # inodes */\n"
7316 " fsfilcnt_t f_ffree; /* # free inodes */\n"
7317 " fsfilcnt_t f_favail; /* # free inodes for unprivileged users */\n"
7318 " unsigned long f_fsid; /* filesystem ID */\n"
7319 " unsigned long f_flag; /* mount flags */\n"
7320 " unsigned long f_namemax; /* maximum filename length */\n"
7325 #: build/C/man3/statvfs.3:76
7327 "Here the types I<fsblkcnt_t> and I<fsfilcnt_t> are defined in "
7328 "I<E<lt>sys/types.hE<gt>>. Both used to be I<unsigned long>."
7332 #: build/C/man3/statvfs.3:82
7334 "The field I<f_flag> is a bit mask (of mount flags, see B<mount>(8)). Bits "
7335 "defined by POSIX are"
7339 #: build/C/man3/statvfs.3:82
7341 msgid "B<ST_RDONLY>"
7345 #: build/C/man3/statvfs.3:85
7346 msgid "Read-only filesystem."
7350 #: build/C/man3/statvfs.3:85
7352 msgid "B<ST_NOSUID>"
7356 #: build/C/man3/statvfs.3:89
7357 msgid "Set-user-ID/set-group-ID bits are ignored by B<exec>(3)."
7361 #: build/C/man3/statvfs.3:92
7363 "It is unspecified whether all members of the returned struct have meaningful "
7364 "values on all filesystems."
7368 #: build/C/man3/statvfs.3:96
7370 "B<fstatvfs>() returns the same information about an open file referenced by "
7375 #: build/C/man3/statvfs.3:109
7377 "(B<statvfs>()) Search permission is denied for a component of the path "
7378 "prefix of I<path>. (See also B<path_resolution>(7).)"
7382 #: build/C/man3/statvfs.3:114
7383 msgid "(B<fstatvfs>()) I<fd> is not a valid open file descriptor."
7387 #: build/C/man3/statvfs.3:120
7388 msgid "I<Buf> or I<path> points to an invalid address."
7392 #: build/C/man3/statvfs.3:131
7394 "(B<statvfs>()) Too many symbolic links were encountered in translating "
7399 #: build/C/man3/statvfs.3:136
7400 msgid "(B<statvfs>()) I<path> is too long."
7404 #: build/C/man3/statvfs.3:142
7405 msgid "(B<statvfs>()) The file referred to by I<path> does not exist."
7409 #: build/C/man3/statvfs.3:154
7411 "(B<statvfs>()) A component of the path prefix of I<path> is not a "
7416 #: build/C/man3/statvfs.3:157
7422 #: build/C/man3/statvfs.3:158
7424 msgid "Multithreading (see pthreads(7))"
7428 #: build/C/man3/statvfs.3:164
7429 msgid "The B<statvfs>() and B<fstatvfs>() functions are thread-safe."
7433 #: build/C/man3/statvfs.3:166
7434 msgid "POSIX.1-2001."
7438 #: build/C/man3/statvfs.3:172
7440 "The Linux kernel has system calls B<statfs>(2) and B<fstatfs>(2) to "
7441 "support this library call."
7445 #: build/C/man3/statvfs.3:174
7446 msgid "The current glibc implementations of"
7450 #: build/C/man3/statvfs.3:179
7453 " pathconf(path, _PC_REC_XFER_ALIGN);\n"
7454 " pathconf(path, _PC_ALLOC_SIZE_MIN);\n"
7455 " pathconf(path, _PC_REC_MIN_XFER_SIZE);\n"
7459 #: build/C/man3/statvfs.3:188
7461 "respectively use the I<f_frsize>, I<f_frsize>, and I<f_bsize> fields of the "
7462 "return value of I<statvfs(path,buf)>."
7466 #: build/C/man3/statvfs.3:190
7467 msgid "B<statfs>(2)"
7471 #: build/C/man2/sysfs.2:27
7477 #: build/C/man2/sysfs.2:27
7483 #: build/C/man2/sysfs.2:30
7484 msgid "sysfs - get filesystem type information"
7488 #: build/C/man2/sysfs.2:32
7489 msgid "B<int sysfs(int >I<option>B<, const char *>I<fsname>B<);>"
7493 #: build/C/man2/sysfs.2:34
7495 "B<int sysfs(int >I<option>B<, unsigned int >I<fs_index>B<, char "
7500 #: build/C/man2/sysfs.2:36
7501 msgid "B<int sysfs(int >I<option>B<);>"
7505 #: build/C/man2/sysfs.2:45
7507 "B<sysfs>() returns information about the filesystem types currently present "
7508 "in the kernel. The specific form of the B<sysfs>() call and the "
7509 "information returned depends on the I<option> in effect:"
7513 #: build/C/man2/sysfs.2:45
7519 #: build/C/man2/sysfs.2:50
7521 "Translate the filesystem identifier string I<fsname> into a filesystem type "
7526 #: build/C/man2/sysfs.2:50
7532 #: build/C/man2/sysfs.2:61
7534 "Translate the filesystem type index I<fs_index> into a null-terminated "
7535 "filesystem identifier string. This string will be written to the buffer "
7536 "pointed to by I<buf>. Make sure that I<buf> has enough space to accept the "
7541 #: build/C/man2/sysfs.2:61
7547 #: build/C/man2/sysfs.2:65
7548 msgid "Return the total number of filesystem types currently present in the kernel."
7552 #: build/C/man2/sysfs.2:67
7553 msgid "The numbering of the filesystem type indexes begins with zero."
7557 #: build/C/man2/sysfs.2:79
7559 "On success, B<sysfs>() returns the filesystem index for option B<1>, zero "
7560 "for option B<2>, and the number of currently configured filesystems for "
7561 "option B<3>. On error, -1 is returned, and I<errno> is set appropriately."
7565 #: build/C/man2/sysfs.2:84
7566 msgid "Either I<fsname> or I<buf> is outside your accessible address space."
7570 #: build/C/man2/sysfs.2:92
7572 "I<fsname> is not a valid filesystem type identifier; I<fs_index> is "
7573 "out-of-bounds; I<option> is invalid."
7576 #. SVr4 documents additional error conditions ENOLINK, ECOMM, and EINTR
7577 #. but has no ENOSYS condition.
7579 #: build/C/man2/sysfs.2:94 build/C/man2/ustat.2:98
7584 #: build/C/man2/sysfs.2:101
7586 "This System-V derived system call is obsolete; don't use it. On systems "
7587 "with I</proc>, the same information can be obtained via "
7588 "I</proc/filesystems>; use that interface instead."
7592 #: build/C/man2/sysfs.2:104
7594 "There is no libc or glibc support. There is no way to guess how large "
7599 #: build/C/man2/umount.2:30
7605 #: build/C/man2/umount.2:30
7611 #: build/C/man2/umount.2:33
7612 msgid "umount, umount2 - unmount filesystem"
7616 #: build/C/man2/umount.2:38
7618 msgid "B<int umount(const char *>I<target>B<);>\n"
7622 #: build/C/man2/umount.2:40
7624 msgid "B<int umount2(const char *>I<target>B<, int >I<flags>B<);>\n"
7627 #. Note: the kernel naming differs from the glibc naming
7628 #. umount2 is the glibc name for what the kernel now calls umount
7629 #. and umount is the glibc name for oldumount
7631 #: build/C/man2/umount.2:50
7633 "B<umount>() and B<umount2>() remove the attachment of the (topmost) "
7634 "filesystem mounted on I<target>."
7638 #: build/C/man2/umount.2:54
7640 "Appropriate privilege (Linux: the B<CAP_SYS_ADMIN> capability) is required "
7641 "to unmount filesystems."
7645 #: build/C/man2/umount.2:62
7647 "Linux 2.1.116 added the B<umount2>() system call, which, like B<umount>(), "
7648 "unmounts a target, but allows additional I<flags> controlling the behavior "
7653 #: build/C/man2/umount.2:62
7655 msgid "B<MNT_FORCE> (since Linux 2.1.116)"
7659 #: build/C/man2/umount.2:67
7661 "Force unmount even if busy. This can cause data loss. (Only for NFS "
7666 #: build/C/man2/umount.2:67
7668 msgid "B<MNT_DETACH> (since Linux 2.4.11)"
7672 #: build/C/man2/umount.2:72
7674 "Perform a lazy unmount: make the mount point unavailable for new accesses, "
7675 "and actually perform the unmount when the mount point ceases to be busy."
7679 #: build/C/man2/umount.2:72
7681 msgid "B<MNT_EXPIRE> (since Linux 2.6.8)"
7685 #: build/C/man2/umount.2:91
7687 "Mark the mount point as expired. If a mount point is not currently in use, "
7688 "then an initial call to B<umount2>() with this flag fails with the error "
7689 "B<EAGAIN>, but marks the mount point as expired. The mount point remains "
7690 "expired as long as it isn't accessed by any process. A second B<umount2>() "
7691 "call specifying B<MNT_EXPIRE> unmounts an expired mount point. This flag "
7692 "cannot be specified with either B<MNT_FORCE> or B<MNT_DETACH>."
7696 #: build/C/man2/umount.2:91
7698 msgid "B<UMOUNT_NOFOLLOW> (since Linux 2.6.34)"
7701 #. Later added to 2.6.33-stable
7703 #: build/C/man2/umount.2:99
7705 "Don't dereference I<target> if it is a symbolic link. This flag allows "
7706 "security problems to be avoided in set-user-ID-I<root> programs that allow "
7707 "unprivileged users to unmount filesystems."
7711 #: build/C/man2/umount.2:110
7717 #: build/C/man2/umount.2:117
7719 "A call to B<umount2>() specifying B<MNT_EXPIRE> successfully marked an "
7720 "unbusy filesystem as expired."
7724 #: build/C/man2/umount.2:121
7725 msgid "I<target> could not be unmounted because it is busy."
7729 #: build/C/man2/umount.2:125
7730 msgid "I<target> points outside the user address space."
7734 #: build/C/man2/umount.2:129
7735 msgid "I<target> is not a mount point."
7739 #: build/C/man2/umount.2:138
7741 "B<umount2>() was called with B<MNT_EXPIRE> and either B<MNT_DETACH> or "
7746 #: build/C/man2/umount.2:138
7748 msgid "B<EINVAL> (since Linux 2.6.34)"
7752 #: build/C/man2/umount.2:143
7753 msgid "B<umount2>() was called with an invalid flag value in I<flags>."
7756 #. http://sourceware.org/bugzilla/show_bug.cgi?id=10092
7758 #: build/C/man2/umount.2:162
7759 msgid "B<MNT_DETACH> and B<MNT_EXPIRE> are available in glibc since version 2.11."
7763 #: build/C/man2/umount.2:165
7765 "These functions are Linux-specific and should not be used in programs "
7766 "intended to be portable."
7770 #: build/C/man2/umount.2:176
7772 "The original B<umount>() function was called as I<umount(device)> and would "
7773 "return B<ENOTBLK> when called with something other than a block device. In "
7774 "Linux 0.98p4, a call I<umount(dir)> was added, in order to support anonymous "
7775 "devices. In Linux 2.3.99-pre7, the call I<umount(device)> was removed, "
7776 "leaving only I<umount(dir)> (since now devices can be mounted in more than "
7777 "one place, so specifying the device does not suffice)."
7781 #: build/C/man2/umount.2:181
7782 msgid "B<mount>(2), B<path_resolution>(7), B<mount>(8), B<umount>(8)"
7786 #: build/C/man2/ustat.2:30
7792 #: build/C/man2/ustat.2:30
7798 #: build/C/man2/ustat.2:33
7799 msgid "ustat - get filesystem statistics"
7803 #: build/C/man2/ustat.2:38
7805 msgid "B<#include E<lt>unistd.hE<gt>> /* libc[45] */\n"
7809 #: build/C/man2/ustat.2:40
7811 msgid "B<#include E<lt>ustat.hE<gt>> /* glibc2 */\n"
7815 #: build/C/man2/ustat.2:42
7817 msgid "B<int ustat(dev_t >I<dev>B<, struct ustat *>I<ubuf>B<);>\n"
7821 #: build/C/man2/ustat.2:54
7823 "B<ustat>() returns information about a mounted filesystem. I<dev> is a "
7824 "device number identifying a device containing a mounted filesystem. I<ubuf> "
7825 "is a pointer to a I<ustat> structure that contains the following members:"
7829 #: build/C/man2/ustat.2:61
7832 "daddr_t f_tfree; /* Total free blocks */\n"
7833 "ino_t f_tinode; /* Number of free inodes */\n"
7834 "char f_fname[6]; /* Filsys name */\n"
7835 "char f_fpack[6]; /* Filsys pack name */\n"
7839 #: build/C/man2/ustat.2:70
7841 "The last two fields, I<f_fname> and I<f_fpack>, are not implemented and will "
7842 "always be filled with null bytes (\\(aq\\e0\\(aq)."
7846 #: build/C/man2/ustat.2:79
7848 "On success, zero is returned and the I<ustat> structure pointed to by "
7849 "I<ubuf> will be filled in. On error, -1 is returned, and I<errno> is set "
7854 #: build/C/man2/ustat.2:84
7855 msgid "I<ubuf> points outside of your accessible address space."
7859 #: build/C/man2/ustat.2:88
7860 msgid "I<dev> does not refer to a device containing a mounted filesystem."
7864 #: build/C/man2/ustat.2:94
7866 "The mounted filesystem referenced by I<dev> does not support this operation, "
7867 "or any version of Linux before 1.3.16."
7871 #: build/C/man2/ustat.2:104
7873 "B<ustat>() is deprecated and has been provided only for compatibility. All "
7874 "new programs should use B<statfs>(2) instead."
7878 #: build/C/man2/ustat.2:104
7883 #. Some software tries to use this in order to test whether the
7884 #. underlying filesystem is NFS.
7886 #: build/C/man2/ustat.2:118
7888 "The HP-UX version of the I<ustat> structure has an additional field, "
7889 "I<f_blksize>, that is unknown elsewhere. HP-UX warns: For some filesystems, "
7890 "the number of free inodes does not change. Such filesystems will return -1 "
7891 "in the field I<f_tinode>. For some filesystems, inodes are dynamically "
7892 "allocated. Such filesystems will return the current number of free inodes."
7896 #: build/C/man2/ustat.2:121
7897 msgid "B<stat>(2), B<statfs>(2)"