X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fyaz-marcdump-man.xml;h=a44dde0a1f73569e31890420dd74c9345bc8d2e6;hp=d7f1e650aebe088c9ba0fba1ff8494fc35d47f05;hb=30af0a1ebbea75c3e757eb03d3f988c61fce8511;hpb=ad61957d649158cf2e1018da95fa428aa8999f2a

diff --git a/doc/yaz-marcdump-man.xml b/doc/yaz-marcdump-man.xml
index d7f1e65..a44dde0 100644
--- a/doc/yaz-marcdump-man.xml
+++ b/doc/yaz-marcdump-man.xml
@@ -1,45 +1,67 @@
-<!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;
+     <!ENTITY % entities SYSTEM "entities.ent">
+     %entities;
+     <!ENTITY % idcommon SYSTEM "common/common.ent">
+     %idcommon;
 ]>
-<!-- $Id: yaz-marcdump-man.xml,v 1.11 2006-08-28 18:35:07 adam Exp $ -->
 <refentry id="yaz-marcdump">
+ <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>
-   <arg choice="opt"><option>-x</option></arg>
-   <arg choice="opt"><option>-X</option></arg>
-   <arg choice="opt"><option>-e</option></arg>
-   <arg choice="opt"><option>-I</option></arg>
+   <arg choice="opt"><option>-i <replaceable>format</replaceable></option></arg>
+   <arg choice="opt"><option>-o <replaceable>format</replaceable></option></arg>
    <arg choice="opt"><option>-f <replaceable>from</replaceable></option></arg>
    <arg choice="opt"><option>-t <replaceable>to</replaceable></option></arg>
    <arg choice="opt"><option>-l <replaceable>spec</replaceable></option></arg>
-   <arg choice="opt"><option>-v</option></arg>
    <arg choice="opt"><option>-c <replaceable>cfile</replaceable></option></arg>
+   <arg choice="opt"><option>-s <replaceable>prefix</replaceable></option></arg>
+   <arg choice="opt"><option>-C <replaceable>size</replaceable></option></arg>
+   <arg choice="opt"><option>-n</option></arg>
+   <arg choice="opt"><option>-p</option></arg>
+   <arg choice="opt"><option>-v</option></arg>
+   <arg choice="opt"><option>-V</option></arg>
    <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), line format, MARC-in-JSON
+   format as well as XML if that is structured as MARCXML/MarcXchange.
   </para>
   <para>
-   This utility parses records ISO2709(raw MARC) as well as XML
-   if that is structured as MARCXML/MarcXchange.
+   MARC-in-JSON encoding/decoding is supported in YAZ 5.0.5 and later.
   </para>
   <note>
    <para>
@@ -50,51 +72,38 @@
   <para>
    By default, each record is written to standard output in a line
    format with newline for each field, $x for each subfield x.
-   The output format may be changed with options <literal>-X</literal>,
-   <literal>-e</literal>, <literal>-I</literal>.
+   The output format may be changed with option <literal>-o</literal>,
   </para>
   <para>
    <command>yaz-marcdump</command> can also be requested to perform
    character set conversion of each record.
   </para>
  </refsect1>
- 
- <refsect1><title>OPTIONS</title>
-  
-  <variablelist>
-   <varlistentry>
-    <term>-x</term>
-    <listitem><para>
-      Reads MARC records in MARCXML/MarcXchange format. Without
-      this option, <command>yaz-marcdump</command> reads records
-      in ISO2709 format.
-     </para></listitem>
-   </varlistentry>
 
-   <varlistentry>
-    <term>-X</term>
-    <listitem><para>
-      Writes MARC records in MARCXML.
-      This format is equivalent to YAZ_MARC_MARCXML in
-      <filename>yaz/marcdisp.h</filename>.
-     </para></listitem>
-   </varlistentry>
+ <refsect1><title>OPTIONS</title>
 
+  <variablelist>
    <varlistentry>
-    <term>-e</term>
+    <term>-i <replaceable>format</replaceable></term>
     <listitem><para>
-      Writes MARC records in MarcXchange format.
-      This format is equivalent to YAZ_MARC_XCHANGE in
-      <filename>yaz/marcdisp.h</filename>.
+      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>turbomarc</literal> (Turbo MARC),
+      or <literal>json</literal> (MARC-in-JSON).
      </para></listitem>
    </varlistentry>
 
    <varlistentry>
-    <term>-I</term>
+    <term>-o <replaceable>format</replaceable></term>
     <listitem><para>
-      Writes MARC records in ISO2709 format.
-      This format is equivalent to YAZ_MARC_ISO2709 in
-      <filename>yaz/marcdisp.h</filename>.
+      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>turbomarc</literal> (Turbo MARC),
+      or <literal>json</literal> (MARC-in-JSON).
      </para></listitem>
    </varlistentry>
 
@@ -104,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>
 
@@ -113,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>
 
@@ -124,7 +135,40 @@
       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>
+
+   <varlistentry>
+    <term>-s <replaceable>prefix</replaceable></term>
+    <listitem><para>
+      Writes a chunk of records to a separate file with prefix given,
+      i.e. splits a record batch into files with only at most
+      "chunk" ISO2709 record per file. By default chunk is 1 (one record
+      per file). See option <literal>-C</literal>.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>-C <replaceable>chunksize</replaceable></term>
+    <listitem><para>
+      Specifies chunk size; to be used conjunction with option
+      <literal>-s</literal>.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>-p</term>
+    <listitem><para>
+      Makes yaz-marcdump prints record number and input file offset
+      of each record read.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>-n</term>
+    <listitem><para>
+      MARC output is omitted so that MARC input is only checkecd.
      </para></listitem>
    </varlistentry>
 
@@ -136,6 +180,13 @@
      </para></listitem>
    </varlistentry>
 
+   <varlistentry>
+    <term>-V</term>
+    <listitem><para>
+      Prints YAZ version.
+     </para></listitem>
+   </varlistentry>
+
   </variablelist>
  </refsect1>
 
@@ -145,16 +196,26 @@
    MARC21/USMARC in UTF-8 encoding. Leader offset 9 is set to 'a'.
    Both input and output records are ISO2709 encoded.
    <screen>
-    yaz-marcdump -f MARC-8 -t UTF-8 -I -l 9=97 marc21.raw >marc21.utf8.raw
+    yaz-marcdump -f MARC-8 -t UTF-8 -o marc -l 9=97 marc21.raw >marc21.utf8.raw
    </screen>
   </para>
   <para>
    The same records may be converted to MARCXML instead in UTF-8:
    <screen>
-    yaz-marcdump -f MARC-8 -t UTF-8 -X marc21.raw >marcxml.xml
+    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>
@@ -166,22 +227,23 @@
   </refsect1>
  <refsect1><title>SEE ALSO</title>
   <para>
-   yaz(7)
+   <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:
 -->