added description of environment variables that affect wxWin programs

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@25780 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index 4c4179c2c662e1be311c0df0be55075b87472da0..f65752f25561e113a6da1c71089a10017835500b 100644 (file)
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -3577,7 +3577,9 @@ the value of the trace mask (possible during the run-time).
 
 For the second function (taking a string mask), the message is logged only if
 the mask has been previously enabled by the call to
 
 For the second function (taking a string mask), the message is logged only if
 the mask has been previously enabled by the call to

-\helpref{AddTraceMask}{wxlogaddtracemask}. The predefined string trace masks
+\helpref{AddTraceMask}{wxlogaddtracemask} or by setting
+\helpref{{\tt WXTRACE} environment variable}{envvars}.
+The predefined string trace masks

 used by wxWindows are:
 
 \begin{itemize}\itemsep=0pt
 used by wxWindows are:
 
 \begin{itemize}\itemsep=0pt

diff --git a/docs/latex/wx/tenvvars.tex b/docs/latex/wx/tenvvars.tex
new file mode 100644 (file)
index 0000000..0a683b9
--- /dev/null
+++ b/docs/latex/wx/tenvvars.tex
@@ -0,0 +1,32 @@
+\section{Environment variables}\label{envvars}
+%\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
+%\setfooter{\thepage}{}{}{}{}{\thepage}%
+
+This section describes all environment variables that affect execution of
+wxWindows programs.
+
+\twocolwidtha{5cm}%
+\begin{twocollist}\itemsep=0pt
+
+\twocolitem{\tt{WXTRACE}}{(Debug build only.)
+This variable can be set to comma-separated list of trace masks used in
+\helpref{wxLogTrace}{wxlogtrace} calls;
+\helpref{wxLog::AddTraceMask}{wxlogaddtracemask} is called for every mask
+in the list during wxWindows initialization.}
+
+\twocolitem{\tt{WXPREFIX}}{(Unix only.)
+Overrides installation prefix. Normally, the prefix
+is hard-coded and is same as the value passed to {\tt configure} via
+the {\tt --prefix} switch when compiling the library (typically
+{\tt /usr/local} or {\tt /usr}). You can set WXPREFIX if you are for example
+distributing binary version of an application and you don't know in advance
+where it will be installed.}
+
+\twocolitem{\tt{WXMODE}}{(wxMGL only.)
+Sets MGL video mode. The value must be in form
+{\it width}x{\it height}-{\it depth}. The default is {\tt 640x480-16}.}
+
+\twocolitem{\tt{WXSTDERR}}{(wxMGL only.)
+Redirects stderr output to a file.}
+
+\end{twocollist}

diff --git a/docs/latex/wx/topics.tex b/docs/latex/wx/topics.tex
index b106646ef0ea8decd41d2fbd4523c96a4ca33d45..bae331270e2fe63458622ecda5179c89f413cd31 100644 (file)
--- a/docs/latex/wx/topics.tex
+++ b/docs/latex/wx/topics.tex
@@ -56,5 +56,6 @@ This chapter contains a selection of topic overviews, first things first:
 \input tdb.tex
 \input tipc.tex
 \input wxhtml.tex
 \input tdb.tex
 \input tipc.tex
 \input wxhtml.tex

+\input tenvvars.tex

 \input wxPython.tex
 
 \input wxPython.tex