d3d8: Forward the volume's GetDevice() to the texture instead of the wined3d volume.
[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
4e474034 13
d6baf1bb 142. QUICK START
3a5816f8 15
581fc926 16Whenever you compile from source, it is recommended to use the Wine
a0ff2b4a
AM
17Installer to build and install Wine. From the top-level directory
18of the Wine source (which contains this file), run:
d6baf1bb
AJ
19
20./tools/wineinstall
21
4e474034
AJ
22Run programs as "wine program". For more information and problem
23resolution, read the rest of this file, the Wine man page, and
12f9bb7a 24especially the wealth of information found at http://www.winehq.org.
d6baf1bb 25
4e474034 26
d6baf1bb 273. REQUIREMENTS
401710d7 28
0ff60a08 29To compile and run Wine, you must have one of the following:
f41aeca9 30
c08b948f 31 Linux version 2.0.36 or above
c95c75b0 32 FreeBSD 6.3 or later
1b81ee33 33 Solaris x86 9 or later
c08b948f 34 NetBSD-current
bb8e625b 35 Mac OS X 10.4 or later
c08b948f
AM
36
37As Wine requires kernel-level thread support to run, only the operating
fef243cd
GP
38systems mentioned above are supported. Other operating systems which
39support kernel threads may be supported in the future.
f41aeca9 40
c9ec8846 41Linux info:
c08b948f
AM
42 While Linux 2.2.x should still work and Linux 2.0.x may still work
43 (older 2.0.x versions had thread-related crashes),
4fe7ee8c 44 it's best to have a current kernel such as 2.4.x or 2.6.x.
c9ec8846
AM
45
46FreeBSD info:
1b81ee33 47 Wine will generally not work properly on versions before FreeBSD
c95c75b0 48 6.3 or 7.0, and FreeBSD 6.3 has additional patches available. See
1b81ee33 49 <http://wiki.freebsd.org/Wine> for more information.
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
bb8e625b 61Mac OS X info:
4e474034 62 You need Xcode 2.4 or later to build properly on x86.
c08b948f
AM
63
64
65Supported file systems:
6504ee44
AJ
66 Wine should run on most file systems. A few compatibility problems
67 have also been reported using files accessed through Samba. Also,
68 NTFS does not provide all the file system features needed by some
69 applications. Using a native Linux file system such as ext3 is
70 recommended.
c9ec8846 71
c08b948f
AM
72Basic requirements:
73 You need to have the X11 development include files installed
2d979b6a 74 (called xlib6g-dev in Debian and XFree86-devel in Red Hat).
ca851392 75
c08b948f 76 Of course you also need "make" (most likely GNU make).
c9ec8846 77
2d979b6a 78 You also need flex version 2.5 or later and bison.
a5589d56 79
c08b948f 80Optional support libraries:
6504ee44
AJ
81 Configure will display notices when optional libraries are not found
82 on your system. See http://wiki.winehq.org/Recommended_Packages for
83 hints about the packages you should install.
4e474034 84
6504ee44
AJ
85 On 64-bit platforms you have to make sure to install the 32-bit
86 versions of these libraries; see http://wiki.winehq.org/WineOn64bit
87 for details.
6abb89c3 88
d6baf1bb 894. COMPILATION
a69b88b2 90
c9ec8846
AM
91In case you chose to not use wineinstall, run the following commands
92to build Wine:
401710d7 93
d6baf1bb
AJ
94./configure
95make depend
96make
97
a5589d56 98This will build the program "wine" and numerous support libraries/binaries.
a0b2b1d0 99The program "wine" will load and run Windows executables.
1af53cbb
AM
100The library "libwine" ("Winelib") can be used to compile and link
101Windows source code under Unix.
d6baf1bb 102
1af53cbb 103To see compile configuration options, do ./configure --help.
e2bfa4c7 104
3a5816f8
AJ
105To upgrade to a new release by using a patch file, first cd to the
106top-level directory of the release (the one containing this README
107file). Then do a "make clean", and patch the release with:
108
4e474034 109 bunzip2 -c patch-file | patch -p1
f41aeca9 110
3a5816f8 111where "patch-file" is the name of the patch file (something like
1b81ee33 112wine-1.0.x.diff.bz2). You can then re-run "./configure", and then
d6baf1bb 113run "make depend && make".
5f721f81 114
4e474034 115
d6baf1bb 1165. SETUP
8d24ae6d 117
7e56f684 118Once Wine has been built correctly, you can do "make install"; this
38a3d264
JJ
119will install the wine executable, the Wine man page, and a few other
120needed files.
7e56f684 121
de53c487
AM
122Don't forget to uninstall any conflicting previous Wine installation
123first. Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
124before installing.
125
6504ee44
AJ
126Once installed, you can run the "winecfg" configuration tool. See the
127Support area at http://www.winehq.org/ for configuration hints.
a0ff2b4a 128
4e474034 129
d6baf1bb 1306. RUNNING PROGRAMS
8d24ae6d 131
38a3d264 132When invoking Wine, you may specify the entire path to the executable,
8d24ae6d
AJ
133or a filename only.
134
1b81ee33 135For example: to run Notepad:
8d24ae6d 136
1b81ee33
AE
137 wine notepad (using the search Path as specified in
138 wine notepad.exe the config file to locate the file)
c08b948f 139
1b81ee33 140 wine c:\\windows\\notepad.exe (using DOS filename syntax)
5f721f81 141
1b81ee33 142 wine ~/.wine/drive_c/windows/notepad.exe (using Unix filename syntax)
5f721f81 143
1b81ee33 144 wine notepad.exe /parameter1 -parameter2 parameter3
c08b948f 145 (calling program with parameters)
f41aeca9 146
4e474034
AJ
147Wine is not yet complete, so several programs may crash. In that crash
148you will be dropped into the debugger so that you can investigate and
149fix the problem. For more information on how to do this, please check
150the debugging section of the Wine Developer's Guide.
8d24ae6d 151
a6d83eba 152
12f9bb7a 1537. GETTING MORE INFORMATION
46ea8b3f 154
3d2a38cf 155WWW: A great deal of information about Wine is available from WineHQ at
c0232546 156 http://www.winehq.org/ : various Wine Guides, application database,
3d2a38cf 157 bug tracking. This is probably the best starting point.
8cd93514 158
c0232546 159FAQ: The Wine FAQ is located at http://www.winehq.org/FAQ
46ea8b3f 160
ac3a9a32
AP
161Usenet: You can discuss Wine-related issues and get help
162 on comp.emulators.ms-windows.wine.
0ff60a08 163
c0232546 164Bugs: Report bugs to Wine Bugzilla at http://bugs.winehq.org
ac3a9a32
AP
165 Please search the bugzilla database to check whether your
166 problem is already found before posting a bug report. You can
167 also post bug reports to comp.emulators.ms-windows.wine.
46ea8b3f 168
344ed41d 169IRC: Online help is available at channel #WineHQ on irc.freenode.net.
8cd93514 170
350fcb73 171Git: The current Wine development tree is available through Git.
4e474034 172 Go to http://www.winehq.org/site/git for more information.
8d24ae6d 173
3d2a38cf 174Mailing lists:
4e474034
AJ
175 There are several mailing lists for Wine users and developers;
176 see http://www.winehq.org/forums for more information.
177
178Wiki: The Wine Wiki is located at http://wiki.winehq.org
3d2a38cf 179
b6e84187 180If you add something, or fix a bug, please send a patch (in 'diff -u'
c0232546 181format) to wine-patches@winehq.org list for inclusion in the next
ac3a9a32 182release.
8d24ae6d 183
3a5816f8
AJ
184--
185Alexandre Julliard
c0232546 186julliard@winehq.org