README 6.23 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.3 or later
33
  Solaris x86 9 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 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
  Wine will generally not work properly on versions before FreeBSD
48
  6.3 or 7.0, and FreeBSD 6.3 has additional patches available. See
49
  <http://wiki.freebsd.org/Wine> for more information.
Andreas Mohr's avatar
Andreas Mohr committed
50 51

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

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

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


Supported file systems:
Alexandre Julliard's avatar
Alexandre Julliard committed
66 67 68 69 70
  Wine should run on most file systems. A few compatibility problems
  have also been reported using files accessed through Samba. Also,
  NTFS does not provide all the file system features needed by some
  applications.  Using a native Linux file system such as ext3 is
  recommended.
Andreas Mohr's avatar
Andreas Mohr committed
71

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

76
  Of course you also need "make" (most likely GNU make).
Andreas Mohr's avatar
Andreas Mohr committed
77

78
  You also need flex version 2.5 or later and bison.
79

80
Optional support libraries:
Alexandre Julliard's avatar
Alexandre Julliard committed
81 82 83
  Configure will display notices when optional libraries are not found
  on your system. See http://wiki.winehq.org/Recommended_Packages for
  hints about the packages you should install.
84

Alexandre Julliard's avatar
Alexandre Julliard committed
85 86 87
  On 64-bit platforms you have to make sure to install the 32-bit
  versions of these libraries; see http://wiki.winehq.org/WineOn64bit
  for details.
Alexandre Julliard's avatar
Alexandre Julliard committed
88

89
4. COMPILATION
Alexandre Julliard's avatar
Alexandre Julliard committed
90

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

94 95 96 97
./configure
make depend
make

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

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

Alexandre Julliard's avatar
Alexandre Julliard committed
105 106 107 108
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:

109
    bunzip2 -c patch-file | patch -p1
Alexandre Julliard's avatar
Alexandre Julliard committed
110

Alexandre Julliard's avatar
Alexandre Julliard committed
111
where "patch-file" is the name of the patch file (something like
112
wine-1.0.x.diff.bz2). You can then re-run "./configure", and then
113
run "make depend && make".
Alexandre Julliard's avatar
Alexandre Julliard committed
114

115

116
5. SETUP
Alexandre Julliard's avatar
Alexandre Julliard committed
117

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

Andreas Mohr's avatar
Andreas Mohr committed
122 123 124 125
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.

Alexandre Julliard's avatar
Alexandre Julliard committed
126 127
Once installed, you can run the "winecfg" configuration tool. See the
Support area at http://www.winehq.org/ for configuration hints.
128

129

130
6. RUNNING PROGRAMS
Alexandre Julliard's avatar
Alexandre Julliard committed
131

132
When invoking Wine, you may specify the entire path to the executable,
Alexandre Julliard's avatar
Alexandre Julliard committed
133 134
or a filename only.

135
For example: to run Notepad:
Alexandre Julliard's avatar
Alexandre Julliard committed
136

137 138
	wine notepad		   (using the search Path as specified in
	wine notepad.exe	    the config file to locate the file)
139

140
	wine c:\\windows\\notepad.exe  (using DOS filename syntax)
Alexandre Julliard's avatar
Alexandre Julliard committed
141

142
	wine ~/.wine/drive_c/windows/notepad.exe  (using Unix filename syntax)
Alexandre Julliard's avatar
Alexandre Julliard committed
143

144
        wine notepad.exe /parameter1 -parameter2 parameter3
145
				   (calling program with parameters)
Alexandre Julliard's avatar
Alexandre Julliard committed
146

147 148 149 150
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
151

152

153
7. GETTING MORE INFORMATION
Alexandre Julliard's avatar
Alexandre Julliard committed
154

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

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

161 162
Usenet:	You can discuss Wine-related issues and get help
	on comp.emulators.ms-windows.wine.
163

164
Bugs:	Report bugs to Wine Bugzilla at http://bugs.winehq.org
165 166 167
	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
168

169
IRC:	Online help is available at channel #WineHQ on irc.freenode.net.
170

171
Git:	The current Wine development tree is available through Git.
172
	Go to http://www.winehq.org/site/git for more information.
Alexandre Julliard's avatar
Alexandre Julliard committed
173

Andreas Mohr's avatar
Andreas Mohr committed
174
Mailing lists:
175 176 177 178
	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
179

180
If you add something, or fix a bug, please send a patch (in 'diff -u'
181
format) to wine-patches@winehq.org list for inclusion in the next
182
release.
Alexandre Julliard's avatar
Alexandre Julliard committed
183

Alexandre Julliard's avatar
Alexandre Julliard committed
184 185
--
Alexandre Julliard
186
julliard@winehq.org