source/README.md

158e9e763… Alex*0001 ## INTRODUCTION
3a5816f87… Alex*0002
692389d09… Doug*0003 Wine is a program which allows running Microsoft Windows programs
954514ec9… Aust*0004 (including DOS, Windows 3.x, Win32, and Win64 executables) on Unix.
                0005 It consists of a program loader which loads and executes a Microsoft
3d2a38cf1… Andr*0006 Windows binary, and a library (called Winelib) that implements Windows
aa2a90c41… Fran*0007 API calls using their Unix, X11 or Mac equivalents.  The library may also
954514ec9… Aust*0008 be used for porting Windows code into native Unix executables.
3a5816f87… Alex*0009
89894ffc1… Mart*0010 Wine is free software, released under the GNU LGPL; see the file
                0011 LICENSE for the details.
3a5816f87… Alex*0012
4e4740346… Alex*0013
158e9e763… Alex*0014 ## QUICK START
3a5816f87… Alex*0015
a33f4646c… Aust*0016 From the top-level directory of the Wine source (which contains this file),
                0017 run:
d6baf1bb1… Alex*0018
158e9e763… Alex*0019 ```
a33f4646c… Aust*0020 ./configure
                0021 make
158e9e763… Alex*0022 ```
d6baf1bb1… Alex*0023
97dea5bd0… Aust*0024 Then either install Wine:
c6ac65801… Aust*0025
158e9e763… Alex*0026 ```
c6ac65801… Aust*0027 make install
158e9e763… Alex*0028 ```
c6ac65801… Aust*0029
97dea5bd0… Aust*0030 Or run Wine directly from the build directory:
c6ac65801… Aust*0031
158e9e763… Alex*0032 ```
c6ac65801… Aust*0033 ./wine notepad
158e9e763… Alex*0034 ```
c6ac65801… Aust*0035
158e9e763… Alex*0036 Run programs as `wine program`. For more information and problem
4e4740346… Alex*0037 resolution, read the rest of this file, the Wine man page, and
92734380a… Aust*0038 especially the wealth of information found at https://www.winehq.org.
d6baf1bb1… Alex*0039
4e4740346… Alex*0040
158e9e763… Alex*0041 ## REQUIREMENTS
401710d75… Alex*0042
0ff60a08d… Jame*0043 To compile and run Wine, you must have one of the following:
f41aeca9f… Alex*0044
455086e29… Bren*0045 - Linux version 2.6.22 or later
158e9e763… Alex*0046 - FreeBSD 12.4 or later
                0047 - Solaris x86 9 or later
                0048 - NetBSD-current
                0049 - Mac OS X 10.8 or later
c08b948f4… Andr*0050
                0051 As Wine requires kernel-level thread support to run, only the operating
fef243cd8… Gera*0052 systems mentioned above are supported.  Other operating systems which
                0053 support kernel threads may be supported in the future.
f41aeca9f… Alex*0054
158e9e763… Alex*0055 **FreeBSD info**:
92734380a… Aust*0056   See https://wiki.freebsd.org/Wine for more information.
c9ec88464… Andr*0057
158e9e763… Alex*0058 **Solaris info**:
d2b22894a… Gera*0059   You will most likely need to build Wine with the GNU toolchain
2895e7f4f… Gera*0060   (gcc, gas, etc.). Warning : installing gas does *not* ensure that it
a5589d566… Andr*0061   will be used by gcc. Recompiling gcc after installing gas or
2895e7f4f… Gera*0062   symlinking cc, as and ld to the gnu tools is said to be necessary.
                0063
158e9e763… Alex*0064 **NetBSD info**:
9048c49b8… Bang*0065   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
                0066   turned on in your kernel.
                0067
158e9e763… Alex*0068 **Mac OS X info**:
dbafbcb56… Dean*0069   You need Xcode/Xcode Command Line Tools or Apple cctools.  The
                0070   minimum requirements for compiling Wine are clang 3.8 with the
                0071   MacOSX10.10.sdk and mingw-w64 v8.  The MacOSX10.14.sdk and later can
                0072   only build wine64.
c08b948f4… Andr*0073
158e9e763… Alex*0074 **Supported file systems**:
6504ee442… Alex*0075   Wine should run on most file systems. A few compatibility problems
                0076   have also been reported using files accessed through Samba. Also,
                0077   NTFS does not provide all the file system features needed by some
b93b90e29… Alex*0078   applications.  Using a native Unix file system is recommended.
c9ec88464… Andr*0079
158e9e763… Alex*0080 **Basic requirements**:
c08b948f4… Andr*0081   You need to have the X11 development include files installed
8c65205d2… Flor*0082   (called xorg-dev in Debian and libX11-devel in Red Hat).
158e9e763… Alex*0083   Of course you also need make (most likely GNU make).
954514ec9… Aust*0084   You also need flex version 2.5.33 or later and bison.
a5589d566… Andr*0085
158e9e763… Alex*0086 **Optional support libraries**:
6504ee442… Alex*0087   Configure will display notices when optional libraries are not found
92734380a… Aust*0088   on your system. See https://wiki.winehq.org/Recommended_Packages for
d8fe80c5c… Alex*0089   hints about the packages you should install. On 64-bit platforms,
                0090   you have to make sure to install the 32-bit versions of these
                0091   libraries.
