]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/msw/install.txt
projects / wxWidgets.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
More lib and demo changes for dropping the wx prefix, from Jeff G.
[wxWidgets.git] / docs / msw / install.txt
diff --git a/docs/msw/install.txt b/docs/msw/install.txt
index 0eba2f7928e4d5dafb7aa0e2c5e52fcc374b1057..c49c5e80ae4d02a3ce5ff3984228cb40ccd640fb 100644 (file)
--- a/docs/msw/install.txt
+++ b/docs/msw/install.txt
@@ -1,11 +1,10 @@
-Installing wxWindows 2.5.0
+Installing wxWindows 2.5.1
 --------------------------
 
 --------------------------
 
-This is wxWindows 2.5.0 for Microsoft Windows 9x/ME, Windows NT, Windows 2000
+This is wxWindows 2.5.1 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
 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.
-
+change in backwards incompatible way during the 2.5 branch lifetime.
 
 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,
@@ -19,30 +18,23 @@ Please report bugs using the SourceForge bug tracker:
 
   http://sourceforge.net/bugs/?group_id=9863
 
 
   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
 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. 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.
+path that contains spaces.
 
 The setup program contains the following:
 
 - All common, generic and MSW-specific wxWindows source;
 
 The setup program contains the following:
 
 - All common, generic and MSW-specific wxWindows source;
-- samples;
-- documentation in Windows Help format;
+- samples and demos;
+- documentation in MS HTML Help format;
 - makefiles for most Windows compilers, plus CodeWarrior,
   BC++ and VC++ IDE files;
 - JPEG library source;
 - TIFF library source;
 - makefiles for most Windows compilers, plus CodeWarrior,
   BC++ and VC++ IDE files;
 - JPEG library source;
 - TIFF library source;
-- Object Graphics Library;
-- Tex2RTF source;
-- Dialog Editor binary.
+- Object Graphics Library, Tex2RTF, wxSTC, etc.
 
 Alternatively, you may unarchive the .zip form by hand:
 wxMSW-x.y.z.zip where x.y.z is the version number.
 
 Alternatively, you may unarchive the .zip form by hand:
 wxMSW-x.y.z.zip where x.y.z is the version number.
@@ -50,14 +42,6 @@ wxMSW-x.y.z.zip where x.y.z is the version number.
 Unarchive the required files plus any optional documentation
 files into a suitable directory such as c:\wx.
 
 Unarchive the required files plus any optional documentation
 files into a suitable directory such as c:\wx.
 
-Other add-on packages are available from the wxWindows Web site, such as:
-
-- mmedia.zip. Audio, CD, video access for Windows and Linux.
-- ogl3.zip. Object Graphics Library: build network diagrams, CASE tools etc.
-- tex2rtf3.zip. Tex2RTF: create Windows Help, HTML, and Word RTF files from
-  the same document source.
-
-
 General installation notes
 ==========================
 
 General installation notes
 ==========================
 
@@ -65,7 +49,6 @@ 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].
 
 include/wx/msw/setup.h and edit the resulting file to choose
 the features you would like to compile wxWindows with[out].
 
-
 Compilation
 ===========
 
 Compilation
 ===========
 
@@ -123,7 +106,6 @@ examples:
 Below are compiler specific notes followed by customizing instructions that
 apply to all compilers (search for "Configuring the build").
 
 Below are compiler specific notes followed by customizing instructions that
 apply to all compilers (search for "Configuring the build").
 
-
 Microsoft Visual C++ compilation
 --------------------------------
 
 Microsoft Visual C++ compilation
 --------------------------------
 
@@ -170,6 +152,7 @@ Using makefiles:
    to make the wxWindows core library as release DLL.
    See "Configuring the build" for instruction how to build debug or static
    libraries.
    to make the wxWindows core library as release DLL.
    See "Configuring the build" for instruction how to build debug or static
    libraries.
+
 2. Change directory to samples and type 'nmake -f makefile.vc'
    to make all the samples. You can also make them individually.
 
 2. Change directory to samples and type 'nmake -f makefile.vc'
    to make all the samples. You can also make them individually.
 
