]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/msw/install.txt
Small correction: add WINDOWSLDLIBS when linking an executable.
[wxWidgets.git] / docs / msw / install.txt
index 235fcbdabd70435721e38c9590f1c0deac1fab84..2ed5cf925279bb60e379e0b34e7574133ba7f482 100644 (file)
@@ -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++
@@ -12,25 +12,34 @@ relevant section below for details.
 
 IMPORTANT NOTE: If you experience problems installing, please
 re-read this instructions and other related files (changes.txt,
-readme.txt, notes on the Web site) carefully before mailing
-wx-users or the author. Preferably, try to fix the problem first and
-then send a patch to the author. Please report bugs using the
-bug report form on the wxWindows web site.
+readme.txt, FAQ) carefully before mailing wx-users. Preferably,
+try to fix the problem first and then upload a patch to
+SourceForge:
+
+  http://sourceforge.net/patch/?group_id=9863
+
+Please report bugs using the SourceForge bug tracker:
+
+  http://sourceforge.net/bugs/?group_id=9863
 
 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;
 - documentation in Windows Help format;
-- makefiles for most Windows compilers, plus BC++ and
-  VC++ IDE files;
+- makefiles for most Windows compilers, plus CodeWarrior,
+  BC++ and VC++ IDE files;
 - JPEG library source;
 - TIFF library source;
 - Object Graphics Library;
@@ -53,9 +62,9 @@ Other add-on packages are available from the wxWindows Web site, such as:
 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
@@ -67,14 +76,23 @@ Compilation
 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).
-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
@@ -131,12 +149,21 @@ Makefile notes:
   You MUST use the 'cleanall' target (with FINAL=1 or FINAL=0)
   before making a different configuration, because otherwise
   object files used to build the previous configuration may be
-  used accidentally for the current configuation. You might see
+  used accidentally for the current configuration. You might see
   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 ).
+  to the nmake invocation ( default is UNICODE=0 ). If you want to
+  be able to use Unicode version on Windows9x, you will need 
+  MSLU (Microsoft Layer for Unicode) runtime DLL and import lib.
+  The former can be downloaded from Microsoft, the latter is part
+  of the latest Platform SDK from Microsoft (see msdn.microsoft.com 
+  for details). An alternative implementation of import library can
+  be downloaded from http://libunicows.sourceforge.net - unlike the
+  official one, this one works with other compilers and does not
+  require 300+ MB Platform SDK update. Add MSLU=1 to the nmake
+  invocation to enable MSLU.
 
   Note that the wxWindows core library allows you to have debug
   and release libraries available simultaneously, by compiling the
@@ -211,31 +238,66 @@ executables.
 Borland C++ 4.5/5.0/5.5 compilation
 -------------------------------
 
-Compiling using the makefiles:
+Compiling using the makefiles (updated 24 Sept 02):
 
-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.
+   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 warnings about
-   'XXX' not found in library.
+   make the wxWindows core library. Ignore the compiler warnings.
+   This produces a library in the wxwindows\lib directory called
+   wx32ds.lib
 3. Change directory to a sample or demo such as samples\minimal, and type
-  'make -f makefile.b32'.
+  'make -f makefile.b32'. This produces a windows exe file
 4. For release versions, recompile wxWindows and samples using
    'make -f makefile.b32 clean'
    'make -f makefile.b32 FINAL=1'
-   for the library and samples.
+   for the library and samples. This produces a library wx32s.lib eliminating
+   all debugging information - if you wish to retain reduced debugging information
+   'make -f makefile.b32 clean'
+   'make -f makefile.b32 FINAL=hybrid'
+
 5. To make and use wxWindows as a DLL, type
    'make -f makefile.b32 clean'
    'make -f makefile.b32 DLL=1'
+   which generates a DLL (wx32d.dll) and import library (wx32d.lib), 
    and then for each sample,
    'make -f makefile.b32 WXUSINGDLL=1'
    Please note that the samples have not been exhaustively tested
