ddraw/tests: Add test for branch instruction with non-zero offset.
[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
14 2. QUICK START
15
16 Whenever you compile from source, it is recommended to use the Wine
17 Installer to build and install Wine.  From the top-level directory
18 of the Wine source (which contains this file), run:
19
20 ./tools/wineinstall
21
22 Run programs as "wine program".  For more information and problem
23 resolution, read the rest of this file, the Wine man page, and
24 especially the wealth of information found at http://www.winehq.org.
25
26
27 3. REQUIREMENTS
28
29 To compile and run Wine, you must have one of the following:
30
31   Linux version 2.0.36 or above
32   FreeBSD 6.2 or later
33   Solaris x86 2.5 or later
34   NetBSD-current
35   Mac OS X 10.4 or later
36
37 As Wine requires kernel-level thread support to run, only the operating
38 systems mentioned above are supported.  Other operating systems which
39 support kernel threads may be supported in the future.
40
41 Linux info:
42   While Linux 2.2.x should still work and Linux 2.0.x may still work
43   (older 2.0.x versions had thread-related crashes),
44   it's best to have a current kernel such as 2.4.x or 2.6.x.
45
46 FreeBSD info:
47   Wine should build on FreeBSD 5.x, but versions before FreeBSD 7.0 will
48   generally not work properly. FreeBSD 6.3 has patches available to allow
49   Wine to run. See <http://wiki.freebsd.org/Wine> for more information.
50  
51   More information can be found in the FreeBSD ports tree at
52   <ftp://ftp.freebsd.org/pub/FreeBSD/ports/ports/emulators/wine/>.
53
54 Solaris info:
55   You will most likely need to build Wine with the GNU toolchain
56   (gcc, gas, etc.). Warning : installing gas does *not* ensure that it
57   will be used by gcc. Recompiling gcc after installing gas or
58   symlinking cc, as and ld to the gnu tools is said to be necessary.
59
60 NetBSD info:
61   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
62   turned on in your kernel.
63
64 Mac OS X info:
65   You need Xcode 2.4 or later to build properly on x86.
66
67
68 Supported file systems:
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
71   also been reported using files accessed through Samba. Also, NTFS does not
72   provide all the file system features needed by some applications.
73   Using a native Linux file system such as ext3 is recommended.
74
75 Basic requirements:
76   You need to have the X11 development include files installed
77   (called xlib6g-dev in Debian and XFree86-devel in Red Hat).
78
79 Build tool requirements:
80   On x86 Systems gcc >= 2.7.2 is required.
81   Versions earlier than 2.7.2.3 may have problems when certain files
82   are compiled with optimization, often due to problems with header file
83   management.
84
85   Of course you also need "make" (most likely GNU make).
86
87   You also need flex version 2.5 or later and bison.
88
89 Optional support libraries:
90   Run ./configure --verbose to see the optional libraries that could
91   be used but aren't found on your system.
92
93
94 4. COMPILATION
95
96 In case you chose to not use wineinstall, run the following commands
97 to build Wine:
98
99 ./configure
100 make depend
101 make
102
103 This will build the program "wine" and numerous support libraries/binaries.
104 The program "wine" will load and run Windows executables.
105 The library "libwine" ("Winelib") can be used to compile and link
106 Windows source code under Unix.
107
108 To see compile configuration options, do ./configure --help.
109
110 To upgrade to a new release by using a patch file, first cd to the
111 top-level directory of the release (the one containing this README
112 file). Then do a "make clean", and patch the release with:
113
114     bunzip2 -c patch-file | patch -p1
115
116 where "patch-file" is the name of the patch file (something like
117 wine-0.9.x.diff.bz2). You can then re-run "./configure", and then
118 run "make depend && make".
119
120
121 5. SETUP
122
123 Once Wine has been built correctly, you can do "make install"; this
124 will install the wine executable, the Wine man page, and a few other
125 needed files.
126
127 Don't forget to uninstall any conflicting previous Wine installation
128 first.  Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
129 before installing.
130
131 See the Support area at http://www.winehq.org/ for configuration
132 hints.
133
134 In case of library loading errors
135 (e.g. "Error while loading shared libraries: libntdll.so"), make sure
136 to add the library path to /etc/ld.so.conf and run ldconfig as root.
137
138
139 6. RUNNING PROGRAMS
140
141 When invoking Wine, you may specify the entire path to the executable,
142 or a filename only.
143
144 For example: to run Solitaire:
145
146         wine sol                   (using the search Path as specified in
147         wine sol.exe                the config file to locate the file)
148
149         wine c:\\windows\\sol.exe  (using DOS filename syntax)
150
151         wine /usr/windows/sol.exe  (using Unix filename syntax)
152
153         wine sol.exe /parameter1 -parameter2 parameter3
154                                    (calling program with parameters)
155
156 Wine is not yet complete, so several programs may crash. In that crash
157 you will be dropped into the debugger so that you can investigate and
158 fix the problem.  For more information on how to do this, please check
159 the debugging section of the Wine Developer's Guide.
160
161
162 7. GETTING MORE INFORMATION
163
164 WWW:    A great deal of information about Wine is available from WineHQ at
165         http://www.winehq.org/ : various Wine Guides, application database,
166         bug tracking. This is probably the best starting point.
167
168 FAQ:    The Wine FAQ is located at http://www.winehq.org/FAQ
169
170 Usenet: You can discuss Wine-related issues and get help
171         on comp.emulators.ms-windows.wine.
172
173 Bugs:   Report bugs to Wine Bugzilla at http://bugs.winehq.org
174         Please search the bugzilla database to check whether your
175         problem is already found before posting a bug report.  You can
176         also post bug reports to comp.emulators.ms-windows.wine.
177
178 IRC:    Online help is available at channel #WineHQ on irc.freenode.net.
179
180 GIT:    The current Wine development tree is available through GIT.
181         Go to http://www.winehq.org/site/git for more information.
182
183 Mailing lists:
184         There are several mailing lists for Wine users and developers;
185         see http://www.winehq.org/forums for more information.
186
187 Wiki:   The Wine Wiki is located at http://wiki.winehq.org
188
189 If you add something, or fix a bug, please send a patch (in 'diff -u'
190 format) to wine-patches@winehq.org list for inclusion in the next
191 release.
192
193 --
194 Alexandre Julliard
195 julliard@winehq.org