source: multimedia/cdwriteutils/cdrtools.xml@ 6732c094

<?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 cdrtools-download-http "http://gd.tuwien.ac.at/utils/schilling/cdrtools/cdrtools-&cdrtools-version;.tar.bz2">
  <!ENTITY cdrtools-download-ftp  "ftp://ftp.berlios.de/pub/cdrecord/cdrtools-&cdrtools-version;.tar.bz2">
  <!ENTITY cdrtools-md5sum        "d44a81460e97ae02931c31188fe8d3fd">
  <!ENTITY cdrtools-size          "1.4 MB">
  <!ENTITY cdrtools-buildsize     "21 MB">
  <!ENTITY cdrtools-time          "0.5 SBU">
]>

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

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

  <title>Cdrtools-&cdrtools-version;</title>

  <indexterm zone="cdrtools">
    <primary sortas="a-Cdrtools">Cdrtools</primary>
  </indexterm>

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

    <para>The <application>Cdrtools</application> package contains
    CD recording utilities. These are useful for reading, creating or writing
    (burning) Compact Discs.</para>

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Required patch for extending the number of locales to create
        CDs with non-ASCII filenames:
        <ulink url="&patch-root;/cdrtools-&cdrtools-version;-mkisofs_iconv-1.patch"/></para>
      </listitem>

      <listitem>
        <para>Recommended Patch for using <application>Cdrtools</application>
        in locales using non-ISO-8859-1 character sets:
        <ulink url="&patch-root;/cdrtools-&cdrtools-version;-ascii-2.patch"/></para>
      </listitem>
    </itemizedlist>

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

  </sect2>

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

    <note>
      <para>Installation of <application>Cdrtools</application> will fail if raw
      kernel headers are found in <filename class='directory'>/usr/src/linux</filename>
      either as actual files or a symlink. As of the Linux 2.6 kernel series, this directory
      should no longer exist because appropriate headers were installed in the
      linux-libc-headers package during the base LFS installation.</para>
    </note>

    <para>When creating an ISO 9660 image with <command>mkisofs</command>,
    the character set of the filenames used must be specified unless it is
    ISO-8859-1, the default. If the character set is not specified correctly,
    then non-ASCII filenames will be unreadable on other systems, such as
    <application>Microsoft Windows</application>. This patch allows any
    input character set supported by <application>Glibc</application>
    (such as UTF-8) to be specified to <command>mkisofs</command>, as
    opposed of the short list of built-in encodings. Also, the default input
    character set is set to that of the current locale, which is the correct
    behavior. To address this situation, apply the mkisofs_iconv patch:</para>

<screen><userinput>patch -Np1 -i ../cdrtools-&cdrtools-version;-mkisofs_iconv-1.patch</userinput></screen>

    <para>The <command>cdrecord</command> program has hard-coded non-ASCII
    characters in its messages.  Since these characters are part of the
    ISO-8859-1 character set, they will not be displayed correctly in
    locales that use a different character set, such as UTF-8. The following
    patch converts these characters to ASCII approximations:</para>

<screen><userinput>patch -Np1 -i ../cdrtools-&cdrtools-version;-ascii-2.patch</userinput></screen>

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

