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 2. QUICK START
  14
  15 Whenever you compile from source, it is recommended to use the Wine
  16 Installer to build and install Wine.  From the top-level directory
  17 of the Wine source (which contains this file), run:
  18
  19 ./tools/wineinstall
  20
  21 Run programs as "wine [options] program".  For more information and
  22 problem resolution, read the rest of this file, the Wine man page,
  23 the files in the documentation directory of the Wine source
  24 (see "DOCUMENTATION"), and especially the wealth of information
  25 found at http://www.winehq.com.
  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 4.x or FreeBSD 5-CURRENT
  33         Solaris x86 2.5 or later
  34         NetBSD-current
  35
  36 Linux info:
  37   Although Linux version 2.0.x will mostly work, certain features
  38   (specifically LDT sharing) required for properly supporting Win32
  39   threads were not implemented until kernel version 2.2.  If you get
  40   consistent thread-related crashes, you may want to upgrade to at least 2.2.
  41   Also, some bugs were fixed and additional features were added
  42   late in the Linux 2.0.x series, so if you have a very old Linux kernel,
  43   you may want to upgrade to at least the latest 2.0.x release.
  44
  45 FreeBSD info:
  46   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
  47   turned on in your kernel.
  48   More information including patches for the 4-STABLE branch is in the
  49   ports tree:
  50   ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/ports/emulators/wine/files/
  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 File systems info:
  63   Wine should run on most file systems. However, Wine will fail to start
  64   if umsdos is used for the /tmp directory. A few compatibility problems have
  65   also been reported using files accessed through Samba. Also, as NTFS
  66   can only be used safely with readonly access for now, we recommend against
  67   using NTFS, as Windows programs need write access almost everywhere.
  68   In case of NTFS files, copy over to a writable location.
  69
  70 Wine requires kernel-level threads to run. Currently, only Linux
  71 version 2.0 or later, FreeBSD-current or FreeBSD 3.0 or later,
  72 Solaris x86 version 2.5 or later, and NetBSD-current are supported.
  73 Other operating systems which support kernel threads may be supported
  74 in the future.
  75
  76 You need to have the X11 development include files installed
  77 (called xlib6g-dev in Debian and XFree86-devel in RedHat).
  78 To use Wine's support for multi-threaded applications, your X libraries
  79 must be reentrant, which is probably the default by now.
  80 If you have libc6 (glibc2), or you compiled the X libraries yourself,
  81 they were probably compiled with the reentrant option enabled.
  82
  83 On x86 Systems gcc >= 2.7.2 is required.
  84 Versions earlier than 2.7.2.3 may have problems when certain files
  85 are compiled with optimization, often due to problems with header file
  86 management. pgcc currently doesn't work with Wine. The cause of this problem
  87 is unknown.
  88
  89 You also need flex version 2.5 or later and yacc.
  90 Bison will work as a replacement for yacc. If you are
  91 using RedHat or Debian, install the flex and bison packages.
  92
  93 For requirements in case you intend to build the documentation yourself,
  94 see "DOCUMENTATION" section.
  95
  96 4. COMPILATION
  97
  98 In case you chose to not use wineinstall, run the following commands
  99 to build Wine:
 100
 101 ./configure
 102 make depend
 103 make
 104
 105 This will build the program "wine" and numerous support libraries/binaries.
 106 The program "wine" will load and run Windows executables.
 107 The library "libwine" ("Winelib") can be used to compile and link
 108 Windows source code under Unix.
 109
 110 To see compile configuration options, do ./configure --help.
 111
 112 To upgrade to a new release by using a patch file, first cd to the
 113 top-level directory of the release (the one containing this README
 114 file). Then do a "make clean", and patch the release with:
 115
 116     gunzip -c patch-file | patch -p1
 117
 118 where "patch-file" is the name of the patch file (something like
 119 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
 120 run "make depend && make".
 121
 122 5. SETUP
 123
 124 Once Wine has been built correctly, you can do "make install"; this
 125 will install the wine executable, the Wine man page, and a few other
 126 needed files.
 127
 128 Don't forget to uninstall any conflicting previous Wine installation
 129 first.  Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
 130 before installing.
 131
 132 If you want to read the documentation supplied with the Wine source,
 133 see the "DOCUMENTATION" section.
 134
 135 Wine requires a configuration file named named "config" in your
 136 ~/.wine directory. The format of this file is explained in the config file
 137 man page (documentation/wine.conf.man).
 138 The file documentation/samples/config contains an example configuration file
 139 which has to be adapted and copied to the location mentioned above.
 140
 141 Don't forget to add vital registry entries by applying winedefault.reg
 142 with programs/regapi/. See documentation/ directory for details.
 143
 144 See http://www.winehq.com/support.shtml for further configuration hints.
 145
 146 In case of library loading errors
 147 (e.g. "Error while loading shared libraries: libntdll.so"), make sure
 148 to add the library path to /etc/ld.so.conf and run ldconfig as root.
 149
 150 In order to verify the correctness of the environment you need for
 151 Wine to run successfully, you may run "./tools/winecheck | less".
 152 You'll get a percentage score indicating "Wine configuration correctness".
 153 As this program is alpha, it doesn't run a truly thorough test yet, though,
 154 so it should be taken as a first verification step only.
 155
 156 See wine.conf man page on how to switch to text mode only support if desired.
 157
 158 6. RUNNING PROGRAMS
 159
 160 When invoking Wine, you may specify the entire path to the executable,
 161 or a filename only.
 162
 163 For example: to run Solitaire:
 164
 165         wine sol                   (using the searchpath to locate the file)
 166         wine sol.exe
 167
 168         wine c:\\windows\\sol.exe  (using a DOS filename)
 169
 170         wine /usr/windows/sol.exe  (using a Unix filename)
 171
 172 Note: the path of the file will also be added to the path when
 173       a full name is supplied on the commandline.
 174
 175 Wine is not yet complete, so several programs may crash. Provided you set up
 176 winedbg correctly according to documentation/debugger.sgml, you will be dropped
 177 into a debugger so that you can investigate and fix the problem.
 178 For more information on how to do this, please read the file
 179 documentation/debugging.sgml.
 180
 181 You should backup all your important files that you give Wine access
 182 to, or use a special Wine copy of them, as there have been some cases
 183 of users reporting file corruption. Do NOT run Explorer, for instance,
 184 if you don't have a proper backup, as it renames/cripples several
 185 directories sometimes. Not even other MS apps such as e.g. Messenger are safe,
 186 as they launch Explorer somehow. This particular corruption (!$!$!$!$.pfr)
 187 can at least partially be fixed by using
 188 http://home.nexgo.de/andi.mohr/download/decorrupt_explorer
 189
 190 7. DOCUMENTATION
 191
 192 Some documentation (various Wine Guides etc.) can be found in the
 193 documentation/ directory (apart from also being available on WineHQ).
 194
 195 If you want to process the SGML files in there, then you can run "make"
 196 in the documentation/ directory.
 197 Doing so requires the sgml tools package (for db2html, db2ps, db2pdf) named:
 198 Debian:         docbook-utils
 199 Mandrake:       sgml-tools-A.B.C-DDmdk
 200 SuSE:           docbktls-A.BB.C-DD
 201
 202 8. GETTING MORE INFORMATION
 203
 204 WWW:    A great deal of information about Wine is available from WineHQ at
 205         http://www.winehq.com/ : various Wine Guides, application database,
 206         bug tracking. This is probably the best starting point.
 207
 208 FAQ:    The Wine FAQ is located at http://www.winehq.com/FAQ
 209
 210 Usenet: You can discuss Wine-related issues and get help
 211         on comp.emulators.ms-windows.wine.
 212
 213 Bugs:   Report bugs to Wine Bugzilla at http://bugs.winehq.com/.
 214         Please search the bugzilla database to check whether your
 215         problem is already found before posting a bug report.  You can
 216         also post bug reports to comp.emulators.ms-windows.wine.
 217         Please read the file documentation/bugs.sgml to see what
 218         information is required.
 219
 220 HOWTO:  The Wine HOWTO (outdated !) is available at
 221         http://www.westfalen.de/witch/wine-HOWTO.txt .
 222
 223 IRC:    Online help is available at channel #WineHQ on irc.openprojects.net.
 224
 225 CVS:    The current Wine development tree is available through CVS.
 226         Go to http://www.winehq.com/dev.shtml for more information.
 227
 228 Mailing lists:
 229         There are several mailing lists for Wine developers; see
 230         http://www.winehq.com/dev.shtml#ml for more information.
 231
 232 If you add something, or fix a bug, please send a patch (in 'diff -u'
 233 format) to wine-patches@winehq.com list for inclusion in the next
 234 release.
 235
 236 --
 237 Alexandre Julliard
 238 julliard@winehq.com