]> pd.if.org Git - pdclib/commitdiff
Add string.h man page
authorOwen Shepherd <owen.shepherd@e43.eu>
Tue, 14 Aug 2012 15:29:15 +0000 (16:29 +0100)
committerOwen Shepherd <owen.shepherd@e43.eu>
Tue, 14 Aug 2012 15:29:15 +0000 (16:29 +0100)
man/string.h.3 [new file with mode: 0644]

diff --git a/man/string.h.3 b/man/string.h.3
new file mode 100644 (file)
index 0000000..486d22e
--- /dev/null
@@ -0,0 +1,114 @@
+.\" 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 STRING.H 3\r
+.Os\r
+.\"\r
+.Sh NAME\r
+.Nm string.h\r
+.Nd byte string manipulation\r
+.\"\r
+.Sh SYNOPSIS\r
+.In string.h\r
+.\"\r
+.Sh DESCRIPTION\r
+The\r
+.In string.h\r
+header provides byte string manipulation operations.\r
+.\"\r
+.Pp\r
+The type\r
+.Vt size_t ,\r
+and the preprocessor constant\r
+.Dv NULL\r
+shall be defined.\r
+\r
+.Pp\r
+The following shall be defined as functions:\r
+.br\r
+.Fn "void *memcpy" "void *restrict dest" "const void *restrict src" "size_t byteCount" \r
+.br\r
+.Fn "void *memmove" "void *dest" "void *src" "size_t byteCount"\r
+.br\r
+.Fn "char *strcpy" "char *restrict dest" "const char *restrict src"\r
+.br\r
+.Fn "char *strncpy" "char *restrict dest" "const char *src" "size_t byteCount"\r
+.br\r
+.Fn "char *strcat" "char *restrict s1" "const char *restrict s2"\r
+.br\r
+.Fn "char *strncat" "char *restrict s1" "const char *restrict s2" "size_t n"\r
+.br\r
+.Fn "int memcmp" "const void *s1" "const void *s2" "size_t n"\r
+.br\r
+.Fn "int strcmp" "const char *s1" "const char *s2"\r
+.br\r
+.Fn "int strcoll" "const char *s1" "const char *s2"\r
+.br\r
+.Fn "int strncmp" "const char *s1" "const char *s2" "size_t n"\r
+.br\r
+.Fn "size_t strxfrm" "char *restrict s1" "const char *restrict s2" "size_t n"\r
+.br\r
+.Fn "void *memchr" "const void *s" "int c" "size_t n"\r
+.br\r
+.Fn "char *strchr" "const char *s" "int c"\r
+.br\r
+.Fn "size_t strcspn" "const char *s1" "const char *s2"\r
+.br\r
+.Fn "char *strpbrk" "const char *s1" "const char *s2"\r
+.br\r
+.Fn "char *strrchr" "const char *s" "int c"\r
+.br\r
+.Fn "size_t strspn" "const char *s1" "const char *s2"\r
+.br\r
+.Fn "char *strstr" "const char *s1" "const char *s2"\r
+.br\r
+.Fn "char *strtok" "char *restrict s1" "const char *restrict s2"\r
+.br\r
+.Fn "void *memset" "void *s" "int c" "size_t n"\r
+.br\r
+.Fn "char *strerror" "int errnum"\r
+.br\r
+.Fn "size_t strlen" "const char *s"\r
+.\"\r
+.Pp\r
+.Sy #define _PDCLIB_POSIX_MIN(2008098L) || _PDCLIB_XOPEN_MIN(0)\r
+.br\r
+.Fn char *strdup" "const char*src"\r
+.\"\r
+.Pp\r
+.Sy #define _PDCLIB_POSIX_MIN(2008098L)\r
+.br\r
+.Fn char *strndup" "const char*src" "size_t n"\r
+.\"\r
+.Sh SEE ALSO\r
+.Xr wchar.h 3\r
+.Xr stdlib.h 3\r
+.Xr memcpy 3\r
+.Xr memmove 3\r
+.Xr strcpy 3\r
+.Xr strncpy 3\r
+.Xr strcat 3\r
+.Xr strncat 3\r
+.Xr memcmp 3\r
+.Xr strcmp 3\r
+.Xr strcoll 3\r
+.Xr strncmp 3\r
+.Xr strxfrm 3\r
+.Xr memchr 3\r
+.Xr strchr 3\r
+.Xr strcspn 3\r
+.Xr strpbrk 3\r
+.Xr strrchr 3\r
+.Xr strspn 3\r
+.Xr strstr 3\r
+.Xr strtok 3\r
+.Xr memset 3\r
+.Xr strerror 3\r
+.Xr strlen 3\r
+.Xr strdup 3\r
+.Xr strndup 3\r
+.Sh STANDARDS\r
+Conforming to\r
+.St -isoC-90 ,\r
+.St -isoC-99 .
\ No newline at end of file