[pulseaudio-discuss] [PATCH 1/8] man: Fix XDG_RUNTIME_DIR variable reference.

[Glenn Golden]

Colin Guthrie <colin at mageia.org> [2014-10-18 20:43:24 +0200]:
> diff --git a/man/pulse-daemon.conf.5.xml.in b/man/pulse-daemon.conf.5.xml.in
> index 8bd076d..754312e 100644
> --- a/man/pulse-daemon.conf.5.xml.in
> +++ b/man/pulse-daemon.conf.5.xml.in
> @@ -124,7 +124,7 @@ USA.
>  
>      <option>
>        <p><opt>use-pid-file=</opt> Create a PID file in the runtime directory
> -      (<file>$XDG_RUNTIMEDIR/pulse/pid</file>). If this is enabled you may
> +      (<file>$XDG_RUNTIME_DIR/pulse/pid</file>). If this is enabled you may
>        use commands like <opt>--kill</opt> or <opt>--check</opt>. If
>        you are planning to start more than one PulseAudio process per
>        user, you better disable this option since it effectively

I realize that the above patch simply fixes a typo, but wanted to ask about
a larger issue: In accordance with a long-running thread on the list, in
particular this message:

    http://lists.freedesktop.org/archives/pulseaudio-discuss/2014-September/021523.html

it seems that the determination of the appropriate runtime directory is
significantly more complicated than simply $XDG_RUNTIME_DIR (per 5a-e in
the above message).

I'm not suggesting that that entire set of possibilities be listed in detail
in pulse-daemon.conf.5, but perhaps the above could be rephrased something
like this:

  Create a PID file in the appropriate runtime directory.  If this is enabled
  you may use commands like...

This of course leaves open to the reader's imagination what might constitute
"the appropriate runtime directory", but perhaps this can be addressed later
via a footnote or citation once some authoritative documentation describing
that procedure can be supplied (a task that I'm currently working on.)