More style issues

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

diff --git a/docs/wine/install.txt b/docs/wine/install.txt
index 8663d9b939d35cb5e46819301cb62a2da2981881..29fc50154b98bcf5dbcc006b7f418db3e7c8e57c 100644 (file)
--- a/docs/wine/install.txt
+++ b/docs/wine/install.txt
@@ -7,11 +7,14 @@
 ----------------
 
 Most C++ compilers cannot compile the WINE sources yet (this includes
 ----------------
 
 Most C++ compilers cannot compile the WINE sources yet (this includes

-all versions of g++ and ecgs) so you have to make a minimal change
+all versions of g++ and egcs) so you have to make a minimal change

 and recompile all of WINE in order to get anywhere.
 
 and recompile all of WINE in order to get anywhere.
 

+(Note: this information may be out of date now. See notes at
+the bottom of this file.)
+

 This change has do be applied to the /include/windef.h file, line 59
 This change has do be applied to the /include/windef.h file, line 59

-in the section "Calling convention defintions", where the sources
+in the section "Calling convention definitions", where the sources

 reads:
 
 #if __i386__
 reads:
 
 #if __i386__


@@ -28,29 +31,54 @@ change disables the Windows native calling convention.
 * The most simple case
 -----------------------
 
 * The most simple case
 -----------------------
 

-If you compile wxWindows on Unix for the first time and don't like to read 
+If you compile wxWindows on Linux for the first time and don't like to read 

 install instructions just do (in the base dir):
 
 install instructions just do (in the base dir):
 

-./configure --with-wine
-make
-su <type root password>
-make install
-ldconfig
-exit
+> ./configure --with-wine
+> make
+> su <type root password>
+> make install
+> ldconfig
+> exit
+
+On all variants of Unix except Linux (and maybe except *BSD), shared libraries 
+are not supported out of the box due to the utter stupidity of libtool, so you'll 
+have to do this to get shared library support:
+
+> ./configure --with-wine --disable-static --enable-shared
+
+Then you'll have to edit the wrongly created libtool script. There are two
+important entries with respect to shared library creation, which are
+
+  archive_cmds="\$LD -shared ....
+  archive_expsym_cmds="\$LD -shared ....
+  
+which should be something like
+
+  archive_cmds="\$CC -shared ....
+  archive_expsym_cmds="\$CC -shared ....
+  
+Afterwards you can continue with
+
+> make
+> su <type root password>
+> make install
+> ldconfig
+> exit

 
 If you want to remove wxWindows on Unix you can do this:
 
 
 If you want to remove wxWindows on Unix you can do this:
 

-su <type root password>
-make uninstall
-ldconfig
-exit
+> su <type root password>
+> make uninstall
+> ldconfig
+> exit

 
 * The expert case
 -----------------
 
 If you want to do some more serious cross-platform programming with wxWindows, 
 such as for GTK and Motif, you can now build two complete libraries and use 
 
 * The expert case
 -----------------
 
 If you want to do some more serious cross-platform programming with wxWindows, 
 such as for GTK and Motif, you can now build two complete libraries and use 

-them concurretly. For this end, you have to create a directory for each build 
+them concurrently. For this end, you have to create a directory for each build 

 of wxWindows - you may also want to create different versions of wxWindows
 and test them concurrently. Most typically, this would be a version configured 
 with --enable-debug_flag and one without. Note, that only one build can currently 
 of wxWindows - you may also want to create different versions of wxWindows
 and test them concurrently. Most typically, this would be a version configured 
 with --enable-debug_flag and one without. Note, that only one build can currently 


@@ -83,7 +111,7 @@ wxWINE doesn't work yet as WINE isn't really up to the task yet.
 
 You get errors during compilation: The reason is that you probably have a broken 
 compiler, which includes almost everything that is called gcc. If you use gcc 2.8 
 
 You get errors during compilation: The reason is that you probably have a broken 
 compiler, which includes almost everything that is called gcc. If you use gcc 2.8 

-you have to disable optimsation as the compiler will give up with an internal 
+you have to disable optimisation as the compiler will give up with an internal 

 compiler error.
 
 If there is just any way for you to use egcs, use egcs. We cannot fix gcc.
 compiler error.
 
 If there is just any way for you to use egcs, use egcs. We cannot fix gcc.


@@ -128,18 +156,18 @@ You can get the newest version of the WINE from the WINE homepage at:
 -----------------------------
 
 Usage:
 -----------------------------
 
 Usage:

-       ./configure options
+    ./configure options

 
 If you want to use system's C and C++ compiler,
 set environment variables CC and CCC as
 
 
 If you want to use system's C and C++ compiler,
 set environment variables CC and CCC as
 

-       % setenv CC cc
-       % setenv CCC CC
-       % ./configure options
+    % setenv CC cc
+    % setenv CCC CC
+    % ./configure options

 
 to see all the options please use:
 
 
 to see all the options please use:
 

-       ./configure --help
+    ./configure --help

 
 The basic philosophy is that if you want to use different
 configurations, like a debug and a release version, 
 
 The basic philosophy is that if you want to use different
 configurations, like a debug and a release version, 


