source: gnome/add/sound-juicer.xml@ b0db915

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY sound-juicer-download-http "&gnome-download-http;/sound-juicer/&gnome-version;/sound-juicer-&sound-juicer-version;.tar.bz2">
  <!ENTITY sound-juicer-download-ftp  "&gnome-download-ftp;/sound-juicer/&gnome-version;/sound-juicer-&sound-juicer-version;.tar.bz2">
  <!ENTITY sound-juicer-md5sum        "2bb23f1bd7751eb9f14f2446beed15e0">
  <!ENTITY sound-juicer-size          "883 KB">
  <!ENTITY sound-juicer-buildsize     "11.8 MB">
  <!ENTITY sound-juicer-time          "0.2 SBU">
]>

<sect1 id="sound-juicer" xreflabel="Sound Juicer-&sound-juicer-version;">
  <?dbhtml filename="sound-juicer.html"?>

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

  <title>Sound Juicer-&sound-juicer-version;</title>

  <indexterm zone="sound-juicer">
    <primary sortas="a-Sound-Juicer">Sound Juicer</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Sound Juicer</title>

    <para>The <application>Sound Juicer</application> package contains the
    <command>sound-juicer</command> program, a simple and clean CD ripping
    tool. This is useful for extracting the audio tracks from audio compact
    discs and converting them into audio files. It can also play the audio
    tracks directly from the CD, allowing you to preview the CD before ripping
    it. <application>Sound Juicer</application> is designed to be easy to use,
    and to work with little user intervention.  When you start
    <command>sound-juicer</command> it will examine the CD in the drive and try
    to locate information about the audio tracks using the MusicBrainz
    service.</para>

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

    <bridgehead renderas="sect3">Sound Juicer Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="gnome-media"/>,
    <xref linkend="gst-plugins-base"/> (for the cdparanoiasrc, gnomevfssink
    and vorbisenc plugins), and <xref linkend="libmusicbrainz"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="intltool"/>,
    <xref linkend="gst-plugins-good"/> (for the flacenc and wavenc plugins),
    <xref linkend="gst-plugins-ugly"/> (for the lame plugin),
    <ulink url="http://www.gnu.org/software/libcdio/">libcdio</ulink>
    (which can use <xref linkend="cdparanoia"/>,
    <ulink url="http://sourceforge.net/projects/libcddb">libcddb</ulink>, and
    <ulink url="http://www.gnu.org/software/vcdimager/">VCDImager</ulink>), and
    <ulink url="http://developer.kde.org/~wheeler/taglib/">TagLib</ulink></para>

    <note>
      <para>At a minimum you should have the following plugins configured into
      the <application>GStreamer</application> installation: cdparanoiasrc and
      gnomevfssink. If either of these plugins are not configured into the
      <application>GStreamer</application> setup, <application>Sound
      Juicer</application> will fail at run-time. Additionally, if you need to
      encode in Ogg Vorbis, FLAC, Wave or MP3 formats, you should ensure the
      vorbisenc, flacenc, wavenc and lame plugins are configured into
      <application>GStreamer</application>. You can easily determine if you
      have the necessary plugins configured by using the
      <command>gst-inspect</command> program. Here is an example:</para>

<screen><userinput>gst-inspect | grep cdparanoiasrc</userinput></screen>
    </note>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of Sound Juicer</title>

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

<screen><userinput>./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
            --sysconfdir=&gnome-etc-dir; \
            --localstatedir=/var/lib &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>

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

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

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

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Sound Juicer</title>

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

      <para>Configuration is accomplished by using the
      <quote>Preferences</quote> drop-down menu option. For information on how
      to configure <command>sound-juicer</command> to use
      <application>LAME</application> as the default encoding method (creating
      MP3 files as the default) see the <application>Sound Juicer</application>
      Help section.</para>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>sound-juicer</seg>
        <seg>none</seg>
        <seg><envar>$GNOME_PREFIX</envar>/share/{,gnome/help/
        ,omf/}sound-juicer</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="sound-juicer-prog">
        <term><command>sound-juicer</command></term>
        <listitem>
          <para>is a graphical CD extraction (ripping) tool based on
          GNOME-2 and GStreamer.</para>
          <indexterm zone="sound-juicer sound-juicer-prog">
            <primary sortas="b-sound-juicer">sound-juicer</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>