xref: /freebsd/lib/libc/iconv/iconv_canonicalize.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1ad30f8e7SGabor Kovesdan.\" Copyright (c) 2009 Gabor Kovesdan <gabor@FreeBSD.org>
2ad30f8e7SGabor Kovesdan.\" All rights reserved.
3ad30f8e7SGabor Kovesdan.\"
4ad30f8e7SGabor Kovesdan.\" Redistribution and use in source and binary forms, with or without
5ad30f8e7SGabor Kovesdan.\" modification, are permitted provided that the following conditions
6ad30f8e7SGabor Kovesdan.\" are met:
7ad30f8e7SGabor Kovesdan.\" 1. Redistributions of source code must retain the above copyright
8ad30f8e7SGabor Kovesdan.\"    notice, this list of conditions and the following disclaimer.
9ad30f8e7SGabor Kovesdan.\" 2. Redistributions in binary form must reproduce the above copyright
10ad30f8e7SGabor Kovesdan.\"    notice, this list of conditions and the following disclaimer in the
11ad30f8e7SGabor Kovesdan.\"    documentation and/or other materials provided with the distribution.
12ad30f8e7SGabor Kovesdan.\"
13ad30f8e7SGabor Kovesdan.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14ad30f8e7SGabor Kovesdan.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15ad30f8e7SGabor Kovesdan.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16ad30f8e7SGabor Kovesdan.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17ad30f8e7SGabor Kovesdan.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18ad30f8e7SGabor Kovesdan.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19ad30f8e7SGabor Kovesdan.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20ad30f8e7SGabor Kovesdan.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21ad30f8e7SGabor Kovesdan.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22ad30f8e7SGabor Kovesdan.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23ad30f8e7SGabor Kovesdan.\" SUCH DAMAGE.
24ad30f8e7SGabor Kovesdan.\"
25ad30f8e7SGabor Kovesdan.\" Portions of this text are reprinted and reproduced in electronic form
26ad30f8e7SGabor Kovesdan.\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology --
27ad30f8e7SGabor Kovesdan.\" Portable Operating System Interface (POSIX), The Open Group Base
28ad30f8e7SGabor Kovesdan.\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of
29ad30f8e7SGabor Kovesdan.\" Electrical and Electronics Engineers, Inc and The Open Group.  In the
30ad30f8e7SGabor Kovesdan.\" event of any discrepancy between this version and the original IEEE and
31ad30f8e7SGabor Kovesdan.\" The Open Group Standard, the original IEEE and The Open Group Standard is
32ad30f8e7SGabor Kovesdan.\" the referee document.  The original Standard can be obtained online at
33ad30f8e7SGabor Kovesdan.\"	http://www.opengroup.org/unix/online.html.
34ad30f8e7SGabor Kovesdan.\"
35ad30f8e7SGabor Kovesdan.Dd October 20, 2009
36ad30f8e7SGabor Kovesdan.Dt ICONV_CANONICALIZE 3
37ad30f8e7SGabor Kovesdan.Os
38ad30f8e7SGabor Kovesdan.Sh NAME
39ad30f8e7SGabor Kovesdan.Nm iconv_canonicalize
40ad30f8e7SGabor Kovesdan.Nd resolving character encoding names to canonical form
41ad30f8e7SGabor Kovesdan.Sh LIBRARY
42ad30f8e7SGabor Kovesdan.Lb libc
43ad30f8e7SGabor Kovesdan.Sh SYNOPSIS
44ad30f8e7SGabor Kovesdan.In iconv.h
45ad30f8e7SGabor Kovesdan.Ft const char *
46ad30f8e7SGabor Kovesdan.Fn iconv_canonicalize "const char *name"
47ad30f8e7SGabor Kovesdan.Sh DESCRIPTION
48ad30f8e7SGabor KovesdanThe
49ad30f8e7SGabor Kovesdan.Fn iconv_canonicalize
50ad30f8e7SGabor Kovesdanfunction resolves the character encoding name specified by the
51ad30f8e7SGabor Kovesdan.Fa name
52ad30f8e7SGabor Kovesdanargument to its canonical form.
53ad30f8e7SGabor Kovesdan.Sh RETURN VALUES
54ad30f8e7SGabor KovesdanUpon successful completion
55ad30f8e7SGabor Kovesdan.Fn iconv_canonicalize ,
56ad30f8e7SGabor Kovesdanreturns the canonical name of the given encoding.
57ad30f8e7SGabor KovesdanIf the specified name is already a canonical name, the same
58ad30f8e7SGabor Kovesdanvalue is returned.
59ad30f8e7SGabor KovesdanIf the specified name is not an existing character encoding
60ad30f8e7SGabor Kovesdanname, NULL is returned.
61ad30f8e7SGabor Kovesdan.Sh SEE ALSO
62ad30f8e7SGabor Kovesdan.Xr iconv 3
63ad30f8e7SGabor Kovesdan.Sh STANDARDS
64ad30f8e7SGabor KovesdanThe
65ad30f8e7SGabor Kovesdan.Nm
66ad30f8e7SGabor Kovesdanfunction is a non-standard extension, which appeared in
67ad30f8e7SGabor Kovesdanthe GNU implementation and was adopted in
68d7d8b00bSUlrich Spörlein.Fx 9.0
69ad30f8e7SGabor Kovesdanfor compatibility's sake.
70ad30f8e7SGabor Kovesdan.Sh AUTHORS
71ad30f8e7SGabor KovesdanThis manual page was written by
72*8fbf3d50SBaptiste Daroussin.An Gabor Kovesdan Aq Mt gabor@FreeBSD.org .
73