<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [

<!--ArborText, Inc., 1988-1999, v.4002-->

<!ENTITY cmd "vumeter">

<!ENTITY % commonents SYSTEM "smancommon.ent">

%commonents;

<!ENTITY % booktitles SYSTEM "booktitles.ent">

%booktitles;

<!ENTITY suncopy "Copyright (c) 2004,2007 Sun Microsystems, Inc. All Rights Reserved.">

]>

<?Pub UDT _bookmark _target>

<?Pub Inc>

<refentry id="vumeter-1">

<refmeta><refentrytitle>vumeter</refentrytitle><manvolnum>1</manvolnum>

<refmiscinfo class="date">08 Nov 2007</refmiscinfo>

<refmiscinfo class="sectdesc">&man1;</refmiscinfo>

<refmiscinfo class="software">&release;</refmiscinfo>

<refmiscinfo class="arch">generic</refmiscinfo>

<refmiscinfo class="copyright">&suncopy;</refmiscinfo>

</refmeta>

<indexterm><primary>vumeter</primary></indexterm><indexterm><primary>visual

audio-level meter</primary></indexterm>

<refnamediv id="vumeter-1-name"><refname>vumeter</refname><refpurpose>visual

audio-level meter</refpurpose></refnamediv>

<refsynopsisdiv id="vumeter-1-synp"><title>&synp-tt;</title>

<cmdsynopsis><command>&cmd;</command>

<arg choice="opt"><option>-record</option></arg>

<arg choice="opt"><option>-server=<replaceable>ESD-server-host</replaceable></option></arg>

<arg choice="opt"><option>-vertical</option></arg>

<arg choice="opt"><option>-xpos=<replaceable>x-position</replaceable></option></arg>

<arg choice="opt"><option>-ypos=<replaceable>y-position</replaceable></option></arg>

<arg choice="opt"><option role="nodash"><replaceable>gnome-std-options</replaceable></option></arg>

</cmdsynopsis></refsynopsisdiv>

<refsect1 id="vumeter-1-desc"><title>&desc-tt;</title>

<para><command>&cmd;</command> provides a visual indication of the audio level

of the audio device when <command>esd</command>, the enlightened sound daemon,

is running.</para>

</refsect1>

<refsect1 id="vumeter-1-opts"><title>&opts-tt;</title>

<para>The following options are supported:</para>

<variablelist termlength="wide">

<varlistentry>

<term><option>r</option>, <option>-record</option></term><listitem><para>Act as a recording-level

meter instead of an output-level meter.</para>

</listitem></varlistentry>

<varlistentry>

<term><option>s</option>, <option>-server=<replaceable>ESD-server-host</replaceable></option></term>

<listitem><para>Connect to the <command>esd</command> server on the host named <replaceable>

ESD-server-host</replaceable>, and monitor the running <command>esd</command>

daemon. If <replaceable>ESD-server-host</replaceable> is not specified, the

default value is the local host.</para>

</listitem></varlistentry>

<varlistentry>

<term><option>v</option>, <option>-vertical</option></term>

<listitem>

<para>Display the meter in a vertical orientation. The meter is displayed

horizontally by default.</para>

</listitem></varlistentry>

<varlistentry>

<term><option>x</option>, <option>-xpos=<replaceable>x-position</replaceable></option></term>

<listitem><para>Create initial window with given horizontal offset, measured

in pixels, from the left of the display. <replaceable>x-position</replaceable>

is the number of pixels by which to offset the window.</para>

</listitem></varlistentry>

<varlistentry>

<term><option>y</option>, <option>ypos=<replaceable>y-position</replaceable></option></term>

<listitem><para>Create initial window with given vertical offset, measured

in pixels, from the top of the display. <replaceable>y-position</replaceable>

is the number of pixels by which to offset the window.</para>

</listitem></varlistentry>

<varlistentry><term><option role="nodash"><replaceable>gnome-std-options</replaceable></option></term>

<listitem><para>Standard options available for use with most GNOME applications.

See <citerefentry><refentrytitle>gnome-std-options</refentrytitle><manvolnum>

5</manvolnum></citerefentry> for more information.</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="vumeter-1-exam"><title>&exam-tt;</title>

<example role="example">

<title>Launching the Visual Audio-Level Meter</title>

<para><screen>example% <userinput>&cmd;</userinput></screen></para>

</example>

</refsect1>

<refsect1 id="vumeter-1-exit"><title>&exit-tt;</title>

<para>The following exit values are returned:</para>

<variablelist termlength="xtranarrow">

<varlistentry><term><returnvalue>0</returnvalue></term><listitem><para>Application

exited successfully</para>

</listitem></varlistentry>

<varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application

exited with failure</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="vumeter-1-file"><title>&file-tt;</title>

<para>The following files are used by this application:</para>

<variablelist termlength="medium">

<varlistentry><term><filename>/usr/bin/&cmd;</filename></term><listitem><para>

Executable for visual audio-level meter</para>

</listitem></varlistentry>

</variablelist></refsect1>

<refsect1 id="vumeter-1-attr"><title>&attr-tt;</title>

<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>

<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>

for descriptions of the following attributes:</para>

<informaltable frame="all">

<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">

<colspec colname="COLSPEC1" colwidth="1*">

<thead>

<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"

valign="middle">ATTRIBUTE VALUE</entry></row>

</thead>

<tbody>

<row><entry><para>Availability</para></entry><entry><para>gnome/media/sound-recorder

</para></entry></row>

<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry

colname="COLSPEC1"><para>Volatile</para></entry></row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 id="vumeter-1-also"><title>&also-tt;</title>

<para>Latest version of the <citetitle>GNOME Desktop User Guide</citetitle>

for your platform.</para>

<para>

<citerefentry><refentrytitle>esd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>,

<citerefentry><refentrytitle>gnome-std-options</refentrytitle><manvolnum>5</manvolnum></citerefentry>

</para>

</refsect1>

<refsect1 id="vumeter-1-note"><title>&note-tt;</title>

<para>Written by Niall Power, Sun Microsystems Inc., 2004, 2007.</para>

</refsect1>

</refentry>