Wrapped long lines, wrapped at sentence boundaries; stripped trailing

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

diff --git a/man3/mbtowc.3 b/man3/mbtowc.3
index 5fc1d4826b292bd3169a66f9759f8a7a609a99c1..4480253e1ccb66473b25870ad3b564497026dffa 100644 (file)
--- a/man3/mbtowc.3
+++ b/man3/mbtowc.3
@@ -22,27 +22,36 @@ mbtowc \- convert a multibyte sequence to a wide character
 .fi
 .SH DESCRIPTION
 The main case for this function is when \fIs\fP is not NULL and \fIpwc\fP is
-not NULL. In this case, the \fBmbtowc\fP() function inspects at most \fIn\fP
-bytes of the multibyte string starting at \fIs\fP, extracts the next complete
+not NULL.
+In this case, the \fBmbtowc\fP() function inspects at most \fIn\fP
+bytes of the multibyte string starting at \fIs\fP,
+extracts the next complete
 multibyte character, converts it to a wide character and stores it at
-\fI*pwc\fP. It updates an internal shift state only known to the mbtowc
-function. If \fIs\fP does not point to a '\\0' byte, it returns the number
+\fI*pwc\fP.
+It updates an internal shift state only known to the mbtowc
+function.
+If \fIs\fP does not point to a '\\0' byte, it returns the number
 of bytes that were consumed from \fIs\fP, otherwise it returns 0.
 .PP
 If the \fIn\fP bytes starting at \fIs\fP do not contain a complete multibyte
 character, or if they contain an invalid multibyte sequence, \fBmbtowc\fP()
-returns \fI-1\fP. This can happen even if \fIn\fP >= \fIMB_CUR_MAX\fP,
+returns \fI-1\fP.
+This can happen even if \fIn\fP >= \fIMB_CUR_MAX\fP,
 if the multibyte string contains redundant shift sequences.
 .PP
-A different case is when \fIs\fP is not NULL but \fIpwc\fP is NULL. In this
+A different case is when \fIs\fP is not NULL but \fIpwc\fP is NULL.
+In this
 case the \fBmbtowc\fP() function behaves as above, excepts that it does not
 store the converted wide character in memory.
 .PP
-A third case is when \fIs\fP is NULL. In this case, \fIpwc\fP and \fIn\fP are
-ignored. The \fBmbtowc\fP() function
+A third case is when \fIs\fP is NULL.
+In this case, \fIpwc\fP and \fIn\fP are
+ignored.
+The \fBmbtowc\fP() function
 .\" The Dinkumware doc and the Single Unix specification say this, but
 .\" glibc doesn't implement this.
-resets the shift state, only known to this function, to the initial state, and
+resets the shift state, only known to this function,
+to the initial state, and
 returns non-zero if the encoding has non-trivial shift state, or zero if the
 encoding is stateless.
 .SH "RETURN VALUE"
@@ -50,7 +59,8 @@ If \fIs\fP is not NULL, the \fBmbtowc\fP() function returns the number of
 consumed bytes starting at \fIs\fP, or 0 if \fIs\fP points to a null byte,
 or \-1 upon failure.
 .PP
-If \fIs\fP is NULL, the \fBmbtowc\fP() function returns non-zero if the encoding
+If \fIs\fP is NULL, the \fBmbtowc\fP() function
+returns non-zero if the encoding
 has non-trivial shift state, or zero if the encoding is stateless.
 .SH "CONFORMING TO"
 C99
@@ -62,5 +72,6 @@ C99
 The behaviour of \fBmbtowc\fP() depends on the LC_CTYPE category of the
 current locale.
 .PP
-This function is not multi-thread safe. The function \fBmbrtowc\fP() provides
+This function is not multi-thread safe.
+The function \fBmbrtowc\fP() provides
 a better interface to the same functionality.