manpages/man1/esdcat.1

<!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 "esdcat">
<!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="esdcat-1">
<!-- %Z%%M% %I% %E% SMI; -->
<refmeta><refentrytitle>esdcat</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">7 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>esdcat</primary></indexterm><indexterm><primary>play a
sound file</primary></indexterm><refnamediv id="esdcat-1-name">
<refname>esdcat</refname><refpurpose>play a sound file</refpurpose></refnamediv>
<refsynopsisdiv id="esdcat-1-synp"><title>&synp-tt;</title>
<cmdsynopsis><command>&cmd;</command>
<arg choice="opt"><option>s <replaceable>hostname</replaceable>:<replaceable>port</replaceable></option></arg>
<arg choice="opt"><option>b</option></arg>
<arg choice="opt"><option>h</option></arg>
<arg choice="opt"><option>m</option></arg>
<arg choice="opt"><option>n <replaceable>filename</replaceable></option></arg>
<arg choice="opt"><option>r <replaceable>freq</replaceable></option></arg>
<arg choice="opt"><option role="nodash"><replaceable>filename</replaceable></option></arg>
</cmdsynopsis></refsynopsisdiv>
<refsect1 id="esdcat-1-desc"><title>&desc-tt;</title>
<para>
The <command>&cmd;</command> application pipes data from the filename specified
(or <literal>stdin</literal> if not specified) to the sound device, using the
Enlightened Sound Daemon (<filename>esd</filename>).
</para>
</refsect1>
<refsect1 id="esdcat-1-opts"><title>&opts-tt;</title>
<para>The following options are supported:</para>
<variablelist termlength="medium">
<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>.
</para>
</listitem></varlistentry>
<varlistentry>
<term><option>b</option></term>
<listitem><para>
Specify that the output should be in 8-bit format. By default, the output is in
16-bit format.
</para>
</listitem></varlistentry>
<varlistentry>
<term><option>h</option></term>
<listitem><para>
Display help text, and exit.
</para>
</listitem></varlistentry>
<varlistentry>
<term><option>m</option></term>
<listitem><para>
Specify that the output should be in mono format. By default, the output is in
stereo format.
</para>
</listitem></varlistentry>
<varlistentry>
<term><option>n <replaceable>filename</replaceable></option></term>
<listitem><para>
Specify the <replaceable>filename</replaceable> of the input file.  If the
filename is specified both as an operand and with the <option>n</option>
option, then the value specified with the <option>n</option> option is ignored.
If no filename is specified with the command, then <literal>stdin</literal> is
used.
</para>
</listitem></varlistentry>
<varlistentry>
<term><option>r <replaceable>freq</replaceable></option></term>
<listitem><para>
Specify that the output rate should be set to <replaceable> freq</replaceable>.
By default, the output rate is set to 44.1 kHz.
</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="esdcat-1-oper"><title>&oper-tt;</title>
<para>The following operands are supported:</para>
<variablelist termlength="medium">
<varlistentry>
<term><option role="nodash"><replaceable>filename</replaceable></option></term>
<listitem><para>
Specify the <replaceable>filename</replaceable> of the input file.  If no
filename is specified with the command, then <literal>stdin</literal> is used.
</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="esdcat-1-exam"><title>&exam-tt;</title>
<example role="example"><title>Playing a sound file "beep" from
<literal>stdin</literal></title>
<para><screen>example% <userinput>&cmd; &lt; beep</userinput></screen></para>
</example>
</refsect1>
<refsect1 id="esdcat-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="esdcat-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 sound piper
</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="esdcat-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>SUNWgnome-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="esdcat-1-also"><title>&also-tt;</title>
<!--Reference to another man page-->
<!--Reference to a Help manual-->
<!--Reference to a book.-->
<para>
<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>esdctl</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="esdcat-1-note"><title>&note-tt;</title>
<para>Written by Brian Cameron, Sun Microsystems Inc., 2003, 2006.</para>
</refsect1>
</refentry>