Wrapped long lines, wrapped at sentence boundaries; stripped trailing

[thirdparty/man-pages.git] / man3 / wcsnrtombs.3

diff --git a/man3/wcsnrtombs.3 b/man3/wcsnrtombs.3
index e214c5634cd6ac29f9c8216833d0b488eb2a6a7a..b82dc6618d471291e300c54ff7d8d1460a6ff37b 100644 (file)
--- a/man3/wcsnrtombs.3
+++ b/man3/wcsnrtombs.3
@@ -21,48 +21,64 @@ wcsnrtombs \- convert a wide character string to a multibyte string
 .BI "                  size_t " len ", mbstate_t *" ps );
 .fi
 .SH DESCRIPTION
-The \fBwcsnrtombs\fP() function is like the \fBwcsrtombs\fP() function, 
-except that the number of wide characters to be converted, 
+The \fBwcsnrtombs\fP() function is like the \fBwcsrtombs\fP() function,
+except that the number of wide characters to be converted,
 starting at \fI*src\fP, is limited to \fInwc\fP.
 .PP
-If \fIdest\fP is not a NULL pointer, the \fBwcsnrtombs\fP() function converts
+If \fIdest\fP is not a NULL pointer,
+the \fBwcsnrtombs\fP() function converts
 at most \fInwc\fP wide characters from
 the wide-character string \fI*src\fP to a multibyte string starting at
-\fIdest\fP. At most \fIlen\fP bytes are written to \fIdest\fP. The shift state
-\fI*ps\fP is updated. The conversion is effectively performed by repeatedly
-calling wcrtomb(\fIdest\fP,\fI*src\fP,\fIps\fP), as long as this call succeeds,
-and then incrementing \fIdest\fP by the number of bytes written and \fI*src\fP
-by one. The conversion can stop for three reasons:
+\fIdest\fP.
+At most \fIlen\fP bytes are written to \fIdest\fP.
+The shift state
+\fI*ps\fP is updated.
+The conversion is effectively performed by repeatedly
+calling wcrtomb(\fIdest\fP,\fI*src\fP,\fIps\fP),
+as long as this call succeeds,
+and then incrementing \fIdest\fP by the
+number of bytes written and \fI*src\fP
+by one.
+The conversion can stop for three reasons:
 .PP
 1. A wide character has been encountered that can not be represented as a
-multibyte sequence (according to the current locale). In this case \fI*src\fP
+multibyte sequence (according to the current locale).
+In this case \fI*src\fP
 is left pointing to the invalid wide character, (size_t)(\-1) is returned,
 and \fIerrno\fP is set to \fBEILSEQ\fP.
 .PP
-2. \fInwc\fP wide characters have been converted without encountering a L'\\0',
-or the length limit forces a stop. In this case \fI*src\fP is left pointing
+2. \fInwc\fP wide characters have been
+converted without encountering a L'\\0',
+or the length limit forces a stop.
+In this case \fI*src\fP is left pointing
 to the next wide character to be converted, and the number of bytes written
 to \fIdest\fP is returned.
 .PP
 3. The wide-character string has been completely converted, including the
 terminating L'\\0' (which has the side effect of bringing back \fI*ps\fP
-to the initial state). In this case \fI*src\fP is set to NULL, and the number
+to the initial state).
+In this case \fI*src\fP is set to NULL, and the number
 of bytes written to \fIdest\fP, excluding the terminating '\\0' byte, is
 returned.
 .PP
-If \fIdest\fP is NULL, \fIlen\fP is ignored, and the conversion proceeds as
-above, except that the converted bytes are not written out to memory, and that
+If \fIdest\fP is NULL, \fIlen\fP is ignored,
+and the conversion proceeds as above,
+except that the converted bytes are not written out to memory, and that
 no destination length limit exists.
 .PP
-In both of the above cases, if \fIps\fP is a NULL pointer, a static anonymous
+In both of the above cases,
+if \fIps\fP is a NULL pointer, a static anonymous
 state only known to the wcsnrtombs function is used instead.
 .PP
 The programmer must ensure that there is room for at least \fIlen\fP bytes
 at \fIdest\fP.
 .SH "RETURN VALUE"
-The \fBwcsnrtombs\fP() function returns the number of bytes that make up the
-converted part of multibyte sequence, not including the terminating null byte.
-If a wide character was encountered which could not be converted, (size_t)(\-1)
+The \fBwcsnrtombs\fP() function returns
+the number of bytes that make up the
+converted part of multibyte sequence,
+not including the terminating null byte.
+If a wide character was encountered which
+could not be converted, (size_t)(\-1)
 is returned, and \fIerrno\fP set to \fBEILSEQ\fP.
 .SH "CONFORMING TO"
 This function is a GNU extension.