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>EXAMPLES</title>
  85   <para>
  86    The following command converts from ISO-8859-1 (Latin-1) to
  87    UTF-8.
  88    <screen>
  89     yaz-iconv -f ISO-8859-1 -t UTF-8 -X &lt;input.lst &gt;output.lst
  90    </screen>
  91   </para>
  92  </refsect1>
  93
  94  <refsect1><title>FILES</title>
  95   <para>
  96    <filename><replaceable>prefix</replaceable>/bin/yaz-iconv</filename>
  97   </para>
  98   <para>
  99    <filename><replaceable>prefix</replaceable>/include/yaz/yaz-iconv.h</filename>
 100   </para>
 101  </refsect1>
 102  <refsect1><title>SEE ALSO</title>
 103   <para>
 104    yaz(7)
 105    iconv(1)
 106   </para>
 107  </refsect1>
 108 </refentry>
 109
 110 <!-- Keep this comment at the end of the file
 111 Local variables:
 112 mode: sgml
 113 sgml-omittag:t
 114 sgml-shorttag:t
 115 sgml-minimize-attributes:nil
 116 sgml-always-quote-attributes:t
 117 sgml-indent-step:1
 118 sgml-indent-data:t
 119 sgml-parent-document:nil
 120 sgml-local-catalogs: nil
 121 sgml-namecase-general:t
 122 End:
 123 -->