xref: /freebsd/lib/libc/iconv/iconv_canonicalize.3 (revision d37eb51047221dc3322b34db1038ff3aa533883f)
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.Dd October 20, 2009
36.Dt ICONV_CANONICALIZE 3
37.Os
38.Sh NAME
39.Nm iconv_canonicalize
40.Nd resolving character encoding names to canonical form
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In iconv.h
45.Ft const char *
46.Fn iconv_canonicalize "const char *name"
47.Sh DESCRIPTION
48The
49.Fn iconv_canonicalize
50function resolves the character encoding name specified by the
51.Fa name
52argument to its canonical form.
53.Sh RETURN VALUES
54Upon successful completion
55.Fn iconv_canonicalize ,
56returns the canonical name of the given encoding.
57If the specified name is already a canonical name, the same
58value is returned.
59If the specified name is not an existing character encoding
60name, NULL is returned.
61.Sh SEE ALSO
62.Xr iconv 3
63.Sh STANDARDS
64The
65.Nm
66function is a non-standard extension, which appeared in
67the GNU implementation and was adopted in
68.Fx 9.0
69for compatibility's sake.
70.Sh AUTHORS
71This manual page was written by
72.An Gabor Kovesdan Aq Mt gabor@FreeBSD.org .
73