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