From 6654e987c17bc1026944248cfb01876311807bd7 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Mon, 19 Jun 2006 23:52:16 +0000 Subject: update docs git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@1040 fefdeb5f-60dc-0310-8127-8f9354f1896f --- doc/README.html.in | 108 +++++++++++++++++++++++++++-------------------------- 1 file changed, 55 insertions(+), 53 deletions(-) (limited to 'doc/README.html.in') diff --git a/doc/README.html.in b/doc/README.html.in index 2f6ad448..e4eea786 100644 --- a/doc/README.html.in +++ b/doc/README.html.in @@ -3,12 +3,12 @@ -pulseaudio @PACKAGE_VERSION@ +PulseAudio @PACKAGE_VERSION@ -

pulseaudio @PACKAGE_VERSION@

+

PulseAudio @PACKAGE_VERSION@

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

@@ -44,7 +44,7 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

News

Fri Jun 2 2006:

Version 0.9.1 +href="@PACKAGE_URL@polypaudio-0.9.1.tar.gz">Version 0.9.1 released; changes include: load modules even when libtool .la files are missing; generate better ALSA device names from module-detect; if an ALSA device doesn't support the @@ -53,7 +53,7 @@ suggests instead; amd64 portability; drop .sh suffix of esdcompat.sh; build system fixes; No API or ABI changes were made

Fri May 26 2006:

Version 0.9.0 +href="@PACKAGE_URL@polypaudio-0.9.0.tar.gz">Version 0.9.0 released; changes include: new module module-volume-restore; new OSS API emulation tool padsp; 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

Fri Apr 28 2006:

Version 0.8.1 +href="@PACKAGE_URL@polypaudio-0.8.1.tar.gz">Version 0.8.1 released; changes include: support for specifying the channel map on the command lines of paplay and pacat and as arguments to the driver modules; ALSA hardware mixer compatibility; @@ -70,16 +70,16 @@ fix linking; properly remove PF_UNIX sockets when unloading protocol modules; fix sample cache; many other fixes

Thu Apr 13 2006:

Version 0.8 released; -changes include: too many to count - consider reading this blog entry for more information; many, many minor fixes.

+href="@PACKAGE_URL@polypaudio-0.8.tar.gz">Version 0.8 released; +changes include: too many to count - consider reading this blog entry for more information; many, many minor fixes.

Sun Nov 21 2004:

Version 0.7 released; +href="@PACKAGE_URL@polypaudio-0.7.tar.gz">Version 0.7 released; changes include: IPv6 support; PID file support; publish credentials in X11 root window (module-x11-publish; new tool pacmd; ESOUND backend; new command load-sample-dir-lazy; many, many minor fixes.

Thu Oct 28 2004:

Version 0.6 released; +href="@PACKAGE_URL@polypaudio-0.6.tar.gz">Version 0.6 released; changes include: TCP wrappers support; don't load the complete sound file into memory when playing back using pa_play_file(); 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 pacat: allow sample type specification.

Mon Sep 24 2004:

Version 0.5.1 released; +href="@PACKAGE_URL@polypaudio-0.5.1.tar.gz">Version 0.5.1 released; changes include: improve esound protocol compatibility; fix autospawning via libesd; make use of POSIX capabilities; allow SCHED_FIFO scheduling only for users in group realtime; minor build system fix.

Mon Sep 20 2004:

Version 0.5 released; +href="@PACKAGE_URL@polypaudio-0.5.tar.gz">Version 0.5 released; changes include: extensive API improvements, new module module-combine 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 module-pipe-source, many other fixes and improvements.

Wed Sep 8 2004:

Version 0.4 released; +href="@PACKAGE_URL@polypaudio-0.4.tar.gz">Version 0.4 released; changes include: daemon auto spawning, support for SCHED_FIFO scheduling, three new modules, proper logging, CPU load watchdog, many fixes.

Fri Aug 27 2004:

Version 0.3 released; +href="@PACKAGE_URL@polypaudio-0.3.tar.gz">Version 0.3 released; changes include: support for both glib 2.0 and glib 1.2, future cancellation, API updates, many fixes, relicense client library to LGPL.

Fri Aug 20 2004:

Version 0.2 released; +href="@PACKAGE_URL@polypaudio-0.2.tar.gz">Version 0.2 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.

Sat Jul 17 2004:

Version 0.1 released

+href="@PACKAGE_URL@polypaudio-0.1.tar.gz">Version 0.1 released

Overview

-

pulseaudio is a networked sound server for Linux and other +

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 Enlightened Sound Daemon (ESOUND). In addition to the features ESOUND provides -pulseaudio has:

+PulseAudio has:

-

A GTK GUI manager application for pulseaudio is the Polypaudio -Manager. Other GTK GUI tool for Polypaudio are the Polypaudio Volume +

A GTK GUI manager application for PulseAudio is the PulseAudio +Manager. Other GTK GUI tool for PulseAudio are the PulseAudio Volume Meter and the Polypaudio Volume +href="http://0pointer.de/lennart/projects/pavucontrol">PulseAudio Volume Control .

There are output plugins for Xine (merged in Xine CVS). Drivers for PortAudio will be released shortly.

+

PulseAudio was formerly known as Polypaudio.

+

Current Status

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

@@ -216,68 +218,68 @@ href="modules.html">modules.html, cli.html, daemon.html and FAQ.html.

-

There is a Trac based Wiki for Polypaudio available.

+

There is a Trac based Wiki for PulseAudio available.

First Steps

-

Simply start the pulseaudio daemon with the argument -nC

+

Simply start the PulseAudio daemon with the argument -nC

pulseaudio -nC

This will present you a screen like this:

-
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:

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.

-- cgit