]> git.ipfire.org Git - thirdparty/man-pages.git/blobdiff - man3/mbsrtowcs.3
dist.mk, All pages: .TH: Generate date at 'make dist'
[thirdparty/man-pages.git] / man3 / mbsrtowcs.3
index 3244b85cc54198a84a5b1e534545b78ee8d5ae9f..ef61409d1a14f76e25b3b0985ed250950d182ec7 100644 (file)
@@ -1,11 +1,6 @@
 .\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
 .\"
-.\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
-.\" This is free documentation; you can redistribute it and/or
-.\" modify it under the terms of the GNU General Public License as
-.\" published by the Free Software Foundation; either version 2 of
-.\" the License, or (at your option) any later version.
-.\" %%%LICENSE_END
+.\" SPDX-License-Identifier: GPL-2.0-or-later
 .\"
 .\" References consulted:
 .\"   GNU glibc-2 source code and manual
 .\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
 .\"   ISO/IEC 9899:1999
 .\"
-.TH MBSRTOWCS 3  2015-08-08 "GNU" "Linux Programmer's Manual"
+.TH MBSRTOWCS 3 (date) "Linux man-pages (unreleased)"
 .SH NAME
 mbsrtowcs \- convert a multibyte string to a wide-character string
+.SH LIBRARY
+Standard C library
+.RI ( libc ", " \-lc )
 .SH SYNOPSIS
 .nf
 .B #include <wchar.h>
-.sp
-.BI "size_t mbsrtowcs(wchar_t *" dest ", const char **" src ,
-.BI "                  size_t " len ", mbstate_t *" ps );
+.PP
+.BI "size_t mbsrtowcs(wchar_t *restrict " dest ", const char **restrict " src ,
+.BI "                 size_t " len ", mbstate_t *restrict " ps );
 .fi
 .SH DESCRIPTION
 If
@@ -65,7 +63,7 @@ is set to
 .BR EILSEQ .
 .IP 2.
 .I len
-non-L\(aq\\0\(aq wide characters have been stored at
+non-L\(aq\e0\(aq wide characters have been stored at
 .IR dest .
 In this case,
 .I *src
@@ -76,7 +74,7 @@ and the number of wide characters written to
 is returned.
 .IP 3.
 The multibyte string has been completely converted, including the
-terminating null wide character (\(aq\\0\(aq), which has the side
+terminating null wide character (\(aq\e0\(aq), which has the side
 effect of bringing back
 .I *ps
 to the
@@ -89,7 +87,7 @@ characters written to
 excluding the terminating null wide character, is returned.
 .PP
 If
-.IR dest
+.I dest
 is NULL,
 .I len
 is ignored,
@@ -126,17 +124,23 @@ set to
 .SH ATTRIBUTES
 For an explanation of the terms used in this section, see
 .BR attributes (7).
+.ad l
+.nh
 .TS
 allbox;
-lb lb lbw28
+lb lb lbx
 l l l.
 Interface      Attribute       Value
 T{
 .BR mbsrtowcs ()
-T}     Thread safety   MT-Unsafe race:mbsrtowcs/!ps
+T}     Thread safety   T{
+MT-Unsafe race:mbsrtowcs/!ps
+T}
 .TE
-
-.SH CONFORMING TO
+.hy
+.ad
+.sp 1
+.SH STANDARDS
 POSIX.1-2001, POSIX.1-2008, C99.
 .SH NOTES
 The behavior of