2 Installing wxWindows 2.1
3 ------------------------
5 This is a beta release of wxWindows 2.1 for Microsoft
6 Windows 95, 98 and NT. This is not a production release,
7 although a huge number of bugs found in earlier versions
8 of wxWindows have been fixed.
10 IMPORTANT NOTE: If you experience problems installing, please
11 re-read this instructions and other related files (release.txt,
12 todo.txt, bugs.txt etc.) carefully before mailing wxwin-users or
13 the author. Preferably, try to fix the problem first and
14 then send a patch to the author. Please report bugs using the
15 bug report form on the wxWindows web site.
20 A setup program is provided (setup.exe) to automatically copy files to a
21 directory on your hard disk. Do not install into a path that contains spaces.
22 The installation program should set the WXWIN environment variable, which
23 will be activated when your machine is rebooted. The setup
24 program contains the following:
26 - All common, generic and MSW-specific wxWindows source;
28 - documentation in Windows Help format;
29 - makefiles for most Windows compilers, plus BC++ and
31 - JPEG library source;
32 - TIFF library source;
33 - Object Graphics Library;
35 - Dialog Editor binary.
37 Alternatively, you may unarchive the set of .zip files by hand,
38 where x is the minor version number and y is the release number:
40 wx2_x_y_gen.zip Generic source code and samples (required)
41 wx2_x_y_msw.zip Windows-specific source code and samples (required)
42 wx2_x_y_doc.zip Documentation source code (not required)
43 wx2_x_y_hlp.zip WinHelp documentation
44 wx2_x_y_pdf.zip Acrobat PDF documentation
45 wx2_x_y_htm.zip HTML documentation
46 wx2_x_y_vc.zip MS VC++ 5.0 project files
47 wx2_x_y_cw.zip Metrowerks CodeWarrior project files
48 wx2_x_y_bc.zip BC++ 5 project files
49 jpeg.zip Use this to allow wxImage to read and write JPEG files
50 tiff.zip Use this to allow wxImage to read and write TIFF files
52 Unarchive the required files plus any optional documentation
53 files into a suitable directory such as c:\wx.
55 Other add-on packages are available from the wxWindows Web site, such as:
57 - mmedia.zip. Audio, CD, video access for Windows and Linux.
58 - ogl3.zip. Object Graphics Library: build network diagrams, CASE tools etc.
59 - tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
60 the same document source.
62 General installation notes
63 --------------------------
65 Alter your WXWIN environment variable to point to this directory.
66 For Cygwin or Mingw32 compilation, make sure WXWIN contains only
69 If installing from the CVS server, copy include/wx/msw/setup0.h to
70 include/wx/msw/setup.h and edit the resulting file to choose the featrues you
71 would like to compile wxWindows with[out].
76 The following sections explain how to compile wxWindows with each supported
79 Visual C++ 4.0/5.0/6.0 compilation
80 ----------------------------------
82 Using project files (VC++ 5 and 6 only):
84 1. Unarchive wx2_x_y_vc.zip, the VC++ 5/6 project makefiles.
85 2. Open src/wxvc.dsp, set Debug or Release configuration for
86 the wxvc project, and compile. Alternatively, use Batch Build
87 to build both Debug and Release configurations.
88 This will produce lib/wx.lib (release) and lib/wxd.lib (debug),
89 plus various subordinate libraries. It assumes you have
90 the TIFF and JPEG source, which is already in the setup
91 version of the distribution.
92 The project file src/wxvc_dll.dsp will make a DLL version of wxWindow,
93 which will go in lib/wxdll.[lib,dll] and lib/wxdlld.[lib,dll].
94 3. Open a sample project file, choose a configuration such as
95 Debug using Build | Set Active Configuration..., and compile.
96 The project files don't use precompiled headers, to save disk
97 space, but you can switch PCH compiling on for greater speed.
98 NOTE: you may also use samples/SamplesVC.dsw to access all
99 sample projects without opening each workspace individually.
100 You can use the Batch Build facility to make several samples
105 1. Make sure your WXWIN variable is set.
106 2. If you do NOT have the TIFF or JPEG source code, please remove
107 the tiff and jpeg targets from the 'all' target in
108 src\msw\makefile.vc. Also ensure the settings in
109 include\wx\msw\setup.h specify not to use JPEG or TIFF.
110 3. Change directory to wx\src\msw. Type:
112 'nmake -f makefile.vc'
114 to make the wxWindows core library with debug information
115 (wx\lib\wxd.lib), then
117 'nmake -f makefile.vc cleanall FINAL=1'
118 'nmake -f makefile.vc FINAL=1'
120 to make the wxWindows core library without debug information
122 4. Change directory to wx\samples and type 'nmake -f makefile.vc'
123 to make all the samples. You can also make them individually.
127 Use the 'cleanall' target to clean all objects, libraries and
130 To build the release version using makefiles, add FINAL=1 to your
131 nmake invocation, both when building the library and for samples.
132 You MUST use the 'cleanall' target (with FINAL=1 or FINAL=0)
133 before making a different configuration, because otherwise
134 object files used to build the previous configuration may be
135 used accidentally for the current configuation. You might see
136 this manifested in unexpected link errors or warnings. This problem
137 doesn't occur when using project files to build wxWindows.
139 Note that the wxWindows core library allows you to have debug
140 and release libraries available simultaneously, by compiling the
141 objects in different subdirectories, whereas samples must be
142 cleaned and re-made to build a different configuration.
144 To build the DLL version using makefiles:
146 1. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll pch'
147 to make both a suitable DLL and import library, and to build a
148 suitable precompiled header file for compiling applications.
149 The resulting libraries are called:
151 wx\lib\wx[version].lib(dll) (debug version)
152 wx\lib\wx[version].lib(dll) (release version, using FINAL=1)
154 2. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'
155 (or edit src\makeprog.vc to set WXUSINGDLL to 1 for all
158 Note (1): if you wish to use templates, please edit
159 include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
160 Without this, the redefinition of 'new' will cause problems in
161 the headers. Alternatively, #undef new before including template headers.
162 You will also need to set wxUSE_IOSTREAMH to 0 if you will be
163 using templates, to avoid the non-template stream files being included
166 Note (2): libraries and applications generated with makefiles and
167 project files are now (hopefully) compatible where static libraries
168 are concerned, but please exercise caution nevertheless and if
169 possible, use one method or the other.
171 Note (3): VC++ 5's optimization code seems to be broken and can
172 cause both compile and run-time problems: this can be seen when
173 deleting an object Dialog Editor, in Release mode with optimizations
174 on. If in doubt, switch off optimisations, although this will result in much
175 larger executables. It seems possible that the library can be created with
176 strong optimization, so long as the application is not strongly
177 optimized. For example, in wxWindows project, set to 'Minimum
178 Size'. In Dialog Editor project, set to 'Customize: Favor Small
179 Code' (and no others). This will then work.
181 Similarly, in VC++ 4, optimization can cause internal compiler
182 errors, so edit src\makevc.env and change /O1 to /Od before
183 trying build a release version of the library. Or, type:
185 nmake -f makefile.vc noopt FINAL=1
187 and then resume compilation in the normal way. This will build
188 troublesome files with no optimization. However, there now seems to be
189 an internal linker error using VC++ 4, in addition to internal
190 compiler errors for most of the samples, so this version of the compiler
191 cannot be recommended!
193 Note (4): some crash problems can be due to inconsistent compiler
194 options. If strange/weird/impossible things start to happen please
195 check (dumping IDE project file as makefile and doing text comparison
196 if necessary) that the project settings, especially the list of defined
197 symbols, struct packing, etc. are exactly the same for all items in
198 the project. After this, delete everything (including PCH) and recompile.
200 Note (5): for some further notes about upgrading your project
201 files to be compatible with wxWindows 2.1.14, please see
202 "Highlights of wxWindows 2.1.14" from the Download page of the
205 Visual C++ 1.5 compilation (16-bit)
206 -----------------------------------
208 1. Make sure your WXWIN variable is set, and uses the FAT (short
210 2. Change directory to wx\src\msw. Type 'nmake -f makefile.dos' to
211 make the wxWindows core library.
212 3. Change directory to a sample, such as wx\samples\minimal, and
213 type 'nmake -f makefile.dos'.
215 Add FINAL=1 to your makefile invocation to build the release
216 versions of the library and samples.
218 Use the 'clean' target to clean all objects, libraries and
221 Borland C++ 4.5/5.0 compilation
222 -------------------------------
224 Compiling using the makefiles:
226 1. Make sure your WXWIN variable is set, and uses the FAT (short
227 name) form if doing a 16-bit compile.
228 2. Change directory to wx\src\msw. Type 'make -f makefile.b32' to
229 make the wxWindows core library. Ignore the warnings about
230 'XXX' not found in library.
231 3. Change directory to a sample or demo such as samples\minimal, and type
232 'make -f makefile.b32'.
233 4. For release versions, recompile wxWindows and samples using
234 'make -f makefile.b32 clean'
235 'make -f makefile.b32 FINAL=1'
236 for the library and samples.
238 Note (1): the wxWindows library and (some) samples compile in 16-bit mode
239 using makefile.bcc, but at present the wxWindows resource system is switched
240 off in this mode. See issues.txt for details.
242 Note (2): unfortunately most samples won't link in 16-bit mode,
243 because the automatic data segment exceeds 64K. The minimal
244 sample links and runs, however.
246 Note (3): the wxWindows makefiles assume byte structure alignment. Please
247 make sure that your own project or makefile settings use the
248 same alignment, or you could experience mysterious crashes. To
249 change the alignment, add a suitable option to the $(CFG) target code
250 in src/msw/makefile.b32.
252 Note (4): if you get undefined _SQL... symbols at link time,
253 either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
254 directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
255 recompile wxWindows. The same applies if compiling using the IDE.
257 Note (5): BC++ 4.5 (not 5.0) trips up over jdmerge.c in the JPEG folder;
258 you will therefore need to set wxUSE_LIBJPEG to 0 in setup.h and remove
259 the jpeg target from src\msw\makefile.b32, and remove jpeg from
262 Note (6): If using C++Builder 4 and above (BC++ 5.4 and above), change LINK=tlink32 to
263 LINK=ilink32 in src\makeb32.env. You may also need to disable
264 wxUSE_LIBJPEG because there is a conflict in the BC++ headers
265 (actually this problem seems to have gone away with 5.5 and SP1).
267 Note (7): If you wish debug messages to be sent to the console in
268 debug mode, edit src\makeb32.env and change /aa to /Tpe in
271 Compiling using the IDE files:
273 1. Load src\bc32.ide (Release settings)
274 2. Go to Options|Project... and specify the correct BC++ include and lib path for
276 3. Press F9 to compile the wxWindows library.
277 4. Load samples\bc32.ide.
278 5. Go to Options|Project... and specify the correct BC++ include and lib path for
280 6. Press F9 to compile the samples (build each node separately if
281 you prefer, by right clicking and choose Build Node).
282 7. Run each sample: you may need to run from each sample's directory
283 since some (notably the wxHTML samples) look for files
284 relative to the working directory.
286 Note (1): the samples project file contains a selection of
287 samples, and not all samples. The remaining samples can be made
288 with the makefiles. See also the demos hierarchy which doesn't
289 have any BC++ project files yet.
291 Note (2): to make the png, xpm, zlib, jpeg and tiff libraries (needed for
292 some samples) you need to compile them with bc32.ide.
294 Note (3): the debug version of the wxWindows library is about 40 MB, and the
295 release version is around 5 MB.
297 See also the file bc_ide.txt for further instructions and details
298 of how to create your own project files.
300 Borland C++Builder compilation
301 ------------------------------
303 C++Builder compilation is the same as for Borland C++ above.
305 Tested with C++Builder 1.0 and 3.0. Only makefiles are currently
308 Watcom C++ 10.6/11 compilation
309 ---------------------------
311 1. Make sure your WXWIN variable is set, and uses the DOS short
313 2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat' to
314 make the wxWindows core library.
315 3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat'
316 to make this sample. Repeat for other samples of interest.
318 Note (1): setup.h overrides wxUSE_LIBJPEG and sets it to 0, since
319 imagjpeg.cpp doesn't compile.
320 Note (2): makewat.env uses the odbc32.lib supplied in wxWindows' lib\watcom
321 directory. See the notes in that directory.
322 Note (3): if variant.cpp is compiled with date/time class
323 options, the linker gives up. So the date/time option is switched
324 off for Watcom C++. Also, wxAutomationObject is not compiled with
326 Note (4): if Watcom can't read the precompiled header when
327 building a sample, try deleting src\msw\watcom.pch and
328 compiling the sample again.
329 Note (5): if you get _popen_ and _pclose_ link errors, try
330 recompiling wxWindows with XPM support disabled in setup.h.
331 Alternatively, make sure these lines exist at the top of
334 // Added by JACS for Watcom C++/wxWindows compilation (no popen/pclose functions)
339 Metrowerks CodeWarrior compilation
340 ----------------------------------
342 1. Downloaded and unzip wx2_x_y_cw.zip.
343 2. Load the make_cw.mcp project in wx\src, and compile.
344 3. Load the make_cw.mcp project in wx\samples\minimal, and compile.
345 Further project files for samples will be available in due
348 Note (1): you need CodeWarrior Pro 4 plus the patches to 4.1 from the
351 Note (2): unfortunately these files are not yet up-to-date for the
354 Symantec C++ compilation
355 ------------------------
357 1. Make sure your WXWIN variable is set, and uses the FAT (short
359 2. Edit setup.h and set wxUSE_DRAG_AND_DROP to 0.
360 3. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
361 make the wxWindows core library.
362 4. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
365 Note: the minimal sample doesn't link properly ('Error: no
367 32-bit compilation only (partially) supported at present, using SC++ 6.1.
368 Some functionality is missing using this compiler (see makefile).
369 Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
370 Step (2). 16-bit compilation is left as an excercise for the user!
372 Salford C++ compilation
373 -----------------------
375 1. Make sure your WXWIN variable is set, and uses the FAT (short
377 2. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
379 3. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
380 make the wxWindows core library.
381 4. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
384 Unfortunately, Salford C++ seems to have problems with its code generation for
385 operations on objects, as seen in wxFrame::OnMenuHighlight
386 (minimal sample) or wxWindow::SetValidator (mdi sample). Also the
387 the debugging version of the library is 90MB, with samples coming in
388 at 40MB :-) However, wxWindows at least makes a good test suite for
389 improving the compiler.
391 Cygwin b19/b20/Mingw32 compilation
392 ----------------------------------
394 wxWindows 2 supports Cygwin (formerly GnuWin32) b19, b20, Mingw32,
397 Thanks are due to Keith Garry Boyce (garp@opustel.com) and Cygnus for making
400 From wxWindows 2.0 beta 9, both Cygwin and Mingw32 (the minimal
401 distribution of Cygwin) can be used with the same makefiles.
403 Here are the steps required:
405 - Retrieve and install the latest beta of Cygwin, or Mingw32, as per the
406 instructions with either of these packages.
408 - If using Mingw32 (including the EGCS variant), you need some
409 extra files to use the wxWindows makefiles. You can find these
410 files in ports/mingw32 on the ftp site or CD-ROM, as extra.zip.
411 These should be extracted to the Mingw32 directory.
412 If you have already have downloaded bison, flex, make, rm, cp, mv
413 from elsewhere, you won't need this.
415 If using Mingw32 2.8.1, see also see mingw32.txt in this directory
416 (docs/msw) about a fix that has to be applied to a Mingw32 header file.
418 If using Mingw32 2.95 and below with wxWindows 2.1 or above, you
419 must hand-patch in Mingw32-gcc295.patches (located in the top-level of the
420 wxWindows 2 installation). Mingw32 2.95.2 and above contain the
423 - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
424 to set up appropriate variables, if necessary mounting drives.
425 Run it before compiling.
427 - For Cygwin, make sure there's a \tmp directory on your
428 Windows drive or bison will crash (actually you don't need this
429 for ordinary wxWindows compilation: a pre-generated .c file is
432 - Edit wx/src/makeg95.env and set the MINGW32 variable at the top of
433 the file to either 1 (you have Mingw32) or 0 (you have Cygwin32).
434 If using MINGW32, also set the MINGW32VERSION variable
437 - Mingw32 may not support winsock.h, so if you have a problem
438 here, comment out socket-related files in src/msw/makefile.g95.
440 - Set your WXWIN variable to where wxWindows is installed.
441 *** IMPORTANT: For Cygwin/Mingw32, use forward slashes in the path, not
444 - Use the makefile.g95 files for compiling wxWindows and samples,
447 > make -f makefile.g95
448 > cd c:\wx\samples\minimal
449 > make -f makefile.g95
451 Ignore the warning about the default entry point.
453 - Use the 'strip' command to reduce executable size.
455 - With Cygnus Cygwin, you can invoke gdb --nw myfile.exe to
456 debug an executable. If there are memory leaks, they will be
457 flagged when the program quits.
459 - If using GnuWin32 b18, you will need to copy windres.exe
460 from e.g. the Mingw32 distribution, to a directory in your path.
462 All targets have 'clean' targets to allow removal of object files
463 and other intermediate compiler files.
467 1. See also the Cygwin/Mingw32 on the web site or CD-ROM for
468 further information about using wxWindows with these compilers.
470 2. libwx.a is 48 MB or more - but much less if compiled with no
471 debug info (-g0) and level 4 optimization (-O4).
473 3. There's a bug in Mingw32 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 4. If there's a problem with the copy command in
486 src/msw/makefile.g95, you may need to change the COPY and
487 COPYSEP variables in makeg95.env.
489 5. If there's a problem executing the windres program, try
490 commenting out RCPREPROCESSOR in makeg95.env.
492 6. OpenGL support should work with Mingw32 as-is. However,
493 if you wish to generate import libraries appropriate either for
494 the MS OpenGL libraries or the SGI OpenGL libraries, go to
495 include/wx/msw/gl and use:
497 dlltool -k -d opengl.def -llibopengl.a
501 dlltool -k -d opengl32.def -llibopengl32.a
503 and similarly for glu[32].def.
507 - The GNU-WIN32 site is at
508 http://www.cygnus.com/gnu-win32/
509 - Mingw32 is available at:
510 ftp://ftp.xraylith.wisc.edu/pub/khan/gnu-win32/mingw32/gcc-2.95/
511 - See also http://web.ukonline.co.uk/julian.smart/wxwin/gnuwin32.htm
513 TWIN32 and gcc on Linux
514 -----------------------
516 The wxWindows 2 for Windows port may be compiled using
517 the TWIN32 emulator package from www.willows.com. However,
518 TWIN32 is by no means finished so this should be taken as
519 something to think about for the future, rather than
520 a tool for writing products with.
522 Use makefile.twn in much the same way as makefile.g95, as
523 described above. Not all sample makefiles are supplied yet.
525 For some reason, I found I had to copy TWIN32's Windows resource
526 compiler (rc) to the current working directory for it to be found.
531 - Debugging: under Windows 95, debugging output isn't output in
532 the same way that it is under NT or Windows 3.1. Set
533 wxUSE_DBWIN32 to 1 if you wish to enable code to output debugging
534 info to an external debug monitor, such as Andrew Tucker's DBWIN32.
535 You can download DBWIN32 from:
537 http://ftp.digital.com/pub/micro/NT/WinSite/programr/dbwin32.zip
539 and it's also on the wxWindows CD-ROM under Packages.
541 - If you are installing wxWindows 2 from CVS, you may find that
542 include/wx/msw/setup.h is missing. This is deliberate, to avoid
543 developers' different setup.h configurations getting confused.
544 Please copy setup0.h to setup.h before compiling.