]> git.saurik.com Git - wxWidgets.git/blame - docs/doxygen/overviews/envvars.h
another batch of topic overviews reviewing (letters e,f)
[wxWidgets.git] / docs / doxygen / overviews / envvars.h
CommitLineData
15b6757b 1/////////////////////////////////////////////////////////////////////////////
3b88355f 2// Name: envvars.h
15b6757b
FM
3// Purpose: topic overview
4// Author: wxWidgets team
5// RCS-ID: $Id$
6// Licence: wxWindows license
7/////////////////////////////////////////////////////////////////////////////
8
9/*!
36c9828f 10
3b88355f 11 @page overview_envvars Environment variables
36c9828f 12
15b6757b
FM
13 This section describes all environment variables that affect execution of
14 wxWidgets programs.
36c9828f 15
3b88355f
FM
16 @beginDefList
17 @itemdef{WXTRACE,
18 (Debug build only.)
19 This variable can be set to a comma-separated list of trace masks used in
20 #wxLogTrace calls; wxLog::AddTraceMask is called for every mask
21 in the list during wxWidgets initialization.}
22 @itemdef{WXPREFIX,
23 (Unix only.)
24 Overrides installation prefix. Normally, the prefix
25 is hard-coded and is the same as the value passed to @c configure via
26 the @c --prefix switch when compiling the library (typically
27 @c /usr/local or @c /usr). You can set WXPREFIX if you are for example
28 distributing a binary version of an application and you don't know in advance
29 where it will be installed.}
30 @itemdef{WXMODE,
31 (wxMGL only.)
32 Sets MGL video mode. The value must be in form
33 @e widthx@e height-@e depth. The default is @c 640x480-16.}
34 @itemdef{WXSTDERR,
35 (wxMGL only.)
36 Redirects stderr output to a file.}
37
38*/
36c9828f 39