source: multimedia/libdriv/libcanberra.xml@ 171c0d5

<?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 libcanberra-download-http "http://0pointer.de/lennart/projects/libcanberra/libcanberra-&libcanberra-version;.tar.gz">
  <!ENTITY libcanberra-download-ftp  " ">
  <!ENTITY libcanberra-md5sum        "c198b4811598c4c161ff505e4531b02c">
  <!ENTITY libcanberra-size          "476 KB">
  <!ENTITY libcanberra-buildsize     "6 MB">
  <!ENTITY libcanberra-time          "0.2 SBU">
]>

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

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

  <title>libcanberra-&libcanberra-version;</title>

  <indexterm zone="libcanberra">
    <primary sortas="a-libcanberra">libcanberra</primary>
  </indexterm>

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

    <para>The <application>libcanberra</application> is an implementation of the
    XDG Sound Theme and Name Specifications, for generating event sounds on free
    desktops, such as <application>GNOME</application>.</para>

    &lfs70_built;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="libvorbis"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="alsa-lib"/>,
      <xref linkend="gstreamer"/>,
      <xref linkend="gtk2"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="gtk-doc"/>,
      <xref linkend='pulseaudio'/>,
      <xref linkend="xorg7-proto"/>, and 
      <ulink url="http://tdb.samba.org/">tdb</ulink>
    </para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc \
    --with-gconf-schema-file-dir=$GNOME_SYSCONFDIR/gconf/schemas &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><option>--with-gconf-schema-file-dir=$GNOME_SYSCONFDIR/gconf/schemas</option>:
    Omit this parameter if you are not installing
    <application>libcanberra</application> for a GNOME installation.</para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gtk-doc-rebuild.xml"/>

  </sect2>

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

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

      <seglistitem>
        <seg>canberra-boot and canberra-gtk-play</seg>
        <seg>libcanberra-alsa.so, libcanberra-gstreamer.so,
        libcanberra-gtk-module.so, libcanberra-gtk.so,
        libcanberra-gtk3-module.so, libcanberra-gtk3.so, libcanberra-multi.so,
        libcanberra-null.so, libcanberra-oss.so, libcanberra-pulse.so, and
        libcanberra.so</seg>
        <seg>/usr/{lib/{gnome-settings-daemon-3.0/gtk-modules,libcanberra-0.28},
        share/{doc/libcanberra,gdm/autostart/LoginWindow,gnome/{autostart,
        shutdown},gtk-doc/html/libcanberra}}</seg>
      </seglistitem>
    </segmentedlist>

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

      <!--<varlistentry id="canberra-boot">
        <term><command>canberra-boot</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="libcanberra canberra-boot">
            <primary sortas="b-canberra-boot">canberra-boot</primary>
          </indexterm>
        </listitem>
      </varlistentry>-->

      <varlistentry id="canberra-gtk-play">
        <term><command>canberra-gtk-play</command></term>
        <listitem>
          <para>is an application for playing sound events.</para>
          <indexterm zone="libcanberra canberra-gtk-play">
            <primary sortas="b-canberra-gtk-play">canberra-gtk-play</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcanberra-alsa">
        <term><filename class='libraryfile'>libcanberra-alsa.so</filename></term>
        <listitem>
          <para>is an <application>ALSA</application> backend.</para>
          <indexterm zone="libcanberra libcanberra-alsa">
            <primary sortas="c-libcanberra-alsa">libcanberra-alsa.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcanberra-gstreamer">
        <term><filename class='libraryfile'>libcanberra-gstreamer.so</filename></term>
        <listitem>
          <para>is an <application>GStreamer</application> backend.</para>
          <indexterm zone="libcanberra libcanberra-gstreamer">
            <primary sortas="c-libcanberra-gstreamer">libcanberra-gstreamer.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcanberra-gtk-module">
        <term><filename class='libraryfile'>libcanberra-gtk-module.so</filename></term>
        <listitem>
          <para>contains Gtk+2 module functions.</para>
          <indexterm zone="libcanberra libcanberra-gtk-module">
            <primary sortas="c-libcanberra-gtk-module">libcanberra-gtk-module.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcanberra-gtk">
        <term><filename class='libraryfile'>libcanberra-gtk.so</filename></term>
        <listitem>
          <para>contains Gtk+2 libcanberra bindings functions.</para>
          <indexterm zone="libcanberra libcanberra-gtk">
            <primary sortas="c-libcanberra-gtk">libcanberra-gtk.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcanberra-gtk3-module">
        <term><filename class='libraryfile'>libcanberra-gtk3-module.so</filename></term>
        <listitem>
          <para>contains Gtk+3 module functions.</para>
          <indexterm zone="libcanberra libcanberra-gtk3-module">
            <primary sortas="c-libcanberra-gtk3-module">libcanberra-gtk3-module.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcanberra-gtk3">
        <term><filename class='libraryfile'>libcanberra-gtk3.so</filename></term>
        <listitem>
          <para>contains Gtk+3 libcanberra bindings functions.</para>
          <indexterm zone="libcanberra libcanberra-gtk3">
            <primary sortas="c-libcanberra-gtk3">libcanberra-gtk3.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcanberra-multi">
        <term><filename class='libraryfile'>libcanberra-multi.so</filename></term>
        <listitem>
          <para>is a multi backend.</para>
          <indexterm zone="libcanberra libcanberra-multi">
            <primary sortas="c-libcanberra-multi">libcanberra-multi.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcanberra-null">
        <term><filename class='libraryfile'>libcanberra-null.so</filename></term>
        <listitem>
          <para>is a null backend.</para>
          <indexterm zone="libcanberra libcanberra-null">
            <primary sortas="c-libcanberra-null">libcanberra-null.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcanberra-oss">
        <term><filename class='libraryfile'>libcanberra-oss.so</filename></term>
        <listitem>
          <para>is an oss backend.</para>
          <indexterm zone="libcanberra libcanberra-oss">
            <primary sortas="c-libcanberra-oss">libcanberra-oss.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcanberra-pulse">
        <term><filename class='libraryfile'>libcanberra-pulse.so</filename></term>
        <listitem>
          <para>is an <application>PulseAudio</application> backend.</para>
          <indexterm zone="libcanberra libcanberra-pulse">
            <primary sortas="c-libcanberra-pulse">libcanberra-pulse.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcanberra-lib">
        <term><filename class='libraryfile'>libcanberra.so</filename></term>
        <listitem>
          <para>contains general libcanberra API functions.</para>
          <indexterm zone="libcanberra libcanberra-lib">
            <primary sortas="c-libcanberra">libcanberra.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>