summaryrefslogtreecommitdiff
path: root/doc/c-strcasestr.texi
diff options
context:
space:
mode:
authorBruno Haible <bruno@clisp.org>2008-01-11 03:42:54 +0100
committerBruno Haible <bruno@clisp.org>2008-01-11 03:42:54 +0100
commit4a3dfbf40eba25a6d355db2ae5ac721f862a0557 (patch)
tree58a1bed45a004d4e80d4c309895ab9a6585b83c6 /doc/c-strcasestr.texi
parent4de3b7f8a666cbbebcb63ef90027ee2988d146bb (diff)
downloadgnulib-4a3dfbf40eba25a6d355db2ae5ac721f862a0557.tar.gz
Add documentation for the c-* modules.
Diffstat (limited to 'doc/c-strcasestr.texi')
-rw-r--r--doc/c-strcasestr.texi27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/c-strcasestr.texi b/doc/c-strcasestr.texi
new file mode 100644
index 0000000000..5ff1f88b95
--- /dev/null
+++ b/doc/c-strcasestr.texi
@@ -0,0 +1,27 @@
+@c Documentation of gnulib module 'c-strcasestr'.
+
+@c Copyright (C) 2008 Free Software Foundation, Inc.
+
+@c Permission is granted to copy, distribute and/or modify this document
+@c under the terms of the GNU Free Documentation License, Version 1.2 or
+@c any later version published by the Free Software Foundation; with no
+@c Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
+@c Texts. A copy of the license is included in the ``GNU Free
+@c Documentation License'' file as part of this distribution.
+
+The @code{c-strcasestr} module contains a case-insensitive string search
+function operating on single-byte character strings, that operate as if the
+locale encoding was ASCII.
+(The "C" locale on many systems has the locale encoding "ASCII".)
+
+The function is:
+@smallexample
+extern char *c_strcasestr (const char *haystack, const char *needle);
+@end smallexample
+
+For case conversion here, only ASCII characters are considered to be
+upper case or lower case.
+
+Note: The function @code{strcasestr} from @code{<string.h>} supports only
+unibyte locales; for multibyte locales, you need the function
+@code{mbscasestr}.