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