README 6.5 KB
Newer Older
Alexandre Julliard's avatar
Alexandre Julliard committed
1 2
1. INTRODUCTION

3 4
Wine is a program which allows running Microsoft Windows programs
(including DOS, Windows 3.x and Win32 executables) on Unix.  It
5
consists of a program loader which loads and executes a Microsoft
Andreas Mohr's avatar
Andreas Mohr committed
6 7 8
Windows binary, and a library (called Winelib) that implements Windows
API calls using their Unix or X11 equivalents.  The library may also
be used for porting Win32 code into native Unix executables.
Alexandre Julliard's avatar
Alexandre Julliard committed
9

Martin Garton's avatar
Martin Garton committed
10 11
Wine is free software, released under the GNU LGPL; see the file
LICENSE for the details.
Alexandre Julliard's avatar
Alexandre Julliard committed
12

13

14
2. QUICK START
Alexandre Julliard's avatar
Alexandre Julliard committed
15

Andreas Mohr's avatar
Andreas Mohr committed
16
Whenever you compile from source, it is recommended to use the Wine
17 18
Installer to build and install Wine.  From the top-level directory
of the Wine source (which contains this file), run:
19 20 21

./tools/wineinstall

22 23
Run programs as "wine program".  For more information and problem
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
Alexandre Julliard's avatar
Alexandre Julliard committed
28

29
To compile and run Wine, you must have one of the following:
Alexandre Julliard's avatar
Alexandre Julliard committed
30

31
  Linux version 2.0.36 or above
32
  FreeBSD 6.2 or later
33 34
  Solaris x86 2.5 or later
  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 39
systems mentioned above are supported.  Other operating systems which
support kernel threads may be supported in the future.
Alexandre Julliard's avatar
Alexandre Julliard committed
40

Andreas Mohr's avatar
Andreas Mohr committed
41
Linux info:
42 43
  While Linux 2.2.x should still work and Linux 2.0.x may still work
  (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.
Andreas Mohr's avatar
Andreas Mohr committed
45 46

FreeBSD info:
47 48
  Wine should build on FreeBSD 5.x, but versions before FreeBSD 6.2 will
  generally not work properly.
Gerald Pfeifer's avatar
Gerald Pfeifer committed
49 50 51
 
  More information can be found in the FreeBSD ports tree at
  <ftp://ftp.freebsd.org/pub/FreeBSD/ports/ports/emulators/wine/>.
Andreas Mohr's avatar
Andreas Mohr committed
52 53

Solaris info:
54
  You will most likely need to build Wine with the GNU toolchain
Gerard Patel's avatar
Gerard Patel committed
55
  (gcc, gas, etc.). Warning : installing gas does *not* ensure that it
56
  will be used by gcc. Recompiling gcc after installing gas or
Gerard Patel's avatar
Gerard Patel committed
57 58
  symlinking cc, as and ld to the gnu tools is said to be necessary.

59 60 61 62
NetBSD info:
  Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
  turned on in your kernel.

63
Mac OS X info:
64
  You need Xcode 2.4 or later to build properly on x86.
65 66 67


Supported file systems:
Gerard Patel's avatar
Gerard Patel committed
68 69
  Wine should run on most file systems. However, Wine will fail to start
  if umsdos is used for the /tmp directory. A few compatibility problems have
70 71 72 73
  also been reported using files accessed through Samba. Also, as NTFS
  can only be used safely with readonly access for now, we recommend against
  using NTFS, as Windows programs need write access almost everywhere.
  In case of NTFS files, copy over to a writable location.
Andreas Mohr's avatar
Andreas Mohr committed
74

75 76
Basic requirements:
  You need to have the X11 development include files installed
77
  (called xlib6g-dev in Debian and XFree86-devel in Red Hat).
78

79 80 81 82
Build tool requirements:
  On x86 Systems gcc >= 2.7.2 is required.
  Versions earlier than 2.7.2.3 may have problems when certain files
  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).
Andreas Mohr's avatar
Andreas Mohr committed
86

87
  You also need flex version 2.5 or later and bison.
88

89
Optional support libraries:
90 91 92
  Run ./configure --verbose to see the optional libraries that could
  be used but aren't found on your system.

Alexandre Julliard's avatar
Alexandre Julliard committed
93

94
4. COMPILATION
Alexandre Julliard's avatar
Alexandre Julliard committed
95

Andreas Mohr's avatar
Andreas Mohr committed
96 97
In case you chose to not use wineinstall, run the following commands
to build Wine:
Alexandre Julliard's avatar
Alexandre Julliard committed
98

99 100 101 102
./configure
make depend
make

103
This will build the program "wine" and numerous support libraries/binaries.
Alexandre Julliard's avatar
Alexandre Julliard committed
104
The program "wine" will load and run Windows executables.
Andreas Mohr's avatar
Andreas Mohr committed
105 106
The library "libwine" ("Winelib") can be used to compile and link
Windows source code under Unix.
107

