[vlc-commits] doc: document the environment variables (fixes #8835)

[Rémi Denis-Courmont]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Fri May 30 22:00:23 2014 +0800| [63dfea6d0d1cd63c1774ecd8821800c753266cc0] | committer: Rémi Denis-Courmont

doc: document the environment variables (fixes #8835)

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=63dfea6d0d1cd63c1774ecd8821800c753266cc0
---

 doc/vlc.1 |   44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/doc/vlc.1 b/doc/vlc.1
index 6324770..a3ad1c3 100644
--- a/doc/vlc.1
+++ b/doc/vlc.1
@@ -69,6 +69,50 @@ Execute a playlist command. Commands are:
 .B quit
 (close VLC).
 
+.SH ENVIRONMENT VARIABLES
+The following environment variables may affect VLC:
+
+.TP
+.B DISPLAY
+The X11 display server address.
+
+.TP
+.B http_proxy
+The HTTP proxy server URL.
+
+.TP
+.B OSSAUDIO_DEV
+The default audio output device,
+used by the OSSv4 output plugin.
+
+.TP
+.B VLC_DATA_PATH
+The directory containing VLC run-time data files (e.g. /usr/share/vlc).
+
+.TP
+.B VLC_PLUGIN_PATH
+An extra directory to load VLC plugins from.
+
+.TP
+.B VLC_VERBOSE
+The level of verbosity for log messages
+(0: silent, 1: error/info, 2: warning, 3: debug).
+
+.TP
+.B XDG_CACHE_DIR XDG_CONFIG_DIR XDG_DATA_DIR
+The directories to store user cached data, user configuration files and
+user data files respectively.
+
+.TP
+.B XDG_DOCUMENTS_DIR XDG_DOWNLOAD_DIR XDG_MUSIC_DIR XDG_PICTURES_DIR XDG_VIDEO_DIR
+The directories to fetch or store user text files,
+downloads, music, pictures (i.e. snapshots), and video respectively.
+
+.TP
+.B XDG_SESSION_COOKIE
+The unique identifier of the desktop session,
+used by the PulseAudio output plugin.
+
 .SH SEE ALSO
 Online documentation: http://www.videolan.org/doc/
 .PP