<screen><userinput>make INS_BASE=/usr DEFINSUSR=root DEFINSGRP=root</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 INS_BASE=/usr DEFINSUSR=root DEFINSGRP=root install &amp;&amp;
install -v -m755 -d /usr/share/doc/cdrtools-2.01 &amp;&amp;
install -v -m644 README* ABOUT doc/*.ps \
    /usr/share/doc/cdrtools-2.01</userinput></screen>

  </sect2>

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

    <para><parameter>INS_BASE=/usr</parameter>: This parameter moves
    the install directory from <filename class="directory">/opt/schily</filename>
    to <filename class="directory">/usr</filename>.</para>

    <para><parameter>DEFINSUSR=root DEFINSGRP=root</parameter>: These
    parameters install all programs with root:root ownership instead of the default
    bin:bin.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>cdda2wav, cdrecord, devdump, isodebug, isodump, isoinfo, isovfy,
        mkhybrid, mkisofs, readcd, rscsi, scgcheck, and skel</seg>
        <seg>libdeflt.a, libedc_ecc.a, libfile.a, libhfs.a, libparanoia.a, librscg.a,
        libscg.a, libschily.a, and libunls.a</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="cdda2wav">
        <term><command>cdda2wav</command></term>
        <listitem>
          <para>converts Compact Disc audio into WAV sound files.</para>
          <indexterm zone="cdrtools cdda2wav">
            <primary sortas="b-cdda2wav">cdda2wav</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="cdrecord">
        <term><command>cdrecord</command></term>
        <listitem>
          <para>records audio or data Compact Discs.</para>
          <indexterm zone="cdrtools cdrecord">
            <primary sortas="b-cdrecord">cdrecord</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="devdump">
        <term><command>devdump</command></term>
        <listitem>
          <para>is a diagnostic program used to dump an
          ISO-9660 device or file in hex.</para>
          <indexterm zone="cdrtools devdump">
            <primary sortas="b-devdump">devdump</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="isodebug">
        <term><command>isodebug</command></term>
        <listitem>
          <para>is used to display the command-line parameters used to create
          an ISO-9660 image.</para>
          <indexterm zone="cdrtools isodebug">
            <primary sortas="b-isodebug">isodebug</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="isodump">
        <term><command>isodump</command></term>
        <listitem>
          <para>is a diagnostic program used to dump a device or file based on
          ISO-9660.</para>
          <indexterm zone="cdrtools isodump">
            <primary sortas="b-isodump">isodump</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="isoinfo">
        <term><command>isoinfo</command></term>
        <listitem>
          <para>is used to analyze or list an ISO-9660 image.</para>
          <indexterm zone="cdrtools isoinfo">
            <primary sortas="b-isoinfo">isoinfo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="isovfy">
        <term><command>isovfy</command></term>
        <listitem>
          <para>is used to verify an ISO-9660 image.</para>
          <indexterm zone="cdrtools isovfy">
            <primary sortas="b-isovfy">isovfy</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mkhybrid">
        <term><command>mkhybrid</command></term>
        <listitem>
          <para>is a symbolic link to <command>mkisofs</command> used to
          create ISO-9660/HFS hybrid filesystem images.</para>
          <indexterm zone="cdrtools mkhybrid">
            <primary sortas="b-mkhybrid">mkhybrid</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mkisofs">
        <term><command>mkisofs</command></term>
        <listitem>
          <para>is used to create ISO-9660/JOLIET/HFS filesystem images,
          optionally with Rock Ridge attributes.</para>
          <indexterm zone="cdrtools mkisofs">
            <primary sortas="b-mkisofs">mkisofs</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="readcd">
        <term><command>readcd</command></term>
        <listitem>
          <para>reads or writes Compact Discs.</para>
          <indexterm zone="cdrtools readcd">
            <primary sortas="b-readcd">readcd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rscsi">
        <term><command>rscsi</command></term>
        <listitem>
          <para>is a remote SCSI manager.</para>
          <indexterm zone="cdrtools rscsi">
            <primary sortas="b-rscsi">rscsi</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="scgcheck">
        <term><command>scgcheck</command></term>
        <listitem>
          <para>is used to check and verify the Application Binary Interface
          of <filename class="libraryfile">libscg</filename>.</para>
          <indexterm zone="cdrtools scgcheck">
            <primary sortas="b-scgcheck">scgcheck</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libscg">
        <term><filename class='libraryfile'>libscg.a</filename></term>
        <listitem>
          <para>is a highly portable SCSI transport library.</para>
          <indexterm zone="cdrtools libscg">
            <primary sortas="c-libscg">libscg.a</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>