Solaris/manpages/man1/esdmon.1
author dcarbery
Fri, 24 Nov 2006 16:37:59 +0000
branch217update
changeset 19096 d542fc2c823e
permissions -rwxr-xr-x
Merged trunk changes r9797:9829 into 217update branch.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
19096
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
     1
<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
     2
<!--ArborText, Inc., 1988-1999, v.4002-->
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
     3
<!ENTITY cmd "esdmon">
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
     4
<!ENTITY % commonents SYSTEM "smancommon.ent">
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
     5
%commonents;
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
     6
<!ENTITY % booktitles SYSTEM "booktitles.ent">
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
     7
%booktitles;
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
     8
<!ENTITY suncopy "Copyright (c) 2003,2006 Sun Microsystems, Inc. All Rights Reserved.">
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
     9
]>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    10
<?Pub UDT _bookmark _target>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    11
<?Pub Inc>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    12
<refentry id="esdmon-1">
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    13
<!-- %Z%%M% %I% %E% SMI; -->
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    14
<refmeta><refentrytitle>esdmon</refentrytitle><manvolnum>1</manvolnum>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    15
<refmiscinfo class="date">8 Jan 2003</refmiscinfo>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    16
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    17
<refmiscinfo class="software">&release;</refmiscinfo>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    18
<refmiscinfo class="arch">generic</refmiscinfo>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    19
<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    20
</refmeta>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    21
<indexterm><primary>esdmon</primary></indexterm><indexterm><primary>sound
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    22
monitor using the Enlightened Sound Daemon (esd)</primary></indexterm><refnamediv
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    23
id="esdmon-1-name"><refname>esdmon</refname><refpurpose>sound monitor using
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    24
the Enlightened Sound Daemon (esd)</refpurpose></refnamediv>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    25
<refsynopsisdiv id="esdmon-1-synp"><title>&synp-tt;</title>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    26
<cmdsynopsis><command>&cmd;</command><arg choice="opt"><option>s <replaceable>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    27
hostname</replaceable>:<replaceable>port</replaceable></option></arg><arg
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    28
choice="opt"><option>b</option></arg><arg choice="opt"><option>h</option></arg>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    29
<arg choice="opt"><option>m</option></arg><arg choice="opt"><option>r <replaceable>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    30
freq</replaceable></option></arg><arg choice="opt"><option role="nodash"><replaceable>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    31
filename</replaceable></option></arg>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    32
</cmdsynopsis></refsynopsisdiv>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    33
<refsect1 id="esdmon-1-desc"><title>&desc-tt;</title>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    34
<para>The <command>&cmd;</command> utility opens the <filename>esd</filename> socket
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    35
and duplicates the stream being sent to the sound device.</para>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    36
</refsect1>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    37
<refsect1 id="esdmon-1-opts"><title>&opts-tt;</title>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    38
<para>The following options are supported:</para>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    39
<variablelist termlength="medium"><varlistentry><term><option>s <replaceable>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    40
hostname</replaceable>:<replaceable>port</replaceable></option></term><listitem>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    41
<para>Contact the <filename>esd</filename> server on <replaceable>hostname
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    42
</replaceable> at <replaceable>port</replaceable>.</para>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    43
</listitem></varlistentry>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    44
<varlistentry><term><option>b</option></term><listitem><para>Specify that
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    45
the output should be in 8-bit format. By default, the output is in 16-bit
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    46
format.</para>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    47
</listitem></varlistentry>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    48
<varlistentry><term><option>h</option></term><listitem><para>Display help
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    49
text, and exit.</para>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    50
</listitem></varlistentry>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    51
<varlistentry><term><option>m</option></term><listitem><para>Specify that
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    52
the output should be in mono format. By default, the output is in stereo format.
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    53
</para>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    54
</listitem></varlistentry>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    55
<varlistentry><term><option>r <replaceable>freq</replaceable></option></term>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    56
<listitem><para>Specify that the output rate should be set to <replaceable>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    57
freq</replaceable>. By default, the output rate is set to 44.1 kHz.</para>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    58
</listitem></varlistentry>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    59
</variablelist></refsect1>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    60
<refsect1 id="esdmon-1-oper"><title>&oper-tt;</title>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    61
<para>The following operands are supported:</para>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    62
<variablelist termlength="medium"><varlistentry><term><option role="nodash"><replaceable>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    63
filename</replaceable></option></term><listitem><para>Specify that the output
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    64
should be written to <replaceable>filename</replaceable>. By default, the
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    65
output is written to <filename>stdout</filename>.</para>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    66
</listitem></varlistentry>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    67
</variablelist></refsect1>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    68
<refsect1 id="esdmon-1-exam"><title>&exam-tt;</title>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    69
<example role="example"><title>Monitor sound from file "beep"</title>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    70
<para><screen>example% <userinput>&cmd; &lt; beep</userinput></screen></para>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    71
</example>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    72
</refsect1>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    73
<refsect1 id="esdmon-1-exit"><title>&exit-tt;</title>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    74
<para>The following exit values are returned:</para>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    75
<variablelist termlength="xtranarrow"><varlistentry><term><returnvalue>0</returnvalue></term>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    76
<listitem><para>Application exited successfully</para>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    77
</listitem></varlistentry>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    78
<varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    79
exited with failure</para>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    80
</listitem></varlistentry>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    81
</variablelist></refsect1>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    82
<refsect1 id="esdmon-1-file"><title>&file-tt;</title>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    83
<para>The following files are used by this application:</para>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    84
<variablelist termlength="medium"><varlistentry><term><filename>/usr/bin/&cmd;</filename> 
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    85
</term><listitem><para>Executable for Enlightened Sound Daemon sound monitor.
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    86
</para>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    87
</listitem></varlistentry>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    88
</variablelist></refsect1>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    89
<refsect1 id="esdmon-1-attr"><title>&attr-tt;</title>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    90
<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    91
<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    92
for descriptions of the following attributes:</para>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    93
<informaltable frame="all">
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    94
<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    95
<colspec colname="COLSPEC1" colwidth="1*">
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    96
<thead>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    97
<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    98
valign="middle">ATTRIBUTE VALUE</entry></row>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
    99
