1 Installing wxWindows 2.5.0
2 --------------------------
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.
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
16 http://sourceforge.net/patch/?group_id=9863
18 Please report bugs using the SourceForge bug tracker:
20 http://sourceforge.net/bugs/?group_id=9863
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
34 The setup program contains the following:
36 - All common, generic and MSW-specific wxWindows source;
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;
45 - Dialog Editor binary.
47 Alternatively, you may unarchive the .zip form by hand:
48 wxMSW-x.y.z.zip where x.y.z is the version number.
50 Unarchive the required files plus any optional documentation
51 files into a suitable directory such as c:\wx.
53 Other add-on packages are available from the wxWindows Web site, such as:
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.
61 General installation notes
62 ==========================
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].
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.
76 All makefiles and project are located in build\msw directory.
78 Where compiled files are stored
79 -------------------------------
81 After succesful compilation you'll find the libraries in a subdirectory
82 of lib directory named after the compiler, toolkit name and DLL and Unicode
83 settings. A couple of examples:
85 lib\vc_msw VC++ compiled static libraries
86 lib\vc_mswdll VC++ DLLs
87 lib\bcc_mswud Static libraries for Borland C++,
89 lib\wat_mswunivdll Watcom C++ DLLs of wxUniversal port
91 Names of compiled wxWindows libraries follow this scheme: libraries that don't
92 depend on GUI components begin with "wxbase" followed by version number and
93 letters indicating if the library is compiled as Unicode ('u') and/or debug
94 build ('d'). Last component of them name is name of wxWindows component
95 (unless you built the library as single monolithic library; look for
96 "Configuring the build" below). This is a typical set of release ANSI build
97 libraries (release versions on left, debug on right side):
99 wxbase25.lib wxbase25d.lib
100 wxbase25_net.lib wxbase25d_net.lib
101 wxbase25_xml.lib wxbase25d_xml.lib
102 wxmsw25_core.lib wxmsw25d_core.lib
103 wxmsw25_html.lib wxmsw25d_html.lib
104 wxmsw25_adv.lib wxmsw25d_adv.lib
106 These directories also contain wx/setup.h header.
108 Below are compiler specific notes followed by customizing instructions that
109 apply to all compilers (search for "Configuring the build").
112 Microsoft Visual C++ compilation
113 --------------------------------
115 You may wish to visit http://wiki.wxwindows.org/wiki.pl?MSVC for a more
116 informal and more detailed description of the process summarized below.
118 Please note that the VC++ 6.0 project files will work for VC++ .NET also.
120 Also note that you can make the project files work with VC++ 5.0 but you'll
121 need to edit .dsp file by hand before this is possible (change the version in
122 the .dsp file header from 6.0 to 5.0).
124 Using project files (VC++ 6 and later):
126 1. Unarchive wxWindows-x.y.z-vc.zip, the VC++ 6 project
127 makefiles (already included in wxMSW-x.y.z.zip and the setup version).
128 2. Open build\msw\wx.dsw, which has configurations for static
129 compilation or DLL compilation, and each of these available in
130 Unicode/ANSI, Debug/Release and wxUniversal or native variations.
131 Normally you'll use a static linking ANSI configuration.
132 Choose the Win32 Debug or Win32 Release configuration for the wxWindows
133 project, and compile. Alternatively, use Batch Build to build more than
134 one configuration. It will also produce similar variations on jpeg.lib,
135 png.lib, tiff.lib, zlib.lib, and regex.lib.
136 3. Open a sample project file, choose a configuration such as
137 Win32 Debug using Build | Set Active Configuration..., and compile.
138 The project files don't use precompiled headers, to save disk
139 space, but you can switch PCH compiling on for greater speed.
140 NOTE: you may also use samples/samples.dsw to access all
141 sample projects without opening each workspace individually.
142 You can use the Batch Build facility to make several samples
147 1. Change directory to build\msw. Type:
149 'nmake -f makefile.vc'
151 to make the wxWindows core library as release DLL.
152 See "Configuring the build" for instruction how to build debug or static
154 2. Change directory to samples and type 'nmake -f makefile.vc'
155 to make all the samples. You can also make them individually.
159 Use the 'clean' target to clean all objects, libraries and
162 Note (1): if you wish to use templates, please edit
163 include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
164 Without this, the redefinition of 'new' will cause problems in
165 the headers. Alternatively, #undef new before including template headers.
166 You will also need to set wxUSE_IOSTREAMH to 0 if you will be
167 using templates, to avoid the non-template stream files being included
170 Note (2): libraries and applications generated with makefiles and
171 project files are now (hopefully) compatible where static libraries
172 are concerned, but please exercise caution nevertheless and if
173 possible, use one method or the other.
175 Note (3): VC++ 5's optimization code seems to be broken and can
176 cause both compile and run-time problems: this can be seen when
177 deleting an object Dialog Editor, in Release mode with optimizations
178 on. If in doubt, switch off optimisations, although this will result in much
179 larger executables. It seems possible that the library can be created with
180 strong optimization, so long as the application is not strongly
181 optimized. For example, in wxWindows project, set to 'Minimum
182 Size'. In Dialog Editor project, set to 'Customize: Favor Small
183 Code' (and no others). This will then work.
185 Note (4): some crash problems can be due to inconsistent compiler
186 options. If strange/weird/impossible things start to happen please
187 check (dumping IDE project file as makefile and doing text comparison
188 if necessary) that the project settings, especially the list of defined
189 symbols, struct packing, etc. are exactly the same for all items in
190 the project. After this, delete everything (including PCH) and recompile.
192 Note (5): to create your own IDE files, see the technical note on the
193 wxWindows web site or CD-ROM, entitled "Compiling wxWindows
194 applications in the VC++ IDE" (technical note docs/tech/tn0010.htm in the
195 wxWindows distribution). You can also copy .dsp and .dsw
196 files from an existing wxWindows sample and adapt them.
199 Visual C++ 1.5 compilation (16-bit)
200 -----------------------------------
205 Borland C++ 5.0/5.5 compilation
206 -------------------------------
208 Compiling using the makefiles (updated 24 Sept 02):
210 1. Change directory to build\msw. Type 'make -f makefile.bcc' to
211 make the wxWindows core library. Ignore the compiler warnings.
212 This produces a couple of librarie in the lib\bcc_mswdll directory.
214 2. Change directory to a sample or demo such as samples\minimal, and type
215 'make -f makefile.bcc'. This produces a windows exe file - by default
216 in the bcc_mswdll subdirectory.
218 Note (1): the wxWindows makefiles assume dword structure alignment. Please
219 make sure that your own project or makefile settings use the
220 same alignment, or you could experience mysterious crashes. To
221 change the alignment, change CPPFLAGS in build\msw\config.bcc.
223 Note (2): if you get undefined _SQL... symbols at link time,
224 either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
225 directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
226 recompile wxWindows. The same applies if compiling using the IDE.
229 Note (3): If you wish debug messages to be sent to the console in
230 debug mode, edit makefile.bcc and change /aa to /Tpe in link commands.
232 Compiling using the IDE files: [Borland C++ 5.0, not Cbuilder]
234 1. Load src\bc32.ide from the file bc32.zip at
235 http://biolpc22.york.ac.uk/pub/ports/bcc32/wxwin21/ and select Release settings
236 2. Go to Options|Project... and specify the correct BC++ include and lib path for
238 3. Press F9 to compile the wxWindows library.
239 4. Load samples\bc32.ide.
240 5. Go to Options|Project... and specify the correct BC++ include and lib path for
242 6. Press F9 to compile the samples (build each node separately if
243 you prefer, by right clicking and choose Build Node).
244 7. Run each sample: you may need to run from each sample's directory
245 since some (notably the wxHTML samples) look for files
246 relative to the working directory.
248 Note (1): the samples project file contains a selection of
249 samples, and not all samples. The remaining samples can be made
250 with the makefiles. See also the demos hierarchy which doesn't
251 have any BC++ project files yet.
253 Note (2): to make the png, zlib, jpeg and tiff libraries (needed for
254 some samples) you need to compile them with bc32.ide.
256 Note (3): the debug version of the wxWindows library is about 40 MB, and the
257 release version is around 5 MB.
259 See also the file docs/tech/tn0007.txt for further instructions and details
260 of how to create your own project files.
264 In all of your wxWindows applications, your source code should include
265 the following preprocessor directive:
271 (check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for
275 Borland C++Builder IDE compilation
276 ----------------------------------
278 1. Build the wxWindows libraries using the Borland make utility as
279 specified in the section called "Borland C++ 5.0 compilation"
280 above. (C++ Builder includes a stand-alone C++ compiler. For example,
281 C++ Builder 4.0 comes with C++ 5.4.)
283 2. You can use the process_sample_bcb.bat command which is in
284 wxwindows\distrib\msw to generate a .mak or .bpr file for most of the
285 samples [mak for Cbuilder 1-6; v4 and after will convert this to bpr].
286 Execute this in the sampledirectory, passing the name of the cpp files
287 on the command line. For more details, see the instructions in
288 docs/tech/tn0004.htm or http://biolpc22.york.ac.uk/wx/bc/ide.html.
290 Borland 16 Bit compilation for Windows 3.1
291 ------------------------------------------
293 The last version of wxWindows to support 16-bit compilation with Borland was
294 2.2.7 - Please download and read the instructions in that release
296 Watcom C++ 10.6/11 and OpenWatcom compilation
297 ---------------------------------------------
299 1. Change directory to build\msw. Type 'wmake -f makefile.wat' to
300 make the wxWindows core library.
301 2. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat'
302 to make this sample. Repeat for other samples of interest.
305 Note (1): if your installation of Watcom doesn't have odbc32.lib file and
306 you need it (i.e. you have wxUSE_ODBC=1), you can use the file
307 from lib\watcom directory. See the notes in that directory.
309 Note (2): if variant.cpp is compiled with date/time class options, the linker
310 gives up. So the date/time option is switched off for Watcom C++.
311 Also, wxAutomationObject is not compiled with Watcom C++ 10.
313 Note (3): RawBitmaps won't work at present because they use unsupported template
316 Note (4): if Watcom can't read the precompiled header when building a sample,
317 try deleting .pch files in build\msw\wat_* and compiling
321 Metrowerks CodeWarrior compilation
322 ----------------------------------
324 1. CodeWarrior Pro7 project files in XML format are already
325 included in wxMSW-2.5.0.zip and the setup version.
326 2. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if
327 you are working from the CVS version) to make sure the settings reflect
328 what you want. If you aren't sure, leave it alone and go with the
329 default settings. A few notes:
330 - Don't use wxUSE_DEBUG_NEW_ALWAYS: it doesn't mix well with MSL
331 - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports
332 will be rather confusing due to interactions with the MSL ANSI
334 3. The project file to build the Win32 wxWindows libraries relies on the
335 Batch File Runner plug-in. This plug-in is not installed as part of
336 a normal CW7 installation. However, you can find this plug-in on the
337 CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the
338 "Batch File Post Linker".
339 4. If you choose not to install the Batch File Runner plug-in, then you
340 need to do the following by hand:
341 (1) Create the directories lib\cw7msw\include\wx and copy the file
342 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
343 working from the CVS version) to lib\cw7msw\include\wx\setup.h
344 (2) Create the directories lib\cw7mswd\include\wx and copy the file
345 include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
346 working from the CVS version) to lib\cw7mswd\include\wx\setup.h
347 5. Import src\wxWindowsW7.xml to create the project file wxWindowsW7.mcp.
348 Store this project file in directory src. You may get warnings about
349 not being able to find certain project paths; ignore these warnings, the
350 appropriate paths will be created during the build by the Batch File Runner.
351 6. Choose the wxlib Win32 debug or wxlib Win32 Release target and build. You
352 will get some warnings about hidden virtual functions, illegal conversions
353 from const pointers to pointers, etc., all of which you can safely ignore.
354 ***Note: if you get errors that the compiler can't find "wx/setup.h", just
355 stop the build and build again. These errors occur because sometimes the
356 compiler starts doing its thing before the copying of setup.h has completed.
357 7. The following libraries will be produced depending on chosen
359 - wx_x86.lib ANSI Release (static)
360 - wx_x86_d.lib ANSI Debug (static)
361 8. Sorry, I haven't had time yet to create and test unicode or DLL versions.
362 Volunteers for this are welcome (as neither DLLs nor unicode builds are
363 big priorities for me ;).
364 9. CodeWarrior Pro7 project files (in XML format) are also provided for some
365 of the samples. In particular, there are project files for the minimal,
366 controls, dialogs, dnd, nd docview samples. You can use these project
367 files as templates for the other samples and for your own projects.
368 - For example, to make a project file for the "newgrid" sample,
369 just copy the project file for the "minimal" sample, minimalW7.mcp
370 (made by importing minimalW7.xml into CodeWarrior), into the
371 sample/newgrid directory, calling it newgridW7.mcp. Open
372 newgridW7.mcp and revise the project by deleting the files
373 minimal.rc and minimal.cpp and adding the files griddemo.rc and
374 griddemo.cpp. Build and run....
377 Cygwin/MinGW compilation
378 ------------------------
380 wxWindows 2 supports Cygwin (formerly GnuWin32) betas and
381 releases, and MinGW. Cygwin can be downloaded from:
383 http://sources.redhat.com/cygwin/
387 http://www.mingw.org/
389 Both Cygwin and MinGW can be used with configure (assuming you have MSYS
390 installed in case of MinGW). You will need new enough MinGW version, preferably
391 MinGW 2.0 (ships with gcc3) or at least 1.0 (gcc-2.95.3). GCC versions older
392 than 2.95.3 don't work; you can use wxWindows 2.4 with them.
394 NOTE: some notes specific to old Cygwin (< 1.1.x) are at the end of this
395 section (see OLD VERSIONS)
397 There are two methods of compiling wxWindows, by using the
398 makefiles provided or by using 'configure'.
400 Retrieve and install the latest version of Cygwin, or MinGW, as per
401 the instructions with either of these packages.
403 If using MinGW, you can download the add-on MSYS package to
404 provide Unix-like tools that you'll need to build wxWindows using configure.
406 Using makefiles directly
407 ------------------------
409 NOTE: The makefile are for compilation under Cygwin, MSYS, or
410 command.com/cmd.exe, they won't work in other environments
413 Here are the steps required using the provided makefiles:
415 - If you are using gcc-2.95, edit build\msw\config.gcc and set the GCC_VERSION
418 - Use the makefile.gcc files for compiling wxWindows and samples,
419 e.g. to compile a debugging version of wxWindows:
421 > make -f makefile.gcc BUILD=debug
422 > cd c:\wx\samples\minimal
423 > make -f makefile.gcc BUILD=debug
424 (See below for more options.)
426 Ignore the warning about the default entry point.
428 - Use the 'strip' command to reduce executable/dll size (note that
429 stripping an executable/dll will remove debug information!).
431 All targets have 'clean' targets to allow removal of object files
432 and other intermediate compiler files.
437 Instead of using the makefiles, you can use the configure
438 system to generate appropriate makefiles, as used on Unix
439 and Mac OS X systems.
441 Change directory to the root of the wxWindows distribution,
442 make a build directory, and run configure and make in this directory.
449 ../configure --with-msw --enable-debug --enable-debug_gdb --disable-shared
451 make install % This step is optional, see note (8) below.
458 1. See also the Cygwin/MinGW on the web site or CD-ROM for
459 further information about using wxWindows with these compilers.
461 2. libwx.a is 100 MB or more - but much less if compiled with no
462 debug info (-g0) and level 4 optimization (-O4).
464 3. If you get a link error under MinGW 2.95.2 referring to:
466 EnumDAdvise__11IDataObjectPP13IEnumSTATDATA@8
468 then you need to edit the file objidl.h at line 663 and add
469 a missing PURE keyword:
471 STDMETHOD(EnumDAdvise)(THIS_ IEnumSTATDATA**) PURE;
473 4. There's a bug in MinGW headers for some early distributions.
475 in include/windows32/defines.h, where it says:
477 #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
481 #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
485 5. OpenGL support should work with MinGW as-is. However,
486 if you wish to generate import libraries appropriate either for
487 the MS OpenGL libraries or the SGI OpenGL libraries, go to
488 include/wx/msw/gl and use:
490 dlltool -k -d opengl.def -llibopengl.a
494 dlltool -k -d opengl32.def -llibopengl32.a
496 and similarly for glu[32].def.
498 6. The 'make install' step is optional, and copies files
501 /usr/local/lib - wxmswXYZd.dll.a and wxmswXYZd.dll
502 /usr/local/include/wx - wxWindows header files
503 /usr/local/bin - wx-config
505 You may need to do this if using wx-config with the
508 7. With Cygwin, you can invoke gdb --nw myfile.exe to
509 debug an executable. If there are memory leaks, they will be
510 flagged when the program quits. You can use Cygwin gdb
511 to debug MinGW executables.
516 - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
517 to set up appropriate variables, if necessary mounting drives.
518 Run it before compiling.
520 - For Cygwin, make sure there's a \tmp directory on your
521 Windows drive or bison will crash (actually you don't need
522 bison for ordinary wxWindows compilation: a pre-generated .c file is
525 - If using GnuWin32 b18, you will need to copy windres.exe
526 from e.g. the MinGW distribution, to a directory in your path.
529 Symantec & DigitalMars C++ compilation
530 --------------------------------------
531 The DigitalMars compiler is a free succssor to the Symantec compiler
532 and can be downloaded from http://www.digitalmars.com/
534 1. You need to download and unzip in turn (later packages will overwrite
536 Digital Mars C/C++ Compiler Version 8.33
538 beta test C++ Compiler Version 8.34
539 from http://www.digitalmars.com/download/freecompiler.html [02 may 03, CE]
541 2. Change directory to build\msw. Type 'make -f makefile.dm' to
542 make the wxWindows core library.
543 3. Change directory to wx\samples\minimal and type 'make -f makefile.dm'
544 to make this sample. The mdi and image sample also work; others may give
545 linker erros due to missing libraries
547 16-bit compilation is no longer supported.
550 Configuring the build
551 =====================
553 So far the instructions only explained how to build release DLLs of wxWindows
554 and did not cover any configuration. It is possible to change many aspects of
555 the build, including debug/release and ANSI/Unicode settings. All makefiles in
556 build\msw directory use same options (with a few exceptions documented below)
557 and the only difference between them is in object files and library directory
558 names and in make invocation command.
560 Changing the settings
561 ---------------------
563 There are two ways to modify the settings: either by passing the values as
564 arguments when invoking make or by editing build\msw\config.$(compiler) file
565 where $(compiler) is same extension as the makefile you use has (see below).
566 The latter is good for setting options that never change in your development
567 process (e.g. GCC_VERSION or VENDOR). If you want to build several versions of
568 wxWindows and use them side by side, the former method is better. Settings in
569 config.* files are shared by all makefiles (samples, contrib, main library),
570 but if you pass the options as arguments, you must use same arguments you used
571 for the library when building samples or contrib libraries!
573 Examples of invoking make in Unicode debug build (other options described
574 below are set analogically):
577 > nmake -f makefile.vc BUILD=debug UNICODE=1
580 > nmake -f makefile.bcc -DBUILD=debug -DUNICODE=1
581 (Note that you have to use -D to set the variable, unlike in other make
585 > wmake -f makefile.wat BUILD=debug UNICODE=1
587 MinGW using native makefiles:
588 > mingw32-make -f makefile.gcc BUILD=debug UNICODE=1
590 MinGW using configure or Cygwin:
591 > ./configure --enable-debug --enable-unicode
592 (see ./configure --help on details; configure is not covered in this
595 Brief explanation of options and possible values is in every
596 build\msw\config.* file; more detailed description follows.
602 Builds debug version of the library (default is 'release'). This affects
603 name of the library ('d' is appended), __WXDEBUG__ is defined and debug
604 information compiled into object files and the executable.
607 Build static libraries instead of DLLs. By default, DLLs are build
611 To build Unicode versions of the libraries, add UNICODE=1 to make invocation
612 (default is UNICODE=0). If you want to be able to use Unicode version on
613 Windows9x, you will need to set MSLU=1 as well.
615 This option affect name of the library ('u' is appended) and the directory
616 where the library and setup.h are store (ditto).
619 Build wxUniversal instead of native wxMSW (see
620 http://www.wxwindows.org/wxuniv.htm for more information).
626 Starting with version 2.5.0, wxWindows has the ability to be built as
627 several smaller libraries instead of single big one as used to be the case
628 in 2.4 and older versions. This is called "multilib build" and is the
629 default behaviour of makefiles. You can still build single library
630 ("monolithic build") by setting MONOLITHIC variable to 1.
633 Disable building GUI parts of the library, build only wxBase components used
634 by console applications. Note that if you leave USE_GUI=1 then both wxBase
635 and GUI libraries are built. If you are building monolithic library, then
636 you should set wxUSE_GUI to 1 in setup.h.
639 Build wxmsw25_gl.lib library with OpenGL integration class wxGLCanvas.
640 You must also modify your setup.h to #define wxUSE_GLCANVAS 1. Note that
641 OpenGL library is always built as additional library, even in monolithic
645 Build two additional libraries in multilib mode, one with database
646 classes and one with wxGrid database support. You must
647 #define wxUSE_ODBC 1 in setup.h
650 Do not build wxHTML library. If MONOLITHIC=1, then you must also
651 #define wxUSE_HTML 1 in setup.h.
654 Links static version of C and C++ runtime libraries into the executable, so
655 that the program does not depend on DLLs provided with the compiler (e.g.
656 Visual C++'s msvcrt.dll or Borland's cc3250mt.dll).
657 Caution: Do not use static runtime libraries when building DLL (SHARED=1)!
660 Enables MSLU (Microsoft Layer for Unicode). This setting makes sense only if
661 used together with UNICODE=1. If you want to be able to use Unicode version
662 on Windows9x, you will need MSLU (Microsoft Layer for Unicode) runtime DLL
663 and import lib. The former can be downloaded from Microsoft, the latter is
664 part of the latest Platform SDK from Microsoft (see msdn.microsoft.com for
665 details). An alternative implementation of import library can be downloaded
666 from http://libunicows.sourceforge.net - unlike the official one, this one
667 works with other compilers and does not require 300+ MB Platform SDK update.
671 If set to 1, define __WXDEBUG__ symbol, append 'd' to library name and do
672 sanity checks at runtime. If set to 0, don't do it. By default, this is
673 governed by BUILD option (if 'debug', DEBUG_FLAG=1, if 'release' it is 0),
674 but it is sometimes desirable to modify default behaviour and e.g. define
675 __WXDEBUG__ even in release builds.
679 Same as DEBUG_FLAG in behaviour, this option affects whether debugging
680 information is included in the executable or not.
682 VENDOR=<your company name>
683 Set this to a short string identifying your company if you are planning to
684 distribute wxWindows DLLs with your application. Default value is 'custom'.
685 This string is included as part of DLL name. wxWindows DLLs contain compiler
686 name, version information and vendor name in them. For example
687 wxmsw250_core_bcc_custom.dll is one of DLLs build using Borland C++ with
688 default settings. If you set VENDOR=mycorp, the name will change to
689 wxmsw250_core_bcc_mycorp.dll.
691 CFG=<configuration name>
692 Sets configuration name so that you can have multiple wxWindows build with
693 different setup.h settings coexisting in same tree. See "Object and library
694 directories" below for more information.
696 Compiler specific options
697 -------------------------
701 If you are using gcc-2.95 instead of gcc3, you must set GCC_VERSION to
702 2.95. In build\msw\config.gcc, change
711 If set to 1, msvcrtd.dll is used, if to 0, msvcrt.dll is used. By default
712 msvcrtd.dll is used only if the executable contains debug info and
713 msvcrt.dll if it doesn't. It is sometimes desirable to build with debug info
714 and still link against msvcrt.dll (e.g. when you want to ship the app to
715 customers and still have usable .pdb files with debug information) and this
716 setting makes it possible.
718 Fine-tuning the compiler
719 ------------------------
721 All makefiles have variables that you can use to specify additional options
722 passed to the compiler or linker. You won't need this in most cases, but if you
723 do, simply add desired flags to CFLAGS (for C compiler), CXXFLAGS (for C++
724 compiler), CPPFLAGS (for both C and C++ compiler) and LDFLAGS (the linker).
726 Object and library directories
727 ------------------------------
729 All object files produced during library build are stored in a directory under
730 build\msw. It's name is derived from build settings and CFG variable and from
731 compiler name. Examples of directory names:
733 build\msw\bcc_msw SHARED=0
734 build\msw\bcc_mswdll SHARED=1
735 build\msw\bcc_mswunivd SHARED=0, WXUNIV=1, BUILD=debug
736 build\msw\vc_mswunivd ditto, with Visual C++
738 Libraries and DLLs are copied into subdirectory of lib directory with same
739 name as the build\msw subdirectory used for object files:
746 Each lib\ subdirectory has wx subdirectory with setup.h. This file is copied
747 there from include\wx\msw\setup.h (and if it doesn't exist, from
748 include\wx\msw\setup0.h) and this is the copy of setup.h that is used by all
749 samples and should be used by your apps as well. If you are doing changes to
750 setup.h, you should do them in this file, _not_ in include\wx\msw\setup.h.
752 If you set CFG to something, the value is appended to directory names. E.g.
753 for CFG=MyBuild, you'll have object files in
755 build\msw\bcc_mswMyBuild
756 build\msw\bcc_mswdllMyBuild
762 lib\bcc_mswdllMyBuild
765 By now it is clear for CFG is for: builds with different CFG settings don't
766 share any files and they use different setup.h files. This allows you to e.g.
767 have two static debug builds, one with wxUSE_SOCKETS=0 and one with sockets
768 enabled (without CFG, both of them would be put into same directory and there
769 would be conflict between the files).
775 - Debugging: under Windows 95, debugging output isn't output in
776 the same way that it is under NT or Windows 3.1.
777 Please see DebugView (bin/dbgview.exe in the distribution), also
778 available from http://www.sysinternals.com and on the wxWindows CD-ROM
781 - If you are installing wxWindows 2 from CVS, you may find that
782 include/wx/msw/setup.h is missing. This is deliberate, to avoid
783 developers' different setup.h configurations getting confused.
784 Please copy setup0.h to setup.h before compiling. Also, read
785 the BuildCVS.txt for other hints.