man page for yaz-iconv

[yaz-moved-to-github.git] / doc / yaz-iconv-man.xml

diff --git a/doc/yaz-iconv-man.xml b/doc/yaz-iconv-man.xml
new file mode 100644 (file)
index 0000000..502f846
--- /dev/null
+++ b/doc/yaz-iconv-man.xml
@@ -0,0 +1,110 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!-- $Id: yaz-iconv-man.xml,v 1.1 2003-11-18 20:34:34 adam Exp $ -->
+<refentry id="yaz-iconv">
+ <refmeta>
+  <refentrytitle>yaz-iconv</refentrytitle>
+  <manvolnum>1</manvolnum>
+ </refmeta>
+ 
+ <refnamediv>
+  <refname>yaz-iconv</refname>
+  <refpurpose>YAZ Charcter set conversion utility</refpurpose>
+ </refnamediv>
+ 
+ <refsynopsisdiv>
+  <cmdsynopsis>
+   <command>yaz-iconv</command>
+   <arg choice="opt"><option>-f <replaceable>from</replaceable></option></arg>
+   <arg choice="opt"><option>-t <replaceable>to</replaceable></option></arg>
+   <arg choice="opt"><option>-v</option></arg>
+   <arg choice="opt" rep="repeat">file</arg>
+  </cmdsynopsis>
+ </refsynopsisdiv>
+ 
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   <command>yaz-iconv</command> converts data in file in character
+   set specified by <replaceable>from</replaceable> to output in
+   character set as specified by <replaceable>to</replaceable>.
+  </para>
+  <para>
+   This <command>yaz-iconv</command> utility similar to the
+   <command>iconv</command> found on many POSIX systems (Glibc, Solaris, etc).
+  </para>
+  <para>
+   If no <replaceable>file</replaceable> is specified,
+   <command>yaz-iconv</command> reads from standard input.
+  </para>
+ </refsect1>
+ 
+ <refsect1><title>OPTIONS</title>
+  
+  <variablelist>
+   <varlistentry>
+    <term>-f<replaceable>from</replaceable>]</term>
+    <listitem><para>
+      Specify the character set <replaceable>from</replaceable>
+      of the input file.
+      Should be used in conjunction with option <literal>-t</literal>.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>-t<replaceable>to</replaceable>]</term>
+    <listitem><para>
+      Specify the character set <replaceable>of</replaceable>
+      of the output.
+      Should be used in conjunction with option <literal>-f</literal>.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>-v</term>
+    <listitem><para>
+      Print more information about the conversion process.
+     </para></listitem>
+   </varlistentry>
+
+  </variablelist>
+ </refsect1>
+
+ <refsect1><title>EXAMPLES</title>
+  <para>
+   The following command converts from ISO-8859-1 (Latin-1) to
+   UTF-8.
+   <screen>
+    yaz-iconv -f ISO-8859-1 -t UTF-8 -X &lt;input.lst &gt;output.lst
+   </screen>
+  </para>
+ </refsect1> 
+
+ <refsect1><title>FILES</title>
+  <para>
+   <filename><replaceable>prefix</replaceable>/bin/yaz-iconv</filename>
+  </para>
+  <para>
+   <filename><replaceable>prefix</replaceable>/include/yaz/yaz-iconv.h</filename>
+  </para>
+ </refsect1>
+ <refsect1><title>SEE ALSO</title>
+  <para>
+   yaz(7)
+   iconv(1)
+  </para>
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
+End:
+-->