winedbg: Only check for break/watch points on first chance exceptions.
[wine] / README
CommitLineData
3a5816f8
AJ
11. INTRODUCTION
2
692389d0
DR
3Wine is a program which allows running Microsoft Windows programs
4(including DOS, Windows 3.x and Win32 executables) on Unix. It
0ff60a08 5consists of a program loader which loads and executes a Microsoft
3d2a38cf
AM
6Windows binary, and a library (called Winelib) that implements Windows
7API calls using their Unix or X11 equivalents. The library may also
8be used for porting Win32 code into native Unix executables.
3a5816f8 9
89894ffc
MG
10Wine is free software, released under the GNU LGPL; see the file
11LICENSE for the details.
3a5816f8 12
4e474034 13
d6baf1bb 142. QUICK START
3a5816f8 15
581fc926 16Whenever you compile from source, it is recommended to use the Wine
a0ff2b4a
AM
17Installer to build and install Wine. From the top-level directory
18of the Wine source (which contains this file), run:
d6baf1bb
AJ
19
20./tools/wineinstall
21
4e474034
AJ
22Run programs as "wine program". For more information and problem
23resolution, read the rest of this file, the Wine man page, and
12f9bb7a 24especially the wealth of information found at http://www.winehq.org.
d6baf1bb 25
4e474034 26
d6baf1bb 273. REQUIREMENTS
401710d7 28
0ff60a08 29To compile and run Wine, you must have one of the following:
f41aeca9 30
c08b948f 31 Linux version 2.0.36 or above
a93fb4a0 32 FreeBSD 5.3 or later
c08b948f
AM
33 Solaris x86 2.5 or later
34 NetBSD-current
bb8e625b 35 Mac OS X 10.4 or later
c08b948f
AM
36
37As Wine requires kernel-level thread support to run, only the operating
38systems mentioned above are supported.
39Other operating systems which support kernel threads may be supported
40in the future.
f41aeca9 41
c9ec8846 42Linux info:
c08b948f
AM
43 While Linux 2.2.x should still work and Linux 2.0.x may still work
44 (older 2.0.x versions had thread-related crashes),
4fe7ee8c 45 it's best to have a current kernel such as 2.4.x or 2.6.x.
c9ec8846
AM
46
47FreeBSD info:
e5f6637e
GP
48 Wine should build on FreeBSD 4.x and FreeBSD 5.x, but versions before
49 FreeBSD 5.3 will generally not work properly.
a93fb4a0
GP
50
51 More information can be found in the FreeBSD ports tree at
52 <ftp://ftp.freebsd.org/pub/FreeBSD/ports/ports/emulators/wine/>.
c9ec8846
AM
53
54Solaris info:
d2b22894 55 You will most likely need to build Wine with the GNU toolchain
2895e7f4 56 (gcc, gas, etc.). Warning : installing gas does *not* ensure that it
a5589d56 57 will be used by gcc. Recompiling gcc after installing gas or
2895e7f4
GP
58 symlinking cc, as and ld to the gnu tools is said to be necessary.
59
9048c49b
BJY
60NetBSD info:
61 Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
62 turned on in your kernel.
63
bb8e625b 64Mac OS X info:
4e474034 65 You need Xcode 2.4 or later to build properly on x86.
c08b948f
AM
66
67
68Supported file systems:
2895e7f4
GP
69 Wine should run on most file systems. However, Wine will fail to start
70 if umsdos is used for the /tmp directory. A few compatibility problems have
a0ff2b4a
AM
71 also been reported using files accessed through Samba. Also, as NTFS
72 can only be used safely with readonly access for now, we recommend against
73 using NTFS, as Windows programs need write access almost everywhere.
74 In case of NTFS files, copy over to a writable location.
c9ec8846 75
c08b948f
AM
76Basic requirements:
77 You need to have the X11 development include files installed
2d979b6a 78 (called xlib6g-dev in Debian and XFree86-devel in Red Hat).
ca851392 79
c08b948f
AM
80Build tool requirements:
81 On x86 Systems gcc >= 2.7.2 is required.
82 Versions earlier than 2.7.2.3 may have problems when certain files
83 are compiled with optimization, often due to problems with header file
4e474034 84 management.
c165bca8 85
c08b948f 86 Of course you also need "make" (most likely GNU make).
c9ec8846 87
2d979b6a 88 You also need flex version 2.5 or later and bison.
a5589d56 89
c08b948f 90Optional support libraries:
4e474034
AJ
91 Run ./configure --verbose to see the optional libraries that could
92 be used but aren't found on your system.
93
6abb89c3 94
d6baf1bb 954. COMPILATION
a69b88b2 96
c9ec8846
AM
97In case you chose to not use wineinstall, run the following commands
98to build Wine:
401710d7 99
d6baf1bb
AJ
100./configure
101make depend
102make
103
a5589d56 104This will build the program "wine" and numerous support libraries/binaries.
a0b2b1d0 105The program "wine" will load and run Windows executables.
1af53cbb
AM
106The library "libwine" ("Winelib") can be used to compile and link
107Windows source code under Unix.
d6baf1bb 108
1af53cbb 109To see compile configuration options, do ./configure --help.
e2bfa4c7 110
3a5816f8
AJ
111To upgrade to a new release by using a patch file, first cd to the
112top-level directory of the release (the one containing this README
113file). Then do a "make clean", and patch the release with:
114
4e474034 115 bunzip2 -c patch-file | patch -p1
f41aeca9 116
3a5816f8 117where "patch-file" is the name of the patch file (something like
4e474034 118wine-0.9.x.diff.bz2). You can then re-run "./configure", and then
d6baf1bb 119run "make depend && make".
5f721f81 120
4e474034 121
d6baf1bb 1225. SETUP
8d24ae6d 123
7e56f684 124Once Wine has been built correctly, you can do "make install"; this
38a3d264
JJ
125will install the wine executable, the Wine man page, and a few other
126needed files.
7e56f684 127
de53c487
AM
128Don't forget to uninstall any conflicting previous Wine installation
129first. Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
130before installing.
131
12f9bb7a
DP
132See the Support area at http://www.winehq.org/ for configuration
133hints.
8d24ae6d 134
a0ff2b4a
AM
135In case of library loading errors
136(e.g. "Error while loading shared libraries: libntdll.so"), make sure
137to add the library path to /etc/ld.so.conf and run ldconfig as root.
138
4e474034 139
d6baf1bb 1406. RUNNING PROGRAMS
8d24ae6d 141
38a3d264 142When invoking Wine, you may specify the entire path to the executable,
8d24ae6d
AJ
143or a filename only.
144
692389d0 145For example: to run Solitaire:
8d24ae6d 146
c08b948f
AM
147 wine sol (using the search Path as specified in
148 wine sol.exe the config file to locate the file)
149
150 wine c:\\windows\\sol.exe (using DOS filename syntax)
5f721f81 151
c08b948f 152 wine /usr/windows/sol.exe (using Unix filename syntax)
5f721f81 153
f950d973 154 wine sol.exe /parameter1 -parameter2 parameter3
c08b948f 155 (calling program with parameters)
f41aeca9 156
4e474034
AJ
157Wine is not yet complete, so several programs may crash. In that crash
158you will be dropped into the debugger so that you can investigate and
159fix the problem. For more information on how to do this, please check
160the debugging section of the Wine Developer's Guide.
8d24ae6d 161
a6d83eba 162
12f9bb7a 1637. GETTING MORE INFORMATION
46ea8b3f 164
3d2a38cf 165WWW: A great deal of information about Wine is available from WineHQ at
c0232546 166 http://www.winehq.org/ : various Wine Guides, application database,
3d2a38cf 167 bug tracking. This is probably the best starting point.
8cd93514 168
c0232546 169FAQ: The Wine FAQ is located at http://www.winehq.org/FAQ
46ea8b3f 170
ac3a9a32
AP
171Usenet: You can discuss Wine-related issues and get help
172 on comp.emulators.ms-windows.wine.
0ff60a08 173
c0232546 174Bugs: Report bugs to Wine Bugzilla at http://bugs.winehq.org
ac3a9a32
AP
175 Please search the bugzilla database to check whether your
176 problem is already found before posting a bug report. You can
177 also post bug reports to comp.emulators.ms-windows.wine.
46ea8b3f 178
344ed41d 179IRC: Online help is available at channel #WineHQ on irc.freenode.net.
8cd93514 180
4e474034
AJ
181GIT: The current Wine development tree is available through GIT.
182 Go to http://www.winehq.org/site/git for more information.
8d24ae6d 183
3d2a38cf 184Mailing lists:
4e474034
AJ
185 There are several mailing lists for Wine users and developers;
186 see http://www.winehq.org/forums for more information.
187
188Wiki: The Wine Wiki is located at http://wiki.winehq.org
3d2a38cf 189
b6e84187 190If you add something, or fix a bug, please send a patch (in 'diff -u'
c0232546 191format) to wine-patches@winehq.org list for inclusion in the next
ac3a9a32 192release.
8d24ae6d 193
3a5816f8
AJ
194--
195Alexandre Julliard
c0232546 196julliard@winehq.org