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