1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY libmusicbrainz-download-http "http://ftp.musicbrainz.org/pub/musicbrainz/historical/libmusicbrainz-&libmusicbrainz-version;.tar.gz">
|
---|
8 | <!ENTITY libmusicbrainz-download-ftp " ">
|
---|
9 | <!ENTITY libmusicbrainz-md5sum "d5e19bb77edd6ea798ce206bd05ccc5f">
|
---|
10 | <!ENTITY libmusicbrainz-size "524 KB">
|
---|
11 | <!ENTITY libmusicbrainz-buildsize "12 MB">
|
---|
12 | <!ENTITY libmusicbrainz-time "0.4 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="libmusicbrainz" xreflabel="libmusicbrainz-&libmusicbrainz-version;">
|
---|
16 | <?dbhtml filename="libmusicbrainz.html"?>
|
---|
17 |
|
---|
18 |
|
---|
19 | <title>libmusicbrainz-&libmusicbrainz-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="libmusicbrainz">
|
---|
22 | <primary sortas="a-libmusicbrainz">libmusicbrainz</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to libmusicbrainz</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | The <application>libmusicbrainz</application> package contains a library
|
---|
30 | which allows you to access the data held on the MusicBrainz server.
|
---|
31 | This is useful for adding MusicBrainz lookup capabilities to other
|
---|
32 | applications.
|
---|
33 | </para>
|
---|
34 |
|
---|
35 | <para>
|
---|
36 | MusicBrainz is a community music metadatabase that attempts to create
|
---|
37 | a comprehensive music information site. You can use the MusicBrainz data
|
---|
38 | either by browsing the web site, or you can access the data from a client
|
---|
39 | program — for example, a CD player program can use MusicBrainz to
|
---|
40 | identify CDs and provide information about the CD, about the artist or
|
---|
41 | other related information.
|
---|
42 | </para>
|
---|
43 |
|
---|
44 | &lfs121_checked;
|
---|
45 |
|
---|
46 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
47 | <itemizedlist spacing="compact">
|
---|
48 | <listitem>
|
---|
49 | <para>
|
---|
50 | Download (HTTP): <ulink url="&libmusicbrainz-download-http;"/>
|
---|
51 | </para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>
|
---|
55 | Download (FTP): <ulink url="&libmusicbrainz-download-ftp;"/>
|
---|
56 | </para>
|
---|
57 | </listitem>
|
---|
58 | <listitem>
|
---|
59 | <para>
|
---|
60 | Download MD5 sum: &libmusicbrainz-md5sum;
|
---|
61 | </para>
|
---|
62 | </listitem>
|
---|
63 | <listitem>
|
---|
64 | <para>
|
---|
65 | Download size: &libmusicbrainz-size;
|
---|
66 | </para>
|
---|
67 | </listitem>
|
---|
68 | <listitem>
|
---|
69 | <para>
|
---|
70 | Estimated disk space required: &libmusicbrainz-buildsize;
|
---|
71 | </para>
|
---|
72 | </listitem>
|
---|
73 | <listitem>
|
---|
74 | <para>
|
---|
75 | Estimated build time: &libmusicbrainz-time;
|
---|
76 | </para>
|
---|
77 | </listitem>
|
---|
78 | </itemizedlist>
|
---|
79 |
|
---|
80 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
81 | <itemizedlist spacing="compact">
|
---|
82 | <listitem>
|
---|
83 | <para>
|
---|
84 | Required patch: <ulink
|
---|
85 | url="&patch-root;/libmusicbrainz-&libmusicbrainz-version;-missing-includes-1.patch"/>
|
---|
86 | </para>
|
---|
87 | </listitem>
|
---|
88 | </itemizedlist>
|
---|
89 |
|
---|
90 | <bridgehead renderas="sect3">libmusicbrainz Dependencies</bridgehead>
|
---|
91 |
|
---|
92 | <bridgehead renderas="sect4">Optional to Build the Python Bindings</bridgehead>
|
---|
93 | <para role="optional">
|
---|
94 | <xref linkend="python2"/>
|
---|
95 | </para>
|
---|
96 |
|
---|
97 | </sect2>
|
---|
98 |
|
---|
99 | <sect2 role="installation">
|
---|
100 | <title>Installation of libmusicbrainz</title>
|
---|
101 |
|
---|
102 | <para>
|
---|
103 | Install <application>libmusicbrainz</application> by running the
|
---|
104 | following commands:
|
---|
105 | </para>
|
---|
106 |
|
---|
107 | <screen><userinput>patch -Np1 -i ../libmusicbrainz-&libmusicbrainz-version;-missing-includes-1.patch &&
|
---|
108 |
|
---|
109 | CXXFLAGS="${CXXFLAGS:--O2 -g} -std=c++98" \
|
---|
110 | ./configure --prefix=/usr --disable-static &&
|
---|
111 | make</userinput></screen>
|
---|
112 |
|
---|
113 | <para>
|
---|
114 | If <application>Python</application> is installed, build the bindings
|
---|
115 | with the following commands:
|
---|
116 | </para>
|
---|
117 |
|
---|
118 | <screen><userinput>(cd python && python2 setup.py build)</userinput></screen>
|
---|
119 |
|
---|
120 | <para>
|
---|
121 | This package does not come with a stand-alone test suite (to
|
---|
122 | test you must have <application>Python</application> installed and perform
|
---|
123 | the test after the package is installed).
|
---|
124 | </para>
|
---|
125 |
|
---|
126 | <para>
|
---|
127 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
128 | </para>
|
---|
129 |
|
---|
130 | <screen role="root"><userinput>make install &&
|
---|
131 | install -v -m644 -D docs/mb_howto.txt \
|
---|
132 | /usr/share/doc/libmusicbrainz-&libmusicbrainz-version;/mb_howto.txt</userinput></screen>
|
---|
133 |
|
---|
134 | <para>
|
---|
135 | To test the Python bindings, issue the following:
|
---|
136 | <command>(cd python && python2 setup.py test)</command>.
|
---|
137 | </para>
|
---|
138 |
|
---|
139 | <para>
|
---|
140 | If you built the Python bindings, issue the following commands as
|
---|
141 | the <systemitem class="username">root</systemitem> user to install
|
---|
142 | them:
|
---|
143 | </para>
|
---|
144 |
|
---|
145 | <screen role="root"><userinput>(cd python && python2 setup.py install)</userinput></screen>
|
---|
146 |
|
---|
147 | </sect2>
|
---|
148 |
|
---|
149 | <sect2 role="commands">
|
---|
150 | <title>Command Explanations</title>
|
---|
151 |
|
---|
152 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
153 | href="../../xincludes/static-libraries.xml"/>
|
---|
154 |
|
---|
155 | </sect2>
|
---|
156 |
|
---|
157 | <sect2 role="content">
|
---|
158 | <title>Contents</title>
|
---|
159 |
|
---|
160 | <segmentedlist>
|
---|
161 | <segtitle>Installed Programs</segtitle>
|
---|
162 | <segtitle>Installed Library</segtitle>
|
---|
163 | <segtitle>Installed Directories</segtitle>
|
---|
164 |
|
---|
165 | <seglistitem>
|
---|
166 | <seg>None</seg>
|
---|
167 | <seg>libmusicbrainz.so</seg>
|
---|
168 | <seg>/usr/include/musicbrainz and
|
---|
169 | /usr/share/doc/libmusicbrainz-&libmusicbrainz-version;</seg>
|
---|
170 | </seglistitem>
|
---|
171 | </segmentedlist>
|
---|
172 |
|
---|
173 | <variablelist>
|
---|
174 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
175 | <?dbfo list-presentation="list"?>
|
---|
176 | <?dbhtml list-presentation="table"?>
|
---|
177 |
|
---|
178 | <varlistentry id="libmusicbrainz-lib">
|
---|
179 | <term><filename class="libraryfile">libmusicbrainz.so</filename></term>
|
---|
180 | <listitem>
|
---|
181 | <para>
|
---|
182 | contains API functions to access the MusicBrainz database, both
|
---|
183 | for looking up data and also for submitting new data
|
---|
184 | </para>
|
---|
185 | <indexterm zone="libmusicbrainz libmusicbrainz-lib">
|
---|
186 | <primary sortas="c-libmusicbrainz">libmusicbrainz.{so,a}</primary>
|
---|
187 | </indexterm>
|
---|
188 | </listitem>
|
---|
189 | </varlistentry>
|
---|
190 | </variablelist>
|
---|
191 |
|
---|
192 | </sect2>
|
---|
193 |
|
---|
194 | </sect1>
|
---|