Spell fix

[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 0dd2a49..d24dff7 100644 (file)
--- a/doc/yaz-iconv-man.xml
+++ b/doc/yaz-iconv-man.xml
@@ -8,7 +8,6 @@
      <!ENTITY % idcommon SYSTEM "common/common.ent">
      %idcommon;
 ]>
-<!-- $Id: yaz-iconv-man.xml,v 1.6 2007-05-22 11:10:08 adam Exp $ -->
 <refentry id="yaz-iconv">
  <refentryinfo>
   <productname>YAZ</productname>
@@ -22,7 +21,7 @@
  
  <refnamediv>
   <refname>yaz-iconv</refname>
-  <refpurpose>YAZ Charcter set conversion utility</refpurpose>
+  <refpurpose>YAZ Character set conversion utility</refpurpose>
  </refnamediv>
  
  <refsynopsisdiv>
@@ -81,6 +80,106 @@
 
   </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' 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>
+    <term>marc8 (encode, decode)</term>
+    <listitem>
+     <para>
+      The <ulink url="&url.marc8;">MARC8</ulink> encoding as defined by
+      the Library of Congress. Most MARC21/USMARC records usees
+      this encoding.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term>marc8s (encode, decode)</term>
+    <listitem>
+     <para>
+      Like MARC8 but with conversion prefers non-combined characters
+      in the Latin-1 plane over combined characters.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term>marc8lossy (encode)</term>
+    <listitem>
+     <para>
+      Lossy encoding of MARC-8.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term>marc8lossless (encode)</term>
+    <listitem>
+     <para>
+      Lossless encoding of MARC8.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term>utf8 (encode, decode)</term>
+    <listitem>
+     <para>
+      The most commonly used UNICODE encoding on the Internet.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term>iso8859-1 (encode, decode)</term>
+    <listitem>
+     <para>
+      ISO-8859-1, AKA Latin-1.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term>iso5426 (decode)</term>
+    <listitem>
+     <para>
+      ISO 5426. Some MARC records (UNIMARC) uses this encoding.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term>iso5428:1984 (encode, decode)</term>
+    <listitem>
+     <para>
+      ISO 5428:1984.
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term>advancegreek (encode, decode)</term>
+    <listitem>
+     <para>
+      An encoding for Greek used by some vendors (Advance).
+     </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>
 
  <refsect1><title>EXAMPLES</title>
   <para>