Add documentation chapter about the glibc header files.

[gnulib.git] / doc / glibc-headers / shadow.texi

diff --git a/doc/glibc-headers/shadow.texi b/doc/glibc-headers/shadow.texi
new file mode 100644 (file)
index 0000000..886f6cd
--- /dev/null
+++ b/doc/glibc-headers/shadow.texi
@@ -0,0 +1,39 @@
+@node shadow.h
+@section @file{shadow.h}
+
+Defines the type @code{struct spwd} and declares the functions
+@code{setspent}, @code{endspent},
+@code{getspent}, @code{getspent_r},
+@code{getspnam}, @code{getspnam_r},
+@code{sgetspent}, @code{sgetspent_r},
+@code{fgetspent}, @code{fgetspent_r},
+@code{putspent},
+@code{lckpwdf}, @code{ulckpwdf}.
+
+Documentation:
+@itemize
+@item
+@uref{http://www.kernel.org/doc/man-pages/online/pages/man3/setspent.3.html,,man setspent}.
+@end itemize
+
+Gnulib module: ---
+
+Portability problems fixed by Gnulib:
+@itemize
+@end itemize
+
+Portability problems not fixed by Gnulib:
+@itemize
+@item
+This header file is missing on some platforms:
+MacOS X 10.3, FreeBSD 6.0, NetBSD 3.0, OpenBSD 3.8, AIX 5.1, OSF/1 5.1, Cygwin, mingw, Interix 3.5, BeOS.
+@item
+The functions @code{getspent_r}, @code{getspnam_r}, @code{sgetspent_r},
+@code{fgetspent}, @code{fgetspent_r}, @code{putspent} are missing on some
+platforms:
+HP-UX 11.
+@item
+The functions @code{sgetspent}, @code{sgetspent_r} are missing on some
+platforms:
+IRIX 6.5, Solaris 10.
+@end itemize