285 lines
10 KiB
HTML
285 lines
10 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta name="generator" content="HTML Tidy, see www.w3.org">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
|
|
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
|
|
<title>iconv</title>
|
|
</head>
|
|
<body bgcolor="white">
|
|
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
|
|
</script>
|
|
|
|
<basefont size="3"> <a name="iconv"></a> <a name="tag_04_66"></a><!-- iconv -->
|
|
<!--header start-->
|
|
<center><font size="2">The Open Group Base Specifications Issue 6<br>
|
|
IEEE Std 1003.1-2001<br>
|
|
Copyright © 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
|
|
|
|
<!--header end-->
|
|
<hr size="2" noshade>
|
|
<h4><a name="tag_04_66_01"></a>NAME</h4>
|
|
|
|
<blockquote>iconv - codeset conversion</blockquote>
|
|
|
|
<h4><a name="tag_04_66_02"></a>SYNOPSIS</h4>
|
|
|
|
<blockquote class="synopsis">
|
|
<p><code><tt>iconv</tt> <b>[</b><tt>-cs</tt><b>]</b> <tt>-f</tt> <i>fromcode</i> <tt>-t</tt> <i>tocode</i> <b>[</b><i>file</i>
|
|
<tt>...</tt><b>]</b><tt><br>
|
|
<br>
|
|
iconv -l<br>
|
|
</tt></code></p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_03"></a>DESCRIPTION</h4>
|
|
|
|
<blockquote>
|
|
<p>The <i>iconv</i> utility shall convert the encoding of characters in <i>file</i> from one codeset to another and write the
|
|
results to standard output.</p>
|
|
|
|
<p>When the options indicate that charmap files are used to specify the codesets (see OPTIONS), the codeset conversion shall be
|
|
accomplished by performing a logical join on the symbolic character names in the two charmaps. The implementation need not support
|
|
the use of charmap files for codeset conversion unless the POSIX2_LOCALEDEF symbol is defined on the system.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_04"></a>OPTIONS</h4>
|
|
|
|
<blockquote>
|
|
<p>The <i>iconv</i> utility shall conform to the Base Definitions volume of IEEE Std 1003.1-2001, <a href=
|
|
"../basedefs/xbd_chap12.html#tag_12_02">Section 12.2, Utility Syntax Guidelines</a>.</p>
|
|
|
|
<p>The following options shall be supported:</p>
|
|
|
|
<dl compact>
|
|
<dt><b>-c</b></dt>
|
|
|
|
<dd>Omit any invalid characters from the output. When <b>-c</b> is not used, the results of encountering invalid characters in the
|
|
input stream (either those that are not valid members of the <i>fromcode</i> or those that have no corresponding value in
|
|
<i>tocode</i>) shall be specified in the system documentation. The presence or absence of <b>-c</b> shall not affect the exit
|
|
status of <i>iconv</i>.</dd>
|
|
|
|
<dt><b>-f </b> <i>fromcode</i></dt>
|
|
|
|
<dd>Identify the codeset of the input file. If the option-argument contains a slash character, <i>iconv</i> shall attempt to use it
|
|
as the pathname of a charmap file, as defined in the Base Definitions volume of IEEE Std 1003.1-2001, <a href=
|
|
"../basedefs/xbd_chap06.html#tag_06_04">Section 6.4, Character Set Description File</a>. If the pathname does not represent a
|
|
valid, readable charmap file, the results are undefined. If the option-argument does not contain a slash, it shall be considered
|
|
the name of one of the codeset descriptions provided by the system, in an unspecified format. The valid values of the
|
|
option-argument without a slash are implementation-defined. If this option is omitted, the codeset of the current locale shall be
|
|
used.</dd>
|
|
|
|
<dt><b>-l</b></dt>
|
|
|
|
<dd>Write all supported <i>fromcode</i> and <i>tocode</i> values to standard output in an unspecified format.</dd>
|
|
|
|
<dt><b>-s</b></dt>
|
|
|
|
<dd>Suppress any messages written to standard error concerning invalid characters. When <b>-s</b> is not used, the results of
|
|
encountering invalid characters in the input stream (either those that are not valid members of the <i>fromcode</i> or those that
|
|
have no corresponding value in <i>tocode</i>) shall be specified in the system documentation. The presence or absence of <b>-s</b>
|
|
shall not affect the exit status of <i>iconv</i>.</dd>
|
|
|
|
<dt><b>-t </b> <i>tocode</i></dt>
|
|
|
|
<dd>Identify the codeset to be used for the output file. The semantics shall be equivalent to the <b>-f</b> <i>fromcode</i>
|
|
option.</dd>
|
|
</dl>
|
|
|
|
<p>If either <b>-f</b> or <b>-t</b> represents a charmap file, but the other does not (or is omitted), or both <b>-f</b> and
|
|
<b>-t</b> are omitted, the results are undefined.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_05"></a>OPERANDS</h4>
|
|
|
|
<blockquote>
|
|
<p>The following operand shall be supported:</p>
|
|
|
|
<dl compact>
|
|
<dt><i>file</i></dt>
|
|
|
|
<dd>A pathname of an input file. If no <i>file</i> operands are specified, or if a <i>file</i> operand is <tt>'-'</tt> , the
|
|
standard input shall be used.</dd>
|
|
</dl>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_06"></a>STDIN</h4>
|
|
|
|
<blockquote>
|
|
<p>The standard input shall be used only if no <i>file</i> operands are specified, or if a <i>file</i> operand is <tt>'-'</tt>
|
|
.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_07"></a>INPUT FILES</h4>
|
|
|
|
<blockquote>
|
|
<p>The input file shall be a text file.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_08"></a>ENVIRONMENT VARIABLES</h4>
|
|
|
|
<blockquote>
|
|
<p>The following environment variables shall affect the execution of <i>iconv</i>:</p>
|
|
|
|
<dl compact>
|
|
<dt><i>LANG</i></dt>
|
|
|
|
<dd>Provide a default value for the internationalization variables that are unset or null. (See the Base Definitions volume of
|
|
IEEE Std 1003.1-2001, <a href="../basedefs/xbd_chap08.html#tag_08_02">Section 8.2, Internationalization Variables</a> for
|
|
the precedence of internationalization variables used to determine the values of locale categories.)</dd>
|
|
|
|
<dt><i>LC_ALL</i></dt>
|
|
|
|
<dd>If set to a non-empty string value, override the values of all the other internationalization variables.</dd>
|
|
|
|
<dt><i>LC_CTYPE</i></dt>
|
|
|
|
<dd>Determine the locale for the interpretation of sequences of bytes of text data as characters (for example, single-byte as
|
|
opposed to multi-byte characters in arguments). During translation of the file, this variable is superseded by the use of the
|
|
<i>fromcode</i> option-argument.</dd>
|
|
|
|
<dt><i>LC_MESSAGES</i></dt>
|
|
|
|
<dd>Determine the locale that should be used to affect the format and contents of diagnostic messages written to standard
|
|
error.</dd>
|
|
|
|
<dt><i>NLSPATH</i></dt>
|
|
|
|
<dd><sup>[<a href="javascript:open_code('XSI')">XSI</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
|
|
Determine the location of message catalogs for the processing of <i>LC_MESSAGES .</i> <img src="../images/opt-end.gif" alt=
|
|
"[Option End]" border="0"></dd>
|
|
</dl>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_09"></a>ASYNCHRONOUS EVENTS</h4>
|
|
|
|
<blockquote>
|
|
<p>Default.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_10"></a>STDOUT</h4>
|
|
|
|
<blockquote>
|
|
<p>When the <b>-l</b> option is used, the standard output shall contain all supported <i>fromcode</i> and <i>tocode</i> values,
|
|
written in an unspecified format.</p>
|
|
|
|
<p>When the <b>-l</b> option is not used, the standard output shall contain the sequence of characters read from the input files,
|
|
translated to the specified codeset. Nothing else shall be written to the standard output.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_11"></a>STDERR</h4>
|
|
|
|
<blockquote>
|
|
<p>The standard error shall be used only for diagnostic messages.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_12"></a>OUTPUT FILES</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_13"></a>EXTENDED DESCRIPTION</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_14"></a>EXIT STATUS</h4>
|
|
|
|
<blockquote>
|
|
<p>The following exit values shall be returned:</p>
|
|
|
|
<dl compact>
|
|
<dt> 0</dt>
|
|
|
|
<dd>Successful completion.</dd>
|
|
|
|
<dt>>0</dt>
|
|
|
|
<dd>An error occurred.</dd>
|
|
</dl>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_15"></a>CONSEQUENCES OF ERRORS</h4>
|
|
|
|
<blockquote>
|
|
<p>Default.</p>
|
|
</blockquote>
|
|
|
|
<hr>
|
|
<div class="box"><em>The following sections are informative.</em></div>
|
|
|
|
<h4><a name="tag_04_66_16"></a>APPLICATION USAGE</h4>
|
|
|
|
<blockquote>
|
|
<p>The user must ensure that both charmap files use the same symbolic names for characters the two codesets have in common.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_17"></a>EXAMPLES</h4>
|
|
|
|
<blockquote>
|
|
<p>The following example converts the contents of file <b>mail.x400</b> from the ISO/IEC 6937:1994 standard codeset to the
|
|
ISO/IEC 8859-1:1998 standard codeset, and stores the results in file <b>mail.local</b>:</p>
|
|
|
|
<pre>
|
|
<tt>iconv -f IS6937 -t IS8859 mail.x400 > mail.local
|
|
</tt>
|
|
</pre>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_18"></a>RATIONALE</h4>
|
|
|
|
<blockquote>
|
|
<p>The <i>iconv</i> utility can be used portably only when the user provides two charmap files as option-arguments. This is because
|
|
a single charmap provided by the user cannot reliably be joined with the names in a system-provided character set description. The
|
|
valid values for <i>fromcode</i> and <i>tocode</i> are implementation-defined and do not have to have any relation to the charmap
|
|
mechanisms. As an aid to interactive users, the <b>-l</b> option was adopted from the Plan 9 operating system. It writes
|
|
information concerning these implementation-defined values. The format is unspecified because there are many possible useful
|
|
formats that could be chosen, such as a matrix of valid combinations of <i>fromcode</i> and <i>tocode</i>. The <b>-l</b> option is
|
|
not intended for shell script usage; conforming applications will have to use charmaps.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_19"></a>FUTURE DIRECTIONS</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_20"></a>SEE ALSO</h4>
|
|
|
|
<blockquote>
|
|
<p><a href="gencat.html"><i>gencat</i></a></p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_21"></a>CHANGE HISTORY</h4>
|
|
|
|
<blockquote>
|
|
<p>First released in Issue 3.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_04_66_22"></a>Issue 6</h4>
|
|
|
|
<blockquote>
|
|
<p>This utility has been rewritten to align with the IEEE P1003.2b draft standard. Specifically, the ability to use charmap
|
|
files for conversion has been added.</p>
|
|
</blockquote>
|
|
|
|
<div class="box"><em>End of informative text.</em></div>
|
|
|
|
<hr>
|
|
<hr size="2" noshade>
|
|
<center><font size="2"><!--footer start-->
|
|
UNIX ® is a registered Trademark of The Open Group.<br>
|
|
POSIX ® is a registered Trademark of The IEEE.<br>
|
|
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
|
|
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
|
|
]</font></center>
|
|
|
|
<!--footer end-->
|
|
<hr size="2" noshade>
|
|
</body>
|
|
</html>
|
|
|