[pulseaudio-discuss] [PATCH] doc: Explain PULSE_SERVER string in pulseaudio.1

[David Henningsson]

On 04/12/2013 10:53 AM, Peter Meerwald wrote:
> 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 at pmeerw.net>
> ---
>   man/pulseaudio.1.xml.in | 8 +++++++-
>   1 file changed, 7 insertions(+), 1 deletion(-)
>
> diff --git a/man/pulseaudio.1.xml.in b/man/pulseaudio.1.xml.in
> index 12f05e8..cf687f4 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 existance 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>
>
>

Pushed. Thanks!


-- 
David Henningsson, Canonical Ltd.
https://launchpad.net/~diwic