-   with this configuration.
+   with this configuration. You may also generate a sepratae library
+   and second DLL using the commands
+   'make -f makefile.b32 clean'
+   'make -f makefile.b32 DLL=1 FINAL=1'
+   which generates a DLL (wx32.dll) and import library (wx32.lib), 
+   and then for each sample,
+   'make -f makefile.b32 WXUSINGDLL=1 FINAL=1'
+
+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'
+   There is a sample\console directory and in this type
+   'make -f makefile.b32 wxUSE_GUI=0'
+
+Note (0): This provides the ability to produce separate wxwindows libraries
+   for different purposes, and only have to rebuild the applications
+
 
 Note (1): In Borland 4.5 and earleir, using bcc.exe you also need to define BCCDIR
 in the autoexec.bat file; like this:
@@ -355,7 +417,7 @@ Metrowerks CodeWarrior compilation
 ----------------------------------
 
 1. CodeWarrior Pro7 project files in XML format are already 
-   included in wxMSW-x.y.z.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 
@@ -377,7 +439,7 @@ Metrowerks CodeWarrior compilation
       (2) Create the directories lib\cw7mswd\include\wx and copy the file 
           include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are 
           working from the CVS version) to lib\cw7mswd\include\wx\setup.h
-5. Import srcwxWindows.xml to create the project file wxWindows.mcp.
+5. Import src\wxWindowsW7.xml to create the project file wxWindowsW7.mcp.
    Store this project file in directory src.  You may get warnings about 
    not being able to find certain project paths; ignore these warnings, the 
    appropriate paths will be created during the build by the Batch File Runner.
@@ -395,56 +457,28 @@ Metrowerks CodeWarrior compilation
    Volunteers for this are welcome (as neither DLLs nor unicode builds are 
    big priorities for me ;).
 9. CodeWarrior Pro7 project files (in XML format) are also provided for some 
-   of the samples.  In particular, for the minimal, controls, dialogs, dnd, 
-   and docview samples.  You can use these project files as templates for 
-   the other samples and for your own projects.
-
-
-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 excercise 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.
+   of the samples.  In particular, there are project files for the minimal, 
+   controls, dialogs, dnd, nd docview samples.  You can use these project 
+   files as templates for the other samples and for your own projects.  
+       - For example, to make a project file for the "newgrid" sample, 
+         just copy the project file for the "minimal" sample, minimalW7.mcp 
+         (made by importing minimalW7.xml into CodeWarrior), into the 
+         sample/newgrid directory, calling it newgridW7.mcp.  Open 
+         newgridW7.mcp and revise the project by deleting the files 
+         minimal.rc and minimal.cpp and adding the files griddemo.rc and 
+         griddemo.cpp.  Build and run....
 
 Cygwin/Mingw32 compilation
 ----------------------------------
 
 wxWindows 2 supports Cygwin (formerly GnuWin32) betas and
-releases, and Mingw32.
+releases, and Mingw32. Cygwin can be downloaded from:
 
-Thanks are due to Keith Garry Boyce (garp@opustel.com), Cygnus
-and others for making it all possible.
+    http://sources.redhat.com/cygwin
+
+and Mingw32 from:
+
+    http://www.mingw.org
 
 Both Cygwin and MinGW can be used with the same makefiles.
 
@@ -452,47 +486,89 @@ 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:
+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 can download the add-on MSYS package to
+provide Unix-like tools that you'll need to build wxWindows.
 
-- 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. 
+The solution prior to MSYS was to download extra utilities from
+ports/mingw32 on the wxWindows ftp site or CD-ROM:
 
-  ftp://ftp.remstar.com/pub/wxwin/ports/mingw32/extra.zip
+  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:
+
+  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
+      (such as UNIX)
+
+Here are the steps required using the provided makefiles:
 
 - Set your WXWIN variable to where wxWindows is installed.
   *** IMPORTANT: For Cygwin/Mingw32, use forward slashes in the path, not
   backslashes.
 
