man/pax11publish.1.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 <!--
   6 This file is part of PulseAudio.
   7
   8 PulseAudio is free software; you can redistribute it and/or modify it
   9 under the terms of the GNU Lesser General Public License as
  10 published by the Free Software Foundation; either version 2.1 of the
  11 License, or (at your option) any later version.
  12
  13 PulseAudio is distributed in the hope that it will be useful, but WITHOUT
  14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  15 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  16 Public License for more details.
  17
  18 You should have received a copy of the GNU Lesser General Public
  19 License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
  20 -->
  21
  22 <manpage name="pax11publish" section="1" desc="PulseAudio X11 Credential Utility">
  23
  24   <synopsis>
  25     <cmd>pax11publish <opt>-h</opt></cmd>
  26     <cmd>pax11publish [<arg>options</arg>] [<opt>-d</opt>]</cmd>
  27     <cmd>pax11publish [<arg>options</arg>] <opt>-e</opt></cmd>
  28     <cmd>pax11publish [<arg>options</arg>] <opt>-i</opt></cmd>
  29     <cmd>pax11publish [<arg>options</arg>] <opt>-r</opt></cmd>
  30   </synopsis>
  31
  32   <description>
  33     <p>The <file>pax11publish</file> utility can be used to dump or
  34     manipulate the PulseAudio server credentials that can be stored as
  35     properties on the X11 root window.</p>
  36
  37     <p>Please note that the loadable module
  38     <file>module-x11-publish</file> exports the same information
  39     directly from the PulseAudio sound server, and should in most
  40     cases be used in preference over this tool.</p>
  41
  42     <p>Use the following command to dump the raw
  43     PulseAudio-specific data that is stored in your X11 root
  44     window:</p>
  45
  46     <p>xprop -root | grep ^PULSE_</p>
  47
  48   </description>
  49
  50   <options>
  51
  52     <option>
  53       <p><opt>-h</opt></p>
  54
  55       <optdesc><p>Show help.</p></optdesc>
  56     </option>
  57
  58     <option>
  59       <p><opt>-d</opt></p>
  60
  61       <optdesc><p>Read the PulseAudio server credentials currently set
  62       on the X11 root window and dump them in a human readable form. This reads the
  63       PULSE_SERVER, PULSE_SINK, PULSE_SOURCE and PULSE_COOKIE
  64       properties.</p></optdesc>
  65     </option>
  66
  67     <option>
  68       <p><opt>-i</opt></p>
  69       <optdesc><p>Similar to <opt>-d</opt>, however dumps them in a
  70       Bourne shell compatible format so they may be used together with
  71       the <file>eval</file> shell command to set the $PULSE_SERVER,
  72       $PULSE_SINK, $PULSE_SOURCE environment variables. Also reads the
  73       authentication cookie from the root window and stores it in
  74       <file>~/.config/pulse/cookie</file>. </p></optdesc>
  75     </option>
  76
  77     <option>
  78       <p><opt>-e</opt></p>
  79
  80       <optdesc><p>Export the currently locally used sound server,
  81       sink, source configuration to the X11 root window. This takes
  82       the data from the $PULSE_SERVER, $PULSE_SINK, $PULSE_SOURCE
  83       environment variables and combines them with the data from
  84       <file>~/.config/pulse/client.conf</file> (or
  85       <file>@PA_DEFAULT_CONFIG_DIR@/client.conf</file> if that file does not
  86       exist). If specific options are passed on the command line
  87       (<opt>-S</opt>, <opt>-O</opt>, <opt>-I</opt>, <opt>-c</opt>, see
  88       below), they take precedence. Also uploads the local
  89       authentication cookie <file>~/.config/pulse/cookie</file> to the X11
  90       server.</p></optdesc>
  91     </option>
  92
  93     <option>
  94       <p><opt>-r</opt></p>
  95
  96       <optdesc><p>Removes the configured PulseAudio configuration from the X11 root window.</p></optdesc>
  97     </option>
  98
  99     <option>
 100       <p><opt>-D</opt> <arg>DISPLAY</arg></p>
 101
 102       <optdesc><p>Connect to the specified X11 display, instead of the default one configured in $DISPLAY.</p></optdesc>
 103     </option>
 104
 105     <option>
 106       <p><opt>-S</opt> <arg>SERVER</arg></p>
 107
 108       <optdesc><p>Only valid for <opt>-e</opt>: export the specified
 109       PulseAudio server as default to the X11 display instead of the
 110       one configured via local configuration.</p></optdesc>
 111     </option>
 112
 113     <option>
 114       <p><opt>-O</opt> <arg>SINK</arg></p>
 115
 116       <optdesc><p>Only valid for <opt>-e</opt>: export the specified
 117       sink as default sink to the X11 display instead of the one
 118       configured via local configuration.</p></optdesc>
 119     </option>
 120
 121     <option>
 122       <p><opt>-I</opt> <arg>SOURCE</arg></p>
 123
 124       <optdesc><p>Only valid for <opt>-e</opt>: export the specified
 125       source as default to the X11 display instead of the one
 126       configured via local configuration.</p></optdesc>
 127     </option>
 128
 129     <option>
 130       <p><opt>-c</opt> <arg>FILE</arg></p>
 131
 132       <optdesc><p>Only valid for <opt>-e</opt>: export the PulseAudio
 133       authentication cookie stored in the specified file to the X11
 134       display instead of the one stored in <file>~/.config/pulse/cookie</file>.</p></optdesc>
 135     </option>
 136
 137   </options>
 138
 139   <section name="Authors">
 140     <p>The PulseAudio Developers &lt;@PACKAGE_BUGREPORT@&gt;; PulseAudio is available from <url href="@PACKAGE_URL@"/></p>
 141   </section>
 142
 143   <section name="See also">
 144     <p>
 145       <manref name="pulseaudio" section="1"/>, <manref name="xprop" section="1"/>
 146     </p>
 147   </section>
 148
 149 </manpage>