@@ -162,62 +190,62 @@ Given below are the commands to change the default behaviour,
 i.e. if it says "--disable-threads" it means that threads
 are enabled by default.
 
 i.e. if it says "--disable-threads" it means that threads
 are enabled by default.
 

-Many of the confiugre options have been thoroughly tested
+Many of the configure options have been thoroughly tested

 in wxWindows snapshot 6, but not yet all (ODBC not).
 
 You must do this by running configure with either of:
 
 in wxWindows snapshot 6, but not yet all (ODBC not).
 
 You must do this by running configure with either of:
 

-        --with-wine              Use the WINE library
-       
+    --with-wine              Use the WINE library
+    

 The following options handle the kind of library you want to build.
 
 The following options handle the kind of library you want to build.
 

-       --enable-threads        Compile without thread support. Threads
-                               support is also required for the
-                               socket code to work.
-
-       --disable-shared        Do not create shared libraries.
-
-       --disable-optimise      Do not optimise the code. Can
-                               sometimes be useful for debugging
-                               and is required on some architectures
-                               such as Sun with gcc 2.8.X which
-                               would otherwise produce segvs.
-
-       --enable-profile        Add profiling info to the object 
-                               files. Currently broken, I think.
-                               
-       --enable-no_rtti        Enable compilation without creation of
-                               C++ RTTI information in object files. 
-                               This will speed-up compilation and reduce 
-                               binary size.
-                               
-       --enable-no_exceptions  Enable compilation without creation of
-                               C++ exception information in object files. 
-                               This will speed-up compilation and reduce 
-                               binary size. Also fewer crashes during the
-                               actual compilation...
-                               
-       --enable-mem_tracing    Add built-in memory tracing. 
-                               
-       --enable-dmalloc        Use the dmalloc memory debugger.
-                               Read more at www.letters.com/dmalloc/
-                               
-       --enable-debug_info     Add debug info to object files and
-                               executables for use with debuggers
-                               such as gdb (or its many frontends).
-
-       --enable-debug_flag     Define __DEBUG__ and __WXDEBUG__ when
-                               compiling. This enable wxWindows' very
-                               useful internal debugging tricks (such
-                               as automatically reporting illegal calls)
-                               to work. Note that program and library
-                               must be compiled with the same debug 
-                               options.
+    --enable-threads        Compile with thread support. Threads
+                            support is also required for the
+                            socket code to work.
+
+    --disable-shared        Do not create shared libraries.
+
+    --disable-optimise        Do not optimise the code. Can
+                            sometimes be useful for debugging
+                            and is required on some architectures
+                            such as Sun with gcc 2.8.X which
+                            would otherwise produce segvs.
+
+    --enable-profile        Add profiling info to the object 
+                            files. Currently broken, I think.
+                
+    --enable-no_rtti        Enable compilation without creation of
+                            C++ RTTI information in object files. 
+                            This will speed-up compilation and reduce 
+                            binary size.
+                
+    --enable-no_exceptions  Enable compilation without creation of
+                            C++ exception information in object files. 
+                            This will speed-up compilation and reduce 
+                            binary size. Also fewer crashes during the
+                            actual compilation...
+                
+    --enable-mem_tracing    Add built-in memory tracing. 
+                
+    --enable-dmalloc        Use the dmalloc memory debugger.
+                            Read more at www.letters.com/dmalloc/
+                
+    --enable-debug_info     Add debug info to object files and
+                            executables for use with debuggers
+                            such as gdb (or its many frontends).
+
+    --enable-debug_flag     Define __DEBUG__ and __WXDEBUG__ when
+                            compiling. This enable wxWindows' very
+                            useful internal debugging tricks (such
+                            as automatically reporting illegal calls)
+                            to work. Note that program and library
+                            must be compiled with the same debug 
+                            options.

 
 * Feature Options
 -------------------
 
 
 * Feature Options
 -------------------
 

-Many of the confiugre options have been thoroughly tested
+Many of the configure options have been thoroughly tested

 in wxWindows snapshot 6, but not yet all (ODBC not).
 
 When producing an executable that is linked statically with wxGTK
 in wxWindows snapshot 6, but not yet all (ODBC not).
 
 When producing an executable that is linked statically with wxGTK


@@ -226,38 +254,38 @@ drastically reduced by removing features from wxWindows that
 are not used in your program. The most relevant such features
 are
 
 are not used in your program. The most relevant such features
 are
 

