source: kde/kf5-apps/k3b.xml@ 1f28e76c

<?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 k3b-download-http "&kf5apps-download-http;/k3b-&kf5apps-version;.tar.xz">
  <!ENTITY k3b-download-ftp  " ">
  <!ENTITY k3b-md5sum        "15df47ce0a4157e8c3d0b3bda16cdb94">
  <!ENTITY k3b-size          "10 MB">
  <!ENTITY k3b-buildsize     "118 MB">
  <!ENTITY k3b-time          "1.1 SBU (using parallelism=4)">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

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

  <indexterm zone="k3b">
    <primary sortas="a-K3b">K3b</primary>
  </indexterm>

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

    <para>
      The <application>K3b</application> package contains a KF5-based
      graphical interface to the <application>Cdrtools</application> and
      <application>dvd+rw-tools</application> CD/DVD manipulation tools. It also
      combines the capabilities of many other multimedia packages into one
      central interface to provide a simple-to-operate application that can be
      used to handle many of your CD/DVD recording and formatting requirements.
      It is used for creating audio, data, video and mixed-mode CDs as well
      as copying, ripping and burning CDs and DVDs.
    </para>

    <para>
      Though <application>k3b</application> can be used to copy almost any
      DVD to similar medium, it does not provide a way to copy, or reproduce a
      double-layer DVD onto single-layer medium. Of course, there is not a
      program anywhere on any platform that can make an exact duplicate of a
      double-layer DVD onto a single-layer disk, there are programs on some
      platforms that can compress the data on a double-layer DVD to fit on a
      single-layer DVD producing a duplicate, but compressed, image. If you need
      to copy the contents of a double-layer DVD to single-layer medium, you may
      want to look at the
      <ulink url="http://www.mcmurchy.com/rmlcopydvd/">RMLCopyDVD</ulink> package.
    </para>

    &lfs111_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="kf5-frameworks"/>,
      <xref linkend="libkcddb"/>,
      <xref linkend="libsamplerate"/>, and
      <xref linkend="shared-mime-info"/>
    </para>

    <para role="required">
      The CD/DVD drive is detected at run time using <xref linkend="udisks2"
      role="runtime"/>, which must therefore be installed before running
      <command>k3b</command>.
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="libburn"/>,
      <xref linkend="libdvdread"/>, and
      <xref linkend="taglib"/>
    </para>

    <para role="recommended">
      There are programs from three packages that
      <application>k3b</application> will look for at runtime:
      <xref role="runtime" linkend="cdrtools"/> (required to burn CD-ROM media),
      <xref role="runtime" linkend="dvd-rw-tools"/> (required to burn or format
      DVD media), and <xref role="runtime" linkend="cdrdao"/> (required to burn
      CD-ROM media in DAO (Disk At Once) mode). If you  don't need the
      capability provided by any of the three packages, you don't have to
      install it. However, a warning message will be generated every time you
      run the <command>k3b</command> program if any are not installed.
    </para>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="flac"/>,
      <xref linkend="lame"/>,
      <xref linkend="libmad"/>,
      <xref linkend="libsndfile"/>,
      <xref linkend="libvorbis"/>,
      <xref linkend="libmusicbrainz"/>, and
      <ulink url="http://www.musepack.net/">Musepack (libmpcdec)</ulink>
    </para>

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

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

    <para>
      Install <application>K3b</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>
          k3b
        </seg>
        <seg>
          libk3bdevice.so,
          libk3blib.so,
          and numerous plugin modules for the installed dependencies
        </seg>
        <seg>
          $KF5_PREFIX/share/{,kxmlgui5/}k3b and
          $KF5_PREFIX/share/doc/HTML/*/k3b
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="k3b-prog">
        <term><command>k3b</command></term>
        <listitem>
          <para>
            is the graphical CD/DVD program
          </para>
          <indexterm zone="k3b k3b-prog">
            <primary sortas="b-k3b">k3b</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>