Andreas Mohr's avatar
Andreas Mohr committed
108
To see compile configuration options, do ./configure --help.
Alexandre Julliard's avatar
Alexandre Julliard committed
109

Alexandre Julliard's avatar
Alexandre Julliard committed
110 111 112 113
To upgrade to a new release by using a patch file, first cd to the
top-level directory of the release (the one containing this README
file). Then do a "make clean", and patch the release with:

114
    bunzip2 -c patch-file | patch -p1
Alexandre Julliard's avatar
Alexandre Julliard committed
115

Alexandre Julliard's avatar
Alexandre Julliard committed
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".
Alexandre Julliard's avatar
Alexandre Julliard committed
119

120

121
5. SETUP
Alexandre Julliard's avatar
Alexandre Julliard committed
122

Alexandre Julliard's avatar
Alexandre Julliard committed
123
Once Wine has been built correctly, you can do "make install"; this
124 125
will install the wine executable, the Wine man page, and a few other
needed files.
Alexandre Julliard's avatar
Alexandre Julliard committed
126

Andreas Mohr's avatar
Andreas Mohr committed
127 128 129 130
Don't forget to uninstall any conflicting previous Wine installation
first.  Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
before installing.

131 132
See the Support area at http://www.winehq.org/ for configuration
hints.
Alexandre Julliard's avatar
Alexandre Julliard committed
133

134 135 136 137
In case of library loading errors
(e.g. "Error while loading shared libraries: libntdll.so"), make sure
to add the library path to /etc/ld.so.conf and run ldconfig as root.

138

139
6. RUNNING PROGRAMS
Alexandre Julliard's avatar
Alexandre Julliard committed
140

141
When invoking Wine, you may specify the entire path to the executable,
Alexandre Julliard's avatar
Alexandre Julliard committed
142 143
or a filename only.

144
For example: to run Solitaire:
Alexandre Julliard's avatar
Alexandre Julliard committed
145

146 147 148 149
	wine sol		   (using the search Path as specified in
	wine sol.exe		    the config file to locate the file)

	wine c:\\windows\\sol.exe  (using DOS filename syntax)
Alexandre Julliard's avatar
Alexandre Julliard committed
150

151
	wine /usr/windows/sol.exe  (using Unix filename syntax)
Alexandre Julliard's avatar
Alexandre Julliard committed
152

153
        wine sol.exe /parameter1 -parameter2 parameter3
154
				   (calling program with parameters)
Alexandre Julliard's avatar
Alexandre Julliard committed
155

156 157 158 159
Wine is not yet complete, so several programs may crash. In that crash
you will be dropped into the debugger so that you can investigate and
fix the problem.  For more information on how to do this, please check
the debugging section of the Wine Developer's Guide.
Alexandre Julliard's avatar
Alexandre Julliard committed
160

161

162
7. GETTING MORE INFORMATION
Alexandre Julliard's avatar
Alexandre Julliard committed
163

Andreas Mohr's avatar
Andreas Mohr committed
164
WWW:	A great deal of information about Wine is available from WineHQ at
165
	http://www.winehq.org/ : various Wine Guides, application database,
Andreas Mohr's avatar
Andreas Mohr committed
166
	bug tracking. This is probably the best starting point.
167

168
FAQ:	The Wine FAQ is located at http://www.winehq.org/FAQ
Alexandre Julliard's avatar
Alexandre Julliard committed
169

170 171
Usenet:	You can discuss Wine-related issues and get help
	on comp.emulators.ms-windows.wine.
172

173
Bugs:	Report bugs to Wine Bugzilla at http://bugs.winehq.org
174 175 176
	Please search the bugzilla database to check whether your
	problem is already found before posting a bug report.  You can
	also post bug reports to comp.emulators.ms-windows.wine.
Alexandre Julliard's avatar
Alexandre Julliard committed
177

178
IRC:	Online help is available at channel #WineHQ on irc.freenode.net.
179

180 181
GIT:	The current Wine development tree is available through GIT.
	Go to http://www.winehq.org/site/git for more information.
Alexandre Julliard's avatar
Alexandre Julliard committed
182

Andreas Mohr's avatar
Andreas Mohr committed
183
Mailing lists:
184 185 186 187
	There are several mailing lists for Wine users and developers;
	see http://www.winehq.org/forums for more information.

Wiki:	The Wine Wiki is located at http://wiki.winehq.org
Andreas Mohr's avatar
Andreas Mohr committed
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.
Alexandre Julliard's avatar
Alexandre Julliard committed
192

Alexandre Julliard's avatar
Alexandre Julliard committed
193 194
--
Alexandre Julliard
195
julliard@winehq.org