Small correction: add WINDOWSLDLIBS when linking an executable.

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

diff --git a/docs/msw/install.txt b/docs/msw/install.txt
index 264b2c6e51ca28a7b82b07bad615f657193a40fa..2ed5cf925279bb60e379e0b34e7574133ba7f482 100644 (file)
--- a/docs/msw/install.txt
+++ b/docs/msw/install.txt
@@ -1,8 +1,8 @@
 
 

-Installing wxWindows 2.3.3
+Installing wxWindows 2.5.0

 --------------------------
 
 --------------------------
 

-This is wxWindows 2.3.3 for Microsoft Windows 9x/ME, Windows NT,
+This is wxWindows 2.5.0 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++
 Windows 2000 and Windows XP. This is an unstable development release.
 
 Please note that the library naming conventions for VC++


@@ -25,11 +25,15 @@ Please report bugs using the SourceForge bug tracker:
 Unarchiving
 -----------
 
 Unarchiving
 -----------
 

-A setup program is provided (setup.exe) to automatically copy files to a
-directory on your hard disk. Do not install into a path that contains spaces.
-The installation program should set the WXWIN environment variable, which
-will be activated when your machine is rebooted. The setup
-program contains the following:
+A setup program is provided (setup.exe) to automatically copy
+files to a directory on your hard disk. Do not install into a
+path that contains spaces. To avoid confusion with other
+wxWindows installations that might be on your machine, the
+installation program does not se the WXWIN environment variable;
+please set this by hand via the System applet if you wish to
+make it permanent.
+
+The setup program contains the following:

 
 - All common, generic and MSW-specific wxWindows source;
 - samples;
 
 - All common, generic and MSW-specific wxWindows source;
 - samples;


@@ -58,9 +62,9 @@ Other add-on packages are available from the wxWindows Web site, such as:
 General installation notes
 --------------------------
 
 General installation notes
 --------------------------
 

-Alter your WXWIN environment variable to point to this directory.
-For Cygwin or Mingw32 compilation, make sure WXWIN contains only
-forward slashes.
+Alter your WXWIN environment variable to point to the root directory of the
+wxWindows installation. 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
 include/wx/msw/setup.h and edit the resulting file to choose
 
 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


@@ -72,14 +76,23 @@ 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++ 6.0 compilation
+Visual C++ compilation

 ---------------------------
 
 ---------------------------
 

-Using project files (VC++ 6 only):
+Please note that the VC++ 6.0 project files will work for VC++ .NET also, but
+you must open the .dsp files and not the .dsw files and in this case you will
+need to manually build the other .dsp on which.wxWindows.dsp depends: jpeg,
+png, regex, tiff and zlib.
+
+Also note that you might make the project files work with VC++ 5 but you'll
+need to edit them version in the .dsp file by hand before this is possible.
+
+
+Using project files (VC++ 6 and later):

 
 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).
 
 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).

-2. Open src/wxWindows.dsp, which has configurations for static
+2. Open src/wxWindows.dsw, 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
    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


@@ -225,12 +238,13 @@ executables.
 Borland C++ 4.5/5.0/5.5 compilation
 -------------------------------
 
 Borland C++ 4.5/5.0/5.5 compilation
 -------------------------------
 

-Compiling using the makefiles (updated 24 Seot 02):
+Compiling using the makefiles (updated 24 Sept 02):

 
 1. Make sure your WXWIN variable is set [e.g add
    set WXWIN=c:\wxwindows
 
 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.
+   to your autoexec.bat file], The WXWIN variable should contain neither spaces nor -
+   You may like to use the short form as shown by a dos directory listing ; 
+   eg instead of c:\wxwindows-2.5.0 use c:\wxwind~1.4

    Reboot if needed for the changes to autoexec.bat to take effect.   
 2. Change directory to src\msw. Type 'make -f makefile.b32' to
    make the wxWindows core library. Ignore the compiler warnings.
    Reboot if needed for the changes to autoexec.bat to take effect.   
 2. Change directory to src\msw. Type 'make -f makefile.b32' to
    make the wxWindows core library. Ignore the compiler warnings.


@@ -261,7 +275,20 @@ Compiling using the makefiles (updated 24 Seot 02):
    and then for each sample,
    'make -f makefile.b32 WXUSINGDLL=1 FINAL=1'
 
    and then for each sample,
    'make -f makefile.b32 WXUSINGDLL=1 FINAL=1'
 

