source: multimedia/libdriv/libdiscid.xml@ 18a8da63

<?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 libdiscid-download-http "http://ftp.musicbrainz.org/pub/musicbrainz/libdiscid/libdiscid-&libdiscid-version;.tar.gz">
  <!ENTITY libdiscid-download-ftp  "ftp://ftp.musicbrainz.org/pub/musicbrainz/libdiscid/libdiscid-&libdiscid-version;.tar.gz">
  <!ENTITY libdiscid-md5sum        "2812bb678f5142efdfd0d0f7d6ea87d6">
  <!ENTITY libdiscid-size          "396 KB">
  <!ENTITY libdiscid-buildsize     "3.1 MB (with tests)">
  <!ENTITY libdiscid-time          "0.1 SBU (with tests)">
]>

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

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

  <title>libdiscid-&libdiscid-version;</title>

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

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

    <para>
      The <application>libdiscid</application> package contains a library for
      creating MusicBrainz DiscIDs from audio CDs. It reads a CD's table of
      contents (TOC) and generates an identifier which can be used to lookup the
      CD at MusicBrainz (<ulink url="http://musicbrainz.org"/>). Additionally, it
      provides a submission URL for adding the DiscID to the database.
    </para>

    &lfs10_checked;

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/>
    </para>

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

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

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

<screen><userinput>./configure --prefix=/usr --disable-static &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="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

  </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>
          libdiscid.so
        </seg>
        <seg>
          /usr/include/discid
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libdiscid-lib">
        <term><filename class="libraryfile">libdiscid.so</filename></term>
        <listitem>
          <para>
            contains the DiscID API functions.
          </para>
          <indexterm zone="libdiscid libdiscid-lib">
            <primary sortas="c-libdiscid">libdiscid.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>