docstring fix

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

diff --git a/docs/msw/install.txt b/docs/msw/install.txt
index 1aca7b46b1fc0b208bc3b1d937fb43e3e92ee3b9..db258d2d46b0a767feefdf1c1a10e53136ed3844 100644 (file)
--- a/docs/msw/install.txt
+++ b/docs/msw/install.txt
@@ -1,7 +1,7 @@
-Installing wxWidgets 2.5.2
+Installing wxWidgets 2.5.5

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

-This is wxWidgets 2.5.2 for Microsoft Windows 9x/ME, Windows NT, Windows 2000
+This is wxWidgets 2.5.5 for Microsoft Windows 9x/ME, Windows NT, Windows 2000

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


@@ -61,7 +61,7 @@ All makefiles and project are located in build\msw directory.
 Where compiled files are stored
 -------------------------------
 
 Where compiled files are stored
 -------------------------------
 

-After succesful compilation you'll find the libraries in a subdirectory
+After successful compilation you'll find the libraries in a subdirectory

 of lib directory named after the compiler and DLL/static settings.
 A couple of examples:
 
 of lib directory named after the compiler and DLL/static settings.
 A couple of examples:
 


@@ -263,7 +263,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.5.2.zip and the setup version.
+   included in wxMSW-2.5.5.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
 
 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


@@ -326,7 +326,7 @@ Metrowerks CodeWarrior compilation
 Cygwin/MinGW compilation
 ------------------------
 
 Cygwin/MinGW compilation
 ------------------------
 

-wxWidgets 2 supports Cygwin (formerly GnuWin32) betas and
+wxWidgets supports Cygwin (formerly GnuWin32) betas and

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


@@ -339,6 +339,8 @@ Both Cygwin and MinGW can be used with configure (assuming you have MSYS
 installed in case of MinGW). You will need new enough MinGW version, preferably
 MinGW 2.0 (ships with gcc3) or at least 1.0 (gcc-2.95.3). GCC versions older
 than 2.95.3 don't work; you can use wxWidgets 2.4 with them.
 installed in case of MinGW). You will need new enough MinGW version, preferably
 MinGW 2.0 (ships with gcc3) or at least 1.0 (gcc-2.95.3). GCC versions older
 than 2.95.3 don't work; you can use wxWidgets 2.4 with them.

+If using Cygwin, you must pass --disable-sockets to configure due to a header
+conflict in Cygwin.

 
 NOTE: some notes specific to old Cygwin (< 1.1.x) are at the end of this
       section (see OLD VERSIONS)
 
 NOTE: some notes specific to old Cygwin (< 1.1.x) are at the end of this
       section (see OLD VERSIONS)


@@ -355,10 +357,10 @@ provide Unix-like tools that you'll need to build wxWidgets using configure.
 Using makefiles directly
 ------------------------
 
 Using makefiles directly
 ------------------------
 

-NOTE: The makefile are for compilation under Cygwin, or
-      command.com/cmd.exe, they won't work in other environments
-      (such as UNIX or Unix-like, e.g. MSYS, you have to use configure
-      instead)
+NOTE: The makefile.gcc makefiles are for compilation under MinGW using
+      native make and Windows command interpreter (command.com/cmd.exe), they
+      won't work in other environments (such as UNIX or Unix-like, e.g. MSYS;
+      you have to use configure instead)

 
 Here are the steps required using the provided makefiles:
 
 
 Here are the steps required using the provided makefiles:
 


@@ -557,14 +559,15 @@ build\msw\config.* file; more detailed description follows.
 Basic options
 -------------
 
 Basic options
 -------------
 

-BUILD=debug
-  Builds debug version of the library (default is 'release'). This affects
-  name of the library ('d' is appended), __WXDEBUG__ is defined and debug
-  information compiled into object files and the executable.
+BUILD=release
+  Builds release version of the library. It differs from default 'debug' 
+  in lack of appended 'd' in name of library, does not define __WXDEBUG__
+  and not include debug information compiled into object files and the 
+  executable.

 
 

-SHARED=0
-  Build static libraries instead of DLLs. By default, DLLs are built
-  (SHARED=1).
+SHARED=1
+  Build shared libraries (DLLs). By default, DLLs are not built
+  (SHARED=0).

 
 UNICODE=1
   To build Unicode versions of the libraries, add UNICODE=1 to make invocation
 
 UNICODE=1
   To build Unicode versions of the libraries, add UNICODE=1 to make invocation


@@ -609,6 +612,10 @@ USE_HTML=0
   Do not build wxHTML library. If MONOLITHIC=1, then you must also
   #define wxUSE_HTML 1 in setup.h.
 
   Do not build wxHTML library. If MONOLITHIC=1, then you must also
   #define wxUSE_HTML 1 in setup.h.
 

+USE_XRC=0
+  Do not build XRC resources library. If MONOLITHIC=1, then you must also
+  #define wxUSE_HTML 1 in setup.h.
+

 RUNTIME_LIBS=static
   Links static version of C and C++ runtime libraries into the executable, so
   that the program does not depend on DLLs provided with the compiler (e.g.
 RUNTIME_LIBS=static
   Links static version of C and C++ runtime libraries into the executable, so
   that the program does not depend on DLLs provided with the compiler (e.g.