README 5.57 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

Alexandre Julliard's avatar
Alexandre Julliard committed
31 32
  Linux version 2.0.36 or later
  FreeBSD 7.0 or later
33
  Solaris x86 9 or later
34
  NetBSD-current
35
  Mac OS X 10.5 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
FreeBSD info:
Alexandre Julliard's avatar
Alexandre Julliard committed
42 43
  Wine will generally not work properly on versions before FreeBSD 7.0.
  See http://wiki.freebsd.org/Wine for more information.
Andreas Mohr's avatar
Andreas Mohr committed
44 45

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

51 52 53 54
NetBSD info:
  Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
  turned on in your kernel.

55
Mac OS X info:
56
  You need Xcode 2.4 or later to build properly on x86.
57
  The Mac driver requires OS X 10.6 or later and won't be built on 10.5.
58 59 60


Supported file systems:
Alexandre Julliard's avatar
Alexandre Julliard committed
61 62 63
  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
64
  applications.  Using a native Unix file system is recommended.
Andreas Mohr's avatar
Andreas Mohr committed
65

66 67
Basic requirements:
  You need to have the X11 development include files installed
68
  (called xlib6g-dev in Debian and XFree86-devel in Red Hat).
69

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

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

74
Optional support libraries:
Alexandre Julliard's avatar
Alexandre Julliard committed
75 76 77
  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.
78

Austin English's avatar
Austin English committed
79 80 81 82 83
  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
84

85
4. COMPILATION
Alexandre Julliard's avatar
Alexandre Julliard committed
86

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

90 91 92
./configure
make

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

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

100
5. SETUP
Alexandre Julliard's avatar
Alexandre Julliard committed
101

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

Andreas Mohr's avatar
Andreas Mohr committed
106 107 108 109
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
110 111
Once installed, you can run the "winecfg" configuration tool. See the
Support area at http://www.winehq.org/ for configuration hints.
112

113

114
6. RUNNING PROGRAMS
Alexandre Julliard's avatar
Alexandre Julliard committed
115

116
When invoking Wine, you may specify the entire path to the executable,
Alexandre Julliard's avatar
Alexandre Julliard committed
117 118
or a filename only.

119
For example: to run Notepad:
Alexandre Julliard's avatar
Alexandre Julliard committed
120

Austin English's avatar
Austin English committed
121 122
    wine notepad            (using the search Path as specified in
    wine notepad.exe         the registry to locate the file)
123

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

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

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

Austin English's avatar
Austin English committed
130 131 132
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
133

134

135
7. GETTING MORE INFORMATION
Alexandre Julliard's avatar
Alexandre Julliard committed
136

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

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

Austin English's avatar
Austin English committed
143 144 145 146 147
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.
148

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

153
IRC:	Online help is available at channel #WineHQ on irc.freenode.net.
154

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

Austin English's avatar
Austin English committed
158 159 160
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
161

Alexandre Julliard's avatar
Alexandre Julliard committed
162 163
--
Alexandre Julliard
164
julliard@winehq.org