]> code.delx.au - pulseaudio/blobdiff - man/pacmd.1.xml.in
pactl: Stop parsing option when the first non-option is encountered
[pulseaudio] / man / pacmd.1.xml.in
index c20c016e4dfd1ad10d3ccab5aced1e66d87419ee..7a555fe19b28373f911049f2c91252706d7f702e 100644 (file)
@@ -25,6 +25,8 @@ USA.
 
   <synopsis>
     <cmd>pacmd</cmd>
+    <cmd>pacmd <opt>--help</opt></cmd>
+    <cmd>pacmd <opt>--version</opt></cmd>
   </synopsis>
 
   <description>
@@ -34,16 +36,39 @@ USA.
     the commands also understood in the <file>default.pa</file>
     configuration scripts.</p>
 
-    <p>This program takes no command line options.</p>
+    <p>To exit the live shell, use ctrl+d. Note that the 'exit' command
+    inside the shell will tell the PulseAudio daemon itself to shutdown!</p>
+
+    <p>If any arguments are passed on the command line, they will be
+    passed into the live shell which will process the command and exit.</p>
   </description>
 
+  <options>
+
+    <option>
+      <p><opt>-h | --help</opt></p>
+
+      <optdesc><p>Show help.</p></optdesc>
+    </option>
+
+    <option>
+      <p><opt>--version</opt></p>
+
+      <optdesc><p>Show version information.</p></optdesc>
+    </option>
+
+  </options>
+
   <section name="Authors">
     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
   </section>
 
   <section name="See also">
     <p>
-      <manref name="pulseaudio" section="1"/>, <manref name="pactl" section="1"/>, <manref name="default.pa" section="5"/>
+      <manref name="pulse-cli-syntax" section="5"/>,
+      <manref name="pulseaudio" section="1"/>,
+      <manref name="pactl" section="1"/>,
+      <manref name="default.pa" section="5"/>
     </p>
   </section>