doc/yaz-iconv-man.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2 <!-- $Id: yaz-iconv-man.xml,v 1.3 2006-04-25 11:25:08 marc Exp $ -->
   3 <refentry id="yaz-iconv">
   4  <refmeta>
   5   <refentrytitle>yaz-iconv</refentrytitle>
   6   <manvolnum>1</manvolnum>
   7  </refmeta>
   8
   9  <refnamediv>
  10   <refname>yaz-iconv</refname>
  11   <refpurpose>YAZ Charcter set conversion utility</refpurpose>
  12  </refnamediv>
  13
  14  <refsynopsisdiv>
  15   <cmdsynopsis>
  16    <command>yaz-iconv</command>
  17    <arg choice="opt"><option>-f <replaceable>from</replaceable></option></arg>
  18    <arg choice="opt"><option>-t <replaceable>to</replaceable></option></arg>
  19    <arg choice="opt"><option>-v</option></arg>
  20    <arg choice="opt" rep="repeat">file</arg>
  21   </cmdsynopsis>
  22  </refsynopsisdiv>
  23
  24  <refsect1><title>DESCRIPTION</title>
  25   <para>
  26    <command>yaz-iconv</command> converts data in file in character
  27    set specified by <replaceable>from</replaceable> to output in
  28    character set as specified by <replaceable>to</replaceable>.
  29   </para>
  30   <para>
  31    This <command>yaz-iconv</command> utility similar to the
  32    <command>iconv</command> found on many POSIX systems (Glibc, Solaris, etc).
  33   </para>
  34   <para>
  35    If no <replaceable>file</replaceable> is specified,
  36    <command>yaz-iconv</command> reads from standard input.
  37   </para>
  38  </refsect1>
  39
  40  <refsect1><title>OPTIONS</title>
  41
  42   <variablelist>
  43    <varlistentry>
  44     <term>-f<replaceable>from</replaceable>]</term>
  45     <listitem><para>
  46       Specify the character set <replaceable>from</replaceable>
  47       of the input file.
  48       Should be used in conjunction with option <literal>-t</literal>.
  49      </para></listitem>
  50    </varlistentry>
  51
  52    <varlistentry>
  53     <term>-t<replaceable>to</replaceable>]</term>
  54     <listitem><para>
  55       Specify the character set <replaceable>of</replaceable>
  56       of the output.
  57       Should be used in conjunction with option <literal>-f</literal>.
  58      </para></listitem>
  59    </varlistentry>
  60
  61    <varlistentry>
  62     <term>-v</term>
  63     <listitem><para>
  64       Print more information about the conversion process.
  65      </para></listitem>
  66    </varlistentry>
  67
  68   </variablelist>
  69  </refsect1>
  70
  71  <refsect1><title>EXAMPLES</title>
  72   <para>
  73    The following command converts from ISO-8859-1 (Latin-1) to
  74    UTF-8.
  75    <screen>
  76     yaz-iconv -f ISO-8859-1 -t UTF-8 -X &lt;input.lst &gt;output.lst
  77    </screen>
  78   </para>
  79  </refsect1>
  80
  81  <refsect1><title>FILES</title>
  82   <para>
  83    <filename><replaceable>prefix</replaceable>/bin/yaz-iconv</filename>
  84   </para>
  85   <para>
  86    <filename><replaceable>prefix</replaceable>/include/yaz/yaz-iconv.h</filename>
  87   </para>
  88  </refsect1>
  89  <refsect1><title>SEE ALSO</title>
  90   <para>
  91    yaz(7)
  92    iconv(1)
  93   </para>
  94  </refsect1>
  95 </refentry>
  96
  97 <!-- Keep this comment at the end of the file
  98 Local variables:
  99 mode: sgml
 100 sgml-omittag:t
 101 sgml-shorttag:t
 102 sgml-minimize-attributes:nil
 103 sgml-always-quote-attributes:t
 104 sgml-indent-step:1
 105 sgml-indent-data:t
 106 sgml-parent-document:nil
 107 sgml-local-catalogs: nil
 108 sgml-namecase-general:t
 109 End:
 110 -->