yaz-marcdump man: quote in leader spec example

[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 a859971..5a66ea3 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;
@@ -8,15 +8,17 @@
      <!ENTITY % idcommon SYSTEM "common/common.ent">
      %idcommon;
 ]>
-<!-- $Id: yaz-marcdump-man.xml,v 1.14 2007-05-22 11:10:08 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>
@@ -32,8 +34,13 @@
    <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>
@@ -74,7 +81,9 @@
     <listitem><para>
       Specifies input format. Must be one of
       <literal>marcxml</literal>, <literal>marc</literal> (ISO2709),
-      <literal>line</literal> (line mode MARC).
+      <literal>marcxchange</literal> (ISO25577),
+      <literal>line</literal> (line mode MARC),
+      or <literal>turbomarc</literal> (Turbo MARC).
      </para></listitem>
    </varlistentry>
 
@@ -83,7 +92,9 @@
     <listitem><para>
       Specifies output format. Must be one of
       <literal>marcxml</literal>, <literal>marc</literal> (ISO2709),
-      <literal>line</literal> (line mode MARC).
+      <literal>marcxchange</literal> (ISO25577),
+      <literal>line</literal> (line mode MARC),
+      or <literal>turbomarc</literal> (Turbo MARC).
      </para></listitem>
    </varlistentry>
 
@@ -93,6 +104,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>
 
@@ -102,6 +114,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>
 
@@ -113,7 +126,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>
 
@@ -124,6 +170,13 @@
       Useful if you have ill-formatted ISO2709 records as input.
      </para></listitem>
    </varlistentry>
+   
+   <varlistentry>
+    <term>-V</term>
+    <listitem><para>
+      Prints YAZ version.
+     </para></listitem>
+   </varlistentry>
 
   </variablelist>
  </refsect1>
@@ -143,6 +196,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>
@@ -155,7 +218,22 @@
   </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>
+  <para>
+   <ulink url="&url.marcxml;">MARCXML</ulink>.
+  </para>
+  <para>
+   <ulink url="&url.marcxchange;">ISO25577</ulink>.
   </para>
  </refsect1>
 </refentry>