From f44ba092651aa75055e109e04b4164ea92ae7fdc Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Mon, 19 Jun 2006 21:53:48 +0000 Subject: big s/polyp/pulse/g git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@1033 fefdeb5f-60dc-0310-8127-8f9354f1896f --- doc/modules.html.in | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) (limited to 'doc/modules.html.in') diff --git a/doc/modules.html.in b/doc/modules.html.in index 85479523..f004f084 100644 --- a/doc/modules.html.in +++ b/doc/modules.html.in @@ -2,7 +2,7 @@ -polypaudio: Loadable Modules +pulseaudio: Loadable Modules @@ -10,7 +10,7 @@

Loadable Modules

-

The following loadable modules are provided with the polypaudio 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 polypaudio 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 polypaudio 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/polypaudio/cli) + socket=(only for -unix) The UNIX socket name (defaults to /tmp/pulseaudio/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 polypaudio 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 polypaudio.

+

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 polypaudio 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.

@@ -347,7 +347,7 @@ already loaded protocol module is used. - +
config=The LIRC configuration file
appname=The application name to pass to LIRC (defaults to polypaudio)
appname=The application name to pass to LIRC (defaults to pulseaudio)
sink=The sink to control
@@ -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 polypaudio.
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 polypaudio. 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 polypaudio. 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 ~/.polypaudio/match.table)
table=The regular expression matching table file to use (defaults to ~/.pulseaudio/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 ~/.polypaudio/volume.table)
table=The table file to use (defaults to ~/.pulseaudio/volume.table)

In contrast to module-match this module needs no explicit -- cgit