Describe "shift sequence" input.

This commit is contained in:
Michael Kerrisk 2008-09-08 13:50:13 +00:00
parent 5b0dc1baed
commit 037273a620
1 changed files with 6 additions and 1 deletions

View File

@ -13,7 +13,7 @@
.\" 2000-06-30 correction by Yuichi SATO <sato@complex.eng.hokudai.ac.jp>
.\" 2000-11-15 aeb, fixed prototype
.\"
.TH ICONV 3 2008-08-11 "GNU" "Linux Programmer's Manual"
.TH ICONV 3 2008-09-08 "GNU" "Linux Programmer's Manual"
.SH NAME
iconv \- perform character set conversion
.SH SYNOPSIS
@ -44,6 +44,11 @@ each character conversion it increments \fI*inbuf\fP and decrements
\fI*inbytesleft\fP by the number of converted input bytes, it increments
\fI*outbuf\fP and decrements \fI*outbytesleft\fP by the number of converted
output bytes, and it updates the conversion state contained in \fIcd\fP.
If the character encoding of the input is stateful, the
.BR iconv ()
function can also convert a sequence of input bytes
to an update to the conversion state without producing any output bytes;
such input is called a \fIshift sequence\fP.
The conversion can stop for four reasons:
.PP
1. An invalid multibyte sequence is encountered in the input.