|
1 <!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [ |
|
2 <!--ArborText, Inc., 1988-1999, v.4002--> |
|
3 <!ENTITY cmd "vumeter"> |
|
4 <!ENTITY % commonents SYSTEM "smancommon.ent"> |
|
5 %commonents; |
|
6 <!ENTITY % booktitles SYSTEM "booktitles.ent"> |
|
7 %booktitles; |
|
8 <!ENTITY suncopy "Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved."> |
|
9 ]> |
|
10 <?Pub UDT _bookmark _target> |
|
11 <?Pub Inc> |
|
12 <refentry id="vumeter-1"> |
|
13 <!-- %Z%%M% %I% %E% SMI; --> |
|
14 <refmeta><refentrytitle>vumeter</refentrytitle><manvolnum>1</manvolnum> |
|
15 <refmiscinfo class="date">7 Sep 2004</refmiscinfo> |
|
16 <refmiscinfo class="sectdesc">&man1;</refmiscinfo> |
|
17 <refmiscinfo class="software">&release;</refmiscinfo> |
|
18 <refmiscinfo class="arch">generic</refmiscinfo> |
|
19 <refmiscinfo class="copyright">&suncopy;</refmiscinfo> |
|
20 </refmeta> |
|
21 <indexterm><primary>vumeter</primary></indexterm><indexterm><primary>visual |
|
22 audio-level meter</primary></indexterm> |
|
23 <refnamediv id="vumeter-1-name"><refname>vumeter</refname><refpurpose>visual |
|
24 audio-level meter</refpurpose></refnamediv> |
|
25 <refsynopsisdiv id="vumeter-1-synp"><title>&synp-tt;</title> |
|
26 <cmdsynopsis><command>&cmd;</command> |
|
27 <arg choice="opt"><option>r</option></arg> |
|
28 <arg choice="opt"><option>s=<replaceable>ESD-server-host</replaceable></option></arg> |
|
29 <arg choice="opt"><option>v</option></arg> |
|
30 <arg choice="opt"><option>x=<replaceable>x-position</replaceable></option></arg> |
|
31 <arg choice="opt"><option>y=<replaceable>y-position</replaceable></option></arg> |
|
32 <arg choice="opt"><option role="nodash"><replaceable>gnome-std-options</replaceable></option></arg> |
|
33 </cmdsynopsis></refsynopsisdiv> |
|
34 <refsect1 id="vumeter-1-desc"><title>&desc-tt;</title> |
|
35 <para><command>&cmd;</command> provides a visual indication of the audio level |
|
36 of the audio device when <command>esd</command>, the enlightened sound daemon, |
|
37 is running.</para> |
|
38 </refsect1> |
|
39 <refsect1 id="vumeter-1-opts"><title>&opts-tt;</title> |
|
40 <para>The following options are supported:</para> |
|
41 <variablelist termlength="medium"> |
|
42 <varlistentry><term><option>r</option></term><listitem><para>Act as a recording-level |
|
43 meter instead of an output-level meter.</para> |
|
44 </listitem></varlistentry> |
|
45 <varlistentry><term><option>s=<replaceable>ESD-server-host</replaceable></option></term> |
|
46 <listitem><para>Connect to the <command>esd</command> server on the host named <replaceable> |
|
47 ESD-server-host</replaceable>, and monitor the running <command>esd</command> |
|
48 daemon. If <replaceable>ESD-server-host</replaceable> is not specified, the |
|
49 default value is the local host.</para> |
|
50 </listitem></varlistentry> |
|
51 <varlistentry><term><option>v</option></term><listitem><para>Display the meter |
|
52 in a vertical orientation. The meter is displayed horizontally by default. |
|
53 </para> |
|
54 </listitem></varlistentry> |
|
55 <varlistentry><term><option>x=<replaceable>x-position</replaceable></option></term> |
|
56 <listitem><para>Create initial window with given horizontal offset, measured |
|
57 in pixels, from the left of the display. <replaceable>x-position</replaceable> |
|
58 is the number of pixels by which to offset the window.</para> |
|
59 </listitem></varlistentry> |
|
60 <varlistentry><term><option>y=<replaceable>y-position</replaceable></option></term> |
|
61 <listitem><para>Create initial window with given vertical offset, measured |
|
62 in pixels, from the top of the display. <replaceable>y-position</replaceable> |
|
63 is the number of pixels by which to offset the window.</para> |
|
64 </listitem></varlistentry> |
|
65 <varlistentry><term><option role="nodash"><replaceable>gnome-std-options</replaceable></option></term> |
|
66 <listitem><para>Standard options available for use with most GNOME applications. |
|
67 See <citerefentry><refentrytitle>gnome-std-options</refentrytitle><manvolnum> |
|
68 5</manvolnum></citerefentry> for more information.</para> |
|
69 </listitem></varlistentry> |
|
70 </variablelist></refsect1> |
|
71 <refsect1 id="vumeter-1-exam"><title>&exam-tt;</title> |
|
72 <example role="example"> |
|
73 <title>Launching the Visual Audio-Level Meter</title> |
|
74 <para><screen>example% <userinput>&cmd;</userinput></screen></para> |
|
75 </example> |
|
76 </refsect1> |
|
77 <refsect1 id="vumeter-1-exit"><title>&exit-tt;</title> |
|
78 <para>The following exit values are returned:</para> |
|
79 <variablelist termlength="xtranarrow"> |
|
80 <varlistentry><term><returnvalue>0</returnvalue></term><listitem><para>Application |
|
81 exited successfully</para> |
|
82 </listitem></varlistentry> |
|
83 <varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application |
|
84 exited with failure</para> |
|
85 </listitem></varlistentry> |
|
86 </variablelist></refsect1> |
|
87 <refsect1 id="vumeter-1-file"><title>&file-tt;</title> |
|
88 <para>The following files are used by this application:</para> |
|
89 <variablelist termlength="medium"> |
|
90 <varlistentry><term><filename>/usr/bin/&cmd;</filename></term><listitem><para> |
|
91 Executable for visual audio-level meter</para> |
|
92 </listitem></varlistentry> |
|
93 </variablelist></refsect1> |
|
94 <refsect1 id="vumeter-1-attr"><title>&attr-tt;</title> |
|
95 <para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry> |
|
96 <refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink> |
|
97 for descriptions of the following attributes:</para> |
|
98 <informaltable frame="all"> |
|
99 <tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*"> |
|
100 <colspec colname="COLSPEC1" colwidth="1*"> |
|
101 <thead> |
|
102 <row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center" |
|
103 valign="middle">ATTRIBUTE VALUE</entry></row> |
|
104 </thead> |
|
105 <tbody> |
|
106 <row><entry><para>Availability</para></entry><entry><para>SUNWgnome-sound-recorder |
|
107 </para></entry></row> |
|
108 <row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry |
|
109 colname="COLSPEC1"><para>Volatile</para></entry></row> |
|
110 </tbody> |
|
111 </tgroup> |
|
112 </informaltable> |
|
113 </refsect1> |
|
114 <refsect1 id="vumeter-1-also"><title>&also-tt;</title> |
|
115 <!--Reference to another man page--> |
|
116 <!--Reference to a Help manual--> |
|
117 <!--Reference to a book.--> |
|
118 <para>Latest version of the <citetitle>GNOME Desktop User Guide</citetitle> |
|
119 for your platform.</para> |
|
120 <para><citerefentry><refentrytitle>esd<?Pub Caret></refentrytitle><manvolnum> |
|
121 1</manvolnum></citerefentry>, <citerefentry><refentrytitle>gnome-std-options |
|
122 </refentrytitle><manvolnum>5</manvolnum></citerefentry></para> |
|
123 </refsect1> |
|
124 <refsect1 id="vumeter-1-note"><title>¬e-tt;</title> |
|
125 <para>Written by Niall Power, Sun Microsystems Inc., 2004.</para> |
|
126 </refsect1> |
|
127 </refentry> |
|
128 <?Pub *0000006296> |