-       --without-libpng        Disables PNG image format code.
-       
-       --without-libjpeg       Disables JPEG image format code.
-       
-{      --without-odbc          Disables ODBC code. Not yet. }
-       
-        --disable-resources     Disables the use of *.wxr type
-                               resources.
-               
-       --disable-threads       Disables threads. Will also
-                               disable sockets.
-
-       --disable-sockets       Disables sockets.
-
-       --disable-dnd           Disables Drag'n'Drop.
-       
-       --disable-clipboard     Disables Clipboard.
-       
-       --disable-serial        Disables object instance serialiasation.
-       
-       --disable-streams       Disables the wxStream classes.
-       
-       --disable-file          Disables the wxFile class.
-       
-       --disable-textfile      Disables the wxTextFile class.
-       
-       --disable-intl          Disables the internationalisation.
-       
-       --disable-validators    Disables validators.
-       
-       --disable-accel         Disables accel.
-       
+    --without-libpng    Disables PNG image format code.
+    
+    --without-libjpeg    Disables JPEG image format code.
+    
+{   --without-odbc          Disables ODBC code. Not yet. }
+    
+    --disable-resources     Disables the use of *.wxr type
+                            resources.
+        
+    --disable-threads       Disables threads. Will also
+                            disable sockets.
+
+    --disable-sockets       Disables sockets.
+
+    --disable-dnd           Disables Drag'n'Drop.
+    
+    --disable-clipboard     Disables Clipboard.
+    
+    --disable-serial        Disables object instance serialisation.
+    
+    --disable-streams       Disables the wxStream classes.
+    
+    --disable-file          Disables the wxFile class.
+    
+    --disable-textfile      Disables the wxTextFile class.
+    
+    --disable-intl          Disables the internationalisation.
+    
+    --disable-validators    Disables validators.
+    
+    --disable-accel         Disables accel.
+    

 Apart from disabling certain features you can very often "strip"
 the program of its debugging information resulting in a significant
 reduction in size.
 Apart from disabling certain features you can very often "strip"
 the program of its debugging information resulting in a significant
 reduction in size.


@@ -271,30 +299,30 @@ or ~/wxWin or whatever)
 Now the makefiles are created (by configure) and you can compile 
 the library by typing:
 
 Now the makefiles are created (by configure) and you can compile 
 the library by typing:
 

-       make
+    make

 
 make yourself some coffee, as it will take some time. On an old
 386SX possibly two weeks. During compilation, you'll get a few 
 warning messages depending in your compiler.
 
 If you want to be more selective, you can change into a specific
 
 make yourself some coffee, as it will take some time. On an old
 386SX possibly two weeks. During compilation, you'll get a few 
 warning messages depending in your compiler.
 
 If you want to be more selective, you can change into a specific

-directiry and type "make" there.
+directory and type "make" there.

 
 

-Then you may install the library and it's header files under
+Then you may install the library and its header files under

 /usr/local/include/wx and /usr/local/lib respectively. You
 have to log in as root (i.e. run "su" and enter the root
 password) and type
 
 /usr/local/include/wx and /usr/local/lib respectively. You
 have to log in as root (i.e. run "su" and enter the root
 password) and type
 

-        make install   
+        make install    

 
 You can remove any traces of wxWindows by typing
 
         make uninstall
 
 You can remove any traces of wxWindows by typing
 
         make uninstall

-       
+    

 If you want to save disk space by removing unnecessary
 object-files:
 
 If you want to save disk space by removing unnecessary
 object-files:
 

-        make clean
+     make clean

 
 in the various directories will do the work for you.
 
 
 in the various directories will do the work for you.
 


@@ -318,10 +346,10 @@ minimal.o: minimal.cpp mondrian.xpm
     $(CC) `wx-config --cflags` -c minimal.cpp -o minimal.o
 
 clean: 
     $(CC) `wx-config --cflags` -c minimal.cpp -o minimal.o
 
 clean: 

-       rm -f *.o minimal
+    rm -f *.o minimal

 
 This is certain to become the standard way unless we decide
 
 This is certain to become the standard way unless we decide

-to sitch to tmake.
+to stick to tmake.

 
 2) The other way creates a project within the source code 
 directories of wxWindows. For this endeavour, you'll need
 
 2) The other way creates a project within the source code 
 directories of wxWindows. For this endeavour, you'll need


@@ -345,5 +373,38 @@ go ahead yourself :-)
 In the hope that it will be useful,
 
         Robert Roebling <roebling@sun2.ruf.uni-freiburg.de>
 In the hope that it will be useful,
 
         Robert Roebling <roebling@sun2.ruf.uni-freiburg.de>

-       
-       
+    
+
+Addition notes by Julian Smart, August 2002
+===========================================    
+
+I've fixed some compile errors, and got as far as
+compiling wxWINE, but actually linking a sample will take
+further work.
+
+To compile wxWINE, export these variables:
+
+export CPPFLAGS=-I/usr/local/include/wine
+export LDFLAGS=-L/usr/local/lib/wine
+
+and configure with:
+
+configure --disable-static --enable-shared --enable-gui \
+ --with-wine --without-libpng --enable-debug_flag --enable-log \
+ --enable-debug_info --enable-ole --enable-clipboard --enable-dataobj \
+ --enable-debug --enable-threads --disable-sockets \
+ --with-libjpeg --enable-debug_cntxt
+
+Compiling a sample won't work yet because 'winebuild' needs
+to be called, and the resuling C file compiled and linked.
+Plus, Windows DLLs need to be imported.
+
+Note that the documentation on the WINE web site on using
+winebuild is out of date (August 2002) -- the spec file no
+longer supports import and type keywords. Instead look at
+samples in the WINE 'programs' directory for inspiration
+and compile options to use. It's probable that the
+wxWINE library will need recompiling with different options.
+
+Any progress on this front will be very welcome.
+