Solaris/manpages/man1/esdplay.1
branch217update
changeset 19096 d542fc2c823e
equal deleted inserted replaced
19095:e8e7aa8c74b9 19096:d542fc2c823e
       
     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 "esdplay">
       
     4 <!ENTITY % commonents SYSTEM "smancommon.ent">
       
     5 %commonents;
       
     6 <!ENTITY % booktitles SYSTEM "booktitles.ent">
       
     7 %booktitles;
       
     8 <!ENTITY suncopy "Copyright (c) 2003,2006 Sun Microsystems, Inc. All Rights Reserved.">
       
     9 ]>
       
    10 <?Pub UDT _bookmark _target>
       
    11 <?Pub Inc>
       
    12 <refentry id="esdplay-1">
       
    13 <!-- %Z%%M% %I% %E% SMI; -->
       
    14 <refmeta><refentrytitle>esdplay</refentrytitle><manvolnum>1</manvolnum>
       
    15 <refmiscinfo class="date">8 Jan 2003</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>esdplay</primary></indexterm><indexterm><primary>play
       
    22 a sound file</primary></indexterm><refnamediv id="esdplay-1-name"><refname>esdplay</refname>
       
    23 <refpurpose>play a sound file</refpurpose></refnamediv>
       
    24 <refsynopsisdiv id="esdplay-1-synp"><title>&synp-tt;</title>
       
    25 <cmdsynopsis><command>&cmd;</command><arg choice="opt"><option>h</option></arg><arg choice="opt"><option>-help</option></arg>
       
    26 <arg choice="opt"><option>s <replaceable>hostname</replaceable>:<replaceable>
       
    27 port</replaceable></option></arg><arg choice="opt"><option>v</option></arg><arg choice="opt"><option>-version</option></arg>
       
    28 <arg choice="plain"><option role="nodash"><replaceable>filename</replaceable></option></arg>
       
    29 </cmdsynopsis></refsynopsisdiv>
       
    30 <refsect1 id="esdplay-1-desc"><title>&desc-tt;</title>
       
    31 <para>The <command>&cmd;</command> application plays a sound file using the
       
    32 Enlightened Sound Daemon (esd).  The input data is read from the specified <filename><replaceable>
       
    33 filename</replaceable></filename>.</para>
       
    34 </refsect1>
       
    35 <refsect1 id="esdplay-1-opts"><title>&opts-tt;</title>
       
    36 <para>The following options are supported:</para>
       
    37 <variablelist termlength="medium"><varlistentry><term><option>h</option>, <option>-help</option></term>
       
    38 <listitem><para>Display help text, and exit.</para>
       
    39 </listitem></varlistentry>
       
    40 <varlistentry><term><option>s <replaceable>hostname</replaceable>:<replaceable>
       
    41 port</replaceable></option></term><listitem><para>Contact the <filename>esd
       
    42 </filename> server on <replaceable>hostname</replaceable> at <replaceable>
       
    43 port</replaceable>. You can also specify this option as follows: </para>
       
    44 <para><option>-server=<replaceable>hostname</replaceable>:<replaceable>port
       
    45 </replaceable></option></para>
       
    46 </listitem></varlistentry>
       
    47 <varlistentry><term><option>v</option>, <option>-version</option></term><listitem><para>Display version
       
    48 information, and exit.</para>
       
    49 </listitem></varlistentry>
       
    50 </variablelist></refsect1>
       
    51 <refsect1 id="esdplay-1-oper"><title>&oper-tt;</title>
       
    52 <para>The following operands are supported:</para>
       
    53 <variablelist termlength="medium"><varlistentry><term><option role="nodash"><replaceable>
       
    54 filename</replaceable></option></term><listitem><para>Specify the <replaceable>
       
    55 filename</replaceable> from which the input data should be read.</para>
       
    56 </listitem></varlistentry>
       
    57 </variablelist></refsect1>
       
    58 <refsect1 id="esdplay-1-exam"><title>&exam-tt;</title>
       
    59 <example role="example"><title>Playing sound file "beep"</title>
       
    60 <para><screen>example% <userinput>&cmd; beep</userinput></screen></para>
       
    61 </example>
       
    62 </refsect1>
       
    63 <refsect1 id="esdplay-1-exit"><title>&exit-tt;</title>
       
    64 <para>The following exit values are returned:</para>
       
    65 <variablelist termlength="xtranarrow"><varlistentry><term><returnvalue>0</returnvalue></term>
       
    66 <listitem><para>Application exited successfully</para>
       
    67 </listitem></varlistentry>
       
    68 <varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application
       
    69 exited with failure</para>
       
    70 </listitem></varlistentry>
       
    71 </variablelist></refsect1>
       
    72 <refsect1 id="esdplay-1-file"><title>&file-tt;</title>
       
    73 <para>The following files are used by this application:</para>
       
    74 <variablelist termlength="medium"><varlistentry><term><filename>/usr/bin/&cmd;</filename> 
       
    75 </term><listitem><para>Executable for Enlightened Sound Daemon sound player.<?Pub Caret>
       
    76 </para>
       
    77 </listitem></varlistentry>
       
    78 </variablelist></refsect1>
       
    79 <refsect1 id="esdplay-1-attr"><title>&attr-tt;</title>
       
    80 <para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
       
    81 <refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
       
    82 for descriptions of the following attributes:</para>
       
    83 <informaltable frame="all">
       
    84 <tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
       
    85 <colspec colname="COLSPEC1" colwidth="1*">
       
    86 <thead>
       
    87 <row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
       
    88 valign="middle">ATTRIBUTE VALUE</entry></row>
       
    89 </thead>
       
    90 <tbody>
       
    91 <row><entry><para>Availability</para></entry><entry><para>SUNWgnome-audio
       
    92 </para></entry></row>
       
    93 <row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
       
    94 colname="COLSPEC1"><para>Volatile</para></entry></row>
       
    95 </tbody>
       
    96 </tgroup>
       
    97 </informaltable>
       
    98 </refsect1>
       
    99 <refsect1 id="esdplay-1-also"><title>&also-tt;</title>
       
   100 <!--Reference to another man page-->
       
   101 <!--Reference to a Help manual-->
       
   102 <!--Reference to a book.-->
       
   103 <para><citerefentry><refentrytitle>esdcat</refentrytitle><manvolnum>1</manvolnum>
       
   104 </citerefentry>, <citerefentry><refentrytitle>esdmon</refentrytitle><manvolnum>
       
   105 1</manvolnum></citerefentry>, <citerefentry><refentrytitle>esdrec</refentrytitle>
       
   106 <manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>esdsample
       
   107 </refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>
       
   108 esdctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry>
       
   109 <refentrytitle>esd-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry>
       
   110 <refentrytitle>libesd</refentrytitle><manvolnum>3</manvolnum></citerefentry></para>
       
   111 </refsect1>
       
   112 <refsect1 id="esdplay-1-note"><title>&note-tt;</title>
       
   113 <para>Written by Brian Cameron, Sun Microsystems  Inc., 2003, 2006.</para>
       
   114 </refsect1>
       
   115 </refentry>
       
   116 <?Pub *0000005889>