README 7.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
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
22 23
problem resolution, read the rest of this file, the Wine man page, and
especially the wealth of information found at http://www.winehq.org.
24 25

3. REQUIREMENTS
Alexandre Julliard's avatar
Alexandre Julliard committed
26

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

29
  Linux version 2.0.36 or above
Gerald Pfeifer's avatar
Gerald Pfeifer committed
30
  FreeBSD 5.3 or later
31 32 33 34 35 36 37
  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
38

Andreas Mohr's avatar
Andreas Mohr committed
39
Linux info:
40 41 42
  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
43 44

FreeBSD info:
45 46
  Wine should build on FreeBSD 4.x and FreeBSD 5.x, but versions before
  FreeBSD 5.3 will generally not work properly.
Gerald Pfeifer's avatar
Gerald Pfeifer committed
47 48 49
 
  More information can be found in the FreeBSD ports tree at
  <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
Basic requirements:
  You need to have the X11 development include files installed
73
  (called xlib6g-dev in Debian and XFree86-devel in Red Hat).
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
  You also need flex version 2.5 or later and bison.
85

86 87 88
Optional support libraries:
  If you want CUPS printing support, please install both cups and cups-devel
  packages.
89
  Install the libxml2 package to get a functional msxml implementation.
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 99
./configure
make depend
make

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

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

Alexandre Julliard's avatar
Alexandre Julliard committed
107 108 109 110 111
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
112

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

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

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

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

127 128
See the Support area at http://www.winehq.org/ for configuration
hints.
Alexandre Julliard's avatar
Alexandre Julliard committed
129

130 131 132 133
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.

134
6. RUNNING PROGRAMS
Alexandre Julliard's avatar
Alexandre Julliard committed
135

136
When invoking Wine, you may specify the entire path to the executable,
Alexandre Julliard's avatar
Alexandre Julliard committed
137 138
or a filename only.

139
For example: to run Solitaire:
Alexandre Julliard's avatar
Alexandre Julliard committed
140

141 142 143 144
	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
145

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

148
        wine sol.exe /parameter1 -parameter2 parameter3
149
				   (calling program with parameters)
Alexandre Julliard's avatar
Alexandre Julliard committed
150

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

154
Wine is not yet complete, so several programs may crash. Provided you set up
Andreas Mohr's avatar
Andreas Mohr committed
155
winedbg correctly according to documentation/debugger.sgml, you will be dropped
156 157 158
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
159

160 161 162 163
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
164 165
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
166 167
can at least partially be fixed by using
http://home.nexgo.de/andi.mohr/download/decorrupt_explorer
168

169
7. GETTING MORE INFORMATION
Alexandre Julliard's avatar
Alexandre Julliard committed
170

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

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

177 178
Usenet:	You can discuss Wine-related issues and get help
	on comp.emulators.ms-windows.wine.
179

180
Bugs:	Report bugs to Wine Bugzilla at http://bugs.winehq.org
181 182 183 184 185
	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
186

187
IRC:	Online help is available at channel #WineHQ on irc.freenode.net.
188

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

Andreas Mohr's avatar
Andreas Mohr committed
192
Mailing lists:
193
	There are several mailing lists for Wine developers; see
194
	http://www.winehq.org/forums for more information.
Andreas Mohr's avatar
Andreas Mohr committed
195

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

Alexandre Julliard's avatar
Alexandre Julliard committed
200 201
--
Alexandre Julliard
202
julliard@winehq.org