update Watcom section; minor additions to the other ones

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@18865 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2003-01-22 17:31:04 +00:00
parent a7b4607f4a
commit 545d1e6050
1 changed files with 107 additions and 71 deletions
--- a/docs/msw/install.txt
+++ b/docs/msw/install.txt
@@ -1,14 +1,11 @@
 Installing wxWindows 2.5.0
 --------------------------
-This is wxWindows 2.5.0 for Microsoft Windows 9x/ME, Windows NT,
+This is wxWindows 2.5.0 for Microsoft Windows 9x/ME, Windows NT, Windows 2000
-Windows 2000 and Windows XP. This is an unstable development release.
+and Windows XP. This is an unstable development release. Note that unstable in
 this context doesn't mean that it crashes a lot, just that the library API may
 change in backwards incompatible way during the 2.5 branch life time.
 Please note that the library naming conventions for VC++
 compilation have changed after 2.3.1. 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,
@@ -22,6 +19,7 @@ Please report bugs using the SourceForge bug tracker:
  http://sourceforge.net/bugs/?group_id=9863
 Unarchiving
 -----------
@@ -59,6 +57,7 @@ Other add-on packages are available from the wxWindows Web site, such as:
 - tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
  the same document source.
 General installation notes
 --------------------------
@@ -70,14 +69,17 @@ 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 features you would like to compile wxWindows with[out].
 Compilation
-----------
+===========
 The following sections explain how to compile wxWindows with each supported
-compiler.
+compiler. Search for one of Microsoft/Borland/Watcom/Symantec/Metrowerks/
 Cygwin/Mingw32 to quickly locate the instructions for your compiler.
-Visual C++ compilation
+
---------------------------
+Microsoft Visual C++ compilation
 --------------------------------
 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
@@ -155,10 +157,10 @@ Makefile notes:
  To build Unicode versions of the libraries, add UNICODE=1
  to the nmake invocation (default is UNICODE=0). If you want to
-  be able to use Unicode version on Windows9x, you will need 
+  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 
+  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
@@ -216,6 +218,7 @@ applications in the VC++ IDE" (technical note docs/tech/tn0010.htm in the
 wxWindows distribution). You can also copy .dsp and .dsw
 files from an existing wxWindows sample and adapt them.
 Visual C++ 1.5 compilation (16-bit)
 -----------------------------------
@@ -235,6 +238,7 @@ versions of the library and samples.
 Use the 'clean' target to clean all objects, libraries and
 executables.
 Borland C++ 4.5/5.0/5.5 compilation
 -------------------------------
@@ -243,9 +247,9 @@ Compiling using the makefiles (updated 24 Sept 02):
 1. Make sure your WXWIN variable is set [e.g add
   set WXWIN=c:\wxwindows
   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 ; 
+   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.   
+   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.
   This produces a library in the wxwindows\lib directory called
@@ -263,7 +267,7 @@ Compiling using the makefiles (updated 24 Sept 02):
 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), 
+   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
@@ -271,7 +275,7 @@ Compiling using the makefiles (updated 24 Sept 02):
   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), 
+   which generates a DLL (wx32.dll) and import library (wx32.lib),
   and then for each sample,
   'make -f makefile.b32 WXUSINGDLL=1 FINAL=1'
@@ -302,7 +306,7 @@ Note (0): This provides the ability to produce separate wxwindows libraries
 Note (1): In Borland 4.5 and earleir, using bcc.exe you also need to define BCCDIR
 in the autoexec.bat file; like this:
   set BCCDIR=c:\progra~1\borland\bcc
-   so that it points to the root directory of 
+   so that it points to the root directory of
   your Borland C++ installation, and it uses the FAT (short
   name) form with no spaces.
@@ -367,18 +371,19 @@ of how to create your own project files.
 ** REMEMBER **
-In all of your wxWindows applications, your source code should include 
+In all of your wxWindows applications, your source code should include
 the following preprocessor directive:
 #ifdef __BORLANDC__
 #pragma hdrstop
 #endif
