<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY k3b "<application>K3b</application>">
<!ENTITY cdrdao "<application>cdrdao</application>">
<!ENTITY dvdtools "<application>DVD+RW-Tools</application>">
<!ENTITY mkisofs "<application>mkisofs</application>">
<!ENTITY cdrecord "<application>cdrecord</application>">
<!ENTITY k3b-commands SYSTEM "commands.docbook">
<!ENTITY k3b-video-encoding SYSTEM "video-encoding.docbook">
<!ENTITY k3b-audiocd-howto SYSTEM "audiocd-howto.docbook">
<!ENTITY k3b-cdcopy-howto SYSTEM "cdcopy-howto.docbook">
<!ENTITY k3b-dcop SYSTEM "dcop.docbook">
  <!ENTITY kappname "&k3b;">
  <!ENTITY package "kdeextragear-1">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE">
]>

<book lang="&language;">

<bookinfo>
<title>The &k3b; Handbook</title>

<authorgroup>
  <author>
    <firstname>Carsten</firstname>
    <surname>Niehaus</surname>
  </author>
</authorgroup>

<!-- TRANS:ROLES_OF_TRANSLATORS -->

<copyright>
  <year>2003-2004</year>
<holder>Carsten Niehaus</holder>
</copyright>
<!-- Translators: put here the copyright notice of the translation -->
<legalnotice>&FDLNotice;</legalnotice>

<date>2003-12-14</date>
<releaseinfo>0.01.00</releaseinfo>

<!-- Abstract about this handbook -->

<abstract>
<para>
  &k3b; is a CD and DVD burning application for &kde; with a comfortable user interface.
</para>
</abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>kdeextragear</keyword>
<keyword>cdrecord</keyword>
<keyword>DVD</keyword>
<keyword>CD</keyword>
<keyword>burning</keyword>
<keyword>ripping</keyword>
<keyword>iso</keyword>
<keyword>K3b</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title>Introduction</title>

<para>
  &k3b; is a CD and DVD burning application for Linux systems optimized for &kde;. It provides a comfortable user interface to perform most CD/DVD
  burning tasks like creating an Audio CD from a set of audio files or copying a CD. While the experienced user can take influence in all steps of
  the burning process the beginner may find comfort in the automatic settings and the reasonable K3b defaults which allow a quick start. The actual
  burning in K3b is done by the command line utilities <application>cdrecord</application>, <application>cdrdao</application>, and 
  <application>growisofs</application>.
</para>
</chapter>

<!-- the GUI comands -->
&k3b-commands;

<chapter id="howtos">
  <title>HOWTOs for a quickstart to &k3b;</title>
  <para>&k3b; features, like many other &kde; applications as well, a
    &DCOP; interface which makes it possible to control a part of it's
    functionality from &eg; a shellscript.</para>

  &k3b-video-encoding;
  &k3b-audiocd-howto;
  &k3b-cdcopy-howto;

</chapter>

<!-- now the desciption of the DCOP-Interface -->
&k3b-dcop;


<chapter id="faq">
<title>Questions and Answers</title>

<!-- (OPTIONAL but recommended) This chapter should include all of the silly
(and not-so-silly) newbie questions that fill up your mailbox. This chapter
should be reserved for BRIEF questions and answers! If one question uses more
than a page or so then it should probably be part of the
"Using this Application" chapter instead. You should use links to
cross-reference questions to the parts of your documentation that answer them.
This is also a great place to provide pointers to other FAQ's if your users
must do some complicated configuration on other programs in order for your
application work. -->

&reporting.bugs;
&updating.documentation;

<qandaset id="faqlist">
  <qandaentry>
    <question>
      <para>
        Compiling K3b fails with undefined type "struct KComboBox".
      </para>
    </question>
    <answer>
      <para>
        The QTDesigner tool <application>uic</application> is not able to find the kde widget plugins. 
        To solve this run <application>qtconfig</application> and add 
        <filename class="directory">$<envar>KDEDIR</envar>/lib/kde3/plugins</filename> to the 
        plugin search path (replace $<envar>KDEDIR</envar> with your kde base dir).
      </para>
    </answer>
  </qandaentry>
  <!-- This is a template for a new Q&A-set
  <qandaentry>
    <question>
      <para>
        QUESTION
      </para>
    </question>
    <answer>
      <para>
         ANSWER
      </para>
    </answer>
  </qandaentry>
  -->
</qandaset>
</chapter>

<chapter id="credits">

