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