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       Refer to the yaz-iconv man page for supported character sets.
 103      </para></listitem>
 104    </varlistentry>
 105
 106    <varlistentry>
 107     <term>-t <replaceable>to</replaceable></term>
 108     <listitem><para>
 109       Specify the character set <replaceable>of</replaceable>
 110       of the output.
 111       Should be used in conjunction with option <literal>-f</literal>.
 112       Refer to the yaz-iconv man page for supported character sets.
 113      </para></listitem>
 114    </varlistentry>
 115
 116    <varlistentry>
 117     <term>-l <replaceable>leaderspec</replaceable></term>
 118     <listitem><para>
 119       Specify a simple modification string for MARC leader. The
 120       <replaceable>leaderspec</replaceable> is a list of pos=value
 121       pairs, where pos is an integer offset (0 - 23) for leader. Value
 122       is either a quoted string or an integer (character value in decimal).
 123       Pairs are comma separated. For example, to set leader at offset 9
 124       to a, use <literal>9=a</literal>.
 125      </para></listitem>
 126    </varlistentry>
 127
 128    <varlistentry>
 129     <term>-s <replaceable>prefix</replaceable></term>
 130     <listitem><para>
 131       Writes a chunk of records to a separate file with prefix given,
 132       i.e. splits a record batch into files with only at most
 133       "chunk" ISO2709 record per file. By default chunk is 1 (one record
 134       per file). See option <literal>-C</literal>.
 135      </para></listitem>
 136    </varlistentry>
 137
 138    <varlistentry>
 139     <term>-C <replaceable>chunksize</replaceable></term>
 140     <listitem><para>
 141       Specifies chunk size; to be used conjunction with option
 142       <literal>-s</literal>.
 143      </para></listitem>
 144    </varlistentry>
 145
 146    <varlistentry>
 147     <term>-p</term>
 148     <listitem><para>
 149       Makes yaz-marcdump prints record number and input file offset
 150       of each record read.
 151      </para></listitem>
 152    </varlistentry>
 153
 154    <varlistentry>
 155     <term>-n</term>
 156     <listitem><para>
 157       MARC output is omitted so that MARC input is only checkecd.
 158      </para></listitem>
 159    </varlistentry>
 160
 161    <varlistentry>
 162     <term>-v</term>
 163     <listitem><para>
 164       Writes more information about the parsing process.
 165       Useful if you have ill-formatted ISO2709 records as input.
 166      </para></listitem>
 167    </varlistentry>
 168
 169    <varlistentry>
 170     <term>-V</term>
 171     <listitem><para>
 172       Prints YAZ version.
 173      </para></listitem>
 174    </varlistentry>
 175
 176   </variablelist>
 177  </refsect1>
 178
 179  <refsect1><title>EXAMPLES</title>
 180   <para>
 181    The following command converts MARC21/USMARC in MARC-8 encoding to
 182    MARC21/USMARC in UTF-8 encoding. Leader offset 9 is set to 'a'.
 183    Both input and output records are ISO2709 encoded.
 184    <screen>
 185     yaz-marcdump -f MARC-8 -t UTF-8 -o marc -l 9=97 marc21.raw >marc21.utf8.raw
 186    </screen>
 187   </para>
 188   <para>
 189    The same records may be converted to MARCXML instead in UTF-8:
 190    <screen>
 191     yaz-marcdump -f MARC-8 -t UTF-8 -o marcxml marc21.raw >marcxml.xml
 192    </screen>
 193   </para>
 194  </refsect1>
 195
 196  <refsect1><title>FILES</title>
 197   <para>
 198    <filename><replaceable>prefix</replaceable>/bin/yaz-marcdump</filename>
 199   </para>
 200   <para>
 201    <filename><replaceable>prefix</replaceable>/include/yaz/marcdisp.h</filename>
 202   </para>
 203   </refsect1>
 204  <refsect1><title>SEE ALSO</title>
 205   <para>
 206    <citerefentry>
 207     <refentrytitle>yaz</refentrytitle>
 208     <manvolnum>7</manvolnum>
 209    </citerefentry>
 210   </para>
 211   <para>
 212    <citerefentry>
 213     <refentrytitle>yaz-iconv</refentrytitle>
 214     <manvolnum>1</manvolnum>
 215    </citerefentry>
 216   </para>
 217   <para>
 218    <ulink url="&url.marcxml;">MARCXML</ulink>.
 219   </para>
 220   <para>
 221    <ulink url="&url.marcxchange;">ISO25577</ulink>.
 222   </para>
 223  </refsect1>
 224 </refentry>
 225
 226 <!-- Keep this comment at the end of the file
 227 Local variables:
 228 mode: sgml
 229 sgml-omittag:t
 230 sgml-shorttag:t
 231 sgml-minimize-attributes:nil
 232 sgml-always-quote-attributes:t
 233 sgml-indent-step:1
 234 sgml-indent-data:t
 235 sgml-parent-document:nil
 236 sgml-local-catalogs: nil
 237 sgml-namecase-general:t
 238 End:
 239 -->