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, and its license (contained in the file LICENSE)
  11 is BSD style.  Basically, you can do anything with it except claim
  12 that you wrote it.
  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 Wine
  18 directory (which contains this file), run:
  19
  20 ./tools/wineinstall
  21
  22 Run programs as "wine [options] program".  For more information and
  23 problem resolution, read the rest of this file, the Wine man page,
  24 the files in the documentation directory in the Wine source, and
  25 especially the wealth of information 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 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.
  66
  67 Wine requires kernel-level threads to run. Currently, only Linux
  68 version 2.0 or later, FreeBSD-current or FreeBSD 3.0 or later,
  69 Solaris x86 version 2.5 or later, and NetBSD-current are supported.
  70 Other operating systems which support kernel threads may be supported
  71 in the future.
  72
  73 You need to have the X11 development include files installed
  74 (called xlib6g-dev in Debian and XFree86-devel in RedHat).
  75 To use Wine's support for multi-threaded applications, your X libraries
  76 must be reentrant, which is probably the default by now.
  77 If you have libc6 (glibc2), or you compiled the X libraries yourself,
  78 they were probably compiled with the reentrant option enabled.
  79
  80 On x86 Systems gcc >= 2.7.2 is required.
  81 Versions earlier than 2.7.2.3 may have problems when certain files
  82 are compiled with optimization, often due to problems with header file
  83 management. pgcc currently doesn't work with Wine. The cause of this problem
  84 is unknown.
  85
  86 You also need flex version 2.5 or later and yacc.
  87 Bison will work as a replacement for yacc. If you are
  88 using RedHat or Debian, install the flex and bison packages.
  89
  90 In case you want to build the documentation yourself, you'll also
  91 need the DocBook tools (db2html, db2ps, db2pdf).
  92
  93 4. COMPILATION
  94
  95 In case you chose to not use wineinstall, run the following commands
  96 to build Wine:
  97
  98 ./configure
  99 make depend
 100 make
 101
 102 This will build the program "wine" and numerous support libraries/binaries.
 103 The program "wine" will load and run Windows executables.
 104 The library "libwine" ("Winelib") can be used to compile and link
 105 Windows source code under Unix.
 106
 107 To see compile configuration options, do ./configure --help.
 108
 109 To upgrade to a new release by using a patch file, first cd to the
 110 top-level directory of the release (the one containing this README
 111 file). Then do a "make clean", and patch the release with:
 112
 113     gunzip -c patch-file | patch -p1
 114
 115 where "patch-file" is the name of the patch file (something like
 116 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
 117 run "make depend && make".
 118
 119
 120 5. SETUP
 121
 122 Once Wine has been built correctly, you can do "make install"; this
 123 will install the wine executable, the Wine man page, and a few other
 124 needed files.
 125
 126 Don't forget to uninstall any conflicting previous Wine installation
 127 first.  Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
 128 before installing.
 129
 130 If you want to build the documentation, you can run "make" in the
 131 documentation directory.
 132
 133 Wine requires a configuration file named named "config" in your
 134 ~/.wine directory. The format of this file is explained in the config file
 135 man page (documentation/wine.conf.man).
 136 The file documentation/samples/config contains an example configuration file
 137 which has to be adapted and copied to the location mentioned above.
 138
 139 Don't forget to add vital registry entries by applying winedefault.reg
 140 with programs/regapi/. See documentation/ for details.
 141
 142 See http://www.winehq.com/support.shtml for further configuration hints.
 143
 144 In order to verify the correctness of the environment you need for
 145 Wine to run successfully, run "./tools/winecheck | less".  You'll get
 146 a percentage score indicating "Wine configuration correctness".
 147 As this program is alpha, it doesn't run a truly thorough test yet, though,
 148 so it should be taken as a first verification step only.
 149
 150 6. RUNNING PROGRAMS
 151
 152 When invoking Wine, you may specify the entire path to the executable,
 153 or a filename only.
 154
 155 For example: to run Solitaire:
 156
 157         wine sol                   (using the searchpath to locate the file)
 158         wine sol.exe
 159
 160         wine c:\\windows\\sol.exe  (using a DOS filename)
 161
 162         wine /usr/windows/sol.exe  (using a Unix filename)
 163
 164 Note: the path of the file will also be added to the path when
 165       a full name is supplied on the commandline.
 166
 167 Wine is not yet complete, so some programs may crash. Provided you set up
 168 winedbg correctly according to documentation/debugger.sgml, you will be dropped
 169 into a debugger so that you can investigate and fix the problem. For more
 170 information on how to do this, please read the file documentation/debugging.
 171 If you post a bug report, please read the file documentation/bugreports to
 172 see what information is required.
 173
 174 You should backup all your important files that you give Wine access
 175 to, or use a special Wine copy of them, as there have been some cases
 176 of users reporting file corruption. Do NOT run Explorer, for instance,
 177 if you don't have a proper backup, as it renames/cripples several
 178 directories sometimes. Not even other MS apps such as e.g. Messenger are safe,
 179 as they launch Explorer somehow. This particular corruption (!$!$!$!$.pfr)
 180 can at least partially be fixed by using
 181 http://home.nexgo.de/andi.mohr/download/decorrupt_explorer
 182
 183
 184 7. GETTING MORE INFORMATION
 185
 186 WWW:    A great deal of information about Wine is available from WineHQ at
 187         http://www.winehq.com/ : various user guides, application database,
 188         bug tracking. This is probably the best starting point.
 189
 190 FAQ:    The Wine FAQ is located at http://www.winehq.com/FAQ
 191
 192 HOWTO:  The Wine HOWTO is available at
 193         http://www.westfalen.de/witch/wine-HOWTO.txt .
 194
 195 Usenet: The best place to get help or to report bugs is the Usenet newsgroup
 196         comp.emulators.ms-windows.wine. Please read the file
 197         documentation/bugreports to see what information should be included
 198         in a bug report.
 199
 200         Please browse old messages on http://groups.google.com/ to check
 201         whether your problem is already fixed before posting a bug report
 202         to the newsgroup.
 203
 204 IRC:    Online help is available at channel #WineHQ on irc.openprojects.net.
 205
 206 CVS:    The current Wine development tree is available through CVS.
 207         Go to http://www.winehq.com/dev.shtml for more information.
 208
 209 Mailing lists:
 210         There are several mailing lists for Wine developers; see
 211         http://www.winehq.com/dev.shtml#ml for more information.
 212
 213 If you add something, or fix a bug, please send a patch ('diff -u'
 214 format preferred) to julliard@winehq.com or to the
 215 wine-patches@winehq.com mailing list for inclusion in the next
 216 release.
 217
 218 --
 219 Alexandre Julliard
 220 julliard@winehq.com