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