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
  35 Linux info:
  36   Although Linux version 2.0.x will mostly work, certain features
  37   (specifically LDT sharing) required for properly supporting Win32
  38   threads were not implemented until kernel version 2.2.  If you get
  39   consistent thread-related crashes, you may want to upgrade to 2.2.
  40   Also, some bugs were fixed and additional features were added
  41   late in the Linux 2.0.x series, so if you have a very old Linux kernel,
  42   you may want to upgrade to at least the latest 2.0.x release.
  43
  44 FreeBSD info:
  45   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
  46   turned on in your kernel.
  47   More information including patches for the 4-STABLE branch is in the
  48   ports tree:
  49   ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/ports/emulators/wine/files/
  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 File systems info :
  58   Wine should run on most file systems. However, Wine will fail to start
  59   if umsdos is used for the /tmp directory. A few compatibility problems have
  60   also been reported using files accessed through Samba.
  61
  62 Wine requires kernel-level threads to run. Currently, only Linux
  63 version 2.0 or later, FreeBSD-current or FreeBSD 3.0 or later,
  64 and Solaris x86 version 2.5 or later are supported.
  65 Other operating systems which support kernel threads may be supported
  66 in the future.
  67
  68 You need to have the X11 development include files installed
  69 (called xlib6g-dev in Debian and XFree86-devel in RedHat).
  70 To use Wine's support for multi-threaded applications, your X libraries
  71 must be reentrant, which is probably the default by now.
  72 If you have libc6 (glibc2), or you compiled the X libraries yourself,
  73 they were probably compiled with the reentrant option enabled.
  74
  75 You also need to have libXpm installed on your system. The sources for
  76 it are available at ftp.x.org and all its mirror sites in the directory
  77 /contrib/libraries. If you are using RedHat, libXpm is distributed as the
  78 xpm and xpm-devel packages. Debian distributes libXpm as xpm4.7, xpm4g,
  79 and xpm4g-dev. SuSE calls these packages xpm and xpm-devel.
  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 You also need flex version 2.5 or later and yacc.
  88 Bison will work as a replacement for yacc. If you are
  89 using RedHat or Debian, install the flex and bison packages.
  90
  91 In case you want to build the documentation yourself, you'll also
  92 need the DocBook tools (db2html, db2ps, db2pdf).
  93
  94 4. COMPILATION
  95
  96 In case you chose to not use wineinstall, run the following commands
  97 to build Wine:
  98
  99 ./configure
 100 make depend
 101 make
 102
 103 This will build the program "wine" and numerous support libraries/binaries.
 104 The program "wine" will load and run Windows executables.
 105 The library "libwine" ("Winelib") can be used to compile and link
 106 Windows source code under Unix.
 107
 108 To see compile configuration options, do ./configure --help.
 109
 110 To upgrade to a new release by using a patch file, first cd to the
 111 top-level directory of the release (the one containing this README
 112 file). Then do a "make clean", and patch the release with:
 113
 114     gunzip -c patch-file | patch -p1
 115
 116 where "patch-file" is the name of the patch file (something like
 117 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
 118 run "make depend && make".
 119
 120
 121 5. SETUP
 122
 123 Once Wine has been built correctly, you can do "make install"; this
 124 will install the wine executable, the Wine man page, and a few other
 125 needed files.
 126
 127 Don't forget to uninstall any conflicting previous Wine installation
 128 first.  Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
 129 before installing.
 130
 131 If you want to build the documentation, you can run "make" in the
 132 documentation directory.
 133
 134 Wine requires a configuration file named named "config" in your
 135 ~/.wine directory. The format of this file is explained in the config file
 136 man page (documentation/wine.conf.man).
 137 The file documentation/samples/config contains an example configuration file
 138 which has to be adapted and copied to the location mentioned above.
 139
 140 See http://www.winehq.com/support.shtml for further configuration hints.
 141
 142 In order to verify the correctness of the environment you need for
 143 Wine to run successfully, run "./tools/winecheck | less".  You'll get
 144 a percentage score indicating "Wine configuration correctness".
 145
 146 6. RUNNING PROGRAMS
 147
 148 When invoking Wine, you may specify the entire path to the executable,
 149 or a filename only.
 150
 151 For example: to run Solitaire:
 152
 153         wine sol                   (using the searchpath to locate the file)
 154         wine sol.exe
 155
 156         wine c:\\windows\\sol.exe  (using a DOS filename)
 157
 158         wine /usr/windows/sol.exe  (using a Unix filename)
 159
 160 Note: the path of the file will also be added to the path when
 161       a full name is supplied on the commandline.
 162
 163 Wine is not yet complete, so some programs may crash. Provided you set up
 164 winedbg correctly according to documentation/debugger.sgml, you will be dropped
 165 into a debugger so that you can investigate and fix the problem. For more
 166 information on how to do this, please read the file documentation/debugging.
 167 If you post a bug report, please read the file documentation/bugreports to
 168 see what information is required.
 169
 170 You should backup all your important files that you give Wine access
 171 to, or use a special Wine copy of them, as there have been some cases
 172 of users reporting file corruption. Do NOT run Explorer, for instance,
 173 if you don't have a proper backup, as it renames/cripples several
 174 directories sometimes. Not even other MS apps such as e.g. Messenger are safe,
 175 as they launch Explorer somehow. This particular corruption (!$!$!$!$.pfr)
 176 can be fixed with http://home.nexgo.de/andi.mohr/download/decorrupt_explorer
 177
 178
 179 7. GETTING MORE INFORMATION
 180
 181 WWW:    A great deal of information about Wine is available from WineHQ at
 182         http://www.winehq.com/ : various user guides, application database,
 183         bug tracking. This is probably the best starting point.
 184
 185 FAQ:    The Wine FAQ is located at http://www.winehq.com/FAQ
 186
 187 HOWTO:  The Wine HOWTO is available at
 188         http://www.westfalen.de/witch/wine-HOWTO.txt .
 189
 190 Usenet: The best place to get help or to report bugs is the Usenet newsgroup
 191         comp.emulators.ms-windows.wine. Please read the file
 192         documentation/bugreports to see what information should be included
 193         in a bug report.
 194
 195         Please browse old messages on http://groups.google.com/ to check
 196         whether your problem is already fixed before posting a bug report
 197         to the newsgroup.
 198
 199 IRC:    Online help is available at channel #WineHQ on irc.openprojects.net.
 200
 201 CVS:    The current Wine development tree is available through CVS.
 202         Go to http://www.winehq.com/dev.shtml for more information.
 203
 204 Mailing lists:
 205         There are several mailing lists for Wine developers; see
 206         http://www.winehq.com/dev.shtml#ml for more information.
 207
 208 If you add something, or fix a bug, please send a patch ('diff -u'
 209 format preferred) to julliard@winehq.com or to the
 210 wine-patches@winehq.com mailing list for inclusion in the next
 211 release.
 212
 213 --
 214 Alexandre Julliard
 215 julliard@winehq.com