Update TurboMARC definition and document it

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

diff --git a/doc/yaz-marcdump-man.xml b/doc/yaz-marcdump-man.xml
index c960485..dbc4060 100644 (file)
--- a/doc/yaz-marcdump-man.xml
+++ b/doc/yaz-marcdump-man.xml
@@ -79,7 +79,8 @@
       Specifies input format. Must be one of
       <literal>marcxml</literal>, <literal>marc</literal> (ISO2709),
       <literal>marcxchange</literal> (ISO25577),
-      <literal>line</literal> (line mode MARC).
+      <literal>line</literal> (line mode MARC),
+      or <literal>turbomarc</literal> (Turbo MARC).
      </para></listitem>
    </varlistentry>
 
@@ -89,7 +90,8 @@
       Specifies output format. Must be one of
       <literal>marcxml</literal>, <literal>marc</literal> (ISO2709),
       <literal>marcxchange</literal> (ISO25577),
-      <literal>line</literal> (line mode MARC).
+      <literal>line</literal> (line mode MARC),
+      or <literal>turbomarc</literal> (Turbo MARC).
      </para></listitem>
    </varlistentry>
 
@@ -99,6 +101,7 @@
       Specify the character set <replaceable>from</replaceable>
       of the input MARC record.
       Should be used in conjunction with option <literal>-t</literal>.
+      Refer to the yaz-iconv man page for supported character sets.
      </para></listitem>
    </varlistentry>
 
@@ -108,6 +111,7 @@
       Specify the character set <replaceable>of</replaceable>
       of the output.
       Should be used in conjunction with option <literal>-f</literal>.
+      Refer to the yaz-iconv man page for supported character sets.
      </para></listitem>
    </varlistentry>
 
@@ -163,7 +167,7 @@
       Useful if you have ill-formatted ISO2709 records as input.
      </para></listitem>
    </varlistentry>
-
+   
    <varlistentry>
     <term>-V</term>
     <listitem><para>
@@ -189,6 +193,16 @@
     yaz-marcdump -f MARC-8 -t UTF-8 -o marcxml marc21.raw >marcxml.xml
    </screen>
   </para>
+
+  <para>
+   Turbo MARC is a compact XML notation with same semantics as
+   MARCXML, but which allows for faster processing via XSLT. In order
+   to generate Turbo MARC records encoded in UTF-8 from MARC21 (ISO), one
+   could use:
+   <screen>
+    yaz-marcdump -f MARC8 -t UTF8 -o turbomarc -i marc marc21.raw >out.xml
+   </screen>
+  </para>
  </refsect1> 
 
  <refsect1><title>FILES</title>
@@ -201,8 +215,22 @@
   </refsect1>
  <refsect1><title>SEE ALSO</title>
   <para>
-   yaz(7)
-   yaz-iconv(1)
+   <citerefentry>
+    <refentrytitle>yaz</refentrytitle>
+    <manvolnum>7</manvolnum>
+   </citerefentry>
+  </para>
+  <para>
+   <citerefentry>
+    <refentrytitle>yaz-iconv</refentrytitle>
+    <manvolnum>1</manvolnum>
+   </citerefentry>
+  </para>
+  <para>
+   <ulink url="&url.marcxml;">MARCXML</ulink>.
+  </para>
+  <para>
+   <ulink url="&url.marcxchange;">ISO25577</ulink>.
   </para>
  </refsect1>
 </refentry>