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 wxWindows 2.0 have been
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 - Object Graphics Library;
34 - wxTreeLayout library;
36 - Dialog Editor binary.
38 Alternatively, you may unarchive the set of .zip files by hand,
39 where x is the minor version number and y is the release number:
41 wx2_x_y_gen.zip Generic source code and samples (required)
42 wx2_x_y_msw.zip Windows-specific source code and samples (required)
43 wx2_x_y_doc.zip Documentation source code (not required)
44 wx2_x_y_hlp.zip WinHelp documentation
45 wx2_x_y_pdf.zip Acrobat PDF documentation
46 wx2_x_y_htm.zip HTML documentation
47 wx2_x_y_vc.zip MS VC++ 5.0 project files
48 wx2_x_y_cw.zip Metrowerks CodeWarrior project files
49 wx2_x_y_bc.zip BC++ 5 project files
50 jpeg.zip Use this to allow wxImage to read and write JPEG 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 - glcanvas.zip. Use OpenGL in a wxWindows window.
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 ----------------------------------
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, and
86 compile. This will produce src/Debug/wxvc.lib or
87 src/Release/wxvc.lib. The project file src/wxvc_dll.dsp
88 will make a DLL version of wxWindow, which will go in
89 src/DebugDLL/wxvc.[lib,dll] and src/ReleaseDLL/wxvc.[lib,dll].
90 3. If you want to use JPEG in your application (such as the image
91 sample), open src/jpeg/jpeg.dsp (VC++ 5/6 only) and compile in
92 Debug and Release configurations. If you have VC++ 4,
93 use makefile.vc, but you may only have one set of object
94 files at a time in use (debug or release versions).
95 4. Open a sample project file, choose a configuration using
96 Build | Set Active Configuration..., and compile.
97 The project files don't use precompiled headers, to save
98 space, but you can switch PCH compiling on for greater speed.
102 1. Make sure your WXWIN variable is set.
103 2. Change directory to wx\src\msw. Type:
105 'nmake -f makefile.vc'
107 to make the wxWindows core library with debug information
108 (wx\lib\wx_d.lib), or
110 'nmake -f makefile.vc FINAL=1'
112 to make the wxWindows core library without debug information
114 3. If you wish to use JPEG in your applications, do the same
115 procedure in src\jpeg but add the 'all' target to the
117 4. Change directory to wx\samples and type 'nmake -f makefile.vc'
118 to make all the samples. You can also make them individually.
122 Use the 'clean' target to clean all objects, libraries and
125 To build the release version using makefiles, add FINAL=1 to your
126 nmake invocation, both when building the library and for samples.
128 Note that the wxWindows core library allows you to have debug
129 and release libraries available simultaneously, by compiling the
130 objects in different subdirectories, whereas samples must be
131 cleaned and re-made to build a different configuration. This
132 may be changed in later versions of wxWindows.
134 To build the DLL version using makefiles:
136 1. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll pch'
137 to make both a suitable DLL and import library, and to build a
138 suitable precompiled header file for compiling applications.
139 The resulting libraries are called:
141 wx\lib\wx200.lib(dll) (debug version)
142 wx\lib\wx200.lib(dll) (release version, using FINAL=1)
144 2. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'
145 (or edit src\makeprog.vc to set WXUSINGDLL to 1 for all
148 Note (1): if you wish to use templates, please edit
149 include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
150 Without this, the redefinition of 'new' will cause problems in
151 the headers. Alternatively, #undef new before including template headers.
152 You will also need to set wxUSE_IOSTREAMH to 0 if you will be
153 using templates, to avoid the non-template stream files being included
156 Note (2): libraries and applications generated with makefiles and
157 project files are unlikely to be compatible, so use one method or
160 Note (3): VC++ 5's optimization code seems to be broken and can
161 cause both compile and run-time problems: this can be seen when
162 deleting an object Dialog Editor, in Release mode with optimizations
163 on. If in doubt, switch off optimisations, although this will result in much
164 larger executables. It seems possible that the library can be created with
165 strong optimization, so long as the application is not strongly
166 optimized. For example, in wxWindows project, set to 'Minimum
167 Size'. In Dialog Editor project, set to 'Customize: Favor Small
168 Code' (and no others). This will then work.
170 Similarly, in VC++ 4, optimization can cause internal compiler
171 errors, so edit src\makevc.env and change /O1 to /Od before
172 trying build a release version of the library.
174 Note (4): some crash problems can be due to inconsistent compiler
175 options. If strange/weird/impossible things start to happen please
176 check (dumping IDE project file as makefile and doing text comparison
177 if necessary) that the project settings, especially the list of defined
178 symbols, struct packing, etc. are exactly the same for all items in
179 the project. After this, delete everything (including PCH) and recompile.
181 Visual C++ 1.5 compilation (16-bit)
182 -----------------------------------
184 1. Make sure your WXWIN variable is set, and uses the FAT (short
186 2. Change directory to wx\src\msw. Type 'nmake -f makefile.dos' to
187 make the wxWindows core library.
188 3. Change directory to a sample, such as wx\samples\minimal, and
189 type 'nmake -f makefile.dos'.
191 Add FINAL=1 to your makefile invocation to build the release
192 versions of the library and samples.
194 Use the 'clean' target to clean all objects, libraries and
197 Borland C++ 4.5/5.0 compilation
198 -------------------------------
200 Compiling using the makefiles:
202 1. Make sure your WXWIN variable is set, and uses the FAT (short
203 name) form if doing a 16-bit compile.
204 2. Change directory to wx\src\msw. Type 'make -f makefile.b32' to
205 make the wxWindows core library. Ignore the warnings about
206 'XXX' not found in library.
207 3. Change directory to a sample such as minimal, and type
208 'make -f makefile.b32'.
209 4. For release versions, recompile wxWindows and samples using
210 'make -f makefile.b32 clean'
211 'make -f makefile.b32 FINAL=1'
212 for the library and samples.
214 Note (1): the wxWindows library and (some) samples compile in 16-bit mode
215 using makefile.bcc, but at present the wxWindows resource system is switched
216 off in this mode. See issues.txt for details.
218 Note (2): unfortunately most samples won't link in 16-bit mode,
219 because the automatic data segment exceeds 64K. The minimal
220 sample links and runs, however.
222 Note (3): the wxWindows makefiles assume byte structure alignment. Please
223 make sure that your own project or makefile settings use the
224 same alignment, or you could experience mysterious crashes. To
225 change the alignment, add a suitable option to the $(CFG) target code
226 in src/msw/makefile.b32.
228 Note (4): if you get undefined _SQL... symbols at link time,
229 either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
230 directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
231 recompile wxWindows. The same applies if compiling using the IDE.
233 Compiling using the IDE files:
235 1. Load src\bc32.ide (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 that to make the png, xpm, zlib and jpeg libraries (needed for
249 some samples) you need to compile them with bc32.ide.
251 The debug version of the wxWindows library is about 37 MB, and the
252 release version is around 3 MB.
254 See also the file bc_ide.txt for further instructions and details
255 of how to create your own project files.
257 Borland C++Builder compilation
258 ------------------------------
260 C++Builder compilation is the same as for Borland C++ above.
262 Tested with C++Builder 1.0 and 3.0. Only makefiles are currently
265 Watcom C++ 10.6/11 compilation
266 ---------------------------
268 1. Make sure your WXWIN variable is set, and uses the DOS short
270 2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat' to
271 make the wxWindows core library.
272 3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat'
273 to make this sample. Repeat for other samples of interest.
275 Note (1): setup.h overrides wxUSE_LIBJPEG and sets it to 0, since
276 imagjpeg.cpp doesn't compile.
277 Note (2): makewat.env uses the odbc32.lib supplied in wxWindows' lib\watcom
278 directory. See the notes in that directory.
280 Metrowerks CodeWarrior compilation
281 ----------------------------------
283 1. Downloaded and unzip wx2_x_y_cw.zip.
284 2. Load the make_cw.mcp project in wx\src, and compile.
285 3. Load the make_cw.mcp project in wx\samples\minimal, and compile.
286 Further project files for samples will be available in due
289 Note (1): you need CodeWarrior Pro 4 plus the patches to 4.1 from the
292 Note (2): unfortunately these files are not yet up-to-date for the
295 Symantec C++ compilation
296 ------------------------
298 1. Make sure your WXWIN variable is set, and uses the FAT (short
300 2. Edit setup.h and set wxUSE_DRAG_AND_DROP to 0.
301 3. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
302 make the wxWindows core library.
303 4. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
306 Note: the minimal sample doesn't link properly ('Error: no
308 32-bit compilation only (partially) supported at present, using SC++ 6.1.
309 Some functionality is missing using this compiler (see makefile).
310 Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
311 Step (2). 16-bit compilation is left as an excercise for the user!
313 Salford C++ compilation
314 -----------------------
316 1. Make sure your WXWIN variable is set, and uses the FAT (short
318 2. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
320 3. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
321 make the wxWindows core library.
322 4. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
325 Unfortunately, Salford C++ seems to have problems with its code generation for
326 operations on objects, as seen in wxFrame::OnMenuHighlight
327 (minimal sample) or wxWindow::SetValidator (mdi sample). Also the
328 the debugging version of the library is 90MB, with samples coming in
329 at 40MB :-) However, wxWindows at least makes a good test suite for
330 improving the compiler.
332 Cygwin b19/b20/Mingw32 compilation
333 ----------------------------------
335 wxWindows 2 supports Cygwin (formerly GnuWin32) b19, b20, Mingw32, and Mingw32/EGCS.
337 Thanks are due to Keith Garry Boyce (garp@opustel.com) and Cygnus for making
340 From wxWindows 2.0 beta 9, both Cygwin and Mingw32 (the minimal
341 distribution of Cygwin) can be used with the same makefiles.
343 Here are the steps required:
345 - Retrieve and install the latest beta of Cygwin, or Mingw32, as per the
346 instructions with either of these packages.
348 - If using Mingw32 (including the EGCS variant), you need some
349 extra files to use the wxWindows makefiles. You can find these
350 files in ports/mingw32 on the ftp site or CD-ROM, as extra.zip.
351 These should be extracted to the Mingw32 directory.
352 If you have already have downloaded bison, flex, make, rm, mv
353 from elsewhere, you won't need this.
355 If using Mingw32 2.8.1, see also see mingw32.txt in this directory
356 (docs/msw) about a fix that has to be applied to a Mingw32 header file.
358 If using Mingw32 2.95 with wxWindows 2.1 or above, and wish to use OLE, you
359 should hand-patch in Mingw32-gcc295.patches (located in the top-level of the
360 wxWindows 2 installation).
362 - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
363 to set up appropriate variables, if necessary mounting drives.
364 Run it before compiling.
366 - For Cygwin, make sure there's a \tmp directory on your
367 Windows drive or bison will crash.
369 - Edit wx/src/makeg95.env and set the MINGW32 variable at the top of
370 the file to either 1 (you have Mingw32) or 0 (you have Cygwin32).
371 If using MINGW32, also set the MINGW32VERSION variable
374 - Mingw32 may not support winsock.h, so if you have a problem
375 here, comment out socket-related files in src/msw/makefile.g95.
377 - Set your WXWIN variable to where wxWindows is installed.
378 *** IMPORTANT: For Cygwin/Mingw32, use forward slashes in the path, not
381 - Use the makefile.g95 files for compiling wxWindows and samples,
384 > make -f makefile.g95
385 > cd c:\wx\samples\minimal
386 > make -f makefile.g95
388 Ignore the warning about the default entry point.
390 - Use the 'strip' command to reduce executable size.
392 - With Cygnus Cygwin, you can invoke gdb --nw myfile.exe to
393 debug an executable. If there are memory leaks, they will be
394 flagged when the program quits.
396 - If using GnuWin32 b18, you will need to copy windres.exe
397 from e.g. the Mingw32 distribution, to a directory in your path.
399 All targets have 'clean' targets to allow removal of object files
400 and other intermediate compiler files.
404 - See also the Cygwin/Mingw32 on the web site or CD-ROM for
405 further information about using wxWindows with these compilers.
407 - libwx.a is 48 MB or more - but much less if compiled with no
408 debug info (-g0) and level 4 optimization (-O4).
410 - install.exe doesn't have built-in decompression because lzexpand.lib
411 isn't available with Cygwin. However, you can use it with external
412 decompression utilities.
414 - There's a bug in Mingw32 headers for some early distributions.
416 in include/windows32/defines.h, where it says:
418 #define LPSTR_TEXTCALLBACKA (LPSTR)-1L)
422 #define LPSTR_TEXTCALLBACKA ((LPSTR)-1L)
426 - If there's a problem with the copy command in
427 src/msw/makefile.g95, you may need to change the relevant
428 section to the following:
430 COPY = command /c copy
431 $(COMMDIR)/y_tab.c: $(COMMDIR)/dosyacc.c
432 $(COPY) ..\\common\\dosyacc.c ..\\common\\y_tab.c
434 $(COMMDIR)/lex_yy.c: $(COMMDIR)/doslex.c
435 $(COPY) ..\\common\\doslex.c ..\\common\\lex_yy.c
439 - The GNU-WIN32 site is at
440 http://www.cygnus.com/gnu-win32/
441 - Mingw32 is available at:
442 ftp://ftp.xraylith.wisc.edu/pub/khan/gnu-win32/mingw32/gcc-2.95/
443 - See also http://web.ukonline.co.uk/julian.smart/wxwin/gnuwin32.htm
445 TWIN32 and gcc on Linux
446 -----------------------
448 The wxWindows 2 for Windows port may be compiled using
449 the TWIN32 emulator package from www.willows.com. However,
450 TWIN32 is by no means finished so this should be taken as
451 something to think about for the future, rather than
452 a tool for writing products with.
454 Use makefile.twn in much the same way as makefile.g95, as
455 described above. Not all sample makefiles are supplied yet.
457 For some reason, I found I had to copy TWIN32's Windows resource
458 compiler (rc) to the current working directory for it to be found.
463 - Debugging: under Windows 95, debugging output isn't output in
464 the same way that it is under NT or Windows 3.1. Set
465 wxUSE_DBWIN32 to 1 if you wish to enable code to output debugging
466 info to an external debug monitor, such as Andrew Tucker's DBWIN32.
467 You can download DBWIN32 from:
469 http://ftp.digital.com/pub/micro/NT/WinSite/programr/dbwin32.zip
471 and it's also on the wxWindows CD-ROM under Packages.
473 - If you are installing wxWindows 2 from CVS, you may find that
474 include/wx/msw/setup.h is missing. This is deliberate, to avoid
475 developers' different setup.h configurations getting confused.
476 Please copy setup0.h to setup.h before compiling.