source: kde/kf5-apps/libkcddb.xml@ 39eac921

<?xml version="1.0" encoding="UTF-8"?>
<!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 libkcddb-download-http "&kf5apps-download-http;/libkcddb-&kf5apps-version;.tar.xz">
  <!ENTITY libkcddb-download-ftp  " ">
  <!ENTITY libkcddb-md5sum        "29438c22614fb4bd372c7cd326ce5853">
  <!ENTITY libkcddb-size          "444 KB">
  <!ENTITY libkcddb-buildsize     "11 MB">
  <!ENTITY libkcddb-time          "0.1 SBU">
]>

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


  <title>libkcddb-&kf5apps-version;</title>

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

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

    <para>
      The <application>libkcddb</application> package contains a library
      used to retrieve audio CD meta data from the internet.
    </para>

    &lfs121_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="kf5-frameworks"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="libmusicbrainz5"/>
    </para>

  </sect2>

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

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

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=$KF6_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTING=OFF                \
      -DQT_MAJOR_VERSION=6               \
      -Wno-dev ..                        &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </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 Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libKCddb6.so
        </seg>
        <seg>
          $KF6_PREFIX/include/KCddb6
          $KF6_PREFIX/lib/cmake/KCddb6
          $KF6_PREFIX/share/doc/HTML/*/kcontrol
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libkcddb-lib">
        <term><filename class="libraryfile">libKCddb6.so</filename></term>
        <listitem>
          <para>
            contains functions used to retrieve audio CD meta data
            from the internet
          </para>
          <indexterm zone="libkcddb libkcddb-lib">
            <primary sortas="c-libkcddb">libkcddb.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>