Version 5.14.8

[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..a44dde0 100644 (file)
--- a/doc/yaz-marcdump-man.xml
+++ b/doc/yaz-marcdump-man.xml
@@ -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;
@@ -12,17 +12,20 @@
  <refentryinfo>
   <productname>YAZ</productname>
   <productnumber>&version;</productnumber>
+  <info><orgname>Index Data</orgname></info>
  </refentryinfo>
+
  <refmeta>
   <refentrytitle>yaz-marcdump</refentrytitle>
   <manvolnum>1</manvolnum>
+  <refmiscinfo class="manual">Commands</refmiscinfo>
  </refmeta>
- 
+
  <refnamediv>
   <refname>yaz-marcdump</refname>
   <refpurpose>MARC record dump utility</refpurpose>
  </refnamediv>
- 
+
  <refsynopsisdiv>
   <cmdsynopsis>
    <command>yaz-marcdump</command>
@@ -41,17 +44,24 @@
    <arg choice="opt" rep="repeat">file</arg>
   </cmdsynopsis>
  </refsynopsisdiv>
- 
+
  <refsect1><title>DESCRIPTION</title>
   <para>
    <command>yaz-marcdump</command> reads MARC records from one or
    more files.
-   It parses each record and supports output in line-format, 
-   ISO2709, MARCXML, MarcXchange as well as Hex output.
+   It parses each record and supports output in line-format,
+   ISO2709,
+   <ulink url="&url.marcxml;">MARCXML</ulink>,
+   <ulink url="&url.marc_in_json;">MARC-in-JSON</ulink>,
+   <ulink url="&url.marcxchange;">MarcXchange</ulink>
+   as well as Hex output.
   </para>
   <para>
-   This utility parses records ISO2709(raw MARC) as well as XML
-   if that is structured as MARCXML/MarcXchange.
+   This utility parses records ISO2709(raw MARC), line format, MARC-in-JSON
+   format as well as XML if that is structured as MARCXML/MarcXchange.
+  </para>
+  <para>
+   MARC-in-JSON encoding/decoding is supported in YAZ 5.0.5 and later.
   </para>
   <note>
    <para>
@@ -69,9 +79,9 @@
    character set conversion of each record.
   </para>
  </refsect1>
- 
+
  <refsect1><title>OPTIONS</title>
-  
+
   <variablelist>
    <varlistentry>
     <term>-i <replaceable>format</replaceable></term>
@@ -79,7 +89,9 @@
       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),
+      <literal>turbomarc</literal> (Turbo MARC),
+      or <literal>json</literal> (MARC-in-JSON).
      </para></listitem>
    </varlistentry>
 
@@ -89,7 +101,9 @@
       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),
+      <literal>turbomarc</literal> (Turbo MARC),
+      or <literal>json</literal> (MARC-in-JSON).
      </para></listitem>
    </varlistentry>
 
@@ -99,6 +113,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 +123,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>
 
@@ -119,7 +135,7 @@
       pairs, where pos is an integer offset (0 - 23) for leader. Value
       is either a quoted string or an integer (character value in decimal).
       Pairs are comma separated. For example, to set leader at offset 9
-      to a, use <literal>9=a</literal>.
+      to a, use <literal>9='a'</literal>.
      </para></listitem>
    </varlistentry>
 
@@ -136,7 +152,7 @@
    <varlistentry>
     <term>-C <replaceable>chunksize</replaceable></term>
     <listitem><para>
-      Specifies chunk size; to be used conjunction with option 
+      Specifies chunk size; to be used conjunction with option
       <literal>-s</literal>.
      </para></listitem>
    </varlistentry>
@@ -189,7 +205,17 @@
     yaz-marcdump -f MARC-8 -t UTF-8 -o marcxml marc21.raw >marcxml.xml
    </screen>
   </para>
- </refsect1> 
+
+  <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>
   <para>
@@ -201,23 +227,23 @@
   </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>
  </refsect1>
 </refentry>
 
 <!-- Keep this comment at the end of the file
 Local variables:
-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
+mode: nxml
+nxml-child-indent: 1
 End:
 -->