xref: /dflybsd-src/lib/libc/iconv/iconv_canonicalize.3 (revision d118ff3c3a4b3be37ffc939d7b34ef753cc61733)
10d5acd74SJohn Marino.\" Copyright (c) 2009 Gabor Kovesdan <gabor@FreeBSD.org>
20d5acd74SJohn Marino.\" All rights reserved.
30d5acd74SJohn Marino.\"
40d5acd74SJohn Marino.\" Redistribution and use in source and binary forms, with or without
50d5acd74SJohn Marino.\" modification, are permitted provided that the following conditions
60d5acd74SJohn Marino.\" are met:
70d5acd74SJohn Marino.\" 1. Redistributions of source code must retain the above copyright
80d5acd74SJohn Marino.\"    notice, this list of conditions and the following disclaimer.
90d5acd74SJohn Marino.\" 2. Redistributions in binary form must reproduce the above copyright
100d5acd74SJohn Marino.\"    notice, this list of conditions and the following disclaimer in the
110d5acd74SJohn Marino.\"    documentation and/or other materials provided with the distribution.
120d5acd74SJohn Marino.\"
130d5acd74SJohn Marino.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
140d5acd74SJohn Marino.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
150d5acd74SJohn Marino.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
160d5acd74SJohn Marino.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
170d5acd74SJohn Marino.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
180d5acd74SJohn Marino.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
190d5acd74SJohn Marino.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
200d5acd74SJohn Marino.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
210d5acd74SJohn Marino.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
220d5acd74SJohn Marino.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
230d5acd74SJohn Marino.\" SUCH DAMAGE.
240d5acd74SJohn Marino.\"
250d5acd74SJohn Marino.\" Portions of this text are reprinted and reproduced in electronic form
260d5acd74SJohn Marino.\" from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology --
270d5acd74SJohn Marino.\" Portable Operating System Interface (POSIX), The Open Group Base
280d5acd74SJohn Marino.\" Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of
290d5acd74SJohn Marino.\" Electrical and Electronics Engineers, Inc and The Open Group.  In the
300d5acd74SJohn Marino.\" event of any discrepancy between this version and the original IEEE and
310d5acd74SJohn Marino.\" The Open Group Standard, the original IEEE and The Open Group Standard is
320d5acd74SJohn Marino.\" the referee document.  The original Standard can be obtained online at
330d5acd74SJohn Marino.\"	http://www.opengroup.org/unix/online.html.
340d5acd74SJohn Marino.\"
350d5acd74SJohn Marino.\" $FreeBSD: head/lib/libc/iconv/iconv_canonicalize.3 219019 2011-02-25 00:04:39Z gabor $
360d5acd74SJohn Marino.\"
370d5acd74SJohn Marino.Dd September 19, 2013
380d5acd74SJohn Marino.Dt ICONV_CANONICALIZE 3
390d5acd74SJohn Marino.Os
400d5acd74SJohn Marino.Sh NAME
410d5acd74SJohn Marino.Nm iconv_canonicalize
420d5acd74SJohn Marino.Nd resolving character encoding names to canonical form
430d5acd74SJohn Marino.Sh LIBRARY
440d5acd74SJohn Marino.Lb libc
450d5acd74SJohn Marino.Sh SYNOPSIS
460d5acd74SJohn Marino.In iconv.h
470d5acd74SJohn Marino.Ft const char *
480d5acd74SJohn Marino.Fn iconv_canonicalize "const char *name"
490d5acd74SJohn Marino.Sh DESCRIPTION
500d5acd74SJohn MarinoThe
510d5acd74SJohn Marino.Fn iconv_canonicalize
520d5acd74SJohn Marinofunction resolves the character encoding name specified by the
530d5acd74SJohn Marino.Fa name
540d5acd74SJohn Marinoargument to its canonical form.
550d5acd74SJohn Marino.Sh RETURN VALUES
560d5acd74SJohn MarinoUpon successful completion
570d5acd74SJohn Marino.Fn iconv_canonicalize ,
580d5acd74SJohn Marinoreturns the canonical name of the given encoding.
590d5acd74SJohn MarinoIf the specified name is already a canonical name, the same
600d5acd74SJohn Marinovalue is returned.
610d5acd74SJohn MarinoIf the specified name is not an existing character encoding
620d5acd74SJohn Marinoname, NULL is returned.
630d5acd74SJohn Marino.Sh SEE ALSO
640d5acd74SJohn Marino.Xr iconv 3
650d5acd74SJohn Marino.Sh STANDARDS
660d5acd74SJohn MarinoThe
670d5acd74SJohn Marino.Nm
680d5acd74SJohn Marinofunction is a non-standard extension, which appeared in
690d5acd74SJohn Marinothe GNU implementation and was adopted in
70*d118ff3cSFranco Fichtner.Fx 9.0
710d5acd74SJohn Marinofor compatibility's sake.
720d5acd74SJohn Marino.Sh AUTHORS
730d5acd74SJohn MarinoThis manual page was written by
74*d118ff3cSFranco Fichtner.An Gabor Kovesdan Aq Mt gabor@FreeBSD.org .
75