locale/FreeBSD/mbstowcs.3.patch

   1 --- mbstowcs.3.orig     2009-11-09 15:05:25.000000000 -0800
   2 +++ mbstowcs.3  2009-11-09 15:05:26.000000000 -0800
   3 @@ -37,7 +37,8 @@
   4  .Dt MBSTOWCS 3
   5  .Os
   6  .Sh NAME
   7 -.Nm mbstowcs
   8 +.Nm mbstowcs ,
   9 +.Nm mbstowcs_l
  10  .Nd convert a character string to a wide-character string
  11  .Sh LIBRARY
  12  .Lb libc
  13 @@ -45,21 +46,39 @@
  14  .In stdlib.h
  15  .Ft size_t
  16  .Fo mbstowcs
  17 -.Fa "wchar_t * restrict wcstring" "const char * restrict mbstring"
  18 -.Fa "size_t nwchars"
  19 +.Fa "wchar_t *restrict pwcs"
  20 +.Fa "const char *restrict s"
  21 +.Fa "size_t n"
  22 +.Fc
  23 +.In stdlib.h
  24 +.In xlocale.h
  25 +.Ft size_t
  26 +.Fo mbstowcs_l
  27 +.Fa "wchar_t *restrict pwcs"
  28 +.Fa "const char *restrict s"
  29 +.Fa "size_t n"
  30 +.Fa "locale_t loc"
  31  .Fc
  32  .Sh DESCRIPTION
  33  The
  34  .Fn mbstowcs
  35  function converts a multibyte character string
  36 -.Fa mbstring
  37 -beginning in the initial conversion state
  38 +.Fa s ,
  39 +beginning in the initial conversion state,
  40  into a wide character string
  41 -.Fa wcstring .
  42 +.Fa pwcs .
  43  No more than
  44 -.Fa nwchars
  45 +.Fa n
  46  wide characters are stored.
  47 -A terminating null wide character is appended if there is room.
  48 +A terminating null wide character is appended, if there is room.
  49 +.Pp
  50 +Although the
  51 +.Fn mbstowcs
  52 +function uses the current locale, the
  53 +.Fn mbstowcs_l
  54 +function may be passed a locale directly. See
  55 +.Xr xlocale 3
  56 +for more information.
  57  .Sh RETURN VALUES
  58  The
  59  .Fn mbstowcs
  60 @@ -79,7 +98,8 @@ The conversion state is invalid.
  61  .Sh SEE ALSO
  62  .Xr mbsrtowcs 3 ,
  63  .Xr mbtowc 3 ,
  64 -.Xr multibyte 3
  65 +.Xr multibyte 3 ,
  66 +.Xr xlocale 3
  67  .Sh STANDARDS
  68  The
  69  .Fn mbstowcs