docs/msw/install.txt

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