source: multimedia/cdwriteutils/k3b.xml@ a7208196

<?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 "http://downloads.sourceforge.net/k3b/k3b-&k3b-version;.tar.bz2">
  <!ENTITY k3b-download-ftp  " ">
  <!ENTITY k3b-md5sum        "cac9b8230295c1756581399b3bbd0687">
  <!ENTITY k3b-size          "4.0 MB">
  <!ENTITY k3b-buildsize     "64.1 MB">
  <!ENTITY k3b-time          "4.0 SBU">
]>

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

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

  <title>K3b-&k3b-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 KDE-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.
    This is useful 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>

    <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="kdelibs"/></para>

    <para>There are programs from three packages that
    <application>K3b</application> will look for at runtime:
    <xref linkend="cdrtools"/> (required to burn CD-ROM media),
    <xref linkend="dvd-rw-tools"/> (required to burn or format DVD media), and
    <xref 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">Recommended</bridgehead>
    <para role="recommended"><xref linkend="kdebase"/>,
    <xref linkend="libjpeg"/>,
    <xref linkend="kdemultimedia"/> (required for a working audio player)</para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="alsa"/>,
    <xref linkend="cdparanoia"/>,
    <xref linkend="ffmpeg"/>,
    <xref linkend="flac"/>,
    <xref linkend="hal"/>* (must also have
    <ulink url="http://www.freedesktop.org/wiki/Software/DBusBindings">D-Bus
    Qt3 Bindings</ulink>),
    <xref linkend="lame"/>,
    <xref linkend="libmad"/>,
    <xref linkend="libmusicbrainz"/>,
    <xref linkend="libvorbis"/>,
    <xref linkend="libxml2"/>,
    <xref linkend="transcode"/>,
    <ulink url="http://www.mega-nerd.com/libsndfile/">libsndfile</ulink>,
    <ulink url="http://movix.sourceforge.net/">MoviX</ulink>,
    <ulink url="http://www.musepack.net/">Musepack (libmpcdec)</ulink>,
    <ulink url="http://normalize.nongnu.org/">normalize</ulink>,
    <ulink url="ftp://ftp.lst.de/pub/people/okir/resmgr/">resmgr</ulink>,
    <ulink url="http://www.mega-nerd.com/libsamplerate/">Secret Rabbit
    Code (libsamplerate)</ulink>,
    <ulink url="http://sox.sourceforge.net/">SoX</ulink>,
    <ulink url="http://developer.kde.org/~wheeler/taglib/">TagLib</ulink>, and
    <ulink url="http://www.vcdimager.org/">VCDImager</ulink></para>

    <para>* This combination of <application>HAL</application> and the
    <application>D-Bus</application> <application>Qt3</application> bindings
    has not been tested by the BLFS team.</para>

    <para>For an explanation how each package is used by
    <application>K3b</application>, see the Requirements page at
    <ulink url="http://k3b.plainblack.com/requirements"/>.</para>

    <bridgehead renderas="sect4">Runtime Requirements for DVD Ripping and
    Encoding</bridgehead>
    <para role="optional"><xref linkend="transcode"/>,
    <xref linkend="xvid"/>,
    <xref linkend="libdvdread"/>, and
    <xref linkend="libdvdcss"/></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>

    <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
    href="../../xincludes/kde-sysconfdir.xml"/>

<screen><userinput>./configure --prefix=$(kde-config --prefix) \
            --sysconfdir=/etc/kde \
            --disable-debug \
            --disable-dependency-tracking &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="commands">
    <title>Command Explanations</title>

    <para><parameter>--prefix=$(kde-config --prefix)</parameter>: This
    parameter uses <command>kde-config</command> to establish the prefix of
    the existing KDE installation and then sets the installation prefix for
    <application>K3b</application> to the same value.</para>

    <para><parameter>--disable-debug</parameter>: This option causes the package
    to be compiled without debugging code.</para>

    <para><parameter>--disable-dependency-tracking</parameter>: This option
    speeds up one time builds.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring k3b</title>

    <sect3 id="k3b-config">
      <title>Configuration Information</title>

      <para>You will need to ensure that any user of
      <application>K3b</application> has permission to read and write to the
      CD/DVD/audio hardware device files. The easiest way to do this is by
      creating groups (audio, video, cdrecord, dvdrecord, etc.,) and then add
      users to the appropriate groups. You'll also have to ensure that the
      <application>Udev</application> rules are set up appropriately if you
      are using a system where the device files are created during the system
      boot-up sequence.</para>

      <para>There is a script installed (<command>k3bsetup</command>) that is
      a front-end to the k3bsetup2 KControlModule. This script can be accessed
      as a pull-down menu from the K3b GUI and requires
      <systemitem class="username">root</systemitem> user privileges
      (<systemitem class="username">root</systemitem> privileges are acquired
      through the use of the automatically-launched <command>kdesud</command>
      program). Though this utility can be used to set the appropriate
      permissions for the device files, be forewarned that in a Udev
      environment, where the device files are created during the system boot-up
      sequence, any changes made by this utility will not be preserved across
      system boots.</para>

    </sect3>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>k3b and k3bsetup</seg>
        <seg>libk3b.so, libk3bdevice.so and numerous
        modules for the installed dependencies</seg>
        <seg>The following subdirectories of <envar>$KDE_PREFIX</envar>/share/:
        applnk/Settings/System, apps/k3b, doc/HTML/en/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>

      <varlistentry id="k3bsetup">
        <term><command>k3bsetup</command></term>
        <listitem>
          <para>is a script used to launch the k3bsetup2 KControlModule
          for setting up the CD/DVD hardware and device files in your
          system.</para>
          <indexterm zone="k3b k3bsetup">
            <primary sortas="b-k3bsetup">k3bsetup</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>