Solaris/manpages/man1/esd-config.1
branch217update
changeset 19096 d542fc2c823e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Solaris/manpages/man1/esd-config.1	Fri Nov 24 16:37:59 2006 +0000
@@ -0,0 +1,138 @@
+<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
+<!--ArborText, Inc., 1988-1999, v.4002-->
+<!ENTITY suncopy "Copyright (c) 2003, Sun Microsystems, Inc. 
+Copyright (c) 2001, Dick Porter, ACM, and Elliot Lee
+ Copyright (c) 2000, Chris Waters, Debian. 
+All Rights Reserved.">
+<!ENTITY cmd "esd-config">
+<!ENTITY % commonents SYSTEM "smancommon.ent">
+%commonents;
+<!ENTITY % booktitles SYSTEM "booktitles.ent">
+%booktitles;
+]>
+<?Pub UDT _bookmark _target>
+<?Pub Inc>
+<refentry id="esd-config-1">
+<!-- %Z%%M% %I% %E% SMI; -->
+<refmeta><refentrytitle>esd-config</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>esd-config</primary></indexterm><indexterm><primary>helper
+script for building with the Enlightened Sound Daemon (esd)</primary></indexterm>
+<refnamediv id="esd-config-1-name"><refname>esd-config</refname><refpurpose>helper
+script for building with the Enlightened Sound Daemon (<command>esd</command>)
+</refpurpose></refnamediv>
+<refsynopsisdiv id="esd-config-1-synp"><title>&synp-tt;</title>
+<cmdsynopsis><command>&cmd;</command><arg choice="opt"><option>-version</option></arg>
+<arg choice="opt"><option>-prefix=<replaceable>dir</replaceable></option></arg>
+<arg choice="opt"><option>-cflags</option></arg><arg choice="opt"><option>
+-libs</option></arg><arg choice="opt"><option>-exec-prefix=<replaceable>dir
+</replaceable></option></arg>
+</cmdsynopsis></refsynopsisdiv>
+<refsect1 id="esd-config-1-desc"><title>&desc-tt;</title>
+<para>The <command>&cmd;</command> tool enables you to specify which compiler
+and linker flags should be used to compile and link programs that use the <command>
+esd</command> library.</para>
+</refsect1>
+<refsect1 id="esd-config-1-opts"><?Pub Caret><title>&opts-tt;</title>
+<para>The following options are supported:</para>
+<variablelist termlength="medium"><varlistentry><term><option>-cflags</option></term>
+<listitem><para>Print the compiler flags that are necessary to compile a program
+using the specified library.</para>
+</listitem></varlistentry>
+<varlistentry><term><option>-libs</option></term><listitem><para>Print the
+linker flags that are necessary to link with the specified library.</para>
+</listitem></varlistentry>
+<varlistentry><term><option>-exec-prefix=<replaceable>dir</replaceable></option></term>
+<listitem><para>If specified, use <filename><replaceable>dir </replaceable></filename>instead
+of the installation <filename>exec</filename> prefix that the library was
+built with, when computing the output for the <option>-cflags</option> and <option>
+-libs</option> options. This option must be specified before any <option>
+-libs</option> or <option>-cflags</option> options.</para>
+</listitem></varlistentry>
+<varlistentry><term><option>-prefix=<replaceable>dir</replaceable></option></term>
+<listitem><para>If specified, use <filename><replaceable>dir</replaceable></filename>
+instead of the installation prefix that the library was built with, when computing
+the output for the <option>-cflags</option> and <option>-libs</option> options.
+This option must be specified before any <option>-libs</option> or <option>
+-cflags</option> options. This option is also used for the <filename>exec
+</filename> prefix, if the <option>-exec-prefix</option> option is not specified.
+</para>
+</listitem></varlistentry>
+<varlistentry><term><option>-version</option></term><listitem><para>Print
+the currently installed version of the library on the standard output.</para>
+</listitem></varlistentry>
+</variablelist></refsect1>
+<refsect1 id="esd-config-1-exam"><title>&exam-tt;</title>
+<example role="example"><title>Getting the Enlightened Sound Daemon version
+</title>
+<para><screen>example% <userinput>&cmd; --version</userinput></screen></para>
+</example>
+<example role="example"><title>Determining the libraries required to link
+with the Enlightened Sound Daemon</title>
+<para><screen>example% <userinput>&cmd; --libs</userinput></screen></para>
+</example>
+</refsect1>
+<refsect1 id="esd-config-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="esd-config-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 helper script
+</para>
+</listitem></varlistentry>
+</variablelist></refsect1>
+<refsect1 id="esd-config-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-devel
+</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="esd-config-1-also"><title>&also-tt;</title>
+<!--Reference to another man page-->
+<!--Reference to a Help manual-->
+<!--Reference to a book.-->
+<para><citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1
+</manvolnum></citerefentry>, <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>esdctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry>
+<refentrytitle>libesd</refentrytitle><manvolnum>3</manvolnum></citerefentry></para>
+</refsect1>
+<refsect1 id="esd-config-1-note"><title>&note-tt;</title>
+<para>This man page was originally written by Chris Waters ([email protected])
+for Debian GNU/Linux. Rewritten by Brian Cameron, Sun Microsystems, using
+information from the <citerefentry><refentrytitle>orbit2-config</refentrytitle>
+<manvolnum>1</manvolnum></citerefentry>  man page, by Dick Porter ([email protected])
+and Elliot Lee ([email protected])</para>
+</refsect1>
+</refentry>
+<?Pub *0000007306>