Copyright 1989 AT&T
Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.
The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
This notice shall appear on any product containing this material.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
iconv [-cs] -f frommap -t tomap [file]...
iconv -f fromcode [-cs] [-t tocode] [file]...
iconv -t tocode [-cs] [-f fromcode] [file]...
iconv -l
The iconv utility converts the characters or sequences of characters in file from one code set to another and writes the results to standard output. If no conversion exists for a particular character, an implementation-defined conversion is performed on this character.
The list of supported conversions and the locations of the associated conversion tables are provided in the iconv(5) manual page.
The following options are supported:
-c
Omits any characters that are invalid in the codeset of the input file from the output. When -c is not used, the results of encountering invalid characters in the input stream depend on the specified codesets for the conversion. Invalid characters can be either those that are not valid characters in the codeset of the input file or those that have no corresponding character in the codeset of the output file. The presence or absence of -c does not affect the exit status of iconv. When fromcode is specified for the fromcodeset of the -f option or tocode is specified for the tocodeset of the -t option, the specification of -c may be ignored.
-f fromcodeset
Identifies the code set of the input file. The following two forms of the fromcodeset option-argument are recognized:
fromcode
The fromcode option-argument must not contain a slash (/) character. It is interpreted as the name of one of the codeset descriptions.
frommap
The frommap option-argument must contain a slash character. It is interpreted as the pathname of a charmap file as defined in charmap(5). If the pathname does not represent a valid, readable charmap file, the results are undefined.
-l
Writes all supported fromcode and tocode values to standard output.
-s
Suppresses any messages written to standard error concerning invalid characters. When -s is not used, the results of encountering invalid characters in the input stream depend on the specified codesets for the conversion. Invalid characters can be either those that are not valid characters in the codeset of the input file or those that have no corresponding character in the codeset of the output file. The presence or absence of -s does not affect the exit status of iconv. When fromcode is specified for the fromcodeset of the -f option or tocode is specified for the tocodeset of the -t option, the specification of -s may be ignored.
-t tocodeset
Identifies the code set used for the output file. The following two forms of the tocodeset option-argument are recognized:
tocode
The tocode option-argument must not contain a slash (/) character. It is interpreted as the name of one of the codeset descriptions.
tomap
The tomap option-argument must contain a slash character. It is interpreted as the pathname of a charmap file as defined in charmap(5). If the pathname does not represent a valid, readable charmap file, the results are undefined.
If either -f or -t represents a charmap file but the other does not, or is omitted, or if both -f and -t are omitted, iconv fails as an error.
The following operands are supported:
file
A path name of an input file. If no file operands are specified, or if a file operand is '-', the standard input is used.
Example 1 Converting and storing files
The following example converts the contents of file mail1 from code set 8859 to 646fr and stores the results in file mail.local:
example% iconv -f 8859 -t 646fr mail1 > mail.local
See environ(5) for descriptions of the following environment variables that affect the execution of iconv: LANG, LC_ALL, LC_CTYPE, LC_MESSAGES, and NLSPATH.
The following exit values are returned:
0
Successful completion.
1
An error has occurred.
list of conversions supported by conversion tables
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
| Interface Stability | Standard |
iconv(3C), iconv_open(3C), attributes(5), charmap(5), environ(5), iconv(5), iconv_unicode(5), standards(5)
Make sure that both charmap files use the same symbolic names for characters the two codesets have in common.
The output format of the -l option is unspecified. The -l option is not intended for shell script usage.
When fromcode or tocode is specified for the codeset conversion, iconv uses the iconv_open(3C) function. If iconv_open(3C) fails to open the specified codeset conversion, iconv searches for an appropriate conversion table. As for the supported codeset conversion by iconv_open(3C), please refer to iconv(5) and iconv_locale(5).