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: 2014-04-24 00:50+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/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/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/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/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:93 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:420 build/C/man3/getfsent.3:139 build/C/man3/getmntent.3:219 build/C/man2/getxattr.2:141 build/C/man2/listxattr.2:153 build/C/man2/mount.2:482 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:845 build/C/man2/statfs.2:277 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:424 build/C/man3/getfsent.3:142 build/C/man3/getmntent.3:223 build/C/man2/getxattr.2:151 build/C/man2/listxattr.2:163 build/C/man2/mount.2:489 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:855 build/C/man2/statfs.2:281 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:208 build/C/man3/fts.3:803 build/C/man3/ftw.3:431 build/C/man3/getfsent.3:149 build/C/man3/getmntent.3:230 build/C/man2/getxattr.2:158 build/C/man2/listxattr.2:170 build/C/man2/mount.2:496 build/C/man7/path_resolution.7:249 build/C/man2/removexattr.2:127 build/C/man2/setxattr.2:169 build/C/man2/spu_create.2:282 build/C/man2/spu_run.2:276 build/C/man7/spufs.7:780 build/C/man2/stat.2:862 build/C/man2/statfs.2:288 build/C/man3/statvfs.3:197 build/C/man2/sysfs.2:111 build/C/man2/umount.2:188 build/C/man2/ustat.2:128
420 "This page is part of release 3.65 of the Linux I<man-pages> project. A "
421 "description of the project, and information about reporting bugs, can be "
422 "found at \\%http://www.kernel.org/doc/man-pages/."
426 #: build/C/man3/fts.3:40
432 #: build/C/man3/fts.3:40
438 #: build/C/man3/fts.3:44
440 "fts, fts_open, fts_read, fts_children, fts_set, fts_close - traverse a file "
445 #: 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/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
451 #: build/C/man3/fts.3:49
454 "B<#include E<lt>sys/types.hE<gt>>\n"
455 "B<#include E<lt>sys/stat.hE<gt>>\n"
456 "B<#include E<lt>fts.hE<gt>>\n"
460 #: build/C/man3/fts.3:52
463 "B<FTS *fts_open(char * const *>I<path_argv>B<, int >I<options>B<, >\n"
464 "B< int (*>I<compar>B<)(const FTSENT **, const FTSENT **));>\n"
468 #: build/C/man3/fts.3:54
470 msgid "B<FTSENT *fts_read(FTS *>I<ftsp>B<);>\n"
474 #: build/C/man3/fts.3:56
476 msgid "B<FTSENT *fts_children(FTS *>I<ftsp>B<, int >I<options>B<);>\n"
480 #: build/C/man3/fts.3:58
482 msgid "B<int fts_set(FTS *>I<ftsp>B<, FTSENT *>I<f>B<, int >I<options>B<);>\n"
486 #: build/C/man3/fts.3:60
488 msgid "B<int fts_close(FTS *>I<ftsp>B<);>\n"
492 #: build/C/man3/fts.3:87
494 "The fts functions are provided for traversing file hierarchies. A simple "
495 "overview is that the B<fts_open>() function returns a \"handle\" on a file "
496 "hierarchy, which is then supplied to the other fts functions. The function "
497 "B<fts_read>() returns a pointer to a structure describing one of the files "
498 "in the file hierarchy. The function B<fts_children>() returns a pointer to "
499 "a linked list of structures, each of which describes one of the files "
500 "contained in a directory in the hierarchy. In general, directories are "
501 "visited two distinguishable times; in preorder (before any of their "
502 "descendants are visited) and in postorder (after all of their descendants "
503 "have been visited). Files are visited once. It is possible to walk the "
504 "hierarchy \"logically\" (visiting the files that symbolic links point to) "
505 "or physically (visiting the symbolic links themselves), order the walk of "
506 "the hierarchy or prune and/or revisit portions of the hierarchy."
510 #: build/C/man3/fts.3:108
512 "Two structures are defined (and typedef'd) in the include file "
513 "I<E<lt>fts.hE<gt>>. The first is I<FTS>, the structure that represents the "
514 "file hierarchy itself. The second is I<FTSENT>, the structure that "
515 "represents a file in the file hierarchy. Normally, an I<FTSENT> structure "
516 "is returned for every file in the file hierarchy. In this manual page, "
517 "\"file\" and \"FTSENT structure\" are generally interchangeable. The "
518 "I<FTSENT> structure contains at least the following fields, which are "
519 "described in greater detail below:"
523 #: build/C/man3/fts.3:127
526 "typedef struct _ftsent {\n"
527 " unsigned short fts_info; /* flags for FTSENT structure */\n"
528 " char *fts_accpath; /* access path */\n"
529 " char *fts_path; /* root path */\n"
530 " short fts_pathlen; /* strlen(fts_path) */\n"
531 " char *fts_name; /* filename */\n"
532 " short fts_namelen; /* strlen(fts_name) */\n"
533 " short fts_level; /* depth (-1 to N) */\n"
534 " int fts_errno; /* file errno */\n"
535 " long fts_number; /* local numeric value */\n"
536 " void *fts_pointer; /* local address value */\n"
537 " struct ftsent *fts_parent; /* parent directory */\n"
538 " struct ftsent *fts_link; /* next file structure */\n"
539 " struct ftsent *fts_cycle; /* cycle structure */\n"
540 " struct stat *fts_statp; /* stat(2) information */\n"
544 #. .Bl -tag -width "fts_namelen"
546 #: build/C/man3/fts.3:132
547 msgid "These fields are defined as follows:"
551 #: build/C/man3/fts.3:132
556 #. .Bl -tag -width FTS_DEFAULT
558 #: build/C/man3/fts.3:144
560 "One of the following flags describing the returned I<FTSENT> structure and "
561 "the file it represents. With the exception of directories without errors "
562 "(B<FTS_D>), all of these entries are terminal, that is, they will not be "
563 "revisited, nor will any of their descendants be visited."
567 #: build/C/man3/fts.3:145
573 #: build/C/man3/fts.3:148
574 msgid "A directory being visited in preorder."
578 #: build/C/man3/fts.3:148
584 #: build/C/man3/fts.3:156
586 "A directory that causes a cycle in the tree. (The I<fts_cycle> field of the "
587 "I<FTSENT> structure will be filled in as well.)"
591 #: build/C/man3/fts.3:156
593 msgid "B<FTS_DEFAULT>"
597 #: build/C/man3/fts.3:164
599 "Any I<FTSENT> structure that represents a file type not explicitly described "
600 "by one of the other I<fts_info> values."
604 #: build/C/man3/fts.3:164
610 #: build/C/man3/fts.3:170
612 "A directory which cannot be read. This is an error return, and the "
613 "I<fts_errno> field will be set to indicate what caused the error."
617 #: build/C/man3/fts.3:170
623 #: build/C/man3/fts.3:180
625 "A file named \".\" or \"..\" which was not specified as a filename to "
626 "B<fts_open>() (see B<FTS_SEEDOT>)."
630 #: build/C/man3/fts.3:180
636 #: build/C/man3/fts.3:190
638 "A directory being visited in postorder. The contents of the I<FTSENT> "
639 "structure will be unchanged from when it was returned in preorder, that is, "
640 "with the I<fts_info> field set to B<FTS_D>."
644 #: build/C/man3/fts.3:190
650 #: build/C/man3/fts.3:195
652 "This is an error return, and the I<fts_errno> field will be set to indicate "
653 "what caused the error."
657 #: build/C/man3/fts.3:195
663 #: build/C/man3/fts.3:198
664 msgid "A regular file."
668 #: build/C/man3/fts.3:198
674 #: build/C/man3/fts.3:209
676 "A file for which no B<stat>(2) information was available. The contents of "
677 "the I<fts_statp> field are undefined. This is an error return, and the "
678 "I<fts_errno> field will be set to indicate what caused the error."
682 #: build/C/man3/fts.3:209
688 #: build/C/man3/fts.3:217
690 "A file for which no B<stat>(2) information was requested. The contents of "
691 "the I<fts_statp> field are undefined."
695 #: build/C/man3/fts.3:217
701 #: build/C/man3/fts.3:220
702 msgid "A symbolic link."
706 #: build/C/man3/fts.3:220
708 msgid "B<FTS_SLNONE>"
713 #: build/C/man3/fts.3:228
715 "A symbolic link with a nonexistent target. The contents of the I<fts_statp> "
716 "field reference the file characteristic information for the symbolic link "
721 #: build/C/man3/fts.3:229
723 msgid "I<fts_accpath>"
727 #: build/C/man3/fts.3:232
728 msgid "A path for accessing the file from the current directory."
732 #: build/C/man3/fts.3:232
738 #: build/C/man3/fts.3:238
740 "The path for the file relative to the root of the traversal. This path "
741 "contains the path specified to B<fts_open>() as a prefix."
745 #: build/C/man3/fts.3:238
747 msgid "I<fts_pathlen>"
751 #: build/C/man3/fts.3:242
752 msgid "The length of the string referenced by I<fts_path>."
756 #: build/C/man3/fts.3:242
762 #: build/C/man3/fts.3:245
763 msgid "The name of the file."
767 #: build/C/man3/fts.3:245
769 msgid "I<fts_namelen>"
773 #: build/C/man3/fts.3:249
774 msgid "The length of the string referenced by I<fts_name>."
778 #: build/C/man3/fts.3:249
784 #: build/C/man3/fts.3:260
786 "The depth of the traversal, numbered from -1 to N, where this file was "
787 "found. The I<FTSENT> structure representing the parent of the starting "
788 "point (or root) of the traversal is numbered -1, and the I<FTSENT> "
789 "structure for the root itself is numbered 0."
793 #: build/C/man3/fts.3:260
799 #: build/C/man3/fts.3:283
801 "Upon return of a I<FTSENT> structure from the B<fts_children>() or "
802 "B<fts_read>() functions, with its I<fts_info> field set to B<FTS_DNR>, "
803 "B<FTS_ERR> or B<FTS_NS>, the I<fts_errno> field contains the value of the "
804 "external variable I<errno> specifying the cause of the error. Otherwise, "
805 "the contents of the I<fts_errno> field are undefined."
809 #: build/C/man3/fts.3:283
811 msgid "I<fts_number>"
815 #: build/C/man3/fts.3:289
817 "This field is provided for the use of the application program and is not "
818 "modified by the fts functions. It is initialized to 0."
822 #: build/C/man3/fts.3:289
824 msgid "I<fts_pointer>"
828 #: build/C/man3/fts.3:296
830 "This field is provided for the use of the application program and is not "
831 "modified by the fts functions. It is initialized to NULL."
835 #: build/C/man3/fts.3:296
837 msgid "I<fts_parent>"
841 #: build/C/man3/fts.3:310
843 "A pointer to the I<FTSENT> structure referencing the file in the hierarchy "
844 "immediately above the current file, that is, the directory of which this "
845 "file is a member. A parent structure for the initial entry point is "
846 "provided as well, however, only the I<fts_level>, I<fts_number> and "
847 "I<fts_pointer> fields are guaranteed to be initialized."
851 #: build/C/man3/fts.3:310
857 #: build/C/man3/fts.3:321
859 "Upon return from the B<fts_children>() function, the I<fts_link> field "
860 "points to the next structure in the NULL-terminated linked list of directory "
861 "members. Otherwise, the contents of the I<fts_link> field are undefined."
865 #: build/C/man3/fts.3:321
871 #: build/C/man3/fts.3:337
873 "If a directory causes a cycle in the hierarchy (see B<FTS_DC>), either "
874 "because of a hard link between two directories, or a symbolic link pointing "
875 "to a directory, the I<fts_cycle> field of the structure will point to the "
876 "I<FTSENT> structure in the hierarchy that references the same file as the "
877 "current I<FTSENT> structure. Otherwise, the contents of the I<fts_cycle> "
878 "field are undefined."
882 #: build/C/man3/fts.3:337
889 #: build/C/man3/fts.3:343
890 msgid "A pointer to B<stat>(2) information for the file."
894 #: build/C/man3/fts.3:370
896 "A single buffer is used for all of the paths of all of the files in the file "
897 "hierarchy. Therefore, the I<fts_path> and I<fts_accpath> fields are "
898 "guaranteed to be null-terminated I<only> for the file most recently returned "
899 "by B<fts_read>(). To use these fields to reference any files represented by "
900 "other I<FTSENT> structures will require that the path buffer be modified "
901 "using the information contained in that I<FTSENT> structure's I<fts_pathlen> "
902 "field. Any such modifications should be undone before further calls to "
903 "B<fts_read>() are attempted. The I<fts_name> field is always "
908 #: build/C/man3/fts.3:370
914 #: build/C/man3/fts.3:377
916 "The B<fts_open>() function takes a pointer to an array of character "
917 "pointers naming one or more paths which make up a logical file hierarchy to "
918 "be traversed. The array must be terminated by a null pointer."
921 #. .Bl -tag -width "FTS_PHYSICAL"
923 #: build/C/man3/fts.3:387
925 "There are a number of options, at least one of which (either B<FTS_LOGICAL> "
926 "or B<FTS_PHYSICAL>) must be specified. The options are selected by ORing "
927 "the following values:"
931 #: build/C/man3/fts.3:387
933 msgid "B<FTS_COMFOLLOW>"
937 #: build/C/man3/fts.3:393
939 "This option causes any symbolic link specified as a root path to be followed "
940 "immediately whether or not B<FTS_LOGICAL> is also specified."
944 #: build/C/man3/fts.3:393
946 msgid "B<FTS_LOGICAL>"
950 #: build/C/man3/fts.3:412
952 "This option causes the fts routines to return I<FTSENT> structures for the "
953 "targets of symbolic links instead of the symbolic links themselves. If this "
954 "option is set, the only symbolic links for which I<FTSENT> structures are "
955 "returned to the application are those referencing nonexistent files. Either "
956 "B<FTS_LOGICAL> or B<FTS_PHYSICAL> I<must> be provided to the B<fts_open>() "
961 #: build/C/man3/fts.3:412
963 msgid "B<FTS_NOCHDIR>"
967 #: build/C/man3/fts.3:428
969 "As a performance optimization, the fts functions change directories as they "
970 "walk the file hierarchy. This has the side-effect that an application "
971 "cannot rely on being in any particular directory during the traversal. The "
972 "B<FTS_NOCHDIR> option turns off this optimization, and the fts functions "
973 "will not change the current directory. Note that applications should not "
974 "themselves change their current directory and try to access files unless "
975 "B<FTS_NOCHDIR> is specified and absolute pathnames were provided as "
976 "arguments to B<fts_open>()."
980 #: build/C/man3/fts.3:428
982 msgid "B<FTS_NOSTAT>"
986 #: build/C/man3/fts.3:444
988 "By default, returned I<FTSENT> structures reference file characteristic "
989 "information (the I<statp> field) for each file visited. This option relaxes "
990 "that requirement as a performance optimization, allowing the fts functions "
991 "to set the I<fts_info> field to B<FTS_NSOK> and leave the contents of the "
992 "I<statp> field undefined."
996 #: build/C/man3/fts.3:444
998 msgid "B<FTS_PHYSICAL>"
1002 #: build/C/man3/fts.3:463
1004 "This option causes the fts routines to return I<FTSENT> structures for "
1005 "symbolic links themselves instead of the target files they point to. If "
1006 "this option is set, I<FTSENT> structures for all symbolic links in the "
1007 "hierarchy are returned to the application. Either B<FTS_LOGICAL> or "
1008 "B<FTS_PHYSICAL> I<must> be provided to the B<fts_open>() function."
1012 #: build/C/man3/fts.3:463
1014 msgid "B<FTS_SEEDOT>"
1018 #: build/C/man3/fts.3:476
1020 "By default, unless they are specified as path arguments to B<fts_open>(), "
1021 "any files named \".\" or \"..\" encountered in the file hierarchy are "
1022 "ignored. This option causes the fts routines to return I<FTSENT> structures "
1027 #: build/C/man3/fts.3:476
1034 #: build/C/man3/fts.3:482
1036 "This option prevents fts from descending into directories that have a "
1037 "different device number than the file from which the descent began."
1041 #: build/C/man3/fts.3:521
1043 "The argument B<compar>() specifies a user-defined function which may be "
1044 "used to order the traversal of the hierarchy. It takes two pointers to "
1045 "pointers to I<FTSENT> structures as arguments and should return a negative "
1046 "value, zero, or a positive value to indicate if the file referenced by its "
1047 "first argument comes before, in any order with respect to, or after, the "
1048 "file referenced by its second argument. The I<fts_accpath>, I<fts_path> and "
1049 "I<fts_pathlen> fields of the I<FTSENT> structures may I<never> be used in "
1050 "this comparison. If the I<fts_info> field is set to B<FTS_NS> or "
1051 "B<FTS_NSOK>, the I<fts_statp> field may not either. If the B<compar>() "
1052 "argument is NULL, the directory traversal order is in the order listed in "
1053 "I<path_argv> for the root paths, and in the order listed in the directory "
1054 "for everything else."
1058 #: build/C/man3/fts.3:521
1064 #: build/C/man3/fts.3:534
1066 "The B<fts_read>() function returns a pointer to an I<FTSENT> structure "
1067 "describing a file in the hierarchy. Directories (that are readable and do "
1068 "not cause cycles) are visited at least twice, once in preorder and once in "
1069 "postorder. All other files are visited at least once. (Hard links between "
1070 "directories that do not cause cycles or symbolic links to symbolic links may "
1071 "cause files to be visited more than once, or directories more than twice.)"
1075 #: build/C/man3/fts.3:555
1077 "If all the members of the hierarchy have been returned, B<fts_read>() "
1078 "returns NULL and sets the external variable I<errno> to 0. If an error "
1079 "unrelated to a file in the hierarchy occurs, B<fts_read>() returns NULL and "
1080 "sets I<errno> appropriately. If an error related to a returned file occurs, "
1081 "a pointer to an I<FTSENT> structure is returned, and I<errno> may or may not "
1082 "have been set (see I<fts_info>)."
1086 #: build/C/man3/fts.3:572
1088 "The I<FTSENT> structures returned by B<fts_read>() may be overwritten after "
1089 "a call to B<fts_close>() on the same file hierarchy stream, or, after a "
1090 "call to B<fts_read>() on the same file hierarchy stream unless they "
1091 "represent a file of type directory, in which case they will not be "
1092 "overwritten until after a call to B<fts_read>() after the I<FTSENT> "
1093 "structure has been returned by the function B<fts_read>() in postorder."
1097 #: build/C/man3/fts.3:572
1099 msgid "fts_children()"
1103 #: build/C/man3/fts.3:590
1105 "The B<fts_children>() function returns a pointer to an I<FTSENT> structure "
1106 "describing the first entry in a NULL-terminated linked list of the files in "
1107 "the directory represented by the I<FTSENT> structure most recently returned "
1108 "by B<fts_read>(). The list is linked through the I<fts_link> field of the "
1109 "I<FTSENT> structure, and is ordered by the user-specified comparison "
1110 "function, if any. Repeated calls to B<fts_children>() will re-create this "
1115 #: build/C/man3/fts.3:618
1117 "As a special case, if B<fts_read>() has not yet been called for a "
1118 "hierarchy, B<fts_children>() will return a pointer to the files in the "
1119 "logical directory specified to B<fts_open>(), that is, the arguments "
1120 "specified to B<fts_open>(). Otherwise, if the I<FTSENT> structure most "
1121 "recently returned by B<fts_read>() is not a directory being visited in "
1122 "preorder, or the directory does not contain any files, B<fts_children>() "
1123 "returns NULL and sets I<errno> to zero. If an error occurs, "
1124 "B<fts_children>() returns NULL and sets I<errno> appropriately."
1128 #: build/C/man3/fts.3:629
1130 "The I<FTSENT> structures returned by B<fts_children>() may be overwritten "
1131 "after a call to B<fts_children>(), B<fts_close>() or B<fts_read>() on the "
1132 "same file hierarchy stream."
1135 #. .Bl -tag -width FTS_NAMEONLY
1137 #: build/C/man3/fts.3:633
1138 msgid "I<Option> may be set to the following value:"
1142 #: build/C/man3/fts.3:633
1144 msgid "B<FTS_NAMEONLY>"
1149 #: build/C/man3/fts.3:643
1151 "Only the names of the files are needed. The contents of all the fields in "
1152 "the returned linked list of structures are undefined with the exception of "
1153 "the I<fts_name> and I<fts_namelen> fields."
1157 #: build/C/man3/fts.3:643
1162 #. .Bl -tag -width FTS_PHYSICAL
1164 #: build/C/man3/fts.3:658
1166 "The function B<fts_set>() allows the user application to determine further "
1167 "processing for the file I<f> of the stream I<ftsp>. The B<fts_set>() "
1168 "function returns 0 on success, and -1 if an error occurs. I<Option> must be "
1169 "set to one of the following values:"
1173 #: build/C/man3/fts.3:658
1175 msgid "B<FTS_AGAIN>"
1179 #: build/C/man3/fts.3:676
1181 "Revisit the file; any file type may be revisited. The next call to "
1182 "B<fts_read>() will return the referenced file. The I<fts_stat> and "
1183 "I<fts_info> fields of the structure will be reinitialized at that time, but "
1184 "no other fields will have been changed. This option is meaningful only for "
1185 "the most recently returned file from B<fts_read>(). Normal use is for "
1186 "postorder directory visits, where it causes the directory to be revisited "
1187 "(in both preorder and postorder) as well as all of its descendants."
1191 #: build/C/man3/fts.3:676
1193 msgid "B<FTS_FOLLOW>"
1197 #: build/C/man3/fts.3:704
1199 "The referenced file must be a symbolic link. If the referenced file is the "
1200 "one most recently returned by B<fts_read>(), the next call to B<fts_read>() "
1201 "returns the file with the I<fts_info> and I<fts_statp> fields reinitialized "
1202 "to reflect the target of the symbolic link instead of the symbolic link "
1203 "itself. If the file is one of those most recently returned by "
1204 "B<fts_children>(), the I<fts_info> and I<fts_statp> fields of the structure, "
1205 "when returned by B<fts_read>(), will reflect the target of the symbolic link "
1206 "instead of the symbolic link itself. In either case, if the target of the "
1207 "symbolic link does not exist, the fields of the returned structure will be "
1208 "unchanged and the I<fts_info> field will be set to B<FTS_SLNONE>."
1212 #: build/C/man3/fts.3:708
1214 "If the target of the link is a directory, the preorder return, followed by "
1215 "the return of all of its descendants, followed by a postorder return, is "
1220 #: build/C/man3/fts.3:708
1227 #: build/C/man3/fts.3:716
1229 "No descendants of this file are visited. The file may be one of those most "
1230 "recently returned by either B<fts_children>() or B<fts_read>()."
1234 #: build/C/man3/fts.3:716
1240 #: build/C/man3/fts.3:729
1242 "The B<fts_close>() function closes a file hierarchy stream I<ftsp> and "
1243 "restores the current directory to the directory from which B<fts_open>() "
1244 "was called to open I<ftsp>. The B<fts_close>() function returns 0 on "
1245 "success, and -1 if an error occurs."
1249 #: build/C/man3/fts.3:729 build/C/man2/getxattr.2:106 build/C/man2/listxattr.2:127 build/C/man2/mount.2:312 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:447 build/C/man2/statfs.2:134 build/C/man3/statvfs.3:101 build/C/man2/sysfs.2:79 build/C/man2/umount.2:104 build/C/man2/ustat.2:79
1255 #: build/C/man3/fts.3:738
1257 "The function B<fts_open>() may fail and set I<errno> for any of the errors "
1258 "specified for B<open>(2) and B<malloc>(3)."
1262 #: build/C/man3/fts.3:747
1264 "The function B<fts_close>() may fail and set I<errno> for any of the errors "
1265 "specified for B<chdir>(2) and B<close>(2)."
1269 #: build/C/man3/fts.3:761
1271 "The functions B<fts_read>() and B<fts_children>() may fail and set "
1272 "I<errno> for any of the errors specified for B<chdir>(2), B<malloc>(3), "
1273 "B<opendir>(3), B<readdir>(3) and B<stat>(2)."
1277 #: build/C/man3/fts.3:770
1279 "In addition, B<fts_children>(), B<fts_open>() and B<fts_set>() may fail "
1280 "and set I<errno> as follows:"
1284 #: build/C/man3/fts.3:770 build/C/man2/mount.2:348 build/C/man2/spu_create.2:186 build/C/man2/spu_run.2:174 build/C/man2/stat.2:510 build/C/man2/sysfs.2:84 build/C/man2/umount.2:125 build/C/man2/umount.2:129 build/C/man2/ustat.2:84
1290 #: build/C/man3/fts.3:773
1291 msgid "The options were invalid."
1295 #: build/C/man3/fts.3:773 build/C/man2/getxattr.2:130 build/C/man2/listxattr.2:142 build/C/man2/mount.2:406 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:520 build/C/man2/umount.2:156
1301 #: build/C/man3/fts.3:775
1302 msgid "These functions are available in Linux since glibc2."
1306 #: build/C/man3/fts.3:775 build/C/man3/ftw.3:335 build/C/man3/getfsent.3:115 build/C/man3/getmntent.3:201 build/C/man2/getxattr.2:133 build/C/man2/listxattr.2:145 build/C/man2/mount.2:417 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:524 build/C/man2/statfs.2:190 build/C/man3/statvfs.3:164 build/C/man2/sysfs.2:92 build/C/man2/umount.2:162 build/C/man2/ustat.2:94
1308 msgid "CONFORMING TO"
1312 #: build/C/man3/fts.3:777
1317 #: build/C/man3/fts.3:777 build/C/man2/sysfs.2:101
1322 #. https://sourceware.org/bugzilla/show_bug.cgi?id=15838
1323 #. https://sourceware.org/bugzilla/show_bug.cgi?id=11460
1324 #. The following statement is years old, and seems no closer to
1325 #. being true -- mtk
1328 #. utility is expected to be included in a future
1332 #: build/C/man3/fts.3:790
1334 "All of the APIs described in this man page are not safe when compiling a "
1335 "program using the LFS APIs (e.g., when compiling with "
1336 "I<-D_FILE_OFFSET_BITS=64>)."
1340 #: build/C/man3/fts.3:796
1341 msgid "B<find>(1), B<chdir>(2), B<stat>(2), B<ftw>(3), B<qsort>(3)"
1345 #: build/C/man3/ftw.3:35
1351 #: build/C/man3/ftw.3:35
1357 #: build/C/man3/ftw.3:38
1358 msgid "ftw, nftw - file tree walk"
1362 #: build/C/man3/ftw.3:41
1364 msgid "B<#include E<lt>ftw.hE<gt>>\n"
1368 #: build/C/man3/ftw.3:46
1371 "B<int ftw(const char *>I<dirpath>B<,>\n"
1372 "B< int (*>I<fn>B<) (const char *>I<fpath>B<, const struct stat "
1374 "B< int >I<typeflag>B<),>\n"
1375 "B< int >I<nopenfd>B<);>\n"
1379 #: build/C/man3/ftw.3:49
1382 "B<#define _XOPEN_SOURCE 500> /* See feature_test_macros(7) */\n"
1383 "B<#include E<lt>ftw.hE<gt>>\n"
1387 #: build/C/man3/ftw.3:54
1390 "B<int nftw(const char *>I<dirpath>B<,>\n"
1391 "B< int (*>I<fn>B<) (const char *>I<fpath>B<, const struct stat "
1393 "B< int >I<typeflag>B<, struct FTW *>I<ftwbuf>B<),>\n"
1394 "B< int >I<nopenfd>B<, int >I<flags>B<);>\n"
1398 #: build/C/man3/ftw.3:62
1400 "B<ftw>() walks through the directory tree that is located under the "
1401 "directory I<dirpath>, and calls I<fn>() once for each entry in the tree. By "
1402 "default, directories are handled before the files and subdirectories they "
1403 "contain (preorder traversal)."
1407 #: build/C/man3/ftw.3:75
1409 "To avoid using up all of the calling process's file descriptors, I<nopenfd> "
1410 "specifies the maximum number of directories that B<ftw>() will hold open "
1411 "simultaneously. When the search depth exceeds this, B<ftw>() will become "
1412 "slower because directories have to be closed and reopened. B<ftw>() uses "
1413 "at most one file descriptor for each level in the directory tree."
1417 #: build/C/man3/ftw.3:104
1419 "For each entry found in the tree, B<ftw>() calls I<fn>() with three "
1420 "arguments: I<fpath>, I<sb>, and I<typeflag>. I<fpath> is the pathname of "
1421 "the entry, and is expressed either as a pathname relative to the calling "
1422 "process's current working directory at the time of the call to B<ftw>(), if "
1423 "I<dirpath> was expressed as a relative pathname, or as an absolute pathname, "
1424 "if I<dirpath> was expressed as an absolute pathname. I<sb> is a pointer to "
1425 "the I<stat> structure returned by a call to B<stat>(2) for I<fpath>. "
1426 "I<typeflag> is an integer that has one of the following values:"
1430 #: build/C/man3/ftw.3:104
1436 #: build/C/man3/ftw.3:108
1437 msgid "I<fpath> is a regular file."
1441 #: build/C/man3/ftw.3:108
1447 #: build/C/man3/ftw.3:112
1448 msgid "I<fpath> is a directory."
1452 #: build/C/man3/ftw.3:112
1458 #: build/C/man3/ftw.3:116
1459 msgid "I<fpath> is a directory which can't be read."
1463 #: build/C/man3/ftw.3:116
1469 #: build/C/man3/ftw.3:130
1471 "The B<stat>(2) call failed on I<fpath>, which is not a symbolic link. The "
1472 "probable cause for this is that the caller had read permission on the parent "
1473 "directory, so that the filename I<fpath> could be seen, but did not have "
1474 "execute permission, so that the file could not be reached for B<stat>(2)."
1478 #: build/C/man3/ftw.3:139
1480 "If I<fpath> is a symbolic link and B<stat>(2) failed, POSIX.1-2001 states "
1481 "that it is undefined whether B<FTW_NS> or B<FTW_SL> (see below) is passed "
1486 #: build/C/man3/ftw.3:150
1488 "To stop the tree walk, I<fn>() returns a nonzero value; this value will "
1489 "become the return value of B<ftw>(). As long as I<fn>() returns 0, B<ftw>() "
1490 "will continue either until it has traversed the entire tree, in which case "
1491 "it will return zero, or until it encounters an error (such as a B<malloc>(3) "
1492 "failure), in which case it will return -1."
1496 #: build/C/man3/ftw.3:160
1498 "Because B<ftw>() uses dynamic data structures, the only safe way to exit "
1499 "out of a tree walk is to return a nonzero value from I<fn>(). To allow a "
1500 "signal to terminate the walk without causing a memory leak, have the handler "
1501 "set a global flag that is checked by I<fn>(). I<Don't> use B<longjmp>(3) "
1502 "unless the program is going to terminate."
1506 #: build/C/man3/ftw.3:160
1512 #: build/C/man3/ftw.3:167
1514 "The function B<nftw>() is the same as B<ftw>(), except that it has one "
1515 "additional argument, I<flags>, and calls I<fn>() with one more argument, "
1520 #: build/C/man3/ftw.3:170
1522 "This I<flags> argument is formed by ORing zero or more of the following "
1527 #: build/C/man3/ftw.3:170
1529 msgid "B<FTW_ACTIONRETVAL> (since glibc 2.3.3)"
1533 #: build/C/man3/ftw.3:179
1535 "If this glibc-specific flag is set, then B<nftw>() handles the return value "
1536 "from I<fn>() differently. I<fn>() should return one of the following "
1541 #: build/C/man3/ftw.3:180
1543 msgid "B<FTW_CONTINUE>"
1547 #: build/C/man3/ftw.3:185
1548 msgid "Instructs B<nftw>() to continue normally."
1552 #: build/C/man3/ftw.3:185
1554 msgid "B<FTW_SKIP_SIBLINGS>"
1557 #. If \fBFTW_DEPTH\fP
1558 #. is set, the entry's parent directory is processed next (with
1559 #. \fIflag\fP set to \fBFTW_DP\fP).
1561 #: build/C/man3/ftw.3:193
1563 "If I<fn>() returns this value, then siblings of the current entry will be "
1564 "skipped, and processing continues in the parent."
1568 #: build/C/man3/ftw.3:193
1570 msgid "B<FTW_SKIP_SUBTREE>"
1574 #: build/C/man3/ftw.3:201
1576 "If I<fn>() is called with an entry that is a directory (I<typeflag> is "
1577 "B<FTW_D>), this return value will prevent objects within that directory from "
1578 "being passed as arguments to I<fn>(). B<nftw>() continues processing with "
1579 "the next sibling of the directory."
1583 #: build/C/man3/ftw.3:201
1589 #: build/C/man3/ftw.3:207
1590 msgid "Causes B<nftw>() to return immediately with the return value B<FTW_STOP>."
1594 #: build/C/man3/ftw.3:210
1596 "Other return values could be associated with new actions in the future; "
1597 "I<fn>() should not return values other than those listed above."
1601 #: build/C/man3/ftw.3:219
1603 "The feature test macro B<_GNU_SOURCE> must be defined (before including "
1604 "I<any> header files) in order to obtain the definition of "
1605 "B<FTW_ACTIONRETVAL> from I<E<lt>ftw.hE<gt>>."
1609 #: build/C/man3/ftw.3:220
1611 msgid "B<FTW_CHDIR>"
1615 #: build/C/man3/ftw.3:227
1617 "If set, do a B<chdir>(2) to each directory before handling its contents. "
1618 "This is useful if the program needs to perform some action in the directory "
1619 "in which I<fpath> resides."
1623 #: build/C/man3/ftw.3:227
1625 msgid "B<FTW_DEPTH>"
1629 #: build/C/man3/ftw.3:233
1631 "If set, do a post-order traversal, that is, call I<fn>() for the directory "
1632 "itself I<after> handling the contents of the directory and its "
1633 "subdirectories. (By default, each directory is handled I<before> its "
1638 #: build/C/man3/ftw.3:233
1640 msgid "B<FTW_MOUNT>"
1644 #: build/C/man3/ftw.3:237
1645 msgid "If set, stay within the same filesystem (i.e., do not cross mount points)."
1649 #: build/C/man3/ftw.3:237
1655 #: build/C/man3/ftw.3:242
1657 "If set, do not follow symbolic links. (This is what you want.) If not set, "
1658 "symbolic links are followed, but no file is reported twice."
1662 #: build/C/man3/ftw.3:247
1664 "If B<FTW_PHYS> is not set, but B<FTW_DEPTH> is set, then the function "
1665 "I<fn>() is never called for a directory that would be a descendant of "
1670 #: build/C/man3/ftw.3:262
1672 "For each entry in the directory tree, B<nftw>() calls I<fn>() with four "
1673 "arguments. I<fpath> and I<sb> are as for B<ftw>(). I<typeflag> may receive "
1674 "any of the same values as with B<ftw>(), or any of the following values:"
1678 #: build/C/man3/ftw.3:262
1684 #: build/C/man3/ftw.3:276
1686 "I<fpath> is a directory, and B<FTW_DEPTH> was specified in I<flags>. (If "
1687 "B<FTW_DEPTH> was not specified in I<flags>, then directories will always be "
1688 "visited with I<typeflag> set to B<FTW_D>.) All of the files and "
1689 "subdirectories within I<fpath> have been processed."
1693 #: build/C/man3/ftw.3:276
1698 #. To obtain the definition of this constant from
1702 #. must be defined, or
1703 #. .BR _XOPEN_SOURCE
1704 #. must be defined with a value of 500 or more.
1706 #: build/C/man3/ftw.3:287
1707 msgid "I<fpath> is a symbolic link, and B<FTW_PHYS> was set in I<flags>."
1711 #: build/C/man3/ftw.3:287
1717 #: build/C/man3/ftw.3:292
1719 "I<fpath> is a symbolic link pointing to a nonexistent file. (This occurs "
1720 "only if B<FTW_PHYS> is not set.)"
1724 #: build/C/man3/ftw.3:298
1726 "The fourth argument that B<nftw>() supplies when calling I<fn>() is a "
1727 "structure of type I<FTW>:"
1731 #: build/C/man3/ftw.3:305
1741 #: build/C/man3/ftw.3:318
1743 "I<base> is the offset of the filename (i.e., basename component) in the "
1744 "pathname given in I<fpath>. I<level> is the depth of I<fpath> in the "
1745 "directory tree, relative to the root of the tree (I<dirpath>, which has "
1750 #: build/C/man3/ftw.3:318 build/C/man3/getfsent.3:99 build/C/man3/getmntent.3:174 build/C/man2/getxattr.2:100 build/C/man2/listxattr.2:121 build/C/man2/mount.2:307 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:442 build/C/man2/statfs.2:129 build/C/man3/statvfs.3:96 build/C/man2/sysfs.2:67 build/C/man2/umount.2:99 build/C/man2/ustat.2:70
1752 msgid "RETURN VALUE"
1756 #: build/C/man3/ftw.3:320
1757 msgid "These functions return 0 on success, and -1 if an error occurs."
1761 #: build/C/man3/ftw.3:327
1763 "If I<fn>() returns nonzero, then the tree walk is terminated and the value "
1764 "returned by I<fn>() is returned as the result of B<ftw>() or B<nftw>()."
1768 #: build/C/man3/ftw.3:335
1770 "If B<nftw>() is called with the B<FTW_ACTIONRETVAL> flag, then the only "
1771 "nonzero value that should be used by I<fn>() to terminate the tree walk is "
1772 "B<FTW_STOP>, and that value is returned as the result of B<nftw>()."
1776 #: build/C/man3/ftw.3:340
1777 msgid "POSIX.1-2001, SVr4, SUSv1. POSIX.1-2008 marks B<ftw>() as obsolete."
1781 #: build/C/man3/ftw.3:340 build/C/man3/getfsent.3:127 build/C/man3/getmntent.3:207 build/C/man2/mount.2:420 build/C/man2/spu_create.2:254 build/C/man2/spu_run.2:196 build/C/man2/stat.2:668 build/C/man2/statfs.2:196 build/C/man3/statvfs.3:166 build/C/man2/sysfs.2:94 build/C/man2/umount.2:165 build/C/man2/ustat.2:98
1787 #: build/C/man3/ftw.3:344
1789 "POSIX.1-2001 note that the results are unspecified if I<fn> does not "
1790 "preserve the current working directory."
1794 #: build/C/man3/ftw.3:350
1796 "The function B<nftw>() and the use of B<FTW_SL> with B<ftw>() were "
1797 "introduced in SUSv1."
1801 #: build/C/man3/ftw.3:360
1803 "On some systems B<ftw>() will never use B<FTW_SL>, on other systems "
1804 "B<FTW_SL> occurs only for symbolic links that do not point to an existing "
1805 "file, and again on other systems B<ftw>() will use B<FTW_SL> for each "
1806 "symbolic link. For predictable control, use B<nftw>()."
1810 #: build/C/man3/ftw.3:364
1812 "Under Linux, libc4 and libc5 and glibc 2.0.6 will use B<FTW_F> for all "
1813 "objects (files, symbolic links, FIFOs, etc.) that can be stat'ed but are "
1818 #: build/C/man3/ftw.3:368
1819 msgid "The function B<nftw>() is available since glibc 2.1."
1823 #: build/C/man3/ftw.3:370
1824 msgid "B<FTW_ACTIONRETVAL> is glibc-specific."
1828 #: build/C/man3/ftw.3:370 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:780
1834 #: build/C/man3/ftw.3:379
1836 "The following program traverses the directory tree under the path named in "
1837 "its first command-line argument, or under the current directory if no "
1838 "argument is supplied. It displays various information about each file. The "
1839 "second command-line argument can be used to specify characters that control "
1840 "the value assigned to the I<flags> argument when calling B<nftw>()."
1844 #: build/C/man3/ftw.3:379
1846 msgid "Program source"
1850 #: build/C/man3/ftw.3:387
1853 "#define _XOPEN_SOURCE 500\n"
1854 "#include E<lt>ftw.hE<gt>\n"
1855 "#include E<lt>stdio.hE<gt>\n"
1856 "#include E<lt>stdlib.hE<gt>\n"
1857 "#include E<lt>string.hE<gt>\n"
1858 "#include E<lt>stdint.hE<gt>\n"
1862 #: build/C/man3/ftw.3:401
1866 "display_info(const char *fpath, const struct stat *sb,\n"
1867 " int tflag, struct FTW *ftwbuf)\n"
1869 " printf(\"%-3s %2d %7jd %-40s %d %s\\en\",\n"
1870 " (tflag == FTW_D) ? \"d\" : (tflag == FTW_DNR) ? \"dnr\" :\n"
1871 " (tflag == FTW_DP) ? \"dp\" : (tflag == FTW_F) ? \"f\" :\n"
1872 " (tflag == FTW_NS) ? \"ns\" : (tflag == FTW_SL) ? \"sl\" :\n"
1873 " (tflag == FTW_SLN) ? \"sln\" : \"???\",\n"
1874 " ftwbuf-E<gt>level, (intmax_t) sb-E<gt>st_size,\n"
1875 " fpath, ftwbuf-E<gt>base, fpath + ftwbuf-E<gt>base);\n"
1876 " return 0; /* To tell nftw() to continue */\n"
1881 #: build/C/man3/ftw.3:406
1885 "main(int argc, char *argv[])\n"
1891 #: build/C/man3/ftw.3:411
1894 " if (argc E<gt> 2 && strchr(argv[2], \\(aqd\\(aq) != NULL)\n"
1895 " flags |= FTW_DEPTH;\n"
1896 " if (argc E<gt> 2 && strchr(argv[2], \\(aqp\\(aq) != NULL)\n"
1897 " flags |= FTW_PHYS;\n"
1901 #: build/C/man3/ftw.3:419
1904 " if (nftw((argc E<lt> 2) ? \".\" : argv[1], display_info, 20, flags)\n"
1906 " perror(\"nftw\");\n"
1907 " exit(EXIT_FAILURE);\n"
1909 " exit(EXIT_SUCCESS);\n"
1914 #: build/C/man3/ftw.3:424
1915 msgid "B<stat>(2), B<fts>(3), B<readdir>(3)"
1919 #: build/C/man3/getfsent.3:27
1925 #: build/C/man3/getfsent.3:27
1931 #: build/C/man3/getfsent.3:27
1937 #: build/C/man3/getfsent.3:30
1938 msgid "getfsent, getfsspec, getfsfile, setfsent, endfsent - handle fstab entries"
1942 #: build/C/man3/getfsent.3:32
1943 msgid "B<#include E<lt>fstab.hE<gt>>"
1947 #: build/C/man3/getfsent.3:34
1948 msgid "B<void endfsent(void);>"
1952 #: build/C/man3/getfsent.3:36
1953 msgid "B<struct fstab *getfsent(void);>"
1957 #: build/C/man3/getfsent.3:38
1958 msgid "B<struct fstab *getfsfile(const char *>I<mount_point>B<);>"
1962 #: build/C/man3/getfsent.3:40
1963 msgid "B<struct fstab *getfsspec(const char *>I<special_file>B<);>"
1967 #: build/C/man3/getfsent.3:42
1968 msgid "B<int setfsent(void);>"
1972 #: build/C/man3/getfsent.3:48
1974 "These functions read from the file I</etc/fstab>. The I<struct fstab> is "
1979 #: build/C/man3/getfsent.3:60
1983 " char *fs_spec; /* block device name */\n"
1984 " char *fs_file; /* mount point */\n"
1985 " char *fs_vfstype; /* file-sysem type */\n"
1986 " char *fs_mntops; /* mount options */\n"
1987 " const char *fs_type; /* rw/rq/ro/sw/xx option */\n"
1988 " int fs_freq; /* dump frequency, in days */\n"
1989 " int fs_passno; /* pass number on parallel dump */\n"
1994 #: build/C/man3/getfsent.3:68
1996 "Here the field I<fs_type> contains (on a *BSD system) one of the five "
1997 "strings \"rw\", \"rq\", \"ro\", \"sw\", \"xx\" (read-write, read-write with "
1998 "quota, read-only, swap, ignore)."
2002 #: build/C/man3/getfsent.3:72
2004 "The function B<setfsent>() opens the file when required and positions it at "
2009 #: build/C/man3/getfsent.3:77
2011 "The function B<getfsent>() parses the next line from the file. (After "
2012 "opening it when required.)"
2016 #: build/C/man3/getfsent.3:81
2017 msgid "The function B<endfsent>() closes the file when required."
2021 #: build/C/man3/getfsent.3:90
2023 "The function B<getfsspec>() searches the file from the start and returns "
2024 "the first entry found for which the I<fs_spec> field matches the "
2025 "I<special_file> argument."
2029 #: build/C/man3/getfsent.3:99
2031 "The function B<getfsfile>() searches the file from the start and returns "
2032 "the first entry found for which the I<fs_file> field matches the "
2033 "I<mount_point> argument."
2039 #. function appeared in 4.0BSD; the other four functions appeared in 4.3BSD.
2041 #: build/C/man3/getfsent.3:115
2043 "Upon success, the functions B<getfsent>(), B<getfsfile>(), and "
2044 "B<getfsspec>() return a pointer to a I<struct fstab>, while B<setfsent>() "
2045 "returns 1. Upon failure or end-of-file, these functions return NULL and 0, "
2050 #: build/C/man3/getfsent.3:127
2052 "These functions are not in POSIX.1-2001. Several operating systems have "
2053 "them, for example, *BSD, SunOS, Digital UNIX, AIX (which also has a "
2054 "B<getfstype>()). HP-UX has functions of the same names, that however use a "
2055 "I<struct checklist> instead of a I<struct fstab>, and calls these functions "
2056 "obsolete, superseded by B<getmntent>(3)."
2060 #: build/C/man3/getfsent.3:129
2061 msgid "These functions are not thread-safe."
2065 #: build/C/man3/getfsent.3:139
2067 "Since Linux allows mounting a block special device in several places, and "
2068 "since several devices can have the same mount point, where the last device "
2069 "with a given mount point is the interesting one, while B<getfsfile>() and "
2070 "B<getfsspec>() only return the first occurrence, these two functions are "
2071 "not suitable for use under Linux."
2075 #: build/C/man3/getfsent.3:142
2076 msgid "B<getmntent>(3), B<fstab>(5)"
2080 #: build/C/man3/getmntent.3:32
2086 #: build/C/man3/getmntent.3:32
2092 #: build/C/man3/getmntent.3:36
2094 "getmntent, setmntent, addmntent, endmntent, hasmntopt, getmntent_r - get "
2095 "filesystem descriptor file entry"
2099 #: build/C/man3/getmntent.3:40
2102 "B<#include E<lt>stdio.hE<gt>>\n"
2103 "B<#include E<lt>mntent.hE<gt>>\n"
2107 #: build/C/man3/getmntent.3:42
2109 msgid "B<FILE *setmntent(const char *>I<filename>B<, const char *>I<type>B<);>\n"
2113 #: build/C/man3/getmntent.3:44
2115 msgid "B<struct mntent *getmntent(FILE *>I<fp>B<);>\n"
2119 #: build/C/man3/getmntent.3:46
2121 msgid "B<int addmntent(FILE *>I<fp>B<, const struct mntent *>I<mnt>B<);>\n"
2125 #: build/C/man3/getmntent.3:48
2127 msgid "B<int endmntent(FILE *>I<fp>B<);>\n"
2131 #: build/C/man3/getmntent.3:50
2133 msgid "B<char *hasmntopt(const struct mntent *>I<mnt>B<, const char *>I<opt>B<);>\n"
2137 #: build/C/man3/getmntent.3:53
2140 "/* GNU extension */\n"
2141 "B<#include E<lt>mntent.hE<gt>>\n"
2145 #: build/C/man3/getmntent.3:56
2148 "B<struct mntent *getmntent_r(FILE *>I<fp>B<, struct mntent *>I<mntbuf>B<,>\n"
2149 "B< char *>I<buf>B<, int >I<buflen>B<);>\n"
2153 #: build/C/man3/getmntent.3:61 build/C/man2/stat.2:68
2154 msgid "Feature Test Macro Requirements for glibc (see B<feature_test_macros>(7)):"
2158 #: build/C/man3/getmntent.3:65
2159 msgid "B<getmntent_r>(): _BSD_SOURCE || _SVID_SOURCE"
2163 #: build/C/man3/getmntent.3:70
2165 "These routines are used to access the filesystem description file "
2166 "I</etc/fstab> and the mounted filesystem description file I</etc/mtab>."
2170 #: build/C/man3/getmntent.3:84
2172 "The B<setmntent>() function opens the filesystem description file "
2173 "I<filename> and returns a file pointer which can be used by B<getmntent>(). "
2174 "The argument I<type> is the type of access required and can take the same "
2175 "values as the I<mode> argument of B<fopen>(3)."
2179 #: build/C/man3/getmntent.3:96
2181 "The B<getmntent>() function reads the next line from the filesystem "
2182 "description file I<fp> and returns a pointer to a structure containing the "
2183 "broken out fields from a line in the file. The pointer points to a static "
2184 "area of memory which is overwritten by subsequent calls to B<getmntent>()."
2188 #: build/C/man3/getmntent.3:106
2190 "The B<addmntent>() function adds the I<mntent> structure I<mnt> to the end "
2191 "of the open file I<fp>."
2195 #: build/C/man3/getmntent.3:111
2196 msgid "The B<endmntent>() function closes the filesystem description file I<fp>."
2200 #: build/C/man3/getmntent.3:128
2202 "The B<hasmntopt>() function scans the I<mnt_opts> field (see below) of the "
2203 "I<mntent> structure I<mnt> for a substring that matches I<opt>. See "
2204 "I<E<lt>mntent.hE<gt>> and B<mount>(8) for valid mount options."
2208 #: build/C/man3/getmntent.3:142
2210 "The reentrant B<getmntent_r>() function is similar to B<getmntent>(), but "
2211 "stores the I<struct mount> in the provided I<*mntbuf> and stores the strings "
2212 "pointed to by the entries in that struct in the provided array I<buf> of "
2217 #: build/C/man3/getmntent.3:148
2218 msgid "The I<mntent> structure is defined in I<E<lt>mntent.hE<gt>> as follows:"
2222 #: build/C/man3/getmntent.3:159
2226 " char *mnt_fsname; /* name of mounted filesystem */\n"
2227 " char *mnt_dir; /* filesystem path prefix */\n"
2228 " char *mnt_type; /* mount type (see mntent.h) */\n"
2229 " char *mnt_opts; /* mount options (see mntent.h) */\n"
2230 " int mnt_freq; /* dump frequency in days */\n"
2231 " int mnt_passno; /* pass number on parallel fsck */\n"
2236 #: build/C/man3/getmntent.3:174
2238 "Since fields in the mtab and fstab files are separated by whitespace, octal "
2239 "escapes are used to represent the four characters space (\\e040), tab "
2240 "(\\e011), newline (\\e012) and backslash (\\e134) in those files when they "
2241 "occur in one of the four strings in a I<mntent> structure. The routines "
2242 "B<addmntent>() and B<getmntent>() will convert from string representation "
2243 "to escaped representation and back."
2247 #: build/C/man3/getmntent.3:183
2249 "The B<getmntent>() and B<getmntent_r>() functions return a pointer to the "
2250 "I<mntent> structure or NULL on failure."
2254 #: build/C/man3/getmntent.3:187
2255 msgid "The B<addmntent>() function returns 0 on success and 1 on failure."
2259 #: build/C/man3/getmntent.3:191
2260 msgid "The B<endmntent>() function always returns 1."
2264 #: build/C/man3/getmntent.3:196
2266 "The B<hasmntopt>() function returns the address of the substring if a match "
2267 "is found and NULL otherwise."
2271 #: build/C/man3/getmntent.3:196 build/C/man2/spu_create.2:240
2277 #: build/C/man3/getmntent.3:200
2280 "/etc/fstab filesystem description file\n"
2281 "/etc/mtab mounted filesystem description file\n"
2285 #: build/C/man3/getmntent.3:207
2287 "The nonreentrant functions are from SunOS 4.1.3. A routine B<getmntent_r>() "
2288 "was introduced in HP-UX 10, but it returns an int. The prototype shown "
2289 "above is glibc-only."
2293 #: build/C/man3/getmntent.3:219
2295 "System V also has a B<getmntent>() function but the calling sequence "
2296 "differs, and the returned structure is different. Under System V "
2297 "I</etc/mnttab> is used. 4.4BSD and Digital UNIX have a routine "
2298 "B<getmntinfo>(), a wrapper around the system call B<getfsstat>()."
2302 #: build/C/man3/getmntent.3:223
2303 msgid "B<fopen>(3), B<fstab>(5), B<mount>(8)"
2307 #: build/C/man2/getxattr.2:25
2313 #: build/C/man2/getxattr.2:25
2319 #: build/C/man2/getxattr.2:28
2320 msgid "getxattr, lgetxattr, fgetxattr - retrieve an extended attribute value"
2324 #: build/C/man2/getxattr.2:33 build/C/man2/listxattr.2:33 build/C/man2/removexattr.2:33 build/C/man2/setxattr.2:33
2327 "B<#include E<lt>sys/types.hE<gt>>\n"
2328 "B<#include E<lt>sys/xattr.hE<gt>>\n"
2332 #: build/C/man2/getxattr.2:40
2335 "B<ssize_t getxattr(const char\\ *>I<path>B<, const char\\ *>I<name>B<,>\n"
2336 "B< void\\ *>I<value>B<, size_t >I<size>B<);>\n"
2337 "B<ssize_t lgetxattr(const char\\ *>I<path>B<, const char\\ *>I<name>B<,>\n"
2338 "B< void\\ *>I<value>B<, size_t >I<size>B<);>\n"
2339 "B<ssize_t fgetxattr(int >I<fd>B<, const char\\ *>I<name>B<,>\n"
2340 "B< void\\ *>I<value>B<, size_t >I<size>B<);>\n"
2344 #: build/C/man2/getxattr.2:53 build/C/man2/setxattr.2:53
2346 "Extended attributes are I<name>:I<value> pairs associated with inodes "
2347 "(files, directories, symbolic links, etc.). They are extensions to the "
2348 "normal attributes which are associated with all inodes in the system (i.e., "
2349 "the B<stat>(2) data). A complete overview of extended attributes concepts "
2350 "can be found in B<attr>(5)."
2354 #: build/C/man2/getxattr.2:65
2356 "B<getxattr>() retrieves the I<value> of the extended attribute identified "
2357 "by I<name> and associated with the given I<path> in the filesystem. The "
2358 "length of the attribute I<value> is returned."
2362 #: build/C/man2/getxattr.2:71
2364 "B<lgetxattr>() is identical to B<getxattr>(), except in the case of a "
2365 "symbolic link, where the link itself is interrogated, not the file that it "
2370 #: build/C/man2/getxattr.2:81
2372 "B<fgetxattr>() is identical to B<getxattr>(), only the open file referred "
2373 "to by I<fd> (as returned by B<open>(2)) is interrogated in place of "
2378 #: build/C/man2/getxattr.2:89
2380 "An extended attribute I<name> is a simple null-terminated string. The name "
2381 "includes a namespace prefix; there may be several, disjoint namespaces "
2382 "associated with an individual inode. The value of an extended attribute is "
2383 "a chunk of arbitrary textual or binary data of specified length."
2387 #: build/C/man2/getxattr.2:96
2389 "An empty buffer of I<size> zero can be passed into these calls to return the "
2390 "current size of the named extended attribute, which can be used to estimate "
2391 "the size of a buffer which is sufficiently large to hold the value "
2392 "associated with the extended attribute."
2396 #: build/C/man2/getxattr.2:100
2398 "The interface is designed to allow guessing of initial buffer sizes, and to "
2399 "enlarge buffers when the return value indicates that the buffer provided was "
2404 #: build/C/man2/getxattr.2:106
2406 "On success, a nonnegative number is returned indicating the size of the "
2407 "extended attribute value. On failure, -1 is returned and I<errno> is set "
2412 #: build/C/man2/getxattr.2:107 build/C/man2/removexattr.2:84 build/C/man2/setxattr.2:119
2418 #: build/C/man2/getxattr.2:116
2420 "The named attribute does not exist, or the process has no access to this "
2421 "attribute. (B<ENOATTR> is defined to be a synonym for B<ENODATA> in "
2422 "I<E<lt>attr/xattr.hE<gt>>.)"
2426 #: build/C/man2/getxattr.2:116 build/C/man2/listxattr.2:128 build/C/man2/removexattr.2:92 build/C/man2/setxattr.2:131
2432 #: build/C/man2/getxattr.2:119 build/C/man2/listxattr.2:131 build/C/man2/removexattr.2:95
2433 msgid "Extended attributes are not supported by the filesystem, or are disabled."
2437 #: build/C/man2/getxattr.2:119 build/C/man2/listxattr.2:131
2443 #: build/C/man2/getxattr.2:126
2444 msgid "The I<size> of the I<value> buffer is too small to hold the result."
2448 #: build/C/man2/getxattr.2:130 build/C/man2/listxattr.2:142 build/C/man2/removexattr.2:99 build/C/man2/setxattr.2:141
2449 msgid "In addition, the errors documented in B<stat>(2) can also occur."
2453 #: build/C/man2/getxattr.2:133 build/C/man2/listxattr.2:145 build/C/man2/removexattr.2:102 build/C/man2/setxattr.2:144
2455 "These system calls have been available on Linux since kernel 2.4; glibc "
2456 "support is provided since version 2.3."
2460 #. Andreas Gruenbacher,
2461 #. .RI < a.gruenbacher@computer.org >
2462 #. and the SGI XFS development team,
2463 #. .RI < linux-xfs@oss.sgi.com >.
2464 #. Please send any bug reports or comments to these addresses.
2466 #: build/C/man2/getxattr.2:141 build/C/man2/listxattr.2:153 build/C/man2/removexattr.2:110 build/C/man2/setxattr.2:152
2467 msgid "These system calls are Linux-specific."
2471 #: build/C/man2/getxattr.2:151
2473 "B<getfattr>(1), B<setfattr>(1), B<listxattr>(2), B<open>(2), "
2474 "B<removexattr>(2), B<setxattr>(2), B<stat>(2), B<attr>(5), B<symlink>(7)"
2478 #: build/C/man2/listxattr.2:25
2484 #: build/C/man2/listxattr.2:25 build/C/man2/removexattr.2:25 build/C/man2/setxattr.2:25
2490 #: build/C/man2/listxattr.2:28
2491 msgid "listxattr, llistxattr, flistxattr - list extended attribute names"
2495 #: build/C/man2/listxattr.2:39
2498 "B<ssize_t listxattr(const char\\ *>I<path>B<, char\\ *>I<list>B<, size_t "
2500 "B<ssize_t llistxattr(const char\\ *>I<path>B<, char\\ *>I<list>B<, size_t "
2502 "B<ssize_t flistxattr(int >I<fd>B<, char\\ *>I<list>B<, size_t "
2507 #: build/C/man2/listxattr.2:50
2509 "Extended attributes are name:value pairs associated with inodes (files, "
2510 "directories, symbolic links, etc.). They are extensions to the normal "
2511 "attributes which are associated with all inodes in the system (i.e., the "
2512 "B<stat>(2) data). A complete overview of extended attributes concepts can "
2513 "be found in B<attr>(5)."
2517 #: build/C/man2/listxattr.2:66
2519 "B<listxattr>() retrieves the list of extended attribute names associated "
2520 "with the given I<path> in the filesystem. The retrieved list is placed in "
2521 "I<list>, a caller-allocated buffer whose size (in bytes) is specified in the "
2522 "argument I<size>. The list is the set of (null-terminated) names, one after "
2523 "the other. Names of extended attributes to which the calling process does "
2524 "not have access may be omitted from the list. The length of the attribute "
2525 "name I<list> is returned."
2529 #: build/C/man2/listxattr.2:73
2531 "B<llistxattr>() is identical to B<listxattr>(), except in the case of a "
2532 "symbolic link, where the list of names of extended attributes associated "
2533 "with the link itself is retrieved, not the file that it refers to."
2537 #: build/C/man2/listxattr.2:83
2539 "B<flistxattr>() is identical to B<listxattr>(), only the open file referred "
2540 "to by I<fd> (as returned by B<open>(2)) is interrogated in place of "
2545 #: build/C/man2/listxattr.2:89
2547 "A single extended attribute I<name> is a simple null-terminated string. The "
2548 "name includes a namespace prefix; there may be several, disjoint namespaces "
2549 "associated with an individual inode."
2553 #: build/C/man2/listxattr.2:95
2555 "An empty buffer of I<size> zero can be passed into these calls to return the "
2556 "current size of the list of extended attribute names, which can be used to "
2557 "estimate the size of a buffer which is sufficiently large to hold the list "
2562 #: build/C/man2/listxattr.2:95
2568 #: build/C/man2/listxattr.2:100
2570 "The I<list> of names is returned as an unordered array of null-terminated "
2571 "character strings (attribute names are separated by null bytes "
2572 "(\\(aq\\e0\\(aq)), like this:"
2576 #: build/C/man2/listxattr.2:105
2578 msgid "user.name1\\e0system.name1\\e0user.name2\\e0\n"
2582 #: build/C/man2/listxattr.2:113
2584 "Filesystems like ext2, ext3 and XFS which implement POSIX ACLs using "
2585 "extended attributes, might return a I<list> like this:"
2589 #: build/C/man2/listxattr.2:118
2591 msgid "system.posix_acl_access\\e0system.posix_acl_default\\e0\n"
2595 #: build/C/man2/listxattr.2:127
2597 "On success, a nonnegative number is returned indicating the size of the "
2598 "extended attribute name list. On failure, -1 is returned and I<errno> is "
2599 "set appropriately."
2603 #: build/C/man2/listxattr.2:138
2604 msgid "The I<size> of the I<list> buffer is too small to hold the result."
2608 #: build/C/man2/listxattr.2:163
2610 "B<getfattr>(1), B<setfattr>(1), B<getxattr>(2), B<open>(2), "
2611 "B<removexattr>(2), B<setxattr>(2), B<stat>(2), B<attr>(5), B<symlink>(7)"
2615 #: build/C/man2/mount.2:40
2621 #: build/C/man2/mount.2:40
2627 #: build/C/man2/mount.2:43
2628 msgid "mount - mount filesystem"
2632 #: build/C/man2/mount.2:46 build/C/man2/umount.2:36
2634 msgid "B<#include E<lt>sys/mount.hE<gt>>\n"
2638 #: build/C/man2/mount.2:50
2641 "B<int mount(const char *>I<source>B<, const char *>I<target>B<,>\n"
2642 "B< const char *>I<filesystemtype>B<, unsigned long "
2643 ">I<mountflags>B<,>\n"
2644 "B< const void *>I<data>B<);>\n"
2648 #: build/C/man2/mount.2:58
2650 "B<mount>() attaches the filesystem specified by I<source> (which is often a "
2651 "device name, but can also be a directory name or a dummy) to the directory "
2652 "specified by I<target>."
2656 #: build/C/man2/mount.2:62
2658 "Appropriate privilege (Linux: the B<CAP_SYS_ADMIN> capability) is required "
2659 "to mount filesystems."
2662 #. Multiple mounts on same mount point: since 2.3.99pre7.
2664 #: build/C/man2/mount.2:67
2666 "Since Linux 2.4 a single filesystem can be visible at multiple mount points, "
2667 "and multiple mounts can be stacked on the same mount point."
2671 #: build/C/man2/mount.2:76
2673 "Values for the I<filesystemtype> argument supported by the kernel are listed "
2674 "in I</proc/filesystems> (e.g., \"minix\", \"ext2\", \"ext3\", \"jfs\", "
2675 "\"xfs\", \"reiserfs\", \"msdos\", \"proc\", \"nfs\", \"iso9660\"). Further "
2676 "types may become available when the appropriate modules are loaded."
2679 #. (as defined in \fI<linux/fs.h>\fP for libc4 and libc5
2680 #. and in \fI<sys/mount.h>\fP for glibc2)
2681 #. FIXME 2.6.15 added flags for "shared subtree" functionality:
2682 #. MS_UNBINDABLE, MS_PRIVATE, MS_SHARED, MS_SLAVE
2685 #. All mounts are private by default. Previously shared mounts
2686 #. can be remarked PRIVATE.
2688 #. Mount points that are marked SHARED propagate mount events
2689 #. to one another after bing cloned.
2691 #. A previously shared mount point can be marked SALVE, meaning
2692 #. it receives propagated events, but does not propagate events.
2694 #. mounts cannot be bound into other places, and will not be
2695 #. propagated into new subtrees
2696 #. mount --make-rshared ==> MS_SHARED | MS_REC
2698 #. These settings are visible in proc/mountinfo
2701 #. These need to be documented on this page.
2703 #. Documentation/filesystems/sharedsubtree.txt
2705 #. http://lwn.net/Articles/159077/
2707 #. http://myweb.sudhaa.com:2022/~ram/sharedsubtree/paper/sharedsubtree.1.pdf
2708 #. Shared-Subtree Concept, Implementation, and Applications in Linux
2709 #. Al Viro viro@ftp.linux.org.uk
2710 #. Ram Pai linuxram@us.ibm.com
2712 #. http://foss.in/2005/slides/sharedsubtree1.pdf
2713 #. Shared Subtree Concept and Implementation in the Linux Kernel
2716 #. http://www.ibm.com/developerworks/linux/library/l-mount-namespaces/index.html
2717 #. Applying mount namespaces
2719 #. Uncover practical applications for advanced Linux mounts features
2720 #. Serge E. Hallyn (sergeh@us.ibm.com), Software Engineer, IBM
2721 #. Ram Pai (linuxram@us.ibm.com), Software Engineer, IBM
2722 #. Date: 17 Sep 2007
2724 #. 2.6.25 Added MS_I_VERSION, which needs to be documented.
2726 #: build/C/man2/mount.2:131
2728 "The I<mountflags> argument may have the magic number 0xC0ED (B<MS_MGC_VAL>) "
2729 "in the top 16 bits (this was required in kernel versions prior to 2.4, but "
2730 "is no longer required and ignored if specified), and various mount flags in "
2731 "the low order 16 bits:"
2735 #: build/C/man2/mount.2:131
2737 msgid "B<MS_BIND> (Linux 2.4 onward)"
2740 #. since 2.4.0-test9
2741 #. with the exception of the "hidden" MS_REC mountflags bit
2743 #: build/C/man2/mount.2:150
2745 "Perform a bind mount, making a file or a directory subtree visible at "
2746 "another point within a filesystem. Bind mounts may cross filesystem "
2747 "boundaries and span B<chroot>(2) jails. The I<filesystemtype> and I<data> "
2748 "arguments are ignored. Up until Linux 2.6.26, I<mountflags> was also "
2749 "ignored (the bind mount has the same mount options as the underlying mount "
2754 #: build/C/man2/mount.2:150
2756 msgid "B<MS_DIRSYNC> (since Linux 2.5.19)"
2760 #: build/C/man2/mount.2:156
2762 "Make directory changes on this filesystem synchronous. (This property can "
2763 "be obtained for individual directories or subtrees using B<chattr>(1).)"
2767 #: build/C/man2/mount.2:156
2769 msgid "B<MS_MANDLOCK>"
2772 #. FIXME Say more about MS_MOVE
2774 #: build/C/man2/mount.2:163
2776 "Permit mandatory locking on files in this filesystem. (Mandatory locking "
2777 "must still be enabled on a per-file basis, as described in B<fcntl>(2).)"
2781 #: build/C/man2/mount.2:163
2787 #: build/C/man2/mount.2:174
2789 "Move a subtree. I<source> specifies an existing mount point and I<target> "
2790 "specifies the new location. The move is atomic: at no point is the subtree "
2791 "unmounted. The I<filesystemtype>, I<mountflags>, and I<data> arguments are "
2796 #: build/C/man2/mount.2:174
2798 msgid "B<MS_NOATIME>"
2802 #: build/C/man2/mount.2:177
2803 msgid "Do not update access times for (all types of) files on this filesystem."
2807 #: build/C/man2/mount.2:177
2813 #: build/C/man2/mount.2:180
2814 msgid "Do not allow access to devices (special files) on this filesystem."
2818 #: build/C/man2/mount.2:180
2820 msgid "B<MS_NODIRATIME>"
2824 #: build/C/man2/mount.2:189
2826 "Do not update access times for directories on this filesystem. This flag "
2827 "provides a subset of the functionality provided by B<MS_NOATIME>; that is, "
2828 "B<MS_NOATIME> implies B<MS_NODIRATIME>."
2832 #: build/C/man2/mount.2:189
2834 msgid "B<MS_NOEXEC>"
2837 #. (Possibly useful for a filesystem that contains non-Linux executables.
2838 #. Often used as a security feature, e.g., to make sure that restricted
2839 #. users cannot execute files uploaded using ftp or so.)
2841 #: build/C/man2/mount.2:195
2842 msgid "Do not allow programs to be executed from this filesystem."
2846 #: build/C/man2/mount.2:195
2848 msgid "B<MS_NOSUID>"
2851 #. (This is a security feature to prevent users executing set-user-ID and
2852 #. set-group-ID programs from removable disk devices.)
2854 #: build/C/man2/mount.2:201
2856 "Do not honor set-user-ID and set-group-ID bits when executing programs from "
2861 #: build/C/man2/mount.2:201
2863 msgid "B<MS_RDONLY>"
2867 #. FIXME Document MS_REC, available since 2.4.11.
2868 #. This flag has meaning in conjunction with MS_BIND and
2869 #. also with the shared subtree flags.
2871 #: build/C/man2/mount.2:208
2872 msgid "Mount filesystem read-only."
2876 #: build/C/man2/mount.2:208
2878 msgid "B<MS_RELATIME> (since Linux 2.6.20)"
2881 #. Matthew Garrett notes in the patch that added this behavior
2882 #. that this lets utilities such as tmpreaper (which deletes
2883 #. files based on last access time) work correctly.
2885 #: build/C/man2/mount.2:229
2887 "When a file on this filesystem is accessed, update the file's last access "
2888 "time (atime) only if the current value of atime is less than or equal to the "
2889 "file's last modification time (mtime) or last status change time (ctime). "
2890 "This option is useful for programs, such as B<mutt>(1), that need to know "
2891 "when a file has been read since it was last modified. Since Linux 2.6.30, "
2892 "the kernel defaults to the behavior provided by this flag (unless "
2893 "B<MS_NOATIME> was specified), and the B<MS_STRICTATIME> flag is required to "
2894 "obtain traditional semantics. In addition, since Linux 2.6.30, the file's "
2895 "last access time is always updated if it is more than 1 day old."
2899 #: build/C/man2/mount.2:229
2901 msgid "B<MS_REMOUNT>"
2905 #: build/C/man2/mount.2:245
2907 "Remount an existing mount. This allows you to change the I<mountflags> and "
2908 "I<data> of an existing mount without having to unmount and remount the "
2909 "filesystem. I<target> should be the same value specified in the initial "
2910 "B<mount>() call; I<source> and I<filesystemtype> are ignored."
2914 #: build/C/man2/mount.2:260
2916 "The following I<mountflags> can be changed: B<MS_RDONLY>, B<MS_SYNCHRONOUS>, "
2917 "B<MS_MANDLOCK>; before kernel 2.6.16, the following could also be changed: "
2918 "B<MS_NOATIME> and B<MS_NODIRATIME>; and, additionally, before kernel 2.4.10, "
2919 "the following could also be changed: B<MS_NOSUID>, B<MS_NODEV>, "
2924 #: build/C/man2/mount.2:260
2926 msgid "B<MS_SILENT> (since Linux 2.6.17)"
2930 #: build/C/man2/mount.2:268
2932 "Suppress the display of certain (I<printk>()) warning messages in the "
2933 "kernel log. This flag supersedes the misnamed and obsolete B<MS_VERBOSE> "
2934 "flag (available since Linux 2.4.12), which has the same meaning."
2938 #: build/C/man2/mount.2:268
2940 msgid "B<MS_STRICTATIME> (since Linux 2.6.30)"
2944 #: build/C/man2/mount.2:278
2946 "Always update the last access time (atime) when files on this filesystem are "
2947 "accessed. (This was the default behavior before Linux 2.6.30.) Specifying "
2948 "this flag overrides the effect of setting the B<MS_NOATIME> and "
2949 "B<MS_RELATIME> flags."
2953 #: build/C/man2/mount.2:278
2955 msgid "B<MS_SYNCHRONOUS>"
2959 #: build/C/man2/mount.2:286
2961 "Make writes on this filesystem synchronous (as though the B<O_SYNC> flag to "
2962 "B<open>(2) was specified for all file opens to this filesystem)."
2966 #: build/C/man2/mount.2:298
2968 "From Linux 2.4 onward, the B<MS_NODEV>, B<MS_NOEXEC>, and B<MS_NOSUID> flags "
2969 "are settable on a per-mount-point basis. From kernel 2.6.16 onward, "
2970 "B<MS_NOATIME> and B<MS_NODIRATIME> are also settable on a per-mount-point "
2971 "basis. The B<MS_RELATIME> flag is also settable on a per-mount-point basis."
2975 #: build/C/man2/mount.2:307
2977 "The I<data> argument is interpreted by the different filesystems. Typically "
2978 "it is a string of comma-separated options understood by this filesystem. "
2979 "See B<mount>(8) for details of the options available for each filesystem "
2984 #: build/C/man2/mount.2:312 build/C/man2/stat.2:447 build/C/man2/statfs.2:134 build/C/man3/statvfs.3:101 build/C/man2/umount.2:104
2986 "On success, zero is returned. On error, -1 is returned, and I<errno> is set "
2991 #: build/C/man2/mount.2:318 build/C/man2/umount.2:110
2993 "The error values given below result from filesystem type independent "
2994 "errors. Each filesystem type may have its own special errors and its own "
2995 "special behavior. See the Linux kernel source code for details."
2999 #: build/C/man2/mount.2:318 build/C/man2/spu_create.2:173 build/C/man2/stat.2:448 build/C/man2/statfs.2:135 build/C/man3/statvfs.3:102
3004 #. mtk: Probably: write permission is required for MS_BIND, with
3005 #. the error EPERM if not present; CAP_DAC_OVERRIDE is required.
3007 #: build/C/man2/mount.2:333
3009 "A component of a path was not searchable. (See also B<path_resolution>(7).) "
3010 "Or, mounting a read-only filesystem was attempted without giving the "
3011 "B<MS_RDONLY> flag. Or, the block device I<source> is located on a "
3012 "filesystem mounted with the B<MS_NODEV> option."
3016 #: build/C/man2/mount.2:333 build/C/man2/umount.2:117
3022 #: build/C/man2/mount.2:345
3024 "I<source> is already mounted. Or, it cannot be remounted read-only, because "
3025 "it still holds files open for writing. Or, it cannot be mounted on "
3026 "I<target> because I<target> is still busy (it is the working directory of "
3027 "some thread, the mount point of another device, has open files, etc.)."
3031 #: build/C/man2/mount.2:345 build/C/man2/spu_create.2:181 build/C/man2/spu_run.2:158 build/C/man2/stat.2:459 build/C/man2/statfs.2:147 build/C/man3/statvfs.3:114 build/C/man2/sysfs.2:80 build/C/man2/umount.2:121 build/C/man2/ustat.2:80
3037 #: build/C/man2/mount.2:348
3038 msgid "One of the pointer arguments points outside the user address space."
3042 #: build/C/man2/mount.2:363
3044 "I<source> had an invalid superblock. Or, a remount (B<MS_REMOUNT>) was "
3045 "attempted, but I<source> was not already mounted on I<target>. Or, a move "
3046 "(B<MS_MOVE>) was attempted, but I<source> was not a mount point, or was "
3051 #: build/C/man2/mount.2:363 build/C/man2/spu_create.2:192 build/C/man2/stat.2:462 build/C/man2/statfs.2:159 build/C/man3/statvfs.3:126
3057 #: build/C/man2/mount.2:370
3059 "Too many links encountered during pathname resolution. Or, a move was "
3060 "attempted, while I<target> is a descendant of I<source>."
3064 #: build/C/man2/mount.2:370 build/C/man2/spu_create.2:196
3070 #: build/C/man2/mount.2:374
3071 msgid "(In case no block device is required:) Table of dummy devices is full."
3075 #: build/C/man2/mount.2:374 build/C/man2/spu_create.2:199 build/C/man2/stat.2:465 build/C/man2/statfs.2:164 build/C/man3/statvfs.3:131 build/C/man2/umount.2:143
3077 msgid "B<ENAMETOOLONG>"
3081 #: build/C/man2/mount.2:378 build/C/man2/umount.2:147
3082 msgid "A pathname was longer than B<MAXPATHLEN>."
3086 #: build/C/man2/mount.2:378 build/C/man2/spu_create.2:206
3092 #: build/C/man2/mount.2:382
3093 msgid "I<filesystemtype> not configured in the kernel."
3097 #: build/C/man2/mount.2:382 build/C/man2/spu_create.2:210 build/C/man2/stat.2:469 build/C/man2/statfs.2:169 build/C/man3/statvfs.3:136 build/C/man2/umount.2:147
3103 #: build/C/man2/mount.2:385 build/C/man2/umount.2:150
3104 msgid "A pathname was empty or had a nonexistent component."
3108 #: build/C/man2/mount.2:385 build/C/man2/spu_create.2:215 build/C/man2/spu_run.2:179 build/C/man2/stat.2:476 build/C/man2/statfs.2:175 build/C/man3/statvfs.3:142 build/C/man2/umount.2:150
3114 #: build/C/man2/mount.2:388 build/C/man2/umount.2:153
3115 msgid "The kernel could not allocate a free page to copy filenames or data into."
3119 #: build/C/man2/mount.2:388
3125 #: build/C/man2/mount.2:392
3126 msgid "I<source> is not a block device (and a device was required)."
3130 #: build/C/man2/mount.2:392 build/C/man2/spu_create.2:228 build/C/man2/stat.2:479 build/C/man2/stat.2:514 build/C/man2/statfs.2:181 build/C/man3/statvfs.3:148
3136 #: build/C/man2/mount.2:398
3137 msgid "I<target>, or a prefix of I<source>, is not a directory."
3141 #: build/C/man2/mount.2:398
3147 #: build/C/man2/mount.2:403
3148 msgid "The major number of the block device I<source> is out of range."
3152 #: build/C/man2/mount.2:403 build/C/man2/spu_create.2:233 build/C/man2/umount.2:153
3158 #: build/C/man2/mount.2:406 build/C/man2/umount.2:156
3159 msgid "The caller does not have the required privileges."
3162 #. FIXME: Definitions of the so-far-undocumented MS_UNBINDABLE, MS_PRIVATE,
3163 #. MS_SHARED, and MS_SLAVE were (also) only added to glibc headers in 2.12.
3165 #: build/C/man2/mount.2:417
3167 "The definitions of B<MS_DIRSYNC>, B<MS_MOVE>, B<MS_REC>, B<MS_RELATIME>, and "
3168 "B<MS_STRICTATIME> were added to glibc headers in version 2.12."
3172 #: build/C/man2/mount.2:420
3174 "This function is Linux-specific and should not be used in programs intended "
3179 #: build/C/man2/mount.2:429
3181 "The original B<MS_SYNC> flag was renamed B<MS_SYNCHRONOUS> in 1.1.69 when a "
3182 "different B<MS_SYNC> was added to I<E<lt>mman.hE<gt>>."
3185 #. The change is in patch-2.4.0-prerelease.
3187 #: build/C/man2/mount.2:438
3189 "Before Linux 2.4 an attempt to execute a set-user-ID or set-group-ID program "
3190 "on a filesystem mounted with B<MS_NOSUID> would fail with B<EPERM>. Since "
3191 "Linux 2.4 the set-user-ID and set-group-ID bits are just silently ignored in "
3196 #: build/C/man2/mount.2:438
3198 msgid "Per-process namespaces"
3202 #: build/C/man2/mount.2:449
3204 "Starting with kernel 2.4.19, Linux provides per-process mount namespaces. A "
3205 "mount namespace is the set of filesystem mounts that are visible to a "
3206 "process. Mount-point namespaces can be (and usually are) shared between "
3207 "multiple processes, and changes to the namespace (i.e., mounts and unmounts) "
3208 "by one process are visible to all other processes sharing the same "
3209 "namespace. (The pre-2.4.19 Linux situation can be considered as one in "
3210 "which a single namespace was shared by every process on the system.)"
3214 #: build/C/man2/mount.2:455
3216 "A child process created by B<fork>(2) shares its parent's mount namespace; "
3217 "the mount namespace is preserved across an B<execve>(2)."
3221 #: build/C/man2/mount.2:475
3223 "A process can obtain a private mount namespace if: it was created using the "
3224 "B<clone>(2) B<CLONE_NEWNS> flag, in which case its new namespace is "
3225 "initialized to be a I<copy> of the namespace of the process that called "
3226 "B<clone>(2); or it calls B<unshare>(2) with the B<CLONE_NEWNS> flag, which "
3227 "causes the caller's mount namespace to obtain a private copy of the "
3228 "namespace that it was previously sharing with other processes, so that "
3229 "future mounts and unmounts by the caller are invisible to other processes "
3230 "(except child processes that the caller subsequently creates) and vice "
3235 #: build/C/man2/mount.2:482
3237 "The Linux-specific I</proc/PID/mounts> file exposes the list of mount points "
3238 "in the mount namespace of the process with the specified ID; see B<proc>(5) "
3243 #: build/C/man2/mount.2:489
3245 "B<lsblk>(1), B<umount>(2), B<namespaces>(7), B<path_resolution>(7), "
3246 "B<mount>(8), B<umount>(8)"
3250 #: build/C/man7/path_resolution.7:25
3252 msgid "PATH_RESOLUTION"
3256 #: build/C/man7/path_resolution.7:25
3262 #: build/C/man7/path_resolution.7:28
3263 msgid "path_resolution - how a pathname is resolved to a file"
3267 #: build/C/man7/path_resolution.7:31
3269 "Some UNIX/Linux system calls have as parameter one or more filenames. A "
3270 "filename (or pathname) is resolved as follows."
3274 #: build/C/man7/path_resolution.7:31
3276 msgid "Step 1: start of the resolution process"
3280 #: build/C/man7/path_resolution.7:50
3282 "If the pathname starts with the \\(aq/\\(aq character, the starting lookup "
3283 "directory is the root directory of the calling process. (A process inherits "
3284 "its root directory from its parent. Usually this will be the root directory "
3285 "of the file hierarchy. A process may get a different root directory by use "
3286 "of the B<chroot>(2) system call. A process may get an entirely private "
3287 "mount namespace in case it\\(emor one of its ancestors\\(emwas started by an "
3288 "invocation of the B<clone>(2) system call that had the B<CLONE_NEWNS> flag "
3289 "set.) This handles the \\(aq/\\(aq part of the pathname."
3293 #: build/C/man7/path_resolution.7:58
3295 "If the pathname does not start with the \\(aq/\\(aq character, the starting "
3296 "lookup directory of the resolution process is the current working directory "
3297 "of the process. (This is also inherited from the parent. It can be changed "
3298 "by use of the B<chdir>(2) system call.)"
3302 #: build/C/man7/path_resolution.7:61
3304 "Pathnames starting with a \\(aq/\\(aq character are called absolute "
3305 "pathnames. Pathnames not starting with a \\(aq/\\(aq are called relative "
3310 #: build/C/man7/path_resolution.7:61
3312 msgid "Step 2: walk along the path"
3316 #: build/C/man7/path_resolution.7:66
3318 "Set the current lookup directory to the starting lookup directory. Now, for "
3319 "each nonfinal component of the pathname, where a component is a substring "
3320 "delimited by \\(aq/\\(aq characters, this component is looked up in the "
3321 "current lookup directory."
3325 #: build/C/man7/path_resolution.7:72
3327 "If the process does not have search permission on the current lookup "
3328 "directory, an B<EACCES> error is returned (\"Permission denied\")."
3332 #: build/C/man7/path_resolution.7:77
3334 "If the component is not found, an B<ENOENT> error is returned (\"No such "
3335 "file or directory\")."
3339 #: build/C/man7/path_resolution.7:82
3341 "If the component is found, but is neither a directory nor a symbolic link, "
3342 "an B<ENOTDIR> error is returned (\"Not a directory\")."
3346 #: build/C/man7/path_resolution.7:86
3348 "If the component is found and is a directory, we set the current lookup "
3349 "directory to that directory, and go to the next component."
3353 #. presently: max recursion depth during symlink resolution: 5
3354 #. max total number of symbolic links followed: 40
3355 #. _POSIX_SYMLOOP_MAX is 8
3357 #: build/C/man7/path_resolution.7:110
3359 "If the component is found and is a symbolic link (symlink), we first resolve "
3360 "this symbolic link (with the current lookup directory as starting lookup "
3361 "directory). Upon error, that error is returned. If the result is not a "
3362 "directory, an B<ENOTDIR> error is returned. If the resolution of the "
3363 "symlink is successful and returns a directory, we set the current lookup "
3364 "directory to that directory, and go to the next component. Note that the "
3365 "resolution process here involves recursion. In order to protect the kernel "
3366 "against stack overflow, and also to protect against denial of service, there "
3367 "are limits on the maximum recursion depth, and on the maximum number of "
3368 "symbolic links followed. An B<ELOOP> error is returned when the maximum is "
3369 "exceeded (\"Too many levels of symbolic links\")."
3373 #: build/C/man7/path_resolution.7:110
3375 msgid "Step 3: find the final entry"
3379 #: build/C/man7/path_resolution.7:122
3381 "The lookup of the final component of the pathname goes just like that of all "
3382 "other components, as described in the previous step, with two differences: "
3383 "(i) the final component need not be a directory (at least as far as the path "
3384 "resolution process is concerned\\(emit may have to be a directory, or a "
3385 "nondirectory, because of the requirements of the specific system call), and "
3386 "(ii) it is not necessarily an error if the component is not found\\(emmaybe "
3387 "we are just creating it. The details on the treatment of the final entry "
3388 "are described in the manual pages of the specific system calls."
3392 #: build/C/man7/path_resolution.7:122
3398 #: build/C/man7/path_resolution.7:126
3400 "By convention, every directory has the entries \".\" and \"..\", which refer "
3401 "to the directory itself and to its parent directory, respectively."
3405 #: build/C/man7/path_resolution.7:130
3407 "The path resolution process will assume that these entries have their "
3408 "conventional meanings, regardless of whether they are actually present in "
3409 "the physical filesystem."
3413 #: build/C/man7/path_resolution.7:132
3414 msgid "One cannot walk down past the root: \"/..\" is the same as \"/\"."
3418 #: build/C/man7/path_resolution.7:132
3420 msgid "Mount points"
3424 #: build/C/man7/path_resolution.7:136
3426 "After a \"mount dev path\" command, the pathname \"path\" refers to the root "
3427 "of the filesystem hierarchy on the device \"dev\", and no longer to whatever "
3428 "it referred to earlier."
3432 #: build/C/man7/path_resolution.7:140
3434 "One can walk out of a mounted filesystem: \"path/..\" refers to the parent "
3435 "directory of \"path\", outside of the filesystem hierarchy on \"dev\"."
3439 #: build/C/man7/path_resolution.7:140
3441 msgid "Trailing slashes"
3445 #: build/C/man7/path_resolution.7:146
3447 "If a pathname ends in a \\(aq/\\(aq, that forces resolution of the preceding "
3448 "component as in Step 2: it has to exist and resolve to a directory. "
3449 "Otherwise a trailing \\(aq/\\(aq is ignored. (Or, equivalently, a pathname "
3450 "with a trailing \\(aq/\\(aq is equivalent to the pathname obtained by "
3451 "appending \\(aq.\\(aq to it.)"
3455 #: build/C/man7/path_resolution.7:146
3457 msgid "Final symlink"
3461 #: build/C/man7/path_resolution.7:155
3463 "If the last component of a pathname is a symbolic link, then it depends on "
3464 "the system call whether the file referred to will be the symbolic link or "
3465 "the result of path resolution on its contents. For example, the system call "
3466 "B<lstat>(2) will operate on the symlink, while B<stat>(2) operates on the "
3467 "file pointed to by the symlink."
3471 #: build/C/man7/path_resolution.7:155
3473 msgid "Length limit"
3477 #: build/C/man7/path_resolution.7:162
3479 "There is a maximum length for pathnames. If the pathname (or some "
3480 "intermediate pathname obtained while resolving symbolic links) is too long, "
3481 "an B<ENAMETOOLONG> error is returned (\"Filename too long\")."
3485 #: build/C/man7/path_resolution.7:162
3487 msgid "Empty pathname"
3491 #: build/C/man7/path_resolution.7:169
3493 "In the original UNIX, the empty pathname referred to the current directory. "
3494 "Nowadays POSIX decrees that an empty pathname must not be resolved "
3495 "successfully. Linux returns B<ENOENT> in this case."
3499 #: build/C/man7/path_resolution.7:169
3505 #: build/C/man7/path_resolution.7:182
3507 "The permission bits of a file consist of three groups of three bits, cf.\\& "
3508 "B<chmod>(1) and B<stat>(2). The first group of three is used when the "
3509 "effective user ID of the calling process equals the owner ID of the file. "
3510 "The second group of three is used when the group ID of the file either "
3511 "equals the effective group ID of the calling process, or is one of the "
3512 "supplementary group IDs of the calling process (as set by B<setgroups>(2)). "
3513 "When neither holds, the third group is used."
3517 #: build/C/man7/path_resolution.7:186
3519 "Of the three bits used, the first bit determines read permission, the second "
3520 "write permission, and the last execute permission in case of ordinary files, "
3521 "or search permission in case of directories."
3525 #: build/C/man7/path_resolution.7:191
3527 "Linux uses the fsuid instead of the effective user ID in permission checks. "
3528 "Ordinarily the fsuid will equal the effective user ID, but the fsuid can be "
3529 "changed by the system call B<setfsuid>(2)."
3533 #: build/C/man7/path_resolution.7:199
3535 "(Here \"fsuid\" stands for something like \"filesystem user ID\". The "
3536 "concept was required for the implementation of a user space NFS server at a "
3537 "time when processes could send a signal to a process with the same effective "
3538 "user ID. It is obsolete now. Nobody should use B<setfsuid>(2).)"
3541 #. FIXME say something about filesystem mounted read-only ?
3543 #: build/C/man7/path_resolution.7:205
3545 "Similarly, Linux uses the fsgid (\"filesystem group ID\") instead of the "
3546 "effective group ID. See B<setfsgid>(2)."
3550 #: build/C/man7/path_resolution.7:205
3552 msgid "Bypassing permission checks: superuser and capabilities"
3555 #. (but for exec at least one x bit must be set) -- AEB
3556 #. but there is variation across systems on this point: for
3557 #. example, HP-UX and Tru64 are as described by AEB. However,
3558 #. on some implementations (e.g., Solaris, FreeBSD),
3559 #. access(X_OK) by superuser will report success, regardless
3560 #. of the file's execute permission bits. -- MTK (Oct 05)
3562 #: build/C/man7/path_resolution.7:216
3564 "On a traditional UNIX system, the superuser (I<root>, user ID 0) is "
3565 "all-powerful, and bypasses all permissions restrictions when accessing "
3570 #: build/C/man7/path_resolution.7:224
3572 "On Linux, superuser privileges are divided into capabilities (see "
3573 "B<capabilities>(7)). Two capabilities are relevant for file permissions "
3574 "checks: B<CAP_DAC_OVERRIDE> and B<CAP_DAC_READ_SEARCH>. (A process has "
3575 "these capabilities if its fsuid is 0.)"
3579 #: build/C/man7/path_resolution.7:230
3581 "The B<CAP_DAC_OVERRIDE> capability overrides all permission checking, but "
3582 "grants execute permission only when at least one of the file's three execute "
3583 "permission bits is set."
3586 #. FIXME say something about immutable files
3587 #. FIXME say something about ACLs
3589 #: build/C/man7/path_resolution.7:237
3591 "The B<CAP_DAC_READ_SEARCH> capability grants read and search permission on "
3592 "directories, and read permission on ordinary files."
3596 #: build/C/man7/path_resolution.7:242
3597 msgid "B<readlink>(2), B<capabilities>(7), B<credentials>(7), B<symlink>(7)"
3601 #: build/C/man2/removexattr.2:25
3607 #: build/C/man2/removexattr.2:28
3608 msgid "removexattr, lremovexattr, fremovexattr - remove an extended attribute"
3612 #: build/C/man2/removexattr.2:37
3615 "B<int removexattr(const char\\ *>I<path>B<, const char\\ *>I<name>B<);>\n"
3616 "B<int lremovexattr(const char\\ *>I<path>B<, const char\\ *>I<name>B<);>\n"
3617 "B<int fremovexattr(int >I<fd>B<, const char\\ *>I<name>B<);>\n"
3621 #: build/C/man2/removexattr.2:49
3623 "Extended attributes are I<name>:value pairs associated with inodes (files, "
3624 "directories, symbolic links, etc.). They are extensions to the normal "
3625 "attributes which are associated with all inodes in the system (i.e., the "
3626 "B<stat>(2) data). A complete overview of extended attributes concepts can "
3627 "be found in B<attr>(5)."
3631 #: build/C/man2/removexattr.2:56
3633 "B<removexattr>() removes the extended attribute identified by I<name> and "
3634 "associated with the given I<path> in the filesystem."
3638 #: build/C/man2/removexattr.2:62
3640 "B<lremovexattr>() is identical to B<removexattr>(), except in the case of a "
3641 "symbolic link, where the extended attribute is removed from the link itself, "
3642 "not the file that it refers to."
3646 #: build/C/man2/removexattr.2:72
3648 "B<fremovexattr>() is identical to B<removexattr>(), only the extended "
3649 "attribute is removed from the open file referred to by I<fd> (as returned by "
3650 "B<open>(2)) in place of I<path>."
3654 #: build/C/man2/removexattr.2:78
3656 "An extended attribute name is a simple null-terminated string. The I<name> "
3657 "includes a namespace prefix; there may be several, disjoint namespaces "
3658 "associated with an individual inode."
3662 #: build/C/man2/removexattr.2:83 build/C/man2/setxattr.2:110
3664 "On success, zero is returned. On failure, -1 is returned and I<errno> is "
3665 "set appropriately."
3669 #: build/C/man2/removexattr.2:92
3671 "The named attribute does not exist. (B<ENOATTR> is defined to be a synonym "
3672 "for B<ENODATA> in I<E<lt>attr/xattr.hE<gt>>.)"
3676 #: build/C/man2/removexattr.2:120
3678 "B<getfattr>(1), B<setfattr>(1), B<getxattr>(2), B<listxattr>(2), B<open>(2), "
3679 "B<setxattr>(2), B<stat>(2), B<attr>(5), B<symlink>(7)"
3683 #: build/C/man2/setxattr.2:25
3689 #: build/C/man2/setxattr.2:28
3690 msgid "setxattr, lsetxattr, fsetxattr - set an extended attribute value"
3694 #: build/C/man2/setxattr.2:40
3697 "B<int setxattr(const char\\ *>I<path>B<, const char\\ *>I<name>B<,>\n"
3698 "B< const void\\ *>I<value>B<, size_t >I<size>B<, int "
3700 "B<int lsetxattr(const char\\ *>I<path>B<, const char\\ *>I<name>B<,>\n"
3701 "B< const void\\ *>I<value>B<, size_t >I<size>B<, int "
3703 "B<int fsetxattr(int >I<fd>B<, const char\\ *>I<name>B<,>\n"
3704 "B< const void\\ *>I<value>B<, size_t >I<size>B<, int "
3709 #: build/C/man2/setxattr.2:67
3711 "B<setxattr>() sets the I<value> of the extended attribute identified by "
3712 "I<name> and associated with the given I<path> in the filesystem. The "
3713 "I<size> of the I<value> must be specified."
3717 #: build/C/man2/setxattr.2:73
3719 "B<lsetxattr>() is identical to B<setxattr>(), except in the case of a "
3720 "symbolic link, where the extended attribute is set on the link itself, not "
3721 "the file that it refers to."
3725 #: build/C/man2/setxattr.2:83
3727 "B<fsetxattr>() is identical to B<setxattr>(), only the extended attribute "
3728 "is set on the open file referred to by I<fd> (as returned by B<open>(2)) in "
3733 #: build/C/man2/setxattr.2:93
3735 "An extended attribute name is a simple null-terminated string. The I<name> "
3736 "includes a namespace prefix; there may be several, disjoint namespaces "
3737 "associated with an individual inode. The I<value> of an extended attribute "
3738 "is a chunk of arbitrary textual or binary data of specified length."
3742 #: build/C/man2/setxattr.2:105
3744 "The I<flags> argument can be used to refine the semantics of the operation. "
3745 "B<XATTR_CREATE> specifies a pure create, which fails if the named attribute "
3746 "exists already. B<XATTR_REPLACE> specifies a pure replace operation, which "
3747 "fails if the named attribute does not already exist. By default (no flags), "
3748 "the extended attribute will be created if need be, or will simply replace "
3749 "the value if the attribute exists."
3753 #: build/C/man2/setxattr.2:111
3759 #: build/C/man2/setxattr.2:115
3761 "Disk quota limits meant that there is insufficient space remaining to store "
3762 "the extended attribute."
3766 #: build/C/man2/setxattr.2:115 build/C/man2/spu_create.2:178
3772 #: build/C/man2/setxattr.2:119
3773 msgid "B<XATTR_CREATE> was specified, and the attribute exists already."
3777 #: build/C/man2/setxattr.2:128
3779 "B<XATTR_REPLACE> was specified, and the attribute does not exist. "
3780 "(B<ENOATTR> is defined to be a synonym for B<ENODATA> in "
3781 "I<E<lt>attr/xattr.hE<gt>>.)"
3785 #: build/C/man2/setxattr.2:128 build/C/man2/spu_create.2:218
3791 #: build/C/man2/setxattr.2:131
3792 msgid "There is insufficient space remaining to store the extended attribute."
3796 #: build/C/man2/setxattr.2:137
3798 "Extended attributes are not supported by the filesystem, or are disabled, "
3799 "I<errno> is set to B<ENOTSUP>."
3803 #: build/C/man2/setxattr.2:162
3805 "B<getfattr>(1), B<setfattr>(1), B<getxattr>(2), B<listxattr>(2), B<open>(2), "
3806 "B<removexattr>(2), B<stat>(2), B<attr>(5), B<symlink>(7)"
3810 #: build/C/man2/spu_create.2:25
3816 #: build/C/man2/spu_create.2:25 build/C/man2/spu_run.2:26
3822 #: build/C/man2/spu_create.2:28
3823 msgid "spu_create - create a new spu context"
3827 #: build/C/man2/spu_create.2:32
3830 "B<#include E<lt>sys/types.hE<gt>>\n"
3831 "B<#include E<lt>sys/spu.hE<gt>>\n"
3835 #: build/C/man2/spu_create.2:36
3838 "B<int spu_create(const char *>I<pathname>B<, int >I<flags>B<, mode_t "
3840 "B<int spu_create(const char *>I<pathname>B<, int >I<flags>B<, mode_t "
3842 "B< int >I<neighbor_fd>B<);>\n"
3846 #: build/C/man2/spu_create.2:40 build/C/man2/spu_run.2:39
3847 msgid "I<Note>: There is no glibc wrapper for this system call; see NOTES."
3851 #: build/C/man2/spu_create.2:59
3853 "The B<spu_create>() system call is used on PowerPC machines that implement "
3854 "the Cell Broadband Engine Architecture in order to access Synergistic "
3855 "Processor Units (SPUs). It creates a new logical context for an SPU in "
3856 "I<pathname> and returns a file descriptor associated with it. I<pathname> "
3857 "must refer to a nonexistent directory in the mount point of the SPU "
3858 "filesystem (B<spufs>). If B<spu_create>() is successful, a directory is "
3859 "created at I<pathname> and it is populated with the files described in "
3864 #: build/C/man2/spu_create.2:78
3866 "When a context is created, the returned file descriptor can only be passed "
3867 "to B<spu_run>(2), used as the I<dirfd> argument to the B<*at> family of "
3868 "system calls (e.g., B<openat>(2)), or closed; other operations are not "
3869 "defined. A logical SPU context is destroyed (along with all files created "
3870 "within the context's I<pathname> directory) once the last reference to the "
3871 "context has gone; this usually occurs when the file descriptor returned by "
3872 "B<spu_create>() is closed."
3876 #: build/C/man2/spu_create.2:83
3878 "The I<flags> argument can be zero or any bitwise OR-ed combination of the "
3879 "following constants:"
3883 #: build/C/man2/spu_create.2:83
3885 msgid "B<SPU_CREATE_EVENTS_ENABLED>"
3889 #: build/C/man2/spu_create.2:89
3891 "Rather than using signals for reporting DMA errors, use the I<event> "
3892 "argument to B<spu_run>(2)."
3896 #: build/C/man2/spu_create.2:89
3898 msgid "B<SPU_CREATE_GANG>"
3902 #: build/C/man2/spu_create.2:97
3904 "Create an SPU gang instead of a context. (A gang is a group of SPU contexts "
3905 "that are functionally related to each other and which share common "
3906 "scheduling parameters\\(empriority and policy. In the future, gang "
3907 "scheduling may be implemented causing the group to be switched in and out as "
3912 #: build/C/man2/spu_create.2:104
3914 "A new directory will be created at the location specified by the I<pathname> "
3915 "argument. This gang may be used to hold other SPU contexts, by providing a "
3916 "pathname that is within the gang directory to further calls to "
3921 #: build/C/man2/spu_create.2:104
3923 msgid "B<SPU_CREATE_NOSCHED>"
3927 #: build/C/man2/spu_create.2:110
3929 "Create a context that is not affected by the SPU scheduler. Once the "
3930 "context is run, it will not be scheduled out until it is destroyed by the "
3935 #: build/C/man2/spu_create.2:121
3937 "Because the context cannot be removed from the SPU, some functionality is "
3938 "disabled for B<SPU_CREATE_NOSCHED> contexts. Only a subset of the files "
3939 "will be available in this context directory in B<spufs>. Additionally, "
3940 "B<SPU_CREATE_NOSCHED> contexts cannot dump a core file when crashing."
3944 #: build/C/man2/spu_create.2:127
3946 "Creating B<SPU_CREATE_NOSCHED> contexts requires the B<CAP_SYS_NICE> "
3951 #: build/C/man2/spu_create.2:127
3953 msgid "B<SPU_CREATE_ISOLATE>"
3957 #: build/C/man2/spu_create.2:134
3959 "Create an isolated SPU context. Isolated contexts are protected from some "
3960 "PPE (PowerPC Processing Element) operations, such as access to the SPU "
3961 "local store and the NPC register."
3965 #: build/C/man2/spu_create.2:140
3967 "Creating B<SPU_CREATE_ISOLATE> contexts also requires the "
3968 "B<SPU_CREATE_NOSCHED> flag."
3972 #: build/C/man2/spu_create.2:140
3974 msgid "B<SPU_CREATE_AFFINITY_SPU>"
3978 #: build/C/man2/spu_create.2:148
3980 "Create a context with affinity to another SPU context. This affinity "
3981 "information is used within the SPU scheduling algorithm. Using this flag "
3982 "requires that a file descriptor referring to the other SPU context be passed "
3983 "in the I<neighbor_fd> argument."
3987 #: build/C/man2/spu_create.2:148
3989 msgid "B<SPU_CREATE_AFFINITY_MEM>"
3993 #: build/C/man2/spu_create.2:153
3995 "Create a context with affinity to system memory. This affinity information "
3996 "is used within the SPU scheduling algorithm."
4000 #: build/C/man2/spu_create.2:165
4002 "The I<mode> argument (minus any bits set in the process's B<umask>(2)) "
4003 "specifies the permissions used for creating the new directory in B<spufs>. "
4004 "See B<stat>(2) for a full list of the possible I<mode> values."
4008 #: build/C/man2/spu_create.2:172
4010 "On success, B<spu_create>() returns a new file descriptor. On error, -1 is "
4011 "returned, and I<errno> is set to one of the error codes listed below."
4015 #: build/C/man2/spu_create.2:178
4016 msgid "The current user does not have write access to the B<spufs>(7) mount point."
4020 #: build/C/man2/spu_create.2:181
4021 msgid "An SPU context already exists at the given pathname."
4025 #: build/C/man2/spu_create.2:186
4027 "I<pathname> is not a valid string pointer in the calling process's address "
4032 #: build/C/man2/spu_create.2:192
4034 "I<pathname> is not a directory in the B<spufs>(7) mount point, or invalid "
4035 "flags have been provided."
4039 #: build/C/man2/spu_create.2:196
4040 msgid "Too many symbolic links were found while resolving I<pathname>."
4044 #: build/C/man2/spu_create.2:199
4045 msgid "The process has reached its maximum open files limit."
4049 #: build/C/man2/spu_create.2:203 build/C/man2/stat.2:469
4050 msgid "I<pathname> is too long."
4054 #: build/C/man2/spu_create.2:203
4060 #: build/C/man2/spu_create.2:206
4061 msgid "The system has reached the global open files limit."
4065 #: build/C/man2/spu_create.2:210
4067 "An isolated context was requested, but the hardware does not support SPU "
4072 #: build/C/man2/spu_create.2:215
4073 msgid "Part of I<pathname> could not be resolved."
4077 #: build/C/man2/spu_create.2:218
4078 msgid "The kernel could not allocate all resources required."
4082 #: build/C/man2/spu_create.2:223
4084 "There are not enough SPU resources available to create a new context or the "
4085 "user-specific limit for the number of SPU contexts has been reached."
4089 #: build/C/man2/spu_create.2:223 build/C/man2/spu_run.2:183 build/C/man2/statfs.2:178 build/C/man3/statvfs.3:145 build/C/man2/ustat.2:88
4095 #: build/C/man2/spu_create.2:228 build/C/man2/spu_run.2:188
4097 "The functionality is not provided by the current system, because either the "
4098 "hardware does not provide SPUs or the spufs module is not loaded."
4102 #: build/C/man2/spu_create.2:233
4103 msgid "A part of I<pathname> is not a directory."
4107 #: build/C/man2/spu_create.2:240
4109 "The I<SPU_CREATE_NOSCHED> flag has been given, but the user does not have "
4110 "the B<CAP_SYS_NICE> capability."
4114 #: build/C/man2/spu_create.2:246
4116 "I<pathname> must point to a location beneath the mount point of B<spufs>. "
4117 "By convention, it gets mounted in I</spu>."
4121 #: build/C/man2/spu_create.2:250
4122 msgid "The B<spu_create>() system call was added to Linux in kernel 2.6.16."
4126 #: build/C/man2/spu_create.2:254
4128 "This call is Linux-specific and implemented only on the PowerPC "
4129 "architecture. Programs using this system call are not portable."
4133 #: build/C/man2/spu_create.2:265
4135 "Glibc does not provide a wrapper for this system call; call it using "
4136 "B<syscall>(2). Note however, that B<spu_create>() is meant to be used from "
4137 "libraries that implement a more abstract interface to SPUs, not to be used "
4138 "from regular applications. See E<.UR "
4139 "http://www.bsc.es\\:/projects\\:/deepcomputing\\:/linuxoncell/> E<.UE> for "
4140 "the recommended libraries."
4144 #: build/C/man2/spu_create.2:270
4145 msgid "See B<spu_run>(2) for an example of the use of B<spu_create>()"
4149 #: build/C/man2/spu_create.2:275
4150 msgid "B<close>(2), B<spu_run>(2), B<capabilities>(7), B<spufs>(7)"
4154 #: build/C/man2/spu_run.2:26
4160 #: build/C/man2/spu_run.2:29
4161 msgid "spu_run - execute an SPU context"
4165 #: build/C/man2/spu_run.2:32
4167 msgid "B<#include E<lt>sys/spu.hE<gt>>\n"
4171 #: build/C/man2/spu_run.2:35
4174 "B<int spu_run(int >I<fd>B<, unsigned int *>I<npc>B<, unsigned int "
4179 #: build/C/man2/spu_run.2:53
4181 "The B<spu_run>() system call is used on PowerPC machines that implement the "
4182 "Cell Broadband Engine Architecture in order to access Synergistic Processor "
4183 "Units (SPUs). The I<fd> argument is a file descriptor returned by "
4184 "B<spu_create>(2) that refers to a specific SPU context. When the context "
4185 "gets scheduled to a physical SPU, it starts execution at the instruction "
4186 "pointer passed in I<npc>."
4190 #: build/C/man2/spu_run.2:62
4192 "Execution of SPU code happens synchronously, meaning that B<spu_run>() "
4193 "blocks while the SPU is still running. If there is a need to execute SPU "
4194 "code in parallel with other code on either the main CPU or other SPUs, a new "
4195 "thread of execution must be created first (e.g., using "
4196 "B<pthread_create>(3))."
4200 #: build/C/man2/spu_run.2:72
4202 "When B<spu_run>() returns, the current value of the SPU program counter is "
4203 "written to I<npc>, so successive calls to B<spu_run>() can use the same "
4208 #: build/C/man2/spu_run.2:82
4210 "The I<event> argument provides a buffer for an extended status code. If the "
4211 "SPU context was created with the B<SPU_CREATE_EVENTS_ENABLED> flag, then "
4212 "this buffer is populated by the Linux kernel before B<spu_run>() returns."
4216 #: build/C/man2/spu_run.2:84
4217 msgid "The status code may be one (or more) of the following constants:"
4221 #: build/C/man2/spu_run.2:84
4223 msgid "B<SPE_EVENT_DMA_ALIGNMENT>"
4227 #: build/C/man2/spu_run.2:87
4228 msgid "A DMA alignment error occurred."
4232 #: build/C/man2/spu_run.2:87
4234 msgid "B<SPE_EVENT_INVALID_DMA>"
4238 #: build/C/man2/spu_run.2:90
4239 msgid "An invalid MFC DMA command was attempted."
4243 #: build/C/man2/spu_run.2:90
4245 msgid "B<SPE_EVENT_SPE_DATA_STORAGE>"
4249 #: build/C/man2/spu_run.2:93
4250 msgid "A DMA storage error occurred."
4254 #: build/C/man2/spu_run.2:93
4256 msgid "B<SPE_EVENT_SPE_ERROR>"
4260 #: build/C/man2/spu_run.2:96
4261 msgid "An illegal instruction was executed."
4265 #: build/C/man2/spu_run.2:102
4267 "NULL is a valid value for the I<event> argument. In this case, the events "
4268 "will not be reported to the calling process."
4272 #: build/C/man2/spu_run.2:111
4274 "On success, B<spu_run>() returns the value of the I<spu_status> register. "
4275 "On error, it returns -1 and sets I<errno> to one of the error codes listed "
4280 #: build/C/man2/spu_run.2:120
4282 "The I<spu_status> register value is a bit mask of status codes and "
4283 "optionally a 14-bit code returned from the B<stop-and-signal> instruction on "
4284 "the SPU. The bit masks for the status codes are:"
4288 #: build/C/man2/spu_run.2:120
4294 #: build/C/man2/spu_run.2:125
4295 msgid "SPU was stopped by a B<stop-and-signal> instruction."
4299 #: build/C/man2/spu_run.2:125
4305 #: build/C/man2/spu_run.2:130
4306 msgid "SPU was stopped by a B<halt> instruction."
4310 #: build/C/man2/spu_run.2:130
4316 #: build/C/man2/spu_run.2:133
4317 msgid "SPU is waiting for a channel."
4321 #: build/C/man2/spu_run.2:133
4327 #: build/C/man2/spu_run.2:136
4328 msgid "SPU is in single-step mode."
4332 #: build/C/man2/spu_run.2:136
4338 #: build/C/man2/spu_run.2:139
4339 msgid "SPU has tried to execute an invalid instruction."
4343 #: build/C/man2/spu_run.2:139
4349 #: build/C/man2/spu_run.2:142
4350 msgid "SPU has tried to access an invalid channel."
4354 #: build/C/man2/spu_run.2:142
4356 msgid "B<0x3fff0000>"
4360 #: build/C/man2/spu_run.2:148
4362 "The bits masked with this value contain the code returned from a "
4363 "B<stop-and-signal> instruction. These bits are valid only if the 0x02 bit "
4368 #: build/C/man2/spu_run.2:153
4370 "If B<spu_run>() has not returned an error, one or more bits among the lower "
4371 "eight ones are always set."
4375 #: build/C/man2/spu_run.2:154 build/C/man2/stat.2:455 build/C/man2/stat.2:506 build/C/man2/statfs.2:142 build/C/man3/statvfs.3:109
4381 #: build/C/man2/spu_run.2:158
4382 msgid "I<fd> is not a valid file descriptor."
4386 #: build/C/man2/spu_run.2:164
4388 "I<npc> is not a valid pointer, or I<event> is non-NULL and an invalid "
4393 #: build/C/man2/spu_run.2:164 build/C/man2/statfs.2:153 build/C/man3/statvfs.3:120
4399 #: build/C/man2/spu_run.2:174
4401 "A signal occurred while B<spu_run>() was in progress; see B<signal>(7). "
4402 "The I<npc> value has been updated to the new program counter value if "
4407 #: build/C/man2/spu_run.2:179
4408 msgid "I<fd> is not a valid file descriptor returned from B<spu_create>(2)."
4412 #: build/C/man2/spu_run.2:183
4414 "There was not enough memory available to handle a page fault resulting from "
4415 "a Memory Flow Controller (MFC) direct memory access."
4419 #: build/C/man2/spu_run.2:192
4420 msgid "The B<spu_run>() system call was added to Linux in kernel 2.6.16."
4424 #: build/C/man2/spu_run.2:196
4426 "This call is Linux-specific and implemented only by the PowerPC "
4427 "architecture. Programs using this system call are not portable."
4431 #: build/C/man2/spu_run.2:207
4433 "Glibc does not provide a wrapper for this system call; call it using "
4434 "B<syscall>(2). Note however, that B<spu_run>() is meant to be used from "
4435 "libraries that implement a more abstract interface to SPUs, not to be used "
4436 "from regular applications. See E<.UR "
4437 "http://www.bsc.es\\:/projects\\:/deepcomputing\\:/linuxoncell/> E<.UE> for "
4438 "the recommended libraries."
4442 #: build/C/man2/spu_run.2:212
4444 "The following is an example of running a simple, one-instruction SPU program "
4445 "with the B<spu_run>() system call."
4449 #: build/C/man2/spu_run.2:220
4452 "#include E<lt>stdlib.hE<gt>\n"
4453 "#include E<lt>stdint.hE<gt>\n"
4454 "#include E<lt>unistd.hE<gt>\n"
4455 "#include E<lt>stdio.hE<gt>\n"
4456 "#include E<lt>sys/types.hE<gt>\n"
4457 "#include E<lt>fcntl.hE<gt>\n"
4461 #: build/C/man2/spu_run.2:223
4464 "#define handle_error(msg) \\e\n"
4465 " do { perror(msg); exit(EXIT_FAILURE); } while (0)\n"
4469 #: build/C/man2/spu_run.2:228
4474 " int context, fd, spu_status;\n"
4475 " uint32_t instruction, npc;\n"
4479 #: build/C/man2/spu_run.2:232
4482 " context = spu_create(\"/spu/example-context\", 0, 0755);\n"
4483 " if (context == -1)\n"
4484 " handle_error(\"spu_create\");\n"
4488 #: build/C/man2/spu_run.2:237
4491 " /* write a \\(aqstop 0x1234\\(aq instruction to the SPU\\(aqs\n"
4492 " * local store memory\n"
4494 " instruction = 0x00001234;\n"
4498 #: build/C/man2/spu_run.2:242
4501 " fd = open(\"/spu/example-context/mem\", O_RDWR);\n"
4503 " handle_error(\"open\");\n"
4504 " write(fd, &instruction, sizeof(instruction));\n"
4508 #: build/C/man2/spu_run.2:248
4511 " /* set npc to the starting instruction address of the\n"
4512 " * SPU program. Since we wrote the instruction at the\n"
4513 " * start of the mem file, the entry point will be 0x0\n"
4519 #: build/C/man2/spu_run.2:252
4522 " spu_status = spu_run(context, &npc, NULL);\n"
4523 " if (spu_status == -1)\n"
4524 " handle_error(\"open\");\n"
4528 #: build/C/man2/spu_run.2:258
4531 " /* we should see a status code of 0x1234002:\n"
4532 " * 0x00000002 (spu was stopped due to stop-and-signal)\n"
4533 " * | 0x12340000 (the stop-and-signal code)\n"
4535 " printf(\"SPU Status: 0x%08x\\en\", spu_status);\n"
4539 #: build/C/man2/spu_run.2:261 build/C/man2/stat.2:844
4542 " exit(EXIT_SUCCESS);\n"
4547 #: build/C/man2/spu_run.2:269
4548 msgid "B<close>(2), B<spu_create>(2), B<capabilities>(7), B<spufs>(7)"
4552 #: build/C/man7/spufs.7:27
4558 #: build/C/man7/spufs.7:27
4564 #: build/C/man7/spufs.7:30
4565 msgid "spufs - SPU filesystem"
4569 #: build/C/man7/spufs.7:34
4571 "The SPU filesystem is used on PowerPC machines that implement the Cell "
4572 "Broadband Engine Architecture in order to access Synergistic Processor Units "
4577 #: build/C/man7/spufs.7:43
4579 "The filesystem provides a name space similar to POSIX shared memory or "
4580 "message queues. Users that have write permissions on the filesystem can use "
4581 "B<spu_create>(2) to establish SPU contexts under the B<spufs> root "
4586 #: build/C/man7/spufs.7:50
4588 "Every SPU context is represented by a directory containing a predefined set "
4589 "of files. These files can be used for manipulating the state of the logical "
4590 "SPU. Users can change permissions on the files, but can't add or remove "
4595 #: build/C/man7/spufs.7:50
4597 msgid "Mount options"
4601 #: build/C/man7/spufs.7:51
4603 msgid "B<uid=E<lt>uidE<gt>>"
4607 #: build/C/man7/spufs.7:54
4608 msgid "Set the user owning the mount point; the default is 0 (root)."
4612 #: build/C/man7/spufs.7:54
4614 msgid "B<gid=E<lt>gidE<gt>>"
4618 #: build/C/man7/spufs.7:57
4619 msgid "Set the group owning the mount point; the default is 0 (root)."
4623 #: build/C/man7/spufs.7:57
4625 msgid "B<mode=E<lt>modeE<gt>>"
4629 #: build/C/man7/spufs.7:63
4631 "Set the mode of the top-level directory in B<spufs>, as an octal mode "
4632 "string. The default is 0775."
4636 #: build/C/man7/spufs.7:63
4642 #: build/C/man7/spufs.7:75
4644 "The files in B<spufs> mostly follow the standard behavior for regular system "
4645 "calls like B<read>(2) or B<write>(2), but often support only a subset of "
4646 "the operations supported on regular filesystems. This list details the "
4647 "supported operations and the deviations from the standard behavior described "
4648 "in the respective man pages."
4652 #: build/C/man7/spufs.7:97
4654 "All files that support the B<read>(2) operation also support B<readv>(2) "
4655 "and all files that support the B<write>(2) operation also support "
4656 "B<writev>(2). All files support the B<access>(2) and B<stat>(2) family of "
4657 "operations, but for the latter call, the only fields of the returned I<stat> "
4658 "structure that contain reliable information are I<st_mode>, I<st_nlink>, "
4659 "I<st_uid>, and I<st_gid>."
4663 #: build/C/man7/spufs.7:106
4665 "All files support the B<chmod>(2)/B<fchmod>(2) and B<chown>(2)/B<fchown>(2) "
4666 "operations, but will not be able to grant permissions that contradict the "
4667 "possible operations (e.g., read access on the I<wbox> file)."
4671 #: build/C/man7/spufs.7:108
4672 msgid "The current set of files is:"
4676 #: build/C/man7/spufs.7:108
4678 msgid "I</capabilities>"
4682 #: build/C/man7/spufs.7:113
4684 "Contains a comma-delimited string representing the capabilities of this SPU "
4685 "context. Possible capabilities are:"
4689 #: build/C/man7/spufs.7:114
4695 #: build/C/man7/spufs.7:117
4696 msgid "This context may be scheduled."
4700 #: build/C/man7/spufs.7:117
4706 #: build/C/man7/spufs.7:120
4707 msgid "This context can be run in single-step mode, for debugging."
4711 #: build/C/man7/spufs.7:122
4712 msgid "New capabilities flags may be added in the future."
4716 #: build/C/man7/spufs.7:123
4722 #: build/C/man7/spufs.7:132
4724 "the contents of the local storage memory of the SPU. This can be accessed "
4725 "like a regular shared memory file and contains both code and data in the "
4726 "address space of the SPU. The possible operations on an open I<mem> file "
4731 #: build/C/man7/spufs.7:133
4733 msgid "B<read>(2), B<pread>(2), B<write>(2), B<pwrite>(2), B<lseek>(2)"
4737 #: build/C/man7/spufs.7:144
4739 "These operate as usual, with the exception that B<lseek>(2), B<write>(2), "
4740 "and B<pwrite>(2) are not supported beyond the end of the file. The file "
4741 "size is the size of the local storage of the SPU, which is normally 256 "
4746 #: build/C/man7/spufs.7:144 build/C/man7/spufs.7:706 build/C/man7/spufs.7:725
4752 #: build/C/man7/spufs.7:153
4754 "Mapping I<mem> into the process address space provides access to the SPU "
4755 "local storage within the process address space. Only B<MAP_SHARED> mappings "
4760 #: build/C/man7/spufs.7:154
4766 #: build/C/man7/spufs.7:161
4768 "Contains the saved general-purpose registers of the SPU context. This file "
4769 "contains the 128-bit values of each register, from register 0 to register "
4770 "127, in order. This allows the general-purpose registers to be inspected "
4775 #: build/C/man7/spufs.7:165
4777 "Reading to or writing from this file requires that the context is scheduled "
4778 "out, so use of this file is not recommended in normal program operation."
4782 #: build/C/man7/spufs.7:171
4784 "The I<regs> file is not present on contexts that have been created with the "
4785 "B<SPU_CREATE_NOSCHED> flag."
4789 #: build/C/man7/spufs.7:171
4795 #: build/C/man7/spufs.7:181
4797 "The first SPU-to-CPU communication mailbox. This file is read-only and can "
4798 "be read in units of 4 bytes. The file can be used only in nonblocking mode "
4799 "- even B<poll>(2) cannot be used to block on this file. The only possible "
4800 "operation on an open I<mbox> file is:"
4804 #: 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
4810 #: build/C/man7/spufs.7:200
4812 "If I<count> is smaller than four, B<read>(2) returns -1 and sets I<errno> "
4813 "to B<EINVAL>. If there is no data available in the mailbox (i.e., the SPU "
4814 "has not sent a mailbox message), the return value is set to -1 and I<errno> "
4815 "is set to B<EAGAIN>. When data has been read successfully, four bytes are "
4816 "placed in the data buffer and the value four is returned."
4820 #: build/C/man7/spufs.7:201
4826 #: build/C/man7/spufs.7:217
4828 "The second SPU-to-CPU communication mailbox. This file is similar to the "
4829 "first mailbox file, but can be read in blocking I/O mode, thus calling "
4830 "B<read>(2) on an open I<ibox> file will block until the SPU has written "
4831 "data to its interrupt mailbox channel (unless the file has been opened with "
4832 "B<O_NONBLOCK>, see below). Also, B<poll>(2) and similar system calls can "
4833 "be used to monitor for the presence of mailbox data."
4837 #: build/C/man7/spufs.7:221
4838 msgid "The possible operations on an open I<ibox> file are:"
4842 #: build/C/man7/spufs.7:239
4844 "If I<count> is smaller than four, B<read>(2) returns -1 and sets I<errno> "
4845 "to B<EINVAL>. If there is no data available in the mailbox and the file "
4846 "descriptor has been opened with B<O_NONBLOCK>, the return value is set to -1 "
4847 "and I<errno> is set to B<EAGAIN>."
4851 #: build/C/man7/spufs.7:247
4853 "If there is no data available in the mailbox and the file descriptor has "
4854 "been opened without B<O_NONBLOCK>, the call will block until the SPU writes "
4855 "to its interrupt mailbox channel. When data has been read successfully, "
4856 "four bytes are placed in the data buffer and the value four is returned."
4860 #: build/C/man7/spufs.7:247 build/C/man7/spufs.7:295 build/C/man7/spufs.7:685
4866 #: build/C/man7/spufs.7:254
4868 "Poll on the I<ibox> file returns I<(POLLIN | POLLRDNORM)> whenever data is "
4869 "available for reading."
4873 #: build/C/man7/spufs.7:255
4879 #: build/C/man7/spufs.7:267
4881 "The CPU-to-SPU communication mailbox. It is write-only and can be written "
4882 "in units of four bytes. If the mailbox is full, B<write>(2) will block, "
4883 "and B<poll>(2) can be used to block until the mailbox is available for "
4884 "writing again. The possible operations on an open I<wbox> file are:"
4888 #: 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
4894 #: build/C/man7/spufs.7:286
4896 "If I<count> is smaller than four, B<write>(2) returns -1 and sets I<errno> "
4897 "to B<EINVAL>. If there is no space available in the mailbox and the file "
4898 "descriptor has been opened with B<O_NONBLOCK>, the return value is set to -1 "
4899 "and I<errno> is set to B<EAGAIN>."
4903 #: build/C/man7/spufs.7:295
4905 "If there is no space available in the mailbox and the file descriptor has "
4906 "been opened without B<O_NONBLOCK>, the call will block until the SPU reads "
4907 "from its PPE (PowerPC Processing Element) mailbox channel. When data has "
4908 "been written successfully, the system call returns four as its function "
4913 #: build/C/man7/spufs.7:302
4915 "A poll on the I<wbox> file returns I<(POLLOUT | POLLWRNORM)> whenever space "
4916 "is available for writing."
4920 #: build/C/man7/spufs.7:303
4922 msgid "I</mbox_stat>, I</ibox_stat>, I</wbox_stat>"
4926 #: build/C/man7/spufs.7:316
4928 "These are read-only files that contain the length of the current queue of "
4929 "each mailbox\\(emthat is, how many words can be read from I<mbox> or I<ibox> "
4930 "or how many words can be written to I<wbox> without blocking. The files can "
4931 "be read only in four-byte units and return a big-endian binary integer "
4932 "number. The only possible operation on an open I<*box_stat> file is:"
4936 #: build/C/man7/spufs.7:337
4938 "If I<count> is smaller than four, B<read>(2) returns -1 and sets I<errno> "
4939 "to B<EINVAL>. Otherwise, a four-byte value is placed in the data buffer. "
4940 "This value is the number of elements that can be read from (for I<mbox_stat> "
4941 "and I<ibox_stat>) or written to (for I<wbox_stat>) the respective mailbox "
4942 "without blocking or returning an B<EAGAIN> error."
4946 #: build/C/man7/spufs.7:338
4949 "I</npc>, I</decr>, I</decr_status>, I</spu_tag_mask>, I</event_mask>, "
4950 "I</event_status>, I</srr0>, I</lslr>"
4954 #: build/C/man7/spufs.7:350
4956 "Internal registers of the SPU. These files contain an ASCII string "
4957 "representing the hex value of the specified register. Reads and writes on "
4958 "these files (except for I<npc>, see below) require that the SPU context be "
4959 "scheduled out, so frequent access to these files is not recommended for "
4960 "normal program operation."
4964 #: build/C/man7/spufs.7:352
4965 msgid "The contents of these files are:"
4969 #: build/C/man7/spufs.7:353
4975 #: build/C/man7/spufs.7:356
4976 msgid "Next Program Counter - valid only when the SPU is in a stopped state."
4980 #: build/C/man7/spufs.7:356
4986 #: build/C/man7/spufs.7:359
4987 msgid "SPU Decrementer"
4991 #: build/C/man7/spufs.7:359
4993 msgid "I<decr_status>"
4997 #: build/C/man7/spufs.7:362
4998 msgid "Decrementer Status"
5002 #: build/C/man7/spufs.7:362
5004 msgid "I<spu_tag_mask>"
5008 #: build/C/man7/spufs.7:365
5009 msgid "MFC tag mask for SPU DMA"
5013 #: build/C/man7/spufs.7:365
5015 msgid "I<event_mask>"
5019 #: build/C/man7/spufs.7:368
5020 msgid "Event mask for SPU interrupts"
5024 #: build/C/man7/spufs.7:368
5026 msgid "I<event_status>"
5030 #: build/C/man7/spufs.7:371
5031 msgid "Number of SPU events pending (read-only)"
5035 #: build/C/man7/spufs.7:371
5041 #: build/C/man7/spufs.7:374
5042 msgid "Interrupt Return address register"
5046 #: build/C/man7/spufs.7:374
5052 #: build/C/man7/spufs.7:377
5053 msgid "Local Store Limit Register"
5057 #: build/C/man7/spufs.7:380
5058 msgid "The possible operations on these files are:"
5062 #: build/C/man7/spufs.7:388
5064 "Reads the current register value. If the register value is larger than the "
5065 "buffer passed to the B<read>(2) system call, subsequent reads will continue "
5066 "reading from the same buffer, until the end of the buffer is reached."
5070 #: build/C/man7/spufs.7:392
5072 "When a complete string has been read, all subsequent read operations will "
5073 "return zero bytes and a new file descriptor needs to be opened to read a new "
5078 #: build/C/man7/spufs.7:402 build/C/man7/spufs.7:537
5080 "A B<write>(2) operation on the file sets the register to the value given in "
5081 "the string. The string is parsed from the beginning until the first "
5082 "nonnumeric character or the end of the buffer. Subsequent writes to the "
5083 "same file descriptor overwrite the previous setting."
5087 #: build/C/man7/spufs.7:409
5089 "Except for the I<npc> file, these files are not present on contexts that "
5090 "have been created with the B<SPU_CREATE_NOSCHED> flag."
5094 #: build/C/man7/spufs.7:410
5100 #: build/C/man7/spufs.7:417
5102 "This file provides access to the Floating Point Status and Control Register "
5103 "(fcpr) as a binary, four-byte file. The operations on the I<fpcr> file are:"
5107 #: build/C/man7/spufs.7:432
5109 "If I<count> is smaller than four, B<read>(2) returns -1 and sets I<errno> "
5110 "to B<EINVAL>. Otherwise, a four-byte value is placed in the data buffer; "
5111 "this is the current value of the I<fpcr> register."
5115 #: build/C/man7/spufs.7:446
5117 "If I<count> is smaller than four, B<write>(2) returns -1 and sets I<errno> "
5118 "to B<EINVAL>. Otherwise, a four-byte value is copied from the data buffer, "
5119 "updating the value of the I<fpcr> register."
5123 #: build/C/man7/spufs.7:447
5125 msgid "I</signal1>, I</signal2>"
5129 #: build/C/man7/spufs.7:462
5131 "The files provide access to the two signal notification channels of an SPU. "
5132 "These are read-write files that operate on four-byte words. Writing to one "
5133 "of these files triggers an interrupt on the SPU. The value written to the "
5134 "signal files can be read from the SPU through a channel read or from host "
5135 "user space through the file. After the value has been read by the SPU, it "
5136 "is reset to zero. The possible operations on an open I<signal1> or "
5137 "I<signal2> file are:"
5141 #: build/C/man7/spufs.7:476
5143 "If I<count> is smaller than four, B<read>(2) returns -1 and sets I<errno> "
5144 "to B<EINVAL>. Otherwise, a four-byte value is placed in the data buffer; "
5145 "this is the current value of the specified signal notification register."
5149 #: build/C/man7/spufs.7:497
5151 "If I<count> is smaller than four, B<write>(2) returns -1 and sets I<errno> "
5152 "to B<EINVAL>. Otherwise, a four-byte value is copied from the data buffer, "
5153 "updating the value of the specified signal notification register. The "
5154 "signal notification register will either be replaced with the input data or "
5155 "will be updated to the bitwise OR operation of the old value and the input "
5156 "data, depending on the contents of the I<signal1_type> or I<signal2_type> "
5157 "files respectively."
5161 #: build/C/man7/spufs.7:498
5163 msgid "I</signal1_type>, I</signal2_type>"
5167 #: build/C/man7/spufs.7:516
5169 "These two files change the behavior of the I<signal1> and I<signal2> "
5170 "notification files. They contain a numeric ASCII string which is read as "
5171 "either \"1\" or \"0\". In mode 0 (overwrite), the hardware replaces the "
5172 "contents of the signal channel with the data that is written to it. In mode "
5173 "1 (logical OR), the hardware accumulates the bits that are subsequently "
5174 "written to it. The possible operations on an open I<signal1_type> or "
5175 "I<signal2_type> file are:"
5179 #: build/C/man7/spufs.7:527
5181 "When the count supplied to the B<read>(2) call is shorter than the required "
5182 "length for the digit (plus a newline character), subsequent reads from the "
5183 "same file descriptor will complete the string. When a complete string has "
5184 "been read, all subsequent read operations will return zero bytes and a new "
5185 "file descriptor needs to be opened to read the value again."
5189 #: build/C/man7/spufs.7:538
5191 msgid "I</mbox_info>, I</ibox_info>, I</wbox_info>, I</dma_into>, I</proxydma_info>"
5195 #: build/C/man7/spufs.7:557
5197 "Read-only files that contain the saved state of the SPU mailboxes and DMA "
5198 "queues. This allows the SPU status to be inspected, mainly for debugging. "
5199 "The I<mbox_info> and I<ibox_info> files each contain the four-byte mailbox "
5200 "message that has been written by the SPU. If no message has been written to "
5201 "these mailboxes, then contents of these files is undefined. The "
5202 "I<mbox_stat>, I<ibox_stat> and I<wbox_stat> files contain the available "
5207 #: build/C/man7/spufs.7:566
5209 "The I<wbox_info> file contains an array of four-byte mailbox messages, which "
5210 "have been sent to the SPU. With current CBEA machines, the array is four "
5211 "items in length, so up to 4 * 4 = 16 bytes can be read from this file. If "
5212 "any mailbox queue entry is empty, then the bytes read at the corresponding "
5213 "location are undefined."
5217 #: build/C/man7/spufs.7:571
5219 "The I<dma_info> file contains the contents of the SPU MFC DMA queue, "
5220 "represented as the following structure:"
5224 #: build/C/man7/spufs.7:582
5227 "struct spu_dma_info {\n"
5228 " uint64_t dma_info_type;\n"
5229 " uint64_t dma_info_mask;\n"
5230 " uint64_t dma_info_status;\n"
5231 " uint64_t dma_info_stall_and_notify;\n"
5232 " uint64_t dma_info_atomic_command_status;\n"
5233 " struct mfc_cq_sr dma_info_command_data[16];\n"
5238 #: build/C/man7/spufs.7:590
5240 "The last member of this data structure is the actual DMA queue, containing "
5241 "16 entries. The I<mfc_cq_sr> structure is defined as:"
5245 #: build/C/man7/spufs.7:599
5248 "struct mfc_cq_sr {\n"
5249 " uint64_t mfc_cq_data0_RW;\n"
5250 " uint64_t mfc_cq_data1_RW;\n"
5251 " uint64_t mfc_cq_data2_RW;\n"
5252 " uint64_t mfc_cq_data3_RW;\n"
5257 #: build/C/man7/spufs.7:607
5259 "The I<proxydma_info> file contains similar information, but describes the "
5260 "proxy DMA queue (i.e., DMAs initiated by entities outside the SPU) instead. "
5261 "The file is in the following format:"
5265 #: build/C/man7/spufs.7:616
5268 "struct spu_proxydma_info {\n"
5269 " uint64_t proxydma_info_type;\n"
5270 " uint64_t proxydma_info_mask;\n"
5271 " uint64_t proxydma_info_status;\n"
5272 " struct mfc_cq_sr proxydma_info_command_data[8];\n"
5277 #: build/C/man7/spufs.7:622
5279 "Accessing these files requires that the SPU context is scheduled out - "
5280 "frequent use can be inefficient. These files should not be used for normal "
5281 "program operation."
5285 #: build/C/man7/spufs.7:626
5287 "These files are not present on contexts that have been created with the "
5288 "B<SPU_CREATE_NOSCHED> flag."
5292 #: build/C/man7/spufs.7:626
5298 #: build/C/man7/spufs.7:631
5300 "This file provides access to the SPU Run Control and SPU status registers, "
5301 "as an ASCII string. The following operations are supported:"
5305 #: build/C/man7/spufs.7:638
5307 "Reads from the I<cntl> file will return an ASCII string with the hex value "
5308 "of the SPU Status register."
5312 #: build/C/man7/spufs.7:643
5313 msgid "Writes to the I<cntl> file will set the context's SPU Run Control register."
5317 #: build/C/man7/spufs.7:644
5323 #: build/C/man7/spufs.7:651
5325 "Provides access to the Memory Flow Controller of the SPU. Reading from the "
5326 "file returns the contents of the SPU's MFC Tag Status register, and writing "
5327 "to the file initiates a DMA from the MFC. The following operations are "
5332 #: build/C/man7/spufs.7:656
5334 "Writes to this file need to be in the format of a MFC DMA command, defined "
5339 #: build/C/man7/spufs.7:668
5342 "struct mfc_dma_command {\n"
5343 " int32_t pad; /* reserved */\n"
5344 " uint32_t lsa; /* local storage address */\n"
5345 " uint64_t ea; /* effective address */\n"
5346 " uint16_t size; /* transfer size */\n"
5347 " uint16_t tag; /* command tag */\n"
5348 " uint16_t class; /* class ID */\n"
5349 " uint16_t cmd; /* command opcode */\n"
5354 #: build/C/man7/spufs.7:676
5356 "Writes are required to be exactly I<sizeof(struct mfc_dma_command)> bytes in "
5357 "size. The command will be sent to the SPU's MFC proxy queue, and the tag "
5358 "stored in the kernel (see below)."
5362 #: build/C/man7/spufs.7:685
5364 "Reads the contents of the tag status register. If the file is opened in "
5365 "blocking mode (i.e., without B<O_NONBLOCK>), then the read will block until "
5366 "a DMA tag (as performed by a previous write) is complete. In nonblocking "
5367 "mode, the MFC tag status register will be returned without waiting."
5371 #: build/C/man7/spufs.7:698
5373 "Calling B<poll>(2) on the I<mfc> file will block until a new DMA can be "
5374 "started (by checking for B<POLLOUT>) or until a previously started DMA (by "
5375 "checking for B<POLLIN>) has been completed."
5379 #: build/C/man7/spufs.7:704
5381 "I</mss> Provides access to the MFC MultiSource Synchronization (MSS) "
5382 "facility. By B<mmap>(2)-ing this file, processes can access the MSS area of "
5387 #: build/C/man7/spufs.7:706 build/C/man7/spufs.7:724
5388 msgid "The following operations are supported:"
5392 #: build/C/man7/spufs.7:715
5394 "Mapping B<mss> into the process address space gives access to the SPU MSS "
5395 "area within the process address space. Only B<MAP_SHARED> mappings are "
5400 #: build/C/man7/spufs.7:716
5406 #: build/C/man7/spufs.7:722
5408 "Provides access to the whole problem-state mapping of the SPU. Applications "
5409 "can use this area to interface to the SPU, rather than writing to individual "
5410 "register files in B<spufs>."
5414 #: build/C/man7/spufs.7:733
5416 "Mapping B<psmap> gives a process a direct map of the SPU problem state "
5417 "area. Only B<MAP_SHARED> mappings are supported."
5421 #: build/C/man7/spufs.7:734
5427 #: build/C/man7/spufs.7:740
5429 "Read-only file containing the physical SPU number that the SPU context is "
5430 "running on. When the context is not running, this file contains the string "
5435 #: build/C/man7/spufs.7:742
5436 msgid "The physical SPU number is given by an ASCII hex string."
5440 #: build/C/man7/spufs.7:742
5442 msgid "I</object-id>"
5446 #: build/C/man7/spufs.7:748
5448 "Allows applications to store (or retrieve) a single 64-bit ID into the "
5449 "context. This ID is later used by profiling tools to uniquely identify the "
5454 #: build/C/man7/spufs.7:754
5456 "By writing an ASCII hex value into this file, applications can set the "
5457 "object ID of the SPU context. Any previous value of the object ID is "
5462 #: build/C/man7/spufs.7:758
5464 "Reading this file gives an ASCII hex string representing the object ID for "
5469 #: build/C/man7/spufs.7:760
5471 msgid "I</etc/fstab> entry"
5475 #. Arnd Bergmann <arndb@de.ibm.com>, Mark Nutter <mnutter@us.ibm.com>,
5476 #. Ulrich Weigand <Ulrich.Weigand@de.ibm.com>, Jeremy Kerr <jk@ozlabs.org>
5478 #: build/C/man7/spufs.7:766
5479 msgid "none \t/spu \tspufs \tgid=spu \t0\t0"
5483 #: build/C/man7/spufs.7:771
5484 msgid "B<close>(2), B<spu_create>(2), B<spu_run>(2), B<capabilities>(7)"
5488 #: build/C/man7/spufs.7:773
5489 msgid "I<The Cell Broadband Engine Architecture (CBEA) specification>"
5493 #: build/C/man2/stat.2:40
5499 #: build/C/man2/stat.2:40
5505 #: build/C/man2/stat.2:43
5506 msgid "stat, fstat, lstat, fstatat - get file status"
5510 #: build/C/man2/stat.2:46 build/C/man2/ustat.2:36
5512 msgid "B<#include E<lt>sys/types.hE<gt>>\n"
5516 #: build/C/man2/stat.2:48
5518 msgid "B<#include E<lt>sys/stat.hE<gt>>\n"
5522 #: build/C/man2/stat.2:50
5524 msgid "B<#include E<lt>unistd.hE<gt>>\n"
5528 #: build/C/man2/stat.2:52
5530 msgid "B<int stat(const char *>I<pathname>B<, struct stat *>I<buf>B<);>\n"
5534 #: build/C/man2/stat.2:54
5536 msgid "B<int fstat(int >I<fd>B<, struct stat *>I<buf>B<);>\n"
5540 #: build/C/man2/stat.2:56
5542 msgid "B<int lstat(const char *>I<pathname>B<, struct stat *>I<buf>B<);>\n"
5546 #: build/C/man2/stat.2:59
5549 "B<#include E<lt>fcntl.hE<gt> >/* Definition of AT_* constants */\n"
5550 "B<#include E<lt>sys/stat.hE<gt>>\n"
5554 #: build/C/man2/stat.2:63
5557 "B<int fstatat(int >I<dirfd>B<, const char *>I<pathname>B<, struct stat "
5559 "B< int >I<flags>B<);>\n"
5563 #: build/C/man2/stat.2:73
5568 #: build/C/man2/stat.2:76
5570 "_BSD_SOURCE || _XOPEN_SOURCE\\ E<gt>=\\ 500 || _XOPEN_SOURCE\\ &&\\ "
5571 "_XOPEN_SOURCE_EXTENDED"
5575 #: build/C/man2/stat.2:78
5576 msgid "|| /* Since glibc 2.10: */ _POSIX_C_SOURCE\\ E<gt>=\\ 200112L"
5580 #: build/C/man2/stat.2:81
5581 msgid "B<fstatat>():"
5585 #: build/C/man2/stat.2:84
5587 msgid "Since glibc 2.10:"
5591 #: build/C/man2/stat.2:87
5592 msgid "_XOPEN_SOURCE\\ E<gt>=\\ 700 || _POSIX_C_SOURCE\\ E<gt>=\\ 200809L"
5596 #: build/C/man2/stat.2:87
5598 msgid "Before glibc 2.10:"
5602 #: build/C/man2/stat.2:90
5603 msgid "_ATFILE_SOURCE"
5607 #: build/C/man2/stat.2:105
5609 "These functions return information about a file, in the buffer pointed to by "
5610 "I<stat>. No permissions are required on the file itself, but\\(emin the "
5611 "case of B<stat>(), B<fstatat>(), and B<lstat>()\\(emexecute (search) "
5612 "permission is required on all of the directories in I<pathname> that lead to "
5617 #: build/C/man2/stat.2:114
5619 "B<stat>() and B<fstatat>() retrieve information about the file pointed to "
5620 "by I<pathname>; the differences for B<fstatat>() are described below."
5624 #: build/C/man2/stat.2:122
5626 "B<lstat>() is identical to B<stat>(), except that if I<pathname> is a "
5627 "symbolic link, then it returns information about the link itself, not the "
5628 "file that it refers to."
5632 #: build/C/man2/stat.2:129
5634 "B<fstat>() is identical to B<stat>(), except that the file about which "
5635 "information is to be retrieved is specified by the file descriptor I<fd>."
5639 #: build/C/man2/stat.2:133
5641 "All of these system calls return a I<stat> structure, which contains the "
5646 #: build/C/man2/stat.2:147
5650 " dev_t st_dev; /* ID of device containing file */\n"
5651 " ino_t st_ino; /* inode number */\n"
5652 " mode_t st_mode; /* protection */\n"
5653 " nlink_t st_nlink; /* number of hard links */\n"
5654 " uid_t st_uid; /* user ID of owner */\n"
5655 " gid_t st_gid; /* group ID of owner */\n"
5656 " dev_t st_rdev; /* device ID (if special file) */\n"
5657 " off_t st_size; /* total size, in bytes */\n"
5658 " blksize_t st_blksize; /* blocksize for filesystem I/O */\n"
5659 " blkcnt_t st_blocks; /* number of 512B blocks allocated */\n"
5663 #: build/C/man2/stat.2:151
5666 " /* Since Linux 2.6, the kernel supports nanosecond\n"
5667 " precision for the following timestamp fields.\n"
5668 " For the details before Linux 2.6, see NOTES. */\n"
5672 #: build/C/man2/stat.2:155
5675 " struct timespec st_atim; /* time of last access */\n"
5676 " struct timespec st_mtim; /* time of last modification */\n"
5677 " struct timespec st_ctim; /* time of last status change */\n"
5681 #: build/C/man2/stat.2:160
5684 "#define st_atime st_atim.tv_sec /* Backward compatibility */\n"
5685 "#define st_mtime st_mtim.tv_sec\n"
5686 "#define st_ctime st_ctim.tv_sec\n"
5691 #: build/C/man2/stat.2:173
5693 "I<Note:> the order of fields in the I<stat> structure varies somewhat across "
5694 "architectures. In addition, the definition above does not show the padding "
5695 "bytes that may be present between some fields on various architectures. "
5696 "Consult the the glibc and kernel source code if you need to know the "
5701 #: build/C/man2/stat.2:182
5703 "The I<st_dev> field describes the device on which this file resides. (The "
5704 "B<major>(3) and B<minor>(3) macros may be useful to decompose the device "
5705 "ID in this field.)"
5709 #: build/C/man2/stat.2:186
5710 msgid "The I<st_rdev> field describes the device that this file (inode) represents."
5714 #: build/C/man2/stat.2:193
5716 "The I<st_size> field gives the size of the file (if it is a regular file or "
5717 "a symbolic link) in bytes. The size of a symbolic link is the length of the "
5718 "pathname it contains, without a terminating null byte."
5722 #: build/C/man2/stat.2:200
5724 "The I<st_blocks> field indicates the number of blocks allocated to the file, "
5725 "512-byte units. (This may be smaller than I<st_size>/512 when the file has "
5730 #: build/C/man2/stat.2:206
5732 "The I<st_blksize> field gives the \"preferred\" blocksize for efficient "
5733 "filesystem I/O. (Writing to a file in smaller chunks may cause an "
5734 "inefficient read-modify-rewrite.)"
5738 #: build/C/man2/stat.2:227
5740 "Not all of the Linux filesystems implement all of the time fields. Some "
5741 "filesystem types allow mounting in such a way that file and/or directory "
5742 "accesses do not cause an update of the I<st_atime> field. (See I<noatime>, "
5743 "I<nodiratime>, and I<relatime> in B<mount>(8), and related information in "
5744 "B<mount>(2).) In addition, I<st_atime> is not updated if a file is opened "
5745 "with the B<O_NOATIME>; see B<open>(2)."
5749 #: build/C/man2/stat.2:242
5751 "The field I<st_atime> is changed by file accesses, for example, by "
5752 "B<execve>(2), B<mknod>(2), B<pipe>(2), B<utime>(2) and B<read>(2) (of more "
5753 "than zero bytes). Other routines, like B<mmap>(2), may or may not update "
5758 #: build/C/man2/stat.2:261
5760 "The field I<st_mtime> is changed by file modifications, for example, by "
5761 "B<mknod>(2), B<truncate>(2), B<utime>(2) and B<write>(2) (of more than "
5762 "zero bytes). Moreover, I<st_mtime> of a directory is changed by the "
5763 "creation or deletion of files in that directory. The I<st_mtime> field is "
5764 "I<not> changed for changes in owner, group, hard link count, or mode."
5768 #: build/C/man2/stat.2:266
5770 "The field I<st_ctime> is changed by writing or by setting inode information "
5771 "(i.e., owner, group, link count, mode, etc.)."
5775 #: build/C/man2/stat.2:270
5777 "The following POSIX macros are defined to check the file type using the "
5782 #: build/C/man2/stat.2:271
5784 msgid "B<S_ISREG>(m)"
5788 #: build/C/man2/stat.2:274
5789 msgid "is it a regular file?"
5793 #: build/C/man2/stat.2:274
5795 msgid "B<S_ISDIR>(m)"
5799 #: build/C/man2/stat.2:277
5804 #: build/C/man2/stat.2:277
5806 msgid "B<S_ISCHR>(m)"
5810 #: build/C/man2/stat.2:280
5811 msgid "character device?"
5815 #: build/C/man2/stat.2:280
5817 msgid "B<S_ISBLK>(m)"
5821 #: build/C/man2/stat.2:283
5822 msgid "block device?"
5826 #: build/C/man2/stat.2:283
5828 msgid "B<S_ISFIFO>(m)"
5832 #: build/C/man2/stat.2:286
5833 msgid "FIFO (named pipe)?"
5837 #: build/C/man2/stat.2:286
5839 msgid "B<S_ISLNK>(m)"
5843 #: build/C/man2/stat.2:289
5844 msgid "symbolic link? (Not in POSIX.1-1996.)"
5848 #: build/C/man2/stat.2:289
5850 msgid "B<S_ISSOCK>(m)"
5854 #: build/C/man2/stat.2:292
5855 msgid "socket? (Not in POSIX.1-1996.)"
5859 #: build/C/man2/stat.2:297
5860 msgid "The following flags are defined for the I<st_mode> field:"
5864 #: build/C/man2/stat.2:300
5866 msgid "S_IFMT\t0170000\tbit mask for the file type bit fields\n"
5870 #: build/C/man2/stat.2:301
5872 msgid "S_IFSOCK\t0140000\tsocket\n"
5876 #: build/C/man2/stat.2:302
5878 msgid "S_IFLNK\t0120000\tsymbolic link\n"
5882 #: build/C/man2/stat.2:303
5884 msgid "S_IFREG\t0100000\tregular file\n"
5888 #: build/C/man2/stat.2:304
5890 msgid "S_IFBLK\t0060000\tblock device\n"
5894 #: build/C/man2/stat.2:305
5896 msgid "S_IFDIR\t0040000\tdirectory\n"
5900 #: build/C/man2/stat.2:306
5902 msgid "S_IFCHR\t0020000\tcharacter device\n"
5906 #: build/C/man2/stat.2:307
5908 msgid "S_IFIFO\t0010000\tFIFO\n"
5912 #: build/C/man2/stat.2:308
5914 msgid "S_ISUID\t0004000\tset-user-ID bit\n"
5918 #: build/C/man2/stat.2:309
5920 msgid "S_ISGID\t0002000\tset-group-ID bit (see below)\n"
5924 #: build/C/man2/stat.2:310
5926 msgid "S_ISVTX\t0001000\tsticky bit (see below)\n"
5930 #: build/C/man2/stat.2:311
5932 msgid "S_IRWXU\t00700\tmask for file owner permissions\n"
5936 #: build/C/man2/stat.2:312
5938 msgid "S_IRUSR\t00400\towner has read permission\n"
5942 #: build/C/man2/stat.2:313
5944 msgid "S_IWUSR\t00200\towner has write permission\n"
5948 #: build/C/man2/stat.2:314
5950 msgid "S_IXUSR\t00100\towner has execute permission\n"
5954 #: build/C/man2/stat.2:315
5956 msgid "S_IRWXG\t00070\tmask for group permissions\n"
5960 #: build/C/man2/stat.2:316
5962 msgid "S_IRGRP\t00040\tgroup has read permission\n"
5966 #: build/C/man2/stat.2:317
5968 msgid "S_IWGRP\t00020\tgroup has write permission\n"
5972 #: build/C/man2/stat.2:318
5974 msgid "S_IXGRP\t00010\tgroup has execute permission\n"
5978 #: build/C/man2/stat.2:319
5980 msgid "S_IRWXO\t00007\tT{\n"
5984 #: build/C/man2/stat.2:320
5986 msgid "mask for permissions for others (not in group)\n"
5990 #: build/C/man2/stat.2:321 build/C/man2/stat.2:620 build/C/man2/stat.2:628 build/C/man2/stat.2:639 build/C/man2/stat.2:651 build/C/man2/stat.2:656 build/C/man2/stat.2:659 build/C/man2/stat.2:663
5996 #: build/C/man2/stat.2:322
5998 msgid "S_IROTH\t00004\tothers have read permission\n"
6002 #: build/C/man2/stat.2:323
6004 msgid "S_IWOTH\t00002\tothers have write permission\n"
6008 #: build/C/man2/stat.2:324
6010 msgid "S_IXOTH\t00001\tothers have execute permission\n"
6014 #: build/C/man2/stat.2:341
6016 "The set-group-ID bit (B<S_ISGID>) has several special uses. For a "
6017 "directory it indicates that BSD semantics is to be used for that directory: "
6018 "files created there inherit their group ID from the directory, not from the "
6019 "effective group ID of the creating process, and directories created there "
6020 "will also get the B<S_ISGID> bit set. For a file that does not have the "
6021 "group execution bit (B<S_IXGRP>) set, the set-group-ID bit indicates "
6022 "mandatory file/record locking."
6026 #: build/C/man2/stat.2:350
6028 "The sticky bit (B<S_ISVTX>) on a directory means that a file in that "
6029 "directory can be renamed or deleted only by the owner of the file, by the "
6030 "owner of the directory, and by a privileged process."
6034 #: build/C/man2/stat.2:350
6040 #: build/C/man2/stat.2:356
6042 "The B<fstatat>() system call operates in exactly the same way as B<stat>(), "
6043 "except for the differences described here."
6047 #: build/C/man2/stat.2:366
6049 "If the pathname given in I<pathname> is relative, then it is interpreted "
6050 "relative to the directory referred to by the file descriptor I<dirfd> "
6051 "(rather than relative to the current working directory of the calling "
6052 "process, as is done by B<stat>() for a relative pathname)."
6056 #: build/C/man2/stat.2:378
6058 "If I<pathname> is relative and I<dirfd> is the special value B<AT_FDCWD>, "
6059 "then I<pathname> is interpreted relative to the current working directory of "
6060 "the calling process (like B<stat>())."
6064 #: build/C/man2/stat.2:384
6065 msgid "If I<pathname> is absolute, then I<dirfd> is ignored."
6069 #: build/C/man2/stat.2:387
6071 "I<flags> can either be 0, or include one or more of the following flags "
6076 #: build/C/man2/stat.2:387
6078 msgid "B<AT_EMPTY_PATH> (since Linux 2.6.39)"
6081 #. commit 65cfc6722361570bfe255698d9cd4dccaf47570d
6082 #. Before glibc 2.16, defining _ATFILE_SOURCE sufficed
6084 #: build/C/man2/stat.2:410
6086 "If I<pathname> is an empty string, operate on the file referred to by "
6087 "I<dirfd> (which may have been obtained using the B<open>(2) B<O_PATH> "
6088 "flag). If I<dirfd> is B<AT_FDCWD>, the call operates on the current working "
6089 "directory. In this case, I<dirfd> can refer to any type of file, not just a "
6090 "directory. This flag is Linux-specific; define B<_GNU_SOURCE> to obtain its "
6095 #: build/C/man2/stat.2:410
6097 msgid "B<AT_NO_AUTOMOUNT> (since Linux 2.6.38)"
6100 #. Before glibc 2.16, defining _ATFILE_SOURCE sufficed
6102 #: build/C/man2/stat.2:426
6104 "Don't automount the terminal (\"basename\") component of I<pathname> if it "
6105 "is a directory that is an automount point. This allows the caller to gather "
6106 "attributes of an automount point (rather than the location it would mount). "
6107 "This flag can be used in tools that scan directories to prevent "
6108 "mass-automounting of a directory of automount points. The "
6109 "B<AT_NO_AUTOMOUNT> flag has no effect if the mount point has already been "
6110 "mounted over. This flag is Linux-specific; define B<_GNU_SOURCE> to obtain "
6115 #: build/C/man2/stat.2:426
6117 msgid "B<AT_SYMLINK_NOFOLLOW>"
6121 #: build/C/man2/stat.2:437
6123 "If I<pathname> is a symbolic link, do not dereference it: instead return "
6124 "information about the link itself, like B<lstat>(). (By default, "
6125 "B<fstatat>() dereferences symbolic links, like B<stat>().)"
6129 #: build/C/man2/stat.2:442
6130 msgid "See B<openat>(2) for an explanation of the need for B<fstatat>()."
6134 #: build/C/man2/stat.2:455
6136 "Search permission is denied for one of the directories in the path prefix of "
6137 "I<pathname>. (See also B<path_resolution>(7).)"
6141 #: build/C/man2/stat.2:459
6142 msgid "I<fd> is bad."
6146 #: build/C/man2/stat.2:462
6147 msgid "Bad address."
6151 #: build/C/man2/stat.2:465
6152 msgid "Too many symbolic links encountered while traversing the path."
6156 #: build/C/man2/stat.2:476
6158 "A component of I<pathname> does not exist, or I<pathname> is an empty "
6163 #: build/C/man2/stat.2:479
6164 msgid "Out of memory (i.e., kernel memory)."
6168 #: build/C/man2/stat.2:484
6169 msgid "A component of the path prefix of I<pathname> is not a directory."
6173 #: build/C/man2/stat.2:484 build/C/man2/statfs.2:187 build/C/man3/statvfs.3:154
6175 msgid "B<EOVERFLOW>"
6179 #: build/C/man2/stat.2:503
6181 "I<pathname> or I<fd> refers to a file whose size, inode number, or number of "
6182 "blocks cannot be represented in, respectively, the types I<off_t>, I<ino_t>, "
6183 "or I<blkcnt_t>. This error can occur when, for example, an application "
6184 "compiled on a 32-bit platform without I<-D_FILE_OFFSET_BITS=64> calls "
6185 "B<stat>() on a file whose size exceeds I<(1E<lt>E<lt>31)-1> bytes."
6189 #: build/C/man2/stat.2:506
6190 msgid "The following additional errors can occur for B<fstatat>():"
6194 #: build/C/man2/stat.2:510
6195 msgid "I<dirfd> is not a valid file descriptor."
6199 #: build/C/man2/stat.2:514
6200 msgid "Invalid flag specified in I<flags>."
6204 #: build/C/man2/stat.2:520
6206 "I<pathname> is relative and I<dirfd> is a file descriptor referring to a "
6207 "file other than a directory."
6211 #: build/C/man2/stat.2:524
6213 "B<fstatat>() was added to Linux in kernel 2.6.16; library support was added "
6214 "to glibc in version 2.4."
6217 #. SVr4 documents additional
6219 #. error conditions EINTR, ENOLINK, and EOVERFLOW. SVr4
6220 #. documents additional
6224 #. error conditions EINTR, EMULTIHOP, ENOLINK, and EOVERFLOW.
6226 #: build/C/man2/stat.2:537
6227 msgid "B<stat>(), B<fstat>(), B<lstat>(): SVr4, 4.3BSD, POSIX.1-2001, POSIX.1.2008."
6231 #: build/C/man2/stat.2:540
6232 msgid "B<fstatat>(): POSIX.1-2008."
6236 #: build/C/man2/stat.2:554
6238 "According to POSIX.1-2001, B<lstat>() on a symbolic link need return valid "
6239 "information only in the I<st_size> field and the file-type component of the "
6240 "I<st_mode> field of the I<stat> structure. POSIX.1-2008 tightens the "
6241 "specification, requiring B<lstat>() to return valid information in all "
6242 "fields except the permission bits in I<st_mode>."
6246 #: build/C/man2/stat.2:574
6248 "Use of the I<st_blocks> and I<st_blksize> fields may be less portable. "
6249 "(They were introduced in BSD. The interpretation differs between systems, "
6250 "and possibly on a single system when NFS mounts are involved.) If you need "
6251 "to obtain the definition of the I<blkcnt_t> or I<blksize_t> types from "
6252 "I<E<lt>sys/stat.hE<gt>>, then define B<_XOPEN_SOURCE> with the value 500 or "
6253 "greater (before including I<any> header files)."
6257 #: build/C/man2/stat.2:592
6259 "POSIX.1-1990 did not describe the B<S_IFMT>, B<S_IFSOCK>, B<S_IFLNK>, "
6260 "B<S_IFREG>, B<S_IFBLK>, B<S_IFDIR>, B<S_IFCHR>, B<S_IFIFO>, B<S_ISVTX> "
6261 "constants, but instead demanded the use of the macros B<S_ISDIR>(), and so "
6262 "on. The B<S_IF*> constants are present in POSIX.1-2001 and later."
6266 #: build/C/man2/stat.2:600
6268 "The B<S_ISLNK>() and B<S_ISSOCK>() macros are not in POSIX.1-1996, but "
6269 "both are present in POSIX.1-2001; the former is from SVID 4, the latter from "
6274 #: build/C/man2/stat.2:610
6276 "UNIX V7 (and later systems) had B<S_IREAD>, B<S_IWRITE>, B<S_IEXEC>, where "
6277 "POSIX prescribes the synonyms B<S_IRUSR>, B<S_IWUSR>, B<S_IXUSR>."
6281 #: build/C/man2/stat.2:610
6283 msgid "Other systems"
6287 #: build/C/man2/stat.2:612
6288 msgid "Values that have been (or are) in use on various systems:"
6292 #: build/C/man2/stat.2:615
6294 msgid "hex\tname\tls\toctal\tdescription\n"
6298 #: build/C/man2/stat.2:616
6300 msgid "f000\tS_IFMT\t\t170000\tmask for file type\n"
6304 #: build/C/man2/stat.2:617
6306 msgid "0000\t\t\t000000\tT{\n"
6310 #: build/C/man2/stat.2:618
6312 msgid "SCO out-of-service inode; BSD unknown type; SVID-v2 and XPG2\n"
6316 #: build/C/man2/stat.2:619
6318 msgid "have both 0 and 0100000 for ordinary file\n"
6322 #: build/C/man2/stat.2:621
6324 msgid "1000\tS_IFIFO\tp|\t010000\tFIFO (named pipe)\n"
6328 #: build/C/man2/stat.2:622
6330 msgid "2000\tS_IFCHR\tc\t020000\tcharacter special (V7)\n"
6334 #: build/C/man2/stat.2:623
6336 msgid "3000\tS_IFMPC\t\t030000\tmultiplexed character special (V7)\n"
6340 #: build/C/man2/stat.2:624
6342 msgid "4000\tS_IFDIR\td/\t040000\tdirectory (V7)\n"
6346 #: build/C/man2/stat.2:625
6348 msgid "5000\tS_IFNAM\t\t050000\tT{\n"
6352 #: build/C/man2/stat.2:626
6354 msgid "XENIX named special file with two subtypes, distinguished by\n"
6358 #: build/C/man2/stat.2:627
6360 msgid "I<st_rdev> values 1, 2\n"
6364 #: build/C/man2/stat.2:629
6366 msgid "0001\tS_INSEM\ts\t000001\tXENIX semaphore subtype of IFNAM\n"
6370 #: build/C/man2/stat.2:630
6372 msgid "0002\tS_INSHD\tm\t000002\tXENIX shared data subtype of IFNAM\n"
6376 #: build/C/man2/stat.2:631
6378 msgid "6000\tS_IFBLK\tb\t060000\tblock special (V7)\n"
6382 #: build/C/man2/stat.2:632
6384 msgid "7000\tS_IFMPB\t\t070000\tmultiplexed block special (V7)\n"
6388 #: build/C/man2/stat.2:633
6390 msgid "8000\tS_IFREG\t-\t100000\tregular (V7)\n"
6394 #: build/C/man2/stat.2:634
6396 msgid "9000\tS_IFCMP\t\t110000\tVxFS compressed\n"
6400 #: build/C/man2/stat.2:635
6402 msgid "9000\tS_IFNWK\tn\t110000\tnetwork special (HP-UX)\n"
6406 #: build/C/man2/stat.2:636
6408 msgid "a000\tS_IFLNK\tl@\t120000\tsymbolic link (BSD)\n"
6412 #: build/C/man2/stat.2:637
6414 msgid "b000\tS_IFSHAD\t\t130000\tT{\n"
6418 #: build/C/man2/stat.2:638
6420 msgid "Solaris shadow inode for ACL (not seen by user space)\n"
6424 #: build/C/man2/stat.2:640
6426 msgid "c000\tS_IFSOCK\ts=\t140000\tsocket (BSD; also \"S_IFSOC\" on VxFS)\n"
6430 #: build/C/man2/stat.2:641
6432 msgid "d000\tS_IFDOOR\tDE<gt>\t150000\tSolaris door\n"
6436 #: build/C/man2/stat.2:642
6438 msgid "e000\tS_IFWHT\tw%\t160000\tBSD whiteout (not used for inode)\n"
6442 #: build/C/man2/stat.2:643
6444 msgid "0200\tS_ISVTX\t\t001000\tT{\n"
6448 #: build/C/man2/stat.2:644
6450 msgid "sticky bit: save swapped text even after use (V7)\n"
6454 #: build/C/man2/stat.2:645 build/C/man2/stat.2:647 build/C/man2/stat.2:649 build/C/man2/stat.2:654
6460 #: build/C/man2/stat.2:646
6462 msgid "reserved (SVID-v2)\n"
6466 #: build/C/man2/stat.2:648
6468 msgid "On nondirectories: don't cache this file (SunOS)\n"
6472 #: build/C/man2/stat.2:650
6474 msgid "On directories: restricted deletion flag (SVID-v4.2)\n"
6478 #: build/C/man2/stat.2:652
6480 msgid "0400\tS_ISGID\t\t002000\tT{\n"
6484 #: build/C/man2/stat.2:653
6486 msgid "set-group-ID on execution (V7)\n"
6490 #: build/C/man2/stat.2:655
6492 msgid "for directories: use BSD semantics for propagation of GID\n"
6496 #: build/C/man2/stat.2:657
6498 msgid "0400\tS_ENFMT\t\t002000\tT{\n"
6502 #: build/C/man2/stat.2:658
6504 msgid "System V file locking enforcement (shared with S_ISGID)\n"
6508 #: build/C/man2/stat.2:660
6510 msgid "0800\tS_ISUID\t\t004000\tset-user-ID on execution (V7)\n"
6514 #: build/C/man2/stat.2:661
6516 msgid "0800\tS_CDF\t\t004000\tT{\n"
6520 #: build/C/man2/stat.2:662
6522 msgid "directory is a context dependent file (HP-UX)\n"
6526 #: build/C/man2/stat.2:668
6527 msgid "A sticky command appeared in Version 32V AT&T UNIX."
6531 #: build/C/man2/stat.2:675
6533 "On Linux, B<lstat>() will generally not trigger automounter action, whereas "
6534 "B<stat>() will (but see B<fstatat>(2))."
6538 #: build/C/man2/stat.2:683
6540 "For most files under the I</proc> directory, B<stat>() does not return the "
6541 "file size in the I<st_size> field; instead the field is returned with the "
6546 #: build/C/man2/stat.2:683
6548 msgid "Timestamp fields"
6552 #: build/C/man2/stat.2:694
6554 "Older kernels and older standards did not support nanosecond timestamp "
6555 "fields. Instead, there were three timestamp fields\\(emI<st_atime>, "
6556 "I<st_mtime>, and I<st_ctime>\\(emtyped as I<time_t> that recorded timestamps "
6557 "with one-second precision."
6561 #: build/C/man2/stat.2:716
6563 "Since kernel 2.5.48, the I<stat> structure supports nanosecond resolution "
6564 "for the three file timestamp fields. The nanosecond components of each "
6565 "timestamp are available via names of the form I<st_atim.tv_nsec> if the "
6566 "B<_BSD_SOURCE> or B<_SVID_SOURCE> feature test macro is defined. Nanosecond "
6567 "timestamps are nowadays standardized, starting with POSIX.1-2008, and, "
6568 "starting with version 2.12, glibc also exposes the nanosecond component "
6569 "names if B<_POSIX_C_SOURCE> is defined with the value 200809L or greater, or "
6570 "B<_XOPEN_SOURCE> is defined with the value 700 or greater. If none of the "
6571 "aforementioned macros are defined, then the nanosecond values are exposed "
6572 "with names of the form I<st_atimensec>."
6575 #. commit ef7f38359ea8b3e9c7f2cae9a4d4935f55ca9e80
6577 #: build/C/man2/stat.2:723
6579 "Nanosecond timestamps are supported on XFS, JFS, Btrfs, and ext4 (since "
6580 "Linux 2.6.23). Nanosecond timestamps are not supported in ext2, ext3, and "
6581 "Resierfs. On filesystems that do not support subsecond timestamps, the "
6582 "nanosecond fields are returned with the value 0."
6586 #: build/C/man2/stat.2:723
6588 msgid "Underlying kernel interface"
6592 #. A note from Andries Brouwer, July 2007
6594 #. > Is the story not rather more complicated for some calls like
6597 #. Yes and no, mostly no. See /usr/include/sys/stat.h .
6599 #. The idea is here not so much that syscalls change, but that
6600 #. the definitions of struct stat and of the types dev_t and mode_t change.
6601 #. This means that libc (even if it does not call the kernel
6602 #. but only calls some internal function) must know what the
6603 #. format of dev_t or of struct stat is.
6604 #. The communication between the application and libc goes via
6605 #. the include file <sys/stat.h> that defines a _STAT_VER and
6606 #. _MKNOD_VER describing the layout of the data that user space
6607 #. uses. Each (almost each) occurrence of stat() is replaced by
6608 #. an occurrence of xstat() where the first parameter of xstat()
6609 #. is this version number _STAT_VER.
6611 #. Now, also the definitions used by the kernel change.
6612 #. But glibc copes with this in the standard way, and the
6613 #. struct stat as returned by the kernel is repacked into
6614 #. the struct stat as expected by the application.
6615 #. Thus, _STAT_VER and this setup cater for the application-libc
6616 #. interface, rather than the libc-kernel interface.
6618 #. (Note that the details depend on gcc being used as c compiler.)
6620 #: build/C/man2/stat.2:775
6622 "Over time, increases in the size of the I<stat> structure have led to three "
6623 "successive versions of B<stat>(): I<sys_stat>() (slot I<__NR_oldstat>), "
6624 "I<sys_newstat>() (slot I<__NR_stat>), and I<sys_stat64()> (new in kernel "
6625 "2.4; slot I<__NR_stat64>). The glibc B<stat>() wrapper function hides "
6626 "these details from applications, invoking the most recent version of the "
6627 "system call provided by the kernel, and repacking the returned information "
6628 "if required for old binaries. Similar remarks apply for B<fstat>() and "
6633 #: build/C/man2/stat.2:780
6635 "The underlying system call employed by the glibc B<fstatat>() wrapper "
6636 "function is actually called B<fstatat64>()."
6640 #: build/C/man2/stat.2:786
6642 "The following program calls B<stat>() and displays selected fields in the "
6643 "returned I<stat> structure."
6647 #: build/C/man2/stat.2:793
6650 "#include E<lt>sys/types.hE<gt>\n"
6651 "#include E<lt>sys/stat.hE<gt>\n"
6652 "#include E<lt>time.hE<gt>\n"
6653 "#include E<lt>stdio.hE<gt>\n"
6654 "#include E<lt>stdlib.hE<gt>\n"
6658 #: build/C/man2/stat.2:798
6662 "main(int argc, char *argv[])\n"
6664 " struct stat sb;\n"
6668 #: build/C/man2/stat.2:803
6671 " if (argc != 2) {\n"
6672 " fprintf(stderr, \"Usage: %s E<lt>pathnameE<gt>\\en\", argv[0]);\n"
6673 " exit(EXIT_FAILURE);\n"
6678 #: build/C/man2/stat.2:808
6681 " if (stat(argv[1], &sb) == -1) {\n"
6682 " perror(\"stat\");\n"
6683 " exit(EXIT_FAILURE);\n"
6688 #: build/C/man2/stat.2:810
6690 msgid " printf(\"File type: \");\n"
6694 #: build/C/man2/stat.2:821
6697 " switch (sb.st_mode & S_IFMT) {\n"
6698 " case S_IFBLK: printf(\"block device\\en\"); break;\n"
6699 " case S_IFCHR: printf(\"character device\\en\"); break;\n"
6700 " case S_IFDIR: printf(\"directory\\en\"); break;\n"
6701 " case S_IFIFO: printf(\"FIFO/pipe\\en\"); break;\n"
6702 " case S_IFLNK: printf(\"symlink\\en\"); break;\n"
6703 " case S_IFREG: printf(\"regular file\\en\"); break;\n"
6704 " case S_IFSOCK: printf(\"socket\\en\"); break;\n"
6705 " default: printf(\"unknown?\\en\"); break;\n"
6710 #: build/C/man2/stat.2:823
6712 msgid " printf(\"I-node number: %ld\\en\", (long) sb.st_ino);\n"
6716 #: build/C/man2/stat.2:826
6719 " printf(\"Mode: %lo (octal)\\en\",\n"
6720 " (unsigned long) sb.st_mode);\n"
6724 #: build/C/man2/stat.2:830
6727 " printf(\"Link count: %ld\\en\", (long) sb.st_nlink);\n"
6728 " printf(\"Ownership: UID=%ld GID=%ld\\en\",\n"
6729 " (long) sb.st_uid, (long) sb.st_gid);\n"
6733 #: build/C/man2/stat.2:837
6736 " printf(\"Preferred I/O block size: %ld bytes\\en\",\n"
6737 " (long) sb.st_blksize);\n"
6738 " printf(\"File size: %lld bytes\\en\",\n"
6739 " (long long) sb.st_size);\n"
6740 " printf(\"Blocks allocated: %lld\\en\",\n"
6741 " (long long) sb.st_blocks);\n"
6745 #: build/C/man2/stat.2:841
6748 " printf(\"Last status change: %s\", ctime(&sb.st_ctime));\n"
6749 " printf(\"Last file access: %s\", ctime(&sb.st_atime));\n"
6750 " printf(\"Last file modification: %s\", ctime(&sb.st_mtime));\n"
6754 #: build/C/man2/stat.2:855
6756 "B<ls>(1), B<stat>(1), B<access>(2), B<chmod>(2), B<chown>(2), "
6757 "B<readlink>(2), B<utime>(2), B<capabilities>(7), B<symlink>(7)"
6761 #: build/C/man2/statfs.2:28
6767 #: build/C/man2/statfs.2:28
6773 #: build/C/man2/statfs.2:31
6774 msgid "statfs, fstatfs - get filesystem statistics"
6778 #: build/C/man2/statfs.2:33
6779 msgid "B<#include E<lt>sys/vfs.hE<gt> >/* or E<lt>sys/statfs.hE<gt> */"
6783 #: build/C/man2/statfs.2:35
6784 msgid "B<int statfs(const char *>I<path>B<, struct statfs *>I<buf>B<);>"
6788 #: build/C/man2/statfs.2:37
6789 msgid "B<int fstatfs(int >I<fd>B<, struct statfs *>I<buf>B<);>"
6793 #: build/C/man2/statfs.2:47
6795 "The function B<statfs>() returns information about a mounted filesystem. "
6796 "I<path> is the pathname of any file within the mounted filesystem. I<buf> "
6797 "is a pointer to a I<statfs> structure defined approximately as follows:"
6801 #: build/C/man2/statfs.2:55
6804 "#if __WORDSIZE == 32\t\t/* System word size */\n"
6805 "# define __SWORD_TYPE int\n"
6806 "#else /* __WORDSIZE == 64 */\n"
6807 "# define __SWORD_TYPE\t\tlong int\n"
6812 #: build/C/man2/statfs.2:70
6816 " __SWORD_TYPE f_type; /* type of filesystem (see below) */\n"
6817 " __SWORD_TYPE f_bsize; /* optimal transfer block size */\n"
6818 " fsblkcnt_t f_blocks; /* total data blocks in filesystem */\n"
6819 " fsblkcnt_t f_bfree; /* free blocks in fs */\n"
6820 " fsblkcnt_t f_bavail; /* free blocks available to\n"
6821 " unprivileged user */\n"
6822 " fsfilcnt_t f_files; /* total file nodes in filesystem */\n"
6823 " fsfilcnt_t f_ffree; /* free file nodes in fs */\n"
6824 " fsid_t f_fsid; /* filesystem id */\n"
6825 " __SWORD_TYPE f_namelen; /* maximum length of filenames */\n"
6826 " __SWORD_TYPE f_frsize; /* fragment size (since Linux 2.6) */\n"
6827 " __SWORD_TYPE f_spare[5];\n"
6832 #: build/C/man2/statfs.2:72
6834 msgid "Filesystem types:\n"
6838 #: build/C/man2/statfs.2:118
6841 " ADFS_SUPER_MAGIC 0xadf5\n"
6842 " AFFS_SUPER_MAGIC 0xADFF\n"
6843 " BEFS_SUPER_MAGIC 0x42465331\n"
6844 " BFS_MAGIC 0x1BADFACE\n"
6845 " CIFS_MAGIC_NUMBER 0xFF534D42\n"
6846 " CODA_SUPER_MAGIC 0x73757245\n"
6847 " COH_SUPER_MAGIC 0x012FF7B7\n"
6848 " CRAMFS_MAGIC 0x28cd3d45\n"
6849 " DEVFS_SUPER_MAGIC 0x1373\n"
6850 " EFS_SUPER_MAGIC 0x00414A53\n"
6851 " EXT_SUPER_MAGIC 0x137D\n"
6852 " EXT2_OLD_SUPER_MAGIC 0xEF51\n"
6853 " EXT2_SUPER_MAGIC 0xEF53\n"
6854 " EXT3_SUPER_MAGIC 0xEF53\n"
6855 " EXT4_SUPER_MAGIC 0xEF53\n"
6856 " HFS_SUPER_MAGIC 0x4244\n"
6857 " HPFS_SUPER_MAGIC 0xF995E849\n"
6858 " HUGETLBFS_MAGIC 0x958458f6\n"
6859 " ISOFS_SUPER_MAGIC 0x9660\n"
6860 " JFFS2_SUPER_MAGIC 0x72b6\n"
6861 " JFS_SUPER_MAGIC 0x3153464a\n"
6862 " MINIX_SUPER_MAGIC 0x137F /* orig. minix */\n"
6863 " MINIX_SUPER_MAGIC2 0x138F /* 30 char minix */\n"
6864 " MINIX2_SUPER_MAGIC 0x2468 /* minix V2 */\n"
6865 " MINIX2_SUPER_MAGIC2 0x2478 /* minix V2, 30 char names */\n"
6866 " MSDOS_SUPER_MAGIC 0x4d44\n"
6867 " NCP_SUPER_MAGIC 0x564c\n"
6868 " NFS_SUPER_MAGIC 0x6969\n"
6869 " NTFS_SB_MAGIC 0x5346544e\n"
6870 " OPENPROM_SUPER_MAGIC 0x9fa1\n"
6871 " PROC_SUPER_MAGIC 0x9fa0\n"
6872 " QNX4_SUPER_MAGIC 0x002f\n"
6873 " REISERFS_SUPER_MAGIC 0x52654973\n"
6874 " ROMFS_MAGIC 0x7275\n"
6875 " SMB_SUPER_MAGIC 0x517B\n"
6876 " SYSV2_SUPER_MAGIC 0x012FF7B6\n"
6877 " SYSV4_SUPER_MAGIC 0x012FF7B5\n"
6878 " TMPFS_MAGIC 0x01021994\n"
6879 " UDF_SUPER_MAGIC 0x15013346\n"
6880 " UFS_MAGIC 0x00011954\n"
6881 " USBDEVICE_SUPER_MAGIC 0x9fa2\n"
6882 " VXFS_SUPER_MAGIC 0xa501FCF5\n"
6883 " XENIX_SUPER_MAGIC 0x012FF7B4\n"
6884 " XFS_SUPER_MAGIC 0x58465342\n"
6885 " _XIAFS_SUPER_MAGIC 0x012FD16D\n"
6889 #: build/C/man2/statfs.2:124
6890 msgid "Nobody knows what I<f_fsid> is supposed to contain (but see below)."
6894 #: build/C/man2/statfs.2:129
6896 "Fields that are undefined for a particular filesystem are set to 0. "
6897 "B<fstatfs>() returns the same information about an open file referenced by "
6902 #: build/C/man2/statfs.2:142
6904 "(B<statfs>()) Search permission is denied for a component of the path "
6905 "prefix of I<path>. (See also B<path_resolution>(7).)"
6909 #: build/C/man2/statfs.2:147
6910 msgid "(B<fstatfs>()) I<fd> is not a valid open file descriptor."
6914 #: build/C/man2/statfs.2:153
6915 msgid "I<buf> or I<path> points to an invalid address."
6919 #: build/C/man2/statfs.2:156 build/C/man3/statvfs.3:123
6920 msgid "This call was interrupted by a signal."
6924 #: build/C/man2/statfs.2:156 build/C/man3/statvfs.3:123
6930 #: build/C/man2/statfs.2:159 build/C/man3/statvfs.3:126
6931 msgid "An I/O error occurred while reading from the filesystem."
6935 #: build/C/man2/statfs.2:164
6937 "(B<statfs>()) Too many symbolic links were encountered in translating "
6942 #: build/C/man2/statfs.2:169
6943 msgid "(B<statfs>()) I<path> is too long."
6947 #: build/C/man2/statfs.2:175
6948 msgid "(B<statfs>()) The file referred to by I<path> does not exist."
6952 #: build/C/man2/statfs.2:178 build/C/man3/statvfs.3:145
6953 msgid "Insufficient kernel memory was available."
6957 #: build/C/man2/statfs.2:181 build/C/man3/statvfs.3:148
6958 msgid "The filesystem does not support this call."
6962 #: build/C/man2/statfs.2:187
6963 msgid "(B<statfs>()) A component of the path prefix of I<path> is not a directory."
6967 #: build/C/man2/statfs.2:190 build/C/man3/statvfs.3:157
6968 msgid "Some values were too large to be represented in the returned struct."
6972 #: build/C/man2/statfs.2:196
6974 "Linux-specific. The Linux B<statfs>() was inspired by the 4.4BSD one (but "
6975 "they do not use the same structure)."
6979 #: build/C/man2/statfs.2:218
6981 "The original Linux B<statfs>() and B<fstatfs>() system calls were not "
6982 "designed with extremely large file sizes in mind. Subsequently, Linux 2.6 "
6983 "added new B<statfs64>() and B<fstatfs64>() system calls that employ a new "
6984 "structure, I<statfs64>. The new structure contains the same fields as the "
6985 "original I<statfs> structure, but the sizes of various fields are increased, "
6986 "to accommodate large file sizes. The glibc B<statfs>() and B<fstatfs>() "
6987 "wrapper functions transparently deal with the kernel differences."
6991 #: build/C/man2/statfs.2:223
6993 "Some systems only have I<E<lt>sys/vfs.hE<gt>>, other systems also have "
6994 "I<E<lt>sys/statfs.hE<gt>>, where the former includes the latter. So it "
6995 "seems including the former is the best choice."
6999 #: build/C/man2/statfs.2:233
7001 "LSB has deprecated the library calls B<statfs>() and B<fstatfs>() and "
7002 "tells us to use B<statvfs>(2) and B<fstatvfs>(2) instead."
7006 #: build/C/man2/statfs.2:233
7008 msgid "The f_fsid field"
7012 #: build/C/man2/statfs.2:258
7014 "Solaris, Irix and POSIX have a system call B<statvfs>(2) that returns a "
7015 "I<struct statvfs> (defined in I<E<lt>sys/statvfs.hE<gt>>) containing an "
7016 "I<unsigned long> I<f_fsid>. Linux, SunOS, HP-UX, 4.4BSD have a system call "
7017 "B<statfs>() that returns a I<struct statfs> (defined in "
7018 "I<E<lt>sys/vfs.hE<gt>>) containing a I<fsid_t> I<f_fsid>, where I<fsid_t> "
7019 "is defined as I<struct { int val[2]; }>. The same holds for FreeBSD, except "
7020 "that it uses the include file I<E<lt>sys/mount.hE<gt>>."
7024 #: build/C/man2/statfs.2:271
7026 "The general idea is that I<f_fsid> contains some random stuff such that the "
7027 "pair (I<f_fsid>,I<ino>) uniquely determines a file. Some operating systems "
7028 "use (a variation on) the device number, or the device number combined with "
7029 "the filesystem type. Several OSes restrict giving out the I<f_fsid> field "
7030 "to the superuser only (and zero it for unprivileged users), because this "
7031 "field is used in the filehandle of the filesystem when NFS-exported, and "
7032 "giving it out is a security concern."
7036 #: build/C/man2/statfs.2:277
7038 "Under some operating systems the I<fsid> can be used as second argument to "
7039 "the B<sysfs>(2) system call."
7043 #: build/C/man2/statfs.2:281
7044 msgid "B<stat>(2), B<statvfs>(2), B<path_resolution>(7)"
7048 #: build/C/man3/statvfs.3:30
7054 #: build/C/man3/statvfs.3:30
7060 #: build/C/man3/statvfs.3:33
7061 msgid "statvfs, fstatvfs - get filesystem statistics"
7065 #: build/C/man3/statvfs.3:35
7066 msgid "B<#include E<lt>sys/statvfs.hE<gt>>"
7070 #: build/C/man3/statvfs.3:37
7071 msgid "B<int statvfs(const char *>I<path>B<, struct statvfs *>I<buf>B<);>"
7075 #: build/C/man3/statvfs.3:39
7076 msgid "B<int fstatvfs(int >I<fd>B<, struct statvfs *>I<buf>B<);>"
7080 #: build/C/man3/statvfs.3:49
7082 "The function B<statvfs>() returns information about a mounted filesystem. "
7083 "I<path> is the pathname of any file within the mounted filesystem. I<buf> "
7084 "is a pointer to a I<statvfs> structure defined approximately as follows:"
7088 #: build/C/man3/statvfs.3:65
7091 "struct statvfs {\n"
7092 " unsigned long f_bsize; /* filesystem block size */\n"
7093 " unsigned long f_frsize; /* fragment size */\n"
7094 " fsblkcnt_t f_blocks; /* size of fs in f_frsize units */\n"
7095 " fsblkcnt_t f_bfree; /* # free blocks */\n"
7096 " fsblkcnt_t f_bavail; /* # free blocks for unprivileged users */\n"
7097 " fsfilcnt_t f_files; /* # inodes */\n"
7098 " fsfilcnt_t f_ffree; /* # free inodes */\n"
7099 " fsfilcnt_t f_favail; /* # free inodes for unprivileged users */\n"
7100 " unsigned long f_fsid; /* filesystem ID */\n"
7101 " unsigned long f_flag; /* mount flags */\n"
7102 " unsigned long f_namemax; /* maximum filename length */\n"
7107 #: build/C/man3/statvfs.3:76
7109 "Here the types I<fsblkcnt_t> and I<fsfilcnt_t> are defined in "
7110 "I<E<lt>sys/types.hE<gt>>. Both used to be I<unsigned long>."
7114 #: build/C/man3/statvfs.3:82
7116 "The field I<f_flag> is a bit mask (of mount flags, see B<mount>(8)). Bits "
7117 "defined by POSIX are"
7121 #: build/C/man3/statvfs.3:82
7123 msgid "B<ST_RDONLY>"
7127 #: build/C/man3/statvfs.3:85
7128 msgid "Read-only filesystem."
7132 #: build/C/man3/statvfs.3:85
7134 msgid "B<ST_NOSUID>"
7138 #: build/C/man3/statvfs.3:89
7139 msgid "Set-user-ID/set-group-ID bits are ignored by B<exec>(3)."
7143 #: build/C/man3/statvfs.3:92
7145 "It is unspecified whether all members of the returned struct have meaningful "
7146 "values on all filesystems."
7150 #: build/C/man3/statvfs.3:96
7152 "B<fstatvfs>() returns the same information about an open file referenced by "
7157 #: build/C/man3/statvfs.3:109
7159 "(B<statvfs>()) Search permission is denied for a component of the path "
7160 "prefix of I<path>. (See also B<path_resolution>(7).)"
7164 #: build/C/man3/statvfs.3:114
7165 msgid "(B<fstatvfs>()) I<fd> is not a valid open file descriptor."
7169 #: build/C/man3/statvfs.3:120
7170 msgid "I<Buf> or I<path> points to an invalid address."
7174 #: build/C/man3/statvfs.3:131
7176 "(B<statvfs>()) Too many symbolic links were encountered in translating "
7181 #: build/C/man3/statvfs.3:136
7182 msgid "(B<statvfs>()) I<path> is too long."
7186 #: build/C/man3/statvfs.3:142
7187 msgid "(B<statvfs>()) The file referred to by I<path> does not exist."
7191 #: build/C/man3/statvfs.3:154
7193 "(B<statvfs>()) A component of the path prefix of I<path> is not a "
7198 #: build/C/man3/statvfs.3:157
7204 #: build/C/man3/statvfs.3:158
7206 msgid "Multithreading (see pthreads(7))"
7210 #: build/C/man3/statvfs.3:164
7211 msgid "The B<statvfs>() and B<fstatvfs>() functions are thread-safe."
7215 #: build/C/man3/statvfs.3:166
7216 msgid "POSIX.1-2001."
7220 #: build/C/man3/statvfs.3:172
7222 "The Linux kernel has system calls B<statfs>(2) and B<fstatfs>(2) to "
7223 "support this library call."
7227 #: build/C/man3/statvfs.3:174
7228 msgid "The current glibc implementations of"
7232 #: build/C/man3/statvfs.3:179
7235 " pathconf(path, _PC_REC_XFER_ALIGN);\n"
7236 " pathconf(path, _PC_ALLOC_SIZE_MIN);\n"
7237 " pathconf(path, _PC_REC_MIN_XFER_SIZE);\n"
7241 #: build/C/man3/statvfs.3:188
7243 "respectively use the I<f_frsize>, I<f_frsize>, and I<f_bsize> fields of the "
7244 "return value of I<statvfs(path,buf)>."
7248 #: build/C/man3/statvfs.3:190
7249 msgid "B<statfs>(2)"
7253 #: build/C/man2/sysfs.2:27
7259 #: build/C/man2/sysfs.2:27
7265 #: build/C/man2/sysfs.2:30
7266 msgid "sysfs - get filesystem type information"
7270 #: build/C/man2/sysfs.2:32
7271 msgid "B<int sysfs(int >I<option>B<, const char *>I<fsname>B<);>"
7275 #: build/C/man2/sysfs.2:34
7277 "B<int sysfs(int >I<option>B<, unsigned int >I<fs_index>B<, char "
7282 #: build/C/man2/sysfs.2:36
7283 msgid "B<int sysfs(int >I<option>B<);>"
7287 #: build/C/man2/sysfs.2:45
7289 "B<sysfs>() returns information about the filesystem types currently present "
7290 "in the kernel. The specific form of the B<sysfs>() call and the "
7291 "information returned depends on the I<option> in effect:"
7295 #: build/C/man2/sysfs.2:45
7301 #: build/C/man2/sysfs.2:50
7303 "Translate the filesystem identifier string I<fsname> into a filesystem type "
7308 #: build/C/man2/sysfs.2:50
7314 #: build/C/man2/sysfs.2:61
7316 "Translate the filesystem type index I<fs_index> into a null-terminated "
7317 "filesystem identifier string. This string will be written to the buffer "
7318 "pointed to by I<buf>. Make sure that I<buf> has enough space to accept the "
7323 #: build/C/man2/sysfs.2:61
7329 #: build/C/man2/sysfs.2:65
7330 msgid "Return the total number of filesystem types currently present in the kernel."
7334 #: build/C/man2/sysfs.2:67
7335 msgid "The numbering of the filesystem type indexes begins with zero."
7339 #: build/C/man2/sysfs.2:79
7341 "On success, B<sysfs>() returns the filesystem index for option B<1>, zero "
7342 "for option B<2>, and the number of currently configured filesystems for "
7343 "option B<3>. On error, -1 is returned, and I<errno> is set appropriately."
7347 #: build/C/man2/sysfs.2:84
7348 msgid "Either I<fsname> or I<buf> is outside your accessible address space."
7352 #: build/C/man2/sysfs.2:92
7354 "I<fsname> is not a valid filesystem type identifier; I<fs_index> is "
7355 "out-of-bounds; I<option> is invalid."
7358 #. SVr4 documents additional error conditions ENOLINK, ECOMM, and EINTR
7359 #. but has no ENOSYS condition.
7361 #: build/C/man2/sysfs.2:94 build/C/man2/ustat.2:98
7366 #: build/C/man2/sysfs.2:101
7368 "This System-V derived system call is obsolete; don't use it. On systems "
7369 "with I</proc>, the same information can be obtained via "
7370 "I</proc/filesystems>; use that interface instead."
7374 #: build/C/man2/sysfs.2:104
7376 "There is no libc or glibc support. There is no way to guess how large "
7381 #: build/C/man2/umount.2:30
7387 #: build/C/man2/umount.2:30
7393 #: build/C/man2/umount.2:33
7394 msgid "umount, umount2 - unmount filesystem"
7398 #: build/C/man2/umount.2:38
7400 msgid "B<int umount(const char *>I<target>B<);>\n"
7404 #: build/C/man2/umount.2:40
7406 msgid "B<int umount2(const char *>I<target>B<, int >I<flags>B<);>\n"
7409 #. Note: the kernel naming differs from the glibc naming
7410 #. umount2 is the glibc name for what the kernel now calls umount
7411 #. and umount is the glibc name for oldumount
7413 #: build/C/man2/umount.2:50
7415 "B<umount>() and B<umount2>() remove the attachment of the (topmost) "
7416 "filesystem mounted on I<target>."
7420 #: build/C/man2/umount.2:54
7422 "Appropriate privilege (Linux: the B<CAP_SYS_ADMIN> capability) is required "
7423 "to unmount filesystems."
7427 #: build/C/man2/umount.2:62
7429 "Linux 2.1.116 added the B<umount2>() system call, which, like B<umount>(), "
7430 "unmounts a target, but allows additional I<flags> controlling the behavior "
7435 #: build/C/man2/umount.2:62
7437 msgid "B<MNT_FORCE> (since Linux 2.1.116)"
7441 #: build/C/man2/umount.2:67
7443 "Force unmount even if busy. This can cause data loss. (Only for NFS "
7448 #: build/C/man2/umount.2:67
7450 msgid "B<MNT_DETACH> (since Linux 2.4.11)"
7454 #: build/C/man2/umount.2:72
7456 "Perform a lazy unmount: make the mount point unavailable for new accesses, "
7457 "and actually perform the unmount when the mount point ceases to be busy."
7461 #: build/C/man2/umount.2:72
7463 msgid "B<MNT_EXPIRE> (since Linux 2.6.8)"
7467 #: build/C/man2/umount.2:91
7469 "Mark the mount point as expired. If a mount point is not currently in use, "
7470 "then an initial call to B<umount2>() with this flag fails with the error "
7471 "B<EAGAIN>, but marks the mount point as expired. The mount point remains "
7472 "expired as long as it isn't accessed by any process. A second B<umount2>() "
7473 "call specifying B<MNT_EXPIRE> unmounts an expired mount point. This flag "
7474 "cannot be specified with either B<MNT_FORCE> or B<MNT_DETACH>."
7478 #: build/C/man2/umount.2:91
7480 msgid "B<UMOUNT_NOFOLLOW> (since Linux 2.6.34)"
7483 #. Later added to 2.6.33-stable
7485 #: build/C/man2/umount.2:99
7487 "Don't dereference I<target> if it is a symbolic link. This flag allows "
7488 "security problems to be avoided in set-user-ID-I<root> programs that allow "
7489 "unprivileged users to unmount filesystems."
7493 #: build/C/man2/umount.2:110
7499 #: build/C/man2/umount.2:117
7501 "A call to B<umount2>() specifying B<MNT_EXPIRE> successfully marked an "
7502 "unbusy filesystem as expired."
7506 #: build/C/man2/umount.2:121
7507 msgid "I<target> could not be unmounted because it is busy."
7511 #: build/C/man2/umount.2:125
7512 msgid "I<target> points outside the user address space."
7516 #: build/C/man2/umount.2:129
7517 msgid "I<target> is not a mount point."
7521 #: build/C/man2/umount.2:138
7523 "B<umount2>() was called with B<MNT_EXPIRE> and either B<MNT_DETACH> or "
7528 #: build/C/man2/umount.2:138
7530 msgid "B<EINVAL> (since Linux 2.6.34)"
7534 #: build/C/man2/umount.2:143
7535 msgid "B<umount2>() was called with an invalid flag value in I<flags>."
7538 #. http://sourceware.org/bugzilla/show_bug.cgi?id=10092
7540 #: build/C/man2/umount.2:162
7541 msgid "B<MNT_DETACH> and B<MNT_EXPIRE> are available in glibc since version 2.11."
7545 #: build/C/man2/umount.2:165
7547 "These functions are Linux-specific and should not be used in programs "
7548 "intended to be portable."
7552 #: build/C/man2/umount.2:176
7554 "The original B<umount>() function was called as I<umount(device)> and would "
7555 "return B<ENOTBLK> when called with something other than a block device. In "
7556 "Linux 0.98p4 a call I<umount(dir)> was added, in order to support anonymous "
7557 "devices. In Linux 2.3.99-pre7 the call I<umount(device)> was removed, "
7558 "leaving only I<umount(dir)> (since now devices can be mounted in more than "
7559 "one place, so specifying the device does not suffice)."
7563 #: build/C/man2/umount.2:181
7564 msgid "B<mount>(2), B<path_resolution>(7), B<mount>(8), B<umount>(8)"
7568 #: build/C/man2/ustat.2:30
7574 #: build/C/man2/ustat.2:30
7580 #: build/C/man2/ustat.2:33
7581 msgid "ustat - get filesystem statistics"
7585 #: build/C/man2/ustat.2:38
7587 msgid "B<#include E<lt>unistd.hE<gt>> /* libc[45] */\n"
7591 #: build/C/man2/ustat.2:40
7593 msgid "B<#include E<lt>ustat.hE<gt>> /* glibc2 */\n"
7597 #: build/C/man2/ustat.2:42
7599 msgid "B<int ustat(dev_t >I<dev>B<, struct ustat *>I<ubuf>B<);>\n"
7603 #: build/C/man2/ustat.2:54
7605 "B<ustat>() returns information about a mounted filesystem. I<dev> is a "
7606 "device number identifying a device containing a mounted filesystem. I<ubuf> "
7607 "is a pointer to a I<ustat> structure that contains the following members:"
7611 #: build/C/man2/ustat.2:61
7614 "daddr_t f_tfree; /* Total free blocks */\n"
7615 "ino_t f_tinode; /* Number of free inodes */\n"
7616 "char f_fname[6]; /* Filsys name */\n"
7617 "char f_fpack[6]; /* Filsys pack name */\n"
7621 #: build/C/man2/ustat.2:70
7623 "The last two fields, I<f_fname> and I<f_fpack>, are not implemented and will "
7624 "always be filled with null bytes (\\(aq\\e0\\(aq)."
7628 #: build/C/man2/ustat.2:79
7630 "On success, zero is returned and the I<ustat> structure pointed to by "
7631 "I<ubuf> will be filled in. On error, -1 is returned, and I<errno> is set "
7636 #: build/C/man2/ustat.2:84
7637 msgid "I<ubuf> points outside of your accessible address space."
7641 #: build/C/man2/ustat.2:88
7642 msgid "I<dev> does not refer to a device containing a mounted filesystem."
7646 #: build/C/man2/ustat.2:94
7648 "The mounted filesystem referenced by I<dev> does not support this operation, "
7649 "or any version of Linux before 1.3.16."
7653 #: build/C/man2/ustat.2:104
7655 "B<ustat>() is deprecated and has been provided only for compatibility. All "
7656 "new programs should use B<statfs>(2) instead."
7660 #: build/C/man2/ustat.2:104
7665 #. Some software tries to use this in order to test whether the
7666 #. underlying filesystem is NFS.
7668 #: build/C/man2/ustat.2:118
7670 "The HP-UX version of the I<ustat> structure has an additional field, "
7671 "I<f_blksize>, that is unknown elsewhere. HP-UX warns: For some filesystems, "
7672 "the number of free inodes does not change. Such filesystems will return -1 "
7673 "in the field I<f_tinode>. For some filesystems, inodes are dynamically "
7674 "allocated. Such filesystems will return the current number of free inodes."
7678 #: build/C/man2/ustat.2:121
7679 msgid "B<stat>(2), B<statfs>(2)"