[pulseaudio-commits] r2029 - in /trunk/man: ./ Makefile.am default.pa.5.xml.in pacat.1.xml.in pulse-client.conf.5.xml.in pulse-daemon.conf.5.xml.in
svnmailer-noreply at 0pointer.de
svnmailer-noreply at 0pointer.de
Thu Nov 8 14:30:34 PST 2007
Author: lennart
Date: Thu Nov 8 23:30:33 2007
New Revision: 2029
URL: http://0pointer.de/cgi-bin/viewcvs.cgi?rev=2029&root=pulseaudio&view=rev
Log:
add remaing man pages
Added:
trunk/man/default.pa.5.xml.in (with props)
trunk/man/pulse-client.conf.5.xml.in (with props)
trunk/man/pulse-daemon.conf.5.xml.in (with props)
Modified:
trunk/man/ (props changed)
trunk/man/Makefile.am
trunk/man/pacat.1.xml.in
Propchange: trunk/man/
------------------------------------------------------------------------------
--- svn:ignore (original)
+++ svn:ignore Thu Nov 8 23:30:33 2007
@@ -1,3 +1,4 @@
+*.5
*.1
*.xml
Makefile
Modified: trunk/man/Makefile.am
URL: http://0pointer.de/cgi-bin/viewcvs.cgi/trunk/man/Makefile.am?rev=2029&root=pulseaudio&r1=2028&r2=2029&view=diff
==============================================================================
--- trunk/man/Makefile.am (original)
+++ trunk/man/Makefile.am Thu Nov 8 23:30:33 2007
@@ -31,7 +31,10 @@
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 @@
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 @@
-e 's, at PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
-e 's, at PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+pulse-daemon.conf.5.xml: pulse-daemon.conf.5.xml.in Makefile
+ sed -e 's, at pulseconfdir\@,$(pulseconfdir),g' \
+ -e 's, at PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+ -e 's, at PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
+pulse-client.conf.5.xml: pulse-client.conf.5.xml.in Makefile
+ sed -e 's, at pulseconfdir\@,$(pulseconfdir),g' \
+ -e 's, at PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+ -e 's, at PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
+default.pa.5.xml: default.pa.5.xml.in Makefile
+ sed -e 's, at pulseconfdir\@,$(pulseconfdir),g' \
+ -e 's, at PACKAGE_BUGREPORT\@,$(PACKAGE_BUGREPORT),g' \
+ -e 's, at PACKAGE_URL\@,$(PACKAGE_URL),g' $< > $@
+
if USE_XMLTOMAN
CLEANFILES += \
@@ -133,6 +154,15 @@
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 @@
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
Added: trunk/man/default.pa.5.xml.in
URL: http://0pointer.de/cgi-bin/viewcvs.cgi/trunk/man/default.pa.5.xml.in?rev=2029&root=pulseaudio&view=auto
==============================================================================
--- trunk/man/default.pa.5.xml.in (added)
+++ trunk/man/default.pa.5.xml.in Thu Nov 8 23:30:33 2007
@@ -1,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 <@PACKAGE_BUGREPORT@>;
+ 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>
Propchange: trunk/man/default.pa.5.xml.in
------------------------------------------------------------------------------
svn:keywords = Id
Modified: trunk/man/pacat.1.xml.in
URL: http://0pointer.de/cgi-bin/viewcvs.cgi/trunk/man/pacat.1.xml.in?rev=2029&root=pulseaudio&r1=2028&r2=2029&view=diff
==============================================================================
--- trunk/man/pacat.1.xml.in (original)
+++ trunk/man/pacat.1.xml.in Thu Nov 8 23:30:33 2007
@@ -109,11 +109,11 @@
<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 @@
<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>
Added: trunk/man/pulse-client.conf.5.xml.in
URL: http://0pointer.de/cgi-bin/viewcvs.cgi/trunk/man/pulse-client.conf.5.xml.in?rev=2029&root=pulseaudio&view=auto
==============================================================================
--- trunk/man/pulse-client.conf.5.xml.in (added)
+++ trunk/man/pulse-client.conf.5.xml.in Thu Nov 8 23:30:33 2007
@@ -1,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 <@PACKAGE_BUGREPORT@>;
+ 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>
Propchange: trunk/man/pulse-client.conf.5.xml.in
------------------------------------------------------------------------------
svn:keywords = Id
Added: trunk/man/pulse-daemon.conf.5.xml.in
URL: http://0pointer.de/cgi-bin/viewcvs.cgi/trunk/man/pulse-daemon.conf.5.xml.in?rev=2029&root=pulseaudio&view=auto
==============================================================================
--- trunk/man/pulse-daemon.conf.5.xml.in (added)
+++ trunk/man/pulse-daemon.conf.5.xml.in Thu Nov 8 23:30:33 2007
@@ -1,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 <@PACKAGE_BUGREPORT@>; 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>
Propchange: trunk/man/pulse-daemon.conf.5.xml.in
------------------------------------------------------------------------------
svn:keywords = Id
More information about the pulseaudio-commits
mailing list