summaryrefslogtreecommitdiff
path: root/manual/filesys.texi
diff options
context:
space:
mode:
authorRical Jasan <ricaljasan@pacific.net>2016-12-21 01:36:58 -0800
committerRical Jasan <ricaljasan@pacific.net>2016-12-21 01:36:58 -0800
commit2fe82ca6dc5a2d2ffc91b7df9d136de7bf10bd9a (patch)
tree9bc8f8d16e9de019dc03e46ab994f9f94005b5ca /manual/filesys.texi
parent41c67149b94676347b0068a902058f130e3e88e6 (diff)
manual: Convert @tables of variables to @vtables.
Texinfo @vindex commands add entries to the Variable and Constant Macro Index. Similarly, @items in @vtables are automatically indexed. A number of @tables exist where all @items are @vindexed or all @items are variables, but not indexed, suggesting an optimization by converting such @tables to @vtables and dropping the @vindex. Using a @vtable provides a context for processing @items whereby it can be known the @items should have header and standards annotations. This commit converts @tables of such @items to @vtables in order to establish a framework for automated processing. A pleasant consequence of these changes is that @items previously lacking a @vindex are present in the Variable and Constant Macro Index now. @vindex entries previously detected by summary.awk will still be detected as @items with appropriate annotations. The @vtable of the NSS databases is converted to a @table because 1) those @items are not variables (and will no longer appear in the Variable and Constant Macro Index) and 2) they do not need header and standards annotations, so the incorrect context is fixed. * manual/nss.texi: Change incorrect @vtable to @table. * manual/arith.texi: Convert @tables of variables to @vtables and remove unnecessary indexing. * manual/filesys.texi: Likewise. * manual/llio.texi: Likewise. * manual/memory.texi: Likewise. * manual/process.texi: Likewise. * manual/resource.texi: Likewise. * manual/search.texi: Likewise. * manual/signal.texi: Likewise. * manual/socket.texi: Likewise. * manual/stdio.texi: Likewise. * manual/sysinfo.texi: Likewise. * manual/syslog.texi: Likewise. * manual/terminal.texi: Likewise. * manual/time.texi: Likewise. * manual/users.texi: Likewise.
Diffstat (limited to 'manual/filesys.texi')
-rw-r--r--manual/filesys.texi39
1 files changed, 6 insertions, 33 deletions
diff --git a/manual/filesys.texi b/manual/filesys.texi
index 26758e626e..edc7c64d22 100644
--- a/manual/filesys.texi
+++ b/manual/filesys.texi
@@ -928,12 +928,10 @@ parameter to the function is a pointer to a variable of type
int (*) (const char *, const struct stat *, int, struct FTW *)
@end smallexample
-@vindex FTW_DP
-@vindex FTW_SLN
The first three arguments are the same as for the @code{__ftw_func_t}
type. However for the third argument some additional values are defined
to allow finer differentiation:
-@table @code
+@vtable @code
@item FTW_DP
The current item is a directory and all subdirectories have already been
visited and reported. This flag is returned instead of @code{FTW_D} if
@@ -941,7 +939,7 @@ the @code{FTW_DEPTH} flag is passed to @code{nftw} (see below).
@item FTW_SLN
The current item is a stale symbolic link. The file it points to does
not exist.
-@end table
+@end vtable
The last parameter of the callback function is a pointer to a structure
with some extra information as described below.
@@ -2209,49 +2207,42 @@ This is a bit mask used to extract the file type code from a mode value.
These are the symbolic names for the different file type codes:
-@table @code
+@vtable @code
@comment sys/stat.h
@comment BSD
@item S_IFDIR
-@vindex S_IFDIR
This is the file type constant of a directory file.
@comment sys/stat.h
@comment BSD
@item S_IFCHR
-@vindex S_IFCHR
This is the file type constant of a character-oriented device file.
@comment sys/stat.h
@comment BSD
@item S_IFBLK
-@vindex S_IFBLK
This is the file type constant of a block-oriented device file.
@comment sys/stat.h
@comment BSD
@item S_IFREG
-@vindex S_IFREG
This is the file type constant of a regular file.
@comment sys/stat.h
@comment BSD
@item S_IFLNK
-@vindex S_IFLNK
This is the file type constant of a symbolic link.
@comment sys/stat.h
@comment BSD
@item S_IFSOCK
-@vindex S_IFSOCK
This is the file type constant of a socket.
@comment sys/stat.h
@comment BSD
@item S_IFIFO
-@vindex S_IFIFO
This is the file type constant of a FIFO or pipe.
-@end table
+@end vtable
The POSIX.1b standard introduced a few more objects which possibly can
be implemented as objects in the filesystem. These are message queues,
@@ -2404,15 +2395,13 @@ All of the symbols listed in this section are defined in the header file
These symbolic constants are defined for the file mode bits that control
access permission for the file:
-@table @code
+@vtable @code
@comment sys/stat.h
@comment POSIX.1
@item S_IRUSR
-@vindex S_IRUSR
@comment sys/stat.h
@comment BSD
@itemx S_IREAD
-@vindex S_IREAD
Read permission bit for the owner of the file. On many systems this bit
is 0400. @code{S_IREAD} is an obsolete synonym provided for BSD
compatibility.
@@ -2420,22 +2409,18 @@ compatibility.
@comment sys/stat.h
@comment POSIX.1
@item S_IWUSR
-@vindex S_IWUSR
@comment sys/stat.h
@comment BSD
@itemx S_IWRITE
-@vindex S_IWRITE
Write permission bit for the owner of the file. Usually 0200.
@w{@code{S_IWRITE}} is an obsolete synonym provided for BSD compatibility.
@comment sys/stat.h
@comment POSIX.1
@item S_IXUSR
-@vindex S_IXUSR
@comment sys/stat.h
@comment BSD
@itemx S_IEXEC
-@vindex S_IEXEC
Execute (for ordinary files) or search (for directories) permission bit
for the owner of the file. Usually 0100. @code{S_IEXEC} is an obsolete
synonym provided for BSD compatibility.
@@ -2443,69 +2428,58 @@ synonym provided for BSD compatibility.
@comment sys/stat.h
@comment POSIX.1
@item S_IRWXU
-@vindex S_IRWXU
This is equivalent to @samp{(S_IRUSR | S_IWUSR | S_IXUSR)}.
@comment sys/stat.h
@comment POSIX.1
@item S_IRGRP
-@vindex S_IRGRP
Read permission bit for the group owner of the file. Usually 040.
@comment sys/stat.h
@comment POSIX.1
@item S_IWGRP
-@vindex S_IWGRP
Write permission bit for the group owner of the file. Usually 020.
@comment sys/stat.h
@comment POSIX.1
@item S_IXGRP
-@vindex S_IXGRP
Execute or search permission bit for the group owner of the file.
Usually 010.
@comment sys/stat.h
@comment POSIX.1
@item S_IRWXG
-@vindex S_IRWXG
This is equivalent to @samp{(S_IRGRP | S_IWGRP | S_IXGRP)}.
@comment sys/stat.h
@comment POSIX.1
@item S_IROTH
-@vindex S_IROTH
Read permission bit for other users. Usually 04.
@comment sys/stat.h
@comment POSIX.1
@item S_IWOTH
-@vindex S_IWOTH
Write permission bit for other users. Usually 02.
@comment sys/stat.h
@comment POSIX.1
@item S_IXOTH
-@vindex S_IXOTH
Execute or search permission bit for other users. Usually 01.
@comment sys/stat.h
@comment POSIX.1
@item S_IRWXO
-@vindex S_IRWXO
This is equivalent to @samp{(S_IROTH | S_IWOTH | S_IXOTH)}.
@comment sys/stat.h
@comment POSIX
@item S_ISUID
-@vindex S_ISUID
This is the set-user-ID on execute bit, usually 04000.
@xref{How Change Persona}.
@comment sys/stat.h
@comment POSIX
@item S_ISGID
-@vindex S_ISGID
This is the set-group-ID on execute bit, usually 02000.
@xref{How Change Persona}.
@@ -2513,7 +2487,6 @@ This is the set-group-ID on execute bit, usually 02000.
@comment sys/stat.h
@comment BSD
@item S_ISVTX
-@vindex S_ISVTX
This is the @dfn{sticky} bit, usually 01000.
For a directory it gives permission to delete a file in that directory
@@ -2558,7 +2531,7 @@ This bit is only available on BSD systems (and those derived from
them). Therefore one has to use the @code{_GNU_SOURCE} feature select
macro, or not define any feature test macros, to get the definition
(@pxref{Feature Test Macros}).
-@end table
+@end vtable
The actual bit values of the symbols are listed in the table above
so you can decode file mode values when debugging your programs.