docs/msw/install.txt

   1
   2 Installing wxWindows 2.0
   3 ------------------------
   4
   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.
  10
  11 Unarchiving
  12 -----------
  13
  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.
  17
  18 If there is no setup program, it will come as a series of .zip
  19 files:
  20
  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
  29
  30 Unarchive the required files plus any optional documentation
  31 files into a suitable directory such as c:\wx.
  32
  33 Other add-on packages are available from the wxWindows Web site, such as:
  34
  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.
  39
  40 General installation notes
  41 --------------------------
  42
  43 Alter your WXWIN environment variable to point to this directory.
  44 For Cygwin or Mingw32 compilation, make sure WXWIN contains only
  45 forward slashes.
  46
  47 If installing from the CVS server, copy include/wx/msw/setup0.h to
  48 include/wx/msw/setup.h.
  49
  50 Compilation
  51 -----------
  52
  53 The following sections explain how to compile wxWindows with each supported
  54 compiler.
  55
  56 Visual C++ 4.0/5.0/6.0 compilation
  57 ----------------------------------
  58
  59 Using project files:
  60
  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 lib/wxvc.lib or lib/wxvc_debug.lib.
  64 3. Open a sample project file, choose a configuration, and compile.
  65    The project files don't use precompiled headers, to save
  66    space, but you can switch PCH compiling on for greater speed.
  67
  68 Using makefiles:
  69
  70 1. Make sure your WXWIN variable is set.
  71 2. Change directory to wx\src\msw. Type 'nmake -f makefile.vc' to
  72    make the wxWindows core library.
  73 3. Change directory to wx\samples and type 'nmake -f makefile.vc'
  74    to make all the samples. You can also make them individually.
  75
  76 To build the release version using makefiles, add FINAL=1 to your
  77 nmake invocation, both when building the library and for samples.
  78
  79 Use the 'clean' target to clean all objects, libraries and
  80 executables.
  81
  82 To build the DLL version using makefiles:
  83
  84 1. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll pch'
  85    to make both a suitable DLL and import library, and to build a
  86    suitable precompiled header file for compiling applications.
  87 2. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'.
  88
  89 Note (1): if you wish to use templates, please edit
  90 include\wx\msw\setup.h and set wxUSE_DEBUG_NEW_ALWAYS to 0.
  91 Without this, the redefinition of 'new' will cause problems in
  92 the headers. Alternatively, #undef new before including template headers.
  93 You will also need to set wxUSE_IOSTREAMH to 0 if you will be
  94 using templates, to avoid the non-template stream files being included
  95 within wxWindows.
  96
  97 Note (2): libraries and applications generated with makefiles and
  98 project files are unlikely to be compatible, so use one method or
  99 the other.
 100
 101 Visual C++ 1.5 compilation
 102 --------------------------
 103
 104 1. Make sure your WXWIN variable is set, and uses the FAT (short
 105    name) form.
 106 2. Change directory to wx\src\msw. Type 'nmake -f makefile.dos' to
 107    make the wxWindows core library.
 108 3. Change directory to a sample, such as wx\samples\minimal, and
 109    type 'nmake -f makefile.dos'.
 110
 111 Add FINAL=1 to your makefile invocation to build the release
 112 versions of the library and samples.
 113
 114 Use the 'clean' target to clean all objects, libraries and
 115 executables.
 116
 117 Borland C++ 4.5/5.0 compilation
 118 -------------------------------
 119
 120 1. Make sure your WXWIN variable is set, and uses the FAT (short
 121    name) form if doing a 16-bit compile.
 122 2. Change directory to wx\src\msw. Type 'make -f makefile.b32' to
 123    make the wxWindows core library. Ignore the warnings about
 124    'XXX' not found in library.
 125 3. Change directory to a sample such as minimal, and type
 126   'make -f makefile.b32'.
 127 4. For release versions, recompile wxWindows and samples using
 128    'make -f makefile.b32 clean'
 129    'make -f makefile.b32 FINAL=1'
 130    for the library and samples.
 131
 132 Note: the wxWindows library and (some) samples compile in 16-bit mode
 133 using makefile.bcc, but at present the wxWindows resource system is switched
 134 off in this mode. See issues.txt for details.
 135
 136 Borland C++Builder compilation
 137 ------------------------------
 138
 139 C++Builder compilation is the same as for Borland C++ above.
 140
 141 Tested with C++Builder 1.0 and 3.0. Only makefiles are currently
 142 supplied.
 143
 144 Watcom C++ 10.6 compilation
 145 ---------------------------
 146
 147 1. Make sure your WXWIN variable is set, and uses the FAT (short
 148    name) form.
 149 2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat' to
 150    make the wxWindows core library.
 151 3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat'
 152    to make this sample.
 153
 154 Metrowerks CodeWarrior compilation
 155 ----------------------------------
 156
 157 1. Downloaded and unzip wx200cw.zip.
 158 2. Load the make_cw.mcp project in wx\src, and compile.
 159 3. Load the make_cw.mcp project in wx\samples\minimal, and compile.
 160    Further project files for samples will be available in due
 161    course.
 162
 163 NOTES:
 164
 165 (a) Unfortunately CodeWarrior support is broken in this
 166 release. Stefan Csomor (csomor@advancedconcepts.ch) will rectify this shortly.
 167 (b) You need CodeWarrior Pro 4 plus the patches to 4.1 from the
 168 Metrowerks Web site.
 169
 170 Symantec C++ compilation
 171 ------------------------
 172
 173 1. Make sure your WXWIN variable is set, and uses the FAT (short
 174    name) form.
 175 2. Edit setup.h and set wxUSE_DRAG_AND_DROP to 0.
 176 3. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
 177    make the wxWindows core library.
 178 4. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
 179    to make this sample.
 180
 181 Note: the minimal sample doesn't link properly ('Error: no
 182 start address').
 183 32-bit compilation only (partially) supported at present, using SC++ 6.1.
 184 Some functionality is missing using this compiler (see makefile).
 185 Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
 186 Step (2). 16-bit compilation is left as an excercise for the user!
 187
 188 Salford C++ compilation
 189 -----------------------
 190
 191 1. Make sure your WXWIN variable is set, and uses the FAT (short
 192    name) form.
 193 2. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
 194    notes.
 195 3. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
 196    make the wxWindows core library.
 197 4. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
 198    to make this sample.
 199
 200 Unfortunately, Salford C++ seems to have problems with its code generation for
 201 operations on objects, as seen in wxFrame::OnMenuHighlight
 202 (minimal sample) or wxWindow::SetValidator (mdi sample). Also the
 203 the debugging version of the library is 90MB, with samples coming in
 204 at 40MB :-) However, wxWindows at least makes a good test suite for
 205 improving the compiler.
 206
 207 Cygwin b19/b20/Mingw32 compilation
 208 ----------------------------------
 209
 210 wxWindows 2.0 supports Cygwin (formerly GnuWin32) b19, b20, Mingw32, and Mingw32/EGCS.
 211
 212 Thanks are due to Keith Garry Boyce (garp@opustel.com) and Cygnus for making
 213 it all possible.
 214
 215 From wxWindows 2.0 beta 9, both Cygwin and Mingw32 (the minimal
 216 distribution of Cygwin) can be used with the same makefiles.
 217
 218 Here are the steps required:
 219
 220 - Retrieve and install the latest beta of Cygwin, or Mingw32, as per the
 221   instructions with either of these packages.
 222
 223 - If using Mingw32 (including the EGCS variant), you need some
 224   extra files to use the wxWindows makefiles. You can find these
 225   files in ports/mingw32 on the ftp site or CD-ROM, as extra.zip.
 226   These should be extracted to the Mingw32 directory.
 227   If you have already have downloaded bison, flex, make, rm, mv
 228   from elsewhere, you won't need this.
 229
 230   IMPORTANT: also see mingw32.txt in this directory (docs/msw)
 231   about a fix that has to be applied to a Mingw32 header file.
 232
 233 - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
 234   to set up appropriate variables, if necessary mounting drives.
 235   Run it before compiling.
 236
 237 - For Cygwin, make sure there's a \tmp directory on your
 238   Windows drive or bison will crash.
 239
 240 - Edit wx/src/makeg95.env and search for MINGW32. Take note of
 241   the comments for adjusting settings to suit Cygwin or
 242   Mingw32. Basically, this is just a case of adding the __MINGW32__ symbol
 243   to OPTIONS for Mingw32, or removing it for Cygnus Cygwin.
 244   For Mingw32/EGCS, add both __MINGW32__ and __EGCS__.
 245   You may need to remove -loldnames from WINLIBS for Mingw32, or add it for
 246   Cygwin.
 247
 248 - Mingw32 may not support winsock.h, so comment out
 249   socket-related files in src/msw/makefile.g95.
 250
 251 - Set your WXWIN variable to where wxWindows is installed.
 252   For Cygwin/Mingw32, use forward slashes in the path, not backslashes.
 253
 254 - Use the makefile.g95 files for compiling wxWindows and samples,
 255   e.g.:
 256   > cd c:\wx\src\msw
 257   > make -f makefile.g95
 258   > cd c:\wx\samples\minimal
 259   > make -f makefile.g95
 260
 261 - Use the 'strip' command to reduce executable size.
 262
 263 - With Cygnus Cygwin, you can invoke gdb --nw myfile.exe to
 264   debug an executable. If there are memory leaks, they will be
 265   flagged when the program quits.
 266
 267 - If using GnuWin32 b18, you will need to copy windres.exe
 268   from e.g. the Mingw32 distribution, to a directory in your path.
 269
 270 All targets have 'clean' targets to allow removal of object files
 271 and other intermediate compiler files.
 272
 273 Gotchas:
 274
 275 - libwx.a is 48 MB or more - but much less if compiled with no
 276   debug info (-g0) and level 4 optimization (-O4).
 277 - install.exe doesn't have built-in decompression because lzexpand.lib
 278   isn't available with Cygwin. However, you can use it with external
 279   decompression utilities.
 280 - Doesn't compile src/msw/ole files, so no drag and drop.
 281
 282 References:
 283
 284  - The GNU-WIN32 site is at
 285      http://www.cygnus.com/gnu-win32/
 286  - Mingw32 is available at:
 287      http://agnes.dida.physik.uni-essen.de/~janjaap/mingw32/index.html
 288  - See also http://web.ukonline.co.uk/julian.smart/wxwin/gnuwin32.htm
 289
 290 TWIN32 and gcc on Linux
 291 -----------------------
 292
 293 The wxWindows 2 for Windows port may be compiled using
 294 the TWIN32 emulator package from www.willows.com. However,
 295 TWIN32 is by no means finished so this should be taken as
 296 something to think about for the future, rather than
 297 a tool for writing products with.
 298
 299 Use makefile.twn in much the same way as makefile.g95, as
 300 described above. Not all sample makefiles are supplied yet.
 301
 302 For some reason, I found I had to copy TWIN32's Windows resource
 303 compiler (rc) to the current working directory for it to be found.
 304
 305 General Notes
 306 -------------
 307
 308 - Debugging: under Windows 95, debugging output isn't output in
 309   the same way that it is under NT or Windows 3.1. Set
 310   wxUSE_DBWIN32 to 1 if you wish to enable code to output debugging
 311   info to an external debug monitor, such as Andrew Tucker's DBWIN32.
 312   You can download DBWIN32 from:
 313
 314         http://ftp.digital.com/pub/micro/NT/WinSite/programr/dbwin32.zip
 315
 316   and it's also on the wxWindows CD-ROM under Packages.
 317
 318 - If you are installing wxWindows 2 from CVS, you may find that
 319   include/wx/msw/setup.h is missing. This is deliberate, to avoid
 320   developers' different setup.h configurations getting confused.
 321   Please copy setup0.h to setup.h before compiling.