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