bump standards-version (3.9.4);update overrides
[gnulib.git] / doc / posix-functions / iscntrl.texi
index e93e276..db6ead5 100644 (file)
@@ -2,7 +2,7 @@
 @section @code{iscntrl}
 @findex iscntrl
 
-POSIX specification: @url{http://www.opengroup.org/susv3xsh/iscntrl.html}
+POSIX specification:@* @url{http://www.opengroup.org/onlinepubs/9699919799/functions/iscntrl.html}
 
 Gnulib module: ---
 
@@ -13,3 +13,28 @@ Portability problems fixed by Gnulib:
 Portability problems not fixed by Gnulib:
 @itemize
 @end itemize
+
+Note: This function's behaviour depends on the locale, but does not support
+the multibyte characters that occur in strings in locales with
+@code{MB_CUR_MAX > 1} (this includes all the common UTF-8 locales).
+There are four alternative APIs:
+
+@table @code
+@item c_iscntrl
+This function operates in a locale independent way and returns true only for
+ASCII characters.  It is provided by the Gnulib module @samp{c-ctype}.
+
+@item iswcntrl
+This function operates in a locale dependent way, on wide characters.  In
+order to use it, you first have to convert from multibyte to wide characters,
+using the @code{mbrtowc} function.  It is provided by the Gnulib module
+@samp{wctype}.
+
+@item mb_iscntrl
+This function operates in a locale dependent way, on multibyte characters.
+It is provided by the Gnulib module @samp{mbchar}.
+
+@item uc_is_cntrl
+This function operates in a locale independent way, on Unicode characters.
+It is provided by the Gnulib module @samp{unictype/ctype-cntrl}.
+@end table