From bff4ca431b0146cb0cbb3935905f50714072a0d9 Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Mon, 5 Nov 2007 15:10:13 +0000
Subject: add a man page for the pulseaudio binary. More will follow.

git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@2023 fefdeb5f-60dc-0310-8127-8f9354f1896f
---
 man/Makefile.am         |  60 ++++++++
 man/pulseaudio.1.xml.in | 379 ++++++++++++++++++++++++++++++++++++++++++++++++
 man/xmltoman.css        |  30 ++++
 man/xmltoman.dtd        |  39 +++++
 man/xmltoman.xsl        | 129 ++++++++++++++++
 5 files changed, 637 insertions(+)
 create mode 100644 man/Makefile.am
 create mode 100644 man/pulseaudio.1.xml.in
 create mode 100644 man/xmltoman.css
 create mode 100644 man/xmltoman.dtd
 create mode 100644 man/xmltoman.xsl

(limited to 'man')

diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 00000000..b701a2ea
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,60 @@
+# $Id$
+#
+# This file is part of PulseAudio.
+#
+# PulseAudio is free software; you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# PulseAudio is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with PulseAudio; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+# USA.
+
+pulseconfdir=$(sysconfdir)/pulse
+
+if BUILD_MANPAGES
+
+man_MANS = \
+	pulseaudio.1
+
+noinst_DATA = \
+	pulseaudio.1.xml
+
+CLEANFILES = \
+	$(noinst_DATA)
+
+pulseaudio.1.xml: pulseaudio.1.xml.in Makefile
+	sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \
+	    -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+            -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
+if USE_XMLTOMAN
+
+CLEANFILES += \
+	$(man_MANS)
+
+pulseaudio.1: pulseaudio.1.xml Makefile
+	xmltoman $< > $@
+
+xmllint: $(noinst_DATA)
+	for f in $(noinst_DATA) ; do \
+			xmllint --noout --valid "$$f" || exit 1 ; \
+	done
+
+endif
+
+endif
+
+EXTRA_DIST = \
+	$(man_MANS) \
+	pulseaudio.1.xml.in
+	xmltoman.css \
+	xmltoman.xsl \
+	xmltoman.dtd
diff --git a/man/pulseaudio.1.xml.in b/man/pulseaudio.1.xml.in
new file mode 100644
index 00000000..b30f4484
--- /dev/null
+++ b/man/pulseaudio.1.xml.in
@@ -0,0 +1,379 @@
+<?xml version="1.0"?><!--*-nxml-*-->
+<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
+<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
+
+<!-- $Id$ -->
+
+<!--
+This file is part of PulseAudio.
+
+PulseAudio is free software; you can redistribute it and/or modify it
+under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation; either version 2.1 of the
+License, or (at your option) any later version.
+
+PulseAudio is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with PulseAudio; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+USA.
+-->
+
+<manpage name="pulseaudio" section="1" desc="The PulseAudio Sound System">
+
+  <synopsis>
+    <cmd>pulseaudio [<arg>options</arg>]</cmd>
+    <cmd>pulseaudio <opt>--help</opt></cmd>
+    <cmd>pulseaudio <opt>--dump-conf</opt></cmd>
+    <cmd>pulseaudio <opt>--dump-modules</opt></cmd>
+    <cmd>pulseaudio <opt>--dump-resample-methods</opt></cmd>
+    <cmd>pulseaudio <opt>--cleanup-shm</opt></cmd>
+    <cmd>pulseaudio <opt>--kill</opt></cmd>
+    <cmd>pulseaudio <opt>--check</opt></cmd>
+  </synopsis>
+
+  <description>
+    <p>PulseAudio is a networked low-latency sound server for Linux, POSIX and Windows systems.</p>
+  </description>
+
+  <options>
+
+    <option>
+      <p><opt>-h | --help</opt></p>
+
+      <optdesc><p>Show help.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--version</opt></p>
+
+      <optdesc><p>Show version information.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--dump-conf</opt></p>
+
+      <optdesc><p>Load the daemon configuration file
+      <file>daemon.conf</file> (see below), parse remaining
+      configuration options on the command line and dump the resulting
+      daemon configuration, in a format that is compatible with
+      <file>daemon.conf</file>.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--dump-modules</opt></p>
+
+      <optdesc><p>List available loadable modules. Combine with
+      <opt>-v</opt> for a more elaborate listing.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--dump-resampe-methods</opt></p>
+      <optdesc><p>List available audio resamplers.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--cleanup-shm</opt></p>
+
+      <optdesc><p>Identify stale PulseAudio POSIX shared memory
+      segments in <file>/dev/shm</file> and remove them if
+      possible. This is done implicitly whenever a new daemon starts
+      up or a client tries to connect to a daemon. It should normally
+      not be necessary to issue this command by hand. Only available
+      on systems with POSIX shared memory segments implemented via a
+      virtual file system mounted to <file>/dev/shm</file>
+      (e.g. Linux).</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-k | --kill</opt></p>
+
+      <optdesc><p>Kill an already running PulseAudio daemon of the
+      calling user (Equivalent to sending a SIGTERM).</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--check</opt></p>
+
+      <optdesc><p>Return 0 as return code when the PulseAudio daemon
+      is already running for the calling user.</p></optdesc>
+    </option>
+
+
+    <option>
+      <p><opt>--system</opt><arg>[=BOOL]</arg></p>
+
+      <optdesc><p>Run as system-wide instance instead of
+      per-user. Please not that this disables certain features of
+      PulseAudio and is generally not recommended unless the system
+      knows no local users (e.g. is a thin client). This feature needs
+      special configuration and a dedicated UNIX user set up. It is
+      highly recommended to combine this with
+      <opt>--disallow-module-loading</opt> (see below).</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-D | --daemon</opt><arg>[=BOOL]</arg></p>
+
+      <optdesc><p>Daemonize after startup, i.e. detach from the
+      terminal.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--fail</opt><arg>[=BOOL]</arg></p>
+
+      <optdesc><p>Fail startup when any of the commands specified in
+      the startup script <file>default.pa</file> (see below)
+      fails.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--high-priority</opt><arg>[=BOOL]</arg></p>
+
+      <optdesc><p>Try to acquire a high Unix nice level. This will
+      only succeed if the calling user has a non-zero RLIMIT_NICE
+      resource limit set (on systems that support this), or we're
+      called SUID root (see below), or we are configure to be run as
+      system daemon (see <arg>--system</arg> above). It is recommended
+      to enable this, since it is only a negligible security risk (see
+      below).</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--realtime</opt><arg>[=BOOL]</arg></p>
+
+      <optdesc><p>Try to acquire a real-time scheduling for
+      PulseAudio's I/O threads. This will only succeed if the calling
+      user has a non-zero RLIMIT_RTPRIO resource limit set (on systems
+      that support this), or we're called SUID root (see below), or we
+      are configure to be run as system daemon (see
+      <arg>--system</arg> above). It is recommended to enable this
+      only for trusted users, since it is a major security risk (see
+      below).</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--disallow-module-loading</opt><arg>[=BOOL]</arg></p>
+
+      <optdesc><p>Disallow module loading after startup. This is a
+      security feature since it disallows additional module loading
+      during runtime and on user request. It is highly recommended
+      when <arg>--system</arg> is used (see above). Note however, that
+      this breaks certain features like automatic module loading on hot
+      plug.</p></optdesc>
+
+    </option>
+
+    <option>
+      <p><opt>--exit-idle-time</opt><arg>=SECS</arg></p>
+
+      <optdesc><p>Terminate the daemon when idle and the specified
+      number of seconds passed.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--module-idle-time</opt><arg>=SECS</arg></p>
+
+      <optdesc><p>Unload autoloaded modules when idle and the
+      specified number of seconds passed.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--scache-idle-time</opt><arg>=SECS</arg></p>
+
+      <optdesc><p>Unload autoloaded samples from the cache when the
+      haven't been used for the specified number of
+      seconds.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--log-level</opt><arg>[=LEVEL]</arg></p>
+
+      <optdesc><p>If an argument is passed, set the log level to the
+      specified value, otherwise increase the configured verbosity
+      level by one. The log levels are numerical from 0 to 4,
+      corresponding to <arg>error</arg>, <arg>warn</arg>,
+      <arg>notice</arg>, <arg>info</arg>, <arg>debug</arg>. Default
+      log level is <arg>notice</arg>, i.e. all log messages with lower
+      log levels are printed: <arg>error</arg>, <arg>warn</arg>,
+      <arg>notice</arg>.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-v</opt></p>
+
+      <optdesc><p>Increase the configured verbosity level by one (see
+      <opt>--log-level</opt> above). Specify multiple times to
+      increase log level multiple times.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--log-target</opt><arg>={auto,syslog,stderr}</arg></p>
+
+      <optdesc><p>Specify the log target. If set to <arg>auto</arg>
+      (which is the default), then logging is directed to syslog when
+      <opt>--daemonize</opt> is passed, otherwise to
+      STDERR.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--p | --dl-search-path</opt><arg>=PATH</arg></p>
+
+      <optdesc><p>Set the search path for dynamic shared objects
+      (plugins).</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--resample-method</opt><arg>=METHOD</arg></p>
+
+      <optdesc><p>Use the specified resampler by default (See
+      <opt>--dump-resample-methods</opt> above for possible
+      values).</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--use-pid-file</opt><arg>[=BOOL]</arg></p>
+
+      <optdesc><p>Create a PID file. If this options is disabled it is possible to run multiple sound servers per user.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--no-cpu-limit</opt><arg>[=BOOL]</arg></p>
+
+      <optdesc><p>Do not install CPU load limiter on platforms that
+      support it. By default, PulseAudio will terminate itself when it
+      notices that it takes up too much CPU time. This is useful as a
+      protection against system lockups when real-time scheduling is
+      used (see below). Disabling this meachnism is useful when
+      debugging PulseAudio with tools like <manref name="valgrind"
+      section="1"/> which slow down execution.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--disable-shm</opt><arg>[=BOOL]</arg></p>
+
+      <optdesc><p>PulseAudio clients and the server can exchange audio
+      data via POSIX shared memory segments (on systems that support
+      this). If disabled PulseAudio will communicate exclusively over
+      sockets. Please note that data transfer via shared memory
+      segments is always disabled when PulseAudio is running with
+      <opt>--system</opt> enabled (see above).</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-L | --load</opt><arg>="MODULE ARGUMENTS"</arg></p>
+
+      <optdesc><p>Load the specified plugin module with the specified
+      arguments.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-F | --file</opt><arg>=FILENAME</arg></p>
+
+      <optdesc><p>Run the specified script on startup. May be
+      specified multiple times to specify multiple scripts to be run
+      in order. Combine with <opt>-n</opt> to disable loading of the
+      default script <file>default.pa</file> (see below).</p></optdesc>
+    </option>
+    <option>
+      <p><opt>-C</opt></p>
+
+      <optdesc><p>Open a command interpreter on STDIN/STDOUT after
+      startup. This may be used to configure PulseAudio dynamically
+      during runtime. Equivalent to
+      <opt>--load</opt><arg>=module-cli</arg>.</p></optdesc>
+    </option>
+    <option>
+      <p><opt>-n</opt></p>
+
+      <optdesc><p>Don't load default script file
+      <file>default.pa</file> (see below) on startup. Useful in
+      conjunction with <opt>-C</opt> or
+      <opt>--file</opt>.</p></optdesc>
+    </option>
+
+
+  </options>
+
+  <section name="Files">
+
+    <p><file>~/.pulse/daemon.conf</file>,
+    <file>@pulseconfdir@/daemon.conf</file>: configuration settings
+    for the PulseAudio daemon. If the version in the user's home
+    directory does not exist the global configuration file is
+    loaded. See <manref name="pulse-daemon.conf" section="5"/> for
+    more information.</p>
+
+    <p><file>~/.pulse/default.pa</file>,
+    <file>@pulseconfdir@/default.pa</file>: the default configuration
+    script to execute when the PulseAudio daemon is started. If the
+    version in the user's home directory does not exist the global
+    configuration script is loaded. See <manref name="default.pa"
+    section="5"/> for more information.</p>
+
+    <p><file>~/.pulse/client.conf</file>,
+    <file>@pulseconfdir@/client.conf</file>: configuration settings
+    for PulseAudio client applications. If the version in the user's
+    home directory does not exist the global configuration file is
+    loaded.  See <manref name="pulse-client.conf" section="5"/> for
+    more information.</p>
+
+  </section>
+
+  <section name="Signals">
+
+    <p><arg>SIGINT, SIGTERM</arg>: the PulseAudio daemon will shut
+    down (Same as <opt>--kill</opt>).</p>
+
+    <p><arg>SIGHUP</arg>: dump a long status report to STDOUT or
+    syslog, depending on the configuration.</p>
+
+    <p><arg>SIGUSR1</arg>: load module-cli, allowing runtime
+    reconfiguration via STDIN/STDOUT.</p>
+
+    <p><arg>SIGUSR2</arg>: load module-cli-protocol-unix, allowing
+    runtime reconfiguration via a AF_UNIX socket. See <manref
+    name="pacmd" section="1"/> for more information.</p>
+
+  </section>
+
+  <section name="UNIX Groups and users">
+
+    <p>Group <arg>pulse-rt</arg>: if the PulseAudio binary is marked
+    SUID root, then membership of the calling user in this group
+    decides whether real-time and/or high-priority scheduling is
+    enabled. Please note that enabling real-time scheduling is a
+    security risk (see below).</p>
+
+    <p>Group <arg>pulse-access</arg>: if PulseAudio is running as a system
+    daemon (see <opt>--system</opt> above) access is granted to
+    members of this group when they connect via AF_UNIX sockets. If
+    PulseAudio is running as a user daemon this group has no
+    meaning.</p>
+
+    <p>User <arg>pulse</arg>, group <arg>pulse</arg>: if PulseAudio is running as a system
+    daemon (see <opt>--system</opt> above) and is started as root the
+    daemon will drop priviliges and become a normal user process using
+    this user and group. If PulseAudio is running as a user daemon
+    this user and group has no meaning.</p>
+  </section>
+
+  <section name="Real-time and high-priority scheduling">
+    Blablub
+  </section>
+
+  <section name="Authors">
+    <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
+  </section>
+
+  <section name="See also">
+    <p>
+      <manref name="pulse-daemon.conf" section="5"/>, <manref name="default.pa" section="5"/>, <manref name="pulse-client.conf" section="5"/>, <manref name="pacmd" section="1"/>
+    </p>
+  </section>
+
+</manpage>
diff --git a/man/xmltoman.css b/man/xmltoman.css
new file mode 100644
index 00000000..579a4fdc
--- /dev/null
+++ b/man/xmltoman.css
@@ -0,0 +1,30 @@
+/* $Id$ */
+
+/***
+  This file is part of PulseAudio.
+
+  PulseAudio is free software; you can redistribute it and/or modify it under
+  the terms of the GNU General Public License as published by the Free
+  Software Foundation; either version 2 of the License, or (at your
+  option) any later version.
+
+  PulseAudio is distributed in the hope that it will be useful, but WITHOUT
+  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+  for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with PulseAudio; if not, write to the Free Software Foundation,
+  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
+***/
+
+body { color: black; background-color: white; } 
+a:link, a:visited { color: #900000; }       
+h1 { text-transform:uppercase; font-size: 18pt; } 
+p { margin-left:1cm; margin-right:1cm; } 
+.cmd { font-family:monospace; }
+.file { font-family:monospace; }
+.arg { text-transform:uppercase; font-family:monospace; font-style: italic; }
+.opt { font-family:monospace; font-weight: bold;  }
+.manref { font-family:monospace; }
+.option .optdesc { margin-left:2cm; }
diff --git a/man/xmltoman.dtd b/man/xmltoman.dtd
new file mode 100644
index 00000000..121e62c8
--- /dev/null
+++ b/man/xmltoman.dtd
@@ -0,0 +1,39 @@
+<!-- $Id$ -->
+
+<!-- 
+  This file is part of PulseAudio.
+
+  PulseAudio is free software; you can redistribute it and/or modify it under
+  the terms of the GNU General Public License as published by the Free
+  Software Foundation; either version 2 of the License, or (at your
+  option) any later version.
+
+  PulseAudio is distributed in the hope that it will be useful, but WITHOUT
+  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+  for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with PulseAudio; if not, write to the Free Software Foundation,
+  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
+-->
+
+<!ELEMENT manpage (synopsis | description | section | options | seealso)*>
+<!ATTLIST manpage name CDATA #REQUIRED section CDATA #REQUIRED desc CDATA #IMPLIED>
+<!ELEMENT arg (#PCDATA)>
+<!ELEMENT p (#PCDATA | arg | url | manref | opt | file )*>
+<!ELEMENT synopsis (cmd | p)+>
+<!ELEMENT description (p)+>
+<!ELEMENT section (p | option)*>
+<!ATTLIST section name CDATA #REQUIRED>
+<!ELEMENT option (#PCDATA | p | optdesc)*>
+<!ELEMENT optdesc (#PCDATA | p )*>
+<!ELEMENT cmd (#PCDATA | arg | opt)*>
+<!ELEMENT options (p | option)*>
+<!ELEMENT seealso (p)*>
+<!ELEMENT opt (#PCDATA)>
+<!ELEMENT file (#PCDATA)>
+<!ELEMENT manref EMPTY>
+<!ATTLIST manref name CDATA #REQUIRED section CDATA #REQUIRED href CDATA #IMPLIED>
+<!ELEMENT url EMPTY>
+<!ATTLIST url href CDATA #REQUIRED>
diff --git a/man/xmltoman.xsl b/man/xmltoman.xsl
new file mode 100644
index 00000000..8d4ca212
--- /dev/null
+++ b/man/xmltoman.xsl
@@ -0,0 +1,129 @@
+<?xml version="1.0" encoding="iso-8859-15"?>
+<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml">
+
+<!-- 
+  This file is part of PulseAudio.
+
+  PulseAudio is free software; you can redistribute it and/or modify it under
+  the terms of the GNU General Public License as published by the Free
+  Software Foundation; either version 2 of the License, or (at your
+  option) any later version.
+
+  PulseAudio is distributed in the hope that it will be useful, but WITHOUT
+  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+  for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with PulseAudio; if not, write to the Free Software Foundation,
+  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 
+-->
+
+<!-- $Id$ -->
+
+<xsl:output method="xml" version="1.0" encoding="iso-8859-15" doctype-public="-//W3C//DTD XHTML 1.0 Strict//EN" doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd" indent="yes"/>
+
+<xsl:template match="/manpage">
+  
+    <html>
+
+    <head>
+      <title><xsl:value-of select="@name"/>(<xsl:value-of select="@section"/>)</title>
+      <style type="text/css">
+        body { color: black; background-color: white; } 
+        a:link, a:visited { color: #900000; }       
+        h1 { text-transform:uppercase; font-size: 18pt; } 
+        p { margin-left:1cm; margin-right:1cm; } 
+        .cmd { font-family:monospace; }
+        .file { font-family:monospace; }
+        .arg { text-transform:uppercase; font-family:monospace; font-style: italic; }
+        .opt { font-family:monospace; font-weight: bold;  }
+        .manref { font-family:monospace; }
+        .option .optdesc { margin-left:2cm; }
+      </style>
+    </head>
+    <body>
+      <h1>Name</h1>
+      <p><xsl:value-of select="@name"/>
+        <xsl:if test="string-length(@desc) &gt; 0"> - <xsl:value-of select="@desc"/></xsl:if>
+      </p>
+      <xsl:apply-templates />
+    </body>
+  </html>
+</xsl:template>
+
+<xsl:template match="p">
+ <p>
+  <xsl:apply-templates/>
+ </p>
+</xsl:template>
+
+<xsl:template match="cmd">
+ <p class="cmd">
+  <xsl:apply-templates/>
+ </p>
+</xsl:template>
+
+<xsl:template match="arg">
+  <span class="arg"><xsl:apply-templates/></span>
+</xsl:template>
+
+<xsl:template match="opt">
+  <span class="opt"><xsl:apply-templates/></span>
+</xsl:template>
+
+<xsl:template match="file">
+  <span class="file"><xsl:apply-templates/></span>
+</xsl:template>
+
+<xsl:template match="optdesc">
+  <div class="optdesc">
+    <xsl:apply-templates/>
+  </div>
+</xsl:template>
+
+<xsl:template match="synopsis">
+  <h1>Synopsis</h1>
+  <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="seealso">
+  <h1>Synopsis</h1>
+  <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="description">
+  <h1>Description</h1>
+  <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="options">
+  <h1>Options</h1>
+  <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="section">
+  <h1><xsl:value-of select="@name"/></h1>
+  <xsl:apply-templates/>
+</xsl:template>
+
+<xsl:template match="option">
+  <div class="option"><xsl:apply-templates/></div>
+</xsl:template>
+
+<xsl:template match="manref">
+  <xsl:choose>
+    <xsl:when test="string-length(@href) &gt; 0">
+    <a class="manref"><xsl:attribute name="href"><xsl:value-of select="@href"/></xsl:attribute><xsl:value-of select="@name"/>(<xsl:value-of select="@section"/>)</a>
+    </xsl:when>
+    <xsl:otherwise>
+    <span class="manref"><xsl:value-of select="@name"/>(<xsl:value-of select="@section"/>)</span>
+    </xsl:otherwise>
+  </xsl:choose>
+</xsl:template>
+
+<xsl:template match="url">
+  <a class="url"><xsl:attribute name="href"><xsl:value-of select="@href"/></xsl:attribute><xsl:value-of select="@href"/></a>
+</xsl:template>
+
+</xsl:stylesheet>
-- 
cgit 


From 7fdc1ee0838d3c55e29d8f44f2919a60f9415e56 Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Mon, 5 Nov 2007 23:56:00 +0000
Subject: add a couple of more man pages

git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@2024 fefdeb5f-60dc-0310-8127-8f9354f1896f
---
 man/Makefile.am           |  72 ++++++++++++++++++++-
 man/esdcompat.1.xml.in    |  91 ++++++++++++++++++++++++++
 man/pacat.1.xml.in        | 160 ++++++++++++++++++++++++++++++++++++++++++++++
 man/pacmd.1.xml.in        |  52 +++++++++++++++
 man/pactl.1.xml.in        | 145 +++++++++++++++++++++++++++++++++++++++++
 man/paplay.1.xml.in       | 129 +++++++++++++++++++++++++++++++++++++
 man/pax11publish.1.xml.in | 153 ++++++++++++++++++++++++++++++++++++++++++++
 man/pulseaudio.1.xml.in   |  69 +++++++++++++++++++-
 8 files changed, 867 insertions(+), 4 deletions(-)
 create mode 100644 man/esdcompat.1.xml.in
 create mode 100644 man/pacat.1.xml.in
 create mode 100644 man/pacmd.1.xml.in
 create mode 100644 man/pactl.1.xml.in
 create mode 100644 man/paplay.1.xml.in
 create mode 100644 man/pax11publish.1.xml.in

(limited to 'man')

diff --git a/man/Makefile.am b/man/Makefile.am
index b701a2ea..a3427aa7 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -22,10 +22,22 @@ pulseconfdir=$(sysconfdir)/pulse
 if BUILD_MANPAGES
 
 man_MANS = \
-	pulseaudio.1
+	pulseaudio.1 \
+	esdcompat.1 \
+	pax11publish.1 \
+	paplay.1 \
+	pacat.1 \
+	pacmd.1 \
+	pactl.1
 
 noinst_DATA = \
-	pulseaudio.1.xml
+	pulseaudio.1.xml \
+	esdcompat.1.xml \
+	pax11publish.1.xml \
+	paplay.1.xml \
+	pacat.1.xml \
+	pacmd.1.xml \
+	pactl.1.xml
 
 CLEANFILES = \
 	$(noinst_DATA)
@@ -35,6 +47,36 @@ pulseaudio.1.xml: pulseaudio.1.xml.in Makefile
 	    -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
             -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
 
+esdcompat.1.xml: esdcompat.1.xml.in Makefile
+	sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \
+	    -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+            -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
+pax11publish.1.xml: pax11publish.1.xml.in Makefile
+	sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \
+	    -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+            -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
+paplay.1.xml: paplay.1.xml.in Makefile
+	sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \
+	    -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+            -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
+pacat.1.xml: pacat.1.xml.in Makefile
+	sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \
+	    -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+            -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
+pacmd.1.xml: pacmd.1.xml.in Makefile
+	sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \
+	    -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+            -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
+pactl.1.xml: pactl.1.xml.in Makefile
+	sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \
+	    -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+            -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
 if USE_XMLTOMAN
 
 CLEANFILES += \
@@ -43,6 +85,24 @@ CLEANFILES += \
 pulseaudio.1: pulseaudio.1.xml Makefile
 	xmltoman $< > $@
 
+esdcompat.1: esdcompat.1.xml Makefile
+	xmltoman $< > $@
+
+pax11publish.1: pax11publish.1.xml Makefile
+	xmltoman $< > $@
+
+paplay.1: paplay.1.xml Makefile
+	xmltoman $< > $@
+
+pacat.1: pacat.1.xml Makefile
+	xmltoman $< > $@
+
+pacmd.1: pacmd.1.xml Makefile
+	xmltoman $< > $@
+
+pactl.1: pactl.1.xml Makefile
+	xmltoman $< > $@
+
 xmllint: $(noinst_DATA)
 	for f in $(noinst_DATA) ; do \
 			xmllint --noout --valid "$$f" || exit 1 ; \
@@ -54,7 +114,13 @@ endif
 
 EXTRA_DIST = \
 	$(man_MANS) \
-	pulseaudio.1.xml.in
+	pulseaudio.1.xml.in \
+	esdcompat.1.xml.in \
+	pax11publish.1.xml.in \
+	paplay.1.xml.in \
+	pacat.1.xml.in \
+	pacmd.1.xml.in \
+	pactl.1.xml.in \
 	xmltoman.css \
 	xmltoman.xsl \
 	xmltoman.dtd
diff --git a/man/esdcompat.1.xml.in b/man/esdcompat.1.xml.in
new file mode 100644
index 00000000..864dc5db
--- /dev/null
+++ b/man/esdcompat.1.xml.in
@@ -0,0 +1,91 @@
+<?xml version="1.0"?><!--*-nxml-*-->
+<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
+<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
+
+<!-- $Id$ -->
+
+<!--
+This file is part of PulseAudio.
+
+PulseAudio is free software; you can redistribute it and/or modify it
+under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation; either version 2.1 of the
+License, or (at your option) any later version.
+
+PulseAudio is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with PulseAudio; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+USA.
+-->
+
+<manpage name="esdcompat" section="1" desc="PulseAudio ESD wrapper script">
+
+  <synopsis>
+    <cmd>esdcompat [<arg>options</arg>]</cmd>
+    <cmd>esdcompat <opt>--help</opt></cmd>
+    <cmd>esdcompat <opt>--version</opt></cmd>
+  </synopsis>
+
+  <description>
+    <p><file>esdcompat</file> is a compatiblity script that takes the
+    same arguments as the ESD sound daemon <manref name="esd"
+    section="1"/>, but uses them to start a the PulseAudio sound server with the appropriate parameters. It is
+    required to make PulseAudio a drop-in replacement for esd, i.e. it
+    can be used to make <manref name="gnome-session" section="1"/>
+    start up PulseAudio instead of esd.</p>
+
+    <p>It is recommended to make <file>esd</file> a symbolic link to this script.</p>
+  </description>
+
+  <options>
+
+    <option>
+      <p><opt>-h | --help</opt></p>
+
+      <optdesc><p>Show help.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--version</opt></p>
+
+      <optdesc><p>Show version information.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-tcp | -promiscuous | -d | -b | -r | -as | -unix | -public | -terminate | -nobeeps | -trust | -port | -bind</opt></p>
+
+      <optdesc><p>These options understood by the original
+      <file>esd</file> are ignored by
+      <file>esdcompat</file>.</p></optdesc>
+
+    </option>
+
+
+    <option>
+      <p><opt>-spawnpid | -spawnfd</opt></p>
+
+      <optdesc><p>These internally used options understood by the
+      original <file>esd</file> are properly handled by
+      <file>esdcompat</file>, however are not to be used
+      manually.</p></optdesc>
+
+    </option>
+
+  </options>
+
+  <section name="Authors">
+    <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
+  </section>
+
+  <section name="See also">
+    <p>
+      <manref name="pulseaudio" section="1"/>, <manref name="esd" section="1"/>
+    </p>
+  </section>
+
+</manpage>
diff --git a/man/pacat.1.xml.in b/man/pacat.1.xml.in
new file mode 100644
index 00000000..35c7651b
--- /dev/null
+++ b/man/pacat.1.xml.in
@@ -0,0 +1,160 @@
+<?xml version="1.0"?><!--*-nxml-*-->
+<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
+<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
+
+<!-- $Id$ -->
+
+<!--
+This file is part of PulseAudio.
+
+PulseAudio is free software; you can redistribute it and/or modify it
+under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation; either version 2.1 of the
+License, or (at your option) any later version.
+
+PulseAudio is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with PulseAudio; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+USA.
+-->
+
+<manpage name="pacat" section="1" desc="Play back or record raw audio streams on a PulseAudio sound server">
+
+  <synopsis>
+    <cmd>pacat [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
+    <cmd>parec [<arg>options</arg>] [<arg>FILE</arg>]</cmd>
+    <cmd>paplay <opt>--help</opt></cmd>
+    <cmd>paplay <opt>--version</opt></cmd>
+  </synopsis>
+
+  <description>
+    <p><file>pacat</file> is a simple tool for playing back or
+    capturing raw audio files on a PulseAudio sound server.</p>
+  </description>
+
+  <options>
+
+    <option>
+      <p><opt>-h | --help</opt></p>
+
+      <optdesc><p>Show help.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--version</opt></p>
+
+      <optdesc><p>Show version information.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-r | --record</opt></p>
+
+      <optdesc><p>Capture raw audio data and write it to the specified file or to STDOUT if none is specified. If the tool is called under the name <file>parec</file> this is the default.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-p | --playback</opt></p>
+
+      <optdesc><p>Read raw audio data from the specified file or STDIN if none is specified, and play it back. If the tool is called under the name <file>pacat</file> this is the default.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-v | --verbose</opt></p>
+
+      <optdesc><p>Enable verbose operation. Dumps the current playback time to STDERR during playback/capturing.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-s | --server</opt><arg>=SERVER</arg></p>
+
+      <optdesc><p>Choose the server to connect to.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-d | --device</opt><arg>=SINKORSOURCE</arg></p>
+
+      <optdesc><p>Specify the symbolic name of the sink/source to play/record this stream on/from.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-n | --client-name</opt><arg>=NAME</arg></p>
+
+      <optdesc><p>Specify the client name <file>paplay</file> shall pass to the server when connecting.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--stream-name</opt><arg>=NAME</arg></p>
+
+      <optdesc><p>Specify the stream name <file>paplay</file> shall pass to the server when creating the stream.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--volume</opt><arg>=VOLUME</arg></p>
+
+      <optdesc><p>Specify the initial playback volume to use. Choose a value between 0 (silent) and 65536 (100% volume).</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--rate</opt><arg>=SAMPLERATE</arg></p>
+
+      <optdesc><p>Capture or play back audio with the specified sample rate. Defaults to 44100 Hz.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--format</opt><arg>=FORMAT</arg></p>
+
+      <optdesc><p>Capture or play back audio with the specified sample
+      format. Specify one of <arg>u8</arg>, <arg>s16le</arg>,
+      <arg>s16be</arg>, <arg>float32le</arg>, <arg>float32be</arg>,
+      <arg>ulaw</arg>, <arg>alaw</arg>. Depending on the endianess of
+      the CPU the formats <arg>s16ne</arg>, <arg>s16re</arg>,
+      <arg>float32ne</arg>, <arg>float32re</arg> (for native,
+      resp. reverse endian) are available as aliases. Defaults to
+      s16ne.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--channels</opt><arg>=CHANNELS</arg></p>
+
+      <optdesc><p>Capture or play back audio with the specified number
+      of channels. If more than two channels are used it is
+      recommended to use the <opt>--channel-map</opt> option
+      below. Defaults to 2.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--channel-map</opt><arg>=CHANNELMAP</arg></p>
+
+      <optdesc><p>Explicitly choose a channel map when playing back
+      this stream. The argument should be a comma separated list of
+      channel names: <arg>front-left</arg>, <arg>front-right</arg>,
+      <arg>mono</arg>, <arg>front-center</arg>, <arg>rear-left</arg>,
+      <arg>rear-right</arg>, <arg>rear-center</arg>, <arg>lfe</arg>,
+      <arg>front-left-of-center</arg>,
+      <arg>front-right-of-center</arg>, <arg>side-left</arg>,
+      <arg>side-right</arg>, <arg>top-center</arg>,
+      <arg>top-front-center</arg>, <arg>top-front-left</arg>,
+      <arg>top-front-right</arg>, <arg>top-rear-left</arg>,
+      <arg>top-rear-right</arg>, <arg>top-rear-center</arg>, or any of
+      the 32 auxiliary channel names <arg>aux0</arg> to
+      <arg>aux31</arg>.</p></optdesc>
+    </option>
+
+  </options>
+
+  <section name="Authors">
+    <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
+  </section>
+
+  <section name="See also">
+    <p>
+      <manref name="pulseaudio" section="1"/>, <manref name="paplay" section="1"/>
+    </p>
+  </section>
+
+</manpage>
diff --git a/man/pacmd.1.xml.in b/man/pacmd.1.xml.in
new file mode 100644
index 00000000..b760ba0e
--- /dev/null
+++ b/man/pacmd.1.xml.in
@@ -0,0 +1,52 @@
+<?xml version="1.0"?><!--*-nxml-*-->
+<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
+<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
+
+<!-- $Id$ -->
+
+<!--
+This file is part of PulseAudio.
+
+PulseAudio is free software; you can redistribute it and/or modify it
+under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation; either version 2.1 of the
+License, or (at your option) any later version.
+
+PulseAudio is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with PulseAudio; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+USA.
+-->
+
+<manpage name="pacmd" section="1" desc="Reconfigure a PulseAudio sound server during runtime">
+
+  <synopsis>
+    <cmd>pacmd</cmd>
+  </synopsis>
+
+  <description>
+    <p>This tool can be used to introspect or reconfigure a running
+    PulseAudio sound server during runtime. It connects to the sound
+    server and offers a simple live shell that can be used to enter
+    the commands also understood in the <file>default.pa</file>
+    configuration scripts.</p>
+
+    <p>This program takes no command line options.</p>
+  </description>
+
+  <section name="Authors">
+    <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
+  </section>
+
+  <section name="See also">
+    <p>
+      <manref name="pulseaudio" section="1"/>, <manref name="pactl" section="1"/>, <manref name="default.pa" section="5"/>
+    </p>
+  </section>
+
+</manpage>
diff --git a/man/pactl.1.xml.in b/man/pactl.1.xml.in
new file mode 100644
index 00000000..0b7b9a78
--- /dev/null
+++ b/man/pactl.1.xml.in
@@ -0,0 +1,145 @@
+<?xml version="1.0"?><!--*-nxml-*-->
+<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
+<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
+
+<!-- $Id$ -->
+
+<!--
+This file is part of PulseAudio.
+
+PulseAudio is free software; you can redistribute it and/or modify it
+under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation; either version 2.1 of the
+License, or (at your option) any later version.
+
+PulseAudio is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with PulseAudio; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+USA.
+-->
+
+<manpage name="pactl" section="1" desc="Control a running PulseAudio sound server">
+
+  <synopsis>
+    <cmd>pulseaudio [<arg>options</arg>] stat</cmd>
+    <cmd>pulseaudio [<arg>options</arg>] list</cmd>
+    <cmd>pulseaudio [<arg>options</arg>] exit</cmd>
+    <cmd>pulseaudio [<arg>options</arg>] upload-sample <arg>FILENAME</arg> [<arg>NAME</arg>]</cmd>
+    <cmd>pulseaudio [<arg>options</arg>] play-sample <arg>NAME</arg> [<arg>SINK</arg>]</cmd>
+    <cmd>pulseaudio [<arg>options</arg>] remove-sample <arg>NAME</arg></cmd>
+    <cmd>pulseaudio [<arg>options</arg>] move-sink-input <arg>ID</arg> <arg>SINK</arg></cmd>
+    <cmd>pulseaudio [<arg>options</arg>] move-source-input <arg>ID</arg> <arg>SOURCE</arg></cmd>
+    <cmd>pulseaudio [<arg>options</arg>] load-module <arg>NAME</arg> [<arg>ARGUMENTS ...</arg>]</cmd>
+    <cmd>pulseaudio [<arg>options</arg>] unload-module <arg>ID</arg></cmd>
+    <cmd>pulseaudio [<arg>options</arg>] suspend-sink [<arg>SINK</arg>] <arg>1|0</arg></cmd>
+    <cmd>pulseaudio [<arg>options</arg>] suspend-source [<arg>SOURCE</arg>] <arg>1|0</arg></cmd>
+    <cmd>pulseaudio <opt>--help</opt></cmd>
+    <cmd>pulseaudio <opt>--version</opt></cmd>
+  </synopsis>
+
+  <description>
+    <p>PulseAudio is a networked low-latency sound server for Linux, POSIX and Windows systems.</p>
+  </description>
+
+  <options>
+
+    <option>
+      <p><opt>-h | --help</opt></p>
+
+      <optdesc><p>Show help.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--version</opt></p>
+
+      <optdesc><p>Show version information.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-s | --server</opt><arg>=SERVER</arg></p>
+
+      <optdesc><p>Choose the server to connect to.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-n | --client-name</opt><arg>=NAME</arg></p>
+
+      <optdesc><p>Specify the client name <file>pactl</file> shall pass to the server when connecting.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>stat</opt></p>
+
+      <optdesc><p>Dump a few statistics about the PulseAudio daemon.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>list</opt></p>
+
+      <optdesc><p>Dump all currently loaded modules, available sinks, sources, streams and clients.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>exit</opt></p>
+
+      <optdesc><p>Asks the PulseAudio server to terminate.</p></optdesc>
+    </option>
+
+
+    <option>
+      <p><opt>upload-sample</opt> <arg>FILENAME</arg> [<arg>NAME</arg>]</p>
+
+      <optdesc><p>Upload a sound from the specified audio file into
+      the sample cache. The file types supported are those understood
+      by <file>libsndfile</file>. The sample in the cache is named
+      after the audio file, unless the name is explicitly
+      specified.</p></optdesc>
+
+    </option>
+
+    <option>
+      <p><opt>play-sample</opt> <arg>NAME</arg> [<arg>SINK</arg>]</p>
+
+      <optdesc><p>Play the specified sample from the sample cache. It
+      is played on the default sink, unless the symbolic name or the
+      numerical index of the sink to play it on is
+      specified.</p></optdesc>
+
+    </option>
+
+    <option>
+      <p><opt>remove-sample</opt> <arg>NAME</arg></p>
+
+      <optdesc><p>Remove the specified sample from the sample cache.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>move-sink-input</opt> <arg>ID</arg> <arg>SINK</arg></p>
+
+      <optdesc><p>Move the specified playback stream (identified by its numerical index) to the specified sink (identified by its symbolic name or numerical index).</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>move-source-output</opt> <arg>ID</arg> <arg>SOURCE</arg></p>
+
+      <optdesc><p>Move the specified recording stream (identified by its numerical index) to the specified source (identified by its symbolic name or numerical index).</p></optdesc>
+    </option>
+
+  </options>
+
+  <section name="Authors">
+    <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
+  </section>
+
+  <section name="See also">
+    <p>
+      <manref name="pulseaudio" section="1"/>, <manref name="pacmd" section="1"/>
+    </p>
+  </section>
+
+</manpage>
diff --git a/man/paplay.1.xml.in b/man/paplay.1.xml.in
new file mode 100644
index 00000000..bab45dc3
--- /dev/null
+++ b/man/paplay.1.xml.in
@@ -0,0 +1,129 @@
+<?xml version="1.0"?><!--*-nxml-*-->
+<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
+<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
+
+<!-- $Id$ -->
+
+<!--
+This file is part of PulseAudio.
+
+PulseAudio is free software; you can redistribute it and/or modify it
+under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation; either version 2.1 of the
+License, or (at your option) any later version.
+
+PulseAudio is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with PulseAudio; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+USA.
+-->
+
+<manpage name="paplay" section="1" desc="Play back audio files on a PulseAudio sound server">
+
+  <synopsis>
+    <cmd>paplay [<arg>options</arg>] <arg>FILE</arg></cmd>
+    <cmd>paplay <opt>--help</opt></cmd>
+    <cmd>paplay <opt>--version</opt></cmd>
+  </synopsis>
+
+  <description>
+    <p><file>paplay</file> is a simple tool for playing back audio
+    files on a PulseAudio sound server. It understands all audio file
+    formats supported by <file>libsndfile</file>.</p>
+  </description>
+
+  <options>
+
+    <option>
+      <p><opt>-h | --help</opt></p>
+
+      <optdesc><p>Show help.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--version</opt></p>
+
+      <optdesc><p>Show version information.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-v | --verbose</opt></p>
+
+      <optdesc><p>Enable verbose operation. Dumps the current playback time to STDERR during playback.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-s | --server</opt><arg>=SERVER</arg></p>
+
+      <optdesc><p>Choose the server to connect to.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-d | --device</opt><arg>=SINK</arg></p>
+
+      <optdesc><p>Specify the symbolic name of the sink to play this file on.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-n | --client-name</opt><arg>=NAME</arg></p>
+
+      <optdesc><p>Specify the client name <file>paplay</file> shall pass to the server when connecting.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--stream-name</opt><arg>=NAME</arg></p>
+
+      <optdesc><p>Specify the stream name <file>paplay</file> shall pass to the server when creating the stream.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--volume</opt><arg>=VOLUME</arg></p>
+
+      <optdesc><p>Specify the initial playback volume to use. Choose a value between 0 (silent) and 65536 (100% volume).</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--channel-map</opt><arg>=CHANNELMAP</arg></p>
+
+      <optdesc><p>Explicitly choose a channel map when playing back
+      this stream. The argument should be a comma separated list of
+      channel names: <arg>front-left</arg>, <arg>front-right</arg>,
+      <arg>mono</arg>, <arg>front-center</arg>, <arg>rear-left</arg>,
+      <arg>rear-right</arg>, <arg>rear-center</arg>, <arg>lfe</arg>,
+      <arg>front-left-of-center</arg>,
+      <arg>front-right-of-center</arg>, <arg>side-left</arg>,
+      <arg>side-right</arg>, <arg>top-center</arg>,
+      <arg>top-front-center</arg>, <arg>top-front-left</arg>,
+      <arg>top-front-right</arg>, <arg>top-rear-left</arg>,
+      <arg>top-rear-right</arg>, <arg>top-rear-center</arg>, or any of
+      the 32 auxiliary channel names <arg>aux0</arg> to
+      <arg>aux31</arg>.</p></optdesc>
+    </option>
+
+  </options>
+
+  <section name="Limitations">
+
+    <p>Due to a limitation in <file>libsndfile</file>
+    <file>paplay</file> currently does not always set the correct channel
+    mapping for playback of multichannel (i.e. surround) audio files, even if the channel mapping information is
+    available in the audio file.</p>
+
+  </section>
+
+  <section name="Authors">
+    <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
+  </section>
+
+  <section name="See also">
+    <p>
+      <manref name="pulseaudio" section="1"/>, <manref name="pacat" section="1"/>
+    </p>
+  </section>
+
+</manpage>
diff --git a/man/pax11publish.1.xml.in b/man/pax11publish.1.xml.in
new file mode 100644
index 00000000..1e3a1f01
--- /dev/null
+++ b/man/pax11publish.1.xml.in
@@ -0,0 +1,153 @@
+<?xml version="1.0"?><!--*-nxml-*-->
+<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
+<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
+
+<!-- $Id$ -->
+
+<!--
+This file is part of PulseAudio.
+
+PulseAudio is free software; you can redistribute it and/or modify it
+under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation; either version 2.1 of the
+License, or (at your option) any later version.
+
+PulseAudio is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with PulseAudio; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+USA.
+-->
+
+<manpage name="pax11publish" section="1" desc="PulseAudio X11 Credential Utility">
+
+  <synopsis>
+    <cmd>pax11publish <opt>-h</opt></cmd>
+    <cmd>pax11publish [<arg>options</arg>] [<opt>-d</opt>]</cmd>
+    <cmd>pax11publish [<arg>options</arg>] <opt>-e</opt></cmd>
+    <cmd>pax11publish [<arg>options</arg>] <opt>-i</opt></cmd>
+    <cmd>pax11publish [<arg>options</arg>] <opt>-r</opt></cmd>
+  </synopsis>
+
+  <description>
+    <p>The <file>pax11publish</file> utility can be used to dump or
+    manipulate the PulseAudio server credentials that can be stored as
+    properties on the X11 root window.</p>
+
+    <p>Please note that the loadable module
+    <file>module-x11-publish</file> exports the same information
+    directly from the PulseAudio sound server, and should in most
+    cases be used in preference over this tool.</p>
+
+    <p>Use the following command to dump the raw
+    PulseAudio-specific data that is stored in your X11 root
+    window:</p>
+
+    <p>xprop -root | grep ^PULSE_</p>
+
+  </description>
+
+  <options>
+
+    <option>
+      <p><opt>-h</opt></p>
+
+      <optdesc><p>Show help.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-d</opt></p>
+
+      <optdesc><p>Read the PulseAudio server credentials currently set
+      on the X11 root window and dump them in a human readable form. This reads the
+      PULSE_SERVER, PULSE_SINK, PULSE_SOURCE and PULSE_COOKIE
+      properties.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-i</opt></p>
+      <optdesc><p>Similar to <opt>-d</opt>, however dumps them in a
+      Bourne shell compatible format so they may be used together with
+      the <file>eval</file> shell command to set the $PULSE_SERVER,
+      $PULSE_SINK, $PULSE_SOURCE environment variables. Also reads the
+      authentication cookie from the root window and stores it in
+      <file>~/.pulse-cookie</file>. </p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-e</opt></p>
+
+      <optdesc><p>Export the currently locally used sound server,
+      sink, source configuration to the X11 root window. This takes
+      the data from the $PULSE_SERVER, $PULSE_SINK, $PULSE_SOURCE
+      environment variables and combines them with the data from
+      <file>~/.pulse/client.conf</file> (or
+      <file>@pulseconfdir@/client.conf</file> if that file does not
+      exist). If specific options are passed on the command line
+      (<opt>-S</opt>, <opt>-O</opt>, <opt>-I</opt>, <opt>-c</opt>, see
+      below), they take precedence. Also uploads the local
+      authentication cookie <file>~/.pulse-cookie</file> to the X11
+      server.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-r</opt></p>
+
+      <optdesc><p>Removes the configured PulseAudio configuration from the X11 root window.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-D</opt> <arg>DISPLAY</arg></p>
+
+      <optdesc><p>Connect to the specified X11 display, instead of the default one configured in $DISPLAY.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-S</opt> <arg>SERVER</arg></p>
+
+      <optdesc><p>Only valid for <opt>-e</opt>: export the specified
+      PulseAudio server as default to the X11 display instead of the
+      one configured via local configuration.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-O</opt> <arg>SINK</arg></p>
+
+      <optdesc><p>Only valid for <opt>-e</opt>: export the specified
+      sink as default sink to the X11 display instead of the one
+      configured via local configuration.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-I</opt> <arg>SOURCE</arg></p>
+
+      <optdesc><p>Only valid for <opt>-e</opt>: export the specified
+      source as default to the X11 display instead of the one
+      configured via local configuration.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-c</opt> <arg>FILE</arg></p>
+
+      <optdesc><p>Only valid for <opt>-e</opt>: export the PulseAudio
+      authentication cookie stored in the specified file to the X11
+      display instead of the one stored in <file>~/.pulse-cookie</file>.</p></optdesc>
+    </option>
+
+  </options>
+
+  <section name="Authors">
+    <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
+  </section>
+
+  <section name="See also">
+    <p>
+      <manref name="pulseaudio" section="1"/>, <manref name="xprop" section="1"/>
+    </p>
+  </section>
+
+</manpage>
diff --git a/man/pulseaudio.1.xml.in b/man/pulseaudio.1.xml.in
index b30f4484..1f53a60b 100644
--- a/man/pulseaudio.1.xml.in
+++ b/man/pulseaudio.1.xml.in
@@ -28,6 +28,7 @@ USA.
   <synopsis>
     <cmd>pulseaudio [<arg>options</arg>]</cmd>
     <cmd>pulseaudio <opt>--help</opt></cmd>
+    <cmd>pulseaudio <opt>--version</opt></cmd>
     <cmd>pulseaudio <opt>--dump-conf</opt></cmd>
     <cmd>pulseaudio <opt>--dump-modules</opt></cmd>
     <cmd>pulseaudio <opt>--dump-resample-methods</opt></cmd>
@@ -363,7 +364,73 @@ USA.
   </section>
 
   <section name="Real-time and high-priority scheduling">
-    Blablub
+    <p>To minimize the risk of drop-outs during playback it is
+    recommended to run PulseAudio with real-time scheduling if the
+    underlying platform supports it. This decouples the scheduling
+    latency of the PulseAudio daemon from the system load and is thus
+    the best way to make sure that PulseAudio always gets CPU time
+    when it needs it to refill the hardware playback
+    buffers. Unfortunately this is a security risk on most systems,
+    since PulseAudio runs as user process, and giving realtime
+    scheduling priviliges to a user process always comes with the risk
+    that the user misuses it to lock up the system -- which is
+    possible since making a process real-time effectively disables
+    preemption.</p>
+
+    <p>To minimize the risk PulseAudio by default does not enable
+    real-time scheduling. It is however recommended to enable it
+    on trusted systems. To do that start PulseAudio with
+    <opt>--realtime</opt> (see above) or enabled the appropriate option in
+    <file>daemon.conf</file>. Since acquiring realtime scheduling is a
+    priviliged operation on most systems, some special changes to the
+    system configuration need to be made to allow them to the calling
+    user. Two options are available:</p>
+
+    <p>On newer Linux systems the system resource limit RLIMIT_RTPRIO
+    (see <manref name="setrlimit" section="2"/> for more information)
+    can be used to allow specific users to acquire real-time
+    scheduling. This can be configured in
+    <file>/etc/security/limits.conf</file>, a resource limit of 9 is recommended.</p>
+
+    <p>Alternatively, the SUID root bit can be set for the PulseAudio
+    binary. Then, the daemon will drop root priviliges immediately on
+    startup, however retain the CAP_NICE capability (on systems that
+    support it), but only if the calling user is a member of the
+    <arg>pulse-rt</arg> group (see above). For all other users all
+    capababilities are dropped immediately. The advantage of this
+    solution is that the real-time priviliges are only granted to the
+    PulseAudio daemon -- not to all the user's processes.</p>
+
+    <p>Alternatively, if the risk of locking up the machine is
+    considered too big to enable real-time scheduling, high-priority
+    scheduling can be enabled instead (i.e. negative nice level). This
+    can be enabled by passing <opt>--high-priority</opt> (see above)
+    when starting PulseAudio and may also be enabled with the
+    approriate option in <file>daemon.conf</file>. Negative nice
+    levels can only be enabled when the appropriate resource limit
+    RLIMIT_NICE is set (see <manref name="setrlimit" section="2"/> for
+    more information), possibly configured in
+    <file>/etc/security/limits.conf</file>. A resource limit of 31
+    (corresponding with nice level -11) is recommended.</p>
+  </section>
+
+  <section name="Environment variables">
+
+    <p>The PulseAudio client libraries check for the existance of the
+    following environment variables and change their local configuration accordingly:</p>
+
+    <p><arg>$PULSE_SERVER</arg>: the server string specifying the server to connect to when a client asks for a sound server connection and doesn't explicitly ask for a specific server.</p>
+
+    <p><arg>$PULSE_SINK</arg>: the symbolic name of the sink to connect to when a client creates a playback stream and doesn't explicitly ask for a specific sink.</p>
+
+    <p><arg>$PULSE_SOURCE</arg>: the symbolic name of the source to connect to when a client creates a record stream and doesn't explicitly ask for a specific source.</p>
+
+    <p><arg>$PULSE_BINARY</arg>: path of PulseAudio executable to run when server auto-spawning is used.</p>
+
+    <p><arg>$PULSE_CLIENTCONFIG</arg>: path of file that shall be read instead of <file>client.conf</file> (see above) for client configuration.</p>
+
+    <p>These environment settings take precedence -- if set -- over the configuration settings from <file>client.conf</file> (see above).</p>
+
   </section>
 
   <section name="Authors">
-- 
cgit 


From 5dbab0b23aa373f5eb61faf2b0cbae24f05570fa Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Tue, 6 Nov 2007 00:21:20 +0000
Subject: complete pactl man page

git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@2026 fefdeb5f-60dc-0310-8127-8f9354f1896f
---
 man/pactl.1.xml.in | 76 +++++++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 61 insertions(+), 15 deletions(-)

(limited to 'man')

diff --git a/man/pactl.1.xml.in b/man/pactl.1.xml.in
index 0b7b9a78..d30d5f7c 100644
--- a/man/pactl.1.xml.in
+++ b/man/pactl.1.xml.in
@@ -26,24 +26,26 @@ USA.
 <manpage name="pactl" section="1" desc="Control a running PulseAudio sound server">
 
   <synopsis>
-    <cmd>pulseaudio [<arg>options</arg>] stat</cmd>
-    <cmd>pulseaudio [<arg>options</arg>] list</cmd>
-    <cmd>pulseaudio [<arg>options</arg>] exit</cmd>
-    <cmd>pulseaudio [<arg>options</arg>] upload-sample <arg>FILENAME</arg> [<arg>NAME</arg>]</cmd>
-    <cmd>pulseaudio [<arg>options</arg>] play-sample <arg>NAME</arg> [<arg>SINK</arg>]</cmd>
-    <cmd>pulseaudio [<arg>options</arg>] remove-sample <arg>NAME</arg></cmd>
-    <cmd>pulseaudio [<arg>options</arg>] move-sink-input <arg>ID</arg> <arg>SINK</arg></cmd>
-    <cmd>pulseaudio [<arg>options</arg>] move-source-input <arg>ID</arg> <arg>SOURCE</arg></cmd>
-    <cmd>pulseaudio [<arg>options</arg>] load-module <arg>NAME</arg> [<arg>ARGUMENTS ...</arg>]</cmd>
-    <cmd>pulseaudio [<arg>options</arg>] unload-module <arg>ID</arg></cmd>
-    <cmd>pulseaudio [<arg>options</arg>] suspend-sink [<arg>SINK</arg>] <arg>1|0</arg></cmd>
-    <cmd>pulseaudio [<arg>options</arg>] suspend-source [<arg>SOURCE</arg>] <arg>1|0</arg></cmd>
-    <cmd>pulseaudio <opt>--help</opt></cmd>
-    <cmd>pulseaudio <opt>--version</opt></cmd>
+    <cmd>pactl [<arg>options</arg>] stat</cmd>
+    <cmd>pactl [<arg>options</arg>] list</cmd>
+    <cmd>pactl [<arg>options</arg>] exit</cmd>
+    <cmd>pactl [<arg>options</arg>] upload-sample <arg>FILENAME</arg> [<arg>NAME</arg>]</cmd>
+    <cmd>pactl [<arg>options</arg>] play-sample <arg>NAME</arg> [<arg>SINK</arg>]</cmd>
+    <cmd>pactl [<arg>options</arg>] remove-sample <arg>NAME</arg></cmd>
+    <cmd>pactl [<arg>options</arg>] move-sink-input <arg>ID</arg> <arg>SINK</arg></cmd>
+    <cmd>pactl [<arg>options</arg>] move-source-input <arg>ID</arg> <arg>SOURCE</arg></cmd>
+    <cmd>pactl [<arg>options</arg>] load-module <arg>NAME</arg> [<arg>ARGUMENTS ...</arg>]</cmd>
+    <cmd>pactl [<arg>options</arg>] unload-module <arg>ID</arg></cmd>
+    <cmd>pactl [<arg>options</arg>] suspend-sink [<arg>SINK</arg>] <arg>1|0</arg></cmd>
+    <cmd>pactl [<arg>options</arg>] suspend-source [<arg>SOURCE</arg>] <arg>1|0</arg></cmd>
+    <cmd>pactl <opt>--help</opt></cmd>
+    <cmd>pactl <opt>--version</opt></cmd>
   </synopsis>
 
   <description>
-    <p>PulseAudio is a networked low-latency sound server for Linux, POSIX and Windows systems.</p>
+    <p><file>pactl</file> can be used to issue control commands to the PulseAudio sound server.</p>
+
+    <p><file>pactl</file> only exposes a subset of the available operations. For the full set use the <manref name="pacmd" section="1"/>.</p>
   </description>
 
   <options>
@@ -130,6 +132,50 @@ USA.
       <optdesc><p>Move the specified recording stream (identified by its numerical index) to the specified source (identified by its symbolic name or numerical index).</p></optdesc>
     </option>
 
+    <option>
+      <p><opt>load-module</opt> <arg>NAME</arg> [<arg>ARGUMENTS ...</arg>]</p>
+
+      <optdesc><p>Load the specified module with the specified arguments into the running sound server. Prints the numeric index of the module just loaded to STDOUT. You can use it to unload the module later.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>unload-module</opt> <arg>ID</arg></p>
+
+      <optdesc><p>Unload the module instance identified by the specified numeric index.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>unload-module</opt> <arg>ID</arg></p>
+
+      <optdesc><p>Unload the module instance identified by the specified numeric index.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>suspend-sink</opt> <arg>SINK</arg> <arg>1|0</arg></p>
+
+      <optdesc><p>Suspend or resume the specified sink (which my be
+      specified either by its symbolic name, or by its numeric index),
+      depending whether 1 (suspend) or 0 (resume) is passed as last
+      argument. Suspending a sink will pause all playback. Depending
+      on the module implementing the sink this might have the effect
+      that the underlying device is closed, making it available for
+      other applications to use. The exact behaviour depends on the
+      module.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>suspend-source</opt> <arg>SOURCE</arg> <arg>1|0</arg></p>
+
+      <optdesc><p>Suspend or resume the specified source (which my be
+      specified either by its symbolic name, or by its numeric index),
+      depending whether 1 (suspend) or 0 (resume) is passed as last
+      argument. Suspending a source will pause all
+      capturing. Depending on the module implementing the source this
+      might have the effect that the underlying device is closed,
+      making it available for other applications to use. The exact
+      behaviour depends on the module.</p></optdesc>
+    </option>
+
   </options>
 
   <section name="Authors">
-- 
cgit 


From 1821f1f4994dfd0618ac290da54da683e7604f40 Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Wed, 7 Nov 2007 13:50:47 +0000
Subject: add man pages for padsp, pabrowse, pasuspender

git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@2027 fefdeb5f-60dc-0310-8127-8f9354f1896f
---
 man/Makefile.am          |  37 +++++++++++++++-
 man/pabrowse.1.xml.in    |  49 +++++++++++++++++++++
 man/padsp.1.xml.in       | 112 +++++++++++++++++++++++++++++++++++++++++++++++
 man/pasuspender.1.xml.in |  75 +++++++++++++++++++++++++++++++
 4 files changed, 271 insertions(+), 2 deletions(-)
 create mode 100644 man/pabrowse.1.xml.in
 create mode 100644 man/padsp.1.xml.in
 create mode 100644 man/pasuspender.1.xml.in

(limited to 'man')

diff --git a/man/Makefile.am b/man/Makefile.am
index a3427aa7..e5ce5530 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -28,7 +28,10 @@ man_MANS = \
 	paplay.1 \
 	pacat.1 \
 	pacmd.1 \
-	pactl.1
+	pactl.1 \
+	pasuspender.1 \
+	padsp.1 \
+	pabrowse.1
 
 noinst_DATA = \
 	pulseaudio.1.xml \
@@ -37,7 +40,10 @@ noinst_DATA = \
 	paplay.1.xml \
 	pacat.1.xml \
 	pacmd.1.xml \
-	pactl.1.xml
+	pactl.1.xml \
+	pasuspender.1.xml \
+	padsp.1.xml \
+	pabrowse.1.xml
 
 CLEANFILES = \
 	$(noinst_DATA)
@@ -77,6 +83,21 @@ pactl.1.xml: pactl.1.xml.in Makefile
 	    -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
             -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
 
+pasuspender.1.xml: pasuspender.1.xml.in Makefile
+	sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \
+	    -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+            -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
+padsp.1.xml: padsp.1.xml.in Makefile
+	sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \
+	    -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+            -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
+pabrowse.1.xml: pabrowse.1.xml.in Makefile
+	sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \
+	    -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+            -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
 if USE_XMLTOMAN
 
 CLEANFILES += \
@@ -103,6 +124,15 @@ pacmd.1: pacmd.1.xml Makefile
 pactl.1: pactl.1.xml Makefile
 	xmltoman $< > $@
 
+pasuspender.1: pasuspender.1.xml Makefile
+	xmltoman $< > $@
+
+padsp.1: padsp.1.xml Makefile
+	xmltoman $< > $@
+
+pabrowse.1: pabrowse.1.xml Makefile
+	xmltoman $< > $@
+
 xmllint: $(noinst_DATA)
 	for f in $(noinst_DATA) ; do \
 			xmllint --noout --valid "$$f" || exit 1 ; \
@@ -121,6 +151,9 @@ EXTRA_DIST = \
 	pacat.1.xml.in \
 	pacmd.1.xml.in \
 	pactl.1.xml.in \
+	pasuspender.1.xml.in \
+	padsp.1.xml.in \
+	pabrowse.1.xml.in \
 	xmltoman.css \
 	xmltoman.xsl \
 	xmltoman.dtd
diff --git a/man/pabrowse.1.xml.in b/man/pabrowse.1.xml.in
new file mode 100644
index 00000000..b539fb21
--- /dev/null
+++ b/man/pabrowse.1.xml.in
@@ -0,0 +1,49 @@
+<?xml version="1.0"?><!--*-nxml-*-->
+<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
+<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
+
+<!-- $Id$ -->
+
+<!--
+This file is part of PulseAudio.
+
+PulseAudio is free software; you can redistribute it and/or modify it
+under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation; either version 2.1 of the
+License, or (at your option) any later version.
+
+PulseAudio is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with PulseAudio; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+USA.
+-->
+
+<manpage name="pabrowse" section="1" desc="List PulseAudio sound servers on the network">
+
+  <synopsis>
+    <cmd>pabrowse</cmd>
+  </synopsis>
+
+  <description>
+    <p><file>pabrowse</file> lists all PulseAudio sound servers on the
+    local network that are being announced with Zeroconf/Avahi.</p>
+
+    <p>This program takes no command line arguments.</p>
+  </description>
+
+  <section name="Authors">
+    <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
+  </section>
+
+  <section name="See also">
+    <p>
+      <manref name="pulseaudio" section="1"/>, <manref name="avahi-daemon" section="8"/>
+    </p>
+  </section>
+
+</manpage>
diff --git a/man/padsp.1.xml.in b/man/padsp.1.xml.in
new file mode 100644
index 00000000..610a9602
--- /dev/null
+++ b/man/padsp.1.xml.in
@@ -0,0 +1,112 @@
+<?xml version="1.0"?><!--*-nxml-*-->
+<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
+<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
+
+<!-- $Id$ -->
+
+<!--
+This file is part of PulseAudio.
+
+PulseAudio is free software; you can redistribute it and/or modify it
+under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation; either version 2.1 of the
+License, or (at your option) any later version.
+
+PulseAudio is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with PulseAudio; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+USA.
+-->
+
+<manpage name="padsp" section="1" desc="PulseAudio OSS Wrapper">
+
+  <synopsis>
+    <cmd>padsp [<arg>options</arg>] <arg>PROGRAM</arg> [<arg>ARGUMENTS ...</arg>]</cmd>
+    <cmd>padsp <opt>-h</opt></cmd>
+  </synopsis>
+
+  <description>
+    <p><file>padsp</file> starts the specified program and
+    redirects its access to OSS compatible audio devices
+    (<file>/dev/dsp</file> and auxiliary devices) to a PulseAudio
+    sound server.</p>
+
+    <p><file>padsp</file> uses the $LD_PRELOAD environment variable
+    that is interpreted by <manref name="ld.so" section="8"/> and thus
+    does not work for SUID binaries and statically built
+    executables.</p>
+
+    <p>Equivalent to using <file>padsp</file> is starting an
+    application with $LD_PRELOAD set to
+    <file>libpulsedsp.so</file></p>
+  </description>
+
+  <options>
+
+    <option>
+      <p><opt>-h | --help</opt></p>
+
+      <optdesc><p>Show help.</p></optdesc>
+    </option>
+
+
+    <option>
+      <p><opt>-s</opt> <arg>SERVER</arg></p>
+
+      <optdesc><p>Set the PulseAudio server to connect to.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-n</opt> <arg>NAME</arg></p>
+
+      <optdesc><p>The client application name that shall be passed to the server when connecting.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-m</opt> <arg>NAME</arg></p>
+
+      <optdesc><p>The stream name that shall be passed to the server when creating a stream.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-M</opt></p>
+
+      <optdesc><p>Disable <file>/dev/mixer</file> emulation.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-S</opt></p>
+
+      <optdesc><p>Disable <file>/dev/sndstat</file> emulation.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-D</opt></p>
+
+      <optdesc><p>Disable <file>/dev/dsp</file> emulation.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-d</opt></p>
+
+      <optdesc><p>Enable debug output.</p></optdesc>
+    </option>
+
+  </options>
+
+  <section name="Authors">
+    <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
+  </section>
+
+  <section name="See also">
+    <p>
+      <manref name="pulseaudio" section="1"/>, <manref name="pasuspender" section="1"/>, <manref name="ld.so" section="8"/>
+    </p>
+  </section>
+
+</manpage>
diff --git a/man/pasuspender.1.xml.in b/man/pasuspender.1.xml.in
new file mode 100644
index 00000000..8a73343a
--- /dev/null
+++ b/man/pasuspender.1.xml.in
@@ -0,0 +1,75 @@
+<?xml version="1.0"?><!--*-nxml-*-->
+<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
+<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
+
+<!-- $Id$ -->
+
+<!--
+This file is part of PulseAudio.
+
+PulseAudio is free software; you can redistribute it and/or modify it
+under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation; either version 2.1 of the
+License, or (at your option) any later version.
+
+PulseAudio is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with PulseAudio; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+USA.
+-->
+
+<manpage name="pasuspender" section="1" desc="Temporarily suspend PulseAudio">
+
+  <synopsis>
+    <cmd>pasuspender [<arg>options</arg>] -- <arg>PROGRAM</arg> [<arg>ARGUMENTS ...</arg>]</cmd>
+    <cmd>pasuspender <opt>--help</opt></cmd>
+    <cmd>pasuspender <opt>--version</opt></cmd>
+  </synopsis>
+
+  <description>
+    <p><file>pasuspender</file> is a tool that can be used to tell a
+    local PulseAudio sound server to temporarily suspend access to the
+    audio devices, to allow other
+    applications access them directly. <file>pasuspender</file> will
+    suspend access to the audio devices, fork a child process, and
+    when the child process terminates, resume access again.</p>
+  </description>
+
+  <options>
+
+    <option>
+      <p><opt>-h | --help</opt></p>
+
+      <optdesc><p>Show help.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--version</opt></p>
+
+      <optdesc><p>Show version information.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>-s | --server=</opt><arg>SERVER</arg></p>
+
+      <optdesc><p>Specify the sound server to connect to.</p></optdesc>
+    </option>
+
+  </options>
+
+  <section name="Authors">
+    <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
+  </section>
+
+  <section name="See also">
+    <p>
+      <manref name="pulseaudio" section="1"/>, <manref name="padsp" section="1"/>, <manref name="pacmd" section="1"/>, <manref name="pactl" section="1"/>
+    </p>
+  </section>
+
+</manpage>
-- 
cgit 


From 445991287d541d15a9a446980e1485263ae55e10 Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Thu, 8 Nov 2007 22:30:33 +0000
Subject: add remaing man pages

git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@2029 fefdeb5f-60dc-0310-8127-8f9354f1896f
---
 man/Makefile.am                |  37 ++++-
 man/default.pa.5.xml.in        |  58 +++++++
 man/pacat.1.xml.in             |  32 ++--
 man/pulse-client.conf.5.xml.in | 115 +++++++++++++
 man/pulse-daemon.conf.5.xml.in | 366 +++++++++++++++++++++++++++++++++++++++++
 5 files changed, 590 insertions(+), 18 deletions(-)
 create mode 100644 man/default.pa.5.xml.in
 create mode 100644 man/pulse-client.conf.5.xml.in
 create mode 100644 man/pulse-daemon.conf.5.xml.in

(limited to 'man')

diff --git a/man/Makefile.am b/man/Makefile.am
index e5ce5530..0a355f95 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -31,7 +31,10 @@ man_MANS = \
 	pactl.1 \
 	pasuspender.1 \
 	padsp.1 \
-	pabrowse.1
+	pabrowse.1 \
+	pulse-daemon.conf.5 \
+	pulse-client.conf.5 \
+	default.pa.5
 
 noinst_DATA = \
 	pulseaudio.1.xml \
@@ -43,7 +46,10 @@ noinst_DATA = \
 	pactl.1.xml \
 	pasuspender.1.xml \
 	padsp.1.xml \
-	pabrowse.1.xml
+	pabrowse.1.xml \
+	pulse-daemon.conf.5.xml \
+	pulse-client.conf.5.xml \
+	default.pa.5.xml
 
 CLEANFILES = \
 	$(noinst_DATA)
@@ -98,6 +104,21 @@ pabrowse.1.xml: pabrowse.1.xml.in Makefile
 	    -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
             -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
 
+pulse-daemon.conf.5.xml: pulse-daemon.conf.5.xml.in Makefile
+	sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \
+	    -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+            -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
+pulse-client.conf.5.xml: pulse-client.conf.5.xml.in Makefile
+	sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \
+	    -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+            -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
+default.pa.5.xml: default.pa.5.xml.in Makefile
+	sed -e 's,@pulseconfdir\@,$(pulseconfdir),g' \
+	    -e 's,@PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+            -e 's,@PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
 if USE_XMLTOMAN
 
 CLEANFILES += \
@@ -133,6 +154,15 @@ padsp.1: padsp.1.xml Makefile
 pabrowse.1: pabrowse.1.xml Makefile
 	xmltoman $< > $@
 
+pulse-daemon.conf.5: pulse-daemon.conf.5.xml Makefile
+	xmltoman $< > $@
+
+pulse-client.conf.5: pulse-client.conf.5.xml Makefile
+	xmltoman $< > $@
+
+default.pa.5: default.pa.5.xml Makefile
+	xmltoman $< > $@
+
 xmllint: $(noinst_DATA)
 	for f in $(noinst_DATA) ; do \
 			xmllint --noout --valid "$$f" || exit 1 ; \
@@ -154,6 +184,9 @@ EXTRA_DIST = \
 	pasuspender.1.xml.in \
 	padsp.1.xml.in \
 	pabrowse.1.xml.in \
+	pulse-daemon.conf.5.xml.in \
+	pulse-client.conf.5.xml.in \
+	default.pa.5.xml.in \
 	xmltoman.css \
 	xmltoman.xsl \
 	xmltoman.dtd
diff --git a/man/default.pa.5.xml.in b/man/default.pa.5.xml.in
new file mode 100644
index 00000000..0f826db6
--- /dev/null
+++ b/man/default.pa.5.xml.in
@@ -0,0 +1,58 @@
+<?xml version="1.0"?><!--*-nxml-*-->
+<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
+<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
+
+<!-- $Id$ -->
+
+<!--
+This file is part of PulseAudio.
+
+PulseAudio is free software; you can redistribute it and/or modify it
+under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation; either version 2.1 of the
+License, or (at your option) any later version.
+
+PulseAudio is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with PulseAudio; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+USA.
+-->
+
+<manpage name="default.pa" section="5" desc="PulseAudio Sound Server Startup Script">
+
+  <synopsis>
+    <p><file>~/.pulse/default.pa</file></p>
+
+    <p><file>@pulseconfdir@/default.pa</file></p>
+  </synopsis>
+
+  <description>
+    <p>The PulseAudio sound server interprets the file
+    <file>~/.pulse/default.pa</file> on startup, and when that file
+    doesn't exist <file>@pulseconfdir@/default.pa</file>. It
+    should contain directives in the PulseAudio CLI languages, as
+    documented on <url href="http://pulseaudio.org/wiki/CLI"/>.</p>
+
+    <p>The same commands can also be entered during runtime in the <manref name="pacmd"
+      section="1"/> tool, allowing flexible runtime reconfiguration.</p>
+  </description>
+
+  <section name="Authors">
+    <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;;
+    PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
+  </section>
+
+  <section name="See also">
+    <p>
+      <manref name="pulse-daemon.conf" section="5"/>, <manref
+      name="pulseaudio" section="1"/>, <manref name="pacmd"
+      section="1"/>
+    </p>
+  </section>
+
+</manpage>
diff --git a/man/pacat.1.xml.in b/man/pacat.1.xml.in
index 35c7651b..e02ad667 100644
--- a/man/pacat.1.xml.in
+++ b/man/pacat.1.xml.in
@@ -109,11 +109,11 @@ USA.
       <p><opt>--format</opt><arg>=FORMAT</arg></p>
 
       <optdesc><p>Capture or play back audio with the specified sample
-      format. Specify one of <arg>u8</arg>, <arg>s16le</arg>,
-      <arg>s16be</arg>, <arg>float32le</arg>, <arg>float32be</arg>,
-      <arg>ulaw</arg>, <arg>alaw</arg>. Depending on the endianess of
-      the CPU the formats <arg>s16ne</arg>, <arg>s16re</arg>,
-      <arg>float32ne</arg>, <arg>float32re</arg> (for native,
+      format. Specify one of <opt>u8</opt>, <opt>s16le</opt>,
+      <opt>s16be</opt>, <opt>float32le</opt>, <opt>float32be</opt>,
+      <opt>ulaw</opt>, <opt>alaw</opt>. Depending on the endianess of
+      the CPU the formats <opt>s16ne</opt>, <opt>s16re</opt>,
+      <opt>float32ne</opt>, <opt>float32re</opt> (for native,
       resp. reverse endian) are available as aliases. Defaults to
       s16ne.</p></optdesc>
     </option>
@@ -132,17 +132,17 @@ USA.
 
       <optdesc><p>Explicitly choose a channel map when playing back
       this stream. The argument should be a comma separated list of
-      channel names: <arg>front-left</arg>, <arg>front-right</arg>,
-      <arg>mono</arg>, <arg>front-center</arg>, <arg>rear-left</arg>,
-      <arg>rear-right</arg>, <arg>rear-center</arg>, <arg>lfe</arg>,
-      <arg>front-left-of-center</arg>,
-      <arg>front-right-of-center</arg>, <arg>side-left</arg>,
-      <arg>side-right</arg>, <arg>top-center</arg>,
-      <arg>top-front-center</arg>, <arg>top-front-left</arg>,
-      <arg>top-front-right</arg>, <arg>top-rear-left</arg>,
-      <arg>top-rear-right</arg>, <arg>top-rear-center</arg>, or any of
-      the 32 auxiliary channel names <arg>aux0</arg> to
-      <arg>aux31</arg>.</p></optdesc>
+      channel names: <opt>front-left</opt>, <opt>front-right</opt>,
+      <opt>mono</opt>, <opt>front-center</opt>, <opt>rear-left</opt>,
+      <opt>rear-right</opt>, <opt>rear-center</opt>, <opt>lfe</opt>,
+      <opt>front-left-of-center</opt>,
+      <opt>front-right-of-center</opt>, <opt>side-left</opt>,
+      <opt>side-right</opt>, <opt>top-center</opt>,
+      <opt>top-front-center</opt>, <opt>top-front-left</opt>,
+      <opt>top-front-right</opt>, <opt>top-rear-left</opt>,
+      <opt>top-rear-right</opt>, <opt>top-rear-center</opt>, or any of
+      the 32 auxiliary channel names <opt>aux0</opt> to
+      <opt>aux31</opt>.</p></optdesc>
     </option>
 
   </options>
diff --git a/man/pulse-client.conf.5.xml.in b/man/pulse-client.conf.5.xml.in
new file mode 100644
index 00000000..dbf8dc0b
--- /dev/null
+++ b/man/pulse-client.conf.5.xml.in
@@ -0,0 +1,115 @@
+<?xml version="1.0"?><!--*-nxml-*-->
+<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
+<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
+
+<!-- $Id$ -->
+
+<!--
+This file is part of PulseAudio.
+
+PulseAudio is free software; you can redistribute it and/or modify it
+under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation; either version 2.1 of the
+License, or (at your option) any later version.
+
+PulseAudio is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with PulseAudio; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+USA.
+-->
+
+<manpage name="pulse-client.conf" section="5" desc="PulseAudio client configuration file">
+
+  <synopsis>
+    <p><file>~/.pulse/client.conf</file></p>
+
+    <p><file>@pulseconfdir@/client.conf</file></p>
+  </synopsis>
+
+  <description>
+    <p>The PulseAudio client library reads configuration directives from
+    a file <file>~/.pulse/client.conf</file> on startup, and when that
+    file doesn't exist from
+    <file>@pulseconfdir@/client.conf</file>.</p>
+
+    <p>The configuration file is a simple collection of variable
+    declarations. If the configuration file parser encounters either ;
+    or # for it ignores the rest of the line until its end.</p>
+
+    <p>For the settings that take a boolean argument, the values
+    <opt>true</opt>, <opt>yes</opt>, <opt>on</opt> and <opt>1</opt>
+    are equivalent, resp. <opt>false</opt>, <opt>no</opt>,
+    <opt>off</opt>, <opt>0</opt>.</p>
+
+  </description>
+
+  <section name="Directives">
+
+    <option>
+      <p><opt>default-sink=</opt> The default sink to connect to. If
+      specified overwrites the setting in the daemon. The environment
+      variable <opt>$PULSE_SINK</opt> however takes precedence.</p>
+    </option>
+
+    <option>
+      <p><opt>default-source=</opt> The default source to connect
+      to. If specified overwrites the setting in the daemon. The
+      environment variable <opt>$PULSE_SOURCE</opt> however takes
+      precedence.</p>
+    </option>
+
+    <option>
+      <p><opt>default-server=</opt> The default sever to connect
+      to. The environment variable <opt>$PULSE_SERVER</opt> takes
+      precedence.</p>
+    </option>
+
+    <option>
+      <p><opt>autospawn=</opt> Autospawn a PulseAudio daemon when
+      needed. Takes a boolean value, defaults to "no".</p>
+    </option>
+
+    <option>
+      <p><opt>daemon-binary=</opt> Path to the PulseAudio daemon to
+      run when autospawning. Defaults to a path configured at compile
+      time.</p>
+    </option>
+
+    <option>
+      <p><opt>extra-arguments=</opt> Extra arguments to pass to the
+      PulseAudio daemon when autospawning. Defaults to
+      <opt>--log-target=syslog --exit-idle-time=5</opt>
+      </p>
+    </option>
+
+    <option>
+      <p><opt>cookie-file=</opt> Specify the path to the PulseAudio
+      authentication cookie. Defaults to
+      <file>~/.pulse-cookie</file>.</p>
+    </option>
+
+    <option>
+      <p><opt>disable-shm=</opt> Disable data transfer via POSIX
+      shared memory. Takes a boolean argument, defaults to
+      <opt>no</opt>.</p>
+    </option>
+
+  </section>
+
+  <section name="Authors">
+    <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;;
+    PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
+  </section>
+
+  <section name="See also">
+    <p>
+      <manref name="pulse-daemon.conf" section="5"/>, <manref name="pulseaudio" section="1"/>
+    </p>
+  </section>
+
+</manpage>
diff --git a/man/pulse-daemon.conf.5.xml.in b/man/pulse-daemon.conf.5.xml.in
new file mode 100644
index 00000000..88bf8f58
--- /dev/null
+++ b/man/pulse-daemon.conf.5.xml.in
@@ -0,0 +1,366 @@
+<?xml version="1.0"?><!--*-nxml-*-->
+<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
+<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
+
+<!-- $Id$ -->
+
+<!--
+This file is part of PulseAudio.
+
+PulseAudio is free software; you can redistribute it and/or modify it
+under the terms of the GNU Lesser General Public License as
+published by the Free Software Foundation; either version 2.1 of the
+License, or (at your option) any later version.
+
+PulseAudio is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with PulseAudio; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+USA.
+-->
+
+<manpage name="pulse-daemon.conf" section="5" desc="PulseAudio daemon configuration file">
+
+  <synopsis>
+    <p><file>~/.pulse/daemon.conf</file></p>
+
+    <p><file>@pulseconfdir@/daemon.conf</file></p>
+  </synopsis>
+
+  <description>
+    <p>The PulseAudio sound server reads configuration directives from
+    a file <file>~/.pulse/daemon.conf</file> on startup, and when that
+    file doesn't exist from
+    <file>@pulseconfdir@/daemon.conf</file>. Please note that the
+    server also reads a configuration script on startup
+    <file>default.pa</file> which also contains runtime configuration
+    directives.</p>
+
+    <p>The configuration file is a simple collection of variable
+    declarations. If the configuration file parser encounters either ;
+    or # for it ignores the rest of the line until its end.</p>
+
+    <p>For the settings that take a boolean argument, the values
+    <opt>true</opt>, <opt>yes</opt>, <opt>on</opt> and <opt>1</opt>
+    are equivalent, resp. <opt>false</opt>, <opt>no</opt>,
+    <opt>off</opt>, <opt>0</opt>.</p>
+
+  </description>
+
+  <section name="General Directives">
+
+    <option>
+      <p><opt>daemonize= </opt> Daemonize after startup. Takes a
+      boolean value, defaults to "no". The <opt>--daemonize</opt>
+      command line option takes precedence.</p>
+    </option>
+
+    <option>
+      <p><opt>fail=</opt> Fail to start up if any of the directives
+      in the configuration script <file>default.pa</file>
+      fail. Takes a boolean argument, defaults to "yes". The <opt>--fail</opt> command line
+      option takes precedence.</p>
+    </option>
+
+    <option>
+      <p><opt>disallow-module-loading=</opt> Disallow module loading
+      after startup. This is a security feature that makes sure that
+      no further modules may be loaded into the PulseAudio server
+      after startup completed. It is recommended to enable this when
+      <opt>system-instance</opt> is enabled. Please note that certain
+      features like automatic hot-plug support will not work if this
+      option is enabled. Takes a boolean argument, defaults to
+      <opt>no</opt>. The <opt>--disallow-module-loading</opt> command line
+      option takes precedence.</p>
+    </option>
+
+    <option>
+      <p><opt>resample-method=</opt> The resampling algorithm to
+      use. Use one of <opt>src-sinc-best-quality</opt>,
+      <opt>src-sinc-medium-quality</opt>, <opt>src-sinc-fastest</opt>,
+      <opt>src-zero-order-hold</opt>, <opt>src-linear</opt>,
+      <opt>trivial</opt>, <opt>speex-float-N</opt>,
+      <opt>speex-fixed-N</opt>, <opt>ffmpeg</opt>. See the
+      documentation of libsamplerate for an explanation for the
+      different src- methods. The method <opt>trivial</opt> is the most basic
+      algorithm implemented. If you're tight on CPU consider using
+      this. On the other hand it has the worst quality of them
+      all. The Speex resamplers take an integer quality setting in the
+      range 0..9 (bad...good). They exist in two flavours: <opt>fixed</opt> and
+      <opt>float</opt>. The former uses fixed point numbers, the latter relies on
+      floating point numbers. On most desktop CPUs the float point
+      resmampler is a lot faster, and it also offers slightly better
+      quality. See the output of <opt>dump-resample-methods</opt> for
+      a complete list of all available resamplers. Defaults to
+      <opt>speex-float-3</opt>. The <opt>--resample-method</opt>
+      command line option takes precedence. Note that some modules
+      overwrite or allow overwriting of the resampler to use.</p>
+    </option>
+
+    <option>
+      <p><opt>use-pid-file=</opt> Create a PID file in
+      <file>/tmp/pulse-$USER/pid</file>. Of this is enabled you may
+      use commands like <opt>--kill</opt> or <opt>--check</opt>. If
+      you are planning to start more than one PulseAudio process per
+      user, you better disable this option since it effectively
+      disables multiple instances. Takes a boolean argument, defaults
+      to <opt>yes</opt>. The <opt>--no-cpu-limit</opt> command line
+      option takes precedence.</p>
+    </option>
+
+    <option>
+      <p><opt>no-cpu-limit=</opt> Do not install the CPU load limiter,
+      even on platforms where it is supported. This option is useful
+      when debugging/profiling PulseAudio to disable disturbing
+      SIGXCPU signals. Takes a boolean argument, defaults to <opt>no</opt>. The
+      <opt>--no-cpu-limit</opt> command line argument takes
+      precedence.</p>
+    </option>
+
+
+    <option>
+      <p><opt>system-instance=</opt> Run the daemon as system-wide
+      instance, requires root priviliges. Takes a boolean argument,
+      defaults to <opt>no</opt>. The <opt>--system</opt> command line
+      argument takes precedence.</p>
+    </option>
+
+
+    <option>
+      <p><opt>disable-shm=</opt> Disable data transfer via POSIX
+      shared memory. Takes a boolean argument, defaults to
+      <opt>no</opt>. The <opt>--disable-shm</opt> command line
+      argument takes precedence.</p>
+    </option>
+
+  </section>
+
+  <section name="Scheduling">
+
+    <option>
+      <p><opt>high-priority=</opt> Renice the daemon after startup to
+      become a high-priority process. This a good idea if you
+      experience drop-outs during playback. However, this is a certain
+      security issue, since it works when called SUID root only, or
+      RLIMIT_NICE is used. root is dropped immediately after gaining
+      the nice level on startup, thus it is presumably safe. See
+      <manref section="1" name="pulseaudio"/> for more
+      information. Takes a boolean argument, defaults to "yes". The <opt>--high-priority</opt>
+      command line option takes precedence.</p>
+    </option>
+
+    <option>
+      <p><opt>realtime-scheduling=</opt> Try to acquire SCHED_FIFO
+      scheduling for the IO threads. The same security concerns as
+      mentioned above apply. However, if PA enters an endless loop,
+      realtime scheduling causes a system lockup. Thus, realtime
+      scheduling should only be enabled on trusted machines for
+      now. Please not that only the IO threads of PulseAudio are made
+      real-time. The controlling thread is left a normally scheduled
+      thread. Thus enabling the high-priority option is orthogonal.
+      See <manref section="1" name="pulseaudio"/> for more
+      information. Takes a boolean argument, defaults to "no". The
+      <opt>--realtime</opt> command line option takes precedence.</p>
+    </option>
+
+    <option>
+      <p><opt>realtime-priority=</opt> The realtime priority to
+      acquire, if <opt>realtime-scheduling</opt> is enabled. Note: JACK uses 10
+      by default, 9 for clients. Thus it is recommended to choose the
+      PulseAudio real-time priorities lower. Some PulseAudio threads
+      might choose a priority a little lower or higher than the
+      specified value. Defaults to "5".</p>
+    </option>
+
+    <option>
+      <p><opt>nice-level=</opt> The nice level to acquire for the
+      daemon, if <opt>high-priority</opt> is enabled. Note: on some
+      distributions X11 uses -10 by default. Defaults to -11.</p>
+    </option>
+
+  </section>
+
+  <section name="Idle Times">
+
+    <option>
+      <p><opt>exit-idle-time=</opt> Terminate the daemon after the
+      last client quit and this time in seconds passed. Use a negative value to
+      disable this feature. Defaults to -1. The
+      <opt>--exit-idle-time</opt> command line option takes
+      precedence.</p>
+    </option>
+
+    <option>
+      <p><opt>module-idle-time=</opt> Unload autoloaded modules after
+      being idle for this time in seconds. Defaults to 20. The
+      <opt>--module-idle-time</opt> command line option takes
+      precedence.</p>
+    </option>
+
+    <option>
+      <p><opt>scache-idle-time=</opt> Unload autoloaded sample cache
+      entries after being idle for this time in seconds. Defaults to
+      20. The <opt>--scache-idle-time</opt> command line option takes
+      precedence.</p>
+    </option>
+
+  </section>
+
+  <section name="Paths">
+
+    <option>
+      <p><opt>dl-search-path=</opt> The path were to look for dynamic
+      shared objects (DSOs/plugins). You may specify more than one
+      path seperated by colons. The default path depends on compile
+      time settings. The <opt>--dl-search-path</opt> command line
+      option takes precedence. </p>
+    </option>
+
+    <option>
+      <p><opt>default-script-file=</opt> The default configuration
+      script file to load. Specify an empty string for not loading a
+      default script file. The default behaviour is to load
+      <file>~/.pulse/default.pa</file>, and if that file does not
+      exist fall back to the system wide installed version
+      <file>@pulseconfdir@/default.pa</file>. If <opt>-n</opt> is
+      passed on the command line the default configuration script is
+      ignored.</p>
+    </option>
+
+  </section>
+
+  <section name="Logging">
+
+    <option>
+      <p><opt>log-target=</opt> The default log target. Use either
+      <opt>stderr</opt>, <opt>syslog</opt> or <opt>auto</opt>. The
+      latter is equivalent to <opt>sylog</opt> in case
+      <opt>daemonize</opt> is enabled, otherwise to
+      <opt>stderr</opt>. Defaults to <opt>auto</opt>. The
+      <opt>--log-target</opt> command line option takes
+      precedence.</p>
+    </option>
+
+    <option>
+      <p><opt>log-level=</opt> Log level, one of <opt>debug</opt>,
+      <opt>info</opt>, <opt>notice</opt>, <opt>warning</opt>,
+      <opt>error</opt>. Log messages with a lower log level than
+      specified here are not logged. Defaults to
+      <opt>notice</opt>. The <opt>--log-level</opt> command line
+      option takes precedence. The <opt>-v</opt> command line option
+      might alter this setting.</p>
+    </option>
+
+  </section>
+
+  <section name="Resource Limits">
+
+    <p>See <manref name="getrlimit" section="2"/> for
+    more information. Set to -1 if PulseAudio shall not touch the resource
+    limit. Not all resource limits are available on all operating
+    systems.</p>
+
+    <option>
+      <p><opt>rlimit-as</opt> Defaults to -1.</p>
+    </option>
+    <option>
+      <p><opt>rlimit-core</opt> Defaults to -1.</p>
+    </option>
+    <option>
+      <p><opt>rlimit-data</opt> Defaults to -1.</p>
+    </option>
+    <option>
+      <p><opt>rlimit-fsize</opt> Defaults to -1.</p>
+    </option>
+    <option>
+      <p><opt>rlimit-nofile</opt> Defaults to 256.</p>
+    </option>
+    <option>
+      <p><opt>rlimit-stack</opt> Defaults to -1.</p>
+    </option>
+    <option>
+      <p><opt>rlimit-nproc</opt> Defaults to -1.</p>
+    </option>
+    <option>
+      <p><opt>rlimit-memlock</opt> Defaults to 16 KiB. Please note
+      that the JACK client libraries may require more locked
+      memory.</p>
+    </option>
+    <option>
+      <p><opt>rlimit-nice</opt> Defaults to 31. Please make sure that
+      the default nice level as configured with <opt>nice-level</opt>
+      fits in this resource limit, if <opt>high-priority</opt> is
+      enabled.</p>
+    </option>
+    <option>
+      <p><opt>rlimit-rtprio</opt> Defaults to 9. Please make sure that
+      the default real-time priority level as configured with
+      <opt>realtime-priority=</opt> fits in this resource limit, if
+      <opt>realtime-scheduling</opt> is enabled. The JACK client
+      libraries require a real-time prority of 9 by default. </p>
+    </option>
+
+  </section>
+
+  <section name="Default Device Settings">
+
+    <p>Most drivers try to open the audio device with these settings
+    and then fall back to lower settings. The default settings are CD
+    quality: 16bit native endian, 2 channels, 44100 Hz sampling.</p>
+
+    <option>
+      <p><opt>default-sample-format=</opt> The default sampling
+      format. Specify one of <opt>u8</opt>, <opt>s16le</opt>,
+      <opt>s16be</opt>, <opt>float32le</opt>, <opt>float32be</opt>,
+      <opt>ulaw</opt>, <opt>alaw</opt>. Depending on the endianess of
+      the CPU the formats <opt>s16ne</opt>, <opt>s16re</opt>,
+      <opt>float32ne</opt>, <opt>float32re</opt> (for native,
+      resp. reverse endian) are available as aliases.</p>
+    </option>
+
+    <option>
+      <p><opt>default-sample-rate=</opt> The default sample frequency.</p>
+    </option>
+
+    <option>
+      <p><opt>default-sample-channels</opt> The default number of channels.</p>
+    </option>
+
+  </section>
+
+  <section name="Default Fragment Settings">
+
+    <p>Some hardware drivers require the hardware playback buffer to
+    be subdivided into several fragments. It is possible to change
+    these buffer metrics for machines with high scheduling
+    latencies. Not all possible values that may be configured here are
+    available in all hardware. The driver will to find the nearest
+    setting supported.</p>
+
+    <option>
+      <p><opt>default-fragments=</opt> The default number of
+      fragments. Defaults to 4.</p>
+    </option>
+    <option>
+      <p><opt>default-fragment-size-msec=</opt>The duration of a
+      single fragment. Defaults to 25ms (i.e. the total buffer is thus
+      100ms long).</p>
+    </option>
+
+  </section>
+
+  <section name="Authors">
+    <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
+  </section>
+
+  <section name="See also">
+    <p>
+      <manref name="pulse-client.conf" section="5"/>, <manref name="default.pa" section="5"/>, <manref name="pulseaudio" section="1"/>, <manref name="pacmd" section="1"/>
+    </p>
+  </section>
+
+</manpage>
-- 
cgit 


From 6b932f0a50a8459399a8b79eb91132c8bacf22b9 Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Wed, 21 Nov 2007 23:03:19 +0000
Subject: update man pages a bit

git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@2070 fefdeb5f-60dc-0310-8127-8f9354f1896f
---
 man/pacat.1.xml.in             | 25 +++++++++++++++++++++++++
 man/pulse-daemon.conf.5.xml.in |  6 ++++++
 2 files changed, 31 insertions(+)

(limited to 'man')

diff --git a/man/pacat.1.xml.in b/man/pacat.1.xml.in
index e02ad667..748d136d 100644
--- a/man/pacat.1.xml.in
+++ b/man/pacat.1.xml.in
@@ -145,6 +145,31 @@ USA.
       <opt>aux31</opt>.</p></optdesc>
     </option>
 
+    <option>
+      <p><opt>--fix-format</opt></p>
+      <optdesc><p>If passed, the sample format of the stream is changed to the native format of the sink the stream is connected to.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--fix-rate</opt></p>
+      <optdesc><p>If passed, the sampling rate of the stream is changed to the native rate of the sink the stream is connected to.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--fix-channels</opt></p>
+      <optdesc><p>If passed, the number of channels and the channel map of the stream is changed to the native number of channels and the native channel map of the sink the stream is connected to.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--no-remix</opt></p>
+      <optdesc><p>Never upmix or downmix channels.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--no-remap</opt></p>
+      <optdesc><p>Never remap channels. Instead of mapping channels by their name this will match them solely by their index/order.</p></optdesc>
+    </option>
+
   </options>
 
   <section name="Authors">
diff --git a/man/pulse-daemon.conf.5.xml.in b/man/pulse-daemon.conf.5.xml.in
index 88bf8f58..2768e24e 100644
--- a/man/pulse-daemon.conf.5.xml.in
+++ b/man/pulse-daemon.conf.5.xml.in
@@ -101,6 +101,12 @@ USA.
       overwrite or allow overwriting of the resampler to use.</p>
     </option>
 
+    <option>
+      <p><opt>disable-remixing=</opt> Never upmix or downmix channels
+      to different channel maps. Instead, do a simple name-based
+      matching only.</p>
+    </option>
+
     <option>
       <p><opt>use-pid-file=</opt> Create a PID file in
       <file>/tmp/pulse-$USER/pid</file>. Of this is enabled you may
-- 
cgit 


From 5552139402dbf5f76fddccb864770edcdf5dec2f Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Fri, 15 Feb 2008 13:33:08 +0000
Subject: explicitly recommend the usage of -- in the pasuspender command line,
 Closes #203

git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@2109 fefdeb5f-60dc-0310-8127-8f9354f1896f
---
 man/pasuspender.1.xml.in | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'man')

diff --git a/man/pasuspender.1.xml.in b/man/pasuspender.1.xml.in
index 8a73343a..406dfe60 100644
--- a/man/pasuspender.1.xml.in
+++ b/man/pasuspender.1.xml.in
@@ -38,6 +38,13 @@ USA.
     applications access them directly. <file>pasuspender</file> will
     suspend access to the audio devices, fork a child process, and
     when the child process terminates, resume access again.</p>
+
+    <p>Make sure to include <opt>--</opt> in
+    your <file>pasuspender</file> command line before passing the
+    subprocess command line (as shown
+    above). Otherwise <file>pasuspender</file> itself might end up
+    interpreting the command line switches and options you intended to
+    pass to the subprocess.</p>
   </description>
 
   <options>
-- 
cgit