mirrors/pulseaudio
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pulseaudio/pulseaudio.git synced 2025-10-29 05:40:23 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

update docs

Browse source 
git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@1040 fefdeb5f-60dc-0310-8127-8f9354f1896f
This commit is contained in:
Lennart Poettering 2006-06-19 23:52:16 +00:00
parent 3cf1621433
commit 6654e987c1
5 changed files with 133 additions and 127 deletions
Download patch file Download diff file Expand all files Collapse all files

110
doc/FAQ.html.in
View file

@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>pulseaudio: FAQ</title>
<title>PulseAudio: FAQ</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
@ -12,39 +12,39 @@
<h1>Frequently Asked Questions</h1>
<ol>
<li><p><b>How does Polypaudio compare with ESOUND/aRts/NAS?</b></p>
<li><p><b>How does PulseAudio compare with ESOUND/aRts/NAS?</b></p>
<p>Polypaudio is sound daemon similar to ESOUND and NAS, but much more
<p>PulseAudio is sound daemon similar to ESOUND and NAS, but much more
powerful. aRts is a realtime-synthesizer-cum-sound-server, i.e. it
does much more than Polypaudio. However, I believe that Polypaudio
does much more than PulseAudio. However, I believe that PulseAudio
does what it does much better than any other free sound server.</p>
</li>
<li><p><b>What about ESOUND compatibility?</b></p>
<p>Polypaudio is a drop in replacement for ESOUND. That means: you can
<p>PulseAudio is a drop in replacement for ESOUND. That means: you can
load a esound compatibility module which implements an ESOUND
compatible protocol which allows you to use most of the classic ESOUND
compatible programs (including the command line programs like
<tt>esdcat</tt>).</p>
</li>
<li><p><b>Is Polypaudio a GNOME program?</b></p>
<p>No, Polypaudio has no dependency on GNOME/GTK/GLIB. All it requires
<li><p><b>Is PulseAudio a GNOME program?</b></p>
<p>No, PulseAudio has no dependency on GNOME/GTK/GLIB. All it requires
is a UNIX-like operating system and very few dependency
libraries. However, the accompanying GUI tools are writen with
libraries. However, the accompanying GUI tools are written with
gtkmm, i.e. require both GLIB and GTK.</p></li>
<li><p><b>Can I integrate Polypaudio in my GLIB/GTK/GNOME application?</b></p>
<p>Yes! Polypaudio comes with a GLIB main loop adapter. You can embed
<li><p><b>Can I integrate PulseAudio in my GLIB/GTK/GNOME application?</b></p>
<p>Yes! PulseAudio comes with a GLIB main loop adapter. You can embed
both the client library and the daemon (!) into your GLIB based
application.</p></li>
<li><p><b>Can I integrate Polypaudio in my Qt/KDE application?</b></p>
<p>Yes! Polypaudio uses a main loop abstraction layer that allows you
to integrate Polypaudio in any program that supports main
<li><p><b>Can I integrate PulseAudio in my Qt/KDE application?</b></p>
<p>Yes! PulseAudio uses a main loop abstraction layer that allows you
to integrate PulseAudio in any program that supports main
loops. Unfortunately there is no adapter for Qt publicly available yet.</p></li>
<li><p><b>I want to write a new driver for Polypaudio, are there any docs?</b></p>
<li><p><b>I want to write a new driver for PulseAudio, are there any docs?</b></p>
<p>Currently, only the client API is documented with doxygen. Read
the source and base your work on a simple module like
<tt>module-pipe-sink</tt>.</p></li>
@ -54,67 +54,67 @@
<li><p><b>What about compatibility with aRts?</b></p>
<p>Is not available. Since aRts is as synthesizer application you'd have to
reimplement very much code for Polypaudio. It should be easy to
reimplement very much code for PulseAudio. It should be easy to
implement limited support for <tt>libartsc</tt> based
applications. Noone has done this yet. It is probably a better idea to
run <tt>arts</tt> on top of Polypaudio (through a pulseaudio driver
run <tt>arts</tt> on top of PulseAudio (through a PulseAudio driver
for aRts, which nobody has written yet). Another solution would be to
embed Polypaudio in the aRts process.</p></li>
embed PulseAudio in the aRts process.</p></li>
<li><p><b>I often hear noises when playing back with Polypaudio, what can I do?</b></p>
<p>There are to possible solutions: run pulseaudio with argument
<li><p><b>I often hear noises when playing back with PulseAudio, what can I do?</b></p>
<p>There are to possible solutions: run PulseAudio with argument
<tt>--high-priority=1</tt> and make yourself member of the group
<tt>realtime</tt>, or increase the fragment sizes of the audio
drivers. The former will allow Polypaudio to activate
drivers. The former will allow PulseAudio to activate
<tt>SCHED_FIFO</tt> high priority scheduling (root rights are dropped
immediately after this). Keep in mind that this is a potential security hole!</p></li>
<li><p><b>The <tt>pulseaudio</tt> executable is installed SUID root by default. Why this? Isn't this a potential security hole?</b></p>
<p>Polypaudio activates <tt>SCHED_FIFO</tt> scheduling if the user
<p>PulseAudio activates <tt>SCHED_FIFO</tt> scheduling if the user
passes <tt>--high-priority=1</tt>. This will only succeed when
executed as root, therefore the binary is marked SUID root by
default. Yes, this is a potential security hole. However, pulseaudio
default. Yes, this is a potential security hole. However, PulseAudio
tries its best to minimize the security threat: immediately after
startup pulseaudio drops all capabilities except
startup PulseAudio drops all capabilities except
<tt>CAP_SYS_NICE</tt> (At least on systems that support it, like Linux; see <tt>man 7
capabilities</tt> for more information). If the calling user is not a
member of the group <tt>realtime</tt> (which is required to have a GID
< 1000), root rights are dropped immediately. This means, you can
install pulseaudio SUID root, but only a subset of your users (the
install <tt>pulseaudio</tt> SUID root, but only a subset of your users (the
members of the group <tt>realtime</tt>) may make use of realtime
scheduling. Keep in mind that these users might load their own binary
modules into the pulseaudio daemon which may freeze the machine. The
modules into the PulseAudio daemon which may freeze the machine. The
daemon has a minimal protection against CPU hogging (the daemon is
killed after hogging more than 70% CPU for 5 seconds), but this may
be circumvented easily by evildoers.</p></li>
<li><p><b>I want to run pulseaudio only when it is needed, how do I do this?</b></p>
<li><p><b>I want to run PulseAudio only when it is needed, how do I do this?</b></p>
<p>Set <tt>autospawn = yes</tt> in <tt>client.conf</tt>. That
configuration file may be found either in <tt>/etc/pulseaudio/</tt> or
in <tt>~/.pulseaudio/</tt>.</p></li>
configuration file may be found either in <tt>/etc/pulse/</tt> or
in <tt>~/.pulse/</tt>.</p></li>
<li><p><b>How do I list all pulseaudio modules installed?</b></p>
<li><p><b>How do I list all PulseAudio modules installed?</b></p>
<p><tt>pulseaudio --dump-modules</tt></p>
<p>Add <tt>-v</tt> for terse usage instructions.</p>
<li><p><b>How do I use pulseaudio over the network?</b></p>
<li><p><b>How do I use PulseAudio over the network?</b></p>
<p>Just set <tt>$POLYP_SERVER</tt> to the host name of the pulseaudio
<p>Just set <tt>$POLYP_SERVER</tt> to the host name of the PulseAudio
server. For authentication you need the same auth cookies on all sides. For
that copy <tt>~./pulseaudio-cookie</tt> to all clients that shall
that copy <tt>~./pulse-cookie</tt> to all clients that shall
be allowed to connect.</p>
<p>Alternatively the authorization cookies can be stored in the X11 server.</p></li>
<li><p><b>Is pulseaudio capable of providing synchronized audio playback over the network for movie players like <tt>mplayer</tt>?</b></p>
<li><p><b>Is PulseAudio capable of providing synchronized audio playback over the network for movie players like <tt>mplayer</tt>?</b></p>
<p>Yes! Unless your network is congested in some way (i.e. transfer latencies vary strongly) it works perfectly. Drop me an email for experimental patches for MPlayer.</p>
<li><p><b>What environment variables does pulseaudio care about?</b></p>
<li><p><b>What environment variables does PulseAudio care about?</b></p>
<p>The client honors: <tt>POLYP_SINK</tt> (default sink to connect to), <tt>POLYP_SOURCE</tt> (default source to connect to), <tt>POLYP_SERVER</tt> (default server to connect to, like <tt>ESPEAKER</tt>), <tt>POLYP_BINARY</tt> (the binary to start when autospawning a daemon), <tt>POLYP_CLIENTCONFIG</tt> (path to the client configuration file).</p>
@ -126,36 +126,36 @@ be allowed to connect.</p>
<p>A brilliant guy named Lennart Poettering once wrote a nifty tool
for that purpose: <a
href="http://0pointer.de/lennart/projects/bidilink/">bidilink</a>. To
connect to a running pulseaudio daemon try using the following commands:</p>
connect to a running PulseAudio daemon try using the following commands:</p>
<pre>killall -USR2 pulseaudio
bidilink unix-client:/tmp/pulseaudio/cli</pre>
bidilink unix-client:/tmp/pulse-$USER/cli</pre>
<p><i>BTW: Someone should package this great tool for Debian!</i></p>
<p><b>New:</b> There's now a tool <tt>pacmd</tt> that automates sending SIGUSR2 to the daemon and running a bidilink like tool for you.</p>
</li>
<li><p><b>How do the pulseaudio libraries decide where to connect to?</b></p>
<li><p><b>How do the PulseAudio libraries decide where to connect to?</b></p>
<p>The following rule applies:</p>
<ol>
<li>If the the application using the library specifies a server to connect to it is used. If the connection fails, the library fails too.</li>
<li>If the environment variable <tt>POLYP_SERVER</tt> is defined the library connects to that server. If the connection fails, the library fails too.</li>
<li>If <tt>$DISPLAY</tt> is set, the library tries to connect to that server and looks for the root window property <tt>POYLP_SERVER</tt> for the host to connect to. If <tt>POLYP_COOKIE</tt> is set it is used as authentication cookie.</li>
<li>If the client configuration file (<tt>~/.pulseaudio/client.conf</tt> or <tt>/etc/pulseaudio/client.conf</tt>) sets the server address, the library connects to that server. If the connection fails, the library fails too.</li>
<li>The library tries to connect to the default local UNIX socket for pulseaudio servers. If the connection fails, it proceeds with the next item.</li>
<li>The library tries to connect to the default local TCP socket for pulseaudio servers. If the connection fails, it proceeds with the next item.</li>
<li>If the client configuration file (<tt>~/.pulse/client.conf</tt> or <tt>/etc/pulse/client.conf</tt>) sets the server address, the library connects to that server. If the connection fails, the library fails too.</li>
<li>The library tries to connect to the default local UNIX socket for PulseAudio servers. If the connection fails, it proceeds with the next item.</li>
<li>The library tries to connect to the default local TCP socket for PulseAudio servers. If the connection fails, it proceeds with the next item.</li>
<li>If <tt>$DISPLAY</tt> is set, the library tries to connect to the default TCP port of that host. If the connection fails, it proceeds with the next item.</li>
<li>The connection fails.</li>
</ol>
</li>
<li><p><b>Why the heck does libpulse link against libX11?</b></p>
<p>The Polypaudio client libraries look for some X11 root window
properties for the credentials of the Polypaudio server to access. You
may compile Polypaudio without X11 for disabling this feature.</p></li>
<p>The PulseAudio client libraries look for some X11 root window
properties for the credentials of the PulseAudio server to access. You
may compile PulseAudio without X11 for disabling this feature.</p></li>
<li><p><b>How can I use Polypaudio as an RTP based N:N multicast
<li><p><b>How can I use PulseAudio as an RTP based N:N multicast
conferencing solution for the LAN?</b></p> <p>After loading all the
necessary audio drivers for recording and playback, just load the RTP
reciever and sender modules with default parameters:</p>
@ -165,7 +165,7 @@ load-module module-rtp-send
load-module module-rtp-recv
</pre>
<p>As long as the Polypaudio daemon runs, the microphone data will be
<p>As long as the PulseAudio daemon runs, the microphone data will be
streamed to the network and the data from other hosts is played back
locally. Please note that this may cause quite a lot of traffic. Hence
consider passing <tt>rate=8000 format=ulaw channels=1</tt> to the
@ -182,11 +182,11 @@ announce RTP sessions that are described with SDP. (Modern SIP based VoIP phones
<p>All three protocols are defined in IETF RFCs (RFC3550, RFC3551,
RFC2327, RFC2327). They can be used in both multicast and unicast
fashions. Polypaudio exclusively uses multicast RTP/SDP/SAP containing audio data.</p>
fashions. PulseAudio exclusively uses multicast RTP/SDP/SAP containing audio data.</p>
<p>For more information about using these technologies with Polypaudio have a look on the <a href="modules.html#rtp">respective module's documentation</a>.
<p>For more information about using these technologies with PulseAudio have a look on the <a href="modules.html#rtp">respective module's documentation</a>.
<li><p><b>How can I use Polypaudio to stream music from my main PC to my LAN with multiple PCs with speakers?</b></p>
<li><p><b>How can I use PulseAudio to stream music from my main PC to my LAN with multiple PCs with speakers?</b></p>
<p>On the sender side create an RTP sink:</p>
@ -208,7 +208,7 @@ load-module module-rtp-recv
<p>BTW: You can have more than one sender machine set up like this. The audio data will be mixed on the client side.</p></li>
<li><p><b>How can I use Polypaudio to share a single LINE-IN/MIC jack on the entire LAN?</b></p>
<li><p><b>How can I use PulseAudio to share a single LINE-IN/MIC jack on the entire LAN?</b></p>
<p>On the sender side simply load the RTP sender module:</p>
@ -238,7 +238,7 @@ modules to select them. Choose your group addresses from the range
<tt>225.0.0.x</tt> to make sure the audio data never leaves the LAN.</p></li>
<li><p><b>Can I use Polypaudio to playback music on two sound cards simultaneously?</b></p>
<li><p><b>Can I use PulseAudio to playback music on two sound cards simultaneously?</b></p>
<p>Yes! Use <a href="modules.html#module-combine"><tt>module-combine</tt></a> for that.</p>
@ -251,13 +251,13 @@ set-sink-default combined
<p>This will combine the two sinks <tt>output0</tt> and
<tt>output1</tt> into a new sink <tt>combined</tt>. Every sample
written to the latter will be forwarded to the former two. Polypaudio
written to the latter will be forwarded to the former two. PulseAudio
will make sure to adjust the sample rate of the slave device in case
it deviates from the master device. You can have more than one slave
sink attached to the combined sink, and hence combine even three and
more sound cards.</p> </li>
<li><p><b>Can I use Polypaudio to combine two stereo soundcards into a virtual surround sound card?</b></p>
<li><p><b>Can I use PulseAudio to combine two stereo soundcards into a virtual surround sound card?</b></p>
<p>Yes! You can use use <a href="modules.html#module-combine"><tt>module-combine</tt></a> for that.</p>
@ -271,7 +271,7 @@ load-module module-combine sink_name=combined master=output0 slaves=output1 chan
time we manually specify the channel mappings for the sinks to make
sure everything is routed correctly.</p>
<p>Please keep in mind that Polypaudio will constantly adjust the
<p>Please keep in mind that PulseAudio will constantly adjust the
sample rate to compensate for the deviating quartzes of the sound
devices. This is not perfect, however. Deviations in a range of
1/44100s (or 1/48000s depending on the sampling frequency) can not be
@ -281,7 +281,11 @@ you hear. </p>
</li>
<li><p><b>Why did you rename Polypaudio to PulseAudio?</b></p>
<p>Please read this <a href="http://0pointer.de/blog/projects/pulse.html">blog story</a> for an explanation.</p>
</li>
</ol>

108
doc/README.html.in
View file

@ -3,12 +3,12 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>pulseaudio @PACKAGE_VERSION@</title>
<title>PulseAudio @PACKAGE_VERSION@</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
<h1><a name="top">pulseaudio @PACKAGE_VERSION@</a></h1>
<h1><a name="top">PulseAudio @PACKAGE_VERSION@</a></h1>
<p><i>Copyright 2004-2006 Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;</i> and Pierre Ossman</p>
@ -44,7 +44,7 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</p>
<h2><a name="news">News</a></h2>
<div class="news-date">Fri Jun 2 2006: </div> <p class="news-text"><a
href="@PACKAGE_URL@pulseaudio-0.9.1.tar.gz">Version 0.9.1</a>
href="@PACKAGE_URL@polypaudio-0.9.1.tar.gz">Version 0.9.1</a>
released; changes include: load modules even when libtool <tt>.la</tt>
files are missing; generate better ALSA device names from
<tt>module-detect</tt>; if an ALSA device doesn't support the
@ -53,7 +53,7 @@ suggests instead; amd64 portability; drop <tt>.sh</tt> suffix of
<tt>esdcompat.sh</tt>; build system fixes; No API or ABI changes were made</p>
<div class="news-date">Fri May 26 2006: </div> <p class="news-text"><a
href="@PACKAGE_URL@pulseaudio-0.9.0.tar.gz">Version 0.9.0</a>
href="@PACKAGE_URL@polypaudio-0.9.0.tar.gz">Version 0.9.0</a>
released; changes include: new module <tt>module-volume-restore</tt>;
new OSS API emulation tool <tt>padsp</tt>; require valid UTF8 strings
everywhere; properly support ALSA channel maps for surround sound;
@ -62,7 +62,7 @@ main loop API for synchronous programs; introduce real shared object
versioning; a few API additions; many, many bugfixes</p>
<div class="news-date">Fri Apr 28 2006: </div> <p class="news-text"><a
href="@PACKAGE_URL@pulseaudio-0.8.1.tar.gz">Version 0.8.1</a>
href="@PACKAGE_URL@polypaudio-0.8.1.tar.gz">Version 0.8.1</a>
released; changes include: support for specifying the channel map on
the command lines of <tt>paplay</tt> and <tt>pacat</tt> and as
arguments to the driver modules; ALSA hardware mixer compatibility;
@ -70,16 +70,16 @@ fix linking; properly remove <tt>PF_UNIX</tt> sockets when unloading
protocol modules; fix sample cache; many other fixes</p>
<div class="news-date">Thu Apr 13 2006: </div> <p class="news-text"><a
href="@PACKAGE_URL@pulseaudio-0.8.tar.gz">Version 0.8</a> released;
changes include: too many to count - consider reading <a href="http://0pointer.de/blog/projects/pulseaudio-0.8.html">this blog entry</a> for more information; many, many minor fixes.</p>
href="@PACKAGE_URL@polypaudio-0.8.tar.gz">Version 0.8</a> released;
changes include: too many to count - consider reading <a href="http://0pointer.de/blog/projects/polypaudio-0.8.html">this blog entry</a> for more information; many, many minor fixes.</p>
<div class="news-date">Sun Nov 21 2004: </div> <p class="news-text"><a
href="@PACKAGE_URL@pulseaudio-0.7.tar.gz">Version 0.7</a> released;
href="@PACKAGE_URL@polypaudio-0.7.tar.gz">Version 0.7</a> released;
changes include: IPv6 support; PID file support; publish credentials
in X11 root window (<tt>module-x11-publish</tt>; new tool <tt>pacmd</tt>; ESOUND backend; new command <tt>load-sample-dir-lazy</tt>; many, many minor fixes.</p>
<div class="news-date">Thu Oct 28 2004: </div> <p class="news-text"><a
href="@PACKAGE_URL@pulseaudio-0.6.tar.gz">Version 0.6</a> released;
href="@PACKAGE_URL@polypaudio-0.6.tar.gz">Version 0.6</a> released;
changes include: TCP wrappers support; don't load the complete sound
file into memory when playing back using <tt>pa_play_file()</tt>;
autoload API change; don't load all sound files as FLOAT32; shorten
@ -91,14 +91,14 @@ generation; correctly lock daemon autospawning; print daemon layout to
STDERR on SIGHUP; new options for <tt>pacat</tt>: allow sample type specification.</p>
<div class="news-date">Mon Sep 24 2004: </div> <p class="news-text"><a
href="@PACKAGE_URL@pulseaudio-0.5.1.tar.gz">Version 0.5.1</a> released;
href="@PACKAGE_URL@polypaudio-0.5.1.tar.gz">Version 0.5.1</a> released;
changes include: improve esound protocol compatibility; fix
autospawning via <tt>libesd</tt>; make use of POSIX capabilities;
allow <tt>SCHED_FIFO</tt> scheduling only for users in group
<tt>realtime</tt>; minor build system fix.</p>
<div class="news-date">Mon Sep 20 2004: </div> <p class="news-text"><a
href="@PACKAGE_URL@pulseaudio-0.5.tar.gz">Version 0.5</a> released;
href="@PACKAGE_URL@polypaudio-0.5.tar.gz">Version 0.5</a> released;
changes include: extensive API improvements, new module
<tt>module-combine</tt> for combining multiple sound cards into one,
gcc 2.95 compatibility, configuration files, add "lazy" samples,
@ -106,29 +106,29 @@ support for source and network latency measurements, add
<tt>module-pipe-source</tt>, many other fixes and improvements.</p>
<div class="news-date">Wed Sep 8 2004: </div> <p class="news-text"><a
href="@PACKAGE_URL@pulseaudio-0.4.tar.gz">Version 0.4</a> released;
href="@PACKAGE_URL@polypaudio-0.4.tar.gz">Version 0.4</a> released;
changes include: daemon auto spawning, support for <tt>SCHED_FIFO</tt> scheduling, three new modules, proper logging, CPU load watchdog, many fixes.</p>
<div class="news-date">Fri Aug 27 2004: </div> <p class="news-text"><a
href="@PACKAGE_URL@pulseaudio-0.3.tar.gz">Version 0.3</a> released;
href="@PACKAGE_URL@polypaudio-0.3.tar.gz">Version 0.3</a> released;
changes include: support for both glib 2.0 and glib 1.2, future cancellation, API updates, many fixes, relicense client library to LGPL.</p>
<div class="news-date">Fri Aug 20 2004: </div> <p class="news-text"><a
href="@PACKAGE_URL@pulseaudio-0.2.tar.gz">Version 0.2</a> released;
href="@PACKAGE_URL@polypaudio-0.2.tar.gz">Version 0.2</a> released;
changes include: added sample cache, introspection API, client API
documentation, module autoloading, glib support, a module for intercepting X11 bell events, and much more.</p>
<div class="news-date">Sat Jul 17 2004: </div> <p class="news-text"><a
href="@PACKAGE_URL@pulseaudio-0.1.tar.gz">Version 0.1</a> released</p>
href="@PACKAGE_URL@polypaudio-0.1.tar.gz">Version 0.1</a> released</p>
<h2><a name="overview">Overview</a></h2>
<p><tt>pulseaudio</tt> is a networked sound server for Linux and other
<p>PulseAudio is a networked sound server for Linux and other
Unix like operating systems and Microsoft Windows. It is intended to be an improved drop-in
replacement for the <a
href="http://www.tux.org/~ricdude/apps.html">Enlightened Sound
Daemon</a> (ESOUND). In addition to the features ESOUND provides
<tt>pulseaudio</tt> has:</p>
PulseAudio has:</p>
<ul>
<li>Extensible plugin architecture (by loading dynamic loadable modules with <tt>dlopen()</tt>)</li>
@ -150,8 +150,8 @@ Daemon</a> (ESOUND). In addition to the features ESOUND provides
use of a simple main loop abstraction layer. This allows easy
integration with asynchronous applications using the
<tt>glib</tt>/<tt>gtk</tt> mainloop. Since the asynchronous API
available through <tt>pulselib</tt> is quite difficult to use there is
a simplified synchronous API wrapper <tt>pulselib-simple</tt>
available through <tt>libpulse</tt> is quite difficult to use there is
a simplified synchronous API wrapper <tt>libpulse-simple</tt>
available. A simple main loop implementation is available as well.</p>
<p>The following modules are currently available:</p>
@ -167,12 +167,12 @@ Sound Architecture</a> (ALSA) sinks and sources</li>
<li><tt>module-combine</tt>: combine multiple sinks into one, adjusting the sample rate if the their clocks deviate.</li>
<li><tt>module-sine</tt>: a sine generate sink input.</li>
<li><tt>module-x11-bell</tt>: play a sample from the sample cache on every X11 bell event.</li>
<li><tt>module-x11-publish</tt>: store Polypaudio credentials in the X11 root window.</li>
<li><tt>module-x11-publish</tt>: store PulseAudio credentials in the X11 root window.</li>
<li><tt>module-esound-protocol-tcp</tt>, <tt>module-esound-protocol-unix</tt>: <a href="http://www.tux.org/~ricdude/apps.html">ESOUND</a> compatibility modules (for TCP/IP resp. UNIX domain sockets)</li>
<li><tt>module-native-protocol-tcp</tt>, <tt>module-native-protocol-unix</tt>: Native pulseaudio protocol (for TCP/IP resp. UNIX domain sockets)</li>
<li><tt>module-native-protocol-tcp</tt>, <tt>module-native-protocol-unix</tt>: Native PulseAudio protocol (for TCP/IP resp. UNIX domain sockets)</li>
<li><tt>module-simple-protocol-tcp</tt>, <tt>module-simple-protocol-unix</tt>: Simplistic protocol for playback/capture for usage with tools like <tt>netcat</tt> (for TCP/IP resp. UNIX domain sockets)</li>
<li><tt>module-cli-protocol-tcp</tt>, <tt>module-cli-protocol-unix</tt>, <tt>module-cli</tt>: Expose pulseaudio's internals whith a simple command line interface. (for TCP/IP resp. UNIX domain sockets resp. STDIN/STDOUT)</li>
<li><tt>module-http-protocol-tcp</tt>: Spawns a small HTTP server which can be used to introspect the Polypaudio server with a web browser.</li>
<li><tt>module-cli-protocol-tcp</tt>, <tt>module-cli-protocol-unix</tt>, <tt>module-cli</tt>: Expose PulseAudio's internals whith a simple command line interface. (for TCP/IP resp. UNIX domain sockets resp. STDIN/STDOUT)</li>
<li><tt>module-http-protocol-tcp</tt>: Spawns a small HTTP server which can be used to introspect the PulseAudio server with a web browser.</li>
<li><tt>module-tunnel-sink</tt>, <tt>module-tunnel-source</tt>: make sinks/sources from other hosts available locally.</li>
<li><tt>module-match</tt>: adjust volume automatically for newly created playback streams based on a regular expression matching table.</li>
<li><tt>module-volume-restore</tt>: much like <tt>module-match</tt>, but create rules fully automatically based on the client name.</li>
@ -186,12 +186,12 @@ Sound Architecture</a> (ALSA) sinks and sources</li>
<li><tt>module-jack-sink</tt>, <tt>module-jack-source</tt>: connect to a <a href="http://jackit.sourceforge.net/">JACK Audio Connection Kit</a> server. (A sound server for professional audio production)</li>
</ul>
<p>A GTK GUI manager application for pulseaudio is the <a
href="http://0pointer.de/lennart/projects/paman/">Polypaudio
Manager</a>. Other GTK GUI tool for Polypaudio are the <a
href="http://0pointer.de/lennart/projects/pavumeter">Polypaudio Volume
<p>A GTK GUI manager application for PulseAudio is the <a
href="http://0pointer.de/lennart/projects/paman/">PulseAudio
Manager</a>. Other GTK GUI tool for PulseAudio are the <a
href="http://0pointer.de/lennart/projects/pavumeter">PulseAudio Volume
Meter</a> and the <a
href="http://0pointer.de/lennart/projects/pavucontrol">Polypaudio Volume
href="http://0pointer.de/lennart/projects/pavucontrol">PulseAudio Volume
Control</a> .</p>
<p>There are output plugins for <a
@ -205,6 +205,8 @@ href="http://xine.sf.net/">Xine</a> (merged in Xine CVS). Drivers for
<a href="http://www.portaudio.com/">PortAudio</a> will be released
shortly.</p>
<p>PulseAudio was formerly known as Polypaudio.</p>
<h2><a name="status">Current Status</a></h2>
<p>Version @PACKAGE_VERSION@ is quite usable. It matches and supersedes ESOUND's feature set in nearly all areas.</p>
@ -216,68 +218,68 @@ href="modules.html"><tt>modules.html</tt></a>, <a
href="cli.html"><tt>cli.html</tt></a>, <a
href="daemon.html"><tt>daemon.html</tt></a> and <a href="FAQ.html"><tt>FAQ.html</tt></a>.</p>
<p>There is a <a href="http://www.edgewall.com/products/trac/">Trac</a> based <a href="http://0pointer.de/trac/pulseaudio/">Wiki for Polypaudio</a> available.</p>
<p>There is a <a href="http://www.edgewall.com/products/trac/">Trac</a> based <a href="http://0pointer.de/trac/pulseaudio/">Wiki for PulseAudio</a> available.</p>
<h3>First Steps</h3>
<p>Simply start the pulseaudio daemon with the argument <tt>-nC</tt></p>
<p>Simply start the PulseAudio daemon with the argument <tt>-nC</tt></p>
<pre>pulseaudio -nC</pre>
<p>This will present you a screen like this:</p>
<pre>Welcome to pulseaudio! Use "help" for usage information.
<pre>Welcome to PulseAudio! Use "help" for usage information.
&gt;&gt;&gt; </pre>
<p>Now you can issue CLI commands as described in <a
href="cli.html"><tt>cli.html</tt></a>. Another way to start
<tt>pulseaudio</tt> is by specifying a configuration script like that one included in the distribution on the
PulseAudio is by specifying a configuration script like that one included in the distribution on the
command line :</p>
<pre>pulseaudio -nF pulseaudio.pa</pre>
<p>This will load some drivers and protocols automatically.</p>
<p>The best idea is to configure your daemon in <tt>/etc/pulseaudio/daemon.conf</tt> and <tt>/etc/pulseaudio/default.pa</tt> and to run pulseaudio without any arguments.</p>
<p>The best idea is to configure your daemon in <tt>/etc/pulse/daemon.conf</tt> and <tt>/etc/pulse/default.pa</tt> and to run PulseAudio without any arguments.</p>
<p><b>Beware!</b> Unless you pass the option <tt>--sysconfdir=/etc</tt> to
<tt>configure</tt>, the directory <tt>/etc/pulseaudio/</tt> is really
<tt>/usr/local/etc/pulseaudio/</tt>.</p>
<tt>configure</tt>, the directory <tt>/etc/pulse/</tt> is really
<tt>/usr/local/etc/pulse/</tt>.</p>
<h3>Developing pulseaudio Clients</h3>
<h3>Developing PulseAudio Clients</h3>
<p>You may browse the <a href="http://www.doxygen.org/">Doxygen</a> generated <a
href="http://0pointer.de/lennart/projects/pulseaudio/doxygen/">programing
documentation</a> for the client API. (Run <tt>make doxygen</tt> to generate this documentation from the source tree)</p>
<h3>Developing pulseaudio Modules</h3>
<h3>Developing PulseAudio Modules</h3>
<p>There are several reasons for writing loadable modules for pulseaudio:</p>
<p>There are several reasons for writing loadable modules for PulseAudio:</p>
<ul>
<li>Extended device driver support</li>
<li>Protocol support beyond ESOUND's protocol and the native protocol. (such as NAS or a subset of aRts)</li>
<li>New programming interfaces such as XMLRPC or DBUS for controlling the daemon.</li>
<li>Hooking audio event sources directly into pulseaudio (similar to <tt>module-x11-bell</tt>)</li>
<li>For low latency applications such as VOIP: load the VOIP core directly into pulseaudio and have a slim GUI frontend to control it.</li>
<li>Hooking audio event sources directly into PulseAudio (similar to <tt>module-x11-bell</tt>)</li>
<li>For low latency applications such as VOIP: load the VOIP core directly into PulseAudio and have a slim GUI frontend to control it.</li>
</ul>
<p>There is currently no documentation how to write loadable modules
for pulseaudio. <i>Read the source, Luke!</i> If you are interested in
for PulseAudio. <i>Read the source, Luke!</i> If you are interested in
writing new modules feel free to contact the author in case you have any
questions.</p>
<h2><a name="requirements">Requirements</a></h2>
<p>Currently, <tt>pulseaudio</tt> is tested on Linux, FreeBSD, Solaris and Microsoft Windows. It requires an OSS, ALSA, Win32 or Solaris compatible soundcard.</p>
<p>Currently, PulseAudio> is tested on Linux, FreeBSD, Solaris and Microsoft Windows. It requires an OSS, ALSA, Win32 or Solaris compatible soundcard.</p>
<p><tt>pulseaudio</tt> was developed and tested on Debian GNU/Linux
<p>PulseAudio was developed and tested on Debian GNU/Linux
"testing" from November 2004, it should work on most other Linux
distributions (and maybe Unix versions) since it uses GNU autoconf and
GNU libtool for source code configuration and shared library
management.</p>
<p><tt>pulseaudio</tt> needs <a
<p>Pulseaudio needs <a
href="http://www.mega-nerd.com/SRC/">Secret Rabbit Code (aka
<tt>libsamplerate</tt>)</a>, <a
href="http://www.mega-nerd.com/libsndfile"><tt>libsndfile</tt></a>, <a
@ -296,7 +298,7 @@ building the GLIB main loop integration module only.)</p>
<tt>./configure</tt> inside the distribution directory for configuring
the source tree. After that you should run <tt>make</tt> for
compilation and <tt>make install</tt> (as root) for installation of
<tt>pulseaudio</tt>.</p>
PulseAudio.</p>
<h2><a name="acks">Acknowledgements</a></h2>
@ -304,11 +306,11 @@ compilation and <tt>make install</tt> (as root) for installation of
<p>Jeff Waugh for creating Ubuntu packages (and hopefully soon Debian)</p>
<p>Miguel Freitas for writing a Polypaudio driver for Xine</p>
<p>Miguel Freitas for writing a PulseAudio driver for Xine</p>
<p>Joe Marcus Clarke for porting Polypaudio to FreeBSD</p>
<p>Joe Marcus Clarke for porting PulseAudio to FreeBSD</p>
<p><a href="http://www.cendio.com">Cendio AB</a> for paying for Pierre's work on Polypaudio</p>
<p><a href="http://www.cendio.com">Cendio AB</a> for paying for Pierre's work on PulseAudio</p>
<p>Sebastien ESTIENNE for testing</p>
@ -320,7 +322,7 @@ compilation and <tt>make install</tt> (as root) for installation of
<p>The current release is <a href="@PACKAGE_URL@pulseaudio-@PACKAGE_VERSION@.tar.gz">@PACKAGE_VERSION@</a></p>
<p>Get <tt>pulseaudio</tt>'s development sources from the <a href="http://subversion.tigris.org/">Subversion</a> <a href="svn://0pointer.de/pulseaudio">repository</a> (<a href="http://0pointer.de/cgi-bin/viewcvs.cgi/?root=pulseaudio">viewcvs</a>): </p>
<p>Get PulseAudio's development sources from the <a href="http://subversion.tigris.org/">Subversion</a> <a href="svn://0pointer.de/pulseaudio">repository</a> (<a href="http://0pointer.de/cgi-bin/viewcvs.cgi/?root=pulseaudio">viewcvs</a>): </p>
<pre>svn checkout svn://0pointer.de/pulseaudio/trunk pulseaudio</pre>
@ -328,13 +330,13 @@ compilation and <tt>make install</tt> (as root) for installation of
<p>If you want to be notified whenever I release a new version of this software use the subscription feature of <a href="http://freshmeat.net/projects/pulseaudio/">Freshmeat</a>.</p>
<p>There is a general discussion <a href="https://tango.0pointer.de/mailman/listinfo/pulseaudio-discuss">mailing list for pulseaudio</a> available. In addition, you can subscribe to <a href="https://tango.0pointer.de/mailman/listinfo/pulseaudio-commits">SVN changes</a> and <a href="https://tango.0pointer.de/mailman/listinfo/pulseaudio-tickets">Trac Tickets</a>.</p>
<p>There is a general discussion <a href="https://tango.0pointer.de/mailman/listinfo/polypaudio-discuss">mailing list for PulseAudio</a> available. In addition, you can subscribe to <a href="https://tango.0pointer.de/mailman/listinfo/polypaudio-commits">SVN changes</a> and <a href="https://tango.0pointer.de/mailman/listinfo/polypaudio-tickets">Trac Tickets</a>.</p>
<p>Polypaudio is being tracked at <a href="http://cia.navi.cx/stats/project/pulseaudio">CIA</a>.</p>
<p>PulseAudio is being tracked at <a href="http://cia.navi.cx/stats/project/polypaudio">CIA</a>.</p>
<p>There's a chance to meet the Polypaudio developers on our <a href="irc://irc.freenode.org/pulseaudio">IRC channel #pulseaudio on irc.freenode.org</a>.</p>
<p>There's a chance to meet the PulseAudio developers on our <a href="irc://irc.freenode.org/pulseaudio">IRC channel #pulseaudio on irc.freenode.org</a>.</p>
<p>There is a <a href="http://www.edgewall.com/products/trac/">Trac</a> based <a href="http://0pointer.de/trac/pulseaudio/">Wiki for Polypaudio</a> available.</p>
<p>There is a <a href="http://www.edgewall.com/products/trac/">Trac</a> based <a href="http://0pointer.de/trac/pulseaudio/">Wiki for PulseAudio</a> available.</p>
<p><b>Please report bugs to <a href="http://0pointer.de/trac/pulseaudio/newticket">our Trac ticket system</a>.</b></p>

8
doc/cli.html.in
View file

@ -2,14 +2,14 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>pulseaudio: Simple Command Line Language</title>
<title>PulseAudio: Simple Command Line Language</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
<body>
<h1>Simple Command Line Language</h1>
<p><tt>pulseaudio</tt> provides a simple command line language used by
<p>PulseAudio provides a simple command line language used by
configuration scripts as well as the modules <tt>module-cli</tt>
and <tt>module-cli-protocol-{unix,tcp}</tt>. Empty lines and lines
beginning with a hashmark (<tt>#</tt>) are silently ignored. Several
@ -181,7 +181,7 @@ on the interactive command line.</p>
<h2>Example Configuration Script</h2>
<p>Mark the following script as executable (<tt>chmod +x</tt>) and run it for a sensible pulseaudio configuration.</p>
<p>Mark the following script as executable (<tt>chmod +x</tt>) and run it for a sensible PulseAudio configuration.</p>
<pre>
#!/usr/bin/polaudio -nF
@ -215,6 +215,6 @@ play-file /usr/share/sounds/startup3.wav combined
</pre>
<hr/>
<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, April 2006</address>
<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, June 2006</address>
<div class="grey"><i>$Id$</i></div>
</body> </html>

8
doc/daemon.html.in
View file

@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>pulseaudio: Daemon</title>
<title>PulseAudio: Daemon</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
@ -11,7 +11,7 @@
<h2>Command Line Arguments</h2>
The <tt>pulseaudio</tt> daemon accepts several command line arguments:
The PulseAudio daemon accepts several command line arguments:
<pre>
COMMANDS:
@ -60,7 +60,7 @@ STARTUP SCRIPT:
<pre>pulseaudio -D</pre>
<p>This will run <tt>/etc/pulseaudio/default.pa</tt> after startup. This should be a script written in the CLI language described in <a href="cli.html">cli.html</a>. </p>
<p>This will run <tt>/etc/pulse/default.pa</tt> after startup. This should be a script written in the CLI language described in <a href="cli.html">cli.html</a>. </p>
<h2>Signals</h2>
@ -83,6 +83,6 @@ STARTUP SCRIPT:
<p>The daemon logs the current server layout.</p>
<hr/>
<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, November 2004</address>
<address class="grey">Lennart Poettering &lt;@PACKAGE_BUGREPORT@&gt;, June 2006</address>
<div class="grey"><i>$Id$</i></div>
</body> </html>

26
doc/modules.html.in
View file

@ -2,7 +2,7 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>pulseaudio: Loadable Modules</title>
<title>PulseAudio: Loadable Modules</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>
@ -10,7 +10,7 @@
<h1>Loadable Modules</h1>
<p>The following loadable modules are provided with the <tt>pulseaudio</tt> distribution:</p>
<p>The following loadable modules are provided with the PulseAudio distribution:</p>
<h2>Device Drivers</h2>
@ -157,7 +157,7 @@ will decrease output quality however. (defaults to
<h3>module-tunnel-{sink,source}</h3>
<p>Tunnel a remote sink/source to a local "ghost"
sink/source. Requires a running pulseaudio daemon on the remote server
sink/source. Requires a running PulseAudio daemon on the remote server
with <tt>module-native-protocol-tcp</tt> loaded. It's probably a
better idea to connect to the remote sink/source directly since some
buffer control is lost through this tunneling.</p>
@ -204,7 +204,7 @@ module see <a href="cli.html"><tt>cli.html</tt></a>.
<h3>module-cli-protocol-{unix,tcp}</h3>
<p>An implemenation of a simple command line based protocol for
controlling the <tt>pulseaudio</tt> daemon. If loaded, the user may
controlling the PulseAudio daemon. If loaded, the user may
connect with tools like <tt>netcat</tt>, <tt>telnet</tt> or
<a href="http://0pointer.de/lennart/projects/bidilink/"><tt>bidilink</tt></a> to the listening sockets and execute commands the
same way as with <tt>module-cli</tt>.</p>
@ -225,7 +225,7 @@ transparent TCP/IP socket. (Both IPv6 and IPv4 - if available)</p>
a numerical binary value. If 1 the socket is bound to the loopback
device, i.e. not publicly accessible. (defaults to 1)</td></tr>
<tr><td><tt>listen=</tt></td><td>(only for <tt>-tcp</tt>) The IP address to listen on. If specified, supersedes the value specified in <tt>loopback=</tt></td></tr>
<tr><td><tt>socket=</tt></td><td>(only for <tt>-unix</tt>) The UNIX socket name (defaults to <tt>/tmp/pulseaudio/cli</tt>)</td></tr>
<tr><td><tt>socket=</tt></td><td>(only for <tt>-unix</tt>) The UNIX socket name (defaults to <tt>/tmp/pulse/cli</tt>)</td></tr>
</table>
<h3>module-simple-protocol-{unix,tcp}</h3>
@ -254,7 +254,7 @@ about the two possible suffixes of this module.</p>
<p>An implemenation of a protocol compatible with the <a
href="http://www.tux.org/~ricdude/EsounD.html">Enlightened Sound
Daemon</a> (ESOUND, <tt>esd</tt>). When you load this module you may
access the <tt>pulseaudio</tt> daemon with tools like <tt>esdcat</tt>,
access the PulseAudio daemon with tools like <tt>esdcat</tt>,
<tt>esdrec</tt> or even <tt>esdctl</tt>. Many applications, such as
XMMS, include support for this protocol.</p>
@ -273,7 +273,7 @@ about the two possible suffixes of this module.</p>
<h3>module-native-protocol-{unix,tcp}</h3>
<p>The native protocol of <tt>pulseaudio</tt>.</p>
<p>The native protocol of PulseAudio.</p>
<p>See <tt>module-cli-protocol-{unix,tcp}</tt> for more information
about the two possible suffixes of this module.</p>
@ -293,7 +293,7 @@ about the two possible suffixes of this module.</p>
<h3>module-http-protocol-tcp</h3>
<p>A proof-of-concept HTTP module, which can be used to introspect
the current status of the pulseaudio daemon using HTTP. Just load this
the current status of the PulseAudio daemon using HTTP. Just load this
module and point your browser to <a
href="http://localhost:4714/">http://localhost:4714/</a>. This module takes the same arguments
as <tt>module-cli-protocol-tcp</tt>.</p>
@ -430,7 +430,7 @@ created in the JACK server.</p>
<table>
<tr><td><tt>sink_name=</tt></td><td>The name for the Polypaudio sink. If ommited defaults to <tt>jack_out</tt>.</td></tr>
<tr><td><tt>server_name=</tt></td><td>The JACK server to connect to. If ommited defaults to the default server.</td></tr>
<tr><td><tt>client_name=</tt></td><td>The client name to tell the JACK server. If ommited defaults to <tt>pulseaudio</tt>.</td></tr>
<tr><td><tt>client_name=</tt></td><td>The client name to tell the JACK server. If ommited defaults to <tt>PulseAudio</tt>.</td></tr>
<tr><td><tt>channels=</tt></td><td>Number of channels to register. If ommited defaults to the number of physical playback ports of the JACK server.</td></tr>
<tr><td><tt>connect=</tt></td><td>Takes a boolean value. If enabled (the default) Polypaudio will try to connect its ports to the physicial playback ports of the JACK server</td></tr>
</table>
@ -455,18 +455,18 @@ which is replaced by <tt>source_name</tt> (with a default of <tt>jack_in</tt>) f
<h3>module-esound-compat-spawnfd</h3>
<p>This is a compatibility module for <tt>libesd</tt> based autospawning of pulseaudio. Don't use it directly.</p>
<p>This is a compatibility module for <tt>libesd</tt> based autospawning of PulseAudio. Don't use it directly.</p>
<h3>module-esound-compat-spawnpid</h3>
<p>This is a compatibility module for <tt>libesd</tt> based autospawning of pulseaudio. Don't use it directly.</p>
<p>This is a compatibility module for <tt>libesd</tt> based autospawning of PulseAudio. Don't use it directly.</p>
<h3>module-match</h3>
<p>Adjust the volume of a playback stream automatically based on its name.</p>
<table>
<tr><td><tt>table=</tt></td><td>The regular expression matching table file to use (defaults to <tt>~/.pulseaudio/match.table</tt>)</td></tr>
<tr><td><tt>table=</tt></td><td>The regular expression matching table file to use (defaults to <tt>~/.pulse/match.table</tt>)</td></tr>
</table>
<p>The table file should contain a regexp and volume on each line, seperated by spaces. An example:</p>
@ -482,7 +482,7 @@ which is replaced by <tt>source_name</tt> (with a default of <tt>jack_in</tt>) f
<p>Adjust the volume of a playback stream automatically based on its name.</p>
<table>
<tr><td><tt>table=</tt></td><td>The table file to use (defaults to <tt>~/.pulseaudio/volume.table</tt>)</td></tr>
<tr><td><tt>table=</tt></td><td>The table file to use (defaults to <tt>~/.pulse/volume.table</tt>)</td></tr>
</table>
<p>In contrast to <tt>module-match</tt> this module needs no explicit