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