← Back to branch summary

~diwic/ubuntu/lucid/pulseaudio/bugfixes

« back to all changes in this revision

Viewing changes to man/pulse-daemon.conf.5

  • Committer: Bazaar Package Importer
  • Author(s): Luke Yelavich
  • Date: 2008-11-04 15:46:00 UTC
  • mfrom: (1.2.1 upstream) (1.1.6 lenny)
  • Revision ID: james.westby@ubuntu.com-20081104154600-hlzknpcazaam0nxm
Tags: 0.9.13-1ubuntu1
* Merge from Debian unstable, remaining changes:
  - Don't build against, and create jack package. Jack is not in main.
  - Remove --disable-per-user-esound-socket from configure flags, as we still
    want per user esound sockets.
  - Remove stop links from rc0 and rc6.
  - Change default resample algorithm and bubffer size.
  - Add alsa configuration files to route alsa applications via pulseaudio.
  - Move libasound2-plugins from Recommends to Depends.
* debian/pulseaudio.preinst: When upgrading from intrepid, remove
  /etc/X11/Xsession.d/70pulseaudio, as this was used to minimize a race
  condition when starting GNOME in intrepid. This race should not exist in
  jaunty once libcanberra is built to use pulseaudio as a backend.
* Do not spawn a pulseaudio server if clients fail to find a running server.
* Remove explicit version dependency for libspeex-dev to allow the package
  to be built for now.
* Regenerate autotools files to work with Ubuntu's newer libtool/libltdl.
* debian/control: libpulsecore5 -> libpulsecore8 to match the library
  soname.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/pulse-daemon.conf.5
7
7
\fI/etc/pulse/daemon.conf\fB
8
8
\f1
9
9
.SH DESCRIPTION
10
 
The PulseAudio sound server reads configuration directives from a file \fI~/.pulse/daemon.conf\f1 on startup, and when that file doesn't exist from \fI/etc/pulse/daemon.conf\f1. Please note that the server also reads a configuration script on startup \fIdefault.pa\f1 which also contains runtime configuration directives.
11
 
 
12
 
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.
13
 
 
14
 
For the settings that take a boolean argument, the values \fBtrue\f1, \fByes\f1, \fBon\f1 and \fB1\f1 are equivalent, resp. \fBfalse\f1, \fBno\f1, \fBoff\f1, \fB0\f1.
 
10
The PulseAudio sound server reads configuration directives from a file \fI~/.pulse/daemon.conf\f1 on startup and when that file doesn't exist from \fI/etc/pulse/daemon.conf\f1. Please note that the server also reads a configuration script on startup \fIdefault.pa\f1 which also contains runtime configuration directives.
 
11
 
 
12
The configuration file is a simple collection of variable declarations. If the configuration file parser encounters either ; or # it ignores the rest of the line until its end.
 
13
 
 
14
For the settings that take a boolean argument the values \fBtrue\f1, \fByes\f1, \fBon\f1 and \fB1\f1 are equivalent, resp. \fBfalse\f1, \fBno\f1, \fBoff\f1, \fB0\f1.
15
15
.SH GENERAL DIRECTIVES
16
16
.TP
17
17
\fBdaemonize= \f1 Daemonize after startup. Takes a boolean value, defaults to "no". The \fB--daemonize\f1 command line option takes precedence.
20
20
.TP
21
21
\fBdisallow-module-loading=\f1 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 \fBsystem-instance\f1 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 \fBno\f1. The \fB--disallow-module-loading\f1 command line option takes precedence.
22
22
.TP
 
23
\fBdisallow-exit=\f1 Disallow exit on user request. Defaults to \fBno\f1.
 
24
.TP
23
25
\fBresample-method=\f1 The resampling algorithm to use. Use one of \fBsrc-sinc-best-quality\f1, \fBsrc-sinc-medium-quality\f1, \fBsrc-sinc-fastest\f1, \fBsrc-zero-order-hold\f1, \fBsrc-linear\f1, \fBtrivial\f1, \fBspeex-float-N\f1, \fBspeex-fixed-N\f1, \fBffmpeg\f1. See the documentation of libsamplerate for an explanation for the different src- methods. The method \fBtrivial\f1 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: \fBfixed\f1 and \fBfloat\f1. 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 \fBdump-resample-methods\f1 for a complete list of all available resamplers. Defaults to \fBspeex-float-3\f1. The \fB--resample-method\f1 command line option takes precedence. Note that some modules overwrite or allow overwriting of the resampler to use.
24
26
.TP
25
27
\fBdisable-remixing=\f1 Never upmix or downmix channels to different channel maps. Instead, do a simple name-based matching only.
26
28
.TP
 
29
\fBdisable-lfe-remixing=\f1 When upmixing or downmixing ignore LFE channels. When this option is on the output LFE channel will only get a signal when an input LFE channel is 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. Defaults to "on".
 
30
.TP
27
31
\fBuse-pid-file=\f1 Create a PID file in \fI/tmp/pulse-$USER/pid\f1. Of this is enabled you may use commands like \fB--kill\f1 or \fB--check\f1. 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 \fByes\f1. The \fB--no-cpu-limit\f1 command line option takes precedence.
28
32
.TP
29
33
\fBno-cpu-limit=\f1 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 \fBno\f1. The \fB--no-cpu-limit\f1 command line argument takes precedence.
31
35
\fBsystem-instance=\f1 Run the daemon as system-wide instance, requires root priviliges. Takes a boolean argument, defaults to \fBno\f1. The \fB--system\f1 command line argument takes precedence.
32
36
.TP
33
37
\fBdisable-shm=\f1 Disable data transfer via POSIX shared memory. Takes a boolean argument, defaults to \fBno\f1. The \fB--disable-shm\f1 command line argument takes precedence.
 