@@ -191,35 +174,16 @@ project files are now (hopefully) compatible where static libraries
 are concerned, but please exercise caution nevertheless and if
 possible, use one method or the other.
 
 are concerned, but please exercise caution nevertheless and if
 possible, use one method or the other.
 
-Note (3): VC++ 5's optimization code seems to be broken and can
-cause both compile and run-time problems: this can be seen when
-deleting an object Dialog Editor, in Release mode with optimizations
-on. If in doubt, switch off optimisations, although this will result in much
-larger executables. It seems possible that the library can be created with
-strong optimization, so long as the application is not strongly
-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.
-
-Note (4): some crash problems can be due to inconsistent compiler
+Note (3): 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
 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.
 
 options. If strange/weird/impossible things start to happen please
 check (dumping IDE project file as makefile and doing text comparison
 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.
 
-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
-files from an existing wxWindows sample and adapt them.
-
-
-Visual C++ 1.5 compilation (16-bit)
------------------------------------
-
-No longer supported
-
+Note (4): to create your own IDE files, copy .dsp and .dsw
+files from an existing wxWindows sample and adapt them, or
+visit http://wiki.wxwindows.org/wiki.pl?MSVC.
 
 Borland C++ 5.0/5.5 compilation
 -------------------------------
 
 Borland C++ 5.0/5.5 compilation
 -------------------------------
@@ -228,11 +192,11 @@ Compiling using the makefiles (updated 24 Sept 02):
 
 1. Change directory to build\msw. Type 'make -f makefile.bcc' to
    make the wxWindows core library. Ignore the compiler warnings.
 
 1. Change directory to build\msw. Type 'make -f makefile.bcc' to
    make the wxWindows core library. Ignore the compiler warnings.
-   This produces a couple of librarie in the lib\bcc_mswdll directory.
+   This produces a couple of libraries in the lib\bcc_lib directory.
 
 2. Change directory to a sample or demo such as samples\minimal, and type
   'make -f makefile.bcc'. This produces a windows exe file - by default 
 
 2. Change directory to a sample or demo such as samples\minimal, and type
   'make -f makefile.bcc'. This produces a windows exe file - by default 
-   in the bcc_mswdll subdirectory.
+   in the bcc_mswd subdirectory.
 
 Note (1): the wxWindows makefiles assume dword structure alignment. Please
 make sure that your own project or makefile settings use the
 
 Note (1): the wxWindows makefiles assume dword structure alignment. Please
 make sure that your own project or makefile settings use the
@@ -244,39 +208,14 @@ either install odbc32.lib from the BC++ CD-ROM into your BC++ lib
 directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
 recompile wxWindows. The same applies if compiling using the IDE.
 
 directory, or set wxUSE_ODBC to 0 in include\wx\msw\setup.h and
 recompile wxWindows. The same applies if compiling using the IDE.
 
-
 Note (3): If you wish debug messages to be sent to the console in
 debug mode, edit makefile.bcc and change /aa to /Tpe in link commands.
 
 Note (3): If you wish debug messages to be sent to the console in
 debug mode, edit makefile.bcc and change /aa to /Tpe in link commands.
 
-Compiling using the IDE files: [Borland C++ 5.0, not Cbuilder]
-
-1. Load src\bc32.ide from the file bc32.zip at 
-   http://biolpc22.york.ac.uk/pub/ports/bcc32/wxwin21/ and select Release settings
-2. Go to Options|Project... and specify the correct BC++ include and lib path for
-   your file structure.
-3. Press F9 to compile the wxWindows library.
-4. Load samples\bc32.ide.
-5. Go to Options|Project... and specify the correct BC++ include and lib path for
-   your file structure.
-6. Press F9 to compile the samples (build each node separately if
-   you prefer, by right clicking and choose Build Node).
-7. Run each sample: you may need to run from each sample's directory
-   since some (notably the wxHTML samples) look for files
-   relative to the working directory.
-
-Note (1): the samples project file contains a selection of
-samples, and not all samples. The remaining samples can be made
-with the makefiles. See also the demos hierarchy which doesn't
-have any BC++ project files yet.
-
-Note (2): to make the png, zlib, jpeg and tiff libraries (needed for
-some samples) you need to compile them with bc32.ide.
+Compiling using the IDE files for Borland C++ 5.0: not supported - please
+use version 2.4.1 (using the make utility in commandline mode works fine_
 
 
-Note (3): the debug version of the wxWindows library is about 40 MB, and the
-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.
+Compiling using CBuilder (v1-v6): not supported - please
+use version 2.4.1 (using the make utility in commandline mode works fine_
 
 ** REMEMBER **
 
 
 ** REMEMBER **
 
@@ -290,22 +229,6 @@ 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 IDE compilation
-----------------------------------
-
-1. Build the wxWindows libraries using the Borland make utility as
-   specified in the section called "Borland C++ 5.0 compilation"
-   above. (C++ Builder includes a stand-alone C++ compiler.  For example,
-   C++ Builder 4.0 comes with C++ 5.4.)
-
-2. 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-6; v4 and after will convert this to bpr]. 
-   Execute this in the sampledirectory, passing the name of the cpp files 
-   on the command line. For more details, see the instructions in 
-   docs/tech/tn0004.htm or http://biolpc22.york.ac.uk/wx/bc/ide.html.
-
 Borland 16 Bit compilation for Windows 3.1
 ------------------------------------------
 
 Borland 16 Bit compilation for Windows 3.1
 ------------------------------------------
 
@@ -317,10 +240,10 @@ Watcom C++ 10.6/11 and OpenWatcom compilation
 
 1. Change directory to build\msw. Type 'wmake -f makefile.wat' to
    make the wxWindows core library.
 
 1. Change directory to build\msw. Type 'wmake -f makefile.wat' to
    make the wxWindows core library.
+
 2. Change directory to samples\minimal and type 'wmake -f makefile.wat'
    to make this sample. Repeat for other samples of interest.
 
 2. Change directory to samples\minimal and type 'wmake -f makefile.wat'
    to make this sample. Repeat for other samples of interest.
 
-
 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 (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.
@@ -336,12 +259,12 @@ Note (4): if Watcom can't read the precompiled header when building a sample,
           try deleting .pch files in build\msw\wat_* and compiling
           the sample again.
 
           try deleting .pch files in build\msw\wat_* and compiling
           the sample again.
 
-
 Metrowerks CodeWarrior compilation
 ----------------------------------
 
 1. CodeWarrior Pro7 project files in XML format are already
 Metrowerks CodeWarrior compilation
 ----------------------------------
 
 1. CodeWarrior Pro7 project files in XML format are already
-   included in wxMSW-2.5.0.zip and the setup version.
+   included in wxMSW-2.5.1.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
@@ -350,11 +273,13 @@ Metrowerks CodeWarrior compilation
        - wxUSE_GLOBAL_MEMORY_OPERATORS works, but memory leak reports
          will be rather confusing due to interactions with the MSL ANSI
          and runtime libs.
        - 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
    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
    CodeWarrior Reference CD, in the Thrill Seekers folder; it's call the
    "Batch File Post Linker".
 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
    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
    "Batch File Post Linker".
+
 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
 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
@@ -363,31 +288,36 @@ 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
       (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 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.
 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.
+
 6. Choose the wxlib Win32 debug or wxlib Win32 Release target and build.  You
    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
    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.
 6. Choose the wxlib Win32 debug or wxlib Win32 Release target and build.  You
    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
    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)
 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
    big priorities for me ;).
 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
    big priorities for me ;).
+
 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,
    controls, dialogs, dnd, nd docview samples.  You can use these project
    files as templates for the other samples and for your own projects.
 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,
    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,
+       - For example, to make a project file for the "grid" sample,
          just copy the project file for the "minimal" sample, minimalW7.mcp
          (made by importing minimalW7.xml into CodeWarrior), into the
          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
+         sample/grid directory, calling it gridW7.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....
          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....
@@ -529,7 +459,6 @@ Notes:
    flagged when the program quits. You can use Cygwin gdb
    to debug MinGW executables.
 
    flagged when the program quits. You can use Cygwin gdb
    to debug MinGW executables.
 
-
 OLD VERSIONS:
 
 - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
 OLD VERSIONS:
 
 - Modify the file wx/src/cygnus.bat (or mingw32.bat or mingegcs.bat)
@@ -552,19 +481,26 @@ and can be downloaded from http://www.digitalmars.com/
    
 1. You need to download and unzip in turn (later packages will overwrite
    older files)
    
 1. You need to download and unzip in turn (later packages will overwrite
    older files)
-    Digital Mars C/C++ Compiler Version 8.33 
-    Basic utilities
-    beta test C++ Compiler Version 8.34
-   from http://www.digitalmars.com/download/freecompiler.html [02 may 03, CE]
+      Digital Mars C/C++ Compiler Version 8.38 or later
+      Basic utilities
+   from http://www.digitalmars.com/download/freecompiler.html
 
 
-2. Change directory to build\msw. Type 'make -f makefile.dm' to
+2. Change directory to build\msw and type 'make -f makefile.dmc' to
    make the wxWindows core library.
    make the wxWindows core library.
-3. Change directory to samples\minimal and type 'make -f makefile.dm'
-   to make this sample. The mdi and image sample also work; others may give
-   linker erros due to missing libraries
 
 
-16-bit compilation is no longer supported.
+3. Change directory to samples\minimal and type 'make -f makefile.dmc'
+   to make this sample. Most of the other samples also work.
+
+
+Note that if you don't have the files makefile.dmc you may create them yourself
+using bakefile tool according to the instructions in build\bakefiles\README:
 
 
+    cd build\bakefiles
+    bakefile_gen -f dmars -b wx.bkl
+    bakefile_gen -f dmars -b ../../samples/minimal/minimal.bkl
+
+
+16-bit compilation is no longer supported.
 
 Configuring the build
 =====================
 
 Configuring the build
 =====================
@@ -596,7 +532,7 @@ Visual C++:
   > nmake -f makefile.vc BUILD=debug UNICODE=1
 
 Borland C++:
   > nmake -f makefile.vc BUILD=debug UNICODE=1
 
 Borland C++:
-  > nmake -f makefile.bcc -DBUILD=debug -DUNICODE=1
+  > make -f makefile.bcc -DBUILD=debug -DUNICODE=1
   (Note that you have to use -D to set the variable, unlike in other make
   tools!)
 
   (Note that you have to use -D to set the variable, unlike in other make
   tools!)
 
@@ -642,7 +578,7 @@ Advanced options
 ----------------
 
 MONOLITHIC=1
 ----------------
 
 MONOLITHIC=1
-  Starting with version 2.5.0, wxWindows has the ability to be built as 
+  Starting with version 2.5.1, wxWindows has the ability to be built as 
   several smaller libraries instead of single big one as used to be the case
   in 2.4 and older versions. This is called "multilib build" and is the
   default behaviour of makefiles. You can still build single library
   several smaller libraries instead of single big one as used to be the case
   in 2.4 and older versions. This is called "multilib build" and is the
   default behaviour of makefiles. You can still build single library
@@ -792,18 +728,10 @@ have two static debug builds, one with wxUSE_SOCKETS=0 and one with sockets
 enabled (without CFG, both of them would be put into same directory and there
 would be conflict between the files).
 
 enabled (without CFG, both of them would be put into same directory and there
 would be conflict between the files).
 
-
 General Notes
 =============
 
 - Debugging: under Windows 95, debugging output isn't output in
   the same way that it is under NT or Windows 3.1.
 General Notes
 =============
 
 - Debugging: under Windows 95, debugging output isn't output in
   the same way that it is under NT or Windows 3.1.
-  Please see DebugView (bin/dbgview.exe in the distribution), also
-  available from http://www.sysinternals.com and on the wxWindows CD-ROM
-  under Packages.
-
-- If you are installing wxWindows 2 from CVS, you may find that
-  include/wx/msw/setup.h is missing. This is deliberate, to avoid
-  developers' different setup.h configurations getting confused.
-  Please copy setup0.h to setup.h before compiling. Also, read
-  the BuildCVS.txt for other hints.
+  Please see DebugView available from http://www.sysinternals.com.
+
wxWidgets (Impactor)