Changes for wxOGL since wxFatalError has been deprecated.

[wxWidgets.git] / docs / msw / install.txt

diff --git a/docs/msw/install.txt b/docs/msw/install.txt
index 336531f75b3394cc419a3ee0d61c0a55169d3189..7533beb565afd0fd95e321451c2f8e3efbacfee7 100644 (file)
--- a/docs/msw/install.txt
+++ b/docs/msw/install.txt
@@ -2,8 +2,13 @@
 Installing wxWindows 2.3
 ------------------------
 
 Installing wxWindows 2.3
 ------------------------
 

-This is wxWindows 2.3 for Microsoft Windows 3.1, 95, 98 and
-Windows NT/Windows 2000. This is an unstable development release.
+This is wxWindows 2.3 for Microsoft Windows 9x/ME, Windows NT,
+Windows 2000 and Windows XP. This is an unstable development release.
+
+Please note that the library naming conventions for VC++
+compilation have changed between 2.3.1 and 2.3.2. This means that
+you will need to change your application project files. See the
+relevant section below for details.

 
 IMPORTANT NOTE: If you experience problems installing, please
 re-read this instructions and other related files (changes.txt,
 
 IMPORTANT NOTE: If you experience problems installing, please
 re-read this instructions and other related files (changes.txt,


@@ -53,8 +58,8 @@ For Cygwin or Mingw32 compilation, make sure WXWIN contains only
 forward slashes.
 
 If installing from the CVS server, copy include/wx/msw/setup0.h to
 forward slashes.
 
 If installing from the CVS server, copy include/wx/msw/setup0.h to

-include/wx/msw/setup.h and edit the resulting file to choose the featrues you
-would like to compile wxWindows with[out].
+include/wx/msw/setup.h and edit the resulting file to choose
+the features you would like to compile wxWindows with[out].

 
 Compilation
 -----------
 
 Compilation
 -----------


@@ -62,27 +67,35 @@ Compilation
 The following sections explain how to compile wxWindows with each supported
 compiler.
 
 The following sections explain how to compile wxWindows with each supported
 compiler.
 

-Visual C++ 4.0/5.0/6.0 compilation
-----------------------------------
+Visual C++ 6.0 compilation
+---------------------------

 
 

-Using project files (VC++ 5 and 6 only):
+Using project files (VC++ 6 only):

 
 

-1. Unarchive wxWindows-x.y.z-vc.zip, the VC++ 5/6 project
+1. Unarchive wxWindows-x.y.z-vc.zip, the VC++ 6 project

    makefiles (already included in wxMSW-x.y.z.zip and the setup version).
    makefiles (already included in wxMSW-x.y.z.zip and the setup version).

-2. Open src/wxvc.dsp, set Debug or Release configuration for
-   the wxvc project, and compile. Alternatively, use Batch Build
-   to build both Debug and Release configurations.
-   This will produce lib/wx.lib (release) and lib/wxd.lib (debug),
-   plus various subordinate libraries. It assumes you have
-   the TIFF and JPEG source, which is already in the setup
-   version of the distribution.
-   The project file src/wxvc_dll.dsp will make a DLL version of wxWindow,
-   which will go in lib/wxdll.[lib,dll] and lib/wxdlld.[lib,dll].
+2. Open src/wxWindows.dsp, which has configurations for static
+   compilation or DLL compilation, and each of these available in
+   Unicode/ANSI and Debug/Release variations. Normally you'll use
+   a static linking ANSI configuration. Choose the Win32 Debug or
+   Win32 Release configuration for the wxWindows project, and compile.
+   Alternatively, use Batch Build to build more than one
+   configuration.
+   The following libraries will be produced depending on chosen
+   configuration:
+
+   wxmsw.lib     wxmswd.lib      ; ANSI Release/Debug
+   wxmswu.lib    wxmswud.lib     ; UNICODE Release/Debug
+   wxmsw23x.lib  wxmsw23xd.lib   ; ANSI DLL Release/Debug
+   wxmsw23xu.lib wxmsw23xud.lib  ; UNICODE DLL Release/Debug
+
+   It will also produce similar variations on jpeg.lib, png.lib,
+   tiff.lib, zlib.lib, and regex.lib.

 3. Open a sample project file, choose a configuration such as
 3. Open a sample project file, choose a configuration such as

-   Debug using Build | Set Active Configuration..., and compile.
+   Win32 Debug using Build | Set Active Configuration..., and compile.

    The project files don't use precompiled headers, to save disk
    space, but you can switch PCH compiling on for greater speed.
    The project files don't use precompiled headers, to save disk
    space, but you can switch PCH compiling on for greater speed.

-   NOTE: you may also use samples/SamplesVC.dsw to access all
+   NOTE: you may also use samples/samples.dsw to access all

    sample projects without opening each workspace individually.
    You can use the Batch Build facility to make several samples
    at a time.
    sample projects without opening each workspace individually.
    You can use the Batch Build facility to make several samples
    at a time.


@@ -104,8 +117,7 @@ Using makefiles:
   'nmake -f makefile.vc cleanall FINAL=1'
   'nmake -f makefile.vc FINAL=1'
 
   'nmake -f makefile.vc cleanall FINAL=1'
   'nmake -f makefile.vc FINAL=1'
 

-   to make the wxWindows core library without debug information
-   (wx\lib\wx.lib).
+   to make the wxWindows core library without debug information.

 4. Change directory to wx\samples and type 'nmake -f makefile.vc'
    to make all the samples. You can also make them individually.
 
 4. Change directory to wx\samples and type 'nmake -f makefile.vc'
    to make all the samples. You can also make them individually.
 


@@ -123,6 +135,9 @@ Makefile notes:
   this manifested in unexpected link errors or warnings. This problem
   doesn't occur when using project files to build wxWindows.
 
   this manifested in unexpected link errors or warnings. This problem
   doesn't occur when using project files to build wxWindows.
 

+  To build Unicode versions of the libraries, add UNICODE=1
+  to the nmake invocation ( default is UNICODE=0 ).
+

   Note that the wxWindows core library allows you to have debug
   and release libraries available simultaneously, by compiling the
   objects in different subdirectories, whereas samples must be
   Note that the wxWindows core library allows you to have debug
   and release libraries available simultaneously, by compiling the
   objects in different subdirectories, whereas samples must be


@@ -133,11 +148,7 @@ To build the DLL version using makefiles:
 1. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll pch'
    to make both a suitable DLL and import library, and to build a
    suitable precompiled header file for compiling applications.
 1. Change directory to wx\src\msw. Type 'nmake -f makefile.vc dll pch'
    to make both a suitable DLL and import library, and to build a
    suitable precompiled header file for compiling applications.

-   The resulting libraries are called:
-
-      wx\lib\wx[version].lib(dll) (debug version)
-      wx\lib\wx[version].lib(dll) (release version, using FINAL=1)
-
+   See the previous section for library names.

 2. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'
    (or edit src\makeprog.vc to set WXUSINGDLL to 1 for all
    applications).
 2. Invoke a sample makefile with 'nmake -f makefile.vc WXUSINGDLL=1'
    (or edit src\makeprog.vc to set WXUSINGDLL to 1 for all
    applications).


@@ -165,18 +176,6 @@ optimized. For example, in wxWindows project, set to 'Minimum
 Size'. In Dialog Editor project, set to 'Customize: Favor Small
 Code' (and no others). This will then work.
 
 Size'. In Dialog Editor project, set to 'Customize: Favor Small
 Code' (and no others). This will then work.
 

-Similarly, in VC++ 4, optimization can cause internal compiler
-errors, so edit src\makevc.env and change /O1 to /Od before
-trying build a release version of the library. Or, type:
-
-nmake -f makefile.vc noopt FINAL=1
-
-and then resume compilation in the normal way. This will build
-troublesome files with no optimization. However, there now seems to be
-an internal linker error using VC++ 4, in addition to internal
-compiler errors for most of the samples, so this version of the compiler
-cannot be recommended!
-

 Note (4): some crash problems can be due to inconsistent compiler
 options. If strange/weird/impossible things start to happen please
 check (dumping IDE project file as makefile and doing text comparison
 Note (4): some crash problems can be due to inconsistent compiler
 options. If strange/weird/impossible things start to happen please
 check (dumping IDE project file as makefile and doing text comparison


@@ -184,12 +183,7 @@ if necessary) that the project settings, especially the list of defined
 symbols, struct packing, etc. are exactly the same for all items in
 the project. After this, delete everything (including PCH) and recompile.
 
 symbols, struct packing, etc. are exactly the same for all items in
 the project. After this, delete everything (including PCH) and recompile.
 

-Note (5): for some further notes about upgrading your project
-files to be compatible with wxWindows 2.1.14, please see
-"Highlights of wxWindows" from the Download page of the
-web site or CD-ROM.
-
-Note (6): to create your own IDE files, see the technical note on the
+Note (5): to create your own IDE files, see the technical note on the

 wxWindows web site or CD-ROM, entitled "Compiling wxWindows
 applications in the VC++ IDE" (technical note docs/tech/tn0010.htm in the
 wxWindows distribution). You can also copy .dsp and .dsw
 wxWindows web site or CD-ROM, entitled "Compiling wxWindows
 applications in the VC++ IDE" (technical note docs/tech/tn0010.htm in the
 wxWindows distribution). You can also copy .dsp and .dsw


@@ -198,6 +192,9 @@ files from an existing wxWindows sample and adapt them.
 Visual C++ 1.5 compilation (16-bit)
 -----------------------------------
 
 Visual C++ 1.5 compilation (16-bit)
 -----------------------------------
 

+NOTE: this has not been tested recently and probably doesn't
+work.
+

 1. Make sure your WXWIN variable is set, and uses the FAT (short
    name) form.
 2. Change directory to wx\src\msw. Type 'nmake -f makefile.dos' to
 1. Make sure your WXWIN variable is set, and uses the FAT (short
    name) form.
 2. Change directory to wx\src\msw. Type 'nmake -f makefile.dos' to


@@ -211,13 +208,23 @@ versions of the library and samples.
 Use the 'clean' target to clean all objects, libraries and
 executables.
 
 Use the 'clean' target to clean all objects, libraries and
 executables.
 

-Borland C++ 4.5/5.0 compilation
+Borland C++ 4.5/5.0/5.5 compilation

 -------------------------------
 
 Compiling using the makefiles:
 
 -------------------------------
 
 Compiling using the makefiles:
 

-1. Make sure your WXWIN variable is set, and uses the FAT (short
-   name) form if doing a 16-bit compile.
+0. If downloading from CVS, copy include\wx\msw\setup0.h to
+   include\wx\setup.h.
+1. Make sure your WXWIN variable is set [e.g add
+   set WXWIN=c:\wxwindows
+   to your autoexec.bat file], and that it uses the FAT (short
+   name) form with no spaces.
+   Make sure your BCCDIR variable is set [e.g add
+   set BCCDIR=c:\progra~1\borland\bcc
+   to your autoexec.bat file], and that it points to the root directory of 
+   your Borland C++ installation, and it uses the FAT (short
+   name) form with no spaces.
+   Reboot if needed for the changes to autoexec.bat to take effect.   

 2. Change directory to wx\src\msw. Type 'make -f makefile.b32' to
    make the wxWindows core library. Ignore the warnings about
    'XXX' not found in library.
 2. Change directory to wx\src\msw. Type 'make -f makefile.b32' to
    make the wxWindows core library. Ignore the warnings about
    'XXX' not found in library.


@@ -259,16 +266,13 @@ you will therefore need to set wxUSE_LIBJPEG to 0 in setup.h and remove
 the jpeg target from src\msw\makefile.b32, and remove jpeg from
 src\makeprog.b32.
 
 the jpeg target from src\msw\makefile.b32, and remove jpeg from
 src\makeprog.b32.
 

-Note (6): If using C++Builder 4 and above (BC++ 5.4 and above), change LINK=tlink32 to
-LINK=ilink32 in src\makeb32.env. You may also need to disable
-wxUSE_LIBJPEG because there is a conflict in the BC++ headers
-(actually this problem seems to have gone away with 5.5 and SP1).
+Note (6): [obsolete]

 
 Note (7): If you wish debug messages to be sent to the console in
 debug mode, edit src\makeb32.env and change /aa to /Tpe in
 LINK_FLAGS.
 
 
 Note (7): If you wish debug messages to be sent to the console in
 debug mode, edit src\makeb32.env and change /aa to /Tpe in
 LINK_FLAGS.
 

-Compiling using the IDE files:
+Compiling using the IDE files: [Borland C++ 5.0, not Cbuilder]

 
 1. Load src\bc32.ide (Release settings)
 2. Go to Options|Project... and specify the correct BC++ include and lib path for
 
 1. Load src\bc32.ide (Release settings)
 2. Go to Options|Project... and specify the correct BC++ include and lib path for


@@ -297,78 +301,6 @@ release version is around 5 MB.
 See also the file docs/tech/tn0007.txt for further instructions and details
 of how to create your own project files.
 
 See also the file docs/tech/tn0007.txt for further instructions and details
 of how to create your own project files.
 

-Borland C++ 5.5 compilation
----------------------------
-
-Before compiling wxWindows with Borland C++ 5.5, there are a few 
-issues concerning the compiler installation: 
-
-1. The compiler must be installed to a path that does not contain 
-   spaces, such as c:\Borland\Bcc55 (in particular, do not install 
-   it below "C:\Program Files").
-
-2. Make sure that you downloaded and installed the service pack 1 
-   for Borland C++ 5.5.  This SP1 can be downloaded from:
-   http://www.borland.com/devsupport/bcppbuilder/file_supplements.html
-
-   IMPORTANT:
-   When installing SP1, make sure that you extract (UnZip) the files 
-   to the directory where you installed Borland C++ 5.5 (e.g., 
-   c:\Borland\Bcc55) with the option "use folder names" selected. 
-   This is necessary, to ensure that the files (mostly include files) 
-   are extracted to the right directory.
-
-3. Create the following two files in the same directory where you 
-   installed Borland C++ 5.5 (e.g., c:\Borland\Bcc55):
-
-   a. bcc32.cfg
-      text file containing the following two lines:
-      -I"c:\Borland\Bcc55\include"
-      -L"c:\Borland\Bcc55\lib"
-
-   b. ilink32.cfg
-      text file containing the following line:
-      -L"c:\Borland\Bcc55\lib"
-
-   (replace c:\Borland\Bcc55 with the actual path where you installed 
-   Borland C++ 5.5)
-
-4. Add the borland BIN directory to your path (e.g., c:\Borland\Bcc55\bin), 
-   and define the environment variable BCCDIR=<Borland C++ 5.5 path>
-   (e.g., set BCCDIR=c:\Borland\Bcc55)
-
-Compiling wxWindows:
-
-Once the compiler and its service pack are properly installed, you build 
-wxWindows using the provided makefile.b32 in the src/msw directory:
-
-a. To build wxWindows in DEBUG mode:
-
-    cd c:\wx2\src\msw
-    make -f makefile.b32
-
-    (replace c:\wx2 with the actual path where you installed wxWindows)
-
-b. To build wxWindows in RELEASE mode:
-
-    cd c:\wx2\src\msw
-    make -f makefile.b32 FINAL=1   
-
-    (if you had previously built wxWindows, you need to clean all of
-    the object and intermediate files.  Before the above make command, 
-    run: 'make -f makefile.b32 CLEANALL')
-
-IMPORTANT:
-The Service Pack 1 for Borland C++ 5.5 must be installed before wxWindows 
-is compiled.  If you compiled wxWindows before, it is advised that you 
-re-compile it following the next steps:
-
-    cd c:\wx2\src\msw
-    make -f makefile.b32 CLEANALL
-    make -f makefile.b32   (or make -f makefile.b32 FINAL=1)
-
-    (replace c:\wx2 with the actual path where you installed wxWindows)
-

 ** REMEMBER **
 
 In all of your wxWindows applications, your source code should include 
 ** REMEMBER **
 
 In all of your wxWindows applications, your source code should include 


@@ -381,7 +313,7 @@ the following preprocessor directive:
 (check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for 
 more details) 
 
 (check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for 
 more details) 
 

-Borland C++Builder compilation
+Borland C++Builder IDE compilation

 ------------------------------
 
 1. Build the wxWindows libraries using the Borland make utility as
 ------------------------------
 
 1. Build the wxWindows libraries using the Borland make utility as


@@ -392,15 +324,19 @@ Borland C++Builder compilation
 2. You can build samples using the makefiles as per the
    instructions for BC++ above, or you can follow the instructions
    in docs/tech/tn0004.htm or http://biolpc22.york.ac.uk/wx/bc/ide.html.
 2. You can build samples using the makefiles as per the
    instructions for BC++ above, or you can follow the instructions
    in docs/tech/tn0004.htm or http://biolpc22.york.ac.uk/wx/bc/ide.html.

+   You can use the process_sample_bcb.bat command which is in
+   wxwindows\distrib\msw to generate a .mak or .bpr file for most of the
+   samples [mak for Cbuilder 1-3; bpr for v4]. Execute this in the sample
+   directory, passing the name of the cpp files on the command line.

 
 Watcom C++ 10.6/11 compilation
 ---------------------------
 
 1. Make sure your WXWIN variable is set, and uses the DOS short
    name form.
 
 Watcom C++ 10.6/11 compilation
 ---------------------------
 
 1. Make sure your WXWIN variable is set, and uses the DOS short
    name form.

-2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat' to
+2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat all' to

    make the wxWindows core library.
    make the wxWindows core library.

-3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat'
+3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat all'

    to make this sample. Repeat for other samples of interest.
 
 Note (1): makewat.env uses the odbc32.lib supplied in wxWindows' lib\watcom
    to make this sample. Repeat for other samples of interest.
 
 Note (1): makewat.env uses the odbc32.lib supplied in wxWindows' lib\watcom


@@ -474,63 +410,69 @@ releases, and Mingw32.
 Thanks are due to Keith Garry Boyce (garp@opustel.com), Cygnus
 and others for making it all possible.
 
 Thanks are due to Keith Garry Boyce (garp@opustel.com), Cygnus
 and others for making it all possible.
 

-Both Cygwin and Mingw32 (the minimal distribution of Cygwin) can be used
-with the same makefiles.
+Both Cygwin and MinGW can be used with the same makefiles.
+
+NOTE: some notes specific to old Cygwin ( < 1.1.x )
+      and MinGW ( < 1.0 ) are at the end of this section
+      ( see OLD VERSIONS )

 
 Here are the steps required:
 
 
 Here are the steps required:
 

-- Retrieve and install the latest beta of Cygwin, or Mingw32, as per the
+- Retrieve and install the latest version of Cygwin, or Mingw32, as per the

   instructions with either of these packages.
 
 - If using Mingw32, you need some extra files to use the wxWindows
   makefiles. You can find these files in ports/mingw32 on the
   instructions with either of these packages.
 
 - If using Mingw32, you need some extra files to use the wxWindows
   makefiles. You can find these files in ports/mingw32 on the

-  wxWindows ftp site or CD-ROM, as extra.zip. These should be extracted
-  to the Mingw32 directory. If you have alread downloaded rm, cp, mv
-  from elsewhere, you won't need this.
+  wxWindows ftp site or CD-ROM, as extra.zip. 

 
 

-  If using Mingw32 2.95 and below with wxWindows 2.1 or above, you
-  must hand-patch with Mingw32-gcc295.patches (located in the
-  top-level of the wxWindows 2 installation). Mingw32 2.95.2
-  and above contain the fixes already.
-
-- Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
-  to set up appropriate variables, if necessary mounting drives.
-  Run it before compiling.
-
-- For Cygwin, make sure there's a \tmp directory on your
-  Windows drive or bison will crash (actually you don't need
-  bison for ordinary wxWindows compilation: a pre-generated .c file is
-  supplied).
-
-- Edit wx/src/makeg95.env and set the MINGW32 variable at the top of
-  the file to either 1 (you have Mingw32 or Cygwin 1.x releases) or 0
-  (if you have Cygwin betas). If using Mingw32, also set the
-  MINGW32VERSION variable appropriately.
+  ftp://ftp.remstar.com/pub/wxwin/ports/mingw32/extra.zip
+  
+  These should be extracted to the Mingw32 directory. If you have 
+  already downloaded rm, cp, mv from elsewhere, you won't need this.

 
 - Set your WXWIN variable to where wxWindows is installed.
   *** IMPORTANT: For Cygwin/Mingw32, use forward slashes in the path, not
   backslashes.
 
 - Use the makefile.g95 files for compiling wxWindows and samples,
 
 - Set your WXWIN variable to where wxWindows is installed.
   *** IMPORTANT: For Cygwin/Mingw32, use forward slashes in the path, not
   backslashes.
 
 - Use the makefile.g95 files for compiling wxWindows and samples,

-  e.g.:
+  e.g. to compile a debugging version of wxWindows:

   > cd c:\wx\src\msw
   > make -f makefile.g95
   > cd c:\wx\samples\minimal
   > make -f makefile.g95
 
   > cd c:\wx\src\msw
   > make -f makefile.g95
   > cd c:\wx\samples\minimal
   > make -f makefile.g95
 

+  to compile with optimizations:
+  > cd c:\wx\src\msw
+  > make -f makefile.g95 FINAL=1
+  > cd c:\wx\samples\minimal
+  > make -f makefile.g95 FINAL=1
+
+  to compile a DLL:
+  > cd c:\wx\src\msw
+  > make -f makefile.g95 WXMAKINGDLL=1
+  > cd c:\wx\samples\minimal
+  > make -f makefile.g95 WXUSINGDLL=1
+
+  to compile the Unicode version:
+  > cd c:\wx\src\msw
+  > make -f makefile.g95 UNICODE=1
+  > cd c:\wx\samples\minimal
+  > make -f makefile.g95 UNICODE=1
+
+  Options can be combined ( e.g.: UNICODE=1 FINAL=1 )
+

   Ignore the warning about the default entry point.
 
 - Use the 'strip' command to reduce executable size.
 
 - With Cygwin, you can invoke gdb --nw myfile.exe to
   debug an executable. If there are memory leaks, they will be
   Ignore the warning about the default entry point.
 
 - Use the 'strip' command to reduce executable size.
 
 - With Cygwin, you can invoke gdb --nw myfile.exe to
   debug an executable. If there are memory leaks, they will be

-  flagged when the program quits.
-
-- If using GnuWin32 b18, you will need to copy windres.exe
-  from e.g. the Mingw32 distribution, to a directory in your path.
+  flagged when the program quits. You can use Cygwin gdb
+  to debug MinGW executables.

 
 All targets have 'clean' targets to allow removal of object files
 
 All targets have 'clean' targets to allow removal of object files

-and other intermediate compiler files.
+and other intermediate compiler files and 'cleanall' targets to
+allow removal of all object files and library files.

 
 Notes:
 
 
 Notes:
 


@@ -572,10 +514,34 @@ Notes:
 
    and similarly for glu[32].def.
 
 
    and similarly for glu[32].def.
 

+OLD VERSIONS:
+
+- If using Mingw32 2.95 and below with wxWindows 2.1 or above, you
+  must hand-patch with Mingw32-gcc295.patches (located in the
+  top-level of the wxWindows 2 installation). Mingw32 2.95.2
+  and above contain the fixes already.
+
+- Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
+  to set up appropriate variables, if necessary mounting drives.
+  Run it before compiling.
+
+- For Cygwin, make sure there's a \tmp directory on your
+  Windows drive or bison will crash (actually you don't need
+  bison for ordinary wxWindows compilation: a pre-generated .c file is
+  supplied).
+
+- Edit wx/src/makeg95.env and set the MINGW32 variable at the top of
+  the file to either 1 (you have Mingw32 or Cygwin 1.x releases) or 0
+  (if you have Cygwin betas). If using Mingw32, also set the
+  MINGW32VERSION variable appropriately.
+
+- If using GnuWin32 b18, you will need to copy windres.exe
+  from e.g. the Mingw32 distribution, to a directory in your path.
+

 References:
 
  - The Cygwin site is at
 References:
 
  - The Cygwin site is at

-     http://sourceware.cygnus.com
+     http://sources.redhat.com/cygwin

  - Mingw32 is available at:
      ftp://www.mingw.org
 
  - Mingw32 is available at:
      ftp://www.mingw.org