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