README 8.96 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
2. QUICK START
Alexandre Julliard's avatar
Alexandre Julliard committed
14

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

./tools/wineinstall

Run programs as "wine [options] program".  For more information and
Andreas Mohr's avatar
Andreas Mohr committed
22
problem resolution, read the rest of this file, the Wine man page,
23
the files in the documentation directory of the Wine source
24
(see "DOCUMENTATION"), and especially the wealth of information
25
found at http://www.winehq.org.
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 32 33 34 35 36 37 38 39
  Linux version 2.0.36 or above
  FreeBSD 4.x or FreeBSD 5-CURRENT or later
  Solaris x86 2.5 or later
  NetBSD-current

As Wine requires kernel-level thread support to run, only the operating
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 44
  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),
  it's best to have a current kernel such as 2.4.x.
Andreas Mohr's avatar
Andreas Mohr committed
45 46

FreeBSD info:
47 48 49
  Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG
  options turned on in your kernel.  More information is in the ports
  tree: ftp://ftp.freebsd.org/pub/FreeBSD/ports/ports/emulators/wine/
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 62 63


Supported file systems:
Gerard Patel's avatar
Gerard Patel committed
64 65
  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
66 67 68 69
  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
70

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

75 76 77 78 79 80
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
  management. pgcc currently doesn't work with Wine. The cause of this problem
  is unknown.
81

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

84 85 86
  You also need flex version 2.5 or later and yacc.
  Bison will work as a replacement for yacc. If you are
  using RedHat or Debian, install the flex and bison packages.
87

88 89 90
Optional support libraries:
  If you want CUPS printing support, please install both cups and cups-devel
  packages.
Alexandre Julliard's avatar
Alexandre Julliard committed
91

92 93
  For the automatic processing of the test suite scripts, you also need
  libperl development header support (libperl-dev package on Debian).
94

95 96
For requirements in case you intend to build the documentation yourself,
see "DOCUMENTATION" section.
97

98
4. COMPILATION
Alexandre Julliard's avatar
Alexandre Julliard committed
99

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

103 104 105 106
./configure
make depend
make

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

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

Alexandre Julliard's avatar
Alexandre Julliard committed
114 115 116 117 118
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:

    gunzip -c patch-file | patch -p1
Alexandre Julliard's avatar
Alexandre Julliard committed
119

