code.delx.au - pulseaudio/blob - man/pulse-daemon.conf.5.xml.in

   1 <?xml version="1.0"?><!--*-nxml-*-->
   2 <!DOCTYPE manpage SYSTEM "xmltoman.dtd">
   3 <?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
   4
   5 <!-- $Id$ -->
   6
   7 <!--
   8 This file is part of PulseAudio.
   9
  10 PulseAudio is free software; you can redistribute it and/or modify it
  11 under the terms of the GNU Lesser General Public License as
  12 published by the Free Software Foundation; either version 2.1 of the
  13 License, or (at your option) any later version.
  14
  15 PulseAudio is distributed in the hope that it will be useful, but WITHOUT
  16 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  17 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  18 Public License for more details.
  19
  20 You should have received a copy of the GNU Lesser General Public
  21 License along with PulseAudio; if not, write to the Free Software
  22 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  23 USA.
  24 -->
  25
  26 <manpage name="pulse-daemon.conf" section="5" desc="PulseAudio daemon configuration file">
  27
  28   <synopsis>
  29     <p><file>~/.pulse/daemon.conf</file></p>
  30
  31     <p><file>@pulseconfdir@/daemon.conf</file></p>
  32   </synopsis>
  33
  34   <description>
  35     <p>The PulseAudio sound server reads configuration directives from
  36     a file <file>~/.pulse/daemon.conf</file> on startup, and when that
  37     file doesn't exist from
  38     <file>@pulseconfdir@/daemon.conf</file>. Please note that the
  39     server also reads a configuration script on startup
  40     <file>default.pa</file> which also contains runtime configuration
  41     directives.</p>
  42
  43     <p>The configuration file is a simple collection of variable
  44     declarations. If the configuration file parser encounters either ;
  45     or # for it ignores the rest of the line until its end.</p>
  46
  47     <p>For the settings that take a boolean argument, the values
  48     <opt>true</opt>, <opt>yes</opt>, <opt>on</opt> and <opt>1</opt>
  49     are equivalent, resp. <opt>false</opt>, <opt>no</opt>,
  50     <opt>off</opt>, <opt>0</opt>.</p>
  51
  52   </description>
  53
  54   <section name="General Directives">
  55
  56     <option>
  57       <p><opt>daemonize= </opt> Daemonize after startup. Takes a
  58       boolean value, defaults to "no". The <opt>--daemonize</opt>
  59       command line option takes precedence.</p>
  60     </option>
  61
  62     <option>
  63       <p><opt>fail=</opt> Fail to start up if any of the directives
  64       in the configuration script <file>default.pa</file>
  65       fail. Takes a boolean argument, defaults to "yes". The <opt>--fail</opt> command line
  66       option takes precedence.</p>
  67     </option>
  68
  69     <option>
  70       <p><opt>disallow-module-loading=</opt> Disallow module loading
  71       after startup. This is a security feature that makes sure that
  72       no further modules may be loaded into the PulseAudio server
  73       after startup completed. It is recommended to enable this when
  74       <opt>system-instance</opt> is enabled. Please note that certain
  75       features like automatic hot-plug support will not work if this
  76       option is enabled. Takes a boolean argument, defaults to
  77       <opt>no</opt>. The <opt>--disallow-module-loading</opt> command line
  78       option takes precedence.</p>
  79     </option>
  80
  81     <option>
  82       <p><opt>resample-method=</opt> The resampling algorithm to
  83       use. Use one of <opt>src-sinc-best-quality</opt>,
  84       <opt>src-sinc-medium-quality</opt>, <opt>src-sinc-fastest</opt>,
  85       <opt>src-zero-order-hold</opt>, <opt>src-linear</opt>,
  86       <opt>trivial</opt>, <opt>speex-float-N</opt>,
  87       <opt>speex-fixed-N</opt>, <opt>ffmpeg</opt>. See the
  88       documentation of libsamplerate for an explanation for the
  89       different src- methods. The method <opt>trivial</opt> is the most basic
  90       algorithm implemented. If you're tight on CPU consider using
  91       this. On the other hand it has the worst quality of them
  92       all. The Speex resamplers take an integer quality setting in the
  93       range 0..9 (bad...good). They exist in two flavours: <opt>fixed</opt> and
  94       <opt>float</opt>. The former uses fixed point numbers, the latter relies on
  95       floating point numbers. On most desktop CPUs the float point
  96       resmampler is a lot faster, and it also offers slightly better
  97       quality. See the output of <opt>dump-resample-methods</opt> for
  98       a complete list of all available resamplers. Defaults to
  99       <opt>speex-float-3</opt>. The <opt>--resample-method</opt>
 100       command line option takes precedence. Note that some modules
 101       overwrite or allow overwriting of the resampler to use.</p>
 102     </option>
 103
 104     <option>
 105       <p><opt>use-pid-file=</opt> Create a PID file in
 106       <file>/tmp/pulse-$USER/pid</file>. Of this is enabled you may
 107       use commands like <opt>--kill</opt> or <opt>--check</opt>. If
 108       you are planning to start more than one PulseAudio process per
 109       user, you better disable this option since it effectively
 110       disables multiple instances. Takes a boolean argument, defaults
 111       to <opt>yes</opt>. The <opt>--no-cpu-limit</opt> command line
 112       option takes precedence.</p>
 113     </option>
 114
 115     <option>
 116       <p><opt>no-cpu-limit=</opt> Do not install the CPU load limiter,
 117       even on platforms where it is supported. This option is useful
 118       when debugging/profiling PulseAudio to disable disturbing
 119       SIGXCPU signals. Takes a boolean argument, defaults to <opt>no</opt>. The
 120       <opt>--no-cpu-limit</opt> command line argument takes
 121       precedence.</p>
 122     </option>
 123
 124
 125     <option>
 126       <p><opt>system-instance=</opt> Run the daemon as system-wide
 127       instance, requires root priviliges. Takes a boolean argument,
 128       defaults to <opt>no</opt>. The <opt>--system</opt> command line
 129       argument takes precedence.</p>
 130     </option>
 131
 132
 133     <option>
 134       <p><opt>disable-shm=</opt> Disable data transfer via POSIX
 135       shared memory. Takes a boolean argument, defaults to
 136       <opt>no</opt>. The <opt>--disable-shm</opt> command line
 137       argument takes precedence.</p>
 138     </option>
 139
 140   </section>
 141
 142   <section name="Scheduling">
 143
 144     <option>
 145       <p><opt>high-priority=</opt> Renice the daemon after startup to
 146       become a high-priority process. This a good idea if you
 147       experience drop-outs during playback. However, this is a certain
 148       security issue, since it works when called SUID root only, or
 149       RLIMIT_NICE is used. root is dropped immediately after gaining
 150       the nice level on startup, thus it is presumably safe. See
 151       <manref section="1" name="pulseaudio"/> for more
 152       information. Takes a boolean argument, defaults to "yes". The <opt>--high-priority</opt>
 153       command line option takes precedence.</p>
 154     </option>
 155
 156     <option>
 157       <p><opt>realtime-scheduling=</opt> Try to acquire SCHED_FIFO
 158       scheduling for the IO threads. The same security concerns as
 159       mentioned above apply. However, if PA enters an endless loop,
 160       realtime scheduling causes a system lockup. Thus, realtime
 161       scheduling should only be enabled on trusted machines for
 162       now. Please not that only the IO threads of PulseAudio are made
 163       real-time. The controlling thread is left a normally scheduled
 164       thread. Thus enabling the high-priority option is orthogonal.
 165       See <manref section="1" name="pulseaudio"/> for more
 166       information. Takes a boolean argument, defaults to "no". The
 167       <opt>--realtime</opt> command line option takes precedence.</p>
 168     </option>
 169
 170     <option>
 171       <p><opt>realtime-priority=</opt> The realtime priority to
 172       acquire, if <opt>realtime-scheduling</opt> is enabled. Note: JACK uses 10
 173       by default, 9 for clients. Thus it is recommended to choose the
 174       PulseAudio real-time priorities lower. Some PulseAudio threads
 175       might choose a priority a little lower or higher than the
 176       specified value. Defaults to "5".</p>
 177     </option>
 178
 179     <option>
 180       <p><opt>nice-level=</opt> The nice level to acquire for the
 181       daemon, if <opt>high-priority</opt> is enabled. Note: on some
 182       distributions X11 uses -10 by default. Defaults to -11.</p>
 183     </option>
 184
 185   </section>
 186
 187   <section name="Idle Times">
 188
 189     <option>
 190       <p><opt>exit-idle-time=</opt> Terminate the daemon after the
 191       last client quit and this time in seconds passed. Use a negative value to
 192       disable this feature. Defaults to -1. The
 193       <opt>--exit-idle-time</opt> command line option takes
 194       precedence.</p>
 195     </option>
 196
 197     <option>
 198       <p><opt>module-idle-time=</opt> Unload autoloaded modules after
 199       being idle for this time in seconds. Defaults to 20. The
 200       <opt>--module-idle-time</opt> command line option takes
 201       precedence.</p>
 202     </option>
 203
 204     <option>
 205       <p><opt>scache-idle-time=</opt> Unload autoloaded sample cache
 206       entries after being idle for this time in seconds. Defaults to
 207       20. The <opt>--scache-idle-time</opt> command line option takes
 208       precedence.</p>
 209     </option>
 210
 211   </section>
 212
 213   <section name="Paths">
 214
 215     <option>
 216       <p><opt>dl-search-path=</opt> The path were to look for dynamic
 217       shared objects (DSOs/plugins). You may specify more than one
 218       path seperated by colons. The default path depends on compile
 219       time settings. The <opt>--dl-search-path</opt> command line
 220       option takes precedence. </p>
 221     </option>
 222
 223     <option>
 224       <p><opt>default-script-file=</opt> The default configuration
 225       script file to load. Specify an empty string for not loading a
 226       default script file. The default behaviour is to load
 227       <file>~/.pulse/default.pa</file>, and if that file does not
 228       exist fall back to the system wide installed version
 229       <file>@pulseconfdir@/default.pa</file>. If <opt>-n</opt> is
 230       passed on the command line the default configuration script is
 231       ignored.</p>
 232     </option>
 233
 234   </section>
 235
 236   <section name="Logging">
 237
 238     <option>
 239       <p><opt>log-target=</opt> The default log target. Use either
 240       <opt>stderr</opt>, <opt>syslog</opt> or <opt>auto</opt>. The
 241       latter is equivalent to <opt>sylog</opt> in case
 242       <opt>daemonize</opt> is enabled, otherwise to
 243       <opt>stderr</opt>. Defaults to <opt>auto</opt>. The
 244       <opt>--log-target</opt> command line option takes
 245       precedence.</p>
 246     </option>
 247
 248     <option>
 249       <p><opt>log-level=</opt> Log level, one of <opt>debug</opt>,
 250       <opt>info</opt>, <opt>notice</opt>, <opt>warning</opt>,
 251       <opt>error</opt>. Log messages with a lower log level than
 252       specified here are not logged. Defaults to
 253       <opt>notice</opt>. The <opt>--log-level</opt> command line
 254       option takes precedence. The <opt>-v</opt> command line option
 255       might alter this setting.</p>
 256     </option>
 257
 258   </section>
 259
 260   <section name="Resource Limits">
 261
 262     <p>See <manref name="getrlimit" section="2"/> for
 263     more information. Set to -1 if PulseAudio shall not touch the resource
 264     limit. Not all resource limits are available on all operating
 265     systems.</p>
 266
 267     <option>
 268       <p><opt>rlimit-as</opt> Defaults to -1.</p>
 269     </option>
 270     <option>
 271       <p><opt>rlimit-core</opt> Defaults to -1.</p>
 272     </option>
 273     <option>
 274       <p><opt>rlimit-data</opt> Defaults to -1.</p>
 275     </option>
 276     <option>
 277       <p><opt>rlimit-fsize</opt> Defaults to -1.</p>
 278     </option>
 279     <option>
 280       <p><opt>rlimit-nofile</opt> Defaults to 256.</p>
 281     </option>
 282     <option>
 283       <p><opt>rlimit-stack</opt> Defaults to -1.</p>
 284     </option>
 285     <option>
 286       <p><opt>rlimit-nproc</opt> Defaults to -1.</p>
 287     </option>
 288     <option>
 289       <p><opt>rlimit-memlock</opt> Defaults to 16 KiB. Please note
 290       that the JACK client libraries may require more locked
 291       memory.</p>
 292     </option>
 293     <option>
 294       <p><opt>rlimit-nice</opt> Defaults to 31. Please make sure that
 295       the default nice level as configured with <opt>nice-level</opt>
 296       fits in this resource limit, if <opt>high-priority</opt> is
 297       enabled.</p>
 298     </option>
 299     <option>
 300       <p><opt>rlimit-rtprio</opt> Defaults to 9. Please make sure that
 301       the default real-time priority level as configured with
 302       <opt>realtime-priority=</opt> fits in this resource limit, if
 303       <opt>realtime-scheduling</opt> is enabled. The JACK client
 304       libraries require a real-time prority of 9 by default. </p>
 305     </option>
 306
 307   </section>
 308
 309   <section name="Default Device Settings">
 310
 311     <p>Most drivers try to open the audio device with these settings
 312     and then fall back to lower settings. The default settings are CD
 313     quality: 16bit native endian, 2 channels, 44100 Hz sampling.</p>
 314
 315     <option>
 316       <p><opt>default-sample-format=</opt> The default sampling
 317       format. Specify one of <opt>u8</opt>, <opt>s16le</opt>,
 318       <opt>s16be</opt>, <opt>float32le</opt>, <opt>float32be</opt>,
 319       <opt>ulaw</opt>, <opt>alaw</opt>. Depending on the endianess of
 320       the CPU the formats <opt>s16ne</opt>, <opt>s16re</opt>,
 321       <opt>float32ne</opt>, <opt>float32re</opt> (for native,
 322       resp. reverse endian) are available as aliases.</p>
 323     </option>
 324
 325     <option>
 326       <p><opt>default-sample-rate=</opt> The default sample frequency.</p>
 327     </option>
 328
 329     <option>
 330       <p><opt>default-sample-channels</opt> The default number of channels.</p>
 331     </option>
 332
 333   </section>
 334
 335   <section name="Default Fragment Settings">
 336
 337     <p>Some hardware drivers require the hardware playback buffer to
 338     be subdivided into several fragments. It is possible to change
 339     these buffer metrics for machines with high scheduling
 340     latencies. Not all possible values that may be configured here are
 341     available in all hardware. The driver will to find the nearest
 342     setting supported.</p>
 343
 344     <option>
 345       <p><opt>default-fragments=</opt> The default number of
 346       fragments. Defaults to 4.</p>
 347     </option>
 348     <option>
 349       <p><opt>default-fragment-size-msec=</opt>The duration of a
 350       single fragment. Defaults to 25ms (i.e. the total buffer is thus
 351       100ms long).</p>
 352     </option>
 353
 354   </section>
 355
 356   <section name="Authors">
 357     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
 358   </section>
 359
 360   <section name="See also">
 361     <p>
 362       <manref name="pulse-client.conf" section="5"/>, <manref name="default.pa" section="5"/>, <manref name="pulseaudio" section="1"/>, <manref name="pacmd" section="1"/>
 363     </p>
 364   </section>
 365
 366 </manpage>