-(check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for 
+(check the samples -- e.g., \wx2\samples\minimal\minimal.cpp -- for
-more details) 
+more details)
 Borland C++Builder IDE compilation
------------------------------
+----------------------------------
 1. Build the wxWindows libraries using the Borland make utility as
   specified in the section called "Borland C++ 4.5/5.0 compilation"
@@ -393,83 +398,106 @@ Borland C++Builder IDE compilation
   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
+
---------------------------
+Watcom C++ 10.6/11 and OpenWatcom 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 all' to
+2. Change directory to wx\src\msw. Type 'wmake -f makefile.wat' to
   make the wxWindows core library.
-3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat all'
+3. Change directory to wx\samples\minimal and type 'wmake -f makefile.wat'
   to make this sample. Repeat for other samples of interest.
-Note (1): makewat.env uses the odbc32.lib supplied in wxWindows' lib\watcom
+
-directory. See the notes in that directory.
+There are several makefile variables which may be modified:
-Note (2): if variant.cpp is compiled with date/time class
+
-options, the linker gives up. So the date/time option is switched
+- FINAL may be set to 1 (e.g. 'wmake -f makefile.wat FINAL=1') to build
-off for Watcom C++. Also, wxAutomationObject is not compiled with
+  the release version of the library, i.e. without debug info and with
-Watcom C++.
+  optimizations enabled
-Note (3): if Watcom can't read the precompiled header when
+
-building a sample, try deleting src\msw\watcom.pch and
+- WATCOM_SUFFIX is appended to the names of all libraries produced by the
-compiling the sample again.
+  makefile -- this allows to use several compilers in the same wxWindows
  source tree. If you only use Watcom compiler, set WATCOM_SUFFIX to nothing.
 - OUTPUTDIR may be set to the name of the directory where you want all the
  object files to be generated (the library files are always created in
  %WXWIN\lib). You may set it to nothing to create them in the same directory
  as the sourcse, however using a separate directory is preferable if you use
  several different compilers. If you change OUTPUTDIR, make sure that it is
  either empty or has a trailing backslash!
 Note (1): if your installation of Watcom doesn't have odbc32.lib file and
          you need it (i.e. you have wxUSE_ODBC=1), you can use the file
          from lib\watcom directory. See the notes in that directory.
 Note (2): if variant.cpp is compiled with date/time class options, the linker
          gives up. So the date/time option is switched off for Watcom C++.
          Also, wxAutomationObject is not compiled with Watcom C++ 10.
 Note (3): if Watcom can't read the precompiled header when building a sample,
          try deleting src\msw\watcom.pch and compiling the sample again.
 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.5.0.zip and the setup version.
