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, but versions before
  48   FreeBSD 5.3 will generally not work properly.
  49
  50   More information can be found in the FreeBSD ports tree at
  51   <ftp://ftp.freebsd.org/pub/FreeBSD/ports/ports/emulators/wine/>.
  52
  53 Solaris info:
  54   You will most likely need to build Wine with the GNU toolchain
  55   (gcc, gas, etc.). Warning : installing gas does *not* ensure that it
  56   will be used by gcc. Recompiling gcc after installing gas or
  57   symlinking cc, as and ld to the gnu tools is said to be necessary.
  58
  59 NetBSD info:
  60   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
  61   turned on in your kernel.
  62
  63
  64
  65 Supported file systems:
  66   Wine should run on most file systems. However, Wine will fail to start
  67   if umsdos is used for the /tmp directory. A few compatibility problems have
  68   also been reported using files accessed through Samba. Also, as NTFS
  69   can only be used safely with readonly access for now, we recommend against
  70   using NTFS, as Windows programs need write access almost everywhere.
  71   In case of NTFS files, copy over to a writable location.
  72
  73 Basic requirements:
  74   You need to have the X11 development include files installed
  75   (called xlib6g-dev in Debian and XFree86-devel in RedHat).
  76
  77 Build tool requirements:
  78   On x86 Systems gcc >= 2.7.2 is required.
  79   Versions earlier than 2.7.2.3 may have problems when certain files
  80   are compiled with optimization, often due to problems with header file
  81   management. pgcc currently doesn't work with Wine. The cause of this problem
  82   is unknown.
  83
  84   Of course you also need "make" (most likely GNU make).
  85
  86   You also need flex version 2.5 or later and bison.  If you are
  87   using RedHat or Debian, install the flex and bison packages.
  88
  89 Optional support libraries:
  90   If you want CUPS printing support, please install both cups and cups-devel
  91   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 See the Support area at http://www.winehq.org/ for further
 145 configuration hints.
 146
 147 In case of library loading errors
 148 (e.g. "Error while loading shared libraries: libntdll.so"), make sure
 149 to add the library path to /etc/ld.so.conf and run ldconfig as root.
 150
 151 6. RUNNING PROGRAMS
 152
 153 When invoking Wine, you may specify the entire path to the executable,
 154 or a filename only.
 155
 156 For example: to run Solitaire:
 157
 158         wine sol                   (using the search Path as specified in
 159         wine sol.exe                the config file to locate the file)
 160
 161         wine c:\\windows\\sol.exe  (using DOS filename syntax)
 162
 163         wine /usr/windows/sol.exe  (using Unix filename syntax)
 164
 165         wine sol.exe /parameter1 -parameter2 parameter3
 166                                    (calling program with parameters)
 167
 168 Note: the path of the file will also be added to the path when
 169       a full name is supplied on the commandline.
 170
 171 Wine is not yet complete, so several programs may crash. Provided you set up
 172 winedbg correctly according to documentation/debugger.sgml, you will be dropped
 173 into a debugger so that you can investigate and fix the problem.
 174 For more information on how to do this, please read the file
 175 documentation/debugging.sgml.
 176
 177 You should backup all your important files that you give Wine access
 178 to, or use a special Wine copy of them, as there have been some cases
 179 of users reporting file corruption. Do NOT run Explorer, for instance,
 180 if you don't have a proper backup, as it renames/cripples several
 181 directories sometimes. Not even other MS apps such as e.g. Messenger are safe,
 182 as they launch Explorer somehow. This particular corruption (!$!$!$!$.pfr)
 183 can at least partially be fixed by using
 184 http://home.nexgo.de/andi.mohr/download/decorrupt_explorer
 185
 186 7. DOCUMENTATION
 187
 188 Some documentation (various Wine Guides etc.) can be found in the
 189 documentation/ directory (apart from also being available on WineHQ).
 190
 191 If you want to process the SGML files in there, then you can run "make doc"
 192 in the documentation/ directory.
 193 Doing so requires the sgml tools package (for db2html, db2ps, db2pdf) named:
 194 Debian:         docbook-utils
 195 Mandrake:       sgml-tools-A.B.C-DDmdk
 196 SuSE:           docbktls-A.BB.C-DD
 197
 198 8. GETTING MORE INFORMATION
 199
 200 WWW:    A great deal of information about Wine is available from WineHQ at
 201         http://www.winehq.org/ : various Wine Guides, application database,
 202         bug tracking. This is probably the best starting point.
 203
 204 FAQ:    The Wine FAQ is located at http://www.winehq.org/FAQ
 205
 206 Usenet: You can discuss Wine-related issues and get help
 207         on comp.emulators.ms-windows.wine.
 208
 209 Bugs:   Report bugs to Wine Bugzilla at http://bugs.winehq.org
 210         Please search the bugzilla database to check whether your
 211         problem is already found before posting a bug report.  You can
 212         also post bug reports to comp.emulators.ms-windows.wine.
 213         Please read the file documentation/bugs.sgml to see what
 214         information is required.
 215
 216 IRC:    Online help is available at channel #WineHQ on irc.freenode.net.
 217
 218 CVS:    The current Wine development tree is available through CVS.
 219         Go to http://www.winehq.org/cvs for more information.
 220
 221 Mailing lists:
 222         There are several mailing lists for Wine developers; see
 223         http://www.winehq.org/forums for more information.
 224
 225 If you add something, or fix a bug, please send a patch (in 'diff -u'
 226 format) to wine-patches@winehq.org list for inclusion in the next
 227 release.
 228
 229 --
 230 Alexandre Julliard
 231 julliard@winehq.org