Use FIXME's in stubs instead of TRACE's.
[wine] / README
CommitLineData
3a5816f8
AJ
11. INTRODUCTION
2
692389d0
DR
3Wine is a program which allows running Microsoft Windows programs
4(including DOS, Windows 3.x and Win32 executables) on Unix. It
0ff60a08 5consists of a program loader which loads and executes a Microsoft
3d2a38cf
AM
6Windows binary, and a library (called Winelib) that implements Windows
7API calls using their Unix or X11 equivalents. The library may also
8be used for porting Win32 code into native Unix executables.
3a5816f8 9
89894ffc
MG
10Wine is free software, released under the GNU LGPL; see the file
11LICENSE for the details.
3a5816f8 12
d6baf1bb 132. QUICK START
3a5816f8 14
581fc926 15Whenever you compile from source, it is recommended to use the Wine
a0ff2b4a
AM
16Installer to build and install Wine. From the top-level directory
17of the Wine source (which contains this file), run:
d6baf1bb
AJ
18
19./tools/wineinstall
20
21Run programs as "wine [options] program". For more information and
12f9bb7a
DP
22problem resolution, read the rest of this file, the Wine man page, and
23especially the wealth of information found at http://www.winehq.org.
d6baf1bb
AJ
24
253. REQUIREMENTS
401710d7 26
0ff60a08 27To compile and run Wine, you must have one of the following:
f41aeca9 28
c08b948f 29 Linux version 2.0.36 or above
a93fb4a0 30 FreeBSD 5.3 or later
c08b948f
AM
31 Solaris x86 2.5 or later
32 NetBSD-current
33
34As Wine requires kernel-level thread support to run, only the operating
35systems mentioned above are supported.
36Other operating systems which support kernel threads may be supported
37in the future.
f41aeca9 38
c9ec8846 39Linux info:
c08b948f
AM
40 While Linux 2.2.x should still work and Linux 2.0.x may still work
41 (older 2.0.x versions had thread-related crashes),
42 it's best to have a current kernel such as 2.4.x.
c9ec8846
AM
43
44FreeBSD info:
e5f6637e
GP
45 Wine should build on FreeBSD 4.x and FreeBSD 5.x, but versions before
46 FreeBSD 5.3 will generally not work properly.
a93fb4a0
GP
47
48 More information can be found in the FreeBSD ports tree at
49 <ftp://ftp.freebsd.org/pub/FreeBSD/ports/ports/emulators/wine/>.
c9ec8846
AM
50
51Solaris info:
d2b22894 52 You will most likely need to build Wine with the GNU toolchain
2895e7f4 53 (gcc, gas, etc.). Warning : installing gas does *not* ensure that it
a5589d56 54 will be used by gcc. Recompiling gcc after installing gas or
2895e7f4
GP
55 symlinking cc, as and ld to the gnu tools is said to be necessary.
56
9048c49b
BJY
57NetBSD info:
58 Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
59 turned on in your kernel.
60
c08b948f
AM
61
62
63Supported file systems:
2895e7f4
GP
64 Wine should run on most file systems. However, Wine will fail to start
65 if umsdos is used for the /tmp directory. A few compatibility problems have
a0ff2b4a
AM
66 also been reported using files accessed through Samba. Also, as NTFS
67 can only be used safely with readonly access for now, we recommend against
68 using NTFS, as Windows programs need write access almost everywhere.
69 In case of NTFS files, copy over to a writable location.
c9ec8846 70
c08b948f
AM
71Basic requirements:
72 You need to have the X11 development include files installed
73 (called xlib6g-dev in Debian and XFree86-devel in RedHat).
ca851392 74
c08b948f
AM
75Build tool requirements:
76 On x86 Systems gcc >= 2.7.2 is required.
77 Versions earlier than 2.7.2.3 may have problems when certain files
78 are compiled with optimization, often due to problems with header file
79 management. pgcc currently doesn't work with Wine. The cause of this problem
80 is unknown.
c165bca8 81
c08b948f 82 Of course you also need "make" (most likely GNU make).
c9ec8846 83
c068f670 84 You also need flex version 2.5 or later and bison. If you are
c08b948f 85 using RedHat or Debian, install the flex and bison packages.
a5589d56 86
c08b948f
AM
87Optional support libraries:
88 If you want CUPS printing support, please install both cups and cups-devel
89 packages.
6abb89c3 90
d6baf1bb 914. COMPILATION
a69b88b2 92
c9ec8846
AM
93In case you chose to not use wineinstall, run the following commands
94to build Wine:
401710d7 95
d6baf1bb
AJ
96./configure
97make depend
98make
99
a5589d56 100This will build the program "wine" and numerous support libraries/binaries.
a0b2b1d0 101The program "wine" will load and run Windows executables.
1af53cbb
AM
102The library "libwine" ("Winelib") can be used to compile and link
103Windows source code under Unix.
d6baf1bb 104
1af53cbb 105To see compile configuration options, do ./configure --help.
e2bfa4c7 106
3a5816f8
AJ
107To upgrade to a new release by using a patch file, first cd to the
108top-level directory of the release (the one containing this README
109file). Then do a "make clean", and patch the release with:
110
111 gunzip -c patch-file | patch -p1
f41aeca9 112
3a5816f8 113where "patch-file" is the name of the patch file (something like
ff8331ea 114Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
d6baf1bb 115run "make depend && make".
5f721f81 116
d6baf1bb 1175. SETUP
8d24ae6d 118
7e56f684 119Once Wine has been built correctly, you can do "make install"; this
38a3d264
JJ
120will install the wine executable, the Wine man page, and a few other
121needed files.
7e56f684 122
de53c487
AM
123Don't forget to uninstall any conflicting previous Wine installation
124first. Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
125before installing.
126
12f9bb7a
DP
127See the Support area at http://www.winehq.org/ for configuration
128hints.
8d24ae6d 129
a0ff2b4a
AM
130In case of library loading errors
131(e.g. "Error while loading shared libraries: libntdll.so"), make sure
132to add the library path to /etc/ld.so.conf and run ldconfig as root.
133
d6baf1bb 1346. RUNNING PROGRAMS
8d24ae6d 135
38a3d264 136When invoking Wine, you may specify the entire path to the executable,
8d24ae6d
AJ
137or a filename only.
138
692389d0 139For example: to run Solitaire:
8d24ae6d 140
c08b948f
AM
141 wine sol (using the search Path as specified in
142 wine sol.exe the config file to locate the file)
143
144 wine c:\\windows\\sol.exe (using DOS filename syntax)
5f721f81 145
c08b948f 146 wine /usr/windows/sol.exe (using Unix filename syntax)
5f721f81 147
f950d973 148 wine sol.exe /parameter1 -parameter2 parameter3
c08b948f 149 (calling program with parameters)
f41aeca9 150
3a5816f8 151Note: the path of the file will also be added to the path when
5819953c
AJ
152 a full name is supplied on the commandline.
153
b6e84187 154Wine is not yet complete, so several programs may crash. Provided you set up
581fc926 155winedbg correctly according to documentation/debugger.sgml, you will be dropped
a0ff2b4a
AM
156into a debugger so that you can investigate and fix the problem.
157For more information on how to do this, please read the file
158documentation/debugging.sgml.
8d24ae6d 159
a6d83eba
AM
160You should backup all your important files that you give Wine access
161to, or use a special Wine copy of them, as there have been some cases
162of users reporting file corruption. Do NOT run Explorer, for instance,
163if you don't have a proper backup, as it renames/cripples several
7bed696a
AM
164directories sometimes. Not even other MS apps such as e.g. Messenger are safe,
165as they launch Explorer somehow. This particular corruption (!$!$!$!$.pfr)
a69c039c
AM
166can at least partially be fixed by using
167http://home.nexgo.de/andi.mohr/download/decorrupt_explorer
a6d83eba 168
12f9bb7a 1697. GETTING MORE INFORMATION
46ea8b3f 170
3d2a38cf 171WWW: A great deal of information about Wine is available from WineHQ at
c0232546 172 http://www.winehq.org/ : various Wine Guides, application database,
3d2a38cf 173 bug tracking. This is probably the best starting point.
8cd93514 174
c0232546 175FAQ: The Wine FAQ is located at http://www.winehq.org/FAQ
46ea8b3f 176
ac3a9a32
AP
177Usenet: You can discuss Wine-related issues and get help
178 on comp.emulators.ms-windows.wine.
0ff60a08 179
c0232546 180Bugs: Report bugs to Wine Bugzilla at http://bugs.winehq.org
ac3a9a32
AP
181 Please search the bugzilla database to check whether your
182 problem is already found before posting a bug report. You can
183 also post bug reports to comp.emulators.ms-windows.wine.
184 Please read the file documentation/bugs.sgml to see what
185 information is required.
46ea8b3f 186
344ed41d 187IRC: Online help is available at channel #WineHQ on irc.freenode.net.
8cd93514 188
38a3d264 189CVS: The current Wine development tree is available through CVS.
c0232546 190 Go to http://www.winehq.org/cvs for more information.
8d24ae6d 191
3d2a38cf 192Mailing lists:
a5589d56 193 There are several mailing lists for Wine developers; see
c0232546 194 http://www.winehq.org/forums for more information.
3d2a38cf 195
b6e84187 196If you add something, or fix a bug, please send a patch (in 'diff -u'
c0232546 197format) to wine-patches@winehq.org list for inclusion in the next
ac3a9a32 198release.
8d24ae6d 199
3a5816f8
AJ
200--
201Alexandre Julliard
c0232546 202julliard@winehq.org