Frequently Asked Questions

Lennart Poettering <@PACKAGE_BUGREPORT@>, April 2006 · BTW: Someone should package this great tool for Debian!

esdcat
module-pipe-sink
libartsc
arts
arts
--high-priority=1
realtime
SCHED_FIFO
pulseaudio
SCHED_FIFO
SCHED_FIFO
--high-priority=1
CAP_SYS_NICE
man 7
 capabilities
realtime
pulseaudio
realtime
autospawn = yes
client.conf
/etc/pulseaudio/
~/.pulseaudio/
/etc/pulse/
~/.pulse/
pulseaudio --dump-modules
-v
$POLYP_SERVER
$POLYP_SERVER
~./pulseaudio-cookie
~./pulse-cookie
mplayer
mplayer
POLYP_SINK
POLYP_SOURCE
POLYP_SERVER
ESPEAKER
POLYP_BINARY
POLYP_CLIENTCONFIG
killall -USR2 pulseaudio
-bidilink unix-client:/tmp/pulseaudio/cli
pacmd
POLYP_SERVER
$DISPLAY
POYLP_SERVER
POLYP_COOKIE
~/.pulseaudio/client.conf
/etc/pulseaudio/client.conf
~/.pulse/client.conf
/etc/pulse/client.conf
$DISPLAY
rate=8000 format=ulaw channels=1
225.0.0.x
module-combine
output0
output1
combined
module-combine
.la
module-detect
.sh
esdcompat.sh
module-volume-restore
padsp
paplay
pacat
PF_UNIX
module-x11-publish
pacmd
load-sample-dir-lazy
pa_play_file()
pacat
libesd
SCHED_FIFO
realtime
module-combine
module-pipe-source
SCHED_FIFO
pulseaudio
pulseaudio
dlopen()
glib
gtk
pulselib
pulselib-simple
libpulse
libpulse-simple
module-combine
module-sine
module-x11-bell
module-x11-publish
module-x11-publish
module-esound-protocol-tcp
module-esound-protocol-unix
module-native-protocol-tcp
module-native-protocol-unix
module-native-protocol-tcp
module-native-protocol-unix
module-simple-protocol-tcp
module-simple-protocol-unix
netcat
module-cli-protocol-tcp
module-cli-protocol-unix
module-cli
module-http-protocol-tcp
module-cli-protocol-tcp
module-cli-protocol-unix
module-cli
module-http-protocol-tcp
module-tunnel-sink
module-tunnel-source
module-match
module-volume-restore
module-match
module-jack-sink
module-jack-source
modules.html
cli.html
daemon.html
FAQ.html
-nC
-nC
pulseaudio -nC
Welcome to pulseaudio! Use "help" for usage information.
+Welcome to PulseAudio! Use "help" for usage information.
 >>> 
 
 Now you can issue CLI commands as described in cli.html. Another way to start
-pulseaudio 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 :
 
 pulseaudio -nF pulseaudio.pa
 
 This will load some drivers and protocols automatically.
 
-The best idea is to configure your daemon in /etc/pulseaudio/daemon.conf and /etc/pulseaudio/default.pa and to run pulseaudio without any arguments.
+The best idea is to configure your daemon in /etc/pulse/daemon.conf and /etc/pulse/default.pa and to run PulseAudio without any arguments.
 
 Beware! Unless you pass the option --sysconfdir=/etc to
-configure, the directory /etc/pulseaudio/ is really
-/usr/local/etc/pulseaudio/.
+configure, the directory /etc/pulse/ is really
+/usr/local/etc/pulse/.
 
-Developing pulseaudio Clients
+Developing PulseAudio Clients
 
 You may browse the Doxygen generated programing
 documentation for the client API. (Run make doxygen to generate this documentation from the source tree)
 
-Developing pulseaudio Modules
+Developing PulseAudio Modules
 
-There are several reasons for writing loadable modules for pulseaudio:
+There are several reasons for writing loadable modules for PulseAudio:
 
 
   Extended device driver support
   Protocol support beyond ESOUND's protocol and the native protocol. (such as NAS or a subset of aRts)
   New programming interfaces such as XMLRPC or DBUS for controlling the daemon.
