Merge branch 'vendor/MDOCML'
[dragonfly.git] / lib / libc / iconv / iconvlist.3
1 .\" Copyright (c) 2009 Gabor Kovesdan <gabor@FreeBSD.org>
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
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.
12 .\"
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
23 .\" SUCH DAMAGE.
24 .\"
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.
34 .\"
35 .\" $FreeBSD: head/lib/libc/iconv/iconvlist.3 233625 2012-03-28 19:20:28Z joel $
36 .\"
37 .Dd September 19, 2013
38 .Dt ICONVLIST 3
39 .Os
40 .Sh NAME
41 .Nm iconvlist
42 .Nd retrieving a list of character encodings supported by
43 .Xr iconv 3
44 .Sh LIBRARY
45 .Lb libc
46 .Sh SYNOPSIS
47 .In iconv.h
48 .Ft void
49 .Fo iconvlist
50 .Fa "int \*[lp]*do_one\*[rp]\*[lp]unsigned int *count, const char * const *names, void *arg\*[rp]"
51 .Fa "void *arg"
52 .Fc
53 .Sh DESCRIPTION
54 The
55 .Fn iconvlist
56 function obtains a list of character encodings that are supported by the
57 .Xr iconv 3
58 call.
59 The
60 .Fn do_one
61 callback function will be called, where the
62 .Fa count
63 argument will be set to the number of the encoding names found, the
64 .Fa names
65 argument will be the list of the supported encoding names and the
66 .Fa arg
67 argument will be the \"outer\"
68 .Fa arg
69 argument of the
70 .Fn iconvlist
71 function.
72 This argument can be used to interchange custom data between the caller of
73 .Fn iconvlist
74 and the callback function.
75 .Pp
76 If an error occurs,
77 .Fa names
78 will be NULL when calling
79 .Fn do_one .
80 .Sh SEE ALSO
81 .Xr iconv 3 ,
82 .Xr __iconv_get_list 3 ,
83 .Xr __iconv_free_list 3
84 .Sh STANDARDS
85 The
86 .Nm
87 function is a non-standard extension, which appeared in
88 the GNU implementation and was adopted in
89 .Fx 9
90 for compatibility's sake.
91 .Sh AUTHORS
92 This manual page was written by
93 .An Gabor Kovesdan Aq gabor@FreeBSD.org .