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