<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!--ARC : LSARC 2001/201 GNOME 2.X on Solaris-->
<!ENTITY cmd "esdctl">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
<!ENTITY suncopy "Copyright (c) 2003,2006 Sun Microsystems, Inc. All Rights Reserved.">
]>
<?Pub UDT _bookmark _target>
<?Pub Inc>
<refentry id="esdctl-1">
<!-- %Z%%M% %I% %E% SMI; -->
<refmeta><refentrytitle>esdctl</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">8 Jan 2003</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
<refmiscinfo class="software">&release;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
</refmeta>
<indexterm><primary>esdctl</primary></indexterm><indexterm><primary>Enlightened
Sound Daemon (esd) control program</primary></indexterm><refnamediv id="esdctl-1-name">
<refname>esdctl</refname><refpurpose>Enlightened Sound Daemon (esd) control
program</refpurpose></refnamediv>
<refsynopsisdiv id="esdctl-1-synp"><title>&synp-tt;</title>
<cmdsynopsis><command>&cmd;</command><arg choice="opt"><option>h</option></arg><arg choice="opt"><option>-help</option></arg><arg choice="opt"><option>p <replaceable>string</replaceable></option></arg><arg choice="opt"><option>s <replaceable>hostname</replaceable>:<replaceable>
port</replaceable></option></arg><arg choice="plain"><option role="nodash"><replaceable>
command</replaceable></option></arg>
</cmdsynopsis></refsynopsisdiv>
<refsect1 id="esdctl-1-desc"><title>&desc-tt;</title>
<para>The <command>&cmd;</command> utility is a command-line control program
for the Enlightened Sound Daemon (<filename>esd</filename>).</para>
</refsect1>
<refsect1 id="esdctl-1-opts"><title>&opts-tt;</title>
<para>The following options are supported:</para>
<variablelist termlength="medium">
<varlistentry><term><option>p <replaceable>
string</replaceable></option></term><listitem>
<para>Prefix for cached samples.  You can also specify this option as follows:</para>
<para><option>-prefix=<replaceable>string</replaceable></option></para>
</listitem></varlistentry>
<varlistentry><term><option>s <replaceable>
hostname</replaceable>:<replaceable>port</replaceable></option></term><listitem>
<para>Contact the <filename>esd</filename> server on <replaceable>hostname
</replaceable> at <replaceable>port</replaceable>. You can also specify this
option as follows:</para>
<para><option>-server=<replaceable>hostname</replaceable>:<replaceable>port
</replaceable></option></para>
</listitem></varlistentry>
<varlistentry><term><option>h</option>, <option>-help</option></term><listitem><para>Display help
text, and exit.</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="esdctl-1-oper"><title>&oper-tt;</title>
<para>The following operands are supported:</para>
<variablelist termlength="narrow"><varlistentry><term><option role="nodash"><replaceable>
command</replaceable></option></term>
<listitem><para>
The following commands are supported:
<variablelist termlength="medium"><varlistentry><term><option
role="nodash">allinfo</option></term><listitem><para>Get player and sample
information from the server</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">cache <replaceable>sample</replaceable></option></term>
<listitem><para>Cache a sample in the server</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">free <replaceable>name</replaceable></option></term>
<listitem><para>Uncache a sample in the server</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">getid <replaceable>name</replaceable></option></term>
<listitem><para>Retrieve a sample id, given the sample name</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">lock &nbsp;&nbsp; &nbsp;&nbsp;</option></term>
<listitem><para>Do not allow foreign clients to use the server</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">loop <replaceable>name</replaceable></option></term>
<listitem><para>Make a cached sample loop</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">off</option></term><listitem><para>
Suspend sound output so that other programs can use the audio device (this
is the same as the <option role="nodash">standby</option> option)</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">on</option></term><listitem><para>
Resume sound output so that only <filename>esd</filename> can use the audio
device (this is the same as the <option role="nodash">resume</option> option)
</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">pansample <replaceable>id</replaceable> <replaceable>
left </replaceable><replaceable>right</replaceable></option></term><listitem>
<para>Set default panning for a sample, where <replaceable>id</replaceable>
is the sample ID, and <replaceable>left </replaceable>and <replaceable>right
</replaceable> are integers in the range 0 to 255</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">panstream <replaceable>id</replaceable> <replaceable>
left </replaceable><replaceable>right</replaceable></option></term><listitem>
<para>Set panning for a stream, where <replaceable>id</replaceable> is the
stream ID, and <replaceable>left </replaceable>and <replaceable>right</replaceable>
are integers in the range 0 to 255</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">play <replaceable>name</replaceable></option></term>
<listitem><para>Play a cached sample once</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">resume</option></term><listitem>
<para>Resume sound output so that only <filename>esd</filename> can use the
audio device (this is the same as the <option role="nodash">on</option> option)
</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">serverinfo</option></term><listitem>
<para>Get server information from the server</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">standby</option></term><listitem>
<para>Suspend sound output so that other programs can use the audio device
(this is the same as the <option role="nodash">off</option> option)</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">standbymode</option></term><listitem>
<para>Check whether the server is on standby</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">stop <replaceable>name</replaceable></option></term>
<listitem><para>Stop the looping sample at the end</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">unlock</option></term><listitem>
<para>Allow foreign clients to use the server</para>
</listitem></varlistentry>
</variablelist></para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="esdctl-1-exam"><title>&exam-tt;</title>
<example role="example"><title>Putting esd into Standby Mode</title>
<para><screen>example% <userinput>&cmd; standby</userinput></screen></para>
</example>
<example role="example"><title>Ending Standby Mode</title>
<para><screen>example% <userinput>&cmd; resume</userinput></screen></para>
</example>
<example role="example"><title>Loading a sample into the esd cache</title>
<para><screen>example% <userinput>&cmd; cache info.wav</userinput>
<computeroutput>Sample &lt;3> uploaded. Name = esdctl:info.wav</computeroutput></screen></para>
<para>This output indicates that the sample id is <literal>3</literal>, and
the sample name is <literal>esdctl:info.wav</literal>.</para>
</example>
<example role="example"><title>Getting a sample id from the esd cache</title>
<para><screen>example% <userinput>&cmd; getid esdctl:info.wav</userinput></screen></para>
</example>
<example role="example"><title>Playing a sample from the esd cache</title>
<para><screen>example% <userinput>&cmd; play esdctl:info.wav</userinput></screen></para>
</example>
<example role="example"><title>Playing and looping a sample</title>
<para><screen>example% <userinput>&cmd; loop esdctl:info.wav</userinput></screen></para>
</example>
<example role="example"><title>Stopping a looped sample that is being played
</title>
<para><screen>example% <userinput>&cmd; stop esdctl:info.wav</userinput></screen></para>
</example>
<example role="example"><title>Removing a sample from the esd cache</title>
<para><screen>example% <userinput>&cmd; free esdctl:info.wav</userinput></screen></para>
</example>
<example role="example"><title>Setting panning for a stream</title>
<para><screen>example% <userinput>&cmd; panstream 1 100 155</userinput></screen></para>
</example>
<example role="example"><title>Setting panning for a sample</title>
<para><screen>example% <userinput>&cmd; pansample 1 155 100</userinput></screen></para>
</example>
</refsect1>
<refsect1 id="esdctl-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="esdctl-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 Enlightened Sound Daemon
control program</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="esdctl-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/gnome-audio
</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="esdctl-1-also"><title>&also-tt;</title>
<!--Reference to another man page-->
<!--Reference to a Help manual-->
<!--Reference to a book.-->
<para>
<citerefentry><refentrytitle>esdcat</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>esdplay</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>esdrec</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>esdsample</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>esdmon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>esd-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>libesd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
<refsect1 id="esdctl-1-note"><title>&note-tt;</title>
<para>Written by Brian Cameron, Sun Microsystems Inc., 2003, 2006.</para>
</refsect1>
</refentry>
