]> pd.if.org Git - pdclib.old/blobdiff - man3/pdclib.3
Manual pages: renmae man->man3 to follow existing conventions. Add files _Exit.3...
[pdclib.old] / man3 / pdclib.3
diff --git a/man3/pdclib.3 b/man3/pdclib.3
new file mode 100644 (file)
index 0000000..f0f90a4
--- /dev/null
@@ -0,0 +1,95 @@
+.\" This file is part of the Public Domain C Library (PDCLib).\r
+.\" Permission is granted to use, modify, and / or redistribute at will.\r
+.\"\r
+.Dd\r
+.Dt PDCLIB 3\r
+.Os\r
+\r
+.Sh NAME\r
+.Nm PDCLib\r
+.Nd Public domain, portable C library\r
+\r
+.Sh LIBRARY\r
+.Lb pdclib\r
+.Sh SYNOPSIS\r
+.In assert.h\r
+.In ctype.h\r
+.In errno.h\r
+.In inttypes.h\r
+.In iso646.h\r
+.In limits.h\r
+.In locale.h\r
+.In signal.h\r
+.In stdarg.h\r
+.In stdbool.h\r
+.In stddef.h\r
+.In stdint.h\r
+.In stdio.h\r
+.In stdlib.h\r
+.In stdnoreturn.h\r
+.In string.h\r
+.In threads.h\r
+.In time.h\r
+\r
+.Sh DESCRIPTION\r
+The\r
+.Nm\r
+library is a portable, public domain C library. It aims at full conformance with\r
+ISO C89, C95, C99 and C11 when used in combination with a conformant compiler. \r
+In addition, it aims at conformance with the portion of ISO C++97 and C++2011 \r
+which is derived from said standards.\r
+.Pp\r
+.Nm\r
+aims for strict conformance with the selected C/C++ standard. Therefore, unlike\r
+most C libraries, it does not by default expose any extensions. Some extensions\r
+(from POSIX or the Single Unix Specification) can be selected by defining the \r
+appropriate feature selection macro, such as \r
+.Dv _POSIX_C_SOURCE\r
+or\r
+.Dv _XOPEN_SOURCE\r
+to the appropriate value. For example, in the following definition:\r
+.Bd -offset indent\r
+.Sy #define _XOPEN_SOURCE || _POSIX_C_SOURCE >= 200809L\r
+.br\r
+.Sy #include\r
+.In string.h\r
+.br\r
+.Fn "char * strdup" "const char *"\r
+.Ed\r
+\r
+it is documented that defining either \r
+.Dv _XOPEN_SOURCE\r
+or\r
+.Dv _POSIX_C_SOURCE\r
+to have a value greater than\r
+.Li 200809L\r
+before the first inclusion of\r
+.In string.h\r
+will expose a definition of the function\r
+.Fn strdup\r
+\r
+.Sh SEE ALSO\r
+.Xr cc 1 ,\r
+.Xr c++ 7\r
+.Sh STANDARDS\r
+When compiled with a C compiler, conformant with \r
+.St -isoC-90 ,\r
+.St -isoC-amd1 ,\r
+.St -isoC-tcor1 ,\r
+.St -isoC-tcor2 ,\r
+.St -isoC-99 or\r
+.St -isoC-2011\r
+as dependent upon the version of C the compiler declares conformance with.\r
+.Pp\r
+When compiled with a C++ compiler, conformant with ISO/IEC 14882:1997 or ISO/IEC\r
+14882:2011 "The C++ Programming Language" as dependent upon the version of C++\r
+the compiler declares conformance with.\r
+.Sh AUTHORS\r
+The\r
+.Nm\r
+library is maintained by by\r
+.An Owen Shepherd ,\r
+.Mt pdclib@owenshepherd.net .\r
+Based upon work by\r
+.An Martin "Solar" Baute ,\r
+.Mt solar@rootdirectory.de .\r