diff options
Diffstat (limited to 'man/pax11publish.1')
| -rw-r--r-- | man/pax11publish.1 | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/man/pax11publish.1 b/man/pax11publish.1 new file mode 100644 index 0000000..ec241b9 --- /dev/null +++ b/man/pax11publish.1 @@ -0,0 +1,57 @@ +.TH pax11publish 1 User Manuals +.SH NAME +pax11publish \- PulseAudio X11 Credential Utility +.SH SYNOPSIS +\fBpax11publish -h\fB + +pax11publish [\fIoptions\fB] [-d\fB] + +pax11publish [\fIoptions\fB] -e\fB + +pax11publish [\fIoptions\fB] -i\fB + +pax11publish [\fIoptions\fB] -r\fB +\f1 +.SH DESCRIPTION +The \fIpax11publish\f1 utility can be used to dump or manipulate the PulseAudio server credentials that can be stored as properties on the X11 root window. + +Please note that the loadable module \fImodule-x11-publish\f1 exports the same information directly from the PulseAudio sound server, and should in most cases be used in preference over this tool. + +Use the following command to dump the raw PulseAudio-specific data that is stored in your X11 root window: + +xprop -root | grep ^PULSE_ +.SH OPTIONS +.TP +\fB-h\f1 +Show help. +.TP +\fB-d\f1 +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. +.TP +\fB-i\f1 +Similar to \fB-d\f1, however dumps them in a Bourne shell compatible format so they may be used together with the \fIeval\f1 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 \fI~/.config/pulse/cookie\f1. +.TP +\fB-e\f1 +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 \fI~/.config/pulse/client.conf\f1 (or \fI/usr/local/etc/pulse/client.conf\f1 if that file does not exist). If specific options are passed on the command line (\fB-S\f1, \fB-O\f1, \fB-I\f1, \fB-c\f1, see below), they take precedence. Also uploads the local authentication cookie \fI~/.config/pulse/cookie\f1 to the X11 server. +.TP +\fB-r\f1 +Removes the configured PulseAudio configuration from the X11 root window. +.TP +\fB-D\f1 \fIDISPLAY\f1 +Connect to the specified X11 display, instead of the default one configured in $DISPLAY. +.TP +\fB-S\f1 \fISERVER\f1 +Only valid for \fB-e\f1: export the specified PulseAudio server as default to the X11 display instead of the one configured via local configuration. +.TP +\fB-O\f1 \fISINK\f1 +Only valid for \fB-e\f1: export the specified sink as default sink to the X11 display instead of the one configured via local configuration. +.TP +\fB-I\f1 \fISOURCE\f1 +Only valid for \fB-e\f1: export the specified source as default to the X11 display instead of the one configured via local configuration. +.TP +\fB-c\f1 \fIFILE\f1 +Only valid for \fB-e\f1: export the PulseAudio authentication cookie stored in the specified file to the X11 display instead of the one stored in \fI~/.config/pulse/cookie\f1. +.SH AUTHORS +The PulseAudio Developers <pulseaudio-discuss (at) lists (dot) freedesktop (dot) org>; PulseAudio is available from \fBhttp://pulseaudio.org/\f1 +.SH SEE ALSO +\fBpulseaudio(1)\f1, \fBxprop(1)\f1 |