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