From 9f23c8f36299635f78475ee9e90b0a20c5cf3b84 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Sun, 21 Nov 2004 22:07:47 +0000 Subject: Documentation updates git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@310 fefdeb5f-60dc-0310-8127-8f9354f1896f --- doc/FAQ.html.in | 9 ++++++--- doc/Makefile.am | 10 +++++----- doc/README.html.in | 52 +++++++++++++++++++++++++++++++--------------------- doc/cli.html.in | 8 +++++++- doc/daemon.html.in | 34 +++++++++++++++++++++++++--------- doc/modules.html.in | 22 +++++++++++++++++++++- doc/todo | 7 ++----- 7 files changed, 97 insertions(+), 45 deletions(-) (limited to 'doc') diff --git a/doc/FAQ.html.in b/doc/FAQ.html.in index 751ef562..9cacfb4c 100644 --- a/doc/FAQ.html.in +++ b/doc/FAQ.html.in @@ -126,9 +126,11 @@ connect to a running polypaudio daemon try using the following commands:

killall -USR2 polypaudio
 bidilink unix-client:/tmp/polypaudio/cli
-

BTW: Someone should package that great tool for Debian!

+

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.

+

  • How do the polypaudio libraries decide where to connect to?

    The following rule applies:

    @@ -142,10 +144,11 @@ bidilink unix-client:/tmp/polypaudio/cli
  • If $DISPLAY 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.
  • The connection fails.
    • -

    - +

  • Why the heck does libpolyp link against libX11?

    +

    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.

    • +
    diff --git a/doc/Makefile.am b/doc/Makefile.am index 17688d3b..001f5b49 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -30,11 +30,11 @@ CLEANFILES += README endif tidy: README.html cli.html modules.html daemon.html - tidy -e < README.html - tidy -e < cli.html - tidy -e < daemon.html - tidy -e < modules.html - tidy -e < FAQ.html + tidy -qe < README.html + tidy -qe < cli.html + tidy -qe < daemon.html + tidy -qe < modules.html + tidy -qe < FAQ.html .PHONY: tidy diff --git a/doc/README.html.in b/doc/README.html.in index 31511886..eb57fdb7 100644 --- a/doc/README.html.in +++ b/doc/README.html.in @@ -44,15 +44,8 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

    Sun Nov 21 2004:

    Version 0.7 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 -default buffers; client-side latency interpolation; add new user -volume metrics; add module-tunnel, module-null-sink, -module-match and new tool paplay; new API version -macros; many client API improvements; correctly lock cookie file -generation; correctly lock daemon autospawning; print daemon layout to -STDERR on SIGHUP; new options for pacat: allow sample type specification.

    +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; @@ -103,8 +96,9 @@ href="@PACKAGE_URL@polypaudio-0.1.tar.gz">Version 0.1 released

    operating systems. It is intended to be an improved drop-in replacement for the Enlightened Sound -Daemon (ESOUND). In addition to the features ESOUND provides -polypaudio has:

    +Daemon (ESOUND). It is my ultimate ambition to get Polypaudio into +Gnome as a replacement for ESOUND. In +addition to the features ESOUND provides polypaudio has:

    polypaudio is the successor of my previous, ill-fated @@ -156,10 +152,18 @@ href="http://asd.sf.net/">asd.

    href="http://0pointer.de/lennart/projects/paman/">Polypaudio Manager. Another GTK GUI tool for Polypaudio is the Polypaudio Volume -Meter. There are output plugins for .

    + +

    There are output plugins for XMMS, libao and gstreamer. Drivers -for MPlayer and PortAudio will be released shortly.

    +href="http://0pointer.de/lennart/projects/libao-polyp/">libao +(merged in libao SVN) and gstreamer +(merged in gstreamer-plugins CVS), MPlayer (merged in MPlayer CVS) and Xine (merged in Xine CVS). Drivers for +PortAudio will be released +shortly.

    Status

    @@ -227,10 +231,10 @@ questions.

    Requirements

    -

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

    +

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

    polypaudio was developed and tested on Debian GNU/Linux -"testing" from July 2004, it should work on most other 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.

    @@ -255,6 +259,12 @@ compilation and make install (as root) for installation of

    Eric B. Mitchell for writing ESOUND

    +

    Jeff Waugh for creating Ubuntu packages (and hopefully soon Debian)

    + +

    Miguel Freitas for writing a Polypaudio driver for Xine

    + +

    Joe Marcus Clarke for porting Polypaudio to FreeBSD

    +

    Download

    The newest release is always available from @PACKAGE_URL@

    @@ -272,7 +282,7 @@ compilation and make install (as root) for installation of

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

    -
    Lennart Poettering <@PACKAGE_BUGREPORT@>, October 2004
    +
    Lennart Poettering <@PACKAGE_BUGREPORT@>, November 2004
    $Id$
    diff --git a/doc/cli.html.in b/doc/cli.html.in index 49e568f8..61d29e5a 100644 --- a/doc/cli.html.in +++ b/doc/cli.html.in @@ -112,6 +112,12 @@ immediately. The sample is loaded only when it is first used. After a certain idle time it is freed again. Expects the the desired sample name and file name to load as arguments.

    +

    load-sample-dir-lazy

    + +

    Load all entries in the specified directory into the sample cache +as lazy entries. A shell globbing expression (e.g. *.wav) may +be appended to the path of the directory to add.

    +

    Module Autoloading

    list-autoload

    @@ -203,6 +209,6 @@ play-file /usr/share/sounds/startup3.wav combined
    -
    Lennart Poettering <@PACKAGE_BUGREPORT@>, September 2004
    +
    Lennart Poettering <@PACKAGE_BUGREPORT@>, November 2004
    $Id$
    diff --git a/doc/daemon.html.in b/doc/daemon.html.in index 8d2414c0..a4db0bd7 100644 --- a/doc/daemon.html.in +++ b/doc/daemon.html.in @@ -14,26 +14,42 @@ The polypaudio daemon accepts several command line arguments: 
    +COMMANDS:
   -h, --help                            Show this help
       --version                         Show version
       --dump-conf                       Dump default configuration
       --dump-modules                    Dump list of available modules