Alexandre Julliard's avatar
Alexandre Julliard committed
120
where "patch-file" is the name of the patch file (something like
Alexandre Julliard's avatar
Alexandre Julliard committed
121
Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
122
run "make depend && make".
Alexandre Julliard's avatar
Alexandre Julliard committed
123

124
5. SETUP
Alexandre Julliard's avatar
Alexandre Julliard committed
125

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

Andreas Mohr's avatar
Andreas Mohr committed
130 131 132 133
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.

134
If you want to read the documentation supplied with the Wine source,
135
see the "DOCUMENTATION" section.
136

Andreas Mohr's avatar
Andreas Mohr committed
137
Wine requires a configuration file named named "config" in your
138 139 140 141
~/.wine directory. The format of this file is explained in the config file
man page (documentation/wine.conf.man).
The file documentation/samples/config contains an example configuration file
which has to be adapted and copied to the location mentioned above.
Andreas Mohr's avatar
Andreas Mohr committed
142

Andreas Mohr's avatar
Andreas Mohr committed
143
Don't forget to add vital registry entries by applying winedefault.reg
144
with programs/regedit/. See documentation/ directory for details.
Andreas Mohr's avatar
Andreas Mohr committed
145

146
See the Support area at http://www.winehq.org/ for further
147
configuration hints.
Alexandre Julliard's avatar
Alexandre Julliard committed
148

149 150 151 152
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.

153
In order to verify the correctness of the environment you need for
154 155
Wine to run successfully, you may run "./tools/winecheck | less".
You'll get a percentage score indicating "Wine configuration correctness".
Andreas Mohr's avatar
Andreas Mohr committed
156 157
As this program is alpha, it doesn't run a truly thorough test yet, though,
so it should be taken as a first verification step only.
Alexandre Julliard's avatar
Alexandre Julliard committed
158

159 160
See wine.conf man page on how to switch to text mode only support if desired.

161
6. RUNNING PROGRAMS
Alexandre Julliard's avatar
Alexandre Julliard committed
162

163
When invoking Wine, you may specify the entire path to the executable,
Alexandre Julliard's avatar
Alexandre Julliard committed
164 165
or a filename only.

166
For example: to run Solitaire:
Alexandre Julliard's avatar
Alexandre Julliard committed
167

168 169 170 171
	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
172

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

175 176
        wine -- sol.exe /parameter1 -parameter2 parameter3
				   (calling program with parameters)
Alexandre Julliard's avatar
Alexandre Julliard committed
177

Alexandre Julliard's avatar
Alexandre Julliard committed
178
Note: the path of the file will also be added to the path when
Alexandre Julliard's avatar
Alexandre Julliard committed
179 180
      a full name is supplied on the commandline.

181
Wine is not yet complete, so several programs may crash. Provided you set up
Andreas Mohr's avatar
Andreas Mohr committed
182
winedbg correctly according to documentation/debugger.sgml, you will be dropped
183 184 185
into a debugger so that you can investigate and fix the problem.
For more information on how to do this, please read the file
documentation/debugging.sgml.
Alexandre Julliard's avatar
Alexandre Julliard committed
186

187 188 189 190
You should backup all your important files that you give Wine access
to, or use a special Wine copy of them, as there have been some cases
of users reporting file corruption. Do NOT run Explorer, for instance,
if you don't have a proper backup, as it renames/cripples several
191 192
directories sometimes. Not even other MS apps such as e.g. Messenger are safe,
as they launch Explorer somehow. This particular corruption (!$!$!$!$.pfr)
Andreas Mohr's avatar
Andreas Mohr committed
193 194
can at least partially be fixed by using
http://home.nexgo.de/andi.mohr/download/decorrupt_explorer
195

196 197 198 199 200
7. DOCUMENTATION

Some documentation (various Wine Guides etc.) can be found in the
documentation/ directory (apart from also being available on WineHQ).

201
If you want to process the SGML files in there, then you can run "make doc"
202 203 204 205 206
in the documentation/ directory.
Doing so requires the sgml tools package (for db2html, db2ps, db2pdf) named:
Debian:		docbook-utils
Mandrake:	sgml-tools-A.B.C-DDmdk
SuSE:		docbktls-A.BB.C-DD
Alexandre Julliard's avatar
Alexandre Julliard committed
207

208
8. GETTING MORE INFORMATION
Alexandre Julliard's avatar
Alexandre Julliard committed
209

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

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

216 217
Usenet:	You can discuss Wine-related issues and get help
	on comp.emulators.ms-windows.wine.
218

219
Bugs:	Report bugs to Wine Bugzilla at http://bugs.winehq.org
220 221 222 223 224
	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.
	Please read the file documentation/bugs.sgml to see what
	information is required.
Alexandre Julliard's avatar
Alexandre Julliard committed
225

226
IRC:	Online help is available at channel #WineHQ on irc.freenode.net.
227

228
CVS:	The current Wine development tree is available through CVS.
229
	Go to http://www.winehq.org/cvs for more information.
Alexandre Julliard's avatar
Alexandre Julliard committed
230

Andreas Mohr's avatar
Andreas Mohr committed
231
Mailing lists:
232
	There are several mailing lists for Wine developers; see
233
	http://www.winehq.org/forums for more information.
Andreas Mohr's avatar
Andreas Mohr committed
234

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

Alexandre Julliard's avatar
Alexandre Julliard committed
239 240
--
Alexandre Julliard
241
julliard@winehq.org