2 Installing wxWindows 2.0
3 ------------------------
5 IMPORTANT NOTE: If you experience problems installing, please
6 re-read this instructions and other related files (todo.txt,
7 bugs.txt etc.) carefully before mailing wxwin-users or
8 the author. Preferably, try to fix the problem first and
9 then send a patch to the author.
14 If there is a setup program, run the setup program that comes with the Windows version.
15 Do not install into a path that contains spaces. The installation program should set the
16 WXWIN environment variable, which will be activated when your machine is rebooted.
18 If there is no setup program, it will come as a series of .zip
21 wx200gen.zip Generic source code and samples (required)
22 wx200msw.zip Windows-specific source code and samples (required)
23 wx200doc.zip Documentation source code (not required)
24 wx200hlp.zip WinHelp documentation
25 wx200pdf.zip Acrobat PDF documentation
26 wx200htm.zip HTML documentation
27 wx200vc.zip MS VC++ 5.0 project files
28 wx200cw.zip Metrowerks CodeWarrior project files
30 Unarchive the required files plus any optional documentation
31 files into a suitable directory such as c:\wx.
33 Other add-on packages are available from the wxWindows Web site, such as:
35 - glcanvas.zip. Use OpenGL in a wxWindows window.
36 - ogl3.zip. Object Graphics Library: build network diagrams, CASE tools etc.
37 - tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
38 the same document source.
40 General installation notes
41 --------------------------
43 Alter your WXWIN environment variable to point to this directory.
44 For Cygwin or Mingw32 compilation, make sure WXWIN contains only
47 If installing from the CVS server, copy include/wx/msw/setup0.h to
48 include/wx/msw/setup.h.
53 The following sections explain how to compile wxWindows with each supported
56 Visual C++ 4.0/5.0/6.0 compilation
57 ----------------------------------
61 1. Unarchive wx200vc.zip, the VC++ 5 project makefiles.
62 2. Open src/wxvc.dsp, set Debug or Release configuration, and
63 compile. This will produce src/Debug/wxvc.lib or
64 src/Release/wxvc.lib. The project file src/wxvc_dll.dsp
65 will make a DLL version of wxWindow, which will go in
66 src/DebugDLL/wxvc.[lib,dll] and src/ReleaseDLL/wxvc.[lib,dll].
67 3. Open a sample project file, choose a configuration, and compile.
68 The project files don't use precompiled headers, to save
69 space, but you can switch PCH compiling on for greater speed.
73 1. Make sure your WXWIN variable is set.
74 2. Change directory to wx\src\msw. Type:
76 'nmake -f makefile.vc'
78 to make the wxWindows core library with debug information
81 'nmake -f makefile.vc FINAL=1'
83 to make the wxWindows core library without debug information
86 3. Change directory to wx\samples and type 'nmake -f makefile.vc'
87 to make all the samples. You can also make them individually.
91 Use the 'clean' target to clean all objects, libraries and
94 To build the release version using makefiles, add FINAL=1 to your
95 nmake invocation, both when building the library and for samples.
97 Note that the wxWindows core library allows you to have debug
98 and release libraries available simultaneously, by compiling the
99 objects in different subdirectories, whereas samples must be
100 cleaned and re-made to build a different configuration. This
101 may be changed in later versions of wxWindows.
103 To build the DLL version using makefiles:
105 1. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll pch'
106 to make both a suitable DLL and import library, and to build a
107 suitable precompiled header file for compiling applications.
108 The resulting libraries are called:
110 wx\lib\wx200_d.lib(dll) (debug version)
111 wx\lib\wx200.lib(dll) (release version, using FINAL=1)
113 2. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'
114 (or edit src\makeprog.vc to set WXUSINGDLL to 1 for all
117 Note (1): if you wish to use templates, please edit
118 include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
119 Without this, the redefinition of 'new' will cause problems in
120 the headers. Alternatively, #undef new before including template headers.
121 You will also need to set wxUSE_IOSTREAMH to 0 if you will be
122 using templates, to avoid the non-template stream files being included
125 Note (2): libraries and applications generated with makefiles and
126 project files are unlikely to be compatible, so use one method or
129 Note (3): VC++ 5's optimization code seems to be broken and can
130 cause problems: this can be seen when deleting an object Dialog
131 Editor, in Release mode with optimizations on. If in doubt,
132 switch off optimisations, although this will result in much
133 larger executables. It seems possible that the library can be created with
134 strong optimization, so long as the application is not strongly
135 optimized. For example, in wxWindows project, set to 'Minimum
136 Size'. In Dialog Editor project, set to 'Customize: Favor Small
137 Code' (and no others). This will then work.
139 Visual C++ 1.5 compilation
140 --------------------------
142 1. Make sure your WXWIN variable is set, and uses the FAT (short
144 2. Change directory to wx\src\msw. Type 'nmake -f makefile.dos' to
145 make the wxWindows core library.
146 3. Change directory to a sample, such as wx\samples\minimal, and
147 type 'nmake -f makefile.dos'.
149 Add FINAL=1 to your makefile invocation to build the release
150 versions of the library and samples.
152 Use the 'clean' target to clean all objects, libraries and
155 Borland C++ 4.5/5.0 compilation
156 -------------------------------
158 Compiling using the makefiles:
160 1. Make sure your WXWIN variable is set, and uses the FAT (short
161 name) form if doing a 16-bit compile.
162 2. Change directory to wx\src\msw. Type 'make -f makefile.b32' to
163 make the wxWindows core library. Ignore the warnings about
164 'XXX' not found in library.
165 3. Change directory to a sample such as minimal, and type
166 'make -f makefile.b32'.
167 4. For release versions, recompile wxWindows and samples using
168 'make -f makefile.b32 clean'
169 'make -f makefile.b32 FINAL=1'
170 for the library and samples.
172 Note: the wxWindows library and (some) samples compile in 16-bit mode
173 using makefile.bcc, but at present the wxWindows resource system is switched
174 off in this mode. See issues.txt for details.
176 Compiling using the IDE files:
178 1. Load src\wxwin32_lib.ide.
179 2. Go to Options|Project... and specify the correct BC++ include and lib path for
181 3. Press F9 to compile the wxWindows library.
182 4. Load samples\samples.ide.
183 5. Go to Options|Project... and specify the correct BC++ include and lib path for
185 6. Press F9 to compile the samples.
187 See also the file bc_ide.txt for further instructions and details
188 of how to create your own project files.
190 Borland C++Builder compilation
191 ------------------------------
193 C++Builder compilation is the same as for Borland C++ above.
195 Tested with C++Builder 1.0 and 3.0. Only makefiles are currently
198 Watcom C++ 10.6 compilation
199 ---------------------------
201 1. Make sure your WXWIN variable is set, and uses the DOS short
203 2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat' to
204 make the wxWindows core library.
205 3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat'
208 Metrowerks CodeWarrior compilation
209 ----------------------------------
211 1. Downloaded and unzip wx200cw.zip.
212 2. Load the make_cw.mcp project in wx\src, and compile.
213 3. Load the make_cw.mcp project in wx\samples\minimal, and compile.
214 Further project files for samples will be available in due
219 (a) Unfortunately CodeWarrior support is broken in this
220 release. Stefan Csomor (csomor@advancedconcepts.ch) will rectify this shortly.
221 (b) You need CodeWarrior Pro 4 plus the patches to 4.1 from the
224 Symantec C++ compilation
225 ------------------------
227 1. Make sure your WXWIN variable is set, and uses the FAT (short
229 2. Edit setup.h and set wxUSE_DRAG_AND_DROP to 0.
230 3. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
231 make the wxWindows core library.
232 4. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
235 Note: the minimal sample doesn't link properly ('Error: no
237 32-bit compilation only (partially) supported at present, using SC++ 6.1.
238 Some functionality is missing using this compiler (see makefile).
239 Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
240 Step (2). 16-bit compilation is left as an excercise for the user!
242 Salford C++ compilation
243 -----------------------
245 1. Make sure your WXWIN variable is set, and uses the FAT (short
247 2. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
249 3. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
250 make the wxWindows core library.
251 4. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
254 Unfortunately, Salford C++ seems to have problems with its code generation for
255 operations on objects, as seen in wxFrame::OnMenuHighlight
256 (minimal sample) or wxWindow::SetValidator (mdi sample). Also the
257 the debugging version of the library is 90MB, with samples coming in
258 at 40MB :-) However, wxWindows at least makes a good test suite for
259 improving the compiler.
261 Cygwin b19/b20/Mingw32 compilation
262 ----------------------------------
264 wxWindows 2.0 supports Cygwin (formerly GnuWin32) b19, b20, Mingw32, and Mingw32/EGCS.
266 Thanks are due to Keith Garry Boyce (garp@opustel.com) and Cygnus for making
269 From wxWindows 2.0 beta 9, both Cygwin and Mingw32 (the minimal
270 distribution of Cygwin) can be used with the same makefiles.
272 Here are the steps required:
274 - Retrieve and install the latest beta of Cygwin, or Mingw32, as per the
275 instructions with either of these packages.
277 - If using Mingw32 (including the EGCS variant), you need some
278 extra files to use the wxWindows makefiles. You can find these
279 files in ports/mingw32 on the ftp site or CD-ROM, as extra.zip.
280 These should be extracted to the Mingw32 directory.
281 If you have already have downloaded bison, flex, make, rm, mv
282 from elsewhere, you won't need this.
284 IMPORTANT: also see mingw32.txt in this directory (docs/msw)
285 about a fix that has to be applied to a Mingw32 header file.
287 - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
288 to set up appropriate variables, if necessary mounting drives.
289 Run it before compiling.
291 - For Cygwin, make sure there's a \tmp directory on your
292 Windows drive or bison will crash.
294 - Edit wx/src/makeg95.env and search for MINGW32. Take note of
295 the comments for adjusting settings to suit Cygwin or
296 Mingw32. Basically, this is just a case of adding the __MINGW32__ symbol
297 to OPTIONS for Mingw32, or removing it for Cygnus Cygwin.
298 For Mingw32/EGCS, add both __MINGW32__ and __EGCS__.
299 You may need to remove -loldnames from WINLIBS for Mingw32, or add it for
302 - Mingw32 may not support winsock.h, so comment out
303 socket-related files in src/msw/makefile.g95.
305 - Set your WXWIN variable to where wxWindows is installed.
306 For Cygwin/Mingw32, use forward slashes in the path, not backslashes.
308 - Use the makefile.g95 files for compiling wxWindows and samples,
311 > make -f makefile.g95
312 > cd c:\wx\samples\minimal
313 > make -f makefile.g95
315 Ignore the warning about the default entry point.
317 - Use the 'strip' command to reduce executable size.
319 - With Cygnus Cygwin, you can invoke gdb --nw myfile.exe to
320 debug an executable. If there are memory leaks, they will be
321 flagged when the program quits.
323 - If using GnuWin32 b18, you will need to copy windres.exe
324 from e.g. the Mingw32 distribution, to a directory in your path.
326 All targets have 'clean' targets to allow removal of object files
327 and other intermediate compiler files.
331 - libwx.a is 48 MB or more - but much less if compiled with no
332 debug info (-g0) and level 4 optimization (-O4).
333 - install.exe doesn't have built-in decompression because lzexpand.lib
334 isn't available with Cygwin. However, you can use it with external
335 decompression utilities.
336 - Doesn't compile src/msw/ole files, so no drag and drop.
340 - The GNU-WIN32 site is at
341 http://www.cygnus.com/gnu-win32/
342 - Mingw32 is available at:
343 http://agnes.dida.physik.uni-essen.de/~janjaap/mingw32/index.html
344 - See also http://web.ukonline.co.uk/julian.smart/wxwin/gnuwin32.htm
346 TWIN32 and gcc on Linux
347 -----------------------
349 The wxWindows 2 for Windows port may be compiled using
350 the TWIN32 emulator package from www.willows.com. However,
351 TWIN32 is by no means finished so this should be taken as
352 something to think about for the future, rather than
353 a tool for writing products with.
355 Use makefile.twn in much the same way as makefile.g95, as
356 described above. Not all sample makefiles are supplied yet.
358 For some reason, I found I had to copy TWIN32's Windows resource
359 compiler (rc) to the current working directory for it to be found.
364 - Debugging: under Windows 95, debugging output isn't output in
365 the same way that it is under NT or Windows 3.1. Set
366 wxUSE_DBWIN32 to 1 if you wish to enable code to output debugging
367 info to an external debug monitor, such as Andrew Tucker's DBWIN32.
368 You can download DBWIN32 from:
370 http://ftp.digital.com/pub/micro/NT/WinSite/programr/dbwin32.zip
372 and it's also on the wxWindows CD-ROM under Packages.
374 - If you are installing wxWindows 2 from CVS, you may find that
375 include/wx/msw/setup.h is missing. This is deliberate, to avoid
376 developers' different setup.h configurations getting confused.
377 Please copy setup0.h to setup.h before compiling.