msvcrt: Save esp before calling catch block and restore afterwards.
[wine] / README
1 1. INTRODUCTION
2
3 Wine is a program which allows running Microsoft Windows programs
4 (including DOS, Windows 3.x and Win32 executables) on Unix.  It
5 consists of a program loader which loads and executes a Microsoft
6 Windows binary, and a library (called Winelib) that implements Windows
7 API calls using their Unix or X11 equivalents.  The library may also
8 be used for porting Win32 code into native Unix executables.
9
10 Wine is free software, released under the GNU LGPL; see the file
11 LICENSE for the details.
12
13 2. QUICK START
14
15 Whenever you compile from source, it is recommended to use the Wine
16 Installer to build and install Wine.  From the top-level directory
17 of the Wine source (which contains this file), run:
18
19 ./tools/wineinstall
20
21 Run programs as "wine [options] program".  For more information and
22 problem resolution, read the rest of this file, the Wine man page, and
23 especially the wealth of information found at http://www.winehq.org.
24
25 3. REQUIREMENTS
26
27 To compile and run Wine, you must have one of the following:
28
29   Linux version 2.0.36 or above
30   FreeBSD 5.3 or later
31   Solaris x86 2.5 or later
32   NetBSD-current
33
34 As Wine requires kernel-level thread support to run, only the operating
35 systems mentioned above are supported.
36 Other operating systems which support kernel threads may be supported
37 in the future.
38
39 Linux info:
40   While Linux 2.2.x should still work and Linux 2.0.x may still work
41   (older 2.0.x versions had thread-related crashes),
42   it's best to have a current kernel such as 2.4.x.
43
44 FreeBSD info:
45   Wine should build on FreeBSD 4.x and FreeBSD 5.x, but versions before
46   FreeBSD 5.3 will generally not work properly.
47  
48   More information can be found in the FreeBSD ports tree at
49   <ftp://ftp.freebsd.org/pub/FreeBSD/ports/ports/emulators/wine/>.
50
51 Solaris info:
52   You will most likely need to build Wine with the GNU toolchain
53   (gcc, gas, etc.). Warning : installing gas does *not* ensure that it
54   will be used by gcc. Recompiling gcc after installing gas or
55   symlinking cc, as and ld to the gnu tools is said to be necessary.
56
57 NetBSD info:
58   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
59   turned on in your kernel.
60
61
62
63 Supported file systems:
64   Wine should run on most file systems. However, Wine will fail to start
65   if umsdos is used for the /tmp directory. A few compatibility problems have
66   also been reported using files accessed through Samba. Also, as NTFS
67   can only be used safely with readonly access for now, we recommend against
68   using NTFS, as Windows programs need write access almost everywhere.
69   In case of NTFS files, copy over to a writable location.
70
71 Basic requirements:
72   You need to have the X11 development include files installed
73   (called xlib6g-dev in Debian and XFree86-devel in RedHat).
74
75 Build tool requirements:
76   On x86 Systems gcc >= 2.7.2 is required.
77   Versions earlier than 2.7.2.3 may have problems when certain files
78   are compiled with optimization, often due to problems with header file
79   management. pgcc currently doesn't work with Wine. The cause of this problem
80   is unknown.
81
82   Of course you also need "make" (most likely GNU make).
83
84   You also need flex version 2.5 or later and bison.  If you are
85   using RedHat or Debian, install the flex and bison packages.
86
87 Optional support libraries:
88   If you want CUPS printing support, please install both cups and cups-devel
89   packages.
90
91 4. COMPILATION
92
93 In case you chose to not use wineinstall, run the following commands
94 to build Wine:
95
96 ./configure
97 make depend
98 make
99
100 This will build the program "wine" and numerous support libraries/binaries.
101 The program "wine" will load and run Windows executables.
102 The library "libwine" ("Winelib") can be used to compile and link
103 Windows source code under Unix.
104
105 To see compile configuration options, do ./configure --help.
106
107 To upgrade to a new release by using a patch file, first cd to the
108 top-level directory of the release (the one containing this README
109 file). Then do a "make clean", and patch the release with:
110
111     gunzip -c patch-file | patch -p1
112
113 where "patch-file" is the name of the patch file (something like
114 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
115 run "make depend && make".
116
117 5. SETUP
118
119 Once Wine has been built correctly, you can do "make install"; this
120 will install the wine executable, the Wine man page, and a few other
121 needed files.
122
123 Don't forget to uninstall any conflicting previous Wine installation
124 first.  Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
125 before installing.
126
127 See the Support area at http://www.winehq.org/ for configuration
128 hints.
129
130 In case of library loading errors
131 (e.g. "Error while loading shared libraries: libntdll.so"), make sure
132 to add the library path to /etc/ld.so.conf and run ldconfig as root.
133
134 6. RUNNING PROGRAMS
135
136 When invoking Wine, you may specify the entire path to the executable,
137 or a filename only.
138
139 For example: to run Solitaire:
140
141         wine sol                   (using the search Path as specified in
142         wine sol.exe                the config file to locate the file)
143
144         wine c:\\windows\\sol.exe  (using DOS filename syntax)
145
146         wine /usr/windows/sol.exe  (using Unix filename syntax)
147
148         wine sol.exe /parameter1 -parameter2 parameter3
149                                    (calling program with parameters)
150
151 Note: the path of the file will also be added to the path when
152       a full name is supplied on the commandline.
153
154 Wine is not yet complete, so several programs may crash. Provided you set up
155 winedbg correctly according to documentation/debugger.sgml, you will be dropped
156 into a debugger so that you can investigate and fix the problem.
157 For more information on how to do this, please read the file
158 documentation/debugging.sgml.
159
160 You should backup all your important files that you give Wine access
161 to, or use a special Wine copy of them, as there have been some cases
162 of users reporting file corruption. Do NOT run Explorer, for instance,
163 if you don't have a proper backup, as it renames/cripples several
164 directories sometimes. Not even other MS apps such as e.g. Messenger are safe,
165 as they launch Explorer somehow. This particular corruption (!$!$!$!$.pfr)
166 can at least partially be fixed by using
167 http://home.nexgo.de/andi.mohr/download/decorrupt_explorer
168
169 7. GETTING MORE INFORMATION
170
171 WWW:    A great deal of information about Wine is available from WineHQ at
172         http://www.winehq.org/ : various Wine Guides, application database,
173         bug tracking. This is probably the best starting point.
174
175 FAQ:    The Wine FAQ is located at http://www.winehq.org/FAQ
176
177 Usenet: You can discuss Wine-related issues and get help
178         on comp.emulators.ms-windows.wine.
179
180 Bugs:   Report bugs to Wine Bugzilla at http://bugs.winehq.org
181         Please search the bugzilla database to check whether your
182         problem is already found before posting a bug report.  You can
183         also post bug reports to comp.emulators.ms-windows.wine.
184         Please read the file documentation/bugs.sgml to see what
185         information is required.
186
187 IRC:    Online help is available at channel #WineHQ on irc.freenode.net.
188
189 CVS:    The current Wine development tree is available through CVS.
190         Go to http://www.winehq.org/cvs for more information.
191
192 Mailing lists:
193         There are several mailing lists for Wine developers; see
194         http://www.winehq.org/forums for more information.
195
196 If you add something, or fix a bug, please send a patch (in 'diff -u'
197 format) to wine-patches@winehq.org list for inclusion in the next
198 release.
199
200 --
201 Alexandre Julliard
202 julliard@winehq.org