-2. Review the file include\wx\msw\setup.h (or include\wx\msw\setup0.h if 
+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 
+   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 
+   what you want.  If you aren't sure, leave it alone and go with the
   default settings.  A few notes:
       - Don't use wxUSE_DEBUG_NEW_ALWAYS: it doesn't mix well with MSL
-       - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports 
+       - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports
         will be rather confusing due to interactions with the MSL ANSI
         and runtime libs.
-3. The project file to build the Win32 wxWindows libraries relies on the 
+3. The project file to build the Win32 wxWindows libraries relies on the
-   Batch File Runner plug-in.  This plug-in is not installed as part of 
+   Batch File Runner plug-in.  This plug-in is not installed as part of
-   a normal CW7 installation.  However, you can find this plug-in on the 
+   a normal CW7 installation.  However, you can find this plug-in on the
-   CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the 
+   CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the
-   "Batch File Post Linker". 
+   "Batch File Post Linker".
-4. If you choose not to install the Batch File Runner plug-in, then you 
+4. If you choose not to install the Batch File Runner plug-in, then you
   need to do the following by hand:
-      (1) Create the directories lib\cw7msw\include\wx and copy the file 
+      (1) Create the directories lib\cw7msw\include\wx and copy the file
-          include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are 
+          include\wx\msw\setup.h (or include\wx\msw\setup0.h if you are
          working from the CVS version) to lib\cw7msw\include\wx\setup.h
-      (2) Create the directories lib\cw7mswd\include\wx and copy the file 
+      (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 
+          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 src\wxWindowsW7.xml to create the project file wxWindowsW7.mcp.
-   Store this project file in directory src.  You may get warnings about 
+   Store this project file in directory src.  You may get warnings about
-   not being able to find certain project paths; ignore these warnings, the 
+   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.
-6. Choose the wxlib Win32 debug or wxlib Win32 Release target and build.  You 
+6. Choose the wxlib Win32 debug or wxlib Win32 Release target and build.  You
-   will get some warnings about hidden virtual functions, illegal conversions 
+   will get some warnings about hidden virtual functions, illegal conversions
   from const pointers to pointers, etc., all of which you can safely ignore.
-   ***Note:  if you get errors that the compiler can't find "wx/setup.h", just 
+   ***Note:  if you get errors that the compiler can't find "wx/setup.h", just
-   stop the build and build again.  These errors occur because sometimes the 
+   stop the build and build again.  These errors occur because sometimes the
   compiler starts doing its thing before the copying of setup.h has completed.
 7. The following libraries will be produced depending on chosen
   target:
       - wx_x86.lib             ANSI Release (static)
       - wx_x86_d.lib           ANSI Debug (static)
 8. Sorry, I haven't had time yet to create and test unicode or DLL versions.
-   Volunteers for this are welcome (as neither DLLs nor unicode builds are 
+   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 
+9. CodeWarrior Pro7 project files (in XML format) are also provided for some
-   of the samples.  In particular, there are project files for the minimal, 
+   of the samples.  In particular, there are project files for the minimal,
-   controls, dialogs, dnd, nd docview samples.  You can use these project 
+   controls, dialogs, dnd, nd docview samples.  You can use these project
-   files as templates for the other samples and for your own projects.  
+   files as templates for the other samples and for your own projects.
-       - For example, to make a project file for the "newgrid" sample, 
+       - For example, to make a project file for the "newgrid" sample,
-         just copy the project file for the "minimal" sample, minimalW7.mcp 
+         just copy the project file for the "minimal" sample, minimalW7.mcp
-         (made by importing minimalW7.xml into CodeWarrior), into the 
+         (made by importing minimalW7.xml into CodeWarrior), into the
-         sample/newgrid directory, calling it newgridW7.mcp.  Open 
+         sample/newgrid directory, calling it newgridW7.mcp.  Open
-         newgridW7.mcp and revise the project by deleting the files 
+         newgridW7.mcp and revise the project by deleting the files
-         minimal.rc and minimal.cpp and adding the files griddemo.rc and 
+         minimal.rc and minimal.cpp and adding the files griddemo.rc and
         griddemo.cpp.  Build and run....
 Cygwin/MinGW compilation
----------------------------------
+------------------------
 wxWindows 2 supports Cygwin (formerly GnuWin32) betas and
 releases, and MinGW. Cygwin can be downloaded from:
@@ -481,7 +509,11 @@ and MinGW from:
    http://www.mingw.org/
 Both Cygwin and MinGW can be used with the same makefiles, and both can be
-used with configure.
+used with configure. However the (strongly) preferred way to build wxWindows
 is using configure with Cygwin and using the makefiles with MinGW as these
 configurations are test much more often than the remaining two and so are much
 more likely to work out of the box.
 NOTE: some notes specific to old Cygwin (< 1.1.x)
      and MinGW (< 1.0) are at the end of this section
@@ -499,8 +531,8 @@ If you do not want to use MSYS, then you need 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 a directory in your path. If you have 
+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
@@ -687,6 +719,7 @@ OLD VERSIONS:
 - If using GnuWin32 b18, you will need to copy windres.exe
  from e.g. the MinGW distribution, to a directory in your path.
 Symantec C++ compilation
 ------------------------
@@ -705,6 +738,7 @@ 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
 -----------------------
@@ -724,6 +758,7 @@ 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
 -----------------------
@@ -739,6 +774,7 @@ described above. Not all sample makefiles are supplied yet.
 For some reason, I found I had to copy TWIN32's Windows resource
 compiler (rc) to the current working directory for it to be found.
 General Notes
 -------------