doc/yaz-marcdump-man.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2 <!-- $Id: yaz-marcdump-man.xml,v 1.1 2003-10-27 12:21:24 adam Exp $ -->
   3 <refentry id="yaz-marcdump">
   4  <refmeta>
   5   <refentrytitle>yaz-marcdump</refentrytitle>
   6   <manvolnum>1</manvolnum>
   7  </refmeta>
   8
   9  <refnamediv>
  10   <refname>yaz-marcdump</refname>
  11   <refpurpose>MARC record dump utility</refpurpose>
  12  </refnamediv>
  13
  14  <refsynopsisdiv>
  15   <cmdsynopsis>
  16    <command>yaz-marcdump</command>
  17    <arg choice="opt"><option>-x</option></arg>
  18    <arg choice="opt"><option>-X</option></arg>
  19    <arg choice="opt"><option>-O</option></arg>
  20    <arg choice="opt"><option>-f <replaceable>from</replaceable></option></arg>
  21    <arg choice="opt"><option>-t <replaceable>to</replaceable></option></arg>
  22    <arg choice="opt"><option>-v</option></arg>
  23    <arg choice="opt"><option>-c <replaceable>cfile</replaceable></option></arg>
  24    <arg choice="opt" rep="repeat">file</arg>
  25   </cmdsynopsis>
  26  </refsynopsisdiv>
  27
  28  <refsect1><title>DESCRIPTION</title>
  29   <para>
  30    <command>yaz-marcdump</command> reads ISO2709/MARC records from one or
  31    more files.
  32    It validates each record and supports output in line-format,
  33    MARCXML, OAIMARC as well as Hex output.
  34   </para>
  35   <para>
  36    By default, each record is printed to standard output in a line
  37    format with newline for each field, $x for each subfield x.
  38   </para>
  39   <para>
  40    <command>yaz-marcdump</command> can also be requested to perform
  41    character set conversion of each record.
  42   </para>
  43  </refsect1>
  44
  45  <refsect1><title>OPTIONS</title>
  46
  47   <variablelist>
  48    <varlistentry>
  49     <term>-x</term>
  50     <listitem><para>
  51       Print MARC records in a simple XML format.
  52       This format is equivalent to YAZ_MARC_SIMPLEXML in
  53       <filename>yaz/marcdisp.h</filename>.
  54      </para></listitem>
  55    </varlistentry>
  56
  57    <varlistentry>
  58     <term>-X</term>
  59     <listitem><para>
  60       Print MARC records in MARCXML.
  61       This format is equivalent to YAZ_MARC_MARCXML in
  62       <filename>yaz/marcdisp.h</filename>.
  63      </para></listitem>
  64    </varlistentry>
  65
  66    <varlistentry>
  67     <term>-O</term>
  68     <listitem><para>
  69       Print MARC records in OAIMARC. Another XML variant.
  70       This format is equivalent to YAZ_MARC_OAIMARC in
  71       <filename>yaz/marcdisp.h</filename>.
  72      </para></listitem>
  73    </varlistentry>
  74
  75    <varlistentry>
  76     <term>-f<replaceable>from</replaceable>]</term>
  77     <listitem><para>
  78       Specify the character set <replaceable>from</replaceable>
  79       of the input MARC record.
  80       Should be used in conjunction with option <literal>-t</literal>.
  81      </para></listitem>
  82    </varlistentry>
  83
  84    <varlistentry>
  85     <term>-t<replaceable>to</replaceable>]</term>
  86     <listitem><para>
  87       Specify the character set <replaceable>of</replaceable>
  88       of the output.
  89       Should be used in conjunction with option <literal>-f</literal>.
  90      </para></listitem>
  91    </varlistentry>
  92
  93    <varlistentry>
  94     <term>-v</term>
  95     <listitem><para>
  96       Print more information about the parsing process.
  97       Useful if you have ill-formatted ISO2709 records as input.
  98      </para></listitem>
  99    </varlistentry>
 100
 101   </variablelist>
 102  </refsect1>
 103
 104  <refsect1><title>EXAMPLES</title>
 105   <para>
 106    The following command converts MARC21/USMARC using MARC-8 encoding to
 107    MARCXML in UTF-8 encoding.
 108    <screen>
 109     yaz-marcdump -f MARC-8 -t UTF-8 -X marc21.raw >marcxml.xml
 110    </screen>
 111   </para>
 112  </refsect1>
 113
 114  <refsect1><title>FILES</title>
 115   <para>
 116    <filename><replaceable>prefix</replaceable>/bin/yaz-marcdump</filename>
 117    <filename><replaceable>prefix</replaceable>/include/yaz/marcdisp.h</filename>
 118   </para>
 119   </refsect1>
 120  <refsect1><title>SEE ALSO</title>
 121   <para>
 122    yaz(7)
 123   </para>
 124  </refsect1>
 125 </refentry>
 126
 127 <!-- Keep this comment at the end of the file
 128 Local variables:
 129 mode: sgml
 130 sgml-omittag:t
 131 sgml-shorttag:t
 132 sgml-minimize-attributes:nil
 133 sgml-always-quote-attributes:t
 134 sgml-indent-step:1
 135 sgml-indent-data:t
 136 sgml-parent-document:nil
 137 sgml-local-catalogs: nil
 138 sgml-namecase-general:t
 139 End:
 140 -->