man-pages/man1/pax11publish.1.html
2021-03-31 01:06:50 +01:00

88 lines
4.2 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of pax11publish</TITLE>
</HEAD><BODY>
<H1>pax11publish</H1>
Section: User Commands (1)<BR>Updated: User<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
pax11publish - PulseAudio X11 Credential Utility
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>pax11publish -h
<P>
pax11publish [</B><I>options</I><B>] [-d]
<P>
pax11publish [</B><I>options</I><B>] -e
<P>
pax11publish [</B><I>options</I><B>] -i
<P>
pax11publish [</B><I>options</I><B>] -r
</B>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
The <I>pax11publish</I> utility can be used to dump or manipulate the PulseAudio server credentials that can be stored as properties on the X11 root window.
<P>
Please note that the loadable module <I>module-x11-publish</I> exports the same information directly from the PulseAudio sound server, and should in most cases be used in preference over this tool.
<P>
Use the following command to dump the raw PulseAudio-specific data that is stored in your X11 root window:
<P>
xprop -root | grep ^PULSE_
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<DL COMPACT>
<DT id="1"><B>-h</B><DD>
Show help.
<DT id="2"><B>-d</B><DD>
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.
<DT id="3"><B>-i</B><DD>
Similar to <B>-d</B>, however dumps them in a Bourne shell compatible format so they may be used together with the <I>eval</I> 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 <I>~/.config/pulse/cookie</I>.
<DT id="4"><B>-e</B><DD>
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 <I>~/.config/pulse/client.conf</I> (or <I>/etc/pulse/client.conf</I> if that file does not exist). If specific options are passed on the command line (<B>-S</B>, <B>-O</B>, <B>-I</B>, <B>-c</B>, see below), they take precedence. Also uploads the local authentication cookie <I>~/.config/pulse/cookie</I> to the X11 server.
<DT id="5"><B>-r</B><DD>
Removes the configured PulseAudio configuration from the X11 root window.
<DT id="6"><B>-D</B> <I>DISPLAY</I><DD>
Connect to the specified X11 display, instead of the default one configured in $DISPLAY.
<DT id="7"><B>-S</B> <I>SERVER</I><DD>
Only valid for <B>-e</B>: export the specified PulseAudio server as default to the X11 display instead of the one configured via local configuration.
<DT id="8"><B>-O</B> <I>SINK</I><DD>
Only valid for <B>-e</B>: export the specified sink as default sink to the X11 display instead of the one configured via local configuration.
<DT id="9"><B>-I</B> <I>SOURCE</I><DD>
Only valid for <B>-e</B>: export the specified source as default to the X11 display instead of the one configured via local configuration.
<DT id="10"><B>-c</B> <I>FILE</I><DD>
Only valid for <B>-e</B>: export the PulseAudio authentication cookie stored in the specified file to the X11 display instead of the one stored in <I>~/.config/pulse/cookie</I>.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>AUTHORS</H2>
The PulseAudio Developers &lt;pulseaudio-discuss (at) lists (dot) freedesktop (dot) org&gt;; PulseAudio is available from <B><A HREF="http://pulseaudio.org/">http://pulseaudio.org/</A></B>
<A NAME="lbAG">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?1+pulseaudio">pulseaudio</A>(1)</B>, <B><A HREF="/cgi-bin/man/man2html?1+xprop">xprop</A>(1)</B>
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="11"><A HREF="#lbAB">NAME</A><DD>
<DT id="12"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="13"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="14"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="15"><A HREF="#lbAF">AUTHORS</A><DD>
<DT id="16"><A HREF="#lbAG">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:21 GMT, March 31, 2021
</BODY>
</HTML>