Add documentation for the c-* modules.

[gnulib.git] / doc / c-strstr.texi

diff --git a/doc/c-strstr.texi b/doc/c-strstr.texi
new file mode 100644 (file)
index 0000000..08a6728
--- /dev/null
+++ b/doc/c-strstr.texi
@@ -0,0 +1,24 @@
+@c Documentation of gnulib module 'c-strstr'.
+
+@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-strstr} module contains a substring 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_strstr (const char *haystack, const char *needle);
+@end smallexample
+
+Note: The function @code{strstr} from @code{<string.h>} supports only
+unibyte locales; for multibyte locales, you need the function
+@code{mbsstr}.