X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/71521e3757cdcc5010e2e397a4b3a830720de7ad..7664a67f57db442025638bb87099fb2826bc2400:/docs/msw/install.txt diff --git a/docs/msw/install.txt b/docs/msw/install.txt index a51818d883..77054b6db7 100644 --- a/docs/msw/install.txt +++ b/docs/msw/install.txt @@ -1,7 +1,7 @@ -Installing wxWidgets 2.6.2 +Installing wxWidgets for Windows ----------------------------------------------------------- -This is wxWidgets 2.6.2 for Microsoft Windows 9x/ME, Windows NT, +This is wxWidgets for Microsoft Windows 9x/ME, Windows NT, Windows 2000, Windows XP and Windows CE. These installation notes can be found in docs/msw/install.txt @@ -9,20 +9,25 @@ in your wxWidgets distribution. IMPORTANT NOTE: If you experience problems installing, please re-read this instructions and other related files (changes.txt, -readme.txt, FAQ) carefully before mailing wx-users. Preferably, -try to fix the problem first and then upload a patch to -SourceForge: +readme.txt, FAQ) carefully before posting to wx-users list. - http://sourceforge.net/patch/?group_id=9863 +If you are sure that you found a bug, please report it at +wxWidgets Trac: -Please report bugs using the SourceForge bug tracker: + http://trac.wxwidgets.org/newticket + +Please notice that often trying to correct the bug yourself is the +quickest way to fix it. Even if you fail to do it, you may +discover valuable information allowing us to fix it while doing +it. We also give much higher priority to bug reports with patches +fixing the problems so this ensures that your report will be +addressed sooner. - http://sourceforge.net/bugs/?group_id=9863 Unarchiving ============================================================ -A setup program is provided (setup.exe) to automatically copy +A setup program is provided (wxMSW-x.x.x-setup.exe) to automatically copy files to a directory on your hard disk. Do not install into a path that contains spaces. @@ -46,7 +51,7 @@ files into a suitable directory such as c:\wx. General installation notes ========================== -If installing from the CVS server, copy include/wx/msw/setup0.h to +If installing from the SVN 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 wxWidgets with[out]. @@ -79,24 +84,24 @@ build ('d'). Last component of them name is name of wxWidgets component "Configuring the build" below). This is a typical set of release ANSI build libraries (release versions on left, debug on right side): - wxbase25.lib wxbase25d.lib - wxbase25_net.lib wxbase25d_net.lib - wxbase25_xml.lib wxbase25d_xml.lib - wxmsw25_core.lib wxmsw25d_core.lib - wxmsw25_html.lib wxmsw25d_html.lib - wxmsw25_adv.lib wxmsw25d_adv.lib + wxbase29.lib wxbase29d.lib + wxbase29_net.lib wxbase29d_net.lib + wxbase29_xml.lib wxbase29d_xml.lib + wxmsw29_core.lib wxmsw29d_core.lib + wxmsw29_html.lib wxmsw29d_html.lib + wxmsw29_adv.lib wxmsw29d_adv.lib Their Unicode debug counterparts in wxUniversal build would be - wxbase25ud.lib - wxbase25ud_net.lib - wxbase25ud_xml.lib (notice these libs are same for wxUniv and wxMSW) - wxmswuniv25ud_core.lib - wxmswuniv25ud_html.lib - wxmswuniv25ud_adv.lib + wxbase29ud.lib + wxbase29ud_net.lib + wxbase29ud_xml.lib (notice these libs are same for wxUniv and wxMSW) + wxmswuniv29ud_core.lib + wxmswuniv29ud_html.lib + wxmswuniv29ud_adv.lib These directories also contain subdirectory with wx/setup.h header. This -subdirectory is named after port, Unicode, wxUniv and debug settings and +subdirectory is named after port, Unicode, wxUniv and debug settings and you must add it to include paths when compiling your application. Some examples: @@ -132,9 +137,17 @@ Using project files (VC++ 6 and later): know you won't need some of the libraries (i.e. html part), you don't have to compile it. It will also produce similar variations on jpeg.lib, png.lib, tiff.lib, zlib.lib, and regex.lib. - If you want to build DLLs, you have to either build them one by one in - proper order (jpeg, png, tiff, zlib, regex, expat, base, core, the rest - in any order) or to use wx_dll.dsw workspace which has correct dependencies. + + If you want to build DLL configurations in wx.dsw project you unfortunately + need to build them in the proper order (jpeg, png, tiff, zlib, regex, expat, + base, net, odbc, core, gl, html, media, qa, adv, dbgrid, xrc, aui, richtext, + propgrid) manually because VC6 doesn't always respect the correct build order. + + Alternatively, use the special wx_dll.dsw project which adds the + dependencies to force the correct order (but, because of this, doesn't work + for the static libraries) or simply redo the build several times until all + DLLs are linked correctly. Pleae notice that it's normal that dbgrid project + doesn't build if wxUSE_ODBC is set to 0 (default). 3. Open a sample project file, choose a configuration such as Win32 Debug using Build | Set Active Configuration..., and compile. The project files don't use precompiled headers, to save disk @@ -264,8 +277,17 @@ See http://support.microsoft.com/?id=894573 for more information. Borland C++ compilation ---------------------------------------------------------------- -The minimum version required is 5.5, which can be downloaded for free from: -http://www.borland.com/products/downloads/download_cbuilder.html# +The minimum version required is 5.5 (last version supported by BC++ 5.0 was +2.4.2), which can be downloaded for free from: +http://www.borland.com/products/downloads/download_cbuilder.html + +We have found that the free Turbo Explorer and commercial BDS work fine; the +debugger is very good. To avoid linker errors you will need to add +-DSHARED=1 to the makefile line for the library + +The version 5.6 included in Borland C++ Builder 2006 works as well after the +following small change: please remove the test for __WINDOWS__ from line 88 +of the file BCCDIR\include\stl\_threads.h. Compiling using the makefiles: @@ -274,7 +296,7 @@ Compiling using the makefiles: 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 + 'make -f makefile.bcc'. This produces a windows exe file - by default in the bcc_mswd subdirectory. Note (1): the wxWidgets makefiles assume dword structure alignment. Please @@ -290,10 +312,27 @@ recompile wxWidgets. 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. -Cmpilation succeeds with CBuilderX personal edition and CBuilder6, but +Using the Debugger and IDE in BDS or Turbo Explorer +--------------------------------------------------- + + +Doubleclick / open samples\minimal\borland.bdsproj. The current version +is to be used with a dynamic build of wxWidgets-made by running +make -f Makefile.bcc -DBUILD=debug -DSHARED=1 +in wxWidgets\build\msw. You also need the wxWidgets\lib\bcc_dll +directory in your PATH. The debugger tracks your source and also +traces into the wxWidgets sources. + +To use this to debug other samples, copy the borland_ide.cpp +and borland.bdsproj files, then replace all occurences of +"minimal" with the name of the new project files + +Compilation succeeds with CBuilderX personal edition and CBuilder6, but you may have to copy make.exe from the 5.5 download to the new bin directory. -Compiling using the IDE files for Borland C++ 5.0 and using CBuilder IDE -(v1-v6): not supported + +Compiling using the IDE files for Borland C++ 5.0 and using CBuilder IDE +(v1-v6): not supported + ** REMEMBER ** @@ -338,14 +377,27 @@ 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. +Note (5): wxUSE_STD_STRING is disabled in wx/string.h for Watcom as this + compiler doesn't come with standard C++ library headers by default. + If you install STLPort or another STL implementation, you'll need to + edit wx/string.h and remove the check for Digital Mars in it (search + for __WATCOM__). + + Metrowerks CodeWarrior compilation ---------------------------------------------------------------- +** NOTE: We don't use Metrowerks compiler any more and so depend on +** your contributions to keep it up to date. It is possible that +** the project files mentioned below are out of date due to recently +** added files, please add them manually if you get linking errors. +** The authoritative list of files is in build/bakefiles/files.bkl + 1. CodeWarrior Pro 7 project files in XML format are already - included in wxMSW-2.6.2.zip and the setup version. + included in wxMSW-2.8.x.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 + you are working from the SVN version) to make sure the settings reflect 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 @@ -363,10 +415,10 @@ Metrowerks CodeWarrior compilation need to do the following by hand: (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 - working from the CVS version) to lib\cw7msw\include\wx\setup.h + working from the SVN version) to lib\cw7msw\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 + working from the SVN version) to lib\cw7mswd\include\wx\setup.h 5. Import src\wxWidgetsW7.xml to create the project file wxWidgetsW7.mcp. Store this project file in directory src. You may get warnings about @@ -435,27 +487,24 @@ Using makefiles directly ---------------------------------------------------------------- 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: + Windows command interpreter (command.com/cmd.exe), they won't work in + other environments (such as UNIX or Unix-like, e.g. MSYS where you have + to use configure instead, see the section below) -- If you are using gcc-2.95, edit build\msw\config.gcc and set the GCC_VERSION - variable to "2.95". - -- Use the makefile.gcc files for compiling wxWidgets and samples, - e.g. to compile a debugging version of wxWidgets: +Use the makefile.gcc files for compiling wxWidgets and samples, +e.g. to compile a debugging version of wxWidgets: > cd c:\wx\build\msw - > make -f makefile.gcc BUILD=debug + > mingw32-make -f makefile.gcc BUILD=debug > cd c:\wx\samples\minimal - > make -f makefile.gcc BUILD=debug + > mingw32-make -f makefile.gcc BUILD=debug (See below for more options.) - Ignore the warning about the default entry point. +Notice that Windows command interpreter (cmd.exe) and mingw32-make must be +used, using Bash (sh.exe) and make.exe from MSYS will only work when using +configure-based build procedure described below! -- Use the 'strip' command to reduce executable/dll size (note that - stripping an executable/dll will remove debug information!). +You can also use the 'strip' command to reduce executable/dll size (note that +stripping an executable/dll will remove debug information!). All targets have 'clean' targets to allow removal of object files and other intermediate compiler files. @@ -477,7 +526,7 @@ For example: cd build-debug ../configure --with-msw --enable-debug --enable-debug_gdb --disable-shared make - make install % This step is optional, see note (8) below. + make install % This step is optional, see note (6) below. cd samples/minimal make ./minimal.exe @@ -563,7 +612,7 @@ Symantec & DigitalMars C++ compilation The DigitalMars compiler is a free succssor to the Symantec compiler and can be downloaded from http://www.digitalmars.com/ - + 1. You need to download and unzip in turn (later packages will overwrite older files) Digital Mars C/C++ Compiler Version 8.40 or later @@ -585,6 +634,12 @@ using bakefile tool according to the instructions in build\bakefiles\README: bakefile_gen -f dmars -b ../../samples/minimal/minimal.bkl +Note that wxUSE_STD_STRING is disabled in wx/string.h for Digital Mars as this +compiler doesn't come with standard C++ library headers by default. If you +install STLPort or another STL implementation, you'll need to edit wx/string.h +and remove the check for Digital Mars in it (search for __DMC__). + + 16-bit compilation is no longer supported. Configuring the build @@ -644,18 +699,18 @@ Basic options ---------------------------------------------------------------- BUILD=release - Builds release version of the library. It differs from default 'debug' + 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 + and not include debug information compiled into object files and the executable. 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 - (default is UNICODE=0). If you want to be able to use Unicode version on +UNICODE=0 + To build ANSI versions of the libraries, add UNICODE=0 to make invocation + (default is UNICODE=1). If you want to be able to use Unicode version on Windows9x, you will need to set MSLU=1 as well. This option affect name of the library ('u' is appended) and the directory @@ -669,7 +724,7 @@ Advanced options ---------------------------------------------------------------- MONOLITHIC=1 - Starting with version 2.5.1, wxWidgets has the ability to be built as + Starting with version 2.5.1, wxWidgets 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 @@ -682,7 +737,7 @@ USE_GUI=0 you should set wxUSE_GUI to 1 in setup.h. USE_OPENGL=1 - Build wxmsw25_gl.lib library with OpenGL integration class wxGLCanvas. + Build wxmsw29_gl.lib library with OpenGL integration class wxGLCanvas. You must also modify your setup.h to #define wxUSE_GLCANVAS 1. Note that OpenGL library is always built as additional library, even in monolithic build! @@ -729,27 +784,39 @@ DEBUG_INFO=1 Same as DEBUG_FLAG in behaviour, this option affects whether debugging information is included in the executable or not. +TARGET_CPU=AMD64|IA64 + (VC++ only.) Set this variable to build for x86_64 systems. If unset, x86 + build is performed. + VENDOR= Set this to a short string identifying your company if you are planning to distribute wxWidgets DLLs with your application. Default value is 'custom'. This string is included as part of DLL name. wxWidgets DLLs contain compiler name, version information and vendor name in them. For example - wxmsw250_core_bcc_custom.dll is one of DLLs build using Borland C++ with + wxmsw290_core_bcc_custom.dll is one of DLLs build using Borland C++ with default settings. If you set VENDOR=mycorp, the name will change to - wxmsw250_core_bcc_mycorp.dll. + wxmsw290_core_bcc_mycorp.dll. CFG= Sets configuration name so that you can have multiple wxWidgets builds with different setup.h settings coexisting in same tree. See "Object and library directories" below for more information. +COMPILER_PREFIX= + If you build with multiple versions of the same compiler, you can put + their outputs into directories like "vc6_lib", "vc8_lib" etc. instead of + "vc_lib" by setting this variable to e.g. "vc6". This is merely a + convenience variable, you can achieve the same effect (but different dir + names) with the CFG option. + + Compiler specific options ---------------------------------------------------------------- * MinGW If you are using gcc-2.95 instead of gcc3, you must set GCC_VERSION to -2.95. In build\msw\config.gcc, change +2.95. In build\msw\config.gcc, change > GCC_VERSION = 3 to > GCC_VERSION = 2.95 @@ -785,7 +852,7 @@ compiler name. Examples of directory names: build\msw\bcc_mswunivd SHARED=0, WXUNIV=1, BUILD=debug build\msw\vc_mswunivd ditto, with Visual C++ -Libraries and DLLs are copied into subdirectory of lib directory with +Libraries and DLLs are copied into subdirectory of lib directory with name derived from compiler and static/DLL setting and setup.h into directory with name that contains other settings: @@ -806,7 +873,7 @@ to setup.h, you should do them in this file, _not_ in include\wx\msw\setup.h. If you set CFG to something, the value is appended to directory names. E.g. for CFG=MyBuild, you'll have object files in - + build\msw\bcc_mswMyBuild build\msw\bcc_mswdllMyBuild etc. @@ -818,7 +885,7 @@ and libraries in etc. By now it is clear what CFG is for: builds with different CFG settings don't -share any files and they use different setup.h files. This allows you to e.g. +share any files and they use different setup.h files. This allows you to e.g. 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 conflicts between the files).