This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
[PATCH v2 3/5] manual: Add new header and standards annotations.
- From: Rical Jasan <ricaljasan at pacific dot net>
- To: libc-alpha at sourceware dot org
- Cc: joseph at codesourcery dot com, mtk dot manpages at gmail dot com, carlos at redhat dot com
- Date: Tue, 6 Dec 2016 02:55:23 -0800
- Subject: [PATCH v2 3/5] manual: Add new header and standards annotations.
- Authentication-results: sourceware.org; auth=none
- References: <20161206105525.21117-1-ricaljasan@pacific.net>
This commit completes header and standard annotations for all
@def*-commands and @vtable @items.
The header annotations are believed to all be correct, as the
various definitions/declarations had to found in a header.
The standards annotations are a best-effort. They are roughly
derived from the following strategy:
1) Use a standard derived from any feature test macros
2) Obvious context, including:
a) top of file says, e.g., "ISO C99 ..."
b) manual annotates other nearby, related entries
c) manual describes section as per a given standard
The "???" placeholder is used for anything not obvious from a
cursory survey of the glibc sources.
The choice of standards nomenclature uses a loose convention
of standard names, though the syntax is essentially free-form.
It prefers names that indicate specific standards and the
oldest relevant standard, where known (e.g., "C90" over "ISO"
or "POSIX.1-2001" over "POSIX").
* manual/argp.texi: Complete header and standards annotations.
* manual/arith.texi: Likewise.
* manual/creature.texi: Likewise.
* manual/filesys.texi: Likewise.
* manual/ipc.texi: Likewise.
* manual/lang.texi: Likewise.
* manual/llio.texi: Likewise.
* manual/locale.texi: Likewise.
* manual/math.texi: Likewise.
* manual/memory.texi: Likewise.
* manual/message.texi: Likewise.
* manual/nss.texi: Likewise.
* manual/pattern.texi: Likewise.
* manual/platform.texi: Likewise.
* manual/process.texi: Likewise.
* manual/resource.texi: Likewise.
* manual/search.texi: Likewise.
* manual/signal.texi: Likewise.
* manual/socket.texi: Likewise.
* manual/startup.texi: Likewise.
* manual/stdio.texi: Likewise.
* manual/string.texi: Likewise.
* manual/sysinfo.texi: Likewise.
* manual/syslog.texi: Likewise.
* manual/terminal.texi: Likewise.
* manual/time.texi: Likewise.
* manual/users.texi: Likewise.
---
manual/argp.texi | 28 +++++++++
manual/arith.texi | 28 +++++++++
manual/creature.texi | 2 +
manual/filesys.texi | 44 ++++++++++++++
manual/ipc.texi | 28 +++++++++
manual/lang.texi | 20 +++++++
manual/llio.texi | 82 +++++++++++++++++++++++++
manual/locale.texi | 166 +++++++++++++++++++++++++++++++++++++++++++++++++++
manual/math.texi | 26 ++++++++
manual/memory.texi | 25 ++++++++
manual/message.texi | 4 ++
manual/nss.texi | 8 +++
manual/pattern.texi | 36 +++++++++++
manual/platform.texi | 20 +++++++
manual/process.texi | 8 +++
manual/resource.texi | 27 +++++++++
manual/search.texi | 12 ++++
manual/signal.texi | 12 ++++
manual/socket.texi | 3 +
manual/startup.texi | 2 +
manual/stdio.texi | 52 ++++++++++++++++
manual/string.texi | 2 +
manual/sysinfo.texi | 50 ++++++++++++++++
manual/syslog.texi | 64 ++++++++++++++++++++
manual/terminal.texi | 14 +++++
manual/time.texi | 6 ++
manual/users.texi | 8 +++
27 files changed, 777 insertions(+)
diff --git a/manual/argp.texi b/manual/argp.texi
index bca3ca5..f1767cc 100644
--- a/manual/argp.texi
+++ b/manual/argp.texi
@@ -1133,35 +1133,53 @@ is determined by the @var{flags} argument. This should consist of any of
the following flags, or'd together:
@vtable @code
+@comment argp.h
+@comment GNU
@item ARGP_HELP_USAGE
A unix @samp{Usage:} message that explicitly lists all options.
+@comment argp.h
+@comment GNU
@item ARGP_HELP_SHORT_USAGE
A unix @samp{Usage:} message that displays an appropriate placeholder to
indicate where the options go; useful for showing the non-option
argument syntax.
+@comment argp.h
+@comment GNU
@item ARGP_HELP_SEE
A @samp{Try @dots{} for more help} message; @samp{@dots{}} contains the
program name and @samp{--help}.
+@comment argp.h
+@comment GNU
@item ARGP_HELP_LONG
A verbose option help message that gives each option available along
with its documentation string.
+@comment argp.h
+@comment GNU
@item ARGP_HELP_PRE_DOC
The part of the argp parser doc string preceding the verbose option help.
+@comment argp.h
+@comment GNU
@item ARGP_HELP_POST_DOC
The part of the argp parser doc string that following the verbose option help.
+@comment argp.h
+@comment GNU
@item ARGP_HELP_DOC
@code{(ARGP_HELP_PRE_DOC | ARGP_HELP_POST_DOC)}
+@comment argp.h
+@comment GNU
@item ARGP_HELP_BUG_ADDR
A message that prints where to report bugs for this program, if the
@code{argp_program_bug_address} variable contains this information.
+@comment argp.h
+@comment GNU
@item ARGP_HELP_LONG_ONLY
This will modify any output to reflect the @code{ARGP_LONG_ONLY} mode.
@end vtable
@@ -1171,9 +1189,13 @@ The following flags are only understood when used with
printing its output, or terminates the program:
@vtable @code
+@comment argp.h
+@comment GNU
@item ARGP_HELP_EXIT_ERR
This will terminate the program with @code{exit (argp_err_exit_status)}.
+@comment argp.h
+@comment GNU
@item ARGP_HELP_EXIT_OK
This will terminate the program with @code{exit (0)}.
@end vtable
@@ -1182,16 +1204,22 @@ The following flags are combinations of the basic flags for printing
standard messages:
@vtable @code
+@comment argp.h
+@comment GNU
@item ARGP_HELP_STD_ERR
Assuming that an error message for a parsing error has printed, this
prints a message on how to get help, and terminates the program with an
error.
+@comment argp.h
+@comment GNU
@item ARGP_HELP_STD_USAGE
This prints a standard usage message and terminates the program with an
error. This is used when no other specific error messages are
appropriate or available.
+@comment argp.h
+@comment GNU
@item ARGP_HELP_STD_HELP
This prints the standard response for a @samp{--help} option, and
terminates the program successfully.
diff --git a/manual/arith.texi b/manual/arith.texi
index 0c182c5..eee9880 100644
--- a/manual/arith.texi
+++ b/manual/arith.texi
@@ -331,22 +331,32 @@ This is a generic macro which works on all floating-point types and
which returns a value of type @code{int}. The possible values are:
@vtable @code
+@comment math.h
+@comment C99
@item FP_NAN
The floating-point number @var{x} is ``Not a Number'' (@pxref{Infinity
and NaN})
+@comment math.h
+@comment C99
@item FP_INFINITE
The value of @var{x} is either plus or minus infinity (@pxref{Infinity
and NaN})
+@comment math.h
+@comment C99
@item FP_ZERO
The value of @var{x} is zero. In floating-point formats like @w{IEEE
754}, where zero can be signed, this value is also returned if
@var{x} is negative zero.
+@comment math.h
+@comment C99
@item FP_SUBNORMAL
Numbers whose absolute value is too small to be represented in the
normal format are represented in an alternate, @dfn{denormalized} format
(@pxref{Floating Point Concepts}). This format is less precise but can
represent values closer to zero. @code{fpclassify} returns this value
for values of @var{x} in this alternate format.
+@comment math.h
+@comment C99
@item FP_NORMAL
This value is returned for all other values of @var{x}. It indicates
that there is nothing special about the number.
@@ -714,7 +724,11 @@ such as by defining @code{_GNU_SOURCE}, and then you must include
@comment math.h
@comment ISO
@deftypevr Macro float SNANF
+@comment math.h
+@comment TS 18661-1:2014
@deftypevrx Macro double SNAN
+@comment math.h
+@comment TS 18661-1:2014
@deftypevrx Macro {long double} SNANL
These macros, defined by TS 18661-1:2014, are constant expressions for
signaling NaNs.
@@ -2041,8 +2055,10 @@ NaN.
@comment math.h
@comment ISO
@deftypefun int totalorder (double @var{x}, double @var{y})
+@comment math.h
@comment ISO
@deftypefunx int totalorderf (float @var{x}, float @var{y})
+@comment math.h
@comment ISO
@deftypefunx int totalorderl (long double @var{x}, long double @var{y})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@@ -2063,8 +2079,10 @@ payload.
@comment math.h
@comment ISO
@deftypefun int totalordermag (double @var{x}, double @var{y})
+@comment math.h
@comment ISO
@deftypefunx int totalordermagf (float @var{x}, float @var{y})
+@comment math.h
@comment ISO
@deftypefunx int totalordermagl (long double @var{x}, long double @var{y})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@@ -2197,6 +2215,8 @@ part of a number. There is no standard notation for an imaginary
floating point constant. Instead, @file{complex.h} defines two macros
that can be used to create complex numbers.
+@comment complex.h
+@comment C99
@deftypevr Macro {const float complex} _Complex_I
This macro is a representation of the complex number ``@math{0+1i}''.
Multiplying a real floating-point value by @code{_Complex_I} gives a
@@ -2219,6 +2239,8 @@ Without an optimizing compiler this is more expensive than the use of
the hassles if you use the @code{I} macro below if the name is not
problem.
+@comment complex.h
+@comment C99
@deftypevr Macro {const float imaginary} _Imaginary_I
This macro is a representation of the value ``@math{1i}''. I.e., it is
the value for which
@@ -2245,6 +2267,8 @@ imaginary part -4.0.
@code{_Complex_I} is a bit of a mouthful. @file{complex.h} also defines
a shorter name for the same constant.
+@comment complex.h
+@comment C99
@deftypevr Macro {const float complex} I
This macro has exactly the same value as @code{_Complex_I}. Most of the
time it is preferable. However, it causes problems if you want to use
@@ -2887,7 +2911,11 @@ The @samp{strfrom} functions are declared in @file{stdlib.h}.
@comment stdlib.h
@comment ISO/IEC TS 18661-1
@deftypefun int strfromd (char *restrict @var{string}, size_t @var{size}, const char *restrict @var{format}, double @var{value})
+@comment stdlib.h
+@comment TS 18661-1:2014
@deftypefunx int strfromf (char *restrict @var{string}, size_t @var{size}, const char *restrict @var{format}, float @var{value})
+@comment stdlib.h
+@comment TS 18661-1:2014
@deftypefunx int strfroml (char *restrict @var{string}, size_t @var{size}, const char *restrict @var{format}, long double @var{value})
@safety{@prelim{}@mtsafe{@mtslocale{}}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
@comment these functions depend on __printf_fp and __printf_fphex, which are
diff --git a/manual/creature.texi b/manual/creature.texi
index 257f871..babec55 100644
--- a/manual/creature.texi
+++ b/manual/creature.texi
@@ -218,6 +218,8 @@ cause them to be disabled.
@comment (none)
@comment GNU
@defvr Macro _REENTRANT
+@comment (none)
+@comment ???
@defvrx Macro _THREAD_SAFE
If you define one of these macros, reentrant versions of several functions get
declared. Some of the functions are specified in POSIX.1c but many others
diff --git a/manual/filesys.texi b/manual/filesys.texi
index 3880bc9..8ddb8b7 100644
--- a/manual/filesys.texi
+++ b/manual/filesys.texi
@@ -285,28 +285,44 @@ This is the type of the file, possibly unknown. The following constants
are defined for its value:
@vtable @code
+@comment dirent.h
+@comment MISC
@item DT_UNKNOWN
The type is unknown. Only some filesystems have full support to
return the type of the file, others might always return this value.
+@comment dirent.h
+@comment MISC
@item DT_REG
A regular file.
+@comment dirent.h
+@comment MISC
@item DT_DIR
A directory.
+@comment dirent.h
+@comment MISC
@item DT_FIFO
A named pipe, or FIFO. @xref{FIFO Special Files}.
+@comment dirent.h
+@comment MISC
@item DT_SOCK
A local-domain socket. @c !!! @xref{Local Domain}.
+@comment dirent.h
+@comment MISC
@item DT_CHR
A character device.
+@comment dirent.h
+@comment MISC
@item DT_BLK
A block device.
+@comment dirent.h
+@comment MISC
@item DT_LNK
A symbolic link.
@end vtable
@@ -878,16 +894,26 @@ The last parameter is a flag giving more information about the current
file. It can have the following values:
@vtable @code
+@comment ftw.h
+@comment XOPEN
@item FTW_F
The item is either a normal file or a file which does not fit into one
of the following categories. This could be special files, sockets etc.
+@comment ftw.h
+@comment XOPEN
@item FTW_D
The item is a directory.
+@comment ftw.h
+@comment XOPEN
@item FTW_NS
The @code{stat} call failed and so the information pointed to by the
second parameter is invalid.
+@comment ftw.h
+@comment XOPEN
@item FTW_DNR
The item is a directory which cannot be read.
+@comment ftw.h
+@comment MISC || XPG4
@item FTW_SL
The item is a symbolic link. Since symbolic links are normally followed
seeing this value in a @code{ftw} callback function means the referenced
@@ -932,10 +958,14 @@ 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:
@vtable @code
+@comment ftw.h
+@comment XPG4
@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
the @code{FTW_DEPTH} flag is passed to @code{nftw} (see below).
+@comment ftw.h
+@comment XPG4
@item FTW_SLN
The current item is a stale symbolic link. The file it points to does
not exist.
@@ -1083,25 +1113,35 @@ A second difference is that @code{nftw} takes a fourth argument, which
is @math{0} or a bitwise-OR combination of any of the following values.
@vtable @code
+@comment ftw.h
+@comment XPG4
@item FTW_PHYS
While traversing the directory symbolic links are not followed. Instead
symbolic links are reported using the @code{FTW_SL} value for the type
parameter to the callback function. If the file referenced by a
symbolic link does not exist @code{FTW_SLN} is returned instead.
+@comment ftw.h
+@comment XPG4
@item FTW_MOUNT
The callback function is only called for items which are on the same
mounted filesystem as the directory given by the @var{filename}
parameter to @code{nftw}.
+@comment ftw.h
+@comment XPG4
@item FTW_CHDIR
If this flag is given the current working directory is changed to the
directory of the reported object before the callback function is called.
When @code{ntfw} finally returns the current directory is restored to
its original value.
+@comment ftw.h
+@comment XPG4
@item FTW_DEPTH
If this option is specified then all subdirectories and files within
them are processed before processing the top directory itself
(depth-first processing). This also means the type flag given to the
callback function is @code{FTW_DP} and not @code{FTW_D}.
+@comment ftw.h
+@comment XPG4 && GNU
@item FTW_ACTIONRETVAL
If this option is specified then return values from callbacks
are handled differently. If the callback returns @code{FTW_CONTINUE},
@@ -3239,6 +3279,8 @@ occurring later. Checking for write errors is still required, and
writes to memory-mapped regions created with @code{mmap} can still
result in @code{SIGBUS}.
+@comment fcntl.h
+@comment POSIX.1-2001
@deftypefun int posix_fallocate (int @var{fd}, off_t @var{offset}, off_t @var{length})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c If the file system does not support allocation,
@@ -3297,6 +3339,8 @@ allocation. Instead, an @code{EOPNOTSUPP} is returned to the caller.
@end deftypefun
+@comment fcntl.h
+@comment POSIX.1-2001 && LFS
@deftypefun int posix_fallocate64 (int @var{fd}, off64_t @var{offset}, off64_t @var{length})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
diff --git a/manual/ipc.texi b/manual/ipc.texi
index 081b98f..b7f867b 100644
--- a/manual/ipc.texi
+++ b/manual/ipc.texi
@@ -20,6 +20,8 @@ by @theglibc{}.
@c Need descriptions for all of these functions.
@subsection System V Semaphores
+@comment sys/sem.h
+@comment SVID
@deftypefun int semctl (int @var{semid}, int @var{semnum}, int @var{cmd});
@safety{@prelim{}@mtsafe{}@assafe{}@acunsafe{@acucorrupt{/linux}}}
@c syscall(ipc) ok
@@ -30,16 +32,22 @@ by @theglibc{}.
@c semid_ds.
@end deftypefun
+@comment sys/sem.h
+@comment SVID
@deftypefun int semget (key_t @var{key}, int @var{nsems}, int @var{semflg});
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c syscall(ipc) ok
@end deftypefun
+@comment sys/sem.h
+@comment SVID
@deftypefun int semop (int @var{semid}, struct sembuf *@var{sops}, size_t @var{nsops});
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c syscall(ipc) ok
@end deftypefun
+@comment sys/sem.h
+@comment GNU
@deftypefun int semtimedop (int @var{semid}, struct sembuf *@var{sops}, size_t @var{nsops}, const struct timespec *@var{timeout});
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c syscall(ipc) ok
@@ -47,17 +55,23 @@ by @theglibc{}.
@subsection POSIX Semaphores
+@comment semaphore.h
+@comment POSIX
@deftypefun int sem_init (sem_t *@var{sem}, int @var{pshared}, unsigned int @var{value});
@safety{@prelim{}@mtsafe{}@assafe{}@acunsafe{@acucorrupt{}}}
@c Does not atomically update sem_t therefore AC-unsafe
@c because it can leave sem_t partially initialized.
@end deftypefun
+@comment semaphore.h
+@comment POSIX
@deftypefun int sem_destroy (sem_t *@var{sem});
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c Function does nothing and is therefore always safe.
@end deftypefun
+@comment semaphore.h
+@comment POSIX
@deftypefun sem_t *sem_open (const char *@var{name}, int @var{oflag}, ...);
@safety{@prelim{}@mtsafe{}@asunsafe{@asuinit{}}@acunsafe{@acuinit{}}}
@c pthread_once asuinit
@@ -67,6 +81,8 @@ by @theglibc{}.
@c shmfs on Linux.
@end deftypefun
+@comment semaphore.h
+@comment POSIX
@deftypefun int sem_close (sem_t *@var{sem});
@safety{@prelim{}@mtsafe{}@asunsafe{@asulock{}}@acunsafe{@aculock{}}}
@c lll_lock asulock aculock
@@ -77,12 +93,16 @@ by @theglibc{}.
@c are not updated atomically.
@end deftypefun
+@comment semaphore.h
+@comment POSIX
@deftypefun int sem_unlink (const char *@var{name});
@safety{@prelim{}@mtsafe{}@asunsafe{@asuinit{}}@acunsafe{@acucorrupt{}}}
@c pthread_once asuinit acucorrupt aculock
@c mempcpy acucorrupt
@end deftypefun
+@comment semaphore.h
+@comment POSIX
@deftypefun int sem_wait (sem_t *@var{sem});
@safety{@prelim{}@mtsafe{}@assafe{}@acunsafe{@acucorrupt{}}}
@c atomic_increment (nwaiters) acucorrupt
@@ -95,21 +115,29 @@ by @theglibc{}.
@c waiters count.
@end deftypefun
+@comment semaphore.h
+@comment POSIX.1-2001
@deftypefun int sem_timedwait (sem_t *@var{sem}, const struct timespec *@var{abstime});
@safety{@prelim{}@mtsafe{}@assafe{}@acunsafe{@acucorrupt{}}}
@c Same safety issues as sem_wait.
@end deftypefun
+@comment semaphore.h
+@comment POSIX
@deftypefun int sem_trywait (sem_t *@var{sem});
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c All atomic operations are safe in all contexts.
@end deftypefun
+@comment semaphore.h
+@comment POSIX
@deftypefun int sem_post (sem_t *@var{sem});
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c Same safety as sem_trywait.
@end deftypefun
+@comment semaphore.h
+@comment POSIX
@deftypefun int sem_getvalue (sem_t *@var{sem}, int *@var{sval});
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c Atomic write of a value is safe in all contexts.
diff --git a/manual/lang.texi b/manual/lang.texi
index 6281840..5e4d1d3 100644
--- a/manual/lang.texi
+++ b/manual/lang.texi
@@ -478,6 +478,8 @@ of the same type.
@comment stdarg.h
@comment ISO
@deftypefn {Macro} void va_copy (va_list @var{dest}, va_list @var{src})
+@comment stdarg.h
+@comment GNU
@deftypefnx {Macro} void __va_copy (va_list @var{dest}, va_list @var{src})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c This is no longer provided by glibc, but rather by the compiler.
@@ -1109,6 +1111,8 @@ where @code{radix} appears @code{FLT_MANT_DIG} times.
@comment float.h
@comment ISO
@item DBL_MANT_DIG
+@comment float.h
+@comment ISO
@itemx LDBL_MANT_DIG
This is the number of base-@code{FLT_RADIX} digits in the floating point
mantissa for the data types @code{double} and @code{long double},
@@ -1133,6 +1137,8 @@ The value of this macro is supposed to be at least @code{6}, to satisfy
@comment float.h
@comment ISO
@item DBL_DIG
+@comment float.h
+@comment ISO
@itemx LDBL_DIG
These are similar to @code{FLT_DIG}, but for the data types
@@ -1150,6 +1156,8 @@ normalized floating point number of type @code{float}.
@comment float.h
@comment ISO
@item DBL_MIN_EXP
+@comment float.h
+@comment ISO
@itemx LDBL_MIN_EXP
These are similar to @code{FLT_MIN_EXP}, but for the data types
@@ -1165,6 +1173,8 @@ of type @code{float}. This is supposed to be @code{-37} or even less.
@comment float.h
@comment ISO
@item DBL_MIN_10_EXP
+@comment float.h
+@comment ISO
@itemx LDBL_MIN_10_EXP
These are similar to @code{FLT_MIN_10_EXP}, but for the data types
@code{double} and @code{long double}, respectively.
@@ -1180,6 +1190,8 @@ floating point number of type @code{float}.
@comment float.h
@comment ISO
@item DBL_MAX_EXP
+@comment float.h
+@comment ISO
@itemx LDBL_MAX_EXP
These are similar to @code{FLT_MAX_EXP}, but for the data types
@code{double} and @code{long double}, respectively.
@@ -1194,6 +1206,8 @@ of type @code{float}. This is supposed to be at least @code{37}.
@comment float.h
@comment ISO
@item DBL_MAX_10_EXP
+@comment float.h
+@comment ISO
@itemx LDBL_MAX_10_EXP
These are similar to @code{FLT_MAX_10_EXP}, but for the data types
@code{double} and @code{long double}, respectively.
@@ -1211,6 +1225,8 @@ The smallest representable number is @code{- FLT_MAX}.
@comment float.h
@comment ISO
@item DBL_MAX
+@comment float.h
+@comment ISO
@itemx LDBL_MAX
These are similar to @code{FLT_MAX}, but for the data types
@@ -1228,6 +1244,8 @@ to be no more than @code{1E-37}.
@comment float.h
@comment ISO
@item DBL_MIN
+@comment float.h
+@comment ISO
@itemx LDBL_MIN
These are similar to @code{FLT_MIN}, but for the data types
@@ -1245,6 +1263,8 @@ be no greater than @code{1E-5}.
@comment float.h
@comment ISO
@item DBL_EPSILON
+@comment float.h
+@comment ISO
@itemx LDBL_EPSILON
These are similar to @code{FLT_EPSILON}, but for the data types
diff --git a/manual/llio.texi b/manual/llio.texi
index 9643bcb..dfefd4d 100644
--- a/manual/llio.texi
+++ b/manual/llio.texi
@@ -691,14 +691,20 @@ be one of the symbolic constants @code{SEEK_SET}, @code{SEEK_CUR}, or
@code{SEEK_END}.
@vtable @code
+@comment stdio.h unistd.h fcntl.h
+@comment C90, POSIX.1, XOPEN || POSIX.1-2008
@item SEEK_SET
Specifies that @var{offset} is a count of characters from the beginning
of the file.
+@comment stdio.h unistd.h fcntl.h
+@comment C90, POSIX.1, XOPEN || POSIX.1-2008
@item SEEK_CUR
Specifies that @var{offset} is a count of characters from the current
file position. This count may be positive or negative.
+@comment stdio.h unistd.h fcntl.h
+@comment C90, POSIX.1, XOPEN || POSIX.1-2008
@item SEEK_END
Specifies that @var{offset} is a count of characters from the end of
the file. A negative count specifies a position within the current
@@ -859,12 +865,18 @@ of compatibility with older BSD systems. They are defined in two
different header files: @file{fcntl.h} and @file{sys/file.h}.
@vtable @code
+@comment unistd.h sys/file.h
+@comment BSD, MISC
@item L_SET
An alias for @code{SEEK_SET}.
+@comment unistd.h sys/file.h
+@comment BSD, MISC
@item L_INCR
An alias for @code{SEEK_CUR}.
+@comment unistd.h sys/file.h
+@comment BSD, MISC
@item L_XTND
An alias for @code{SEEK_END}.
@end vtable
@@ -1250,6 +1262,8 @@ One of @code{MAP_SHARED} or @code{MAP_PRIVATE} must be specified.
They include:
@vtable @code
+@comment sys/mman.h
+@comment BSD
@item MAP_PRIVATE
This specifies that writes to the region should never be written back
to the attached file. Instead, a copy is made for the process, and the
@@ -1260,6 +1274,8 @@ Since private mappings effectively revert to ordinary memory
when written to, you must have enough virtual memory for a copy of
the entire mmapped region if you use this mode with @code{PROT_WRITE}.
+@comment sys/mman.h
+@comment BSD
@item MAP_SHARED
This specifies that writes to the region will be written back to the
file. Changes made will be shared immediately with other processes
@@ -1269,13 +1285,19 @@ Note that actual writing may take place at any time. You need to use
@code{msync}, described below, if it is important that other processes
using conventional I/O get a consistent view of the file.
+@comment sys/mman.h
+@comment BSD
@item MAP_FIXED
This forces the system to use the exact mapping address specified in
@var{address} and fail if it can't.
@c One of these is official - the other is obviously an obsolete synonym
@c Which is which?
+@comment sys/mman.h
+@comment Linux, MISC
@item MAP_ANONYMOUS
+@comment sys/mman.h
+@comment BSD, MISC
@itemx MAP_ANON
This flag tells the system to create an anonymous mapping, not connected
to a file. @var{filedes} and @var{offset} are ignored, and the region is
@@ -1399,12 +1421,16 @@ region given should not contain any unmapped space.
@vtable @code
+@comment sys/mman.h
+@comment BSD
@item MS_SYNC
This flag makes sure the data is actually written @emph{to disk}.
Normally @code{msync} only makes sure that accesses to a file with
conventional I/O reflect the recent changes.
+@comment sys/mman.h
+@comment BSD
@item MS_ASYNC
This tells @code{msync} to begin the synchronization, but not to wait for
@@ -1491,22 +1517,32 @@ The valid BSD values for @var{advice} are:
@vtable @code
+@comment sys/mman.h
+@comment MISC
@item MADV_NORMAL
The region should receive no further special treatment.
+@comment sys/mman.h
+@comment MISC
@item MADV_RANDOM
The region will be accessed via random page references. The kernel
should page-in the minimal number of pages for each page fault.
+@comment sys/mman.h
+@comment MISC
@item MADV_SEQUENTIAL
The region will be accessed via sequential page references. This
may cause the kernel to aggressively read-ahead, expecting further
sequential references after any page fault within this region.
+@comment sys/mman.h
+@comment MISC
@item MADV_WILLNEED
The region will be needed. The pages within this region may
be pre-faulted in by the kernel.
+@comment sys/mman.h
+@comment MISC
@item MADV_DONTNEED
The region is no longer needed. The kernel may free these pages,
causing any changes to the pages to be lost, as well as swapped
@@ -1518,18 +1554,28 @@ The POSIX names are slightly different, but with the same meanings:
@vtable @code
+@comment sys/mman.h
+@comment POSIX.1-2001
@item POSIX_MADV_NORMAL
This corresponds with BSD's @code{MADV_NORMAL}.
+@comment sys/mman.h
+@comment POSIX.1-2001
@item POSIX_MADV_RANDOM
This corresponds with BSD's @code{MADV_RANDOM}.
+@comment sys/mman.h
+@comment POSIX.1-2001
@item POSIX_MADV_SEQUENTIAL
This corresponds with BSD's @code{MADV_SEQUENTIAL}.
+@comment sys/mman.h
+@comment POSIX.1-2001
@item POSIX_MADV_WILLNEED
This corresponds with BSD's @code{MADV_WILLNEED}.
+@comment sys/mman.h
+@comment POSIX.1-2001
@item POSIX_MADV_DONTNEED
This corresponds with BSD's @code{MADV_DONTNEED}.
@@ -1584,6 +1630,8 @@ The semantics of @var{oflag} and @var{mode} arguments is same as in @code{open}.
On failure @code{errno} is set.
@end deftypefn
+@comment sys/mman.h
+@comment POSIX
@deftypefn Function int shm_unlink (const char *@var{name})
@safety{@prelim{}@mtsafe{@mtslocale{}}@asunsafe{@asuinit{} @ascuheap{} @asulock{}}@acunsafe{@aculock{} @acsmem{} @acsfd{}}}
@c shm_unlink @mtslocale @asuinit @ascuheap @asulock @aculock @acsmem @acsfd
@@ -1969,15 +2017,21 @@ input or output (or nothing), the information must be stored in the
control block. The possible values are:
@vtable @code
+@comment aio.h
+@comment POSIX
@item LIO_READ
Start a read operation. Read from the file at position
@code{aio_offset} and store the next @code{aio_nbytes} bytes in the
buffer pointed to by @code{aio_buf}.
+@comment aio.h
+@comment POSIX
@item LIO_WRITE
Start a write operation. Write @code{aio_nbytes} bytes starting at
@code{aio_buf} into the file starting at position @code{aio_offset}.
+@comment aio.h
+@comment POSIX
@item LIO_NOP
Do nothing for this control block. This value is useful sometimes when
an array of @code{struct aiocb} values contains holes, i.e., some of the
@@ -2904,47 +2958,73 @@ descriptions of the individual commands.
Briefly, here is a list of what the various commands are.
@vtable @code
+@comment fcntl.h
+@comment BSD
@item F_DUPFD
Duplicate the file descriptor (return another file descriptor pointing
to the same open file). @xref{Duplicating Descriptors}.
+@comment fcntl.h
+@comment BSD
@item F_GETFD
Get flags associated with the file descriptor. @xref{Descriptor Flags}.
+@comment fcntl.h
+@comment BSD
@item F_SETFD
Set flags associated with the file descriptor. @xref{Descriptor Flags}.
+@comment fcntl.h
+@comment BSD
@item F_GETFL
Get flags associated with the open file. @xref{File Status Flags}.
+@comment fcntl.h
+@comment BSD
@item F_SETFL
Set flags associated with the open file. @xref{File Status Flags}.
+@comment fcntl.h
+@comment BSD
@item F_GETLK
Test a file lock. @xref{File Locks}.
+@comment fcntl.h
+@comment BSD
@item F_SETLK
Set or clear a file lock. @xref{File Locks}.
+@comment fcntl.h
+@comment BSD
@item F_SETLKW
Like @code{F_SETLK}, but wait for completion. @xref{File Locks}.
+@comment fcntl.h
+@comment GNU
@item F_OFD_GETLK
Test an open file description lock. @xref{Open File Description Locks}.
Specific to Linux.
+@comment fcntl.h
+@comment GNU
@item F_OFD_SETLK
Set or clear an open file description lock. @xref{Open File Description Locks}.
Specific to Linux.
+@comment fcntl.h
+@comment GNU
@item F_OFD_SETLKW
Like @code{F_OFD_SETLK}, but block until lock is acquired.
@xref{Open File Description Locks}. Specific to Linux.
+@comment fcntl.h
+@comment UNIX98 || POSIX.1-2008
@item F_GETOWN
Get process or process group ID to receive @code{SIGIO} signals.
@xref{Interrupt Input}.
+@comment fcntl.h
+@comment UNIX98 || POSIX.1-2008
@item F_SETOWN
Set process or process group ID to receive @code{SIGIO} signals.
@xref{Interrupt Input}.
@@ -3919,6 +3999,8 @@ When the same @code{struct flock} is reused as an argument to a
@pindex fcntl.h.
+@comment fcntl.h
+@comment GNU
@deftypevr Macro int F_OFD_GETLK
This macro is used as the @var{command} argument to @code{fcntl}, to
specify that it should get information about a lock. This command
diff --git a/manual/locale.texi b/manual/locale.texi
index ae71ccc..953dc4d 100644
--- a/manual/locale.texi
+++ b/manual/locale.texi
@@ -915,57 +915,139 @@ The type @code{nl_type} is defined in @file{nl_types.h}. The argument
The X/Open standard defines the following values:
@vtable @code
+@comment langinfo.h
+@comment XOPEN
@item CODESET
@code{nl_langinfo} returns a string with the name of the coded character
set used in the selected locale.
+@comment langinfo.h
+@comment XOPEN
@item ABDAY_1
+@comment langinfo.h
+@comment XOPEN
@itemx ABDAY_2
+@comment langinfo.h
+@comment XOPEN
@itemx ABDAY_3
+@comment langinfo.h
+@comment XOPEN
@itemx ABDAY_4
+@comment langinfo.h
+@comment XOPEN
@itemx ABDAY_5
+@comment langinfo.h
+@comment XOPEN
@itemx ABDAY_6
+@comment langinfo.h
+@comment XOPEN
@itemx ABDAY_7
@code{nl_langinfo} returns the abbreviated weekday name. @code{ABDAY_1}
corresponds to Sunday.
+@comment langinfo.h
+@comment XOPEN
@item DAY_1
+@comment langinfo.h
+@comment XOPEN
@itemx DAY_2
+@comment langinfo.h
+@comment XOPEN
@itemx DAY_3
+@comment langinfo.h
+@comment XOPEN
@itemx DAY_4
+@comment langinfo.h
+@comment XOPEN
@itemx DAY_5
+@comment langinfo.h
+@comment XOPEN
@itemx DAY_6
+@comment langinfo.h
+@comment XOPEN
@itemx DAY_7
Similar to @code{ABDAY_1} etc., but here the return value is the
unabbreviated weekday name.
+@comment langinfo.h
+@comment XOPEN
@item ABMON_1
+@comment langinfo.h
+@comment XOPEN
@itemx ABMON_2
+@comment langinfo.h
+@comment XOPEN
@itemx ABMON_3
+@comment langinfo.h
+@comment XOPEN
@itemx ABMON_4
+@comment langinfo.h
+@comment XOPEN
@itemx ABMON_5
+@comment langinfo.h
+@comment XOPEN
@itemx ABMON_6
+@comment langinfo.h
+@comment XOPEN
@itemx ABMON_7
+@comment langinfo.h
+@comment XOPEN
@itemx ABMON_8
+@comment langinfo.h
+@comment XOPEN
@itemx ABMON_9
+@comment langinfo.h
+@comment XOPEN
@itemx ABMON_10
+@comment langinfo.h
+@comment XOPEN
@itemx ABMON_11
+@comment langinfo.h
+@comment XOPEN
@itemx ABMON_12
The return value is abbreviated name of the month. @code{ABMON_1}
corresponds to January.
+@comment langinfo.h
+@comment XOPEN
@item MON_1
+@comment langinfo.h
+@comment XOPEN
@itemx MON_2
+@comment langinfo.h
+@comment XOPEN
@itemx MON_3
+@comment langinfo.h
+@comment XOPEN
@itemx MON_4
+@comment langinfo.h
+@comment XOPEN
@itemx MON_5
+@comment langinfo.h
+@comment XOPEN
@itemx MON_6
+@comment langinfo.h
+@comment XOPEN
@itemx MON_7
+@comment langinfo.h
+@comment XOPEN
@itemx MON_8
+@comment langinfo.h
+@comment XOPEN
@itemx MON_9
+@comment langinfo.h
+@comment XOPEN
@itemx MON_10
+@comment langinfo.h
+@comment XOPEN
@itemx MON_11
+@comment langinfo.h
+@comment XOPEN
@itemx MON_12
Similar to @code{ABMON_1} etc., but here the month names are not abbreviated.
Here the first value @code{MON_1} also corresponds to January.
+@comment langinfo.h
+@comment XOPEN
@item AM_STR
+@comment langinfo.h
+@comment XOPEN
@itemx PM_STR
The return values are strings which can be used in the representation of time
as an hour from 1 to 12 plus an am/pm specifier.
@@ -973,15 +1055,23 @@ as an hour from 1 to 12 plus an am/pm specifier.
Note that in locales which do not use this time representation
these strings might be empty, in which case the am/pm format
cannot be used at all.
+@comment langinfo.h
+@comment XOPEN
@item D_T_FMT
The return value can be used as a format string for @code{strftime} to
represent time and date in a locale-specific way.
+@comment langinfo.h
+@comment XOPEN
@item D_FMT
The return value can be used as a format string for @code{strftime} to
represent a date in a locale-specific way.
+@comment langinfo.h
+@comment XOPEN
@item T_FMT
The return value can be used as a format string for @code{strftime} to
represent time in a locale-specific way.
+@comment langinfo.h
+@comment XOPEN
@item T_FMT_AMPM
The return value can be used as a format string for @code{strftime} to
represent time in the am/pm format.
@@ -989,6 +1079,8 @@ represent time in the am/pm format.
Note that if the am/pm format does not make any sense for the
selected locale, the return value might be the same as the one for
@code{T_FMT}.
+@comment langinfo.h
+@comment XOPEN
@item ERA
The return value represents the era used in the current locale.
@@ -1002,18 +1094,28 @@ Specifying the @code{E} modifier in their format strings causes the
@code{strftime} functions to use this information. The format of the
returned string is not specified, and therefore you should not assume
knowledge of it on different systems.
+@comment langinfo.h
+@comment GNU
@item ERA_YEAR
The return value gives the year in the relevant era of the locale.
As for @code{ERA} it should not be necessary to use this value directly.
+@comment langinfo.h
+@comment XOPEN
@item ERA_D_T_FMT
This return value can be used as a format string for @code{strftime} to
represent dates and times in a locale-specific era-based way.
+@comment langinfo.h
+@comment XOPEN
@item ERA_D_FMT
This return value can be used as a format string for @code{strftime} to
represent a date in a locale-specific era-based way.
+@comment langinfo.h
+@comment XOPEN
@item ERA_T_FMT
This return value can be used as a format string for @code{strftime} to
represent time in a locale-specific era-based way.
+@comment langinfo.h
+@comment XOPEN
@item ALT_DIGITS
The return value is a representation of up to @math{100} values used to
represent the values @math{0} to @math{99}. As for @code{ERA} this
@@ -1022,98 +1124,158 @@ through the @code{strftime} function. When the modifier @code{O} is
used in a format which would otherwise use numerals to represent hours,
minutes, seconds, weekdays, months, or weeks, the appropriate value for
the locale is used instead.
+@comment langinfo.h
+@comment GNU
@item INT_CURR_SYMBOL
The same as the value returned by @code{localeconv} in the
@code{int_curr_symbol} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item CURRENCY_SYMBOL
+@comment langinfo.h
+@comment UNIX98
@itemx CRNCYSTR
The same as the value returned by @code{localeconv} in the
@code{currency_symbol} element of the @code{struct lconv}.
@code{CRNCYSTR} is a deprecated alias still required by Unix98.
+@comment langinfo.h
+@comment GNU
@item MON_DECIMAL_POINT
The same as the value returned by @code{localeconv} in the
@code{mon_decimal_point} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item MON_THOUSANDS_SEP
The same as the value returned by @code{localeconv} in the
@code{mon_thousands_sep} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item MON_GROUPING
The same as the value returned by @code{localeconv} in the
@code{mon_grouping} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item POSITIVE_SIGN
The same as the value returned by @code{localeconv} in the
@code{positive_sign} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item NEGATIVE_SIGN
The same as the value returned by @code{localeconv} in the
@code{negative_sign} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item INT_FRAC_DIGITS
The same as the value returned by @code{localeconv} in the
@code{int_frac_digits} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item FRAC_DIGITS
The same as the value returned by @code{localeconv} in the
@code{frac_digits} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item P_CS_PRECEDES
The same as the value returned by @code{localeconv} in the
@code{p_cs_precedes} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item P_SEP_BY_SPACE
The same as the value returned by @code{localeconv} in the
@code{p_sep_by_space} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item N_CS_PRECEDES
The same as the value returned by @code{localeconv} in the
@code{n_cs_precedes} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item N_SEP_BY_SPACE
The same as the value returned by @code{localeconv} in the
@code{n_sep_by_space} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item P_SIGN_POSN
The same as the value returned by @code{localeconv} in the
@code{p_sign_posn} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item N_SIGN_POSN
The same as the value returned by @code{localeconv} in the
@code{n_sign_posn} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item INT_P_CS_PRECEDES
The same as the value returned by @code{localeconv} in the
@code{int_p_cs_precedes} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item INT_P_SEP_BY_SPACE
The same as the value returned by @code{localeconv} in the
@code{int_p_sep_by_space} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item INT_N_CS_PRECEDES
The same as the value returned by @code{localeconv} in the
@code{int_n_cs_precedes} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item INT_N_SEP_BY_SPACE
The same as the value returned by @code{localeconv} in the
@code{int_n_sep_by_space} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item INT_P_SIGN_POSN
The same as the value returned by @code{localeconv} in the
@code{int_p_sign_posn} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item INT_N_SIGN_POSN
The same as the value returned by @code{localeconv} in the
@code{int_n_sign_posn} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment GNU
@item DECIMAL_POINT
+@comment langinfo.h
+@comment UNIX98
@itemx RADIXCHAR
The same as the value returned by @code{localeconv} in the
@code{decimal_point} element of the @code{struct lconv}.
The name @code{RADIXCHAR} is a deprecated alias still used in Unix98.
+@comment langinfo.h
+@comment GNU
@item THOUSANDS_SEP
+@comment langinfo.h
+@comment UNIX98
@itemx THOUSEP
The same as the value returned by @code{localeconv} in the
@code{thousands_sep} element of the @code{struct lconv}.
The name @code{THOUSEP} is a deprecated alias still used in Unix98.
+@comment langinfo.h
+@comment GNU
@item GROUPING
The same as the value returned by @code{localeconv} in the
@code{grouping} element of the @code{struct lconv}.
+@comment langinfo.h
+@comment XOPEN
@item YESEXPR
The return value is a regular expression which can be used with the
@code{regex} function to recognize a positive response to a yes/no
question. @Theglibc{} provides the @code{rpmatch} function for
easier handling in applications.
+@comment langinfo.h
+@comment XOPEN
@item NOEXPR
The return value is a regular expression which can be used with the
@code{regex} function to recognize a negative response to a yes/no
question.
+@comment langinfo.h
+@comment GNU || (XOPEN && !POSIX.1-2001)
@item YESSTR
The return value is a locale-specific translation of the positive response
to a yes/no question.
@@ -1124,6 +1286,8 @@ translation functions (@pxref{Message Translation}).
The use of this symbol is deprecated. Instead message translation
should be used.
+@comment langinfo.h
+@comment GNU || (XOPEN && !POSIX.1-2001)
@item NOSTR
The return value is a locale-specific translation of the negative response
to a yes/no question. What is said for @code{YESSTR} is also true here.
@@ -1192,6 +1356,8 @@ Therefore the X/Open standards introduce a function which uses such
locale information, making it easier for the user to format
numbers according to these rules.
+@comment monetary.h
+@comment XOPEN
@deftypefun ssize_t strfmon (char *@var{s}, size_t @var{maxsize}, const char *@var{format}, @dots{})
@safety{@prelim{}@mtsafe{@mtslocale{}}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
@c It (and strfmon_l) both call vstrfmon_l, which, besides accessing the
diff --git a/manual/math.texi b/manual/math.texi
index 5ad8732..f91d66d 100644
--- a/manual/math.texi
+++ b/manual/math.texi
@@ -77,30 +77,56 @@ All values are defined as preprocessor macros starting with @code{M_}.
The values provided are:
@vtable @code
+@comment math.h
+@comment MISC || XOPEN
@item M_E
The base of natural logarithms.
+@comment math.h
+@comment MISC || XOPEN
@item M_LOG2E
The logarithm to base @code{2} of @code{M_E}.
+@comment math.h
+@comment MISC || XOPEN
@item M_LOG10E
The logarithm to base @code{10} of @code{M_E}.
+@comment math.h
+@comment MISC || XOPEN
@item M_LN2
The natural logarithm of @code{2}.
+@comment math.h
+@comment MISC || XOPEN
@item M_LN10
The natural logarithm of @code{10}.
+@comment math.h
+@comment MISC || XOPEN
@item M_PI
Pi, the ratio of a circle's circumference to its diameter.
+@comment math.h
+@comment MISC || XOPEN
@item M_PI_2
Pi divided by two.
+@comment math.h
+@comment MISC || XOPEN
@item M_PI_4
Pi divided by four.
+@comment math.h
+@comment MISC || XOPEN
@item M_1_PI
The reciprocal of pi (1/pi)
+@comment math.h
+@comment MISC || XOPEN
@item M_2_PI
Two times the reciprocal of pi.
+@comment math.h
+@comment MISC || XOPEN
@item M_2_SQRTPI
Two times the reciprocal of the square root of pi.
+@comment math.h
+@comment MISC || XOPEN
@item M_SQRT2
The square root of two.
+@comment math.h
+@comment MISC || XOPEN
@item M_SQRT1_2
The reciprocal of the square root of two (also the square root of 1/2).
@end vtable
diff --git a/manual/memory.texi b/manual/memory.texi
index 38d3c3a..b8dde63 100644
--- a/manual/memory.texi
+++ b/manual/memory.texi
@@ -920,6 +920,7 @@ power of two than that, use @code{aligned_alloc} or @code{posix_memalign}.
@file{stdlib.h}.
@comment stdlib.h
+@comment C11
@deftypefun {void *} aligned_alloc (size_t @var{alignment}, size_t @var{size})
@safety{@prelim{}@mtsafe{}@asunsafe{@asulock{}}@acunsafe{@aculock{} @acsfd{} @acsmem{}}}
@c Alias to memalign.
@@ -1077,6 +1078,8 @@ You can adjust some parameters for dynamic memory allocation with the
interface, defined in @file{malloc.h}.
@pindex malloc.h
+@comment malloc.h
+@comment SVID, XPG
@deftypefun int mallopt (int @var{param}, int @var{value})
@safety{@prelim{}@mtunsafe{@mtuinit{} @mtasuconst{:mallopt}}@asunsafe{@asuinit{} @asulock{}}@acunsafe{@acuinit{} @aculock{}}}
@c __libc_mallopt @mtuinit @mtasuconst:mallopt @asuinit @asulock @aculock
@@ -1092,6 +1095,8 @@ choices for @var{param}, as defined in @file{malloc.h}, are:
@comment TODO: @item M_CHECK_ACTION
@vtable @code
+@comment malloc.h
+@comment ???
@item M_MMAP_MAX
The maximum number of chunks to allocate with @code{mmap}. Setting this
to zero disables all use of @code{mmap}.
@@ -1101,6 +1106,8 @@ The default value of this parameter is @code{65536}.
This parameter can also be set for the process at startup by setting the
environment variable @env{MALLOC_MMAP_MAX_} to the desired value.
+@comment malloc.h
+@comment ???
@item M_MMAP_THRESHOLD
All chunks larger than this value are allocated outside the normal
heap, using the @code{mmap} system call. This way it is guaranteed
@@ -1117,6 +1124,8 @@ This parameter can also be set for the process at startup by setting the
environment variable @env{MALLOC_MMAP_THRESHOLD_} to the desired value.
@comment TODO: @item M_MXFAST
+@comment malloc.h
+@comment ???
@item M_PERTURB
If non-zero, memory blocks are filled with values depending on some
low order bits of this parameter when they are allocated (except when
@@ -1131,6 +1140,8 @@ The default value of this parameter is @code{0}.
This parameter can also be set for the process at startup by setting the
environment variable @env{MALLOC_MMAP_PERTURB_} to the desired value.
+@comment malloc.h
+@comment ???
@item M_TOP_PAD
This parameter determines the amount of extra memory to obtain from the system
when an arena needs to be extended. It also specifies the number of bytes to
@@ -1142,6 +1153,8 @@ The default value of this parameter is @code{0}.
This parameter can also be set for the process at startup by setting the
environment variable @env{MALLOC_TOP_PAD_} to the desired value.
+@comment malloc.h
+@comment ???
@item M_TRIM_THRESHOLD
This is the minimum size (in bytes) of the top-most, releasable chunk
that will trigger a system call in order to return memory to the system.
@@ -1154,6 +1167,8 @@ value is set statically to the provided input.
This parameter can also be set for the process at startup by setting the
environment variable @env{MALLOC_TRIM_THRESHOLD_} to the desired value.
+@comment malloc.h
+@comment ???
@item M_ARENA_TEST
This parameter specifies the number of arenas that can be created before the
test on the limit to the number of arenas is conducted. The value is ignored if
@@ -1165,6 +1180,8 @@ systems.
This parameter can also be set for the process at startup by setting the
environment variable @env{MALLOC_ARENA_TEST} to the desired value.
+@comment malloc.h
+@comment ???
@item M_ARENA_MAX
This parameter sets the number of arenas to use regardless of the number of
cores in the system.
@@ -1247,6 +1264,8 @@ must be called before the first such function.
@end deftypefun
+@comment mcheck.h
+@comment GNU
@deftypefun {enum mcheck_status} mprobe (void *@var{pointer})
@safety{@prelim{}@mtunsafe{@mtasurace{:mcheck} @mtasuconst{:malloc_hooks}}@asunsafe{@asucorrupt{}}@acunsafe{@acucorrupt{}}}
@c The linked list of headers may be modified concurrently by other
@@ -1271,6 +1290,8 @@ or @code{realloc}. @code{mprobe} returns a value that says what
inconsistency, if any, was found. The values are described below.
@end deftypefun
+@comment mcheck.h
+@comment GNU
@deftp {Data Type} {enum mcheck_status}
This enumerated type describes what kind of inconsistency was detected
in an allocated block, if any. Here are the possible values:
@@ -3215,10 +3236,14 @@ other bits must be zero.
@vtable @code
+@comment sys/mman.h
+@comment BSD, POSIX
@item MCL_CURRENT
Lock all pages which currently exist in the calling process' virtual
address space.
+@comment sys/mman.h
+@comment BSD, POSIX
@item MCL_FUTURE
Set a mode such that any pages added to the process' virtual address
space in the future will be locked from birth. This mode does not
diff --git a/manual/message.texi b/manual/message.texi
index 2dae3ed..21317b3 100644
--- a/manual/message.texi
+++ b/manual/message.texi
@@ -267,6 +267,8 @@ The @code{catopen} function directly reads the values of the environment
variables.
+@comment nl_types.h
+@comment XOPEN
@deftypefun {char *} catgets (nl_catd @var{catalog_desc}, int @var{set}, int @var{message}, const char *@var{string})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
The function @code{catgets} has to be used to access the message catalog
@@ -306,6 +308,8 @@ between several people working on the same project must be coordinated.
We will see how some of these problems can be relaxed a bit (@pxref{Common
Usage}).
+@comment nl_types.h
+@comment XOPEN
@deftypefun int catclose (nl_catd @var{catalog_desc})
@safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acucorrupt{} @acsmem{}}}
@c catclose @ascuheap @acucorrupt @acsmem
diff --git a/manual/nss.texi b/manual/nss.texi
index ee70ad3..8c3f859 100644
--- a/manual/nss.texi
+++ b/manual/nss.texi
@@ -451,15 +451,23 @@ function returns a pointer to the result the reentrant function return
an @code{enum nss_status} value:
@vtable @code
+@comment nss.h
+@comment ???
@item NSS_STATUS_TRYAGAIN
numeric value @code{-2}
+@comment nss.h
+@comment ???
@item NSS_STATUS_UNAVAIL
numeric value @code{-1}
+@comment nss.h
+@comment ???
@item NSS_STATUS_NOTFOUND
numeric value @code{0}
+@comment nss.h
+@comment ???
@item NSS_STATUS_SUCCESS
numeric value @code{1}
@end vtable
diff --git a/manual/pattern.texi b/manual/pattern.texi
index 30a76c8..9b3ff84 100644
--- a/manual/pattern.texi
+++ b/manual/pattern.texi
@@ -202,13 +202,19 @@ implementation contains some more fields which are non-standard
extensions.
@table @code
+@comment glob.h
+@comment POSIX.2
@item gl_pathc
The number of elements in the vector, excluding the initial null entries
if the GLOB_DOOFFS flag is used (see gl_offs below).
+@comment glob.h
+@comment POSIX.2
@item gl_pathv
The address of the vector. This field has type @w{@code{char **}}.
+@comment glob.h
+@comment POSIX.2
@item gl_offs
The offset of the first real element of the vector, from its nominal
address in the @code{gl_pathv} field. Unlike the other fields, this
@@ -223,6 +229,8 @@ The @code{gl_offs} field is meaningful only if you use the
regardless of what is in this field, and the first real element comes at
the beginning of the vector.
+@comment glob.h
+@comment GNU
@item gl_closedir
The address of an alternative implementation of the @code{closedir}
function. It is used if the @code{GLOB_ALTDIRFUNC} bit is set in
@@ -231,6 +239,8 @@ the flag parameter. The type of this field is
This is a GNU extension.
+@comment glob.h
+@comment GNU
@item gl_readdir
The address of an alternative implementation of the @code{readdir}
function used to read the contents of a directory. It is used if the
@@ -276,6 +286,8 @@ function, and deallocate it in the @code{gl_closedir} callback function.
The @code{gl_readdir} member is a GNU extension.
+@comment glob.h
+@comment GNU
@item gl_opendir
The address of an alternative implementation of the @code{opendir}
function. It is used if the @code{GLOB_ALTDIRFUNC} bit is set in
@@ -284,6 +296,8 @@ the flag parameter. The type of this field is
This is a GNU extension.
+@comment glob.h
+@comment GNU
@item gl_stat
The address of an alternative implementation of the @code{stat} function
to get information about an object in the filesystem. It is used if the
@@ -292,6 +306,8 @@ this field is @w{@code{int (*) (const char *, struct stat *)}}.
This is a GNU extension.
+@comment glob.h
+@comment GNU
@item gl_lstat
The address of an alternative implementation of the @code{lstat}
function to get information about an object in the filesystems, not
@@ -301,6 +317,8 @@ is set in the flag parameter. The type of this field is @code{@w{int
This is a GNU extension.
+@comment glob.h
+@comment GNU
@item gl_flags
The flags used when @code{glob} was called. In addition, @code{GLOB_MAGCHAR}
might be set. See @ref{Flags for Globbing} for more details.
@@ -323,13 +341,19 @@ implementation contains some more fields which are non-standard
extensions.
@table @code
+@comment glob.h
+@comment POSIX.2
@item gl_pathc
The number of elements in the vector, excluding the initial null entries
if the GLOB_DOOFFS flag is used (see gl_offs below).
+@comment glob.h
+@comment POSIX.2
@item gl_pathv
The address of the vector. This field has type @w{@code{char **}}.
+@comment glob.h
+@comment POSIX.2
@item gl_offs
The offset of the first real element of the vector, from its nominal
address in the @code{gl_pathv} field. Unlike the other fields, this
@@ -344,6 +368,8 @@ The @code{gl_offs} field is meaningful only if you use the
regardless of what is in this field, and the first real element comes at
the beginning of the vector.
+@comment glob.h
+@comment GNU
@item gl_closedir
The address of an alternative implementation of the @code{closedir}
function. It is used if the @code{GLOB_ALTDIRFUNC} bit is set in
@@ -352,6 +378,8 @@ the flag parameter. The type of this field is
This is a GNU extension.
+@comment glob.h
+@comment GNU
@item gl_readdir
The address of an alternative implementation of the @code{readdir64}
function used to read the contents of a directory. It is used if the
@@ -360,6 +388,8 @@ this field is @w{@code{struct dirent64 *(*) (void *)}}.
This is a GNU extension.
+@comment glob.h
+@comment GNU
@item gl_opendir
The address of an alternative implementation of the @code{opendir}
function. It is used if the @code{GLOB_ALTDIRFUNC} bit is set in
@@ -368,6 +398,8 @@ the flag parameter. The type of this field is
This is a GNU extension.
+@comment glob.h
+@comment GNU
@item gl_stat
The address of an alternative implementation of the @code{stat64} function
to get information about an object in the filesystem. It is used if the
@@ -376,6 +408,8 @@ this field is @w{@code{int (*) (const char *, struct stat64 *)}}.
This is a GNU extension.
+@comment glob.h
+@comment GNU
@item gl_lstat
The address of an alternative implementation of the @code{lstat64}
function to get information about an object in the filesystems, not
@@ -385,6 +419,8 @@ is set in the flag parameter. The type of this field is @code{@w{int
This is a GNU extension.
+@comment glob.h
+@comment GNU
@item gl_flags
The flags used when @code{glob} was called. In addition, @code{GLOB_MAGCHAR}
might be set. See @ref{Flags for Globbing} for more details.
diff --git a/manual/platform.texi b/manual/platform.texi
index cb16664..ccbe73c 100644
--- a/manual/platform.texi
+++ b/manual/platform.texi
@@ -14,6 +14,8 @@
Facilities specific to PowerPC that are not specific to a particular
operating system are declared in @file{sys/platform/ppc.h}.
+@comment sys/platform/ppc.h
+@comment ???
@deftypefun {uint64_t} __ppc_get_timebase (void)
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
Read the current value of the Time Base Register.
@@ -28,6 +30,8 @@ without requiring assistance from the operating system, so it is very
efficient.
@end deftypefun
+@comment sys/platform/ppc.h
+@comment ???
@deftypefun {uint64_t} __ppc_get_timebase_freq (void)
@safety{@prelim{}@mtunsafe{@mtuinit{}}@asunsafe{@asucorrupt{:init}}@acunsafe{@acucorrupt{:init}}}
@c __ppc_get_timebase_freq=__get_timebase_freq @mtuinit @acsfd
@@ -53,12 +57,16 @@ waiting on a lock intends to divert the shared resources to be used by other
processors. More information is available in @cite{Power ISA 2.06b - Book II -
Section 3.2}.
+@comment sys/platform/ppc.h
+@comment ???
@deftypefun {void} __ppc_yield (void)
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
Provide a hint that performance will probably be improved if shared resources
dedicated to the executing processor are released for use by other processors.
@end deftypefun
+@comment sys/platform/ppc.h
+@comment ???
@deftypefun {void} __ppc_mdoio (void)
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
Provide a hint that performance will probably be improved if shared resources
@@ -66,6 +74,8 @@ dedicated to the executing processor are released until all outstanding storage
accesses to caching-inhibited storage have been completed.
@end deftypefun
+@comment sys/platform/ppc.h
+@comment ???
@deftypefun {void} __ppc_mdoom (void)
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
Provide a hint that performance will probably be improved if shared resources
@@ -74,6 +84,8 @@ accesses to cacheable storage for which the data is not in the cache have been
completed.
@end deftypefun
+@comment sys/platform/ppc.h
+@comment ???
@deftypefun {void} __ppc_set_ppr_med (void)
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
Set the Program Priority Register to medium value (default).
@@ -88,11 +100,15 @@ and @code{__ppc_set_ppc_med_low} (medium low). More information
available in @cite{Power ISA 2.06b - Book II - Section 3.1}.
@end deftypefun
+@comment sys/platform/ppc.h
+@comment ???
@deftypefun {void} __ppc_set_ppr_low (void)
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
Set the Program Priority Register to low value.
@end deftypefun
+@comment sys/platform/ppc.h
+@comment ???
@deftypefun {void} __ppc_set_ppr_med_low (void)
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
Set the Program Priority Register to medium low value.
@@ -102,11 +118,15 @@ Power ISA 2.07 extends the priorities that can be set to the Program Priority
Register (PPR). The following functions implement the new priority levels:
very low and medium high.
+@comment sys/platform/ppc.h
+@comment ???
@deftypefun {void} __ppc_set_ppr_very_low (void)
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
Set the Program Priority Register to very low value.
@end deftypefun
+@comment sys/platform/ppc.h
+@comment ???
@deftypefun {void} __ppc_set_ppr_med_high (void)
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
Set the Program Priority Register to medium high value. The medium high
diff --git a/manual/process.texi b/manual/process.texi
index 085fdec..51d62ae 100644
--- a/manual/process.texi
+++ b/manual/process.texi
@@ -595,12 +595,16 @@ to the @code{waitpid} function.
@comment Extra blank lines make it look better.
@vtable @code
+@comment sys/wait.h
+@comment MISC
@item WAIT_ANY
This constant macro (whose value is @code{-1}) specifies that
@code{waitpid} should return status information about any child process.
+@comment sys/wait.h
+@comment MISC
@item WAIT_MYPGRP
This constant (with value @code{0}) specifies that @code{waitpid} should
return status information about any child process in the same process
@@ -612,11 +616,15 @@ argument to the @code{waitpid} function. You can bitwise-OR the flags
together to obtain a value to use as the argument.
@vtable @code
+@comment sys/wait.h
+@comment POSIX.1
@item WNOHANG
This flag specifies that @code{waitpid} should return immediately
instead of waiting, if there is no child process ready to be noticed.
+@comment sys/wait.h
+@comment POSIX.1
@item WUNTRACED
This flag specifies that @code{waitpid} should report the status of any
diff --git a/manual/resource.texi b/manual/resource.texi
index bf93375..2132e06 100644
--- a/manual/resource.texi
+++ b/manual/resource.texi
@@ -133,6 +133,7 @@ scheduled).
@pindex sys/vtimes.h
@comment sys/vtimes.h
+@comment ???
@deftypefun int vtimes (struct vtimes *@var{current}, struct vtimes *@var{child})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c Calls getrusage twice.
@@ -145,6 +146,8 @@ the invoking process alone in the structure to which it points. If
past children (which have terminated) of the invoking process in the structure
to which it points.
+@comment sys/vtimes.h
+@comment ???
@deftp {Data Type} {struct vtimes}
This data type contains information about the resource usage of a process.
Each member corresponds to a member of the @code{struct rusage} data type
@@ -398,6 +401,8 @@ with @code{EAGAIN}. @xref{Creating a Process}.
@comment sys/resource.h
@comment BSD
@item RLIMIT_NOFILE
+@comment sys/resource.h
+@comment BSD
@itemx RLIMIT_OFILE
The maximum number of files that the process can open. If it tries to
open more files than this, its open attempt fails with @code{errno}
@@ -452,9 +457,13 @@ the limit.
The @var{cmd} values and the operations they specify are:
@vtable @code
+@comment ulimit.h
+@comment BSD
@item GETFSIZE
Get the current limit on the size of a file, in units of 512 bytes.
+@comment ulimit.h
+@comment BSD
@item SETFSIZE
Set the current and maximum limit on the size of a file to @var{limit} *
512 bytes.
@@ -495,16 +504,28 @@ A process tried to increase a maximum limit, but is not superuser.
@var{resource} identifies the resource:
@vtable @code
+@comment sys/vlimit.h
+@comment BSD
@item LIM_CPU
Maximum CPU time. Same as @code{RLIMIT_CPU} for @code{setrlimit}.
+@comment sys/vlimit.h
+@comment BSD
@item LIM_FSIZE
Maximum file size. Same as @code{RLIMIT_FSIZE} for @code{setrlimit}.
+@comment sys/vlimit.h
+@comment BSD
@item LIM_DATA
Maximum data memory. Same as @code{RLIMIT_DATA} for @code{setrlimit}.
+@comment sys/vlimit.h
+@comment BSD
@item LIM_STACK
Maximum stack size. Same as @code{RLIMIT_STACK} for @code{setrlimit}.
+@comment sys/vlimit.h
+@comment BSD
@item LIM_CORE
Maximum core file size. Same as @code{RLIMIT_COR} for @code{setrlimit}.
+@comment sys/vlimit.h
+@comment BSD
@item LIM_MAXRSS
Maximum physical memory. Same as @code{RLIMIT_RSS} for @code{setrlimit}.
@end vtable
@@ -801,10 +822,16 @@ negative, @code{sched_setscheduler} keeps the existing scheduling policy.
The following macros represent the valid values for @var{policy}:
@vtable @code
+@comment sched.h
+@comment POSIX
@item SCHED_OTHER
Traditional Scheduling
+@comment sched.h
+@comment POSIX
@item SCHED_FIFO
First In First Out
+@comment sched.h
+@comment POSIX
@item SCHED_RR
Round Robin
@end vtable
diff --git a/manual/search.texi b/manual/search.texi
index 1d9628d..3a80bae 100644
--- a/manual/search.texi
+++ b/manual/search.texi
@@ -332,6 +332,8 @@ used until the end of the program run.
Entries of the hashing table and keys for the search are defined using
this type:
+@comment search.h
+@comment SVID
@deftp {Data type} {struct ENTRY}
Both elements of this structure are pointers to zero-terminated strings.
This is a limiting restriction of the functionality of the
@@ -591,6 +593,8 @@ which corresponds to the depth of the current node in the tree. The
root node has the depth @math{0} and its children have a depth of
@math{1} and so on. The @code{VISIT} type is an enumeration type.
+@comment search.h
+@comment SVID
@deftp {Data Type} VISIT
The @code{VISIT} value indicates the status of the current node in the
tree and how the function is called. The status of a node is either
@@ -601,15 +605,23 @@ after both children are processed. This makes it possible to handle all
three methods of tree traversal (or even a combination of them).
@vtable @code
+@comment search.h
+@comment SVID
@item preorder
The current node is an internal node and the function is called before
the first child was processed.
+@comment search.h
+@comment SVID
@item postorder
The current node is an internal node and the function is called after
the first child was processed.
+@comment search.h
+@comment SVID
@item endorder
The current node is an internal node and the function is called after
the second child was processed.
+@comment search.h
+@comment SVID
@item leaf
The current node is a leaf.
@end vtable
diff --git a/manual/signal.texi b/manual/signal.texi
index d6a1bfe..08ada58 100644
--- a/manual/signal.texi
+++ b/manual/signal.texi
@@ -1002,6 +1002,8 @@ The second argument, @var{action}, specifies the action to use for the
signal @var{signum}. This can be one of the following:
@table @code
+@comment signal.h
+@comment ISO
@item SIG_DFL
@vindex SIG_DFL
@cindex default action for a signal
@@ -1009,6 +1011,8 @@ signal @var{signum}. This can be one of the following:
The default actions for various kinds of signals are stated in
@ref{Standard Signals}.
+@comment signal.h
+@comment ISO
@item SIG_IGN
@vindex SIG_IGN
@cindex ignore action for a signal
@@ -3183,10 +3187,14 @@ There are two macros defined in @file{signal.h} that you should use in
calculating this size:
@vtable @code
+@comment signal.h
+@comment XOPEN
@item SIGSTKSZ
This is the canonical size for a signal stack. It is judged to be
sufficient for normal uses.
+@comment signal.h
+@comment XOPEN
@item MINSIGSTKSZ
This is the amount of signal stack space the operating system needs just
to implement signal delivery. The size of a signal stack @strong{must}
@@ -3203,9 +3211,13 @@ stack and increase @code{ss_size} accordingly.
This field contains the bitwise @sc{or} of these flags:
@vtable @code
+@comment signal.h
+@comment XOPEN
@item SS_DISABLE
This tells the system that it should not use the signal stack.
+@comment signal.h
+@comment XOPEN
@item SS_ONSTACK
This is set by the system, and indicates that the signal stack is
currently in use. If this bit is not set, then signals will be
diff --git a/manual/socket.texi b/manual/socket.texi
index 25d9276..32073fb 100644
--- a/manual/socket.texi
+++ b/manual/socket.texi
@@ -493,6 +493,7 @@ The following functions, constants and data types are declared in the
header file @file{net/if.h}.
@comment net/if.h
+@comment MISC
@deftypevr Constant size_t IFNAMSIZ
This constant defines the maximum buffer size needed to hold an
interface name, including its terminating zero byte.
@@ -822,6 +823,8 @@ When you call @code{bind} or @code{getsockname}, you should specify
@code{sizeof (struct sockaddr_in)} as the @var{length} parameter if
you are using an IPv4 Internet namespace socket address.
+@comment netinet/in.h
+@comment IPv6 Basic API
@deftp {Data Type} {struct sockaddr_in6}
This is the data type used to represent socket addresses in the IPv6
namespace. It has the following members:
diff --git a/manual/startup.texi b/manual/startup.texi
index e4c983a..070ce3d 100644
--- a/manual/startup.texi
+++ b/manual/startup.texi
@@ -220,6 +220,7 @@ programming of code like this the function @code{getsubopt} is
available.
@comment stdlib.h
+@comment XPG4 || POSIX.1-2008
@deftypefun int getsubopt (char **@var{optionp}, char *const *@var{tokens}, char **@var{valuep})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c getsubopt ok
@@ -666,6 +667,7 @@ basis there may be information that is not available any other way.
@subsection Definition of @code{getauxval}
@comment sys/auxv.h
+@comment GNU
@deftypefun {unsigned long int} getauxval (unsigned long int @var{type})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c Reads from hwcap or iterates over constant auxv.
diff --git a/manual/stdio.texi b/manual/stdio.texi
index dbb21ca..fc15202 100644
--- a/manual/stdio.texi
+++ b/manual/stdio.texi
@@ -682,17 +682,23 @@ reinstated using this function. There are three values defined for the
@var{type} parameter.
@vtable @code
+@comment stdio_ext.h
+@comment SunOS
@item FSETLOCKING_INTERNAL
The stream @code{stream} will from now on use the default internal
locking. Every stream operation with exception of the @code{_unlocked}
variants will implicitly lock the stream.
+@comment stdio_ext.h
+@comment SunOS
@item FSETLOCKING_BYCALLER
After the @code{__fsetlocking} function returns, the user is responsible
for locking the stream. None of the stream operations will implicitly
do this anymore until the state is set back to
@code{FSETLOCKING_INTERNAL}.
+@comment stdio_ext.h
+@comment SunOS
@item FSETLOCKING_QUERY
@code{__fsetlocking} only queries the current locking state of the
stream. The return value will be @code{FSETLOCKING_INTERNAL} or
@@ -1792,6 +1798,8 @@ The @var{param-no} parts of the format must be integers in the range of
implementations limit this number to a certain upper bound. The exact
limit can be retrieved by the following constant.
+@comment limits.h
+@comment XOPEN
@defvr Macro NL_ARGMAX
The value of @code{NL_ARGMAX} is the maximum value allowed for the
specification of a positional parameter in a @code{printf} call. The
@@ -5367,8 +5375,12 @@ bitwise OR combined if wanted, for the @var{classification} parameter of
@code{fmtmsg}:
@vtable @code
+@comment fmtmsg.h
+@comment ???
@item MM_PRINT
Display the message in standard error.
+@comment fmtmsg.h
+@comment ???
@item MM_CONSOLE
Display the message on the system console.
@end vtable
@@ -5378,10 +5390,16 @@ following values which also is bitwise ORed with the
@var{classification} parameter to @code{fmtmsg}:
@vtable @code
+@comment fmtmsg.h
+@comment ???
@item MM_HARD
The source of the condition is some hardware.
+@comment fmtmsg.h
+@comment ???
@item MM_SOFT
The source of the condition is some software.
+@comment fmtmsg.h
+@comment ???
@item MM_FIRM
The source of the condition is some firmware.
@end vtable
@@ -5391,10 +5409,16 @@ can describe the part of the system which detects the problem. This is
done by using exactly one of the following values:
@vtable @code
+@comment fmtmsg.h
+@comment ???
@item MM_APPL
The erroneous condition is detected by the application.
+@comment fmtmsg.h
+@comment ???
@item MM_UTIL
The erroneous condition is detected by a utility.
+@comment fmtmsg.h
+@comment ???
@item MM_OPSYS
The erroneous condition is detected by the operating system.
@end vtable
@@ -5403,8 +5427,12 @@ A last component of @var{classification} can signal the results of this
message. Exactly one of the following values can be used:
@vtable @code
+@comment fmtmsg.h
+@comment ???
@item MM_RECOVER
It is a recoverable error.
+@comment fmtmsg.h
+@comment ???
@item MM_NRECOV
It is a non-recoverable error.
@end vtable
@@ -5428,17 +5456,29 @@ Each of the parameters can be a special value which means this value
is to be omitted. The symbolic names for these values are:
@vtable @code
+@comment fmtmsg.h
+@comment ???
@item MM_NULLLBL
Ignore @var{label} parameter.
+@comment fmtmsg.h
+@comment ???
@item MM_NULLSEV
Ignore @var{severity} parameter.
+@comment fmtmsg.h
+@comment ???
@item MM_NULLMC
Ignore @var{classification} parameter. This implies that nothing is
actually printed.
+@comment fmtmsg.h
+@comment ???
@item MM_NULLTXT
Ignore @var{text} parameter.
+@comment fmtmsg.h
+@comment ???
@item MM_NULLACT
Ignore @var{action} parameter.
+@comment fmtmsg.h
+@comment ???
@item MM_NULLTAG
Ignore @var{tag} parameter.
@end vtable
@@ -5452,14 +5492,24 @@ table:
@cindex severity class
@vtable @code
+@comment fmtmsg.h
+@comment ???
@item MM_NOSEV
Nothing is printed, this value is the same as @code{MM_NULLSEV}.
+@comment fmtmsg.h
+@comment ???
@item MM_HALT
This value is printed as @code{HALT}.
+@comment fmtmsg.h
+@comment ???
@item MM_ERROR
This value is printed as @code{ERROR}.
+@comment fmtmsg.h
+@comment ???
@item MM_WARNING
This value is printed as @code{WARNING}.
+@comment fmtmsg.h
+@comment ???
@item MM_INFO
This value is printed as @code{INFO}.
@end vtable
@@ -5552,6 +5602,8 @@ introducing new classes in a running program. One could use the
@code{setenv} or @code{putenv} function to set the environment variable,
but this is toilsome.
+@comment fmtmsg.h
+@comment MISC
@deftypefun int addseverity (int @var{severity}, const char *@var{string})
@safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{} @asulock{}}@acunsafe{@aculock{} @acsmem{}}}
This function allows the introduction of new severity classes which can be
diff --git a/manual/string.texi b/manual/string.texi
index 1986357..683a20f 100644
--- a/manual/string.texi
+++ b/manual/string.texi
@@ -574,6 +574,7 @@ including the terminating null wide character) into the string
the strings overlap. The return value is the value of @var{wto}.
@end deftypefun
+@comment string.h
@comment SVID
@deftypefun {char *} strdup (const char *@var{s})
@safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{}}@acunsafe{@acsmem{}}}
@@ -884,6 +885,7 @@ in their header conventions. @xref{Copying Strings and Arrays}. The
and the @samp{wc} functions are declared in the file @file{wchar.h}.
@comment string.h
+@comment C90
@deftypefun {char *} strncpy (char *restrict @var{to}, const char *restrict @var{from}, size_t @var{size})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
This function is similar to @code{strcpy} but always copies exactly
diff --git a/manual/sysinfo.texi b/manual/sysinfo.texi
index 9a8b79d..1a10013 100644
--- a/manual/sysinfo.texi
+++ b/manual/sysinfo.texi
@@ -457,15 +457,25 @@ filesystem is mounted. @file{fstab} defines five macros to describe the
possible values:
@vtable @code
+@comment fstab.h
+@comment BSD
@item FSTAB_RW
The filesystem gets mounted with read and write enabled.
+@comment fstab.h
+@comment BSD
@item FSTAB_RQ
The filesystem gets mounted with read and write enabled. Write access
is restricted by quotas.
+@comment fstab.h
+@comment BSD
@item FSTAB_RO
The filesystem gets mounted read-only.
+@comment fstab.h
+@comment BSD
@item FSTAB_SW
This is not a real filesystem, it is a swap device.
+@comment fstab.h
+@comment BSD
@item FSTAB_XX
This entry from the @file{fstab} file is totally ignored.
@end vtable
@@ -618,13 +628,19 @@ name one also knows the filesystem name. Nevertheless here follows the
list of the symbols provided in @file{mntent.h}.
@vtable @code
+@comment mntent.h
+@comment ???
@item MNTTYPE_IGNORE
This symbol expands to @code{"ignore"}. The value is sometimes used in
@file{fstab} files to make sure entries are not used without removing them.
+@comment mntent.h
+@comment ???
@item MNTTYPE_NFS
Expands to @code{"nfs"}. Using this macro sometimes could make sense
since it names the default NFS implementation, in case both version 2
and 3 are supported.
+@comment mntent.h
+@comment ???
@item MNTTYPE_SWAP
This symbol expands to @code{"swap"}. It names the special @file{fstab}
entry which names one of the possibly multiple swap partitions.
@@ -642,23 +658,35 @@ might be many more options which are possible so it doesn't make much sense
to rely on these macros but to be consistent here is the list:
@vtable @code
+@comment mntent.h
+@comment ???
@item MNTOPT_DEFAULTS
Expands to @code{"defaults"}. This option should be used alone since it
indicates all values for the customizable values are chosen to be the
default.
+@comment mntent.h
+@comment ???
@item MNTOPT_RO
Expands to @code{"ro"}. See the @code{FSTAB_RO} value, it means the
filesystem is mounted read-only.
+@comment mntent.h
+@comment ???
@item MNTOPT_RW
Expands to @code{"rw"}. See the @code{FSTAB_RW} value, it means the
filesystem is mounted with read and write permissions.
+@comment mntent.h
+@comment ???
@item MNTOPT_SUID
Expands to @code{"suid"}. This means that the SUID bit (@pxref{How
Change Persona}) is respected when a program from the filesystem is
started.
+@comment mntent.h
+@comment ???
@item MNTOPT_NOSUID
Expands to @code{"nosuid"}. This is the opposite of @code{MNTOPT_SUID},
the SUID bit for all files from the filesystem is ignored.
+@comment mntent.h
+@comment ???
@item MNTOPT_NOAUTO
Expands to @code{"noauto"}. At startup time the @code{mount} program
will ignore this entry if it is started with the @code{-a} option to
@@ -913,11 +941,15 @@ file accesses via @code{ioctl}.
following mask and masked value macros:
@vtable @code
+@comment sys/mount.h
+@comment Linux
@item MS_MGC_MASK
This multibit field contains a magic number. If it does not have the value
@code{MS_MGC_VAL}, @code{mount} assumes all the following bits are zero and
the @var{data} argument is a null string, regardless of their actual values.
+@comment sys/mount.h
+@comment Linux
@item MS_REMOUNT
This bit on means to remount the filesystem. Off means to mount it.
@c There is a mask MS_RMT_MASK in mount.h that says only two of the options
@@ -925,36 +957,52 @@ This bit on means to remount the filesystem. Off means to mount it.
@c MS_RMT_MASK that says they all can be reset. As far as I can tell,
@c libc just passes the arguments straight through to the kernel.
+@comment sys/mount.h
+@comment Linux
@item MS_RDONLY
This bit on specifies that no writing to the filesystem shall be allowed
while it is mounted. This cannot be overridden by @code{ioctl}. This
option is available on nearly all filesystems.
+@comment sys/mount.h
+@comment Linux
@item MS_NOSUID
This bit on specifies that Setuid and Setgid permissions on files in the
filesystem shall be ignored while it is mounted.
+@comment sys/mount.h
+@comment Linux
@item MS_NOEXEC
This bit on specifies that no files in the filesystem shall be executed
while the filesystem is mounted.
+@comment sys/mount.h
+@comment Linux
@item MS_NODEV
This bit on specifies that no device special files in the filesystem
shall be accessible while the filesystem is mounted.
+@comment sys/mount.h
+@comment Linux
@item MS_SYNCHRONOUS
This bit on specifies that all writes to the filesystem while it is
mounted shall be synchronous; i.e., data shall be synced before each
write completes rather than held in the buffer cache.
+@comment sys/mount.h
+@comment Linux
@item MS_MANDLOCK
This bit on specifies that mandatory locks on files shall be permitted while
the filesystem is mounted.
+@comment sys/mount.h
+@comment Linux
@item MS_NOATIME
This bit on specifies that access times of files shall not be updated when
the files are accessed while the filesystem is mounted.
+@comment sys/mount.h
+@comment Linux
@item MS_NODIRATIME
This bit on specifies that access times of directories shall not be updated
when the directories are accessed while the filesystem in mounted.
@@ -1068,6 +1116,8 @@ mask macro:
@vtable @code
+@comment sys/mount.h
+@comment Linux
@item MNT_FORCE
This bit on means to force the unmounting even if the filesystem is
busy, by making it unbusy first. If the bit is off and the filesystem is
diff --git a/manual/syslog.texi b/manual/syslog.texi
index 7b73a09..ab051f9 100644
--- a/manual/syslog.texi
+++ b/manual/syslog.texi
@@ -222,12 +222,16 @@ implicitly and uses defaults for the information in @var{ident} and
single bit masks:
@vtable @code
+@comment sys/syslog.h
+@comment BSD
@item LOG_PERROR
If on, @code{openlog} sets up the connection so that any @code{syslog}
on this connection writes its message to the calling process' Standard
Error stream in addition to submitting it to Syslog. If off, @code{syslog}
does not write the message to Standard Error.
+@comment sys/syslog.h
+@comment BSD
@item LOG_CONS
If on, @code{openlog} sets up the connection so that a @code{syslog} on
this connection that fails to submit a message to Syslog writes the
@@ -235,11 +239,15 @@ message instead to system console. If off, @code{syslog} does not write
to the system console (but of course Syslog may write messages it
receives to the console).
+@comment sys/syslog.h
+@comment BSD
@item LOG_PID
When on, @code{openlog} sets up the connection so that a @code{syslog}
on this connection inserts the calling process' Process ID (PID) into
the message. When off, @code{openlog} does not insert the PID.
+@comment sys/syslog.h
+@comment BSD
@item LOG_NDELAY
When on, @code{openlog} opens and connects the @file{/dev/log} socket.
When off, a future @code{syslog} call must open and connect the socket.
@@ -247,6 +255,8 @@ When off, a future @code{syslog} call must open and connect the socket.
@strong{Portability note:} In early systems, the sense of this bit was
exactly the opposite.
+@comment sys/syslog.h
+@comment BSD
@item LOG_ODELAY
This bit does nothing. It exists for backward compatibility.
@@ -338,42 +348,80 @@ The possible values for the facility code are (macros):
@c if you try to use it here, just selects default.
@vtable @code
+@comment sys/syslog.h
+@comment BSD
@item LOG_USER
A miscellaneous user process
+@comment sys/syslog.h
+@comment BSD
@item LOG_MAIL
Mail
+@comment sys/syslog.h
+@comment BSD
@item LOG_DAEMON
A miscellaneous system daemon
+@comment sys/syslog.h
+@comment BSD
@item LOG_AUTH
Security (authorization)
+@comment sys/syslog.h
+@comment BSD
@item LOG_SYSLOG
Syslog
+@comment sys/syslog.h
+@comment BSD
@item LOG_LPR
Central printer
+@comment sys/syslog.h
+@comment BSD
@item LOG_NEWS
Network news (e.g. Usenet)
+@comment sys/syslog.h
+@comment BSD
@item LOG_UUCP
UUCP
+@comment sys/syslog.h
+@comment BSD
@item LOG_CRON
Cron and At
+@comment sys/syslog.h
+@comment BSD
@item LOG_AUTHPRIV
Private security (authorization)
+@comment sys/syslog.h
+@comment BSD
@item LOG_FTP
Ftp server
+@comment sys/syslog.h
+@comment BSD
@item LOG_LOCAL0
Locally defined
+@comment sys/syslog.h
+@comment BSD
@item LOG_LOCAL1
Locally defined
+@comment sys/syslog.h
+@comment BSD
@item LOG_LOCAL2
Locally defined
+@comment sys/syslog.h
+@comment BSD
@item LOG_LOCAL3
Locally defined
+@comment sys/syslog.h
+@comment BSD
@item LOG_LOCAL4
Locally defined
+@comment sys/syslog.h
+@comment BSD
@item LOG_LOCAL5
Locally defined
+@comment sys/syslog.h
+@comment BSD
@item LOG_LOCAL6
Locally defined
+@comment sys/syslog.h
+@comment BSD
@item LOG_LOCAL7
Locally defined
@end vtable
@@ -393,20 +441,36 @@ Syslog connection was opened. @xref{Syslog Example}.
The possible values for the priority code are (macros):
@vtable @code
+@comment sys/syslog.h
+@comment BSD
@item LOG_EMERG
The message says the system is unusable.
+@comment sys/syslog.h
+@comment BSD
@item LOG_ALERT
Action on the message must be taken immediately.
+@comment sys/syslog.h
+@comment BSD
@item LOG_CRIT
The message states a critical condition.
+@comment sys/syslog.h
+@comment BSD
@item LOG_ERR
The message describes an error.
+@comment sys/syslog.h
+@comment BSD
@item LOG_WARNING
The message is a warning.
+@comment sys/syslog.h
+@comment BSD
@item LOG_NOTICE
The message describes a normal but important event.
+@comment sys/syslog.h
+@comment BSD
@item LOG_INFO
The message is purely informational.
+@comment sys/syslog.h
+@comment BSD
@item LOG_DEBUG
The message is only for debugging purposes.
@end vtable
diff --git a/manual/terminal.texi b/manual/terminal.texi
index 0c5fdd1..46b21e2 100644
--- a/manual/terminal.texi
+++ b/manual/terminal.texi
@@ -1843,14 +1843,20 @@ following values:
@c Extra blank lines here make it look better.
@vtable @code
+@comment termios.h
+@comment POSIX.1
@item TCIFLUSH
Clear any input data received, but not yet read.
+@comment termios.h
+@comment POSIX.1
@item TCOFLUSH
Clear any output data written, but not yet transmitted.
+@comment termios.h
+@comment POSIX.1
@item TCIOFLUSH
Clear both queued input and output.
@@ -1895,15 +1901,23 @@ The @var{action} argument specifies what operation to perform, and can
be one of the following values:
@vtable @code
+@comment termios.h
+@comment POSIX.1
@item TCOOFF
Suspend transmission of output.
+@comment termios.h
+@comment POSIX.1
@item TCOON
Restart transmission of output.
+@comment termios.h
+@comment POSIX.1
@item TCIOFF
Transmit a STOP character.
+@comment termios.h
+@comment POSIX.1
@item TCION
Transmit a START character.
@end vtable
diff --git a/manual/time.texi b/manual/time.texi
index dccb979..bad9ce6 100644
--- a/manual/time.texi
+++ b/manual/time.texi
@@ -981,6 +981,8 @@ precision clocks.
These functions are declared in @file{sys/timex.h}.
@tindex struct ntptimeval
+@comment sys/timex.h
+@comment Linux
@deftp {Data Type} {struct ntptimeval}
This structure is used for information about the system clock. It
contains the following members:
@@ -1017,6 +1019,8 @@ The return value is @code{0} on success and other values on failure. The
following @code{errno} error conditions are defined for this function:
@vtable @code
+@comment sys/timex.h
+@comment Linux
@item TIME_ERROR
The precision clock model is not properly set up at the moment, thus the
clock must be considered unsynchronized, and the values should be
@@ -1025,6 +1029,8 @@ treated with care.
@end deftypefun
@tindex struct timex
+@comment timex.h
+@comment Linux
@deftp {Data Type} {struct timex}
This structure is used to control and monitor the system clock. It
contains the following members:
diff --git a/manual/users.texi b/manual/users.texi
index 47e28fe..1cae402 100644
--- a/manual/users.texi
+++ b/manual/users.texi
@@ -1013,6 +1013,8 @@ The exit status of the process.
@end table
@end deftp
+@comment utmp.h
+@comment SVID
@deftp {Data Type} {struct utmp}
The @code{utmp} data structure is used to hold information about entries
in the user accounting database. On @gnusystems{} it has the following
@@ -1445,10 +1447,14 @@ default @code{getutent}, @code{getutid}, @code{getutline} and
The following macros are defined for use as the @var{file} argument:
+@comment paths.h
+@comment BSD
@deftypevr Macro {char *} _PATH_UTMP
This macro is used to specify the user accounting database.
@end deftypevr
+@comment paths.h
+@comment BSD
@deftypevr Macro {char *} _PATH_WTMP
This macro is used to specify the user accounting log file.
@end deftypevr
@@ -1501,6 +1507,8 @@ These functions, described in the X/Open Portability Guide, are declared
in the header file @file{utmpx.h}.
@pindex utmpx.h
+@comment utmpx.h
+@comment XPG4.2
@deftp {Data Type} {struct utmpx}
The @code{utmpx} data structure contains at least the following members: