List encodings supported by YAZ. Bug #2513.

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

diff --git a/doc/yaz-iconv-man.xml b/doc/yaz-iconv-man.xml
index dc0f3c4..d8e6d70 100644 (file)
--- a/doc/yaz-iconv-man.xml
+++ b/doc/yaz-iconv-man.xml
@@ -1,8 +1,19 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
  "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
->
-<!-- $Id: yaz-iconv-man.xml,v 1.2 2006-04-24 12:41:00 marc Exp $ -->
+[
+     <!ENTITY % local SYSTEM "local.ent">
+     %local;
+     <!ENTITY % entities SYSTEM "entities.ent">
+     %entities;
+     <!ENTITY % idcommon SYSTEM "common/common.ent">
+     %idcommon;
+]>
 <refentry id="yaz-iconv">
+ <refentryinfo>
+  <productname>YAZ</productname>
+  <productnumber>&version;</productnumber>
+ </refentryinfo>
+ 
  <refmeta>
   <refentrytitle>yaz-iconv</refentrytitle>
   <manvolnum>1</manvolnum>
@@ -70,6 +81,75 @@
   </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:
+  </para>
+  <variablelist>
+   <varlistentry>
+    <term>marc8 (encode, decode)</term>
+     <para>
+      The <ulink url="&url.marc8;">MARC8</ulink> encoding as defined by
+      the Library of Congress. Most MARC21/USMARC records usees
+      this encoding.
+     </para>
+   </varlistentry>
+   <varlistentry>
+    <term>marc8s (encode, decode)</term>
+     <para>
+      Like MARC8 but with conversion prefers non-combined characters
+      in the Latin-1 plane over combined characters.
+     </para>
+   </varlistentry>
+   <varlistentry>
+    <term>marc8lossy (encode)</term>
+     <para>
+      Lossy encoding of MARC-8.
+     </para>
+   </varlistentry>
+   <varlistentry>
+    <term>marc8lossless (encode)</term>
+     <para>
+      Lossless encoding of MARC8.
+     </para>
+   </varlistentry>
+   <varlistentry>
+    <term>utf8 (encode, decode)</term>
+     <para>
+      The most commonly used UNICODE encoding on the Internet.
+     </para>
+   </varlistentry>
+   <varlistentry>
+    <term>iso8859-1 (encode, decode)</term>
+     <para>
+      ISO-8859-1, AKA Latin-1.
+     </para>
+   </varlistentry>
+   <varlistentry>
+    <term>iso5426 (decode)</term>
+     <para>
+      ISO 5426. Some MARC records (UNIMARC) uses this encoding.
+     </para>
+   </varlistentry>
+   <varlistentry>
+    <term>iso5428:1984 (encode, decode)</term>
+     <para>
+      ISO 5428:1984.
+     </para>
+   </varlistentry>
+   <varlistentry>
+    <term>advancegreek (encode, decode)</term>
+     <para>
+      An encoding for Greek used by some vendors (Advance).
+     </para>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
  <refsect1><title>EXAMPLES</title>
   <para>
    The following command converts from ISO-8859-1 (Latin-1) to
@@ -96,9 +176,17 @@
  </refsect1>
 </refentry>
 
-<!-- Keep this Emacs mode comment at the end of the file
+<!-- Keep this comment at the end of the file
 Local variables:
-mode: nxml
+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:
 -->
-