From d597239cbd77e80b82b77956f366eaeed94b6dd5 Mon Sep 17 00:00:00 2001 From: Michael Kerrisk Date: Fri, 18 May 2007 10:30:02 +0000 Subject: [PATCH] Relocated GLIBC NOTES as subsection under NOTES --- man2/epoll_wait.2 | 5 ++-- man2/faccessat.2 | 8 +++--- man2/futimesat.2 | 3 ++- man2/gethostname.2 | 2 +- man3/crypt.3 | 3 ++- man3/euidaccess.3 | 3 ++- man3/fenv.3 | 3 ++- man3/fopen.3 | 3 ++- man3/getutent.3 | 3 ++- man3/inet.3 | 2 +- man3/sigsetops.3 | 3 ++- man3/strftime.3 | 5 ++-- man3/strptime.3 | 62 +++++++++++++++++++++++----------------------- 13 files changed, 57 insertions(+), 48 deletions(-) diff --git a/man2/epoll_wait.2 b/man2/epoll_wait.2 index ae023a232..9637475f9 100644 --- a/man2/epoll_wait.2 +++ b/man2/epoll_wait.2 @@ -129,9 +129,10 @@ executing the following calls: .SH VERSIONS .BR epoll_pwait () was added to Linux in kernel 2.6.19. -.SH GLIBC NOTES +.SH NOTES +.SS Glibc Notes Support for -.BR epoll_wait () +.BR epoll_pwait () is provided starting with glibc 2.6. .SH "RETURN VALUE" When successful, diff --git a/man2/faccessat.2 b/man2/faccessat.2 index e3b44c1c4..140710546 100644 --- a/man2/faccessat.2 +++ b/man2/faccessat.2 @@ -119,10 +119,7 @@ See .BR openat (2) for an explanation of the need for .BR faccessat (). -.SH "CONFORMING TO" -This system call is non-standard but is proposed -for inclusion in a future revision of POSIX.1. -.SH GLIBC NOTES +.SS Glibc Notes The .B AT_EACCESS and @@ -135,6 +132,9 @@ to determine access permissions. .SH VERSIONS .BR faccessat () was added to Linux in kernel 2.6.16. +.SH "CONFORMING TO" +This system call is non-standard but is proposed +for inclusion in a future revision of POSIX.1. .SH "SEE ALSO" .BR access (2), .BR openat (2), diff --git a/man2/futimesat.2 b/man2/futimesat.2 index 78fa84172..614366c17 100644 --- a/man2/futimesat.2 +++ b/man2/futimesat.2 @@ -97,7 +97,8 @@ is a file descriptor referring to a file other than a directory. This system call is non-standard but is proposed for inclusion in a future revision of POSIX.1. A similar system call exists on Solaris. -.SH GLIBC NOTES +.SH NOTES +.SS Glibc Notes If .I pathname is NULL, then the glibc diff --git a/man2/gethostname.2 b/man2/gethostname.2 index bd83c7f1d..2b6893d5a 100644 --- a/man2/gethostname.2 +++ b/man2/gethostname.2 @@ -89,7 +89,7 @@ but not SUSv2 guarantees that `Host names are limited to 255 bytes'. POSIX.1-2001 guarantees that `Host names (not including the terminating null byte) are limited to HOST_NAME_MAX bytes'. -.SH "GLIBC NOTES" +.SS Glibc Notes The GNU C library implements .BR gethostname () as a library function that calls diff --git a/man3/crypt.3 b/man3/crypt.3 index 3ef5d627b..31d943c79 100644 --- a/man3/crypt.3 +++ b/man3/crypt.3 @@ -135,7 +135,8 @@ function was not implemented, probably because of U.S.A. export restrictions. .\" .PP .\" Making encrypted data computed using crypt() publicly available has .\" to be considered insecure for the given reasons. -.SH GLIBC NOTES +.SH NOTES +.SS Glibc Notes The glibc2 version of this function has the following additional features. If .I salt diff --git a/man3/euidaccess.3 b/man3/euidaccess.3 index f21a5ec0d..1f0acda0b 100644 --- a/man3/euidaccess.3 +++ b/man3/euidaccess.3 @@ -72,7 +72,8 @@ Some other systems have an .\" e.g., FreeBSD 6.1. .BR eaccess () function. -.SH "GLIBC NOTES" +.SH NOTES +.SS Glibc Notes The .BR eaccess () function was added to glibc in version 2.4. diff --git a/man3/fenv.3 b/man3/fenv.3 index 466ace158..2d5ac479d 100644 --- a/man3/fenv.3 +++ b/man3/fenv.3 @@ -207,7 +207,8 @@ These functions return zero on success and non-zero if an error occurred. .\" Earlier seven of these functions were listed as returning void. .\" This was corrected in Corrigendum 1 (ISO/IEC 9899:1999/Cor.1:2001(E)) .\" of the C99 Standard. -.SH GLIBC NOTES +.SH NOTES +.SS Glibc Notes If possible, the GNU C Library defines a macro .B FE_NOMASK_ENV which represents an environment where every exception raised causes a diff --git a/man3/fopen.3 b/man3/fopen.3 index 4815449f1..d524496f3 100644 --- a/man3/fopen.3 +++ b/man3/fopen.3 @@ -236,7 +236,8 @@ functions conform to C89. The .BR fdopen () function conforms to POSIX.1-1990. -.SH "GLIBC NOTES" +.SH NOTES +.SS Glibc Notes The GNU C library allows the following extensions for the string specified in .IR mode : .TP diff --git a/man3/getutent.3 b/man3/getutent.3 index f9638f0ab..6f14e969a 100644 --- a/man3/getutent.3 +++ b/man3/getutent.3 @@ -110,7 +110,8 @@ and return a pointer to a \fBstruct utmp\fP on success, and NULL on failure. This \fBstruct utmp\fP is allocated in static storage, and may be overwritten by subsequent calls. -.SH GLIBC NOTES +.SH NOTES +.SS Glibc Notes The above functions are not thread-safe. Glibc adds reentrant versions .sp diff --git a/man3/inet.3 b/man3/inet.3 index 0e3688724..772ac574a 100644 --- a/man3/inet.3 +++ b/man3/inet.3 @@ -141,7 +141,7 @@ be aware that each number will be interpreted as octal if preceded by a 0 and as hexadecimal if preceded by 0x. For example, \fBinet_aton("226.000.000.037", &t)\fP will interpret the address as \fI226.0.0.31\fP and not \fI226.0.0.37\fP. -.SH "GLIBC NOTES" +.SS Glibc Notes In order to expose the declaration of .BR inet_aton (), one of the feature test macros _BSD_SOURCE, _SVID_SOURCE, or diff --git a/man3/sigsetops.3 b/man3/sigsetops.3 index c3e05e0b8..d1333fa51 100644 --- a/man3/sigsetops.3 +++ b/man3/sigsetops.3 @@ -91,7 +91,8 @@ is not a member, and \-1 on error. is not a valid signal. .SH "CONFORMING TO" POSIX.1-2001. -.SH "GLIBC NOTES" +.SH NOTES +.SS Glibc Notes If the _GNU_SOURCE feature test macro is defined, then exposes three other functions for manipulating signal sets. diff --git a/man3/strftime.3 b/man3/strftime.3 index 30bb02eb3..22cfbcc0d 100644 --- a/man3/strftime.3 +++ b/man3/strftime.3 @@ -29,7 +29,7 @@ .\" Applied fix by Wolfgang Franke, aeb, 961011 .\" Corrected return value, aeb, 970307 .\" Added Single Unix Spec conversions and %z, aeb/esr, 990329. -.\" 2005-11-22 mtk, added GLIBC NOTES covering optional 'flag' and +.\" 2005-11-22 mtk, added Glibc Notes covering optional 'flag' and .\" 'width' components of conversion specifications. .\" .TH STRFTIME 3 2005-11-23 "GNU" "Linux Programmer's Manual" @@ -273,7 +273,8 @@ In SUSv2, the %S specified allowed a range of 00 to 61, to allow for the theoretical possibility of a minute that included a double leap second (there never has been such a minute). -.SH GLIBC NOTES +.SH NOTES +.SS Glibc Notes Glibc provides some extensions for conversion specifications. (These extensions are not specified in POSIX.1-2001, but a few other systems provide similar features.) diff --git a/man3/strptime.3 b/man3/strptime.3 index 3c2df130d..0bd18adef 100644 --- a/man3/strptime.3 +++ b/man3/strptime.3 @@ -295,7 +295,37 @@ main(void) exit(EXIT_SUCCESS); } .fi -.SH GLIBC NOTES +.SH NOTES +.LP +In principle, this function does not initialize \fBtm\fP but +only stores the values specified. +This means that \fBtm\fP should be initialized before the call. +Details differ a bit between different Unix systems. +The GNU libc implementation does not touch those fields which are not +explicitly specified, except that it recomputes the +.IR tm_wday +and +.IR tm_yday +field if any of the year, month, or day elements changed. +.PP +This function is available since libc 4.6.8. +Linux libc4 and libc5 includes define the prototype unconditionally; +glibc2 includes provide a prototype only when _XOPEN_SOURCE or _GNU_SOURCE +are defined. +.PP +Before libc 5.4.13 whitespace (and the 'n' and 't' specifications) +was not handled, no 'E' and 'O' locale modifier characters were accepted, +and the 'C' specification was a synonym for the 'c' specification. +.PP +The 'y' (year in century) specification is taken to specify a year +in the 20th century by libc4 and libc5. +It is taken to be a year +in the range 1950-2049 by glibc 2.0. +It is taken to be a year in +1969-2068 since glibc 2.1. +.\" In libc4 and libc5 the code for %I is broken (fixed in glibc; +.\" %OI was fixed in glibc 2.2.4). +.SS Glibc Notes For reasons of symmetry, glibc tries to support for .BR strptime () the same format characters as for @@ -342,36 +372,6 @@ Leap seconds are not counted unless leap second support is available. .LP The GNU libc implementation does not require whitespace between two field descriptors. -.SH NOTES -.LP -In principle, this function does not initialize \fBtm\fP but -only stores the values specified. -This means that \fBtm\fP should be initialized before the call. -Details differ a bit between different Unix systems. -The GNU libc implementation does not touch those fields which are not -explicitly specified, except that it recomputes the -.IR tm_wday -and -.IR tm_yday -field if any of the year, month, or day elements changed. -.PP -This function is available since libc 4.6.8. -Linux libc4 and libc5 includes define the prototype unconditionally; -glibc2 includes provide a prototype only when _XOPEN_SOURCE or _GNU_SOURCE -are defined. -.PP -Before libc 5.4.13 whitespace (and the 'n' and 't' specifications) -was not handled, no 'E' and 'O' locale modifier characters were accepted, -and the 'C' specification was a synonym for the 'c' specification. -.PP -The 'y' (year in century) specification is taken to specify a year -in the 20th century by libc4 and libc5. -It is taken to be a year -in the range 1950-2049 by glibc 2.0. -It is taken to be a year in -1969-2068 since glibc 2.1. -.\" In libc4 and libc5 the code for %I is broken (fixed in glibc; -.\" %OI was fixed in glibc 2.2.4). .SH "SEE ALSO" .BR time (2), .BR getdate (3),