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