</thead>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   100
<tbody>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   101
<row><entry><para>Availability</para></entry><entry><para>SUNWgnome-audio
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   102
</para></entry></row>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   103
<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   104
colname="COLSPEC1"><para>Volatile</para></entry></row>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   105
</tbody>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   106
</tgroup>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   107
</informaltable>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   108
</refsect1>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   109
<refsect1 id="esdmon-1-also"><title>&also-tt;</title>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   110
<!--Reference to another man page-->
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   111
<!--Reference to a Help manual-->
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   112
<!--Reference to a book.-->
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   113
<para><citerefentry><refentrytitle>esdcat</refentrytitle><manvolnum>1</manvolnum>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   114
</citerefentry>, <citerefentry><refentrytitle>esdplay</refentrytitle><manvolnum>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   115
1</manvolnum></citerefentry>, <citerefentry><refentrytitle>esdrec</refentrytitle>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   116
<manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>esdsample
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   117
</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   118
esdctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   119
<refentrytitle>esd-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   120
<refentrytitle>libesd</refentrytitle><manvolnum>3</manvolnum></citerefentry></para>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   121
</refsect1>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   122
<refsect1 id="esdmon-1-note"><title>&note-tt;</title>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   123
<para>Written by Brian Cameron, Sun Microsystems  Inc., 2003, 2006.<?Pub Caret>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   124
</para>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   125
</refsect1>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   126
</refentry>
d542fc2c823e Merged trunk changes r9797:9829 into 217update branch.
dcarbery
parents:
diff changeset
   127
<?Pub *0000006465>