From df108afe352a4f0e8d67510f923878e954714c94 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 13 Apr 2006 15:10:55 +0000 Subject: update documentation for release 0.8 git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@699 fefdeb5f-60dc-0310-8127-8f9354f1896f --- doc/FAQ.html.in | 3 +-- doc/Makefile.am | 2 +- doc/README.html.in | 65 +++++++++++++++++++++++++++++++++++------------------ doc/cli.html.in | 20 +++++++++++------ doc/modules.html.in | 65 +++++++++++++++++++++++++++++++++++++++++++++++------ doc/style.css | 15 ++++--------- 6 files changed, 120 insertions(+), 50 deletions(-) (limited to 'doc') diff --git a/doc/FAQ.html.in b/doc/FAQ.html.in index 9cacfb4c..0e738217 100644 --- a/doc/FAQ.html.in +++ b/doc/FAQ.html.in @@ -128,7 +128,6 @@ bidilink unix-client:/tmp/polypaudio/cli

BTW: Someone should package that great tool for Debian!

-

New: There's now a tool pacmd that automates sending SIGUSR2 to the daemon and running a bidilink like tool for you.

@@ -152,6 +151,6 @@ bidilink unix-client:/tmp/polypaudio/cli
-
Lennart Poettering <@PACKAGE_BUGREPORT@>, September 2004
+
Lennart Poettering <@PACKAGE_BUGREPORT@>, April 2006
$Id$
diff --git a/doc/Makefile.am b/doc/Makefile.am index c68c00f5..a5884abd 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -16,7 +16,7 @@ # along with polypaudio; if not, write to the Free Software Foundation, # Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. -noinst_DATA = README.html cli.html modules.html daemon.html +noinst_DATA = README.html cli.html modules.html daemon.html FAQ.html EXTRA_DIST = $(noinst_DATA) style.css README.html.in cli.html.in modules.html.in daemon.html.in todo FAQ.html.in MAINTAINERCLEANFILES = README.html cli.html modules.html daemon.html FAQ.html diff --git a/doc/README.html.in b/doc/README.html.in index eb57fdb7..dbf85411 100644 --- a/doc/README.html.in +++ b/doc/README.html.in @@ -10,13 +10,13 @@

polypaudio @PACKAGE_VERSION@

-

Copyright 2004 Lennart Poettering <@PACKAGE_BUGREPORT@>

+

Copyright 2004-2006 Lennart Poettering <@PACKAGE_BUGREPORT@> and Pierre Ossman

polypaudio is the successor of my previous, ill-fated @@ -165,7 +175,7 @@ href="http://xine.sf.net/">Xine (merged in Xine CVS). Drivers for PortAudio will be released shortly.

-

Status

+

Current Status

Version @PACKAGE_VERSION@ is quite usable. It matches and supersedes ESOUND's feature set in nearly all areas.

@@ -178,7 +188,11 @@ release to release. The client API's library version number is currently fixed t

There is some preliminary documentation available: modules.html, cli.html, daemon.html, FAQ.html, .

+href="daemon.html">daemon.html and FAQ.html.

+ +

There is a Trac based Wiki for Polypaudio available.

+ +

First Steps

@@ -231,7 +245,7 @@ questions.

Requirements

-

Currently, polypaudio is tested on Linux and FreeBSD only. It requires an OSS or ALSA compatible soundcard.

+

Currently, polypaudio is tested on Linux, FreeBSD, Solaris and Microsoft Windows. It requires an OSS, ALSA, Win32 or Solaris compatible soundcard.

polypaudio was developed and tested on Debian GNU/Linux "testing" from November 2004, it should work on most other Linux @@ -239,11 +253,16 @@ distributions (and maybe Unix versions) since it uses GNU autoconf and GNU libtool for source code configuration and shared library management.

-

polypaudio needs libwrap, polypaudio needs Secret Rabbit Code (aka libsamplerate), libsndfile, alsa-lib and liboil.

