diff options
author | Bruno Haible <bruno@clisp.org> | 2004-02-02 11:31:24 +0000 |
---|---|---|
committer | Bruno Haible <bruno@clisp.org> | 2009-06-21 11:43:58 +0200 |
commit | b45f3ec46fd6f4fde9eb01e576ae6f869c6b5268 (patch) | |
tree | 1bf014391685ae8dc2e77e0305947d843827beb0 /man/iconvctl.3 | |
parent | 74976371107476221858170c565626546c394780 (diff) | |
download | android-libiconv-b45f3ec46fd6f4fde9eb01e576ae6f869c6b5268.tar.gz android-libiconv-b45f3ec46fd6f4fde9eb01e576ae6f869c6b5268.tar.bz2 android-libiconv-b45f3ec46fd6f4fde9eb01e576ae6f869c6b5268.zip |
New man page for iconvctl().
Diffstat (limited to 'man/iconvctl.3')
-rwxr-xr-x | man/iconvctl.3 | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/man/iconvctl.3 b/man/iconvctl.3 new file mode 100755 index 0000000..ac87248 --- /dev/null +++ b/man/iconvctl.3 @@ -0,0 +1,66 @@ +.\" Copyright (c) Perry Rapp +.\" Copyright (c) Bruno Haible <bruno@clisp.org> +.\" +.\" 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. +.\" +.\" References consulted: +.\" iconv.h +.\" +.TH ICONVCTL 3 "February 2, 2004" "GNU" "Linux Programmer's Manual" +.SH NAME +iconvctl \- control iconv behavior +.SH SYNOPSIS +.nf +.B #include <iconv.h> +.sp +.BI "int iconvctl (iconv_t " cd " , int " request ", void * " argument ); +.fi +.SH DESCRIPTION +The argument \fIcd\fP must be a conversion descriptor created using the +function \fBiconv_open\fP. +.PP +\fBiconvctl\fP queries or adjusts the behavior of \fBiconv\fP function, when +invoked with the specified conversion descriptor, depending on the request +value. +.SH "REQUEST VALUES" +The following are permissible values for the \fIrequest\fP parameter. +.TP +.B ICONV_TRIVIALP +\fIargument\fP should be an \fBint *\fP which will receive 1 if the +conversion is trivial, or 0 otherwise. +.TP +.B ICONV_GET_TRANSLITERATE +\fIargument\fP should be an \fBint *\fP which will receive 1 if +transliteration is enabled in the conversion, or 0 otherwise. +.TP +.B ICONV_SET_TRANSLITERATE +\fIargument\fP should be a \fBconst int *\fP, pointing to an \fBint\fP value. +A non-zero value is used to enable transliteration in the conversion. A zero +value disables it. +.TP +.B ICONV_GET_DISCARD_ILSEQ +\fIargument\fP should be an \fBint *\fP which will receive 1 if +"illegal sequence discard and continue" is enabled in the conversion, +or 0 otherwise. +.TP +.B ICONV_SET_DISCARD_ILSEQ +\fIargument\fP should be a \fBconst int *\fP, pointing to an \fBint\fP value. +A non-zero value is used to enable "illegal sequence discard and continue" +in the conversion. A zero value disables it. +.SH "RETURN VALUE" +The \fBiconvctl\fP function return 0 if it succeeds. In case of error, it sets +\fBerrno\fP and returns -1. +.SH ERRORS +The following errors can occur, among others: +.TP +.B EINVAL +The request is invalid. +.SH "CONFORMING TO" +This function is implemented only in GNU libiconv and not in other \fBiconv\fP +implementations. It is not backed by a standard. You can test for its presence +through \fB(_LIBICONV_VERSION >= 0x0108)\fP. +.SH "SEE ALSO" +.BR iconv_open "(3), " iconv (3) |