From: Peter Meerwald <pmeerw@pmeerw.net>
Date: Fri, 12 Apr 2013 08:53:00 +0000 (+0200)
Subject: doc: Explain PULSE_SERVER string in pulseaudio.1
X-Git-Url: https://code.delx.au/pulseaudio/commitdiff_plain/8946117ebf49604ff10368b19bbc2ff5f4c4f089

doc: Explain PULSE_SERVER string in pulseaudio.1

first attempt to document the "server string"
See https://bugs.freedesktop.org/show_bug.cgi?id=62444

quite a bit is missing: [hostname], defaults

Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>
---

diff --git a/man/pulseaudio.1.xml.in b/man/pulseaudio.1.xml.in
index b6dd4909..d7d74585 100644
--- a/man/pulseaudio.1.xml.in
+++ b/man/pulseaudio.1.xml.in
@@ -446,7 +446,13 @@ USA.
     <p>The PulseAudio client libraries check for the existence of the
     following environment variables and change their local configuration accordingly:</p>
 
-    <p><arg>$PULSE_SERVER</arg>: the server string specifying the server to connect to when a client asks for a sound server connection and doesn't explicitly ask for a specific server.</p>
+    <p><arg>$PULSE_SERVER</arg>: the server string specifying the server
+    to connect to when a client asks for a sound server connection and doesn't
+    explicitly ask for a specific server. The server string is a list of
+    server addresses separated by whitespace which are tried in turn. A server
+    address consists of an optional address type specifier (unix:, tcp:, tcp4:,
+    tcp6:), followed by a path or host address. A host address may include an
+    optional port number.</p>
 
     <p><arg>$PULSE_SINK</arg>: the symbolic name of the sink to connect to when a client creates a playback stream and doesn't explicitly ask for a specific sink.</p>