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