secur32/tests: Include winsock2.h before other headers.
[wine.git] / README
blob16270816bf6b1ae1aeb763a6aba88435a97252e8
1 1. INTRODUCTION
3 Wine is a program which allows running Microsoft Windows programs
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
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 Windows code into native Unix executables.
10 Wine is free software, released under the GNU LGPL; see the file
11 LICENSE for the details.
14 2. QUICK START
16 Whenever you compile from source, it is recommended to use the Wine
17 Installer to build and install Wine.  From the top-level directory
18 of the Wine source (which contains this file), run:
20 ./tools/wineinstall
22 Run programs as "wine program".  For more information and problem
23 resolution, read the rest of this file, the Wine man page, and
24 especially the wealth of information found at http://www.winehq.org.
27 3. REQUIREMENTS
29 To compile and run Wine, you must have one of the following:
31   Linux version 2.0.36 or later
32   FreeBSD 8.0 or later
33   Solaris x86 9 or later
34   NetBSD-current
35   Mac OS X 10.5 or later
37 As Wine requires kernel-level thread support to run, only the operating
38 systems mentioned above are supported.  Other operating systems which
39 support kernel threads may be supported in the future.
41 FreeBSD info:
42   Wine will generally not work properly on versions before FreeBSD 8.0.
43   See http://wiki.freebsd.org/Wine for more information.
45 Solaris info:
46   You will most likely need to build Wine with the GNU toolchain
47   (gcc, gas, etc.). Warning : installing gas does *not* ensure that it
48   will be used by gcc. Recompiling gcc after installing gas or
49   symlinking cc, as and ld to the gnu tools is said to be necessary.
51 NetBSD info:
52   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
53   turned on in your kernel.
55 Mac OS X info:
56   You need Xcode 2.4 or later to build properly on x86.
57   The Mac driver requires OS X 10.6 or later and won't be built on 10.5.
60 Supported file systems:
61   Wine should run on most file systems. A few compatibility problems
62   have also been reported using files accessed through Samba. Also,
63   NTFS does not provide all the file system features needed by some
64   applications.  Using a native Unix file system is recommended.
66 Basic requirements:
67   You need to have the X11 development include files installed
68   (called xlib6g-dev in Debian and XFree86-devel in Red Hat).
70   Of course you also need "make" (most likely GNU make).
72   You also need flex version 2.5.33 or later and bison.
74 Optional support libraries:
75   Configure will display notices when optional libraries are not found
76   on your system. See http://wiki.winehq.org/Recommended_Packages for
77   hints about the packages you should install.
79   On 64-bit platforms, if compiling Wine as 32-bit (default), you have
80   to make sure to install the 32-bit versions of these libraries; see
81   http://wiki.winehq.org/WineOn64bit for details. If you want a true
82   64-bit Wine (or a mixed 32-bit and 64-bit Wine setup), see
83   http://wiki.winehq.org/Wine64 for details.
85 4. COMPILATION
87 In case you chose to not use wineinstall, run the following commands
88 to build Wine:
90 ./configure
91 make
93 This will build the program "wine" and numerous support libraries/binaries.
94 The program "wine" will load and run Windows executables.
95 The library "libwine" ("Winelib") can be used to compile and link
96 Windows source code under Unix.
98 To see compile configuration options, do ./configure --help.
100 5. SETUP
102 Once Wine has been built correctly, you can do "make install"; this
103 will install the wine executable and libraries, the Wine man page, and
104 other needed files.
106 Don't forget to uninstall any conflicting previous Wine installation
107 first.  Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
108 before installing.
110 Once installed, you can run the "winecfg" configuration tool. See the
111 Support area at http://www.winehq.org/ for configuration hints.
114 6. RUNNING PROGRAMS
116 When invoking Wine, you may specify the entire path to the executable,
117 or a filename only.
119 For example: to run Notepad:
121     wine notepad            (using the search Path as specified in
122     wine notepad.exe         the registry to locate the file)
124     wine c:\\windows\\notepad.exe      (using DOS filename syntax)
126     wine ~/.wine/drive_c/windows/notepad.exe  (using Unix filename syntax)
128     wine notepad.exe readme.txt          (calling program with parameters)
130 Wine is not perfect, so some programs may crash. If that happens you
131 will get a crash log that you should attach to your report when filing
132 a bug.
135 7. GETTING MORE INFORMATION
137 WWW:    A great deal of information about Wine is available from WineHQ at
138         http://www.winehq.org/ : various Wine Guides, application database,
139         bug tracking. This is probably the best starting point.
141 FAQ:    The Wine FAQ is located at http://www.winehq.org/FAQ
143 Wiki:   The Wine Wiki is located at http://wiki.winehq.org
145 Mailing lists:
146         There are several mailing lists for Wine users and developers;
147         see http://www.winehq.org/forums for more information.
149 Bugs:   Report bugs to Wine Bugzilla at http://bugs.winehq.org
150         Please search the bugzilla database to check whether your
151         problem is already known or fixed before posting a bug report.
153 IRC:    Online help is available at channel #WineHQ on irc.freenode.net.
155 Git:    The current Wine development tree is available through Git.
156         Go to http://www.winehq.org/git for more information.
158 If you add something, or fix a bug, please send a patch (preferably
159 using git-format-patch) to the wine-patches@winehq.org list for
160 inclusion in the next release.
163 Alexandre Julliard
164 julliard@winehq.org