1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
2 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
4 <!ENTITY % local SYSTEM "local.ent">
6 <!ENTITY % entities SYSTEM "entities.ent">
8 <!ENTITY % idcommon SYSTEM "common/common.ent">
11 <refentry id="yaz-iconv">
13 <productname>YAZ</productname>
14 <productnumber>&version;</productnumber>
15 <info><orgname>Index Data</orgname></info>
19 <refentrytitle>yaz-iconv</refentrytitle>
20 <manvolnum>1</manvolnum>
21 <refmiscinfo class="manual">Commands</refmiscinfo>
25 <refname>yaz-iconv</refname>
26 <refpurpose>YAZ Character set conversion utility</refpurpose>
31 <command>yaz-iconv</command>
32 <arg choice="opt"><option>-f <replaceable>from</replaceable></option></arg>
33 <arg choice="opt"><option>-t <replaceable>to</replaceable></option></arg>
34 <arg choice="opt"><option>-v</option></arg>
35 <arg choice="opt" rep="repeat">file</arg>
39 <refsect1><title>DESCRIPTION</title>
41 <command>yaz-iconv</command> converts data in file in character
42 set specified by <replaceable>from</replaceable> to output in
43 character set as specified by <replaceable>to</replaceable>.
46 This <command>yaz-iconv</command> utility similar to the
47 <command>iconv</command> found on many POSIX systems (Glibc, Solaris, etc).
50 If no <replaceable>file</replaceable> is specified,
51 <command>yaz-iconv</command> reads from standard input.
55 <refsect1><title>OPTIONS</title>
59 <term>-f<replaceable>from</replaceable>]</term>
61 Specify the character set <replaceable>from</replaceable>
63 Should be used in conjunction with option <literal>-t</literal>.
68 <term>-t<replaceable>to</replaceable>]</term>
70 Specify the character set <replaceable>of</replaceable>
72 Should be used in conjunction with option <literal>-f</literal>.
79 Print more information about the conversion process.
86 <refsect1><title>ENCODINGS</title>
88 The yaz-iconv command and the API as defined in
89 <filename>yaz/yaz-iconv.h</filename> is a wrapper for the
90 library system call iconv. But YAZ' iconv utility also implements
91 conversions on its own. The table below lists characters sets (or encodings).
92 that are supported by YAZ. Each character set is marked with either
93 <emphasis>encode</emphasis> or <emphasis>decode</emphasis>. If
94 an encoding is encode-enabled YAZ may convert <emphasis>to</emphasis>
95 to the designated encoding. If an encoding is decode-enabled, YAZ
96 may convert <emphasis>from</emphasis> the designated encoding.
100 <term>marc8 (encode, decode)</term>
103 The <ulink url="&url.marc8;">MARC8</ulink> encoding as defined by
104 the Library of Congress. Most MARC21/USMARC records use this encoding.
109 <term>marc8s (encode, decode)</term>
112 Like MARC8 but with conversion prefers non-combined characters
113 in the Latin-1 plane over combined characters.
118 <term>marc8lossy (encode)</term>
121 Lossy encoding of MARC-8.
126 <term>marc8lossless (encode)</term>
129 Lossless encoding of MARC8.
134 <term>utf8 (encode, decode)</term>
137 The most commonly used UNICODE encoding on the Internet.
142 <term>iso8859-1 (encode, decode)</term>
145 ISO-8859-1, AKA Latin-1.
150 <term>iso5426 (decode)</term>
153 ISO 5426. Some MARC records (UNIMARC) use this encoding.
158 <term>iso5428:1984 (encode, decode)</term>
166 <term>advancegreek (encode, decode)</term>
169 An encoding for Greek in use by some vendors (Advance).
174 <term>danmarc (decode)</term>
177 <ulink url="&url.danmarc.charset;">Danmarc (in danish)</ulink> is
178 an encoding based on UNICODE which is used for DanMARC2 records.
185 <refsect1><title>EXAMPLES</title>
187 The following command converts from ISO-8859-1 (Latin-1) to
190 yaz-iconv -f ISO-8859-1 -t UTF-8 <input.lst >output.lst
195 <refsect1><title>FILES</title>
197 <filename><replaceable>prefix</replaceable>/bin/yaz-iconv</filename>
200 <filename><replaceable>prefix</replaceable>/include/yaz/yaz-iconv.h</filename>
203 <refsect1><title>SEE ALSO</title>
211 <!-- Keep this comment at the end of the file