Libc-498.1.1.tar.gz

[apple/libc.git] / string / strcoll.3

diff --git a/string/strcoll.3 b/string/strcoll.3
index 76171849686f0dd34dfe09696b9ab1b1fa085634..267c836525592f4f2af9fa787cf5d653a99d7195 100644 (file)
--- a/string/strcoll.3
+++ b/string/strcoll.3
@@ -34,20 +34,32 @@
 .\" SUCH DAMAGE.
 .\"
 .\"     @(#)strcoll.3  8.1 (Berkeley) 6/4/93
-.\" $FreeBSD: src/lib/libc/string/strcoll.3,v 1.11 2001/10/01 16:09:00 ru Exp $
+.\" $FreeBSD: src/lib/libc/string/strcoll.3,v 1.12 2002/10/15 10:11:53 tjr Exp $
 .\"
 .Dd June 4, 1993
 .Dt STRCOLL 3
 .Os
 .Sh NAME
-.Nm strcoll
-.Nd compare strings according to current collation
+.Nm strcoll ,
+.Nm strcoll_l
+.Nd compare strings, according to current collation
 .Sh LIBRARY
 .Lb libc
 .Sh SYNOPSIS
 .In string.h
 .Ft int
-.Fn strcoll "const char *s1" "const char *s2"
+.Fo strcoll
+.Fa "const char *s1"
+.Fa "const char *s2"
+.Fc
+.In string.h
+.In xlocale.h
+.Ft int
+.Fo strcoll_l
+.Fa "const char *s1"
+.Fa "const char *s2"
+.Fa "locale_t loc"
+.Fc
 .Sh DESCRIPTION
 The
 .Fn strcoll
@@ -55,18 +67,29 @@ function
 lexicographically compares the null-terminated strings
 .Fa s1
 and
-.Fa s2
-according to the current locale collation if any, otherwise call
-.Fa strcmp ,
+.Fa s2 ,
+according to the current locale collation, if any.
+Otherwise, it calls
+.Fa strcmp
 and returns an integer greater than, equal to, or less than 0,
 according as
 .Fa s1
 is greater than, equal to, or less than
 .Fa s2 .
+.Pp
+Although the
+.Fn strcoll
+function uses the current locale, the
+.Fn strcoll_l
+function may be passed a locale directly. See
+.Xr xlocale 3
+for more information.
 .Sh SEE ALSO
 .Xr setlocale 3 ,
 .Xr strcmp 3 ,
-.Xr strxfrm 3
+.Xr strxfrm 3 ,
+.Xr wcscoll 3 ,
+.Xr xlocale 3
 .Sh STANDARDS
 The
 .Fn strcoll