source: multimedia/audioutils/kwave.xml@ 8c2ae89

<?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 kwave-download-http "&kf5apps-download-http;/kwave-&kf5apps-version;.tar.xz">
  <!ENTITY kwave-download-ftp  " ">
  <!ENTITY kwave-md5sum        "fad4772ce1ca9b85541424746a1fcd6d">
  <!ENTITY kwave-size          "5.9 MB">
  <!ENTITY kwave-buildsize     "56 MB">
  <!ENTITY kwave-time          "1.2 SBU (using parallelism=4)">
]>

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

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

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

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

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

    <para>
      The <application>KWave</application> package contains a KF5 based Sound
      Editor application.
    </para>

    &lfs90_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="audiofile"/>,
      <xref linkend="fftw"/>, 
      <xref linkend="id3lib"/>, and
      <xref linkend="kf5-frameworks"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="alsa-lib"/>,
      <xref linkend="flac"/>,
      <xref linkend="libogg"/>, and
      <xref linkend="pulseaudio"/>
    </para>

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

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

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

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

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

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX \
      -DCMAKE_BUILD_TYPE=Release         \
      -DBUILD_TESTING=OFF                \
      -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>
          kwave
        </seg>
        <seg>
          libkwave.so, 
          libkwavegui.so, and
          29 plugins
        </seg>
        <seg>
          $KF5_PREFIX/lib/plugins/kwave and
          $KF5_PREFIX/share/doc/HTML/en/kwave
        </seg>
      </seglistitem>
    </segmentedlist>

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

     <varlistentry id="kwave-prog">
        <term><command>kwave</command></term>
        <listitem>
          <para>
            is a sound editor built on the KDE Frameworks 5.
          </para>
          <indexterm zone="kwave kwave-prog">
            <primary sortas="b-kwave">kwave</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>