+ +

Optionally it can make use of libwrap, alsa-lib, libasyncns, +lirc, HOWL (or preferably the compatibility layer included in its superior replacement Avahi) and GLIB. (The latter is required for building the GLIB main loop integration module only.)

@@ -271,18 +290,20 @@ compilation and make install (as root) for installation of

The current release is @PACKAGE_VERSION@

-

Get polypaudio's development sources from the Subversion repository (viewcvs):

+

Get polypaudio's development sources from the Subversion repository (viewcvs):

-
svn checkout svn://seth.intheinter.net/polypaudio/trunk polypaudio
+
svn checkout svn://0pointer.de/polypaudio/trunk polypaudio

If you want to be notified whenever I release a new version of this software use the subscription feature of Freshmeat.

-

New! There is a general discussion mailing list for polypaudio available.

+

There is a general discussion mailing list for polypaudio available. In addition, you can subscribe to SVN changes and Trac Tickets.

+ +

There is a Trac based Wiki for Polypaudio available.

-

New! There is now a Polypaudio wiki (based on trac) available.

+

Please report bugs to our Trac ticket system.

-
Lennart Poettering <@PACKAGE_BUGREPORT@>, November 2004
+
Lennart Poettering <@PACKAGE_BUGREPORT@>, April 2006
$Id$
diff --git a/doc/cli.html.in b/doc/cli.html.in index 61d29e5a..0db96c36 100644 --- a/doc/cli.html.in +++ b/doc/cli.html.in @@ -68,13 +68,19 @@ returned by modules.

Configuration Commands

-

set-sink-volume

+

set-sink-volume/set-source-volume

-

Set the volume of the specified sink. You may specify the sink either -by its index in the sink list or by its name. The volume should be an -integer value greater or equal than 0 (= muted). Volume 256 -(0x100) is normal volume, values greater than this amplify -the audio signal with clipping.

+

Set the volume of the specified sink or source. You may specify the sink/source either +by its index in the sink/source list or by its name. The volume should be an +integer value greater or equal than 0 (= muted). Volume 65536 +(0x10000) is normal volume, values greater than this amplify +the audio signal (with clipping).

+ +

set-sink-mute/set-source-mute

+ +

Mute or unmute the specified sink our source. You may specify the +sink/source either by its index or by its name. The mute value is +either 0 or 1.

set-sink-input-volume

@@ -209,6 +215,6 @@ play-file /usr/share/sounds/startup3.wav combined
-
Lennart Poettering <@PACKAGE_BUGREPORT@>, November 2004
+
Lennart Poettering <@PACKAGE_BUGREPORT@>, April 2006
$Id$
diff --git a/doc/modules.html.in b/doc/modules.html.in index a549396d..64bc4bbc 100644 --- a/doc/modules.html.in +++ b/doc/modules.html.in @@ -100,6 +100,24 @@ compatible as module-oss.

This module accepts exactly the same arguments as module-oss.

+

module-solaris

+ +

Provides a sink and source for the Solaris audio device.

+ +

In addition to the general device driver options described above this module supports:

+ + + + + +
record=Accepts a binary numerical value for enabling (resp. disabling) the recording on this device. (defaults: to 1)
playback=Accepts a binary numerical value for enabling (resp. disabling) the playback on this device. (defaults: to 1)
buffer_size=Record buffer size
+ +

module-waveout

+ +

Provides a sink and source for the Win32 audio device.

+ +

This module supports all arguments thet module-oss supports except device=.

+

module-combine

This combines two or more sinks into one. A new virtual sink is @@ -168,7 +186,7 @@ module see cli.html. -

module-cli-protocol-{unix,tcp,tcp6}

+

module-cli-protocol-{unix,tcp}

An implemenation of a simple command line based protocol for controlling the polypaudio daemon. If loaded, the user may @@ -182,7 +200,7 @@ service.

