README.md

   1 ## INTRODUCTION
   2
   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, X11 or Mac equivalents.  The library may also
   8 be used for porting Windows code into native Unix executables.
   9
  10 Wine is free software, released under the GNU LGPL; see the file
  11 LICENSE for the details.
  12
  13
  14 ## QUICK START
  15
  16 From the top-level directory of the Wine source (which contains this file),
  17 run:
  18
  19 ```
  20 ./configure
  21 make
  22 ```
  23
  24 Then either install Wine:
  25
  26 ```
  27 make install
  28 ```
  29
  30 Or run Wine directly from the build directory:
  31
  32 ```
  33 ./wine notepad
  34 ```
  35
  36 Run programs as `wine program`. For more information and problem
  37 resolution, read the rest of this file, the Wine man page, and
  38 especially the wealth of information found at https://www.winehq.org.
  39
  40
  41 ## REQUIREMENTS
  42
  43 To compile and run Wine, you must have one of the following:
  44
  45 - Linux version 2.6.22 or later
  46 - FreeBSD 12.4 or later
  47 - Solaris x86 9 or later
  48 - NetBSD-current
  49 - Mac OS X 10.8 or later
  50
  51 As Wine requires kernel-level thread support to run, only the operating
  52 systems mentioned above are supported.  Other operating systems which
  53 support kernel threads may be supported in the future.
  54
  55 **FreeBSD info**:
  56   See https://wiki.freebsd.org/Wine for more information.
  57
  58 **Solaris info**:
  59   You will most likely need to build Wine with the GNU toolchain
  60   (gcc, gas, etc.). Warning : installing gas does *not* ensure that it
  61   will be used by gcc. Recompiling gcc after installing gas or
  62   symlinking cc, as and ld to the gnu tools is said to be necessary.
  63
  64 **NetBSD info**:
  65   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
  66   turned on in your kernel.
  67
  68 **Mac OS X info**:
  69   You need Xcode/Xcode Command Line Tools or Apple cctools.  The
  70   minimum requirements for compiling Wine are clang 3.8 with the
  71   MacOSX10.10.sdk and mingw-w64 v8.  The MacOSX10.14.sdk and later can
  72   only build wine64.
  73
  74 **Supported file systems**:
  75   Wine should run on most file systems. A few compatibility problems
  76   have also been reported using files accessed through Samba. Also,
  77   NTFS does not provide all the file system features needed by some
  78   applications.  Using a native Unix file system is recommended.
  79
  80 **Basic requirements**:
  81   You need to have the X11 development include files installed
  82   (called xorg-dev in Debian and libX11-devel in Red Hat).
  83   Of course you also need make (most likely GNU make).
  84   You also need flex version 2.5.33 or later and bison.
  85
  86 **Optional support libraries**:
  87   Configure will display notices when optional libraries are not found
  88   on your system. See https://wiki.winehq.org/Recommended_Packages for
  89   hints about the packages you should install. On 64-bit platforms,
  90   you have to make sure to install the 32-bit versions of these
  91   libraries.
  92
  93
  94 ## COMPILATION
  95
  96 To build Wine, do:
  97
  98 ```
  99 ./configure
 100 make
 101 ```
 102
 103 This will build the program "wine" and numerous support libraries/binaries.
 104 The program "wine" will load and run Windows executables.
 105 The library "libwine" ("Winelib") can be used to compile and link
 106 Windows source code under Unix.
 107
 108 To see compile configuration options, do `./configure --help`.
 109
 110 For more information, see https://wiki.winehq.org/Building_Wine
 111
 112
 113 ## SETUP
 114
 115 Once Wine has been built correctly, you can do `make install`; this
 116 will install the wine executable and libraries, the Wine man page, and
 117 other needed files.
 118
 119 Don't forget to uninstall any conflicting previous Wine installation
 120 first.  Try either `dpkg -r wine` or `rpm -e wine` or `make uninstall`
 121 before installing.
 122
 123 Once installed, you can run the `winecfg` configuration tool. See the
 124 Support area at https://www.winehq.org/ for configuration hints.
 125
 126
 127 ## RUNNING PROGRAMS
 128
 129 When invoking Wine, you may specify the entire path to the executable,
 130 or a filename only.
 131
 132 For example, to run Notepad:
 133
 134 ```
 135 wine notepad            (using the search Path as specified in
 136 wine notepad.exe         the registry to locate the file)
 137
 138 wine c:\\windows\\notepad.exe      (using DOS filename syntax)
 139
 140 wine ~/.wine/drive_c/windows/notepad.exe  (using Unix filename syntax)
 141
 142 wine notepad.exe readme.txt          (calling program with parameters)
 143 ```
 144
 145 Wine is not perfect, so some programs may crash. If that happens you
 146 will get a crash log that you should attach to your report when filing
 147 a bug.
 148
 149
 150 ## GETTING MORE INFORMATION
 151
 152 - **WWW**: A great deal of information about Wine is available from WineHQ at
 153         https://www.winehq.org/ : various Wine Guides, application database,
 154         bug tracking. This is probably the best starting point.
 155
 156 - **FAQ**: The Wine FAQ is located at https://www.winehq.org/FAQ
 157
 158 - **Wiki**: The Wine Wiki is located at https://wiki.winehq.org
 159
 160 - **Gitlab**: Wine development is hosted at https://gitlab.winehq.org
 161
 162 - **Mailing lists**:
 163         There are several mailing lists for Wine users and developers;
 164         see https://www.winehq.org/forums for more information.
 165
 166 - **Bugs**: Report bugs to Wine Bugzilla at https://bugs.winehq.org
 167         Please search the bugzilla database to check whether your
 168         problem is already known or fixed before posting a bug report.
 169
 170 - **IRC**: Online help is available at channel `#WineHQ` on irc.libera.chat.