<!-- Include credits for the programmers, documentation writers, and
contributors here. The license for your software should then be included below
the credits with a reference to the appropriate license file included in the KDE
distribution. -->

<title>Credits and License</title>

<para>
&k3b;
</para>
<para>
  Program copyright 1999-2004 Sebastian Trueg <email>trueg@k3b.org</email>
</para>
<para>
Contributors:
<itemizedlist>
  <listitem><para>Thomas Froescher <email>tfroescher@k3b.org</email></para>
</listitem>
<listitem><para>Christian Kvasny <email>chris@k3b.org</email></para>
</listitem>
<listitem><para>Klaus-Dieter Krannich <email>kd@k3b.org</email></para>
</listitem>
</itemizedlist>
</para>

<para>
  Documentation Copyright &copy; 2003-2004 Carsten Niehaus <email>cniehaus@kde.org</email>
</para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->

&underFDL;               <!-- FDL: do not remove -->

<!-- Determine which license your application is licensed under, 
     and delete all the remaining licenses below:

     (NOTE:  All documentation are licensed under the FDL, 
     regardless of what license the application uses) -->

&underGPL;        	 <!-- GPL License -->
</chapter>

<appendix id="installation">
<title>Installation</title>

<sect1 id="getting-kapp">
<title>How to obtain &k3b;</title>

<!-- This first entity contains boiler plate for applications that are
part of KDE CVS.  You should remove it if you are releasing your
application --> 

&install.intro.documentation;

</sect1>

<sect1 id="requirements">
<title>Requirements</title>

<para>
  In order to successfully use &k3b;, you need &kde; &gt;= 3.1 and &Qt; &gt;= 3.1
</para>
<para>
  &cdrdao; - &cdrdao; records audio or data CD-Rs in disk-at-once (DAO) 
  mode based on a textual description of the CD contents (toc-file). 
</para>
<para>
  &cdrecord;/&mkisofs; - &cdrecord; creates home-burned CDs with a CD-R/CD-RW recorder. 
</para>
<para>
  &dvdtools; - The DVD+RW-Tools are used to burn and format DVD+R(W) and DVD-R(W) media. 
</para>

<para>
  Optionally &k3b; can make use of all these libraries:
</para>

<para>
MAD MPEG Audio Decoder Library - MAD is a high-quality MPEG audio decoder. It currently supports MPEG-1 and the MPEG-2 extension to lower sampling frequencies, as well as the de facto MPEG 2.5 format. All three audio layers Layer I, Layer II, and Layer III (i.e. MP3) are fully implemented.
Used by the Mp3 decoding plugin. 
</para>

<para>
cdparanoia devel - Cdparanoia is a Compact Disc Digital Audio (CDDA) extraction tool, commonly known on the net as a 'ripper'. 
</para>

<para>
transcode - transcode is a linux text-console utility for video stream processing. 
Ogg Vorbis library - Ogg Vorbis is a completely open, patent-free, professional audio encoding and streaming technology with all the benefits of Open Source.
Used by the Ogg Vorbis decoding and encoding plugins. 
</para>

<para>
VCDImager - A full-featured mastering suite for authoring, disassembling and analyzing Video CD's and Super Video CD's. 
</para>

<para>
Normalize - normalize is a tool for adjusting the volume of audio files to a standard level. This is useful for things like creating mixed CD's and mp3 collections, where different recording levels on different albums can cause the volume to vary greatly from song to song. 
</para>

<para>
eMovix - eMoviX is a tiny Linux CD distribution containing all the software to boot from a CD and play automatically every video file localized in the CD root. 
</para>

<!-- For a list of updates, you may refer to the application web site
or the ChangeLog file, or ... -->
<para>
You can find a list of changes at <ulink
url="http://apps.kde.org/kapp">http://apps.kde.org/kapp</ulink>.
</para>
</sect1>

<sect1 id="compilation">
<title>Compilation and Installation</title>

<!-- This entity contains the boilerplate text for standard -->
<!-- compilation instructions.  If your application requires any -->
<!-- special handling, remove it, and replace with your own text. -->

&install.compile.documentation;

</sect1>

<sect1 id="configuration">
<title>Configuration</title>

<para>Don't forget to tell your system to start the <filename>dtd</filename>
dicer-toaster daemon first, or &k3b; won't work !</para>

</sect1>

</appendix>

&documentation.index;
</book>

<!--
Local Variables:
mode: xml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:

vim:tabstop=2:shiftwidth=2:expandtab 
-->