-  Hooking audio event sources directly into pulseaudio (similar to module-x11-bell)
-  For low latency applications such as VOIP: load the VOIP core directly into pulseaudio and have a slim GUI frontend to control it.
+  Hooking audio event sources directly into PulseAudio (similar to module-x11-bell)
+  For low latency applications such as VOIP: load the VOIP core directly into PulseAudio and have a slim GUI frontend to control it.
 
 
 There is currently no documentation how to write loadable modules
-for pulseaudio. Read the source, Luke! If you are interested in
+for PulseAudio. Read the source, Luke! If you are interested in
 writing new modules feel free to contact the author in case you have any
 questions.
 
 Requirements
 
-Currently, pulseaudio is tested on Linux, FreeBSD, Solaris and Microsoft Windows. It requires an OSS, ALSA, Win32 or Solaris compatible soundcard.
+Currently, PulseAudio> is tested on Linux, FreeBSD, Solaris and Microsoft Windows. It requires an OSS, ALSA, Win32 or Solaris compatible soundcard.
 
-pulseaudio was developed and tested on Debian GNU/Linux
+
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.
 
-pulseaudio needs Pulseaudio needs Secret Rabbit Code (aka
 libsamplerate), libsndfile, 
 ./configure inside the distribution directory for configuring
 the source tree. After that you should run make for
 compilation and make install (as root) for installation of
-pulseaudio.

+PulseAudio.
 
 Acknowledgements
 
@@ -304,11 +306,11 @@ compilation and make install (as root) for installation of
 
 Jeff Waugh for creating Ubuntu packages (and hopefully soon Debian)
 
-Miguel Freitas for writing a Polypaudio driver for Xine
+Miguel Freitas for writing a PulseAudio driver for Xine
 
-Joe Marcus Clarke for porting Polypaudio to FreeBSD
+Joe Marcus Clarke for porting PulseAudio to FreeBSD
 
-Cendio AB for paying for Pierre's work on Polypaudio
+Cendio AB for paying for Pierre's work on PulseAudio
 
 Sebastien ESTIENNE for testing
 
@@ -320,7 +322,7 @@ compilation and make install (as root) for installation of
 
 The current release is @PACKAGE_VERSION@
 
-Get pulseaudio's development sources from the Subversion repository (viewcvs): 
+Get PulseAudio's development sources from the Subversion repository (viewcvs): 
 
 svn checkout svn://0pointer.de/pulseaudio/trunk pulseaudio
 
@@ -328,13 +330,13 @@ compilation and make install (as root) for installation of
 
 If you want to be notified whenever I release a new version of this software use the subscription feature of Freshmeat.
 
-There is a general discussion mailing list for pulseaudio available. In addition, you can subscribe to SVN changes and Trac Tickets.
+There is a general discussion mailing list for PulseAudio available. In addition, you can subscribe to SVN changes and Trac Tickets.
 
-Polypaudio is being tracked at CIA.
+PulseAudio is being tracked at CIA.
 
-There's a chance to meet the Polypaudio developers on our IRC channel #pulseaudio on irc.freenode.org.
+There's a chance to meet the PulseAudio developers on our IRC channel #pulseaudio on irc.freenode.org.
 
-There is a Trac based Wiki for Polypaudio available.
+There is a Trac based Wiki for PulseAudio available.
 
 Please report bugs to our Trac ticket system.

diff --git a/doc/cli.html.in b/doc/cli.html.in
index 511f5964..3a256732 100644
--- a/doc/cli.html.in
+++ b/doc/cli.html.in
@@ -2,14 +2,14 @@
 
 
 
-pulseaudio: Simple Command Line Language
+PulseAudio: Simple Command Line Language
 
 
 
 
 Simple Command Line Language
 
