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