1 .\" Copyright (c) 2009 Gabor Kovesdan <gabor@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" Portions of this text are reprinted and reproduced in electronic form
26 .\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology --
27 .\" Portable Operating System Interface (POSIX), The Open Group Base
28 .\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of
29 .\" Electrical and Electronics Engineers, Inc and The Open Group. In the
30 .\" event of any discrepancy between this version and the original IEEE and
31 .\" The Open Group Standard, the original IEEE and The Open Group Standard is
32 .\" the referee document. The original Standard can be obtained online at
33 .\" http://www.opengroup.org/unix/online.html.
35 .\" $FreeBSD: head/lib/libc/iconv/iconvctl.3 233577 2012-03-27 20:50:14Z joel $
42 .Nd controlling and diagnostical facility for
49 .Fn iconvctl "iconv_t cd" "int request" "void *argument"
53 function can retrieve or set specific conversion
56 conversion descriptor.
59 parameter specifies the operation to accomplish and
61 is an operation-specific argument.
63 The possible operations are the following:
64 .Bl -tag -width indent
70 variable, which is set to 1 if the encoding is trivial one, i.e.
71 the input and output encodings are the same.
72 Otherwise, the variable will be 0.
73 .It ICONV_GET_TRANSLITERATE
74 Determines if transliteration is enabled.
75 The answer is stored in
79 It will be set to 1 if this feature is enabled or set to 0 otherwise.
80 .It ICONV_SET_TRANSLITERATE
81 Enables transliteration if
85 set to 1 or disables it if
88 .It ICONV_GET_DISCARD_ILSEQ
89 Determines if illegal sequences are discarded or not.
90 The answer is stored in
94 It will be set to 1 if this feature is enabled or set to 0 otherwise.
95 .It ICONV_SET_DISCARD_ILSEQ
96 Sets whether illegal sequences are discarded or not.
100 set to 1 or disables it if
104 Sets callback functions, which will be called back after successful
106 The callback functions are stored in a
107 .Ft struct iconv_hooks
108 variable, which is passed to
113 .It ICONV_GET_ILSEQ_INVALID
114 Determines if a character in the input buffer that is valid,
115 but for which an identical character does not exist in the target
119 The answer is stored in
123 It will be set to 1 if this feature is enabled or set to 0 otherwise.
124 .It ICONV_SET_ILSEQ_INVALID
125 Sets whether a character in the input buffer that is valid,
126 but for which an identical character does not exist in the target
134 is set to 1 it will be enabled,
137 is set to 0 it will be disabled.
139 .\" XXX: fallbacks are unimplemented and trying to set them will always
140 .\" return EOPNOTSUPP but definitions are provided for source-level
142 .\".It ICONV_SET_FALLBACKS
143 .\"Sets callback functions, which will be called back after failed
145 .\"The callback functions are stored in a
146 .\".Ft struct iconv_fallbacks
147 .\"variable, which is passed to
153 Upon successful completion
156 Otherwise, \-1 is returned and errno is set to
157 specify the kind of error.
161 function may cause an error in the following cases:
164 Unknown or unimplemented operation.
166 The conversion descriptor specified by
176 facility is a non-standard extension, which appeared in
177 the GNU implementation and was adopted in
179 for compatibility's sake.
181 This manual page was written by
182 .An Gabor Kovesdan Aq Mt gabor@FreeBSD.org .
184 Transliteration is enabled in this implementation by default, so it
185 is impossible by design to turn it off.
186 Accordingly, trying to turn it off will always fail and \-1 will be
188 Getting the transliteration state will always succeed and indicate
189 that it is turned on, though.