| <?xml version="1.0"?><!--*-nxml-*--> |
| <!DOCTYPE manpage SYSTEM "xmltoman.dtd"> |
| <?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?> |
| |
| <!-- |
| This file is part of PulseAudio. |
| |
| PulseAudio is free software; you can redistribute it and/or modify it |
| under the terms of the GNU Lesser General Public License as |
| published by the Free Software Foundation; either version 2.1 of the |
| License, or (at your option) any later version. |
| |
| PulseAudio is distributed in the hope that it will be useful, but WITHOUT |
| ANY WARRANTY; without even the implied warranty of MERCHANTABILITY |
| or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General |
| Public License for more details. |
| |
| You should have received a copy of the GNU Lesser General Public |
| License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>. |
| --> |
| |
| <manpage name="pax11publish" section="1" desc="PulseAudio X11 Credential Utility"> |
| |
| <synopsis> |
| <cmd>pax11publish <opt>-h</opt></cmd> |
| <cmd>pax11publish [<arg>options</arg>] [<opt>-d</opt>]</cmd> |
| <cmd>pax11publish [<arg>options</arg>] <opt>-e</opt></cmd> |
| <cmd>pax11publish [<arg>options</arg>] <opt>-i</opt></cmd> |
| <cmd>pax11publish [<arg>options</arg>] <opt>-r</opt></cmd> |
| </synopsis> |
| |
| <description> |
| <p>The <file>pax11publish</file> utility can be used to dump or |
| manipulate the PulseAudio server credentials that can be stored as |
| properties on the X11 root window.</p> |
| |
| <p>Please note that the loadable module |
| <file>module-x11-publish</file> exports the same information |
| directly from the PulseAudio sound server, and should in most |
| cases be used in preference over this tool.</p> |
| |
| <p>Use the following command to dump the raw |
| PulseAudio-specific data that is stored in your X11 root |
| window:</p> |
| |
| <p>xprop -root | grep ^PULSE_</p> |
| |
| </description> |
| |
| <options> |
| |
| <option> |
| <p><opt>-h</opt></p> |
| |
| <optdesc><p>Show help.</p></optdesc> |
| </option> |
| |
| <option> |
| <p><opt>-d</opt></p> |
| |
| <optdesc><p>Read the PulseAudio server credentials currently set |
| on the X11 root window and dump them in a human readable form. This reads the |
| PULSE_SERVER, PULSE_SINK, PULSE_SOURCE and PULSE_COOKIE |
| properties.</p></optdesc> |
| </option> |
| |
| <option> |
| <p><opt>-i</opt></p> |
| <optdesc><p>Similar to <opt>-d</opt>, however dumps them in a |
| Bourne shell compatible format so they may be used together with |
| the <file>eval</file> shell command to set the $PULSE_SERVER, |
| $PULSE_SINK, $PULSE_SOURCE environment variables. Also reads the |
| authentication cookie from the root window and stores it in |
| <file>~/.config/pulse/cookie</file>. </p></optdesc> |
| </option> |
| |
| <option> |
| <p><opt>-e</opt></p> |
| |
| <optdesc><p>Export the currently locally used sound server, |
| sink, source configuration to the X11 root window. This takes |
| the data from the $PULSE_SERVER, $PULSE_SINK, $PULSE_SOURCE |
| environment variables and combines them with the data from |
| <file>~/.config/pulse/client.conf</file> (or |
| <file>@PA_DEFAULT_CONFIG_DIR@/client.conf</file> if that file does not |
| exist). If specific options are passed on the command line |
| (<opt>-S</opt>, <opt>-O</opt>, <opt>-I</opt>, <opt>-c</opt>, see |
| below), they take precedence. Also uploads the local |
| authentication cookie <file>~/.config/pulse/cookie</file> to the X11 |
| server.</p></optdesc> |
| </option> |
| |
| <option> |
| <p><opt>-r</opt></p> |
| |
| <optdesc><p>Removes the configured PulseAudio configuration from the X11 root window.</p></optdesc> |
| </option> |
| |
| <option> |
| <p><opt>-D</opt> <arg>DISPLAY</arg></p> |
| |
| <optdesc><p>Connect to the specified X11 display, instead of the default one configured in $DISPLAY.</p></optdesc> |
| </option> |
| |
| <option> |
| <p><opt>-S</opt> <arg>SERVER</arg></p> |
| |
| <optdesc><p>Only valid for <opt>-e</opt>: export the specified |
| PulseAudio server as default to the X11 display instead of the |
| one configured via local configuration.</p></optdesc> |
| </option> |
| |
| <option> |
| <p><opt>-O</opt> <arg>SINK</arg></p> |
| |
| <optdesc><p>Only valid for <opt>-e</opt>: export the specified |
| sink as default sink to the X11 display instead of the one |
| configured via local configuration.</p></optdesc> |
| </option> |
| |
| <option> |
| <p><opt>-I</opt> <arg>SOURCE</arg></p> |
| |
| <optdesc><p>Only valid for <opt>-e</opt>: export the specified |
| source as default to the X11 display instead of the one |
| configured via local configuration.</p></optdesc> |
| </option> |
| |
| <option> |
| <p><opt>-c</opt> <arg>FILE</arg></p> |
| |
| <optdesc><p>Only valid for <opt>-e</opt>: export the PulseAudio |
| authentication cookie stored in the specified file to the X11 |
| display instead of the one stored in <file>~/.config/pulse/cookie</file>.</p></optdesc> |
| </option> |
| |
| </options> |
| |
| <section name="Authors"> |
| <p>The PulseAudio Developers <@PACKAGE_BUGREPORT@>; PulseAudio is available from <url href="@PACKAGE_URL@"/></p> |
| </section> |
| |
| <section name="See also"> |
| <p> |
| <manref name="pulseaudio" section="1"/>, <manref name="xprop" section="1"/> |
| </p> |
| </section> |
| |
| </manpage> |