2014-06-11 08:09:40 +00:00
|
|
|
|
'\" t -*- coding: UTF-8 -*-
|
|
|
|
|
.\"
|
|
|
|
|
.\" Copyright (C) 2014 Marko Myllynen <myllynen@redhat.com>
|
|
|
|
|
.\"
|
|
|
|
|
.\" %%%LICENSE_START(GPLv2+_DOC_FULL)
|
|
|
|
|
.\" This is free documentation; you can redistribute it and/or
|
|
|
|
|
.\" modify it under the terms of the GNU General Public License as
|
|
|
|
|
.\" published by the Free Software Foundation; either version 2 of
|
|
|
|
|
.\" the License, or (at your option) any later version.
|
|
|
|
|
.\"
|
|
|
|
|
.\" The GNU General Public License's references to "object code"
|
|
|
|
|
.\" and "executables" are to be interpreted as the output of any
|
|
|
|
|
.\" document formatting or typesetting system, including
|
|
|
|
|
.\" intermediate and printed output.
|
|
|
|
|
.\"
|
|
|
|
|
.\" This manual is distributed in the hope that it will be useful,
|
|
|
|
|
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
.\" GNU General Public License for more details.
|
|
|
|
|
.\"
|
|
|
|
|
.\" You should have received a copy of the GNU General Public
|
|
|
|
|
.\" License along with this manual; if not, see
|
|
|
|
|
.\" <http://www.gnu.org/licenses/>.
|
|
|
|
|
.\" %%%LICENSE_END
|
|
|
|
|
.\"
|
iconv.1, ldd.1, connect.2, dup.2, epoll_ctl.2, eventfd.2, fallocate.2, fcntl.2, getitimer.2, inotify_add_watch.2, open.2, pipe.2, poll.2, sendmmsg.2, set_tid_address.2, shmop.2, signalfd.2, splice.2, syscalls.2, syslog.2, tee.2, vmsplice.2, ether_aton.3, mallopt.3, printf.3, profil.3, charmap.5, proc.5, epoll.7, inotify.7, libc.7, pipe.7, sched.7, socket.7, udplite.7, iconvconfig.8, ld.so.8: tstamp
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2014-07-08 14:14:48 +00:00
|
|
|
|
.TH ICONV 1 2014-07-08 "GNU" "Linux User Manual"
|
2014-06-11 08:09:40 +00:00
|
|
|
|
.SH NAME
|
|
|
|
|
iconv \- convert text from one character encoding to another
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.B iconv
|
|
|
|
|
.RI [ options ]
|
|
|
|
|
.RI "[-f " from-encoding "]"
|
|
|
|
|
.RI "[-t " to-encoding "]"
|
|
|
|
|
.RI [ inputfile ]...
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.B iconv
|
|
|
|
|
program reads in text in one encoding and outputs the text in another
|
|
|
|
|
encoding.
|
|
|
|
|
If no input files are given, or if it is given as a dash (\-),
|
|
|
|
|
.B iconv
|
2014-06-11 10:05:09 +00:00
|
|
|
|
reads from standard input.
|
2014-06-11 08:09:40 +00:00
|
|
|
|
If no output file is given,
|
|
|
|
|
.B iconv
|
2014-06-11 10:05:09 +00:00
|
|
|
|
writes to standard output.
|
2014-06-11 08:09:40 +00:00
|
|
|
|
.PP
|
|
|
|
|
If no
|
|
|
|
|
.I from-encoding
|
|
|
|
|
is given, the default is derived
|
|
|
|
|
from the current locale's character encoding.
|
|
|
|
|
If no
|
|
|
|
|
.I to-encoding
|
|
|
|
|
is given, the default is derived
|
|
|
|
|
from the current locale's character
|
|
|
|
|
encoding.
|
|
|
|
|
.SH OPTIONS
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-f " from-encoding" ", \-\-from-code=" from-encoding
|
|
|
|
|
Use
|
|
|
|
|
.I from-encoding
|
|
|
|
|
for input characters.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-t " to-encoding" ", \-\-to-code=" to-encoding
|
|
|
|
|
Use
|
|
|
|
|
.I to-encoding
|
|
|
|
|
for output characters.
|
|
|
|
|
|
2014-06-11 10:05:09 +00:00
|
|
|
|
If the string
|
|
|
|
|
.BR //IGNORE
|
|
|
|
|
is appended to
|
|
|
|
|
.IR to-encoding ,
|
2014-06-11 08:09:40 +00:00
|
|
|
|
characters that cannot be converted are discarded and an error is
|
|
|
|
|
printed after conversion.
|
|
|
|
|
|
2014-06-11 10:05:09 +00:00
|
|
|
|
If the string
|
|
|
|
|
.BR //TRANSLIT
|
|
|
|
|
is appended to
|
|
|
|
|
.IR to-encoding ,
|
2014-06-11 08:09:40 +00:00
|
|
|
|
characters being converted are transliterated when needed and possible.
|
2014-06-11 10:05:09 +00:00
|
|
|
|
This means that when a character cannot be represented in the target
|
|
|
|
|
character set, it can be approximated through one or several similar
|
2014-06-11 08:09:40 +00:00
|
|
|
|
looking characters.
|
|
|
|
|
Characters that are outside of the target character set and cannot be
|
|
|
|
|
transliterated are replaced with a question mark (?) in the output.
|
|
|
|
|
.TP
|
2014-06-23 20:18:37 +00:00
|
|
|
|
.BR \-l ", " \-\-list
|
2014-06-11 08:09:40 +00:00
|
|
|
|
List all known character set encodings.
|
|
|
|
|
.TP
|
|
|
|
|
.B "\-c"
|
|
|
|
|
Silently discard characters that cannot be converted instead of
|
2014-06-11 10:05:09 +00:00
|
|
|
|
terminating when encountering such characters.
|
2014-06-11 08:09:40 +00:00
|
|
|
|
.TP
|
|
|
|
|
.BI \-o " outputfile" ", \-\-output=" outputfile
|
|
|
|
|
Use
|
|
|
|
|
.I outputfile
|
|
|
|
|
for output.
|
|
|
|
|
.TP
|
2014-06-23 20:18:37 +00:00
|
|
|
|
.BR \-s ", " \-\-silent
|
2014-06-11 10:05:09 +00:00
|
|
|
|
This option is ignored; it is provided only for compatibility.
|
2014-06-11 08:09:40 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B "\-\-verbose"
|
|
|
|
|
Print progress information on standard error when processing
|
|
|
|
|
multiple files.
|
|
|
|
|
.TP
|
2014-06-23 20:18:37 +00:00
|
|
|
|
.BR \-? ", " \-\-help
|
2014-06-11 08:09:40 +00:00
|
|
|
|
Print a usage summary and exit.
|
|
|
|
|
.TP
|
|
|
|
|
.B "\-\-usage"
|
|
|
|
|
Print a short usage summary and exit.
|
|
|
|
|
.TP
|
2014-06-23 20:18:37 +00:00
|
|
|
|
.BR \-V ", " \-\-version
|
2014-06-11 08:09:40 +00:00
|
|
|
|
Print the version number, license, and disclaimer of warranty for
|
|
|
|
|
.BR iconv .
|
|
|
|
|
.SH EXIT STATUS
|
|
|
|
|
Zero on success, non-zero on errors.
|
|
|
|
|
.SH ENVIRONMENT
|
|
|
|
|
Internally, the
|
|
|
|
|
.B iconv
|
|
|
|
|
program uses the
|
|
|
|
|
.BR iconv (3)
|
|
|
|
|
function which in turn uses
|
|
|
|
|
.I gconv
|
2014-06-11 19:14:34 +00:00
|
|
|
|
modules (dynamically loaded shared libraries)
|
|
|
|
|
to convert to and from a character set.
|
|
|
|
|
Before calling
|
|
|
|
|
.BR iconv (3),
|
2014-06-14 06:03:45 +00:00
|
|
|
|
the
|
2014-06-11 08:09:40 +00:00
|
|
|
|
.B iconv
|
2014-06-11 19:14:34 +00:00
|
|
|
|
program must first allocate a conversion descriptor using
|
|
|
|
|
.BR iconv_open (3).
|
|
|
|
|
The operation of the latter function is influenced by the setting of the
|
2014-06-11 08:09:40 +00:00
|
|
|
|
.B GCONV_PATH
|
2014-06-11 19:14:34 +00:00
|
|
|
|
environment variable:
|
|
|
|
|
.IP * 3
|
|
|
|
|
If
|
|
|
|
|
.B GCONV_PATH
|
|
|
|
|
is not set,
|
|
|
|
|
.BR iconv_open (3)
|
2014-06-18 11:06:26 +00:00
|
|
|
|
loads the system gconv module configuration cache file created by
|
2014-06-11 19:14:34 +00:00
|
|
|
|
.BR iconvconfig (8)
|
|
|
|
|
and then, based on the configuration,
|
|
|
|
|
loads the gconv modules needed to perform the conversion.
|
2014-06-18 11:06:26 +00:00
|
|
|
|
If the system gconv module configuration cache file is not available
|
|
|
|
|
then the system gconv module configuration file is used.
|
2014-06-11 19:14:34 +00:00
|
|
|
|
.IP *
|
2014-06-11 08:09:40 +00:00
|
|
|
|
If
|
|
|
|
|
.B GCONV_PATH
|
2014-06-11 19:14:34 +00:00
|
|
|
|
is defined (as a colon-separated list of pathnames),
|
|
|
|
|
the system gconv module configuration cache is not used.
|
|
|
|
|
Instead,
|
|
|
|
|
.BR iconv_open (3)
|
2014-06-13 11:43:25 +00:00
|
|
|
|
first tries to load the configuration files by searching the directories in
|
|
|
|
|
.BR GCONV_PATH
|
|
|
|
|
in order,
|
|
|
|
|
followed by the system default gconv module configuration file.
|
2014-06-11 19:14:34 +00:00
|
|
|
|
If a directory does not contain a gconv module configuration file,
|
|
|
|
|
any gconv modules that it may contain are ignored.
|
|
|
|
|
If a directory contains a gconv module configuration file
|
|
|
|
|
and it is determined that a module needed for this conversion is
|
|
|
|
|
available in the directory,
|
|
|
|
|
then the needed module is loaded from that directory,
|
|
|
|
|
the order being such that the first suitable module found in
|
|
|
|
|
.B GCONV_PATH
|
|
|
|
|
is used.
|
|
|
|
|
This allows users to use custom modules and even replace system-provided
|
|
|
|
|
modules by providing such modules in
|
|
|
|
|
.B GCONV_PATH
|
|
|
|
|
directories.
|
2014-06-11 08:09:40 +00:00
|
|
|
|
.SH FILES
|
|
|
|
|
.TP
|
|
|
|
|
.I /usr/lib/gconv
|
|
|
|
|
Usual default gconv module path.
|
|
|
|
|
.TP
|
|
|
|
|
.I /usr/lib/gconv/gconv-modules
|
2014-06-18 11:06:26 +00:00
|
|
|
|
Usual system default gconv module configuration file.
|
2014-06-11 08:09:40 +00:00
|
|
|
|
.TP
|
|
|
|
|
.I /usr/lib/gconv/gconv-modules.cache
|
2014-06-18 11:06:26 +00:00
|
|
|
|
Usual system gconv module configuration cache.
|
2014-06-11 08:09:40 +00:00
|
|
|
|
.SH CONFORMING TO
|
|
|
|
|
POSIX.1-2001.
|
|
|
|
|
.SH EXAMPLE
|
2014-06-11 10:05:09 +00:00
|
|
|
|
Convert text from the ISO 8859-15 character encoding to UTF-8:
|
|
|
|
|
|
|
|
|
|
.in +4n
|
|
|
|
|
.nf
|
|
|
|
|
$ \fBiconv \-f ISO\-8859\-15 -t UTF\-8 < input.txt > output.txt\fP
|
|
|
|
|
.fi
|
|
|
|
|
.in
|
2014-06-11 08:09:40 +00:00
|
|
|
|
.PP
|
|
|
|
|
The next example converts from UTF-8 to ASCII, transliterating when
|
|
|
|
|
possible:
|
|
|
|
|
|
2014-06-11 10:05:09 +00:00
|
|
|
|
.in +4n
|
2014-06-11 08:09:40 +00:00
|
|
|
|
.nf
|
2014-06-11 10:05:09 +00:00
|
|
|
|
$ \fBecho abc ß α € àḃç | iconv \-f UTF\-8 \-t ASCII//TRANSLIT\fP
|
2014-06-11 08:09:40 +00:00
|
|
|
|
abc ss ? EUR abc
|
|
|
|
|
.fi
|
2014-06-11 10:05:09 +00:00
|
|
|
|
.in
|
iconv.1, localedef.1, access.2, execveat.2, fanotify_init.2, futex.2, ioctl_fat.2, mount.2, ftw.3, sd.4, tty_ioctl.4, fanotify.7, futex.7, posixoptions.7, iconvconfig.8: srcfix: Remove useless quotes from .SS and .SH sections
Signed-off-by: Stéphane Aulery <saulery@free.fr>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2015-03-08 02:03:52 +00:00
|
|
|
|
.SH SEE ALSO
|
2014-06-11 08:09:40 +00:00
|
|
|
|
.BR locale (1),
|
|
|
|
|
.BR iconv (3),
|
|
|
|
|
.BR nl_langinfo (3),
|
|
|
|
|
.BR charsets (7),
|
|
|
|
|
.BR iconvconfig (8)
|