+  -k  --kill                            Kill a running daemon
+      --check                           Check for a running daemon
 
+OPTIONS:
   -D, --daemonize[=BOOL]                Daemonize after startup
       --fail[=BOOL]                     Quit when startup fails
       --verbose[=BOOL]                  Be slightly more verbose
-      --high-priority[=BOOL]            Try to set high process priority (only available as root)
+      --high-priority[=BOOL]            Try to set high process priority
+                                        (only available as root)
       --disallow-module-loading[=BOOL]  Disallow module loading after startup
-      --exit-idle-time=SECS             Terminate the daemon when idle and this time passed
-      --module-idle-time=SECS           Unload autoloaded modules when idle and this time passed
-      --scache-idle-time=SECS           Unload autoloaded samples when idle and this time passed
+      --exit-idle-time=SECS             Terminate the daemon when idle and this
+                                        time passed
+      --module-idle-time=SECS           Unload autoloaded modules when idle and
+                                        this time passed
+      --scache-idle-time=SECS           Unload autoloaded samples when idle and
+                                        this time passed
       --log-target={auto,syslog,stderr} Specify the log target
-  -p, --dl-search-path=PATH             Set the search path for dynamic shared objects (plugins)
+  -p, --dl-search-path=PATH             Set the search path for dynamic shared
+                                        objects (plugins)
       --resample-method=[METHOD]        Use the specified resampling method
-
-  -L, --load="MODULE ARGUMENTS"         Load the specified plugin module with the specified argument
+                                        (one of src-sinc-medium-quality,
+                                        src-sinc-best-quality,src-sinc-fastest
+                                        src-zero-order-hold,src-linear,trivial)
+      --use-pid-file[=BOOL]             Create a PID file
+
+STARTUP SCRIPT:
+  -L, --load="MODULE ARGUMENTS"         Load the specified plugin module with
+                                        the specified argument
   -F, --file=FILENAME                   Run the specified script
-  -C                                    Open a command line on the running TTY after startup (identical to -Lmodule-cli)
+  -C                                    Open a command line on the running TTY
+                                        after startup
 
   -n                                    Don't load default script file
    @@ -67,6 +83,6 @@ The polypaudio daemon accepts several command line arguments:

    The daemon logs the current server layout.

    -
    Lennart Poettering <@PACKAGE_BUGREPORT@>, September 2004
    +
    Lennart Poettering <@PACKAGE_BUGREPORT@>, November 2004
    $Id$
    diff --git a/doc/modules.html.in b/doc/modules.html.in index 14fe7278..a549396d 100644 --- a/doc/modules.html.in +++ b/doc/modules.html.in @@ -267,6 +267,26 @@ about the two possible suffixes of this module.

    sink=Name of the sink to play the sample on. If ommited defaults to the default sink. +

    module-x11-publish

    + +

    Publishes the access credentials to the Polypaudio server in the +X11 root window. The following properties are used: +POLYP_SERVER, POYLP_SINK, POLYP_SOURCE, +POLYP_COOKIE. This is very useful when using SSH or any other +remote login tool for logging into other machines and getting audio +playback to your local speakers. The Polypaudio client libraries make +use of this data automatically. Instead of using this module you may +use the tool pax11publish which may be used to access, modify +and import credential data from/to the X11 display.

    + + + + + +
    display=X11 display to connect to. If ommited defaults to the value of $DISPLAY
    sink=Name of the default sink. If ommited this property isn't stored in the X11 display.
    source=Name of the default source. If ommited this property isn't stored in the X11 display.
    cookie=Name of the cookie file of the +cookie to store in the X11 display. If ommited the cookie of an +already loaded protocol module is used.
    +

    module-sine

    Creates a sink input and generates a sine waveform stream.

    @@ -301,6 +321,6 @@ about the two possible suffixes of this module.

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

    -
    Lennart Poettering <@PACKAGE_BUGREPORT@>, September 2004
    +
    Lennart Poettering <@PACKAGE_BUGREPORT@>, November 2004
    $Id$
    diff --git a/doc/todo b/doc/todo index 3e30af4f..d6cfb01a 100644 --- a/doc/todo +++ b/doc/todo @@ -1,10 +1,7 @@ *** $Id$ *** -*** 0.7 **** -- limit all resources -- commenting - -** later *** +*** later **** +- event more commenting - polish for starting polypaudio as root/system-wide instance - per-channel volume - improve module-oss-mmap latency measurement -- cgit