source: multimedia/libdriv/libmusicbrainz3.xml@ e43a5132

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY libmusicbrainz3-download-http "http://ftp.musicbrainz.org/pub/musicbrainz/libmusicbrainz-&libmusicbrainz3-version;.tar.gz">
  <!ENTITY libmusicbrainz3-download-ftp  " ">
  <!ENTITY libmusicbrainz3-md5sum        "f4824d0a75bdeeef1e45cc88de7bb58a">
  <!ENTITY libmusicbrainz3-size          "103 KB">
  <!ENTITY libmusicbrainz3-buildsize     "9 MB">
  <!ENTITY libmusicbrainz3-time          "less than 0.1 SBU">
]>

<sect1 id="libmusicbrainz3" xreflabel="libmusicbrainz3-&libmusicbrainz3-version;">
  <?dbhtml filename="libmusicbrainz3.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>libmusicbrainz-&libmusicbrainz3-version;</title>

  <indexterm zone="libmusicbrainz3">
    <primary sortas="a-libmusicbrainz3">libmusicbrainz3</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libmusicbrainz</title>

    <para>The <application>libmusicbrainz</application> package contains a
    library which allows you to access the data held on the MusicBrainz server.
    This is useful for adding MusicBrainz lookup capabilities to other
    applications.</para>

    <para>MusicBrainz is a community music metadatabase that attempts to create
    a comprehensive music information site. You can use the MusicBrainz data
    either by browsing the web site, or you can access the data from a client
    program &mdash; for example, a CD player program can use MusicBrainz to
    identify CDs and provide information about the CD, about the artist or
    other related information.</para>

    <para><application>libmusicbrainz</application> version 3 is not backward
    compatible with version 2.</para>

    &lfs70_built;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&libmusicbrainz3-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&libmusicbrainz3-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &libmusicbrainz3-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &libmusicbrainz3-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &libmusicbrainz3-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &libmusicbrainz3-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">libmusicbrainz Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="cmake"/> and 
    <xref linkend="neon"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="libdiscid"/> and
    <ulink
    url="http://sourceforge.net/apps/mediawiki/cppunit/">cppunit</ulink>
    (Required to run the test suite)</para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/libmusicbrainz3"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of libmusicbrainz</title>

    <para>Install <application>libmusicbrainz</application> by running the following
    commands:</para>

<screen><userinput>cmake -DCMAKE_INSTALL_PREFIX=/usr . &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>None</seg>
        <seg>libmusicbrainz3.so</seg>
        <seg>/usr/include/musicbrainz3</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="libmusicbrainz3-lib">
        <term><filename class='libraryfile'>libmusicbrainz3.so</filename></term>
        <listitem>
          <para>contains API functions to access the MusicBrainz database, both
          for looking up data and also for submitting new data.</para>
          <indexterm zone="libmusicbrainz3 libmusicbrainz3-lib">
            <primary sortas="c-libmusicbrainz3">libmusicbrainz3.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>