38
.TP
 
39
\fBshm-size-bytes=\f1 Sets the shared memory segment size for the daemon, in bytes. If left unspecified or is set to 0 it will default to some system-specific default, usually 64 MiB. Please note that usually there is no need to change this value, unless you are running an OS kernel that does not do memory overcommit.
34
40
.SH SCHEDULING
35
41
.TP
36
42
\fBhigh-priority=\f1 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 \fBpulseaudio(1)\f1 for more information. Takes a boolean argument, defaults to "yes". The \fB--high-priority\f1 command line option takes precedence.
51
57
.TP
52
58
\fBdl-search-path=\f1 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 \fB--dl-search-path\f1 command line option takes precedence. 
53
59
.TP
54
 
\fBdefault-script-file=\f1 The default configuration script file to load. Specify an empty string for not loading a default script file. The default behaviour is to load \fI~/.pulse/default.pa\f1, and if that file does not exist fall back to the system wide installed version \fI/etc/pulse/default.pa\f1. If \fB-n\f1 is passed on the command line the default configuration script is ignored.
 
60
\fBdefault-script-file=\f1 The default configuration script file to load. Specify an empty string for not loading a default script file. The default behaviour is to load \fI~/.pulse/default.pa\f1, and if that file does not exist fall back to the system wide installed version \fI/etc/pulse/default.pa\f1. If run in system-wide mode the file \fI/etc/pulse/system.pa\f1 is used instead. If \fB-n\f1 is passed on the command line or \fBdefault-script-file=\f1 is disabled the default configuration script is ignored.
 
61
.TP
 
62
\fBdefault-script-file=\f1 Load the default configuration script file as specified in \fBdefault-script-file=\f1. Defaults to "yes".
55
63
.SH LOGGING
56
64
.TP
57
65
\fBlog-target=\f1 The default log target. Use either \fBstderr\f1, \fBsyslog\f1 or \fBauto\f1. The latter is equivalent to \fBsylog\f1 in case \fBdaemonize\f1 is enabled, otherwise to \fBstderr\f1. Defaults to \fBauto\f1. The \fB--log-target\f1 command line option takes precedence.
62
70
.TP
63
71
\fBrlimit-as\f1 Defaults to -1.
64
72
.TP
 
73
\fBrlimit-rss\f1 Defaults to -1.
 
74
.TP
65
75
\fBrlimit-core\f1 Defaults to -1.
66
76
.TP
67
77
\fBrlimit-data\f1 Defaults to -1.
74
84
.TP
75
85
\fBrlimit-nproc\f1 Defaults to -1.
76
86
.TP
 
87
\fBrlimit-locks\f1 Defaults to -1.
 
88
.TP
 
89
\fBrlimit-sigpending\f1 Defaults to -1.
 
90
.TP
 
91
\fBrlimit-msgqueue\f1 Defaults to -1.
 
92
.TP
77
93
\fBrlimit-memlock\f1 Defaults to 16 KiB. Please note that the JACK client libraries may require more locked memory.
78
94
.TP
79
95
\fBrlimit-nice\f1 Defaults to 31. Please make sure that the default nice level as configured with \fBnice-level\f1 fits in this resource limit, if \fBhigh-priority\f1 is enabled.
80
96
.TP
81
97
\fBrlimit-rtprio\f1 Defaults to 9. Please make sure that the default real-time priority level as configured with \fBrealtime-priority=\f1 fits in this resource limit, if \fBrealtime-scheduling\f1 is enabled. The JACK client libraries require a real-time prority of 9 by default. 
 
98
.TP
 
99
\fBrlimit-rttime\f1 Defaults to 1000000.
82
100
.SH DEFAULT DEVICE SETTINGS
83
101
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.
84
102
.TP
85
 
\fBdefault-sample-format=\f1 The default sampling format. Specify one of \fBu8\f1, \fBs16le\f1, \fBs16be\f1, \fBfloat32le\f1, \fBfloat32be\f1, \fBulaw\f1, \fBalaw\f1. Depending on the endianess of the CPU the formats \fBs16ne\f1, \fBs16re\f1, \fBfloat32ne\f1, \fBfloat32re\f1 (for native, resp. reverse endian) are available as aliases.
 
103
\fBdefault-sample-format=\f1 The default sampling format. Specify one of \fBu8\f1, \fBs16le\f1, \fBs16be\f1, \fBs32le\f1, \fBs32be\f1, \fBfloat32le\f1, \fBfloat32be\f1, \fBulaw\f1, \fBalaw\f1. Depending on the endianess of the CPU the formats \fBs16ne\f1, \fBs16re\f1, \fBs32ne\f1, \fBs32re\f1, \fBfloat32ne\f1, \fBfloat32re\f1 (for native, resp. reverse endian) are available as aliases.
86
104
.TP
87
105
\fBdefault-sample-rate=\f1 The default sample frequency.
88
106
.TP