-6. To make console mode applications with wxWindows functions go
+6. You can use the WXUNIVERSAL widgets instead of the native MSW
+   ones (eg if you want to build an application with the same
+   look and feel on all platforms)
+   Use the command
+   'make -f makefile.b32 WXUSINGUNIV=1'
+   Then run
+   'make -f makefile.b32 WXUSINGUNIV=1' in the sample directory  which you wish
+   to build using the wxUniversal widgets. Use 'SET WXTHEME=GTK' [or  WIN32 or METAL]
+   to test the existing themes
+   The makefile is written with the intention that you can build DLLs
+   and  do final releases by combinations of commandline parameters.
+   At the time of writing, (Oct 02) not all the wxDialogs are working
+
+7. To make console mode applications with wxWindows functions go

    to the src\msw directory
    'make -f makebase.b32 clean'
    'make -f makebase.b32'
    to the src\msw directory
    'make -f makebase.b32 clean'
    'make -f makebase.b32'


@@ -390,7 +417,7 @@ Metrowerks CodeWarrior compilation
 ----------------------------------
 
 1. CodeWarrior Pro7 project files in XML format are already 
 ----------------------------------
 
 1. CodeWarrior Pro7 project files in XML format are already 

-   included in wxMSW-2.3.3.zip and the setup version.
+   included in wxMSW-2.5.0.zip and the setup version.

 2. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if 
    you are working from the CVS version) to make sure the settings reflect 
    what you want.  If you aren't sure, leave it alone and go with the 
 2. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if 
    you are working from the CVS version) to make sure the settings reflect 
    what you want.  If you aren't sure, leave it alone and go with the 


@@ -441,52 +468,17 @@ Metrowerks CodeWarrior compilation
          minimal.rc and minimal.cpp and adding the files griddemo.rc and 
          griddemo.cpp.  Build and run....
 
          minimal.rc and minimal.cpp and adding the files griddemo.rc and 
          griddemo.cpp.  Build and run....
 

-
-Symantec C++ compilation
-------------------------
-
-1. Make sure your WXWIN variable is set, and uses the FAT (short
-   name) form.
-2. Edit setup.h and set wxUSE_DRAG_AND_DROP to 0.
-3. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
-   make the wxWindows core library.
-4. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
-   to make this sample.
-
-Note: the minimal sample doesn't link properly ('Error: no
-start address').
-32-bit compilation only (partially) supported at present, using SC++ 6.1.
-Some functionality is missing using this compiler (see makefile).
-Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
-Step (2). 16-bit compilation is left as an exercise for the user!
-
-Salford C++ compilation
------------------------
-
-1. Make sure your WXWIN variable is set, and uses the FAT (short
-   name) form.
-2. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
-   notes.
-3. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
-   make the wxWindows core library.
-4. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
-   to make this sample.
-
-Unfortunately, Salford C++ seems to have problems with its code generation for
-operations on objects, as seen in wxFrame::OnMenuHighlight
-(minimal sample) or wxWindow::SetValidator (mdi sample). Also the
-the debugging version of the library is 90MB, with samples coming in
-at 40MB :-) However, wxWindows at least makes a good test suite for
-improving the compiler.
-

 Cygwin/Mingw32 compilation
 ----------------------------------
 
 wxWindows 2 supports Cygwin (formerly GnuWin32) betas and
 Cygwin/Mingw32 compilation
 ----------------------------------
 
 wxWindows 2 supports Cygwin (formerly GnuWin32) betas and

-releases, and Mingw32.
+releases, and Mingw32. Cygwin can be downloaded from:
+
+    http://sources.redhat.com/cygwin

 
 

-Thanks are due to Keith Garry Boyce (garp@opustel.com), Cygnus
-and others for making it all possible.
+and Mingw32 from:
+
+    http://www.mingw.org

 
 Both Cygwin and MinGW can be used with the same makefiles.
 
 
 Both Cygwin and MinGW can be used with the same makefiles.
 


@@ -494,24 +486,42 @@ NOTE: some notes specific to old Cygwin ( < 1.1.x )
       and MinGW ( < 1.0 ) are at the end of this section
       ( see OLD VERSIONS )
 
       and MinGW ( < 1.0 ) are at the end of this section
       ( see OLD VERSIONS )
 

-

 There are two methods of compiling wxWindows, by using the
 makefiles provided or by using 'configure'.
 
 There are two methods of compiling wxWindows, by using the
 makefiles provided or by using 'configure'.
 

-Retrieve and install the latest version of Cygwin, or Mingw32, as per the
-instructions with either of these packages.
+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
-wxWindows ftp site or CD-ROM, as extra.zip. 
+If using Mingw32, you can download the add-on MSYS package to
+provide Unix-like tools that you'll need to build wxWindows.

 
 

-  ftp://biolp22.york.ac.uk/pub/ports/mingw32/extra.zip
+The solution prior to MSYS was to download extra utilities from
+ports/mingw32 on the wxWindows ftp site or CD-ROM:
+
+  ftp://biolpc22.york.ac.uk/pub/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.
+These should be extracted to a directory in your path. If you have 
+already downloaded rm, cp, mv from elsewhere, or are using
+MSYS, you won't need all of these files. However if using MSYS
+and configure to build wxWindows, you will need to unzip the
+following files from extra.zip and place them in e.g. an
+extrabin directory which you then add to your path:

 
 