+- 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
+  > make -f makefile.g95 clean
   > make -f makefile.g95
   > cd c:\wx\samples\minimal
+  > make -f makefile.g95 cleanall
   > make -f makefile.g95
 
   to compile with optimizations:
   > cd c:\wx\src\msw
+  > make -f makefile.g95 clean
   > make -f makefile.g95 FINAL=1
   > cd c:\wx\samples\minimal
+  > make -f makefile.g95 cleanall
   > make -f makefile.g95 FINAL=1
 
   to compile a DLL:
   > cd c:\wx\src\msw
+  > make -f makefile.g95 clean
   > make -f makefile.g95 WXMAKINGDLL=1
   > cd c:\wx\samples\minimal
+  > make -f makefile.g95 cleanall
   > make -f makefile.g95 WXUSINGDLL=1
 
   to compile the Unicode version:
   > cd c:\wx\src\msw
+  > make -f makefile.g95 clean
   > make -f makefile.g95 UNICODE=1
   > cd c:\wx\samples\minimal
+  > make -f makefile.g95 cleanall
   > make -f makefile.g95 UNICODE=1
 
   Options can be combined ( e.g.: UNICODE=1 FINAL=1 )
@@ -510,15 +586,46 @@ All targets have 'clean' targets to allow removal of object files
 and other intermediate compiler files and 'cleanall' targets to
 allow removal of all object files and library files.
 
+Using configure
+===============
+
+Instead of using the makefiles, you can use the configure
+system to generate appropriate makefiles, as used on Unix
+and Mac OS X systems.
+
+Change directory to the root of the wxWindows distribution,
+make a build directory, run 'sh', and then from this shell
+run configure and make.
+
+For example:
+
+  cd $WXWIN
+  mkdir build-debug
+  cd build-debug
+  ../configure --with-msw --enable-debug --enable-debug_gdb --disable-shared
+  make
+  cd samples/minimal
+  make
+  ./minimal.exe
+
 Notes:
 
 1. See also the Cygwin/Mingw32 on the web site or CD-ROM for
    further information about using wxWindows with these compilers.
 
-2. libwx.a is 48 MB or more - but much less if compiled with no
+2. libwx.a is 100 MB or more - but much less if compiled with no
    debug info (-g0) and level 4 optimization (-O4).
 
-3. There's a bug in Mingw32 headers for some early distributions.
+3. If you get a link error under Mingw32 2.95.2 referring to:
+
+   EnumDAdvise__11IDataObjectPP13IEnumSTATDATA@8
+
+   then you need to edit the file objidl.h at line 663 and add
+   a missing PURE keyword:
+
+   STDMETHOD(EnumDAdvise)(THIS_ IEnumSTATDATA**) PURE;
+
+4. There's a bug in Mingw32 headers for some early distributions.
 
    in include/windows32/defines.h, where it says:
 
@@ -530,14 +637,14 @@ Notes:
 
    (a missing bracket).
 
-4. If there's a problem with the copy or remove commands in
+5. If there's a problem with the copy or remove commands in
    src/msw/makefile.g95, you may need to change the COPY and
    RM variables in makeg95.env.
 
-5. If there's a problem executing the windres program, try
+6. If there's a problem executing the windres program, try
    commenting out RCPREPROCESSOR in makeg95.env.
 
-6. OpenGL support should work with Mingw32 as-is. However,
+7. OpenGL support should work with Mingw32 as-is. However,
    if you wish to generate import libraries appropriate either for
    the MS OpenGL libraries or the SGI OpenGL libraries, go to
    include/wx/msw/gl and use:
@@ -566,20 +673,45 @@ OLD VERSIONS:
   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:
+Symantec 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 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.
 
 TWIN32 and gcc on Linux
 -----------------------