string/FreeBSD/wcscoll.3.patch

   1 --- wcscoll.3.bsdnew    2009-11-18 18:24:39.000000000 -0800
   2 +++ wcscoll.3   2009-11-18 18:24:39.000000000 -0800
   3 @@ -37,37 +37,57 @@
   4  .Dt WCSCOLL 3
   5  .Os
   6  .Sh NAME
   7 -.Nm wcscoll
   8 +.Nm wcscoll ,
   9 +.Nm wcscoll_l
  10  .Nd compare wide strings according to current collation
  11  .Sh LIBRARY
  12  .Lb libc
  13  .Sh SYNOPSIS
  14  .In wchar.h
  15  .Ft int
  16 -.Fn wcscoll "const wchar_t *s1" "const wchar_t *s2"
  17 +.Fo wcscoll
  18 +.Fa "const wchar_t *ws1"
  19 +.Fa "const wchar_t *ws2"
  20 +.Fc
  21 +.In wchar.h
  22 +.In xlocale.h
  23 +.Ft int
  24 +.Fo wcscoll_l
  25 +.Fa "const wchar_t *ws1"
  26 +.Fa "const wchar_t *ws2"
  27 +.Fa "locale_t loc"
  28 +.Fc
  29  .Sh DESCRIPTION
  30  The
  31  .Fn wcscoll
  32  function compares the null-terminated strings
  33 -.Fa s1
  34 +.Fa ws1
  35  and
  36 -.Fa s2
  37 -according to the current locale collation order.
  38 +.Fa ws2 ,
  39 +according to the current locale's collation order.
  40  In the
  41  .Dq Li C
  42  locale,
  43  .Fn wcscoll
  44  is equivalent to
  45  .Fn wcscmp .
  46 +.Pp
  47 +Although the
  48 +.Fn wcscoll
  49 +function uses the current locale, the
  50 +.Fn wcscoll_l
  51 +function may be passed a locale directly. See
  52 +.Xr xlocale 3
  53 +for more information.
  54  .Sh RETURN VALUES
  55  The
  56  .Fn wcscoll
  57  function
  58  returns an integer greater than, equal to, or less than 0,
  59  if
  60 -.Fa s1
  61 +.Fa ws1
  62  is greater than, equal to, or less than
  63 -.Fa s2 .
  64 +.Fa ws2 .
  65  .Pp
  66  No return value is reserved to indicate errors;
  67  callers should set
  68 @@ -91,7 +111,8 @@ Cannot allocate enough memory for tempor
  69  .Xr setlocale 3 ,
  70  .Xr strcoll 3 ,
  71  .Xr wcscmp 3 ,
  72 -.Xr wcsxfrm 3
  73 +.Xr wcsxfrm 3 ,
  74 +.Xr xlocale 3
  75  .Sh STANDARDS
  76  The
  77  .Fn wcscoll