README

   1 1. INTRODUCTION
   2
   3 Wine is a program which allows running Microsoft Windows programs
   4 (including DOS, Windows 3.x and Win32 executables) on Unix.  It
   5 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 Win32 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 above
  32   FreeBSD 6.3 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 Linux info:
  42   While Linux 2.2.x should still work and Linux 2.0.x may still work
  43   (older 2.0.x versions had thread-related crashes),
  44   it's best to have a current kernel such as 2.4.x or 2.6.x.
  45
  46 FreeBSD info:
  47   Wine will generally not work properly on versions before FreeBSD
  48   6.3 or 7.0, and FreeBSD 6.3 has additional patches available. See
  49   <http://wiki.freebsd.org/Wine> for more information.
  50
  51 Solaris info:
  52   You will most likely need to build Wine with the GNU toolchain
  53   (gcc, gas, etc.). Warning : installing gas does *not* ensure that it
  54   will be used by gcc. Recompiling gcc after installing gas or
  55   symlinking cc, as and ld to the gnu tools is said to be necessary.
  56
  57 NetBSD info:
  58   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
  59   turned on in your kernel.
  60
  61 Mac OS X info:
  62   You need Xcode 2.4 or later to build properly on x86.
  63
  64
  65 Supported file systems:
  66   Wine should run on most file systems. A few compatibility problems
  67   have also been reported using files accessed through Samba. Also,
  68   NTFS does not provide all the file system features needed by some
  69   applications.  Using a native Linux file system such as ext3 is
  70   recommended.
  71
  72 Basic requirements:
  73   You need to have the X11 development include files installed
  74   (called xlib6g-dev in Debian and XFree86-devel in Red Hat).
  75
  76   Of course you also need "make" (most likely GNU make).
  77
  78   You also need flex version 2.5 or later and bison.
  79
  80 Optional support libraries:
  81   Configure will display notices when optional libraries are not found
  82   on your system. See http://wiki.winehq.org/Recommended_Packages for
  83   hints about the packages you should install.
  84
  85   On 64-bit platforms you have to make sure to install the 32-bit
  86   versions of these libraries; see http://wiki.winehq.org/WineOn64bit
  87   for details.
  88
  89 4. COMPILATION
  90
  91 In case you chose to not use wineinstall, run the following commands
  92 to build Wine:
  93
  94 ./configure
  95 make depend
  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 To upgrade to a new release by using a patch file, first cd to the
 106 top-level directory of the release (the one containing this README
 107 file). Then do a "make clean", and patch the release with:
 108
 109     bunzip2 -c patch-file | patch -p1
 110
 111 where "patch-file" is the name of the patch file (something like
 112 wine-1.0.x.diff.bz2). You can then re-run "./configure", and then
 113 run "make depend && make".
 114
 115
 116 5. SETUP
 117
 118 Once Wine has been built correctly, you can do "make install"; this
 119 will install the wine executable, the Wine man page, and a few other
 120 needed files.
 121
 122 Don't forget to uninstall any conflicting previous Wine installation
 123 first.  Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
 124 before installing.
 125
 126 Once installed, you can run the "winecfg" configuration tool. See the
 127 Support area at http://www.winehq.org/ for configuration hints.
 128
 129
 130 6. RUNNING PROGRAMS
 131
 132 When invoking Wine, you may specify the entire path to the executable,
 133 or a filename only.
 134
 135 For example: to run Notepad:
 136
 137         wine notepad               (using the search Path as specified in
 138         wine notepad.exe            the config file to locate the file)
 139
 140         wine c:\\windows\\notepad.exe  (using DOS filename syntax)
 141
 142         wine ~/.wine/drive_c/windows/notepad.exe  (using Unix filename syntax)
 143
 144         wine notepad.exe /parameter1 -parameter2 parameter3
 145                                    (calling program with parameters)
 146
 147 Wine is not yet complete, so several programs may crash. In that crash
 148 you will be dropped into the debugger so that you can investigate and
 149 fix the problem.  For more information on how to do this, please check
 150 the debugging section of the Wine Developer's Guide.
 151
 152
 153 7. GETTING MORE INFORMATION
 154
 155 WWW:    A great deal of information about Wine is available from WineHQ at
 156         http://www.winehq.org/ : various Wine Guides, application database,
 157         bug tracking. This is probably the best starting point.
 158
 159 FAQ:    The Wine FAQ is located at http://www.winehq.org/FAQ
 160
 161 Usenet: You can discuss Wine-related issues and get help
 162         on comp.emulators.ms-windows.wine.
 163
 164 Bugs:   Report bugs to Wine Bugzilla at http://bugs.winehq.org
 165         Please search the bugzilla database to check whether your
 166         problem is already found before posting a bug report.  You can
 167         also post bug reports to comp.emulators.ms-windows.wine.
 168
 169 IRC:    Online help is available at channel #WineHQ on irc.freenode.net.
 170
 171 Git:    The current Wine development tree is available through Git.
 172         Go to http://www.winehq.org/site/git for more information.
 173
 174 Mailing lists:
 175         There are several mailing lists for Wine users and developers;
 176         see http://www.winehq.org/forums for more information.
 177
 178 Wiki:   The Wine Wiki is located at http://wiki.winehq.org
 179
 180 If you add something, or fix a bug, please send a patch (in 'diff -u'
 181 format) to wine-patches@winehq.org list for inclusion in the next
 182 release.
 183
 184 --
 185 Alexandre Julliard
 186 julliard@winehq.org