Libc-1082.50.1.tar.gz

[apple/libc.git] / locale / FreeBSD / wcwidth.3

diff --git a/locale/FreeBSD/wcwidth.3 b/locale/FreeBSD/wcwidth.3
index 026813f2013850207488e60ee11123168913d66e..4c014cec65e655741a27a158e16b1887e87742d1 100644 (file)
--- a/locale/FreeBSD/wcwidth.3
+++ b/locale/FreeBSD/wcwidth.3
@@ -28,20 +28,38 @@
 .Dt WCWIDTH 3
 .Os
 .Sh NAME
 .Dt WCWIDTH 3
 .Os
 .Sh NAME

-.Nm wcwidth
+.Nm wcwidth ,
+.Nm wcwidth_l

 .Nd "number of column positions of a wide-character code"
 .Sh LIBRARY
 .Lb libc
 .Sh SYNOPSIS
 .In wchar.h
 .Ft int
 .Nd "number of column positions of a wide-character code"
 .Sh LIBRARY
 .Lb libc
 .Sh SYNOPSIS
 .In wchar.h
 .Ft int

-.Fn wcwidth "wchar_t wc"
+.Fo wcwidth
+.Fa "wchar_t wc"
+.Fc
+.In wchar.h
+.In xlocale.h
+.Ft int
+.Fo wcwidth_l
+.Fa "wchar_t wc"
+.Fa "locale_t loc"
+.Fc

 .Sh DESCRIPTION
 The
 .Fn wcwidth
 function determines the number of column positions required to
 display the wide character
 .Fa wc .
 .Sh DESCRIPTION
 The
 .Fn wcwidth
 function determines the number of column positions required to
 display the wide character
 .Fa wc .

+.Pp
+Although the
+.Fn wcwidth
+function uses the current locale, the
+.Fn wcwidth_l
+function may be passed a locale directly. See
+.Xr xlocale 3
+for more information.

 .Sh RETURN VALUES
 The
 .Fn wcwidth
 .Sh RETURN VALUES
 The
 .Fn wcwidth


@@ -50,8 +68,8 @@ function returns 0 if the
 argument is a null wide character (L'\e0'),
 \-1 if
 .Fa wc
 argument is a null wide character (L'\e0'),
 \-1 if
 .Fa wc

-is not printable,
-otherwise it returns the number of column positions the
+is not printable;
+otherwise, it returns the number of column positions the

 character occupies.
 .Sh EXAMPLES
 This code fragment reads text from standard input and
 character occupies.
 .Sh EXAMPLES
 This code fragment reads text from standard input and


@@ -79,7 +97,8 @@ while ((ch = getwchar()) != WEOF) {
 .Ed
 .Sh SEE ALSO
 .Xr iswprint 3 ,
 .Ed
 .Sh SEE ALSO
 .Xr iswprint 3 ,

-.Xr wcswidth 3
+.Xr wcswidth 3 ,
+.Xr xlocale 3

 .Sh STANDARDS
 The
 .Fn wcwidth
 .Sh STANDARDS
 The
 .Fn wcwidth