X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fyaz-iconv-man.xml;h=80a078464a008e937b4691b02838989cc7412250;hb=2f13c9a407fe345dfe13ef8647ebba02ca519089;hp=935fedbbf746795ee78fcf21a8498be75ff807b0;hpb=23403c6f31b26b0e819a47980c42f3fc8c57d84d;p=yaz-moved-to-github.git

diff --git a/doc/yaz-iconv-man.xml b/doc/yaz-iconv-man.xml
index 935fedb..80a0784 100644
--- a/doc/yaz-iconv-man.xml
+++ b/doc/yaz-iconv-man.xml
@@ -1,6 +1,19 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
-<!-- $Id: yaz-iconv-man.xml,v 1.3 2006-04-25 11:25:08 marc Exp $ -->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+[
+     <!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>
@@ -67,6 +80,97 @@
 
   </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>
+  </variablelist>
+ </refsect1>
 
  <refsect1><title>EXAMPLES</title>
   <para>