Annotation of embedaddon/libiconv/man/iconvctl.3, revision 1.1
1.1 ! misho 1: .\" Copyright (c) Perry Rapp
! 2: .\" Copyright (c) Bruno Haible <bruno@clisp.org>
! 3: .\"
! 4: .\" This is free documentation; you can redistribute it and/or
! 5: .\" modify it under the terms of the GNU General Public License as
! 6: .\" published by the Free Software Foundation; either version 3 of
! 7: .\" the License, or (at your option) any later version.
! 8: .\"
! 9: .\" References consulted:
! 10: .\" iconv.h
! 11: .\"
! 12: .TH ICONVCTL 3 "March 31, 2007" "GNU" "Linux Programmer's Manual"
! 13: .SH NAME
! 14: iconvctl \- control iconv behavior
! 15: .SH SYNOPSIS
! 16: .nf
! 17: .B #include <iconv.h>
! 18: .sp
! 19: .BI "int iconvctl (iconv_t " cd " , int " request ", void * " argument );
! 20: .fi
! 21: .SH DESCRIPTION
! 22: The argument \fIcd\fP must be a conversion descriptor created using the
! 23: function \fBiconv_open\fP.
! 24: .PP
! 25: \fBiconvctl\fP queries or adjusts the behavior of the \fBiconv\fP function,
! 26: when invoked with the specified conversion descriptor, depending on the
! 27: request value.
! 28: .SH "REQUEST VALUES"
! 29: The following are permissible values for the \fIrequest\fP parameter.
! 30: .TP
! 31: .B ICONV_TRIVIALP
! 32: \fIargument\fP should be an \fBint *\fP which will receive 1 if the
! 33: conversion is trivial, or 0 otherwise.
! 34: .TP
! 35: .B ICONV_GET_TRANSLITERATE
! 36: \fIargument\fP should be an \fBint *\fP which will receive 1 if
! 37: transliteration is enabled in the conversion, or 0 otherwise.
! 38: .TP
! 39: .B ICONV_SET_TRANSLITERATE
! 40: \fIargument\fP should be a \fBconst int *\fP, pointing to an \fBint\fP value.
! 41: A non-zero value is used to enable transliteration in the conversion. A zero
! 42: value disables it.
! 43: .TP
! 44: .B ICONV_GET_DISCARD_ILSEQ
! 45: \fIargument\fP should be an \fBint *\fP which will receive 1 if
! 46: "illegal sequence discard and continue" is enabled in the conversion,
! 47: or 0 otherwise.
! 48: .TP
! 49: .B ICONV_SET_DISCARD_ILSEQ
! 50: \fIargument\fP should be a \fBconst int *\fP, pointing to an \fBint\fP value.
! 51: A non-zero value is used to enable "illegal sequence discard and continue"
! 52: in the conversion. A zero value disables it.
! 53: .SH "RETURN VALUE"
! 54: The \fBiconvctl\fP function returns 0 if it succeeds. In case of error, it sets
! 55: \fBerrno\fP and returns \-1.
! 56: .SH ERRORS
! 57: The following errors can occur, among others:
! 58: .TP
! 59: .B EINVAL
! 60: The request is invalid.
! 61: .SH "CONFORMING TO"
! 62: This function is implemented only in GNU libiconv and not in other \fBiconv\fP
! 63: implementations. It is not backed by a standard. You can test for its presence
! 64: through \fB(_LIBICONV_VERSION >= 0x0108)\fP.
! 65: .SH "SEE ALSO"
! 66: .BR iconv_open (3)
! 67: .BR iconv (3)
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>