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

3
Wine is a program which allows running Microsoft Windows programs
Austin English's avatar
Austin English committed
4 5
(including DOS, Windows 3.x, Win32, and Win64 executables) on Unix.
It consists of a program loader which loads and executes a Microsoft
Andreas Mohr's avatar
Andreas Mohr committed
6 7
Windows binary, and a library (called Winelib) that implements Windows
API calls using their Unix or X11 equivalents.  The library may also
Austin English's avatar
Austin English committed
8
be used for porting Windows 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
Austin English's avatar
Austin English committed
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

Austin English's avatar
Austin English committed
78
  You also need flex version 2.5.33 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

Austin English's avatar
Austin English committed
85 86 87 88 89
  On 64-bit platforms, if compiling Wine as 32-bit (default), you have
  to make sure to install the 32-bit versions of these libraries; see
  http://wiki.winehq.org/WineOn64bit for details. If you want a true
  64-bit Wine (or a mixed 32-bit and 64-bit Wine setup), see
  http://wiki.winehq.org/Wine64 for details.
Alexandre Julliard's avatar
Alexandre Julliard committed
90

91
4. COMPILATION
Alexandre Julliard's avatar
Alexandre Julliard committed
92

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

96 97 98
./configure
make

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

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

106
5. SETUP
Alexandre Julliard's avatar
Alexandre Julliard committed
107

Alexandre Julliard's avatar
Alexandre Julliard committed
108
Once Wine has been built correctly, you can do "make install"; this
Austin English's avatar
Austin English committed
109 110
will install the wine executable and libraries, the Wine man page, and
other needed files.
Alexandre Julliard's avatar
Alexandre Julliard committed
111

Andreas Mohr's avatar
Andreas Mohr committed
112 113 114 115
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
116 117
Once installed, you can run the "winecfg" configuration tool. See the
Support area at http://www.winehq.org/ for configuration hints.
118

119

120
6. RUNNING PROGRAMS
Alexandre Julliard's avatar
Alexandre Julliard committed
121

122
When invoking Wine, you may specify the entire path to the executable,
Alexandre Julliard's avatar
Alexandre Julliard committed
123 124
or a filename only.

125
For example: to run Notepad:
Alexandre Julliard's avatar
Alexandre Julliard committed
126

Austin English's avatar
Austin English committed
127 128
    wine notepad            (using the search Path as specified in
    wine notepad.exe         the registry to locate the file)
129

Austin English's avatar
Austin English committed
130
    wine c:\\windows\\notepad.exe      (using DOS filename syntax)
Alexandre Julliard's avatar
Alexandre Julliard committed
131

Austin English's avatar
Austin English committed
132
    wine ~/.wine/drive_c/windows/notepad.exe  (using Unix filename syntax)
Alexandre Julliard's avatar
Alexandre Julliard committed
133

Austin English's avatar
Austin English committed
134
    wine notepad.exe readme.txt          (calling program with parameters)
Alexandre Julliard's avatar
Alexandre Julliard committed
135

Austin English's avatar
Austin English committed
136 137 138
Wine is not perfect, so some programs may crash. If that happens you
will get a crash log that you should attach to your report when filing
a bug.
Alexandre Julliard's avatar
Alexandre Julliard committed
139

140

141
7. GETTING MORE INFORMATION
Alexandre Julliard's avatar
Alexandre Julliard committed
142

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

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

Austin English's avatar
Austin English committed
149 150 151 152 153
Wiki:	The Wine Wiki is located at http://wiki.winehq.org

Mailing lists:
	There are several mailing lists for Wine users and developers;
	see http://www.winehq.org/forums for more information.
154

155
Bugs:	Report bugs to Wine Bugzilla at http://bugs.winehq.org
156
	Please search the bugzilla database to check whether your
Austin English's avatar
Austin English committed
157
	problem is already known or fixed before posting a bug report.
Alexandre Julliard's avatar
Alexandre Julliard committed
158

159
IRC:	Online help is available at channel #WineHQ on irc.freenode.net.
160

161
Git:	The current Wine development tree is available through Git.
Austin English's avatar
Austin English committed
162
	Go to http://www.winehq.org/git for more information.
Andreas Mohr's avatar
Andreas Mohr committed
163

Austin English's avatar
Austin English committed
164 165 166
If you add something, or fix a bug, please send a patch (preferably
using git-format-patch) to the wine-patches@winehq.org list for
inclusion in the next release.
Alexandre Julliard's avatar
Alexandre Julliard committed
167

Alexandre Julliard's avatar
Alexandre Julliard committed
168 169
--
Alexandre Julliard
170
julliard@winehq.org