doc/yaz-iconv-man.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
   2  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
   3 [
   4      <!ENTITY % local SYSTEM "local.ent">
   5      %local;
   6      <!ENTITY % entities SYSTEM "entities.ent">
   7      %entities;
   8      <!ENTITY % idcommon SYSTEM "common/common.ent">
   9      %idcommon;
  10 ]>
  11 <refentry id="yaz-iconv">
  12  <refentryinfo>
  13   <productname>YAZ</productname>
  14   <productnumber>&version;</productnumber>
  15   <info><orgname>Index Data</orgname></info>
  16  </refentryinfo>
  17
  18  <refmeta>
  19   <refentrytitle>yaz-iconv</refentrytitle>
  20   <manvolnum>1</manvolnum>
  21   <refmiscinfo class="manual">Commands</refmiscinfo>
  22  </refmeta>
  23
  24  <refnamediv>
  25   <refname>yaz-iconv</refname>
  26   <refpurpose>YAZ Character set conversion utility</refpurpose>
  27  </refnamediv>
  28
  29  <refsynopsisdiv>
  30   <cmdsynopsis>
  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>
  36   </cmdsynopsis>
  37  </refsynopsisdiv>
  38
  39  <refsect1><title>DESCRIPTION</title>
  40   <para>
  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>.
  44   </para>
  45   <para>
  46    This <command>yaz-iconv</command> utility similar to the
  47    <command>iconv</command> found on many POSIX systems (Glibc, Solaris, etc).
  48   </para>
  49   <para>
  50    If no <replaceable>file</replaceable> is specified,
  51    <command>yaz-iconv</command> reads from standard input.
  52   </para>
  53  </refsect1>
  54
  55  <refsect1><title>OPTIONS</title>
  56
  57   <variablelist>
  58    <varlistentry>
  59     <term>-f<replaceable>from</replaceable>]</term>
  60     <listitem><para>
  61       Specify the character set <replaceable>from</replaceable>
  62       of the input file.
  63       Should be used in conjunction with option <literal>-t</literal>.
  64      </para></listitem>
  65    </varlistentry>
  66
  67    <varlistentry>
  68     <term>-t<replaceable>to</replaceable>]</term>
  69     <listitem><para>
  70       Specify the character set <replaceable>of</replaceable>
  71       of the output.
  72       Should be used in conjunction with option <literal>-f</literal>.
  73      </para></listitem>
  74    </varlistentry>
  75
  76    <varlistentry>
  77     <term>-v</term>
  78     <listitem><para>
  79       Print more information about the conversion process.
  80      </para></listitem>
  81    </varlistentry>
  82
  83   </variablelist>
  84  </refsect1>
  85
  86  <refsect1><title>ENCODINGS</title>
  87   <para>
  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.
  97   </para>
  98   <variablelist>
  99    <varlistentry>
 100     <term>marc8 (encode, decode)</term>
 101     <listitem>
 102      <para>
 103       The <ulink url="&url.marc8;">MARC8</ulink> encoding as defined by
 104       the Library of Congress. Most MARC21/USMARC records use this encoding.
 105      </para>
 106     </listitem>
 107    </varlistentry>
 108    <varlistentry>
 109     <term>marc8s (encode, decode)</term>
 110     <listitem>
 111      <para>
 112       Like MARC8 but with conversion prefers non-combined characters
 113       in the Latin-1 plane over combined characters.
 114      </para>
 115     </listitem>
 116    </varlistentry>
 117    <varlistentry>
 118     <term>marc8lossy (encode)</term>
 119     <listitem>
 120      <para>
 121       Lossy encoding of MARC-8.
 122      </para>
 123     </listitem>
 124    </varlistentry>
 125    <varlistentry>
 126     <term>marc8lossless (encode)</term>
 127     <listitem>
 128      <para>
 129       Lossless encoding of MARC8.
 130      </para>
 131     </listitem>
 132    </varlistentry>
 133    <varlistentry>
 134     <term>utf8 (encode, decode)</term>
 135     <listitem>
 136      <para>
 137       The most commonly used UNICODE encoding on the Internet.
 138      </para>
 139     </listitem>
 140    </varlistentry>
 141    <varlistentry>
 142     <term>iso8859-1 (encode, decode)</term>
 143     <listitem>
 144      <para>
 145       ISO-8859-1, AKA Latin-1.
 146      </para>
 147     </listitem>
 148    </varlistentry>
 149    <varlistentry>
 150     <term>iso5426 (decode)</term>
 151     <listitem>
 152      <para>
 153       ISO 5426. Some MARC records (UNIMARC) use this encoding.
 154      </para>
 155     </listitem>
 156    </varlistentry>
 157    <varlistentry>
 158     <term>iso5428:1984 (encode, decode)</term>
 159     <listitem>
 160      <para>
 161       ISO 5428:1984.
 162      </para>
 163     </listitem>
 164    </varlistentry>
 165    <varlistentry>
 166     <term>advancegreek (encode, decode)</term>
 167     <listitem>
 168      <para>
 169       An encoding for Greek in use by some vendors (Advance).
 170      </para>
 171     </listitem>
 172    </varlistentry>
 173    <varlistentry>
 174     <term>danmarc (decode)</term>
 175     <listitem>
 176      <para>
 177       <ulink url="&url.danmarc.charset;">Danmarc (in danish)</ulink> is
 178       an encoding based on UNICODE which is used for DanMARC2 records.
 179      </para>
 180     </listitem>
 181    </varlistentry>
 182   </variablelist>
 183  </refsect1>
 184
 185  <refsect1><title>EXAMPLES</title>
 186   <para>
 187    The following command converts from ISO-8859-1 (Latin-1) to
 188    UTF-8.
 189    <screen>
 190     yaz-iconv -f ISO-8859-1 -t UTF-8 &lt;input.lst &gt;output.lst
 191    </screen>
 192   </para>
 193  </refsect1>
 194
 195  <refsect1><title>FILES</title>
 196   <para>
 197    <filename><replaceable>prefix</replaceable>/bin/yaz-iconv</filename>
 198   </para>
 199   <para>
 200    <filename><replaceable>prefix</replaceable>/include/yaz/yaz-iconv.h</filename>
 201   </para>
 202  </refsect1>
 203  <refsect1><title>SEE ALSO</title>
 204   <para>
 205    yaz(7)
 206    iconv(1)
 207   </para>
 208  </refsect1>
 209 </refentry>
 210
 211 <!-- Keep this comment at the end of the file
 212 Local variables:
 213 mode: nxml
 214 nxml-child-indent: 1
 215 End:
 216 -->