]> code.delx.au - pulseaudio/blobdiff - man/pulse-daemon.conf.5.xml.in
Fix spelling of separated: s, sepera, separa, g
[pulseaudio] / man / pulse-daemon.conf.5.xml.in
index 6fcdd0ec02fece763ec1cf2db99b22c51ddf937b..de4511a1dd9a264ac209223f31792faed0554534 100644 (file)
@@ -24,14 +24,14 @@ USA.
 <manpage name="pulse-daemon.conf" section="5" desc="PulseAudio daemon configuration file">
 
   <synopsis>
-    <p><file>~/.pulse/daemon.conf</file></p>
+    <p><file>~/.config/pulse/daemon.conf</file></p>
 
     <p><file>@PA_DEFAULT_CONFIG_DIR@/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
+    a file <file>~/.config/pulse/daemon.conf</file> on startup and when that
     file doesn't exist from
     <file>@PA_DEFAULT_CONFIG_DIR@/daemon.conf</file>. Please note that the
     server also reads a configuration script on startup
@@ -124,7 +124,7 @@ USA.
 
     <option>
       <p><opt>use-pid-file=</opt> Create a PID file in the runtime directory
-      (<file>$HOME/.pulse/*-runtime/pid</file>). If this is enabled you may
+      (<file>$XDG_RUNTIMEDIR/pulse/pid</file>). If 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
@@ -149,6 +149,22 @@ USA.
       argument takes precedence.</p>
     </option>
 
+    <option>
+      <p><opt>local-server-type=</opt> Please don't use this option if
+      you don't have to! This option is currently only useful when you
+      want D-Bus clients to use a remote server. This option may be
+      removed in future versions. If you only want to run PulseAudio
+      in the system mode, use the <opt>system-instance</opt> option.
+      This option takes one of <opt>user</opt>, <opt>system</opt> or
+      <opt>none</opt> as the argument. This is essentially a duplicate
+      for the <opt>system-instance</opt> option. The difference is the
+      <opt>none</opt> option, which is useful when you want to use a
+      remote server with D-Bus clients. If both this and
+      <opt>system-instance</opt> are defined, this option takes
+      precedence. Defaults to whatever the <opt>system-instance</opt>
+      is set.</p>
+    </option>
+
     <option>
       <p><opt>enable-shm=</opt> Enable data transfer via POSIX
       shared memory. Takes a boolean argument, defaults to
@@ -251,7 +267,7 @@ USA.
     <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
+      path separated by colons. The default path depends on compile
       time settings. The <opt>--dl-search-path</opt> command line
       option takes precedence. </p>
     </option>
@@ -260,7 +276,7 @@ USA.
       <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
+      <file>~/.config/pulse/default.pa</file>, and if that file does not
       exist fall back to the system wide installed version
       <file>@PA_DEFAULT_CONFIG_DIR@/default.pa</file>. If run in system-wide
       mode the file <file>@PA_DEFAULT_CONFIG_DIR@/system.pa</file> is used
@@ -312,7 +328,7 @@ USA.
 
     <option>
       <p><opt>log-backtrace=</opt> When greater than 0, with each
-      logged message log a code stack trace up the the specified
+      logged message log a code stack trace up the specified
       number of stack frames. Defaults to <opt>0</opt>.</p>
     </option>
 
@@ -414,6 +430,16 @@ USA.
       <p><opt>default-channel-map</opt> The default channel map.</p>
     </option>
 
+    <option>
+      <p><opt>alternate-sample-rate</opt> The alternate sample
+      frequency. Sinks and sources will use either the
+      default-rate-rate value or this alternate value, typically 44.1
+      or 48kHz. Switching between default and alternate values is
+      enabled only when the sinks/sources are suspended. This option
+      is ignored in passthrough mode where the stream rate will be used.
+      If set to zero, this feature is disabled.</p>
+    </option>
+
   </section>
 
   <section name="Default Fragment Settings">
@@ -438,7 +464,7 @@ USA.
 
   </section>
 
-  <section name="Default Sync Volume Settings">
+  <section name="Default Deferred Volume Settings">
 
     <p>With the flat volume feature enabled, the sink HW volume is set
     to the same level as the highest volume input stream. Any other streams
@@ -448,20 +474,20 @@ USA.
     cause the resulting output sound to be momentarily too loud or too soft.
     So to ensure SW and HW volumes are applied concurrently without any
     glitches, their application needs to be synchronized. The sink
-    implementation needs to support synchronized volumes. The following
+    implementation needs to support deferred volumes. The following
     parameters can be used to refine the process.</p>
 
     <option>
-      <p><opt>enable-sync-volume=</opt> Enable sync volume for the sinks that
+      <p><opt>enable-deferred-volume=</opt> Enable deferred volume for the sinks that
       support it. This feature is enabled by default.</p>
     </option>
     <option>
-      <p><opt>sync-volume-safety-margin-usec=</opt> The amount of time (in
+      <p><opt>deferred-volume-safety-margin-usec=</opt> The amount of time (in
       usec) by which the HW volume increases are delayed and HW volume
       decreases are advanced. Defaults to 8000 usec.</p>
     </option>
     <option>
-      <p><opt>sync-volume-extra-delay-usec=</opt> The amount of time (in usec)
+      <p><opt>deferred-volume-extra-delay-usec=</opt> The amount of time (in usec)
       by which HW volume changes are delayed. Negative values are also allowed.
       Defaults to 0.</p>
     </option>