X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fyaz-marcdump-man.xml;h=8b3daa1f7808d94279084c41d6713264ce422ce0;hb=9c70253e4c7eedab806490b87a9a58e970998429;hp=607c75a0214bf24c379ad778940cc4b1ef5101c8;hpb=c6e47cbbff56f39f6d81b079ebaeac41d793d4d9;p=yaz-moved-to-github.git

diff --git a/doc/yaz-marcdump-man.xml b/doc/yaz-marcdump-man.xml
index 607c75a..8b3daa1 100644
--- a/doc/yaz-marcdump-man.xml
+++ b/doc/yaz-marcdump-man.xml
@@ -1,6 +1,19 @@
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
-<!-- $Id: yaz-marcdump-man.xml,v 1.1 2003-10-27 12:21:24 adam 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 % common SYSTEM "common/common.ent">
+     %common;
+]>
+<!-- $Id: yaz-marcdump-man.xml,v 1.12 2006-08-28 19:18:02 adam Exp $ -->
 <refentry id="yaz-marcdump">
+ <refentryinfo>
+  <productname>YAZ</productname>
+  <productnumber>&version;</productnumber>
+ </refentryinfo>
  <refmeta>
   <refentrytitle>yaz-marcdump</refentrytitle>
   <manvolnum>1</manvolnum>
@@ -16,9 +29,11 @@
    <command>yaz-marcdump</command>
    <arg choice="opt"><option>-x</option></arg>
    <arg choice="opt"><option>-X</option></arg>
-   <arg choice="opt"><option>-O</option></arg>
+   <arg choice="opt"><option>-e</option></arg>
+   <arg choice="opt"><option>-I</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" rep="repeat">file</arg>
@@ -27,14 +42,26 @@
  
  <refsect1><title>DESCRIPTION</title>
   <para>
-   <command>yaz-marcdump</command> reads ISO2709/MARC records from one or
+   <command>yaz-marcdump</command> reads MARC records from one or
    more files.
-   It validates each record and supports output in line-format, 
-   MARCXML, OAIMARC as well as Hex output.
+   It parses each record and supports output in line-format, 
+   ISO2709, MARCXML, MarcXchange as well as Hex output.
   </para>
   <para>
-   By default, each record is printed to standard output in a line
+   This utility parses records ISO2709(raw MARC) as well as XML
+   if that is structured as MARCXML/MarcXchange.
+  </para>
+  <note>
+   <para>
+    As of YAZ 2.1.18, OAI-MARC is no longer supported.
+    OAI-MARC is deprecated. Use MARCXML instead.
+   </para>
+  </note>
+  <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>.
   </para>
   <para>
    <command>yaz-marcdump</command> can also be requested to perform
@@ -48,32 +75,41 @@
    <varlistentry>
     <term>-x</term>
     <listitem><para>
-      Print MARC records in a simple XML format. 
-      This format is equivalent to YAZ_MARC_SIMPLEXML in
-      <filename>yaz/marcdisp.h</filename>.
+      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>
-      Print MARC records in MARCXML.
+      Writes MARC records in MARCXML.
       This format is equivalent to YAZ_MARC_MARCXML in
       <filename>yaz/marcdisp.h</filename>.
      </para></listitem>
    </varlistentry>
 
    <varlistentry>
-    <term>-O</term>
+    <term>-e</term>
     <listitem><para>
-      Print MARC records in OAIMARC. Another XML variant.
-      This format is equivalent to YAZ_MARC_OAIMARC in
+      Writes MARC records in MarcXchange format.
+      This format is equivalent to YAZ_MARC_XCHANGE in
       <filename>yaz/marcdisp.h</filename>.
      </para></listitem>
    </varlistentry>
-   
+
    <varlistentry>
-    <term>-f<replaceable>from</replaceable>]</term>
+    <term>-I</term>
+    <listitem><para>
+      Writes MARC records in ISO2709 format.
+      This format is equivalent to YAZ_MARC_ISO2709 in
+      <filename>yaz/marcdisp.h</filename>.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>-f <replaceable>from</replaceable></term>
     <listitem><para>
       Specify the character set <replaceable>from</replaceable>
       of the input MARC record.
@@ -82,7 +118,7 @@
    </varlistentry>
 
    <varlistentry>
-    <term>-t<replaceable>to</replaceable>]</term>
+    <term>-t <replaceable>to</replaceable></term>
     <listitem><para>
       Specify the character set <replaceable>of</replaceable>
       of the output.
@@ -91,9 +127,21 @@
    </varlistentry>
 
    <varlistentry>
+    <term>-l <replaceable>leaderspec</replaceable></term>
+    <listitem><para>
+      Specify a simple modification string for MARC leader. The
+      <replaceable>leaderspec</replaceable> is a list of pos=value
+      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>.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
     <term>-v</term>
     <listitem><para>
-      Print more information about the parsing process.
+      Writes more information about the parsing process.
       Useful if you have ill-formatted ISO2709 records as input.
      </para></listitem>
    </varlistentry>
@@ -103,8 +151,15 @@
 
  <refsect1><title>EXAMPLES</title>
   <para>
-   The following command converts MARC21/USMARC using MARC-8 encoding to
-   MARCXML in UTF-8 encoding.
+   The following command converts MARC21/USMARC in MARC-8 encoding to
+   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
+   </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
    </screen>
@@ -114,6 +169,8 @@
  <refsect1><title>FILES</title>
   <para>
    <filename><replaceable>prefix</replaceable>/bin/yaz-marcdump</filename>
+  </para>
+  <para>
    <filename><replaceable>prefix</replaceable>/include/yaz/marcdisp.h</filename>
   </para>
   </refsect1>