revert instructions for makefile.sc as new makefiles not ready
[wxWidgets.git] / docs / msw / install.txt
1 Installing wxWindows 2.5.0
2 --------------------------
3
4 This is wxWindows 2.5.0 for Microsoft Windows 9x/ME, Windows NT, Windows 2000
5 and Windows XP. This is an unstable development release. Note that unstable in
6 this context doesn't mean that it crashes a lot, just that the library API may
7 change in backwards incompatible way during the 2.5 branch life time.
8
9
10 IMPORTANT NOTE: If you experience problems installing, please
11 re-read this instructions and other related files (changes.txt,
12 readme.txt, FAQ) carefully before mailing wx-users. Preferably,
13 try to fix the problem first and then upload a patch to
14 SourceForge:
15
16   http://sourceforge.net/patch/?group_id=9863
17
18 Please report bugs using the SourceForge bug tracker:
19
20   http://sourceforge.net/bugs/?group_id=9863
21
22
23 Unarchiving
24 ===========
25
26 A setup program is provided (setup.exe) to automatically copy
27 files to a directory on your hard disk. Do not install into a
28 path that contains spaces. To avoid confusion with other
29 wxWindows installations that might be on your machine, the
30 installation program does not se the WXWIN environment variable;
31 please set this by hand via the System applet if you wish to
32 make it permanent.
33
34 The setup program contains the following:
35
36 - All common, generic and MSW-specific wxWindows source;
37 - samples;
38 - documentation in Windows Help format;
39 - makefiles for most Windows compilers, plus CodeWarrior,
40   BC++ and VC++ IDE files;
41 - JPEG library source;
42 - TIFF library source;
43 - Object Graphics Library;
44 - Tex2RTF source;
45 - Dialog Editor binary.
46
47 Alternatively, you may unarchive the .zip form by hand:
48 wxMSW-x.y.z.zip where x.y.z is the version number.
49
50 Unarchive the required files plus any optional documentation
51 files into a suitable directory such as c:\wx.
52
53 Other add-on packages are available from the wxWindows Web site, such as:
54
55 - mmedia.zip. Audio, CD, video access for Windows and Linux.
56 - ogl3.zip. Object Graphics Library: build network diagrams, CASE tools etc.
57 - tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
58   the same document source.
59
60
61 General installation notes
62 ==========================
63
64 If installing from the CVS server, copy include/wx/msw/setup0.h to
65 include/wx/msw/setup.h and edit the resulting file to choose
66 the features you would like to compile wxWindows with[out].
67
68
69 Compilation
70 ===========
71
72 The following sections explain how to compile wxWindows with each supported
73 compiler. Search for one of Microsoft/Borland/Watcom/Symantec/Metrowerks/
74 Cygwin/Mingw32 to quickly locate the instructions for your compiler.
75
76 All makefiles and project are located in build\msw directory.
77
78 Where compiled files are stored
79 -------------------------------
80
81 After succesful compilation you'll find the libraries in a subdirectory
82 of lib directory named after the compiler and DLL/staitc settings.
83 A couple of examples:
84
85   lib\vc_lib                    VC++ compiled static libraries
86   lib\vc_dll                    VC++ DLLs
87   lib\bcc_lib                   Static libraries for Borland C++
88   lib\wat_dll                   Watcom C++ DLLs
89
90 Names of compiled wxWindows libraries follow this scheme: libraries that don't
91 depend on GUI components begin with "wxbase" followed by version number and
92 letters indicating if the library is compiled as Unicode ('u') and/or debug
93 build ('d'). Last component of them name is name of wxWindows component
94 (unless you built the library as single monolithic library; look for
95 "Configuring the build" below). This is a typical set of release ANSI build
96 libraries (release versions on left, debug on right side):
97
98   wxbase25.lib              wxbase25d.lib
99   wxbase25_net.lib          wxbase25d_net.lib
100   wxbase25_xml.lib          wxbase25d_xml.lib
101   wxmsw25_core.lib          wxmsw25d_core.lib
102   wxmsw25_html.lib          wxmsw25d_html.lib
103   wxmsw25_adv.lib           wxmsw25d_adv.lib
104
105 Their Unicode debug counterparts in wxUniversal build would be
106
107   wxbase25ud.lib
108   wxbase25ud_net.lib
109   wxbase25ud_xml.lib        (notice these libs are same for wxUniv and wxMSW)
110   wxmswuniv25ud_core.lib
111   wxmswuniv25ud_html.lib
112   wxmswuniv25ud_adv.lib
113
114 These directories also contain subdirectory with wx/setup.h header. This
115 subdirectory is named after port, Unicode, wxUniv and debug settings and 
116 you must add it to include paths when compiling your application. Some
117 examples:
118
119   lib\vc_lib\msw\wx\setup.h          VC++ static, wxMSW
120   lib\vc_lib\mswud\wx\setup.h        VC++ static, wxMSW, Unicode, debug
121   lib\vc_lib\mswunivd\wx\setup.h     VC++ static, wxUniversal, debug
122
123 Below are compiler specific notes followed by customizing instructions that
124 apply to all compilers (search for "Configuring the build").
125
126
127 Microsoft Visual C++ compilation
128 --------------------------------
129
130 You may wish to visit http://wiki.wxwindows.org/wiki.pl?MSVC for a more
131 informal and more detailed description of the process summarized below.
132
133 Please note that the VC++ 6.0 project files will work for VC++ .NET also.
134
135 Also note that you can make the project files work with VC++ 5.0 but you'll
136 need to edit .dsp file by hand before this is possible (change the version in
137 the .dsp file header from 6.0 to 5.0).
138
139 Using project files (VC++ 6 and later):
140
141 1. Unarchive wxWindows-x.y.z-vc.zip, the VC++ 6 project
142    makefiles (already included in wxMSW-x.y.z.zip and the setup version).
143 2. Open build\msw\wx.dsw, which has configurations for static
144    compilation or DLL compilation, and each of these available in
145    Unicode/ANSI, Debug/Release and wxUniversal or native variations.
146    Normally you'll use a static linking ANSI configuration.
147    Choose the Win32 Debug or Win32 Release configuration (or any other that
148    suits your needs) and use Batch Build to compile _all_ projects. If you
149    know you won't need some of the libraries (i.e. html part), you don't have
150    to compile it.  It will also produce similar variations on jpeg.lib,
151    png.lib, tiff.lib, zlib.lib, and regex.lib.
152    If you want to build DLLs, you have to either build them one by one in
153    proper order (jpeg, png, tiff, zlib, regex, expat, base, core, the rest
154    in any order) or to use wx_dll.dsw workspace which has correct dependencies.
155 3. Open a sample project file, choose a configuration such as
156    Win32 Debug using Build | Set Active Configuration..., and compile.
157    The project files don't use precompiled headers, to save disk
158    space, but you can switch PCH compiling on for greater speed.
159    NOTE: you may also use samples/samples.dsw to access all
160    sample projects without opening each workspace individually.
161    You can use the Batch Build facility to make several samples
162    at a time.
163
164 Using makefiles:
165
166 1. Change directory to build\msw. Type:
167
168   'nmake -f makefile.vc'
169
170    to make the wxWindows core library as release DLL.
171    See "Configuring the build" for instruction how to build debug or static
172    libraries.
173 2. Change directory to samples and type 'nmake -f makefile.vc'
174    to make all the samples. You can also make them individually.
175
176 Makefile notes:
177
178   Use the 'clean' target to clean all objects, libraries and
179   executables.
180
181 Note (1): if you wish to use templates, please edit
182 include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
183 Without this, the redefinition of 'new' will cause problems in
184 the headers. Alternatively, #undef new before including template headers.
185 You will also need to set wxUSE_IOSTREAMH to 0 if you will be
186 using templates, to avoid the non-template stream files being included
187 within wxWindows.
188
189 Note (2): libraries and applications generated with makefiles and
190 project files are now (hopefully) compatible where static libraries
191 are concerned, but please exercise caution nevertheless and if
192 possible, use one method or the other.
193
194 Note (3): VC++ 5's optimization code seems to be broken and can
195 cause both compile and run-time problems: this can be seen when
196 deleting an object Dialog Editor, in Release mode with optimizations
197 on. If in doubt, switch off optimisations, although this will result in much
198 larger executables. It seems possible that the library can be created with
199 strong optimization, so long as the application is not strongly
200 optimized. For example, in wxWindows project, set to 'Minimum
201 Size'. In Dialog Editor project, set to 'Customize: Favor Small
202 Code' (and no others). This will then work.
203
204 Note (4): some crash problems can be due to inconsistent compiler
205 options. If strange/weird/impossible things start to happen please
206 check (dumping IDE project file as makefile and doing text comparison
207 if necessary) that the project settings, especially the list of defined
208 symbols, struct packing, etc. are exactly the same for all items in
209 the project. After this, delete everything (including PCH) and recompile.
210
211 Note (5): to create your own IDE files, see the technical note on the
212 wxWindows web site or CD-ROM, entitled "Compiling wxWindows
213 applications in the VC++ IDE" (technical note docs/tech/tn0010.htm in the
214 wxWindows distribution). You can also copy .dsp and .dsw
215 files from an existing wxWindows sample and adapt them.
216
217
218 Visual C++ 1.5 compilation (16-bit)
219 -----------------------------------
220
221 No longer supported
222
223
224 Borland C++ 5.0/5.5 compilation
225 -------------------------------
226
227 Compiling using the makefiles (updated 24 Sept 02):
228
229 1. Change directory to build\msw. Type 'make -f makefile.bcc' to
230    make the wxWindows core library. Ignore the compiler warnings.
231    This produces a couple of libraries in the lib\bcc_mswdll directory.
232
233 2. Change directory to a sample or demo such as samples\minimal, and type
234   'make -f makefile.bcc'. This produces a windows exe file - by default 
235    in the bcc_mswdll subdirectory.
236
237 Note (1): the wxWindows makefiles assume dword structure alignment. Please
238 make sure that your own project or makefile settings use the
239 same alignment, or you could experience mysterious crashes. To
240 change the alignment, change CPPFLAGS in build\msw\config.bcc.
241
242 Note (2): if you get undefined _SQL... symbols at link time,
243 either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
244 directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
245 recompile wxWindows. The same applies if compiling using the IDE.
246
247
248 Note (3): If you wish debug messages to be sent to the console in
249 debug mode, edit makefile.bcc and change /aa to /Tpe in link commands.
250
251 Compiling using the IDE files for Borland C++ 5.0: not supported - please
252 use version 2.4.1 (using the make utility in commandline mode works fine_
253
254 Compiling using CBuilder (v1-v6): not supported - please
255 use version 2.4.1 (using the make utility in commandline mode works fine_
256
257
258 ** REMEMBER **
259
260 In all of your wxWindows applications, your source code should include
261 the following preprocessor directive:
262
263 #ifdef __BORLANDC__
264 #pragma hdrstop
265 #endif
266
267 (check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for
268 more details)
269
270
271 Borland 16 Bit compilation for Windows 3.1
272 ------------------------------------------
273
274 The last version of wxWindows to support 16-bit compilation with Borland was
275 2.2.7 - Please download and read the instructions in that release
276
277 Watcom C++ 10.6/11 and OpenWatcom compilation
278 ---------------------------------------------
279
280 1. Change directory to build\msw. Type 'wmake -f makefile.wat' to
281    make the wxWindows core library.
282 2. Change directory to samples\minimal and type 'wmake -f makefile.wat'
283    to make this sample. Repeat for other samples of interest.
284
285
286 Note (1): if your installation of Watcom doesn't have odbc32.lib file and
287           you need it (i.e. you have wxUSE_ODBC=1), you can use the file
288           from lib\watcom directory. See the notes in that directory.
289
290 Note (2): if variant.cpp is compiled with date/time class options, the linker
291           gives up. So the date/time option is switched off for Watcom C++.
292           Also, wxAutomationObject is not compiled with Watcom C++ 10.
293
294 Note (3): RawBitmaps won't work at present because they use unsupported template
295           classes
296
297 Note (4): if Watcom can't read the precompiled header when building a sample,
298           try deleting .pch files in build\msw\wat_* and compiling
299           the sample again.
300
301
302 Metrowerks CodeWarrior compilation
303 ----------------------------------
304
305 1. CodeWarrior Pro7 project files in XML format are already
306    included in wxMSW-2.5.0.zip and the setup version.
307 2. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if
308    you are working from the CVS version) to make sure the settings reflect
309    what you want.  If you aren't sure, leave it alone and go with the
310    default settings.  A few notes:
311        - Don't use wxUSE_DEBUG_NEW_ALWAYS: it doesn't mix well with MSL
312        - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports
313          will be rather confusing due to interactions with the MSL ANSI
314          and runtime libs.
315 3. The project file to build the Win32 wxWindows libraries relies on the
316    Batch File Runner plug-in.  This plug-in is not installed as part of
317    a normal CW7 installation.  However, you can find this plug-in on the
318    CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the
319    "Batch File Post Linker".
320 4. If you choose not to install the Batch File Runner plug-in, then you
321    need to do the following by hand:
322       (1) Create the directories lib\cw7msw\include\wx and copy the file
323           include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
324           working from the CVS version) to lib\cw7msw\include\wx\setup.h
325       (2) Create the directories lib\cw7mswd\include\wx and copy the file
326           include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
327           working from the CVS version) to lib\cw7mswd\include\wx\setup.h
328 5. Import src\wxWindowsW7.xml to create the project file wxWindowsW7.mcp.
329    Store this project file in directory src.  You may get warnings about
330    not being able to find certain project paths; ignore these warnings, the
331    appropriate paths will be created during the build by the Batch File Runner.
332 6. Choose the wxlib Win32 debug or wxlib Win32 Release target and build.  You
333    will get some warnings about hidden virtual functions, illegal conversions
334    from const pointers to pointers, etc., all of which you can safely ignore.
335    ***Note:  if you get errors that the compiler can't find "wx/setup.h", just
336    stop the build and build again.  These errors occur because sometimes the
337    compiler starts doing its thing before the copying of setup.h has completed.
338 7. The following libraries will be produced depending on chosen
339    target:
340        - wx_x86.lib             ANSI Release (static)
341        - wx_x86_d.lib           ANSI Debug (static)
342 8. Sorry, I haven't had time yet to create and test unicode or DLL versions.
343    Volunteers for this are welcome (as neither DLLs nor unicode builds are
344    big priorities for me ;).
345 9. CodeWarrior Pro7 project files (in XML format) are also provided for some
346    of the samples.  In particular, there are project files for the minimal,
347    controls, dialogs, dnd, nd docview samples.  You can use these project
348    files as templates for the other samples and for your own projects.
349        - For example, to make a project file for the "newgrid" sample,
350          just copy the project file for the "minimal" sample, minimalW7.mcp
351          (made by importing minimalW7.xml into CodeWarrior), into the
352          sample/newgrid directory, calling it newgridW7.mcp.  Open
353          newgridW7.mcp and revise the project by deleting the files
354          minimal.rc and minimal.cpp and adding the files griddemo.rc and
355          griddemo.cpp.  Build and run....
356
357
358 Cygwin/MinGW compilation
359 ------------------------
360
361 wxWindows 2 supports Cygwin (formerly GnuWin32) betas and
362 releases, and MinGW. Cygwin can be downloaded from:
363
364     http://sources.redhat.com/cygwin/
365
366 and MinGW from:
367
368     http://www.mingw.org/
369
370 Both Cygwin and MinGW can be used with configure (assuming you have MSYS
371 installed in case of MinGW). You will need new enough MinGW version, preferably
372 MinGW 2.0 (ships with gcc3) or at least 1.0 (gcc-2.95.3). GCC versions older
373 than 2.95.3 don't work; you can use wxWindows 2.4 with them.
374
375 NOTE: some notes specific to old Cygwin (< 1.1.x) are at the end of this
376       section (see OLD VERSIONS)
377
378 There are two methods of compiling wxWindows, by using the
379 makefiles provided or by using 'configure'.
380
381 Retrieve and install the latest version of Cygwin, or MinGW, as per
382 the instructions with either of these packages.
383
384 If using MinGW, you can download the add-on MSYS package to
385 provide Unix-like tools that you'll need to build wxWindows using configure.
386
387 Using makefiles directly
388 ------------------------
389
390 NOTE: The makefile are for compilation under Cygwin, MSYS, or
391       command.com/cmd.exe, they won't work in other environments
392       (such as UNIX)
393
394 Here are the steps required using the provided makefiles:
395
396 - If you are using gcc-2.95, edit build\msw\config.gcc and set the GCC_VERSION
397   variable to "2.95".
398
399 - Use the makefile.gcc files for compiling wxWindows and samples,
400   e.g. to compile a debugging version of wxWindows:
401   > cd c:\wx\build\msw
402   > make -f makefile.gcc BUILD=debug
403   > cd c:\wx\samples\minimal
404   > make -f makefile.gcc BUILD=debug
405   (See below for more options.)
406
407   Ignore the warning about the default entry point.
408
409 - Use the 'strip' command to reduce executable/dll size (note that
410   stripping an executable/dll will remove debug information!).
411
412 All targets have 'clean' targets to allow removal of object files
413 and other intermediate compiler files.
414
415 Using configure
416 ---------------
417
418 Instead of using the makefiles, you can use the configure
419 system to generate appropriate makefiles, as used on Unix
420 and Mac OS X systems.
421
422 Change directory to the root of the wxWindows distribution,
423 make a build directory, and run configure and make in this directory.
424
425 For example:
426
427   cd $WXWIN
428   mkdir build-debug
429   cd build-debug
430   ../configure --with-msw --enable-debug --enable-debug_gdb --disable-shared
431   make
432   make install % This step is optional, see note (8) below.
433   cd samples/minimal
434   make
435   ./minimal.exe
436
437 Notes:
438
439 1. See also the Cygwin/MinGW on the web site or CD-ROM for
440    further information about using wxWindows with these compilers.
441
442 2. libwx.a is 100 MB or more - but much less if compiled with no
443    debug info (-g0) and level 4 optimization (-O4).
444
445 3. If you get a link error under MinGW 2.95.2 referring to:
446
447    EnumDAdvise__11IDataObjectPP13IEnumSTATDATA@8
448
449    then you need to edit the file objidl.h at line 663 and add
450    a missing PURE keyword:
451
452    STDMETHOD(EnumDAdvise)(THIS_ IEnumSTATDATA**) PURE;
453
454 4. There's a bug in MinGW headers for some early distributions.
455
456    in include/windows32/defines.h, where it says:
457
458    #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
459
460    it should say:
461
462    #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
463
464    (a missing bracket).
465
466 5. OpenGL support should work with MinGW as-is. However,
467    if you wish to generate import libraries appropriate either for
468    the MS OpenGL libraries or the SGI OpenGL libraries, go to
469    include/wx/msw/gl and use:
470
471      dlltool -k -d opengl.def -llibopengl.a
472
473    for the SGI DLLs, or
474
475      dlltool -k -d opengl32.def -llibopengl32.a
476
477    and similarly for glu[32].def.
478
479 6. The 'make install' step is optional, and copies files
480    as follows:
481
482    /usr/local/lib - wxmswXYZd.dll.a and wxmswXYZd.dll
483    /usr/local/include/wx - wxWindows header files
484    /usr/local/bin - wx-config
485
486    You may need to do this if using wx-config with the
487    default root path.
488
489 7. With Cygwin, you can invoke gdb --nw myfile.exe to
490    debug an executable. If there are memory leaks, they will be
491    flagged when the program quits. You can use Cygwin gdb
492    to debug MinGW executables.
493
494
495 OLD VERSIONS:
496
497 - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
498   to set up appropriate variables, if necessary mounting drives.
499   Run it before compiling.
500
501 - For Cygwin, make sure there's a \tmp directory on your
502   Windows drive or bison will crash (actually you don't need
503   bison for ordinary wxWindows compilation: a pre-generated .c file is
504   supplied).
505
506 - If using GnuWin32 b18, you will need to copy windres.exe
507   from e.g. the MinGW distribution, to a directory in your path.
508
509
510 Symantec & DigitalMars C++ compilation
511 --------------------------------------
512 The DigitalMars compiler is a free succssor to the Symantec compiler
513 and can be downloaded from http://www.digitalmars.com/
514    
515 1. You need to download and unzip in turn (later packages will overwrite
516    older files)
517       Digital Mars C/C++ Compiler Version 8.34 
518       Basic utilities
519    from http://www.digitalmars.com/download/freecompiler.html [25 Aug 03, CE]
520
521 2. Change directory to src\msw. Type 'make -f makefile.sc' to
522    make the wxWindows core library.
523 3. Change directory to samples\minimal and type 'make -f makefile.sc'
524    to make this sample. Most of the other samples also work.
525 4. Note that there is a compiler bug in verson 8.35 of the DM compiler which
526    prevents wxWindows from building.
527
528 16-bit compilation is no longer supported.
529
530
531 Configuring the build
532 =====================
533
534 So far the instructions only explained how to build release DLLs of wxWindows
535 and did not cover any configuration. It is possible to change many aspects of
536 the build, including debug/release and ANSI/Unicode settings. All makefiles in
537 build\msw directory use same options (with a few exceptions documented below)
538 and the only difference between them is in object files and library directory
539 names and in make invocation command.
540
541 Changing the settings
542 ---------------------
543
544 There are two ways to modify the settings: either by passing the values as
545 arguments when invoking make or by editing build\msw\config.$(compiler) file
546 where $(compiler) is same extension as the makefile you use has (see below).
547 The latter is good for setting options that never change in your development
548 process (e.g. GCC_VERSION or VENDOR). If you want to build several versions of
549 wxWindows and use them side by side, the former method is better. Settings in
550 config.* files are shared by all makefiles (samples, contrib, main library),
551 but if you pass the options as arguments, you must use same arguments you used
552 for the library when building samples or contrib libraries!
553
554 Examples of invoking make in Unicode debug build (other options described
555 below are set analogically):
556
557 Visual C++:
558   > nmake -f makefile.vc BUILD=debug UNICODE=1
559
560 Borland C++:
561   > nmake -f makefile.bcc -DBUILD=debug -DUNICODE=1
562   (Note that you have to use -D to set the variable, unlike in other make
563   tools!)
564
565 Watcom C/C++:
566   > wmake -f makefile.wat BUILD=debug UNICODE=1
567
568 MinGW using native makefiles:
569   > mingw32-make -f makefile.gcc BUILD=debug UNICODE=1
570
571 MinGW using configure or Cygwin:
572   > ./configure --enable-debug --enable-unicode
573   (see ./configure --help on details; configure is not covered in this
574   section)
575
576 Brief explanation of options and possible values is in every
577 build\msw\config.* file; more detailed description follows.
578
579 Basic options
580 -------------
581
582 BUILD=debug
583   Builds debug version of the library (default is 'release'). This affects
584   name of the library ('d' is appended), __WXDEBUG__ is defined and debug
585   information compiled into object files and the executable.
586
587 SHARED=0
588   Build static libraries instead of DLLs. By default, DLLs are build
589   (SHARED=1).
590
591 UNICODE=1
592   To build Unicode versions of the libraries, add UNICODE=1 to make invocation
593   (default is UNICODE=0). If you want to be able to use Unicode version on
594   Windows9x, you will need to set MSLU=1 as well.
595
596   This option affect name of the library ('u' is appended) and the directory
597   where the library and setup.h are store (ditto).
598
599 WXUNIV=1
600   Build wxUniversal instead of native wxMSW (see
601   http://www.wxwindows.org/wxuniv.htm for more information).
602
603 Advanced options
604 ----------------
605
606 MONOLITHIC=1
607   Starting with version 2.5.0, wxWindows has the ability to be built as 
608   several smaller libraries instead of single big one as used to be the case
609   in 2.4 and older versions. This is called "multilib build" and is the
610   default behaviour of makefiles. You can still build single library
611   ("monolithic build") by setting MONOLITHIC variable to 1.
612
613 USE_GUI=0
614   Disable building GUI parts of the library, build only wxBase components used
615   by console applications. Note that if you leave USE_GUI=1 then both wxBase
616   and GUI libraries are built. If you are building monolithic library, then
617   you should set wxUSE_GUI to 1 in setup.h.
618
619 USE_OPENGL=1
620   Build wxmsw25_gl.lib library with OpenGL integration class wxGLCanvas.
621   You must also modify your setup.h to #define wxUSE_GLCANVAS 1. Note that
622   OpenGL library is always built as additional library, even in monolithic
623   build!
624
625 USE_ODBC=1
626   Build two additional libraries in multilib mode, one with database
627   classes and one with wxGrid database support. You must
628   #define wxUSE_ODBC 1 in setup.h
629
630 USE_HTML=0
631   Do not build wxHTML library. If MONOLITHIC=1, then you must also
632   #define wxUSE_HTML 1 in setup.h.
633
634 RUNTIME_LIBS=static
635   Links static version of C and C++ runtime libraries into the executable, so
636   that the program does not depend on DLLs provided with the compiler (e.g.
637   Visual C++'s msvcrt.dll or Borland's cc3250mt.dll).
638   Caution: Do not use static runtime libraries when building DLL (SHARED=1)!
639
640 MSLU=1
641   Enables MSLU (Microsoft Layer for Unicode). This setting makes sense only if
642   used together with UNICODE=1. If you want to be able to use Unicode version
643   on Windows9x, you will need MSLU (Microsoft Layer for Unicode) runtime DLL
644   and import lib.  The former can be downloaded from Microsoft, the latter is
645   part of the latest Platform SDK from Microsoft (see msdn.microsoft.com for
646   details). An alternative implementation of import library can be downloaded
647   from http://libunicows.sourceforge.net - unlike the official one, this one
648   works with other compilers and does not require 300+ MB Platform SDK update.
649
650 DEBUG_FLAG=0
651 DEBUG_FLAG=1
652   If set to 1, define __WXDEBUG__ symbol, append 'd' to library name and do
653   sanity checks at runtime. If set to 0, don't do it. By default, this is
654   governed by BUILD option (if 'debug', DEBUG_FLAG=1, if 'release' it is 0),
655   but it is sometimes desirable to modify default behaviour and e.g. define
656   __WXDEBUG__ even in release builds.
657
658 DEBUG_INFO=0
659 DEBUG_INFO=1
660   Same as DEBUG_FLAG in behaviour, this option affects whether debugging
661   information is included in the executable or not.
662
663 VENDOR=<your company name>
664   Set this to a short string identifying your company if you are planning to
665   distribute wxWindows DLLs with your application. Default value is 'custom'.
666   This string is included as part of DLL name. wxWindows DLLs contain compiler
667   name, version information and vendor name in them. For example
668   wxmsw250_core_bcc_custom.dll is one of DLLs build using Borland C++ with
669   default settings. If you set VENDOR=mycorp, the name will change to
670   wxmsw250_core_bcc_mycorp.dll.
671
672 CFG=<configuration name>
673   Sets configuration name so that you can have multiple wxWindows build with
674   different setup.h settings coexisting in same tree. See "Object and library
675   directories" below for more information.
676
677 Compiler specific options
678 -------------------------
679
680 * MinGW
681
682 If you are using gcc-2.95 instead of gcc3, you must set GCC_VERSION to
683 2.95. In build\msw\config.gcc, change 
684 > GCC_VERSION = 3
685 to
686 > GCC_VERSION = 2.95
687
688 * Visual C++
689
690 DEBUG_RUNTIME_LIBS=0
691 DEBUG_RUNTIME_LIBS=1
692   If set to 1, msvcrtd.dll is used, if to 0, msvcrt.dll is used. By default
693   msvcrtd.dll is used only if the executable contains debug info and
694   msvcrt.dll if it doesn't. It is sometimes desirable to build with debug info
695   and still link against msvcrt.dll (e.g. when you want to ship the app to
696   customers and still have usable .pdb files with debug information) and this
697   setting makes it possible.
698
699 Fine-tuning the compiler
700 ------------------------
701
702 All makefiles have variables that you can use to specify additional options
703 passed to the compiler or linker. You won't need this in most cases, but if you
704 do, simply add desired flags to CFLAGS (for C compiler), CXXFLAGS (for C++
705 compiler), CPPFLAGS (for both C and C++ compiler) and LDFLAGS (the linker).
706
707 Object and library directories
708 ------------------------------
709
710 All object files produced during library build are stored in a directory under
711 build\msw. It's name is derived from build settings and CFG variable and from
712 compiler name. Examples of directory names:
713
714   build\msw\bcc_msw            SHARED=0
715   build\msw\bcc_mswdll         SHARED=1
716   build\msw\bcc_mswunivd       SHARED=0, WXUNIV=1, BUILD=debug
717   build\msw\vc_mswunivd        ditto, with Visual C++
718
719 Libraries and DLLs are copied into subdirectory of lib directory with 
720 name derived from compiler and static/DLL setting and setup.h into directory
721 with name that contains other settings:
722
723   lib\bcc_msw
724   lib\bcc_lib\msw\wx\setup.h
725   lib\bcc_dll
726   lib\bcc_dll\msw\wx\setup.h
727   lib\bcc_lib
728   lib\bcc_lib\mswunivd\wx\setup.h
729   lib\vc_lib
730   lib\vc_lib\mswunivd\wx\setup.h
731
732 Each lib\ subdirectory has wx subdirectory with setup.h as seen above.
733 This file is copied there from include\wx\msw\setup.h (and if it doesn't exist,
734 from include\wx\msw\setup0.h) and this is the copy of setup.h that is used by
735 all samples and should be used by your apps as well. If you are doing changes
736 to setup.h, you should do them in this file, _not_ in include\wx\msw\setup.h.
737
738 If you set CFG to something, the value is appended to directory names. E.g.
739 for CFG=MyBuild, you'll have object files in
740   
741   build\msw\bcc_mswMyBuild
742   build\msw\bcc_mswdllMyBuild
743   etc.
744
745 and libraries in
746
747   lib\bcc_libMyBuild
748   lib\bcc_dllMyBuild
749   etc.
750
751 By now it is clear for CFG is for: builds with different CFG settings don't
752 share any files and they use different setup.h files. This allows you to e.g. 
753 have two static debug builds, one with wxUSE_SOCKETS=0 and one with sockets
754 enabled (without CFG, both of them would be put into same directory and there
755 would be conflict between the files).
756
757
758 General Notes
759 =============
760
761 - Debugging: under Windows 95, debugging output isn't output in
762   the same way that it is under NT or Windows 3.1.
763   Please see DebugView (bin/dbgview.exe in the distribution), also
764   available from http://www.sysinternals.com and on the wxWindows CD-ROM
765   under Packages.
766
767 - If you are installing wxWindows 2 from CVS, you may find that
768   include/wx/msw/setup.h is missing. This is deliberate, to avoid
769   developers' different setup.h configurations getting confused.
770   Please copy setup0.h to setup.h before compiling. Also, read
771   the BuildCVS.txt for other hints.