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      <para>
  96       The <ulink url="&url.marc8;">MARC8</ulink> encoding as defined by
  97       the Library of Congress. Most MARC21/USMARC records usees
  98       this encoding.
  99      </para>
 100    </varlistentry>
 101    <varlistentry>
 102     <term>marc8s (encode, decode)</term>
 103      <para>
 104       Like MARC8 but with conversion prefers non-combined characters
 105       in the Latin-1 plane over combined characters.
 106      </para>
 107    </varlistentry>
 108    <varlistentry>
 109     <term>marc8lossy (encode)</term>
 110      <para>
 111       Lossy encoding of MARC-8.
 112      </para>
 113    </varlistentry>
 114    <varlistentry>
 115     <term>marc8lossless (encode)</term>
 116      <para>
 117       Lossless encoding of MARC8.
 118      </para>
 119    </varlistentry>
 120    <varlistentry>
 121     <term>utf8 (encode, decode)</term>
 122      <para>
 123       The most commonly used UNICODE encoding on the Internet.
 124      </para>
 125    </varlistentry>
 126    <varlistentry>
 127     <term>iso8859-1 (encode, decode)</term>
 128      <para>
 129       ISO-8859-1, AKA Latin-1.
 130      </para>
 131    </varlistentry>
 132    <varlistentry>
 133     <term>iso5426 (decode)</term>
 134      <para>
 135       ISO 5426. Some MARC records (UNIMARC) uses this encoding.
 136      </para>
 137    </varlistentry>
 138    <varlistentry>
 139     <term>iso5428:1984 (encode, decode)</term>
 140      <para>
 141       ISO 5428:1984.
 142      </para>
 143    </varlistentry>
 144    <varlistentry>
 145     <term>advancegreek (encode, decode)</term>
 146      <para>
 147       An encoding for Greek used by some vendors (Advance).
 148      </para>
 149    </varlistentry>
 150   </variablelist>
 151  </refsect1>
 152
 153  <refsect1><title>EXAMPLES</title>
 154   <para>
 155    The following command converts from ISO-8859-1 (Latin-1) to
 156    UTF-8.
 157    <screen>
 158     yaz-iconv -f ISO-8859-1 -t UTF-8 -X &lt;input.lst &gt;output.lst
 159    </screen>
 160   </para>
 161  </refsect1>
 162
 163  <refsect1><title>FILES</title>
 164   <para>
 165    <filename><replaceable>prefix</replaceable>/bin/yaz-iconv</filename>
 166   </para>
 167   <para>
 168    <filename><replaceable>prefix</replaceable>/include/yaz/yaz-iconv.h</filename>
 169   </para>
 170  </refsect1>
 171  <refsect1><title>SEE ALSO</title>
 172   <para>
 173    yaz(7)
 174    iconv(1)
 175   </para>
 176  </refsect1>
 177 </refentry>
 178
 179 <!-- Keep this comment at the end of the file
 180 Local variables:
 181 mode: sgml
 182 sgml-omittag:t
 183 sgml-shorttag:t
 184 sgml-minimize-attributes:nil
 185 sgml-always-quote-attributes:t
 186 sgml-indent-step:1
 187 sgml-indent-data:t
 188 sgml-parent-document:nil
 189 sgml-local-catalogs: nil
 190 sgml-namecase-general:t
 191 End:
 192 -->