README 5.37 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
Windows binary, and a library (called Winelib) that implements Windows
7
API calls using their Unix, X11 or Mac 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

16 17
From the top-level directory of the Wine source (which contains this file),
run:
18

19 20
./configure
make
21

22
Then either install Wine:
23 24 25

make install

26
Or run Wine directly from the build directory:
27 28 29

./wine notepad

30 31
Run programs as "wine program".  For more information and problem
resolution, read the rest of this file, the Wine man page, and
32
especially the wealth of information found at https://www.winehq.org.
33

34

35
3. REQUIREMENTS
Alexandre Julliard's avatar
Alexandre Julliard committed
36

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

Alexandre Julliard's avatar
Alexandre Julliard committed
39
  Linux version 2.0.36 or later
40
  FreeBSD 8.0 or later
41
  Solaris x86 9 or later
42
  NetBSD-current
43
  Mac OS X 10.5 or later
44 45

As Wine requires kernel-level thread support to run, only the operating
46 47
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
48

Andreas Mohr's avatar
Andreas Mohr committed
49
FreeBSD info:
50
  Wine will generally not work properly on versions before FreeBSD 8.0.
51
  See https://wiki.freebsd.org/Wine for more information.
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
  The Mac driver requires OS X 10.6 or later and won't be built on 10.5.
66 67 68


Supported file systems:
Alexandre Julliard's avatar
Alexandre Julliard committed
69 70 71
  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
Alexandre Julliard's avatar
Alexandre Julliard committed
72
  applications.  Using a native Unix file system is recommended.
Andreas Mohr's avatar
Andreas Mohr committed
73

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

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

Austin English's avatar
Austin English committed
80
  You also need flex version 2.5.33 or later and bison.
81

82
Optional support libraries:
Alexandre Julliard's avatar
Alexandre Julliard committed
83
  Configure will display notices when optional libraries are not found
84
  on your system. See https://wiki.winehq.org/Recommended_Packages for
85 86 87
  hints about the packages you should install. On 64-bit platforms,
  you have to make sure to install the 32-bit versions of these
  libraries.
Alexandre Julliard's avatar
Alexandre Julliard committed
88

89

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

92
To build Wine, do:
Alexandre Julliard's avatar
Alexandre Julliard committed
93

94 95 96
./configure
make

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

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

104 105
For more information, see https://wiki.winehq.org/Building_Wine

106

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

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

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

120

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

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

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

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

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

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

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

Austin English's avatar
Austin English committed
137 138 139
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
140

141

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

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

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

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

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

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

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

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

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

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