Some man page updates, add missing documentation, other fixes.

This commit is contained in:
Lennart Poettering 2008-10-01 01:15:44 +02:00
parent 79ad4e63f6
commit d299ac5d93
2 changed files with 40 additions and 12 deletions

View file

@ -31,15 +31,15 @@ USA.
<description>
<p>The PulseAudio client library reads configuration directives from
a file <file>~/.pulse/client.conf</file> on startup, and when that
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>
or # it ignores the rest of the line until its end.</p>
<p>For the settings that take a boolean argument, the values
<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>
@ -69,7 +69,7 @@ USA.
<option>
<p><opt>autospawn=</opt> Autospawn a PulseAudio daemon when
needed. Takes a boolean value, defaults to "no".</p>
needed. Takes a boolean value, defaults to "yes".</p>
</option>
<option>
@ -81,7 +81,7 @@ USA.
<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>
<opt>--log-target=syslog</opt>
</p>
</option>

View file

@ -31,7 +31,7 @@ USA.
<description>
<p>The PulseAudio sound server reads configuration directives from
a file <file>~/.pulse/daemon.conf</file> on startup, and when that
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
@ -40,9 +40,9 @@ USA.
<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>
or # it ignores the rest of the line until its end.</p>
<p>For the settings that take a boolean argument, the values
<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>
@ -76,6 +76,11 @@ USA.
option takes precedence.</p>
</option>
<option>
<p><opt>disallow-exit=</opt> Disallow exit on user
request. Defaults to <opt>no</opt>.</p>
</option>
<option>
<p><opt>resample-method=</opt> The resampling algorithm to
use. Use one of <opt>src-sinc-best-quality</opt>,
@ -112,7 +117,7 @@ USA.
available as well. If no input LFE channel is available the
output LFE channel will always be 0. If no output LFE channel is
available the signal on the input LFE channel will be
ignored.</p>
ignored. Defaults to "on".</p>
</option>
<option>
@ -249,9 +254,17 @@ USA.
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>
<file>@pulseconfdir@/default.pa</file>. If run in system-wide
mode the file <file>@pulseconfdir@/system.pa</file> is used
instead. If <opt>-n</opt> is passed on the command line
or <opt>default-script-file=</opt> is disabled the default
configuration script is ignored.</p>
</option>
<option>
<p><opt>default-script-file=</opt> Load the default
configuration script file as specified
in <opt>default-script-file=</opt>. Defaults to "yes".</p>
</option>
</section>
@ -290,6 +303,9 @@ USA.
<option>
<p><opt>rlimit-as</opt> Defaults to -1.</p>
</option>
<option>
<p><opt>rlimit-rss</opt> Defaults to -1.</p>
</option>
<option>
<p><opt>rlimit-core</opt> Defaults to -1.</p>
</option>
@ -308,6 +324,15 @@ USA.
<option>
<p><opt>rlimit-nproc</opt> Defaults to -1.</p>
</option>
<option>
<p><opt>rlimit-locks</opt> Defaults to -1.</p>
</option>
<option>
<p><opt>rlimit-sigpending</opt> Defaults to -1.</p>
</option>
<option>
<p><opt>rlimit-msgqueue</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
@ -326,6 +351,9 @@ USA.
<opt>realtime-scheduling</opt> is enabled. The JACK client
libraries require a real-time prority of 9 by default. </p>
</option>
<option>
<p><opt>rlimit-rttime</opt> Defaults to 1000000.</p>
</option>
</section>