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