Commit | Line | Data |
---|---|---|
3a5816f8 AJ |
1 | 1. INTRODUCTION |
2 | ||
692389d0 DR |
3 | Wine is a program which allows running Microsoft Windows programs |
4 | (including DOS, Windows 3.x and Win32 executables) on Unix. It | |
0ff60a08 | 5 | consists of a program loader which loads and executes a Microsoft |
3d2a38cf AM |
6 | Windows binary, and a library (called Winelib) that implements Windows |
7 | API calls using their Unix or X11 equivalents. The library may also | |
8 | be used for porting Win32 code into native Unix executables. | |
3a5816f8 | 9 | |
89894ffc MG |
10 | Wine is free software, released under the GNU LGPL; see the file |
11 | LICENSE for the details. | |
3a5816f8 | 12 | |
d6baf1bb | 13 | 2. QUICK START |
3a5816f8 | 14 | |
581fc926 | 15 | Whenever you compile from source, it is recommended to use the Wine |
a0ff2b4a AM |
16 | Installer to build and install Wine. From the top-level directory |
17 | of the Wine source (which contains this file), run: | |
d6baf1bb AJ |
18 | |
19 | ./tools/wineinstall | |
20 | ||
21 | Run programs as "wine [options] program". For more information and | |
3d2a38cf | 22 | problem resolution, read the rest of this file, the Wine man page, |
a0ff2b4a | 23 | the files in the documentation directory of the Wine source |
b6e84187 | 24 | (see "DOCUMENTATION"), and especially the wealth of information |
c0232546 | 25 | found at http://www.winehq.org. |
d6baf1bb AJ |
26 | |
27 | 3. REQUIREMENTS | |
401710d7 | 28 | |
0ff60a08 | 29 | To compile and run Wine, you must have one of the following: |
f41aeca9 | 30 | |
c08b948f AM |
31 | Linux version 2.0.36 or above |
32 | FreeBSD 4.x or FreeBSD 5-CURRENT or later | |
33 | Solaris x86 2.5 or later | |
34 | NetBSD-current | |
35 | ||
36 | As Wine requires kernel-level thread support to run, only the operating | |
37 | systems mentioned above are supported. | |
38 | Other operating systems which support kernel threads may be supported | |
39 | in the future. | |
f41aeca9 | 40 | |
c9ec8846 | 41 | Linux 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), | |
44 | it's best to have a current kernel such as 2.4.x. | |
c9ec8846 AM |
45 | |
46 | FreeBSD info: | |
25a38796 GP |
47 | Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG |
48 | options turned on in your kernel. More information is in the ports | |
49 | tree: ftp://ftp.freebsd.org/pub/FreeBSD/ports/ports/emulators/wine/ | |
c9ec8846 AM |
50 | |
51 | Solaris 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 |
57 | NetBSD 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 | ||
63 | Supported 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 |
71 | Basic 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 |
75 | Build 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 |
87 | Optional support libraries: |
88 | If you want CUPS printing support, please install both cups and cups-devel | |
89 | packages. | |
6abb89c3 | 90 | |
c08b948f AM |
91 | For the automatic processing of the test suite scripts, you also need |
92 | libperl development header support (libperl-dev package on Debian). | |
a5589d56 | 93 | |
b6e84187 AM |
94 | For requirements in case you intend to build the documentation yourself, |
95 | see "DOCUMENTATION" section. | |
0ee5f8c6 | 96 | |
d6baf1bb | 97 | 4. COMPILATION |
a69b88b2 | 98 | |
c9ec8846 AM |
99 | In case you chose to not use wineinstall, run the following commands |
100 | to build Wine: | |
401710d7 | 101 | |
d6baf1bb AJ |
102 | ./configure |
103 | make depend | |
104 | make | |
105 | ||
a5589d56 | 106 | This will build the program "wine" and numerous support libraries/binaries. |
a0b2b1d0 | 107 | The program "wine" will load and run Windows executables. |
1af53cbb AM |
108 | The library "libwine" ("Winelib") can be used to compile and link |
109 | Windows source code under Unix. | |
d6baf1bb | 110 | |
1af53cbb | 111 | To see compile configuration options, do ./configure --help. |
e2bfa4c7 | 112 | |
3a5816f8 AJ |
113 | To upgrade to a new release by using a patch file, first cd to the |
114 | top-level directory of the release (the one containing this README | |
115 | file). Then do a "make clean", and patch the release with: | |
116 | ||
117 | gunzip -c patch-file | patch -p1 | |
f41aeca9 | 118 | |
3a5816f8 | 119 | where "patch-file" is the name of the patch file (something like |
ff8331ea | 120 | Wine-yymmdd.diff.gz). You can then re-run "./configure", and then |
d6baf1bb | 121 | run "make depend && make". |
5f721f81 | 122 | |
d6baf1bb | 123 | 5. SETUP |
8d24ae6d | 124 | |
7e56f684 | 125 | Once Wine has been built correctly, you can do "make install"; this |
38a3d264 JJ |
126 | will install the wine executable, the Wine man page, and a few other |
127 | needed files. | |
7e56f684 | 128 | |
de53c487 AM |
129 | Don't forget to uninstall any conflicting previous Wine installation |
130 | first. Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall" | |
131 | before installing. | |
132 | ||
b6e84187 | 133 | If you want to read the documentation supplied with the Wine source, |
a0ff2b4a | 134 | see the "DOCUMENTATION" section. |
0ee5f8c6 | 135 | |
3d2a38cf | 136 | Wine requires a configuration file named named "config" in your |
7bed696a AM |
137 | ~/.wine directory. The format of this file is explained in the config file |
138 | man page (documentation/wine.conf.man). | |
139 | The file documentation/samples/config contains an example configuration file | |
140 | which has to be adapted and copied to the location mentioned above. | |
8a82991a | 141 | |
c0232546 | 142 | See the Support area at http://www.winehq.org/ for further |
c08b948f | 143 | configuration hints. |
8d24ae6d | 144 | |
a0ff2b4a AM |
145 | In case of library loading errors |
146 | (e.g. "Error while loading shared libraries: libntdll.so"), make sure | |
147 | to add the library path to /etc/ld.so.conf and run ldconfig as root. | |
148 | ||
d6baf1bb | 149 | 6. RUNNING PROGRAMS |
8d24ae6d | 150 | |
38a3d264 | 151 | When invoking Wine, you may specify the entire path to the executable, |
8d24ae6d AJ |
152 | or a filename only. |
153 | ||
692389d0 | 154 | For example: to run Solitaire: |
8d24ae6d | 155 | |
c08b948f AM |
156 | wine sol (using the search Path as specified in |
157 | wine sol.exe the config file to locate the file) | |
158 | ||
159 | wine c:\\windows\\sol.exe (using DOS filename syntax) | |
5f721f81 | 160 | |
c08b948f | 161 | wine /usr/windows/sol.exe (using Unix filename syntax) |
5f721f81 | 162 | |
f950d973 | 163 | wine sol.exe /parameter1 -parameter2 parameter3 |
c08b948f | 164 | (calling program with parameters) |
f41aeca9 | 165 | |
3a5816f8 | 166 | Note: the path of the file will also be added to the path when |
5819953c AJ |
167 | a full name is supplied on the commandline. |
168 | ||
b6e84187 | 169 | Wine is not yet complete, so several programs may crash. Provided you set up |
581fc926 | 170 | winedbg correctly according to documentation/debugger.sgml, you will be dropped |
a0ff2b4a AM |
171 | into a debugger so that you can investigate and fix the problem. |
172 | For more information on how to do this, please read the file | |
173 | documentation/debugging.sgml. | |
8d24ae6d | 174 | |
a6d83eba AM |
175 | You should backup all your important files that you give Wine access |
176 | to, or use a special Wine copy of them, as there have been some cases | |
177 | of users reporting file corruption. Do NOT run Explorer, for instance, | |
178 | if you don't have a proper backup, as it renames/cripples several | |
7bed696a AM |
179 | directories sometimes. Not even other MS apps such as e.g. Messenger are safe, |
180 | as they launch Explorer somehow. This particular corruption (!$!$!$!$.pfr) | |
a69c039c AM |
181 | can at least partially be fixed by using |
182 | http://home.nexgo.de/andi.mohr/download/decorrupt_explorer | |
a6d83eba | 183 | |
b6e84187 AM |
184 | 7. DOCUMENTATION |
185 | ||
186 | Some documentation (various Wine Guides etc.) can be found in the | |
187 | documentation/ directory (apart from also being available on WineHQ). | |
188 | ||
5b80ce35 | 189 | If you want to process the SGML files in there, then you can run "make doc" |
b6e84187 AM |
190 | in the documentation/ directory. |
191 | Doing so requires the sgml tools package (for db2html, db2ps, db2pdf) named: | |
192 | Debian: docbook-utils | |
193 | Mandrake: sgml-tools-A.B.C-DDmdk | |
194 | SuSE: docbktls-A.BB.C-DD | |
8d24ae6d | 195 | |
b6e84187 | 196 | 8. GETTING MORE INFORMATION |
46ea8b3f | 197 | |
3d2a38cf | 198 | WWW: A great deal of information about Wine is available from WineHQ at |
c0232546 | 199 | http://www.winehq.org/ : various Wine Guides, application database, |
3d2a38cf | 200 | bug tracking. This is probably the best starting point. |
8cd93514 | 201 | |
c0232546 | 202 | FAQ: The Wine FAQ is located at http://www.winehq.org/FAQ |
46ea8b3f | 203 | |
ac3a9a32 AP |
204 | Usenet: You can discuss Wine-related issues and get help |
205 | on comp.emulators.ms-windows.wine. | |
0ff60a08 | 206 | |
c0232546 | 207 | Bugs: Report bugs to Wine Bugzilla at http://bugs.winehq.org |
ac3a9a32 AP |
208 | Please search the bugzilla database to check whether your |
209 | problem is already found before posting a bug report. You can | |
210 | also post bug reports to comp.emulators.ms-windows.wine. | |
211 | Please read the file documentation/bugs.sgml to see what | |
212 | information is required. | |
46ea8b3f | 213 | |
344ed41d | 214 | IRC: Online help is available at channel #WineHQ on irc.freenode.net. |
8cd93514 | 215 | |
38a3d264 | 216 | CVS: The current Wine development tree is available through CVS. |
c0232546 | 217 | Go to http://www.winehq.org/cvs for more information. |
8d24ae6d | 218 | |
3d2a38cf | 219 | Mailing lists: |
a5589d56 | 220 | There are several mailing lists for Wine developers; see |
c0232546 | 221 | http://www.winehq.org/forums for more information. |
3d2a38cf | 222 | |
b6e84187 | 223 | If you add something, or fix a bug, please send a patch (in 'diff -u' |
c0232546 | 224 | format) to wine-patches@winehq.org list for inclusion in the next |
ac3a9a32 | 225 | release. |
8d24ae6d | 226 | |
3a5816f8 AJ |
227 | -- |
228 | Alexandre Julliard | |
c0232546 | 229 | julliard@winehq.org |