diff --git a/man/Makefile.am b/man/Makefile.am
index e5ce5530c..0a355f952 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 000000000..0f826db6f
--- /dev/null
+++ b/man/default.pa.5.xml.in
@@ -0,0 +1,58 @@
+
+
+
+
+
+
+
+
+
+
+
+ ~/.pulse/default.pa
+
+ @pulseconfdir@/default.pa
+
+
+
+ The PulseAudio sound server interprets the file
+ ~/.pulse/default.pa on startup, and when that file
+ doesn't exist @pulseconfdir@/default.pa . It
+ should contain directives in the PulseAudio CLI languages, as
+ documented on
+
+ The same commands can also be entered during runtime in the
+
+
+
+ The PulseAudio Developers <@PACKAGE_BUGREPORT@>;
+ PulseAudio is available from
+
+
+
+
+
diff --git a/man/pacat.1.xml.in b/man/pacat.1.xml.in
index 35c7651ba..e02ad667b 100644
--- a/man/pacat.1.xml.in
+++ b/man/pacat.1.xml.in
@@ -109,11 +109,11 @@ USA.
--format =FORMAT
Capture or play back audio with the specified sample
- format. Specify one of u8 , s16le ,
- s16be , float32le , float32be ,
- ulaw , alaw . Depending on the endianess of
- the CPU the formats s16ne , s16re ,
- float32ne , float32re (for native,
+ format. Specify one of u8 , s16le ,
+ s16be , float32le , float32be ,
+ ulaw , alaw . Depending on the endianess of
+ the CPU the formats s16ne , s16re ,
+ float32ne , float32re (for native,
resp. reverse endian) are available as aliases. Defaults to
s16ne.
Explicitly choose a channel map when playing back
this stream. The argument should be a comma separated list of
- channel names: front-left , front-right ,
- mono , front-center , rear-left ,
- rear-right , rear-center , lfe ,
- front-left-of-center ,
- front-right-of-center , side-left ,
- side-right , top-center ,
- top-front-center , top-front-left ,
- top-front-right , top-rear-left ,
- top-rear-right , top-rear-center , or any of
- the 32 auxiliary channel names aux0 to
- aux31 .
front-left , front-right ,
+ mono , front-center , rear-left ,
+ rear-right , rear-center , lfe ,
+ front-left-of-center ,
+ front-right-of-center , side-left ,
+ side-right , top-center ,
+ top-front-center , top-front-left ,
+ top-front-right , top-rear-left ,
+ top-rear-right , top-rear-center , or any of
+ the 32 auxiliary channel names aux0 to
+ aux31 .
diff --git a/man/pulse-client.conf.5.xml.in b/man/pulse-client.conf.5.xml.in
new file mode 100644
index 000000000..dbf8dc0b8
--- /dev/null
+++ b/man/pulse-client.conf.5.xml.in
@@ -0,0 +1,115 @@
+
+
+
+
+
+
+
+
+
+
+
+ ~/.pulse/client.conf
+
+ @pulseconfdir@/client.conf
+
+
+
+ The PulseAudio client library reads configuration directives from
+ a file ~/.pulse/client.conf on startup, and when that
+ file doesn't exist from
+ @pulseconfdir@/client.conf .
+
+ 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.
+
+ For the settings that take a boolean argument, the values
+ true , yes , on and 1
+ are equivalent, resp. false , no ,
+ off , 0 .
+
+
+
+
+
+
+ default-sink= The default sink to connect to. If
+ specified overwrites the setting in the daemon. The environment
+ variable $PULSE_SINK however takes precedence.
+
+
+
+ default-source= The default source to connect
+ to. If specified overwrites the setting in the daemon. The
+ environment variable $PULSE_SOURCE however takes
+ precedence.
+
+
+
+ default-server= The default sever to connect
+ to. The environment variable $PULSE_SERVER takes
+ precedence.
+
+
+
+ autospawn= Autospawn a PulseAudio daemon when
+ needed. Takes a boolean value, defaults to "no".
+
+
+
+ daemon-binary= Path to the PulseAudio daemon to
+ run when autospawning. Defaults to a path configured at compile
+ time.
+
+
+
+ extra-arguments= Extra arguments to pass to the
+ PulseAudio daemon when autospawning. Defaults to
+ --log-target=syslog --exit-idle-time=5
+
+
+
+
+ cookie-file= Specify the path to the PulseAudio
+ authentication cookie. Defaults to
+ ~/.pulse-cookie .
+
+
+
+ disable-shm= Disable data transfer via POSIX
+ shared memory. Takes a boolean argument, defaults to
+ no .
+
+
+
+
+
+ The PulseAudio Developers <@PACKAGE_BUGREPORT@>;
+ PulseAudio is available from
+
+
+
+
+
diff --git a/man/pulse-daemon.conf.5.xml.in b/man/pulse-daemon.conf.5.xml.in
new file mode 100644
index 000000000..88bf8f589
--- /dev/null
+++ b/man/pulse-daemon.conf.5.xml.in
@@ -0,0 +1,366 @@
+
+
+
+
+
+
+
+
+
+
+
+ ~/.pulse/daemon.conf
+
+ @pulseconfdir@/daemon.conf
+
+
+
+ The PulseAudio sound server reads configuration directives from
+ a file ~/.pulse/daemon.conf on startup, and when that
+ file doesn't exist from
+ @pulseconfdir@/daemon.conf . Please note that the
+ server also reads a configuration script on startup
+ default.pa which also contains runtime configuration
+ directives.
+
+ 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.
+
+ For the settings that take a boolean argument, the values
+ true , yes , on and 1
+ are equivalent, resp. false , no ,
+ off , 0 .
+
+
+
+
+
+
+ daemonize= Daemonize after startup. Takes a
+ boolean value, defaults to "no". The --daemonize
+ command line option takes precedence.
+
+
+
+ fail= Fail to start up if any of the directives
+ in the configuration script default.pa
+ fail. Takes a boolean argument, defaults to "yes". The --fail command line
+ option takes precedence.
+
+
+
+ disallow-module-loading= 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
+ system-instance 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
+ no . The --disallow-module-loading command line
+ option takes precedence.
+
+
+
+ resample-method= The resampling algorithm to
+ use. Use one of src-sinc-best-quality ,
+ src-sinc-medium-quality , src-sinc-fastest ,
+ src-zero-order-hold , src-linear ,
+ trivial , speex-float-N ,
+ speex-fixed-N , ffmpeg . See the
+ documentation of libsamplerate for an explanation for the
+ different src- methods. The method trivial 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: fixed and
+ float . 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 dump-resample-methods for
+ a complete list of all available resamplers. Defaults to
+ speex-float-3 . The --resample-method
+ command line option takes precedence. Note that some modules
+ overwrite or allow overwriting of the resampler to use.
+
+
+
+ use-pid-file= Create a PID file in
+ /tmp/pulse-$USER/pid . Of this is enabled you may
+ use commands like --kill or --check . 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 yes . The --no-cpu-limit command line
+ option takes precedence.
+
+
+
+ no-cpu-limit= 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 no . The
+ --no-cpu-limit command line argument takes
+ precedence.
+
+
+
+
+ system-instance= Run the daemon as system-wide
+ instance, requires root priviliges. Takes a boolean argument,
+ defaults to no . The --system command line
+ argument takes precedence.
+
+
+
+
+ disable-shm= Disable data transfer via POSIX
+ shared memory. Takes a boolean argument, defaults to
+ no . The --disable-shm command line
+ argument takes precedence.
+
+
+
+
+
+
+
+ high-priority= 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
+ --high-priority
+ command line option takes precedence.
+
+
+
+ realtime-scheduling= 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 --realtime command line option takes precedence.
+
+
+
+ realtime-priority= The realtime priority to
+ acquire, if realtime-scheduling 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".
+
+
+
+ nice-level= The nice level to acquire for the
+ daemon, if high-priority is enabled. Note: on some
+ distributions X11 uses -10 by default. Defaults to -11.
+
+
+
+
+
+
+
+ exit-idle-time= 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
+ --exit-idle-time command line option takes
+ precedence.
+
+
+
+ module-idle-time= Unload autoloaded modules after
+ being idle for this time in seconds. Defaults to 20. The
+ --module-idle-time command line option takes
+ precedence.
+
+
+
+ scache-idle-time= Unload autoloaded sample cache
+ entries after being idle for this time in seconds. Defaults to
+ 20. The --scache-idle-time command line option takes
+ precedence.
+
+
+
+
+
+
+
+ dl-search-path= 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 --dl-search-path command line
+ option takes precedence.
+
+
+
+ default-script-file= The default configuration
+ script file to load. Specify an empty string for not loading a
+ default script file. The default behaviour is to load
+ ~/.pulse/default.pa , and if that file does not
+ exist fall back to the system wide installed version
+ @pulseconfdir@/default.pa . If -n is
+ passed on the command line the default configuration script is
+ ignored.
+
+
+
+
+
+
+
+ log-target= The default log target. Use either
+ stderr , syslog or auto . The
+ latter is equivalent to sylog in case
+ daemonize is enabled, otherwise to
+ stderr . Defaults to auto . The
+ --log-target command line option takes
+ precedence.
+
+
+
+ log-level= Log level, one of debug ,
+ info , notice , warning ,
+ error . Log messages with a lower log level than
+ specified here are not logged. Defaults to
+ notice . The --log-level command line
+ option takes precedence. The -v command line option
+ might alter this setting.
+
+
+
+
+
+
+ See
+
+
+ rlimit-as Defaults to -1.
+
+
+ rlimit-core Defaults to -1.
+
+
+ rlimit-data Defaults to -1.
+
+
+ rlimit-fsize Defaults to -1.
+
+
+ rlimit-nofile Defaults to 256.
+
+
+ rlimit-stack Defaults to -1.
+
+
+ rlimit-nproc Defaults to -1.
+
+
+ rlimit-memlock Defaults to 16 KiB. Please note
+ that the JACK client libraries may require more locked
+ memory.
+
+
+ rlimit-nice Defaults to 31. Please make sure that
+ the default nice level as configured with nice-level
+ fits in this resource limit, if high-priority is
+ enabled.
+
+
+ rlimit-rtprio Defaults to 9. Please make sure that
+ the default real-time priority level as configured with
+ realtime-priority= fits in this resource limit, if
+ realtime-scheduling is enabled. The JACK client
+ libraries require a real-time prority of 9 by default.
+
+
+
+
+
+
+ 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.
+
+
+ default-sample-format= The default sampling
+ format. Specify one of u8 , s16le ,
+ s16be , float32le , float32be ,
+ ulaw , alaw . Depending on the endianess of
+ the CPU the formats s16ne , s16re ,
+ float32ne , float32re (for native,
+ resp. reverse endian) are available as aliases.
+
+
+
+ default-sample-rate= The default sample frequency.
+
+
+
+ default-sample-channels The default number of channels.
+
+
+
+
+
+
+ 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.
+
+
+ default-fragments= The default number of
+ fragments. Defaults to 4.
+
+
+ default-fragment-size-msec= The duration of a
+ single fragment. Defaults to 25ms (i.e. the total buffer is thus
+ 100ms long).
+
+
+
+
+
+ The PulseAudio Developers <@PACKAGE_BUGREPORT@>; PulseAudio is available from
+
+
+
+
+