source: archive/simpleburn.xml@ 48b59802

<?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 simpleburn-download-http "http://simpleburn.tuxfamily.org/IMG/gz/simpleburn-&simpleburn-version;.tar.gz">
  <!ENTITY simpleburn-download-ftp  " ">
  <!ENTITY simpleburn-md5sum        "11cf5b9a69fda6c72b1ae1277fafa386">
  <!ENTITY simpleburn-size          "52 KB">
  <!ENTITY simpleburn-buildsize     "1.6 MB">
  <!ENTITY simpleburn-time          "less than 0.1 SBU">
]>

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

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

  <title>SimpleBurn-&simpleburn-version;</title>

  <indexterm zone="simpleburn">
    <primary sortas="a-SimpleBurn">SimpleBurn</primary>
  </indexterm>

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

    <para>
      <application>SimpleBurn</application> is a minimalistic application for
      burning and extracting CDs and DVDs.
    </para>

    &lfs7a_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libcddb"/> and
      <xref linkend="cmake"/> and
      <xref linkend="gtk2"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="libisoburn"/>,
      <xref linkend="cdparanoia"/>, and
      <xref linkend="cdrdao"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="libcdio"/> (to identify and play CDs),
      <xref linkend="flac"/>,
      <xref linkend="mpg123"/>,
      <xref linkend="vorbistools"/>,
      <xref linkend="lame"/>,
      <xref linkend="mplayer"/>,
      <ulink url="http://mpg321.sourceforge.net/">mpg321</ulink>,
      <ulink url="http://normalize.nongnu.org/">normalize</ulink>,
      <ulink url="http://sourceforge.net/projects/cdrtools/files/alpha/">cdrtools</ulink>, and
      <ulink url="http://www.cdrkit.org/">cdrkit</ulink>
    </para>

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

  </sect2>

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

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

<screen><userinput>sed -i -e 's|DESTINATION doc|DESTINATION share/doc|' CMakeLists.txt &amp;&amp;

mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_BUILD_TYPE=Release  \
      -DCMAKE_INSTALL_PREFIX=/usr \
      -DBURNING=LIBBURNIA .. &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>

    <para>
      All optical devices are not accessible for any user except <systemitem
      class="username">root</systemitem> and members of the <systemitem
      class="groupname">cdrom</systemitem> group. Add any users that might use
      the optical devices to that group:
    </para>

<screen role="root"><userinput>usermod -a -G cdrom <replaceable>&lt;username&gt;</replaceable></userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <command>sed ...</command>: Ensure the documentation is installed
      in /usr/share/doc.
    </para>

    <para>
      <parameter>-DBURNING=LIBBURNIA</parameter>: This switch changes the
      burning suite from the default cdrtools.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          simpleburn,
          simpleburn.sh
          simpleburn-detect.sh,
          simpleburn-gauges, and 
          simpleburn-gauges.sh
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /usr/share/doc/simpleburn-&simpleburn-version; and
          /usr/share/simpleburn
        </seg>
      </seglistitem>
    </segmentedlist>

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

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

      <varlistentry id="simpleburn-gauges">
        <term><command>simpleburn-gauges</command></term>
        <listitem>
          <para>
            is a program used to display a gauge.
          </para>
          <indexterm zone="simpleburn simpleburn-gauges">
            <primary sortas="b-simpleburn-gauges">simpleburn-gauges</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="simpleburn-detect.sh">
        <term><command>simpleburn-detect.sh</command></term>
        <listitem>
          <para>
            is a script that detects a cdrom and optional outputs details
            about the media.
          </para>
          <indexterm zone="simpleburn simpleburn-detect.sh">
            <primary sortas="b-simpleburn-detect.sh">simpleburn-detect.sh</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="simpleburn-gauges.sh">
        <term><command>simpleburn-gauges.sh</command></term>
        <listitem>
          <para>
            is a suport script for other simpleburn scripts
          </para>
          <indexterm zone="simpleburn simpleburn-gauges.sh">
            <primary sortas="b-simpleburn-gauges.sh">simpleburn-gauges.sh</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="simpleburn.sh">
        <term><command>simpleburn.sh</command></term>
        <listitem>
          <para>
            is a script for command line based cdrom operations
          </para>
          <indexterm zone="simpleburn simpleburn.sh">
            <primary sortas="b-simpleburn.sh">simpleburn.sh</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>