-pulseaudio provides a simple command line language used by
+
PulseAudio provides a simple command line language used by
 configuration scripts as well as the modules module-cli
 and module-cli-protocol-{unix,tcp}. Empty lines and lines
 beginning with a hashmark (#) are silently ignored. Several
@@ -181,7 +181,7 @@ on the interactive command line.
 
 Example Configuration Script
 
-Mark the following script as executable (chmod +x) and run it for a sensible pulseaudio configuration.
+Mark the following script as executable (chmod +x) and run it for a sensible PulseAudio configuration.
 
  #!/usr/bin/polaudio -nF
@@ -215,6 +215,6 @@ play-file /usr/share/sounds/startup3.wav combined
 
 
 
-Lennart Poettering <@PACKAGE_BUGREPORT@>, April 2006
+Lennart Poettering <@PACKAGE_BUGREPORT@>, June 2006
 $Id$
  
diff --git a/doc/daemon.html.in b/doc/daemon.html.in
index 0d91e534..d90caa2a 100644
--- a/doc/daemon.html.in
+++ b/doc/daemon.html.in
@@ -2,7 +2,7 @@
 
 
 
-pulseaudio: Daemon
+PulseAudio: Daemon
 
 
 
@@ -11,7 +11,7 @@
 
 Command Line Arguments
 
-The pulseaudio daemon accepts several command line arguments:
+The PulseAudio daemon accepts several command line arguments:
 
  COMMANDS:
@@ -60,7 +60,7 @@ STARTUP SCRIPT:
 
 pulseaudio -D
 
-This will run /etc/pulseaudio/default.pa after startup. This should be a script written in the CLI language described in cli.html. 
+This will run /etc/pulse/default.pa after startup. This should be a script written in the CLI language described in cli.html. 
 
 Signals
 
@@ -83,6 +83,6 @@ STARTUP SCRIPT:
 The daemon logs the current server layout.
 
 
-Lennart Poettering <@PACKAGE_BUGREPORT@>, November 2004
+Lennart Poettering <@PACKAGE_BUGREPORT@>, June 2006
 $Id$
  
diff --git a/doc/modules.html.in b/doc/modules.html.in
index f004f084..dbad8d63 100644
--- a/doc/modules.html.in
+++ b/doc/modules.html.in
@@ -2,7 +2,7 @@
 
 
 
-pulseaudio: Loadable Modules
+PulseAudio: Loadable Modules
 
 
 
@@ -10,7 +10,7 @@
 
 Loadable Modules
 
-The following loadable modules are provided with the pulseaudio distribution:
+The following loadable modules are provided with the PulseAudio distribution:
 
 Device Drivers
 
@@ -157,7 +157,7 @@ will decrease output quality however. (defaults to
 module-tunnel-{sink,source}
 
 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 module-native-protocol-tcp loaded. It's probably a
 better idea to connect to the remote sink/source directly since some
 buffer control is lost through this tunneling.
@@ -204,7 +204,7 @@ module see cli.html.
 module-cli-protocol-{unix,tcp}
 
 An implemenation of a simple command line based protocol for
-controlling the pulseaudio daemon. If loaded, the user may
+controlling the PulseAudio daemon. If loaded, the user may
 connect with tools like netcat, telnet or
 bidilink to the listening sockets and execute commands the
 same way as with module-cli.
@@ -225,7 +225,7 @@ transparent TCP/IP socket. (Both IPv6 and IPv4 - if available)
 a numerical binary value. If 1 the socket is bound to the loopback
 device, i.e. not publicly accessible. (defaults to 1)
   listen=(only for -tcp) The IP address to listen on. If specified, supersedes the value specified in loopback=
-  socket=(only for -unix) The UNIX socket name (defaults to /tmp/pulseaudio/cli)
+  socket=(only for -unix) The UNIX socket name (defaults to /tmp/pulse/cli)
 
 
 module-simple-protocol-{unix,tcp}
@@ -254,7 +254,7 @@ about the two possible suffixes of this module.
 An implemenation of a protocol compatible with the Enlightened Sound
 Daemon (ESOUND, esd). When you load this module you may
-access the pulseaudio daemon with tools like esdcat,
+access the PulseAudio daemon with tools like esdcat,
 esdrec or even esdctl. Many applications, such as
 XMMS, include support for this protocol.
 
@@ -273,7 +273,7 @@ about the two possible suffixes of this module.
 
 module-native-protocol-{unix,tcp}
 
-The native protocol of pulseaudio.
+The native protocol of PulseAudio.
 
 See module-cli-protocol-{unix,tcp} for more information
 about the two possible suffixes of this module.
@@ -293,7 +293,7 @@ about the two possible suffixes of this module.
 module-http-protocol-tcp
 
 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 http://localhost:4714/. This module takes the same arguments
 as module-cli-protocol-tcp.
@@ -430,7 +430,7 @@ created in the JACK server.
 
-  
+  
   sink_name= The name for the Polypaudio sink. If ommited defaults to jack_out.
   server_name= The JACK server to connect to. If ommited defaults to the default server.
client_name= The client name to tell the JACK server. If ommited defaults to pulseaudio.
client_name= The client name to tell the JACK server. If ommited defaults to PulseAudio.
   channels= Number of channels to register. If ommited defaults to the number of physical playback ports of the JACK server.
   connect= Takes a boolean value. If enabled (the default) Polypaudio will try to connect its ports to the physicial playback ports of the JACK server
 
@@ -455,18 +455,18 @@ which is replaced by source_name (with a default of jack_in) f
 
 module-esound-compat-spawnfd
 
-This is a compatibility module for libesd based autospawning of pulseaudio. Don't use it directly.
+This is a compatibility module for libesd based autospawning of PulseAudio. Don't use it directly.
 
 module-esound-compat-spawnpid
 
-This is a compatibility module for libesd based autospawning of pulseaudio. Don't use it directly.
+This is a compatibility module for libesd based autospawning of PulseAudio. Don't use it directly.
 
 module-match
 
 Adjust the volume of a playback stream automatically based on its name.
 
 
-  
+  table= The regular expression matching table file to use (defaults to ~/.pulseaudio/match.table)
table= The regular expression matching table file to use (defaults to ~/.pulse/match.table)
 
 
 The table file should contain a regexp and volume on each line, seperated by spaces. An example:
@@ -482,7 +482,7 @@ which is replaced by source_name (with a default of jack_in) f
 Adjust the volume of a playback stream automatically based on its name.
 
 
-  
+  table= The table file to use (defaults to ~/.pulseaudio/volume.table)
table= The table file to use (defaults to ~/.pulse/volume.table)
 
 
 In contrast to module-match this module needs no explicit
-- 
cgit 



`sink_name=`	The name for the Polypaudio sink. If ommited defaults to `jack_out`.
`server_name=`	The JACK server to connect to. If ommited defaults to the default server.
`client_name=`	The client name to tell the JACK server. If ommited defaults to `pulseaudio`.
`client_name=`	The client name to tell the JACK server. If ommited defaults to `PulseAudio`.
`channels=`	Number of channels to register. If ommited defaults to the number of physical playback ports of the JACK server.
`connect=`	Takes a boolean value. If enabled (the default) Polypaudio will try to connect its ports to the physicial playback ports of the JACK server

`table=`	The regular expression matching table file to use (defaults to `~/.pulseaudio/match.table`)
`table=`	The regular expression matching table file to use (defaults to `~/.pulse/match.table`)

`table=`	The table file to use (defaults to `~/.pulseaudio/volume.table`)
`table=`	The table file to use (defaults to `~/.pulse/volume.table`)

Frequently Asked Questions

pulseaudio @PACKAGE_VERSION@

PulseAudio @PACKAGE_VERSION@

News

Overview

Current Status

First Steps

Developing pulseaudio Clients

Developing PulseAudio Clients

Developing pulseaudio Modules

Developing PulseAudio Modules

Requirements

Acknowledgements

Simple Command Line Language

Example Configuration Script

Command Line Arguments

Signals

Loadable Modules

Device Drivers

module-tunnel-{sink,source}

module-cli-protocol-{unix,tcp}

module-simple-protocol-{unix,tcp}

module-native-protocol-{unix,tcp}

module-http-protocol-tcp

module-esound-compat-spawnfd

module-esound-compat-spawnpid

module-match