Commit | Line | Data |
---|---|---|
3a5816f8 AJ |
1 | 1. INTRODUCTION |
2 | ||
692389d0 | 3 | Wine is a program which allows running Microsoft Windows programs |
954514ec AE |
4 | (including DOS, Windows 3.x, Win32, and Win64 executables) on Unix. |
5 | It 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 | |
954514ec | 8 | be used for porting Windows 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 | |
4e474034 | 13 | |
d6baf1bb | 14 | 2. QUICK START |
3a5816f8 | 15 | |
581fc926 | 16 | Whenever you compile from source, it is recommended to use the Wine |
a0ff2b4a AM |
17 | Installer to build and install Wine. From the top-level directory |
18 | of the Wine source (which contains this file), run: | |
d6baf1bb AJ |
19 | |
20 | ./tools/wineinstall | |
21 | ||
4e474034 AJ |
22 | Run programs as "wine program". For more information and problem |
23 | resolution, read the rest of this file, the Wine man page, and | |
12f9bb7a | 24 | especially the wealth of information found at http://www.winehq.org. |
d6baf1bb | 25 | |
4e474034 | 26 | |
d6baf1bb | 27 | 3. REQUIREMENTS |
401710d7 | 28 | |
0ff60a08 | 29 | To 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 | |
37 | As Wine requires kernel-level thread support to run, only the operating | |
fef243cd GP |
38 | systems mentioned above are supported. Other operating systems which |
39 | support kernel threads may be supported 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), | |
4fe7ee8c | 44 | it's best to have a current kernel such as 2.4.x or 2.6.x. |
c9ec8846 AM |
45 | |
46 | FreeBSD 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 |
954514ec | 49 | http://wiki.freebsd.org/Wine for more information. |
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 | ||
bb8e625b | 61 | Mac OS X info: |
4e474034 | 62 | You need Xcode 2.4 or later to build properly on x86. |
c08b948f AM |
63 | |
64 | ||
65 | Supported 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 |
72 | Basic 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 | |
954514ec | 78 | You also need flex version 2.5.33 or later and bison. |
a5589d56 | 79 | |
c08b948f | 80 | Optional 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 | |
954514ec AE |
85 | On 64-bit platforms, if compiling Wine as 32-bit (default), you have |
86 | to make sure to install the 32-bit versions of these libraries; see | |
87 | http://wiki.winehq.org/WineOn64bit for details. If you want a true | |
88 | 64-bit Wine (or a mixed 32-bit and 64-bit Wine setup), see | |
89 | http://wiki.winehq.org/Wine64 for details. | |
6abb89c3 | 90 | |
d6baf1bb | 91 | 4. COMPILATION |
a69b88b2 | 92 | |
c9ec8846 AM |
93 | In case you chose to not use wineinstall, run the following commands |
94 | to build Wine: | |
401710d7 | 95 | |
d6baf1bb | 96 | ./configure |
d6baf1bb AJ |
97 | make |
98 | ||
a5589d56 | 99 | This will build the program "wine" and numerous support libraries/binaries. |
a0b2b1d0 | 100 | The program "wine" will load and run Windows executables. |
1af53cbb AM |
101 | The library "libwine" ("Winelib") can be used to compile and link |
102 | Windows source code under Unix. | |
d6baf1bb | 103 | |
1af53cbb | 104 | To see compile configuration options, do ./configure --help. |
e2bfa4c7 | 105 | |
d6baf1bb | 106 | 5. SETUP |
8d24ae6d | 107 | |
7e56f684 | 108 | Once Wine has been built correctly, you can do "make install"; this |
954514ec AE |
109 | will install the wine executable and libraries, the Wine man page, and |
110 | other needed files. | |
7e56f684 | 111 | |
de53c487 AM |
112 | Don't forget to uninstall any conflicting previous Wine installation |
113 | first. Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall" | |
114 | before installing. | |
115 | ||
6504ee44 AJ |
116 | Once installed, you can run the "winecfg" configuration tool. See the |
117 | Support area at http://www.winehq.org/ for configuration hints. | |
a0ff2b4a | 118 | |
4e474034 | 119 | |
d6baf1bb | 120 | 6. RUNNING PROGRAMS |
8d24ae6d | 121 | |
38a3d264 | 122 | When invoking Wine, you may specify the entire path to the executable, |
8d24ae6d AJ |
123 | or a filename only. |
124 | ||
1b81ee33 | 125 | For example: to run Notepad: |
8d24ae6d | 126 | |
954514ec AE |
127 | wine notepad (using the search Path as specified in |
128 | wine notepad.exe the registry to locate the file) | |
c08b948f | 129 | |
954514ec | 130 | wine c:\\windows\\notepad.exe (using DOS filename syntax) |
5f721f81 | 131 | |
954514ec | 132 | wine ~/.wine/drive_c/windows/notepad.exe (using Unix filename syntax) |
5f721f81 | 133 | |
954514ec | 134 | wine notepad.exe readme.txt (calling program with parameters) |
f41aeca9 | 135 | |
954514ec AE |
136 | Wine is not perfect, so some programs may crash. If that happens you |
137 | will get a crash log that you should attach to your report when filing | |
138 | a bug. | |
8d24ae6d | 139 | |
a6d83eba | 140 | |
12f9bb7a | 141 | 7. GETTING MORE INFORMATION |
46ea8b3f | 142 | |
3d2a38cf | 143 | WWW: A great deal of information about Wine is available from WineHQ at |
c0232546 | 144 | http://www.winehq.org/ : various Wine Guides, application database, |
3d2a38cf | 145 | bug tracking. This is probably the best starting point. |
8cd93514 | 146 | |
c0232546 | 147 | FAQ: The Wine FAQ is located at http://www.winehq.org/FAQ |
46ea8b3f | 148 | |
954514ec AE |
149 | Wiki: The Wine Wiki is located at http://wiki.winehq.org |
150 | ||
151 | Mailing lists: | |
152 | There are several mailing lists for Wine users and developers; | |
153 | see http://www.winehq.org/forums for more information. | |
0ff60a08 | 154 | |
c0232546 | 155 | Bugs: Report bugs to Wine Bugzilla at http://bugs.winehq.org |
ac3a9a32 | 156 | Please search the bugzilla database to check whether your |
954514ec | 157 | problem is already known or fixed before posting a bug report. |
46ea8b3f | 158 | |
344ed41d | 159 | IRC: Online help is available at channel #WineHQ on irc.freenode.net. |
8cd93514 | 160 | |
350fcb73 | 161 | Git: The current Wine development tree is available through Git. |
954514ec | 162 | Go to http://www.winehq.org/git for more information. |
3d2a38cf | 163 | |
954514ec AE |
164 | If you add something, or fix a bug, please send a patch (preferably |
165 | using git-format-patch) to the wine-patches@winehq.org list for | |
166 | inclusion in the next release. | |
8d24ae6d | 167 | |
3a5816f8 AJ |
168 | -- |
169 | Alexandre Julliard | |
c0232546 | 170 | julliard@winehq.org |