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