README

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