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