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