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