1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
2 "http://www.oasis-open.org/docbook/xml/4.1/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>
18 <refentrytitle>yaz-iconv</refentrytitle>
19 <manvolnum>1</manvolnum>
23 <refname>yaz-iconv</refname>
24 <refpurpose>YAZ Charcter set conversion utility</refpurpose>
29 <command>yaz-iconv</command>
30 <arg choice="opt"><option>-f <replaceable>from</replaceable></option></arg>
31 <arg choice="opt"><option>-t <replaceable>to</replaceable></option></arg>
32 <arg choice="opt"><option>-v</option></arg>
33 <arg choice="opt" rep="repeat">file</arg>
37 <refsect1><title>DESCRIPTION</title>
39 <command>yaz-iconv</command> converts data in file in character
40 set specified by <replaceable>from</replaceable> to output in
41 character set as specified by <replaceable>to</replaceable>.
44 This <command>yaz-iconv</command> utility similar to the
45 <command>iconv</command> found on many POSIX systems (Glibc, Solaris, etc).
48 If no <replaceable>file</replaceable> is specified,
49 <command>yaz-iconv</command> reads from standard input.
53 <refsect1><title>OPTIONS</title>
57 <term>-f<replaceable>from</replaceable>]</term>
59 Specify the character set <replaceable>from</replaceable>
61 Should be used in conjunction with option <literal>-t</literal>.
66 <term>-t<replaceable>to</replaceable>]</term>
68 Specify the character set <replaceable>of</replaceable>
70 Should be used in conjunction with option <literal>-f</literal>.
77 Print more information about the conversion process.
84 <refsect1><title>ENCODINGS</title>
86 The yaz-iconv command and the API as defined in
87 <filename>yaz/yaz-iconv.h</filename> is a wrapper for the
88 library system call iconv. But YAZ' implementation also implements
89 conversions on its own. So regardless of iconv, the following
90 below are always supported by YAZ:
94 <term>marc8 (encode, decode)</term>
96 The <ulink url="&url.marc8;">MARC8</ulink> encoding as defined by
97 the Library of Congress. Most MARC21/USMARC records usees
102 <term>marc8s (encode, decode)</term>
104 Like MARC8 but with conversion prefers non-combined characters
105 in the Latin-1 plane over combined characters.
109 <term>marc8lossy (encode)</term>
111 Lossy encoding of MARC-8.
115 <term>marc8lossless (encode)</term>
117 Lossless encoding of MARC8.
121 <term>utf8 (encode, decode)</term>
123 The most commonly used UNICODE encoding on the Internet.
127 <term>iso8859-1 (encode, decode)</term>
129 ISO-8859-1, AKA Latin-1.
133 <term>iso5426 (decode)</term>
135 ISO 5426. Some MARC records (UNIMARC) uses this encoding.
139 <term>iso5428:1984 (encode, decode)</term>
145 <term>advancegreek (encode, decode)</term>
147 An encoding for Greek used by some vendors (Advance).
153 <refsect1><title>EXAMPLES</title>
155 The following command converts from ISO-8859-1 (Latin-1) to
158 yaz-iconv -f ISO-8859-1 -t UTF-8 -X <input.lst >output.lst
163 <refsect1><title>FILES</title>
165 <filename><replaceable>prefix</replaceable>/bin/yaz-iconv</filename>
168 <filename><replaceable>prefix</replaceable>/include/yaz/yaz-iconv.h</filename>
171 <refsect1><title>SEE ALSO</title>
179 <!-- Keep this comment at the end of the file
184 sgml-minimize-attributes:nil
185 sgml-always-quote-attributes:t
188 sgml-parent-document:nil
189 sgml-local-catalogs: nil
190 sgml-namecase-general:t