source: archive/gvolwheel.xml@ 54bd123

<?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 gvolwheel-download-http "&sourceforge-repo;/gvolwheel/gvolwheel-&gvolwheel-version;.tar.gz">
  <!ENTITY gvolwheel-download-ftp  "">
  <!ENTITY gvolwheel-md5sum        "4f04f00cdb875894c96b8a3ff8a9edb9">
  <!ENTITY gvolwheel-size          "340 KB">
  <!ENTITY gvolwheel-buildsize     "2.8 MB">
  <!ENTITY gvolwheel-time          "less than 0.1 SBU">
]>

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

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

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

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

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

    <para>
      The <application>Gvolwheel</application> package provides a lightweight
      volume control with a tray icon.
    </para>

    &lfs74_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="alsa-utils"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="intltool"/> and
      <xref linkend="perl-xml-parser"/>
    </para>

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

  <sect2 role="kernel"  id="gvolwheel-kernel">
    <title>Kernel Configuration</title>

    <para>
      In the Device Drivers &rArr; Sound card support &rArr; Advanced Linux
      Sound Architecture section of the kernel configuration, ensure that OSS Mixer
      API (CONFIG_SND_MIXER_OSS) is selected. If necessary, recompile and install
      your new kernel.
    </para>

    <indexterm zone="gvolwheel gvolwheel-kernel">
      <primary sortas="d-gvolwheel">gvolwheel</primary>
    </indexterm>

  </sect2>

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

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

<screen><userinput>sed -i 's%doc/gvolwheel%share/doc/gvolwheel-&gvolwheel-version;%' Makefile.in &amp;&amp;
./configure --prefix=/usr --enable-oss &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a working 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>
      <command>sed -i 's%doc/gvolwheel%share/doc/gvolwheel-&gvolwheel-version;%' ...</command>:
      This ensures that the documentation into a versioned directory.
    </para>

    <para>
      <parameter>--enable-oss</parameter>: without this, the program will not
      run unless <command>alsamixer</command> has been run.
    </para>

  </sect2>

  <sect2 role="configuring gvolwheel">
    <title>Configuring Gvolwheel</title>

    <para>
      Before using this application, use <command>alsamixer</command> to
      ensure the channels are not muted, and are set to suitable levels so
      that the master volume control will provide suitable levels. Once
      <command>gvolwheel</command> is running you can, if you wish,
      right-click on its icon in the tray to change it to control the PCM
      volume instead of the  master volume. Depending on your theme settings,
      you may also wish to tick &quot;Use Gnome Icons&quot;.
    </para>

    <para>
      If you middle-click on the icon, it will mute the volume, that is, it
      will set it to zero : do not confuse this with the mute/unmute controls in
      e.g. <command>alsamixer</command>.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          gvolwheel
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /usr/share/doc/gvolwheel-&gvolwheel-version; and
          /usr/share/pixmaps/gvolwheel
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gvolwheel-prog">
        <term><command>gvolwheel</command></term>
        <listitem>
          <para>
            is a lightweight volume control that sits in a tray.
          </para>
          <indexterm zone="gvolwheel gvolwheel">
            <primary sortas="b-gvolwheel">gvolwheel</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>