This module exists in two versions: with the suffix -unix the service will listen on an UNIX domain socket in the local file system. With the suffix -tcp it will listen on a network -transparent TCP/IP socket.

+transparent TCP/IP socket. (Both IPv6 and IPv4 - if available)

This module supports the following options:

@@ -191,10 +209,11 @@ transparent TCP/IP socket.

loopback=(only for -tcp) Accepts 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) -

module-simple-protocol-{unix,tcp,tcp6}

+

module-simple-protocol-{unix,tcp}

An implementation of a simple protocol which allows playback by using simple tools like netcat. Just connect to the listening @@ -231,13 +250,13 @@ about the two possible suffixes of this module.

- +
sink=, source=Specify the sink/source this service connects to
public=If set to 0 not authentication is required to connect to the service
auth-anonymous=If set to 1 no authentication is required to connect to the service
cookie=Name of the cookie file for authentication purposes

This implementation misses some features the original ESOUND has: e.g. there is no sample cache yet. However: XMMS works fine.

-

module-native-protocol-{unix,tcp,tcp6}

+

module-native-protocol-{unix,tcp}

The native protocol of polypaudio.

@@ -247,7 +266,8 @@ about the two possible suffixes of this module.

In addition to the options supported by module-cli-protocol-*, this module supports:

- + +
public=If set to 0 not authentication is required to connect to the service
auth-anonymous=If set to 1 no authentication is required to connect to the service
auth-group=(only for -unix): members of the specified unix group may access the server without further auhentication.
cookie=Name of the cookie file for authentication purposes
@@ -320,7 +340,38 @@ already loaded protocol module is used.

The volumes of all streams with titles starting with sample: are automatically set to 25. (FYI: All sample cache streams start with sample:)

+

module-detect

+ +

Automatically detect the available sound hardware and load modules for it. Supports OSS, ALSA, Solaris and Win32 output drivers. + + + +
just-one=If set to 1 the module will only try to load a single sink/source and than stop.
+ +

module-zeroconf-publish

+ +

Publish all local sinks/sources using mDNS Zeroconf.

+ +

module-mmkbd-evdev

+ +

Adjust the volume of a sink when the special multimedia buttons of modern keyboards are pressed.

+ + + + +
device=Linux input device ("evdev", defaults to /dev/input/event0)
sink=The sink to control
+ +

module-lirc

+ +

Adjust the volume of a sink when the volume buttons of an infrared remote control are pressed (through LIRC).

+ + + + + +
config=The LIRC configuration file
appname=The application name to pass to LIRC (defaults to polypaudio)
sink=The sink to control
+
-
Lennart Poettering <@PACKAGE_BUGREPORT@>, November 2004
+
Lennart Poettering <@PACKAGE_BUGREPORT@>, April 2006
$Id$
diff --git a/doc/style.css b/doc/style.css index a46592a2..a606c08e 100644 --- a/doc/style.css +++ b/doc/style.css @@ -18,17 +18,10 @@ * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. ***/ -body { color: black; background-color: white; margin: 0.5cm; } +body { color: black; background-color: white; } a:link, a:visited { color: #900000; } -p { margin-left: 0.5cm; margin-right: 0.5cm; } -div.news-date { margin-left: 0.5cm; font-size: 80%; color: #4f0000; } -p.news-text { margin-left: 1cm; } -h1 { color: #00009F; } -h2 { color: #00009F; } -h3 { color: #00004F; margin-left: 0.5cm; } -ul { margin-left: .5cm; } -ol { margin-left: .5cm; } -pre { margin-left: .5cm; background-color: #f0f0f0; padding: 0.4cm;} -.grey { color: #afafaf; } +div.news-date { font-size: 80%; font-style: italic; } +pre { background-color: #f0f0f0; padding: 0.4cm; } +.grey { color: #8f8f8f; font-size: 80%; } table { margin-left: 1cm; border:1px solid lightgrey; padding: 0.2cm; } td { padding-left:10px; padding-right:10px; } -- cgit