Add wrbuf_sha1_puts
[yaz-moved-to-github.git] / doc / yaz-iconv-man.xml
index 5ed3766..537e821 100644 (file)
@@ -1,5 +1,5 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
 [
      <!ENTITY % local SYSTEM "local.ent">
      %local;
  <refentryinfo>
   <productname>YAZ</productname>
   <productnumber>&version;</productnumber>
+  <info><orgname>Index Data</orgname></info>
  </refentryinfo>
+
  <refmeta>
   <refentrytitle>yaz-iconv</refentrytitle>
   <manvolnum>1</manvolnum>
+  <refmiscinfo class="manual">Commands</refmiscinfo>
  </refmeta>
+
  <refnamediv>
   <refname>yaz-iconv</refname>
-  <refpurpose>YAZ Charcter set conversion utility</refpurpose>
+  <refpurpose>YAZ Character set conversion utility</refpurpose>
  </refnamediv>
+
  <refsynopsisdiv>
   <cmdsynopsis>
    <command>yaz-iconv</command>
@@ -33,7 +35,7 @@
    <arg choice="opt" rep="repeat">file</arg>
   </cmdsynopsis>
  </refsynopsisdiv>
+
  <refsect1><title>DESCRIPTION</title>
   <para>
    <command>yaz-iconv</command> converts data in file in character
@@ -49,9 +51,9 @@
    <command>yaz-iconv</command> reads from standard input.
   </para>
  </refsect1>
+
  <refsect1><title>OPTIONS</title>
-  
+
   <variablelist>
    <varlistentry>
     <term>-f<replaceable>from</replaceable>]</term>
 
   </variablelist>
  </refsect1>
+
  <refsect1><title>ENCODINGS</title>
   <para>
    The yaz-iconv command and the API as defined in
    <filename>yaz/yaz-iconv.h</filename> is a wrapper for the
-   library system call iconv. But YAZ' implementation also implements
-   conversions on its own. So regardless of iconv, the following
-   below are always supported by YAZ:
+   library system call iconv. But YAZ' iconv utility also implements
+   conversions on its own. The table below lists characters sets (or encodings).
+   that are supported by YAZ. Each character set is marked with either
+   <emphasis>encode</emphasis> or <emphasis>decode</emphasis>. If
+   an encoding is encode-enabled YAZ may convert <emphasis>to</emphasis>
+   to the designated encoding. If an encoding is decode-enabled, YAZ
+   may convert <emphasis>from</emphasis> the designated encoding.
   </para>
   <variablelist>
    <varlistentry>
      </para>
     </listitem>
    </varlistentry>
+   <varlistentry>
+    <term>danmarc (decode)</term>
+    <listitem>
+     <para>
+      <ulink url="&url.danmarc.charset;">Danmarc (in danish)</ulink> is
+      an encoding based on UNICODE which is used for DanMARC2 records.
+     </para>
+    </listitem>
+   </varlistentry>
   </variablelist>
  </refsect1>
 
     yaz-iconv -f ISO-8859-1 -t UTF-8 -X &lt;input.lst &gt;output.lst
    </screen>
   </para>
- </refsect1> 
+ </refsect1>
 
  <refsect1><title>FILES</title>
   <para>