-Using makefiles
-===============
+  bison.exe bison.hairy bison.simple flex.exe
+
+You will also need to set these variables:
+
+  set BISON_SIMPLE=c:\apps\mingw2.0.0-3\extrabin\bison.simple
+  set BISON_HAIRY=c:\apps\mingw2.0.0-3\extrabin\bison.hairy
+
+Here we're setting them in DOS before invoking 'sh', but you
+could set them within the shell instead.
+
+The 'configure' method uses flex and bison, whereas the
+direct makefile method uses pregenerated C files.
+
+Using makefiles directly
+========================

 
 NOTE: The makefile are for compilation under Cygwin, MSYS, or
       command.com/cmd.exe, they won't work in other environments
 
 NOTE: The makefile are for compilation under Cygwin, MSYS, or
       command.com/cmd.exe, they won't work in other environments


@@ -523,9 +533,11 @@ Here are the steps required using the provided makefiles:
   *** IMPORTANT: For Cygwin/Mingw32, use forward slashes in the path, not
   backslashes.
 
   *** IMPORTANT: For Cygwin/Mingw32, use forward slashes in the path, not
   backslashes.
 

-- Check src/makeg95.env to see that MINGW32VERSION is set to correctly
-  reflect the version of gcc that you have. Edit it as needed.
-  
+- Edit src/makeg95.env and set the MINGW32 variable at the top of
+  the file to either 1 (you have Mingw32) or 0 (if you have
+  Cygwin). If using Mingw32, also set the MINGW32VERSION variable
+  appropriately.
+

 - Use the makefile.g95 files for compiling wxWindows and samples,
   e.g. to compile a debugging version of wxWindows:
   > cd c:\wx\src\msw
 - Use the makefile.g95 files for compiling wxWindows and samples,
   e.g. to compile a debugging version of wxWindows:
   > cd c:\wx\src\msw


@@ -582,7 +594,8 @@ system to generate appropriate makefiles, as used on Unix
 and Mac OS X systems.
 
 Change directory to the root of the wxWindows distribution,
 and Mac OS X systems.
 
 Change directory to the root of the wxWindows distribution,

-make a build directory, and then run configure and make.
+make a build directory, run 'sh', and then from this shell
+run configure and make.

 
 For example:
 
 
 For example:
 


@@ -595,7 +608,6 @@ For example:
   make
   ./minimal.exe
 
   make
   ./minimal.exe
 

-

 Notes:
 
 1. See also the Cygwin/Mingw32 on the web site or CD-ROM for
 Notes:
 
 1. See also the Cygwin/Mingw32 on the web site or CD-ROM for


@@ -661,20 +673,45 @@ OLD VERSIONS:
   bison for ordinary wxWindows compilation: a pre-generated .c file is
   supplied).
 
   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.
 
 - If using GnuWin32 b18, you will need to copy windres.exe
   from e.g. the Mingw32 distribution, to a directory in your path.
 

-References:
+Symantec C++ compilation
+------------------------
+
+1. Make sure your WXWIN variable is set, and uses the FAT (short
+   name) form.
+2. Edit setup.h and set wxUSE_DRAG_AND_DROP to 0.
+3. Change directory to wx\src\msw. Type 'make -f makefile.sc' to
+   make the wxWindows core library.
+4. Change directory to wx\samples\minimal and type 'make -f makefile.sc'
+   to make this sample.
+
+Note: the minimal sample doesn't link properly ('Error: no
+start address').
+32-bit compilation only (partially) supported at present, using SC++ 6.1.
+Some functionality is missing using this compiler (see makefile).
+Add -D__WIN95__ if your SC++ has Windows 95 support, and ignore
+Step (2). 16-bit compilation is left as an exercise for the user!
+
+Salford C++ compilation
+-----------------------

 
 

- - The Cygwin site is at
-     http://sources.redhat.com/cygwin
- - Mingw32 is available at:
-     ftp://www.mingw.org
+1. Make sure your WXWIN variable is set, and uses the FAT (short
+   name) form.
+2. Edit SALFORDDIR and RESOURCEDIR in src/makesl.env as per
+   notes.
+3. Change directory to wx\src\msw. Type 'mk32 -f makefile.sl all' to
+   make the wxWindows core library.
+4. Change directory to wx\samples\minimal and type 'mk32 -f makefile.sl'
+   to make this sample.
+
+Unfortunately, Salford C++ seems to have problems with its code generation for
+operations on objects, as seen in wxFrame::OnMenuHighlight
+(minimal sample) or wxWindow::SetValidator (mdi sample). Also the
+the debugging version of the library is 90MB, with samples coming in
+at 40MB :-) However, wxWindows at least makes a good test suite for
+improving the compiler.

 
 TWIN32 and gcc on Linux
 -----------------------
 
 TWIN32 and gcc on Linux
 -----------------------