locale/FreeBSD/mbsinit.3.patch

   1 --- _SB/Libc/locale/FreeBSD/mbsinit.3   2004-11-25 11:38:18.000000000 -0800
   2 +++ _SB/Libc/locale/FreeBSD/mbsinit.3.edit      2006-06-28 16:55:51.000000000 -0700
   3 @@ -28,7 +28,8 @@
   4  .Dt MBSINIT 3
   5  .Os
   6  .Sh NAME
   7 -.Nm mbsinit
   8 +.Nm mbsinit ,
   9 +.Nm mbsinit_l
  10  .Nd "determine conversion object status"
  11  .Sh LIBRARY
  12  .Lb libc
  13 @@ -36,6 +37,10 @@
  14  .In wchar.h
  15  .Ft int
  16  .Fn mbsinit "const mbstate_t *ps"
  17 +.In wchar.h
  18 +.In xlocale.h
  19 +.Ft int
  20 +.Fn mbsinit_l "const mbstate_t *ps" "locale_t loc"
  21  .Sh DESCRIPTION
  22  The
  23  .Fn mbsinit
  24 @@ -44,6 +49,14 @@
  25  object pointed to by
  26  .Fa ps
  27  describes an initial conversion state.
  28 +.Pp
  29 +While the
  30 +.Fn mbsinit
  31 +function uses the current locale, the
  32 +.Fn mbsinit_l
  33 +function may be passed a locale directly. See
  34 +.Xr xlocale 3
  35 +for more information.
  36  .Sh RETURN VALUES
  37  The
  38  .Fn mbsinit
  39 @@ -51,15 +64,16 @@
  40  .Fa ps
  41  is
  42  .Dv NULL
  43 -or describes an initial conversion state,
  44 -otherwise it returns zero.
  45 +or describes an initial conversion state;
  46 +otherwise, it returns zero.
  47  .Sh SEE ALSO
  48  .Xr mbrlen 3 ,
  49  .Xr mbrtowc 3 ,
  50  .Xr mbsrtowcs 3 ,
  51  .Xr multibyte 3 ,
  52  .Xr wcrtomb 3 ,
  53 -.Xr wcsrtombs 3
  54 +.Xr wcsrtombs 3 ,
  55 +.Xr xlocale 3
  56  .Sh STANDARDS
  57  The
  58  .Fn mbsinit