[pulseaudio-discuss] [PATCH] manpage: reformat overlong lines; try to document environment variables

[Tanu Kaskinen]

On Sun, 2012-01-08 at 13:16 +0100, Peter Meerwald wrote:
> this patch adds documentation for the following envirnoment variables used
> by PulseAudio:
> 
> PULSE_COOKIE
> PULSE_PROP_...
> PULSE_PROP_OVERRIDE_...
> PULSE_RUNTIME_PATH
> PULSE_STATE_PATH
> PULSE_CONFIG_PATH
> PULSE_LATENCY_MSEC
> PULSE_NO_SIMD
> VALGRIND

Great, many thanks!

> the list is probably not complete; some env. vars. should probably not be
> documented (?) but rather be dropped

Which ones you think should maybe be dropped?

> there is currently no section in pulseaudio.1 documenting env. vars. relating
> to the daemon, only client-side env. vars. are described -- this might not be
> the best place to put this information

The manual page is for the daemon executable, so I think the server-side
variables belong there. There needs to be just some separator
(sub-heading)? between the client-side and server-side variables.

> which env. var. relate to
> daemon?

PULSE_STATE_PATH
PULSE_NO_SIMD

> client?

PULSE_SERVER
PULSE_SINK
PULSE_SOURCE
PULSE_BINARY
PULSE_CLIENTCONFIG
PULSE_COOKIE
PULSE_PROP_...
PULSE_PROP_OVERRIDE
PULSE_LATENCY_MSEC

> both?

PULSE_RUNTIME_PATH
PULSE_CONFIG_PATH (the man page says that this is only for the client
configuration - that's incorrect)
VALGRIND (I think this is mainly interesting for the server side, but I
think there's code that uses this and is used at both sides)

-- 
Tanu