doc/yaz-iconv-man.xml

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