doc/yaz-marcdump-man.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
   2  "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
   3 [
   4      <!ENTITY % local SYSTEM "local.ent">
   5      %local;
   6      <!ENTITY % entities SYSTEM "entities.ent">
   7      %entities;
   8      <!ENTITY % idcommon SYSTEM "common/common.ent">
   9      %idcommon;
  10 ]>
  11 <refentry id="yaz-marcdump">
  12  <refentryinfo>
  13   <productname>YAZ</productname>
  14   <productnumber>&version;</productnumber>
  15  </refentryinfo>
  16  <refmeta>
  17   <refentrytitle>yaz-marcdump</refentrytitle>
  18   <manvolnum>1</manvolnum>
  19  </refmeta>
  20
  21  <refnamediv>
  22   <refname>yaz-marcdump</refname>
  23   <refpurpose>MARC record dump utility</refpurpose>
  24  </refnamediv>
  25
  26  <refsynopsisdiv>
  27   <cmdsynopsis>
  28    <command>yaz-marcdump</command>
  29    <arg choice="opt"><option>-i <replaceable>format</replaceable></option></arg>
  30    <arg choice="opt"><option>-o <replaceable>format</replaceable></option></arg>
  31    <arg choice="opt"><option>-f <replaceable>from</replaceable></option></arg>
  32    <arg choice="opt"><option>-t <replaceable>to</replaceable></option></arg>
  33    <arg choice="opt"><option>-l <replaceable>spec</replaceable></option></arg>
  34    <arg choice="opt"><option>-c <replaceable>cfile</replaceable></option></arg>
  35    <arg choice="opt"><option>-s <replaceable>prefix</replaceable></option></arg>
  36    <arg choice="opt"><option>-C <replaceable>size</replaceable></option></arg>
  37    <arg choice="opt"><option>-n</option></arg>
  38    <arg choice="opt"><option>-p</option></arg>
  39    <arg choice="opt"><option>-v</option></arg>
  40    <arg choice="opt"><option>-V</option></arg>
  41    <arg choice="opt" rep="repeat">file</arg>
  42   </cmdsynopsis>
  43  </refsynopsisdiv>
  44
  45  <refsect1><title>DESCRIPTION</title>
  46   <para>
  47    <command>yaz-marcdump</command> reads MARC records from one or
  48    more files.
  49    It parses each record and supports output in line-format,
  50    ISO2709, MARCXML, MarcXchange as well as Hex output.
  51   </para>
  52   <para>
  53    This utility parses records ISO2709(raw MARC) as well as XML
  54    if that is structured as MARCXML/MarcXchange.
  55   </para>
  56   <note>
  57    <para>
  58     As of YAZ 2.1.18, OAI-MARC is no longer supported.
  59     OAI-MARC is deprecated. Use MARCXML instead.
  60    </para>
  61   </note>
  62   <para>
  63    By default, each record is written to standard output in a line
  64    format with newline for each field, $x for each subfield x.
  65    The output format may be changed with option <literal>-o</literal>,
  66   </para>
  67   <para>
  68    <command>yaz-marcdump</command> can also be requested to perform
  69    character set conversion of each record.
  70   </para>
  71  </refsect1>
  72
  73  <refsect1><title>OPTIONS</title>
  74
  75   <variablelist>
  76    <varlistentry>
  77     <term>-i <replaceable>format</replaceable></term>
  78     <listitem><para>
  79       Specifies input format. Must be one of
  80       <literal>marcxml</literal>, <literal>marc</literal> (ISO2709),
  81       <literal>marcxchange</literal> (ISO25577),
  82       <literal>line</literal> (line mode MARC).
  83      </para></listitem>
  84    </varlistentry>
  85
  86    <varlistentry>
  87     <term>-o <replaceable>format</replaceable></term>
  88     <listitem><para>
  89       Specifies output format. Must be one of
  90       <literal>marcxml</literal>, <literal>marc</literal> (ISO2709),
  91       <literal>marcxchange</literal> (ISO25577),
  92       <literal>line</literal> (line mode MARC).
  93      </para></listitem>
  94    </varlistentry>
  95
  96    <varlistentry>
  97     <term>-f <replaceable>from</replaceable></term>
  98     <listitem><para>
  99       Specify the character set <replaceable>from</replaceable>
 100       of the input MARC record.
 101       Should be used in conjunction with option <literal>-t</literal>.
 102      </para></listitem>
 103    </varlistentry>
 104
 105    <varlistentry>
 106     <term>-t <replaceable>to</replaceable></term>
 107     <listitem><para>
 108       Specify the character set <replaceable>of</replaceable>
 109       of the output.
 110       Should be used in conjunction with option <literal>-f</literal>.
 111      </para></listitem>
 112    </varlistentry>
 113
 114    <varlistentry>
 115     <term>-l <replaceable>leaderspec</replaceable></term>
 116     <listitem><para>
 117       Specify a simple modification string for MARC leader. The
 118       <replaceable>leaderspec</replaceable> is a list of pos=value
 119       pairs, where pos is an integer offset (0 - 23) for leader. Value
 120       is either a quoted string or an integer (character value in decimal).
 121       Pairs are comma separated. For example, to set leader at offset 9
 122       to a, use <literal>9=a</literal>.
 123      </para></listitem>
 124    </varlistentry>
 125
 126    <varlistentry>
 127     <term>-s <replaceable>prefix</replaceable></term>
 128     <listitem><para>
 129       Writes a chunk of records to a separate file with prefix given,
 130       i.e. splits a record batch into files with only at most
 131       "chunk" ISO2709 record per file. By default chunk is 1 (one record
 132       per file). See option <literal>-C</literal>.
 133      </para></listitem>
 134    </varlistentry>
 135
 136    <varlistentry>
 137     <term>-C <replaceable>chunksize</replaceable></term>
 138     <listitem><para>
 139       Specifies chunk size; to be used conjunction with option
 140       <literal>-s</literal>.
 141      </para></listitem>
 142    </varlistentry>
 143
 144    <varlistentry>
 145     <term>-p</term>
 146     <listitem><para>
 147       Makes yaz-marcdump prints record number and input file offset
 148       of each record read.
 149      </para></listitem>
 150    </varlistentry>
 151
 152    <varlistentry>
 153     <term>-n</term>
 154     <listitem><para>
 155       MARC output is omitted so that MARC input is only checkecd.
 156      </para></listitem>
 157    </varlistentry>
 158
 159    <varlistentry>
 160     <term>-v</term>
 161     <listitem><para>
 162       Writes more information about the parsing process.
 163       Useful if you have ill-formatted ISO2709 records as input.
 164      </para></listitem>
 165    </varlistentry>
 166
 167    <varlistentry>
 168     <term>-V</term>
 169     <listitem><para>
 170       Prints YAZ version.
 171      </para></listitem>
 172    </varlistentry>
 173
 174   </variablelist>
 175  </refsect1>
 176
 177  <refsect1><title>EXAMPLES</title>
 178   <para>
 179    The following command converts MARC21/USMARC in MARC-8 encoding to
 180    MARC21/USMARC in UTF-8 encoding. Leader offset 9 is set to 'a'.
 181    Both input and output records are ISO2709 encoded.
 182    <screen>
 183     yaz-marcdump -f MARC-8 -t UTF-8 -o marc -l 9=97 marc21.raw >marc21.utf8.raw
 184    </screen>
 185   </para>
 186   <para>
 187    The same records may be converted to MARCXML instead in UTF-8:
 188    <screen>
 189     yaz-marcdump -f MARC-8 -t UTF-8 -o marcxml marc21.raw >marcxml.xml
 190    </screen>
 191   </para>
 192  </refsect1>
 193
 194  <refsect1><title>FILES</title>
 195   <para>
 196    <filename><replaceable>prefix</replaceable>/bin/yaz-marcdump</filename>
 197   </para>
 198   <para>
 199    <filename><replaceable>prefix</replaceable>/include/yaz/marcdisp.h</filename>
 200   </para>
 201   </refsect1>
 202  <refsect1><title>SEE ALSO</title>
 203   <para>
 204    yaz(7)
 205   </para>
 206  </refsect1>
 207 </refentry>
 208
 209 <!-- Keep this comment at the end of the file
 210 Local variables:
 211 mode: sgml
 212 sgml-omittag:t
 213 sgml-shorttag:t
 214 sgml-minimize-attributes:nil
 215 sgml-always-quote-attributes:t
 216 sgml-indent-step:1
 217 sgml-indent-data:t
 218 sgml-parent-document:nil
 219 sgml-local-catalogs: nil
 220 sgml-namecase-general:t
 221 End:
 222 -->