6abb89c3b… Alex*0092
a924b9e1f… Fran*0093
158e9e763… Alex*0094 ## COMPILATION
a69b88b2f… Alex*0095
a33f4646c… Aust*0096 To build Wine, do:
401710d75… Alex*0097
158e9e763… Alex*0098 ```
d6baf1bb1… Alex*0099 ./configure
                0100 make
158e9e763… Alex*0101 ```
d6baf1bb1… Alex*0102
a5589d566… Andr*0103 This will build the program "wine" and numerous support libraries/binaries.
a0b2b1d0f… Alex*0104 The program "wine" will load and run Windows executables.
1af53cbb2… Andr*0105 The library "libwine" ("Winelib") can be used to compile and link
                0106 Windows source code under Unix.
d6baf1bb1… Alex*0107
158e9e763… Alex*0108 To see compile configuration options, do `./configure --help`.
e2bfa4c72… Alex*0109
a33f4646c… Aust*0110 For more information, see https://wiki.winehq.org/Building_Wine
                0111
a924b9e1f… Fran*0112
158e9e763… Alex*0113 ## SETUP
8d24ae6d3… Alex*0114
158e9e763… Alex*0115 Once Wine has been built correctly, you can do `make install`; this
954514ec9… Aust*0116 will install the wine executable and libraries, the Wine man page, and
                0117 other needed files.
7e56f6843… Alex*0118
de53c487c… Andr*0119 Don't forget to uninstall any conflicting previous Wine installation
158e9e763… Alex*0120 first.  Try either `dpkg -r wine` or `rpm -e wine` or `make uninstall`
de53c487c… Andr*0121 before installing.
                0122
158e9e763… Alex*0123 Once installed, you can run the `winecfg` configuration tool. See the
92734380a… Aust*0124 Support area at https://www.winehq.org/ for configuration hints.
a0ff2b4ad… Andr*0125
4e4740346… Alex*0126
158e9e763… Alex*0127 ## RUNNING PROGRAMS
8d24ae6d3… Alex*0128
38a3d264f… Jame*0129 When invoking Wine, you may specify the entire path to the executable,
8d24ae6d3… Alex*0130 or a filename only.
                0131
158e9e763… Alex*0132 For example, to run Notepad:
8d24ae6d3… Alex*0133
158e9e763… Alex*0134 ```
                0135 wine notepad            (using the search Path as specified in
                0136 wine notepad.exe         the registry to locate the file)
c08b948f4… Andr*0137
158e9e763… Alex*0138 wine c:\\windows\\notepad.exe      (using DOS filename syntax)
5f721f81f… Alex*0139
158e9e763… Alex*0140 wine ~/.wine/drive_c/windows/notepad.exe  (using Unix filename syntax)
5f721f81f… Alex*0141
158e9e763… Alex*0142 wine notepad.exe readme.txt          (calling program with parameters)
                0143 ```
f41aeca9f… Alex*0144
954514ec9… Aust*0145 Wine is not perfect, so some programs may crash. If that happens you
                0146 will get a crash log that you should attach to your report when filing
                0147 a bug.
8d24ae6d3… Alex*0148
a6d83ebae… Andr*0149
158e9e763… Alex*0150 ## GETTING MORE INFORMATION
46ea8b3f7… Alex*0151
158e9e763… Alex*0152 - **WWW**: A great deal of information about Wine is available from WineHQ at
92734380a… Aust*0153         https://www.winehq.org/ : various Wine Guides, application database,
3d2a38cf1… Andr*0154         bug tracking. This is probably the best starting point.
8cd93514f… Andr*0155
158e9e763… Alex*0156 - **FAQ**: The Wine FAQ is located at https://www.winehq.org/FAQ
46ea8b3f7… Alex*0157
158e9e763… Alex*0158 - **Wiki**: The Wine Wiki is located at https://wiki.winehq.org
954514ec9… Aust*0159
158e9e763… Alex*0160 - **Gitlab**: Wine development is hosted at https://gitlab.winehq.org
3253cbd86… Alex*0161
158e9e763… Alex*0162 - **Mailing lists**:
954514ec9… Aust*0163         There are several mailing lists for Wine users and developers;
92734380a… Aust*0164         see https://www.winehq.org/forums for more information.
0ff60a08d… Jame*0165
158e9e763… Alex*0166 - **Bugs**: Report bugs to Wine Bugzilla at https://bugs.winehq.org
ac3a9a327… Andr*0167         Please search the bugzilla database to check whether your
954514ec9… Aust*0168         problem is already known or fixed before posting a bug report.
46ea8b3f7… Alex*0169
158e9e763… Alex*0170 - **IRC**: Online help is available at channel `#WineHQ` on irc.libera.chat.