1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
2 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
4 <!ENTITY % local SYSTEM "local.ent">
6 <!ENTITY % entities SYSTEM "entities.ent">
8 <!ENTITY % idcommon SYSTEM "common/common.ent">
11 <refentry id="yaz-marcdump">
13 <productname>YAZ</productname>
14 <productnumber>&version;</productnumber>
15 <info><orgname>Index Data</orgname></info>
19 <refentrytitle>yaz-marcdump</refentrytitle>
20 <manvolnum>1</manvolnum>
21 <refmiscinfo class="manual">Commands</refmiscinfo>
25 <refname>yaz-marcdump</refname>
26 <refpurpose>MARC record dump utility</refpurpose>
31 <command>yaz-marcdump</command>
32 <arg choice="opt"><option>-i <replaceable>format</replaceable></option></arg>
33 <arg choice="opt"><option>-o <replaceable>format</replaceable></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>-c <replaceable>cfile</replaceable></option></arg>
38 <arg choice="opt"><option>-s <replaceable>prefix</replaceable></option></arg>
39 <arg choice="opt"><option>-C <replaceable>size</replaceable></option></arg>
40 <arg choice="opt"><option>-n</option></arg>
41 <arg choice="opt"><option>-p</option></arg>
42 <arg choice="opt"><option>-v</option></arg>
43 <arg choice="opt"><option>-V</option></arg>
44 <arg choice="opt" rep="repeat">file</arg>
48 <refsect1><title>DESCRIPTION</title>
50 <command>yaz-marcdump</command> reads MARC records from one or
52 It parses each record and supports output in line-format,
54 <ulink url="&url.marcxml;">MARCXML</ulink>,
55 <ulink url="http://dilettantes.code4lib.org/blog/2010/09/a-proposal-to-serialize-marc-in-json/">MARC-in-JSON</ulink>,
56 <ulink url="&url.marcxchange;">MarcXchange</ulink>
57 as well as Hex output.
60 This utility parses records ISO2709(raw MARC), line format, MARC-in-JSON
61 format as well as XML if that is structured as MARCXML/MarcXchange.
64 MARC-in-JSON encoding/decoding is supported in YAZ 5.0.5 and later.
68 As of YAZ 2.1.18, OAI-MARC is no longer supported.
69 OAI-MARC is deprecated. Use MARCXML instead.
73 By default, each record is written to standard output in a line
74 format with newline for each field, $x for each subfield x.
75 The output format may be changed with option <literal>-o</literal>,
78 <command>yaz-marcdump</command> can also be requested to perform
79 character set conversion of each record.
83 <refsect1><title>OPTIONS</title>
87 <term>-i <replaceable>format</replaceable></term>
89 Specifies input 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 <literal>turbomarc</literal> (Turbo MARC),
94 or <literal>json</literal> (MARC-in-JSON).
99 <term>-o <replaceable>format</replaceable></term>
101 Specifies output format. Must be one of
102 <literal>marcxml</literal>, <literal>marc</literal> (ISO2709),
103 <literal>marcxchange</literal> (ISO25577),
104 <literal>line</literal> (line mode MARC),
105 <literal>turbomarc</literal> (Turbo MARC),
106 or <literal>json</literal> (MARC-in-JSON).
111 <term>-f <replaceable>from</replaceable></term>
113 Specify the character set <replaceable>from</replaceable>
114 of the input MARC record.
115 Should be used in conjunction with option <literal>-t</literal>.
116 Refer to the yaz-iconv man page for supported character sets.
121 <term>-t <replaceable>to</replaceable></term>
123 Specify the character set <replaceable>of</replaceable>
125 Should be used in conjunction with option <literal>-f</literal>.
126 Refer to the yaz-iconv man page for supported character sets.
131 <term>-l <replaceable>leaderspec</replaceable></term>
133 Specify a simple modification string for MARC leader. The
134 <replaceable>leaderspec</replaceable> is a list of pos=value
135 pairs, where pos is an integer offset (0 - 23) for leader. Value
136 is either a quoted string or an integer (character value in decimal).
137 Pairs are comma separated. For example, to set leader at offset 9
138 to a, use <literal>9='a'</literal>.
143 <term>-s <replaceable>prefix</replaceable></term>
145 Writes a chunk of records to a separate file with prefix given,
146 i.e. splits a record batch into files with only at most
147 "chunk" ISO2709 record per file. By default chunk is 1 (one record
148 per file). See option <literal>-C</literal>.
153 <term>-C <replaceable>chunksize</replaceable></term>
155 Specifies chunk size; to be used conjunction with option
156 <literal>-s</literal>.
163 Makes yaz-marcdump prints record number and input file offset
171 MARC output is omitted so that MARC input is only checkecd.
178 Writes more information about the parsing process.
179 Useful if you have ill-formatted ISO2709 records as input.
193 <refsect1><title>EXAMPLES</title>
195 The following command converts MARC21/USMARC in MARC-8 encoding to
196 MARC21/USMARC in UTF-8 encoding. Leader offset 9 is set to 'a'.
197 Both input and output records are ISO2709 encoded.
199 yaz-marcdump -f MARC-8 -t UTF-8 -o marc -l 9=97 marc21.raw >marc21.utf8.raw
203 The same records may be converted to MARCXML instead in UTF-8:
205 yaz-marcdump -f MARC-8 -t UTF-8 -o marcxml marc21.raw >marcxml.xml
210 Turbo MARC is a compact XML notation with same semantics as
211 MARCXML, but which allows for faster processing via XSLT. In order
212 to generate Turbo MARC records encoded in UTF-8 from MARC21 (ISO), one
215 yaz-marcdump -f MARC8 -t UTF8 -o turbomarc -i marc marc21.raw >out.xml
220 <refsect1><title>FILES</title>
222 <filename><replaceable>prefix</replaceable>/bin/yaz-marcdump</filename>
225 <filename><replaceable>prefix</replaceable>/include/yaz/marcdisp.h</filename>
228 <refsect1><title>SEE ALSO</title>
231 <refentrytitle>yaz</refentrytitle>
232 <manvolnum>7</manvolnum>
237 <refentrytitle>yaz-iconv</refentrytitle>
238 <manvolnum>1</manvolnum>
244 <!-- Keep this comment at the end of the file
249 sgml-minimize-attributes:nil
250 sgml-always-quote-attributes:t
253 sgml-parent-document:nil
254 sgml-local-catalogs: nil
255 sgml-namecase-general:t