]> code.delx.au - pulseaudio/blobdiff - man/pulse-cli-syntax.5.xml.in
pactl: Stop parsing option when the first non-option is encountered
[pulseaudio] / man / pulse-cli-syntax.5.xml.in
index 4f4e838d203f5f4fedf4100d65f9c786872203dc..a061c052a9e7c8dab4db25c89d4fad13efab1bdb 100644 (file)
@@ -24,7 +24,7 @@ USA.
 <manpage name="pulse-cli-syntax" section="5" desc="PulseAudio Command Line Interface Syntax">
 
   <synopsis>
-    <p><file>~/.pulse/default.pa</file></p>
+    <p><file>~/.config/pulse/default.pa</file></p>
     <p><file>@PA_DEFAULT_CONFIG_DIR@/default.pa</file></p>
     <p><file>@PA_DEFAULT_CONFIG_DIR@/system.pa</file></p>
   </synopsis>
@@ -32,16 +32,15 @@ USA.
   <description>
     <p>
       PulseAudio provides a simple command line language used by configuration
-      scripts and the pacmd interactive shell, and the modules module-cli and
+      scripts, the pacmd interactive shell, and the modules module-cli and
       module-cli-protocol-{unix,tcp}. Empty lines and lines beginning with a
       hashmark (#) are silently ignored. Several commands are supported.
     </p>
 
     <p>
-      Note that any boolean arguments can be given positively as '1', 'on' or any
-      word starting with the letters 't' or 'y'. Likewise, negative values can be
-      given as '0', 'off' or any word starting with the letters 'f' or 'n'.
-      Case is ignored.
+      Note that any boolean arguments can be given positively as '1', 't', 'y',
+      'true', 'yes' or 'on'. Likewise, negative values can be given as '0',
+      'f', 'n', 'false', 'no' or 'off'. Case is ignored.
     </p>
   </description>
 
@@ -100,9 +99,9 @@ USA.
     </option>
 
     <option>
-      <p><opt>unload-module</opt> <arg>index</arg></p>
-      <optdesc><p>Unload a module specified by its index in the module list as
-      returned by list-modules.</p></optdesc>
+      <p><opt>unload-module</opt> <arg>index|name</arg></p>
+      <optdesc><p>Unload a module, specified either by its index in the module
+      list or its name.</p></optdesc>
     </option>
 
     <option>
@@ -129,14 +128,14 @@ USA.
     </option>
 
     <option>
-      <p><opt>set-sink-input-volume</opt> <arg>index</arg> <arg>volume</arg></p>
-      <optdesc><p>Set the volume of a sink input specified
+      <p><opt>set-sink-input-volume|set-source-output-volume</opt> <arg>index</arg> <arg>volume</arg></p>
+      <optdesc><p>Set the volume of a sink input (resp. source output) specified
       by its index. The same volume rules apply as with set-sink-volume.</p></optdesc>
     </option>
 
     <option>
-      <p><opt>set-sink-input-mute</opt> <arg>index</arg> <arg>boolean</arg></p>
-      <optdesc><p>Mute or unmute a sink input specified
+      <p><opt>set-sink-input-mute|set-source-output-mute</opt> <arg>index</arg> <arg>boolean</arg></p>
+      <optdesc><p>Mute or unmute a sink input (resp. source output) specified
       by its index. The same mute rules apply as with set-sink-mute.</p></optdesc>
     </option>
   </section>
@@ -160,6 +159,11 @@ USA.
       <optdesc><p>Change the profile of a sink (resp. source).</p></optdesc>
     </option>
 
+    <option>
+      <p><opt>set-port-latency-offset</opt> <arg>card-index|card-name</arg> <arg>port-name</arg> <arg>offset</arg> </p>
+      <optdesc><p>Change the latency offset of a port belonging to the specified card</p></optdesc>
+    </option>
+
     <option>
       <p><opt>suspend-sink|suspend-source</opt> <arg>index|name</arg> <arg>boolean</arg></p>
       <optdesc><p>Suspend (i.e. disconnect from the underlying hardware) a sink
@@ -257,6 +261,12 @@ USA.
       <optdesc><p>Show source code location in log messages.</p></optdesc>
     </option>
 
+    <option>
+      <p><opt>set-log-target</opt> <arg>target</arg></p>
+      <optdesc><p>Change the log target (null, auto, journal, syslog, stderr,
+      file:PATH, newfile:PATH).</p></optdesc>
+    </option>
+
     <option>
       <p><opt>set-log-time</opt> <arg>boolean</arg></p>
       <optdesc><p>Show timestamps in log messages.</p></optdesc>
@@ -298,7 +308,7 @@ USA.
 
   <section name="Meta Commands">
     <p>
-      In addition the the commands described above there a few meta directives
+      In addition to the commands described above there are a few meta directives
       supported by the command line interpreter.
     </p>
     <option>
@@ -312,11 +322,6 @@ USA.
       cancel the execution of the current script file. This is a ignored when
       used on the interactive command line.</p></optdesc>
     </option>
-
-    <option>
-      <p><opt>.verbose</opt> and <opt>.noverbose</opt></p>
-      <optdesc><p>Enable (resp. disable) extra verbosity.</p></optdesc>
-    </option>
   </section>
 
   <section name="Authors">