README

   1 1. INTRODUCTION
   2
   3 Wine is a program that allows running MS-Windows programs under X11.
   4 It consists of a program loader, that loads and executes an
   5 MS-Windows binary, and of an emulation library that translates Windows
   6 API calls to their Unix/X11 equivalent.
   7
   8 Wine is free software. See the file LICENSE for the details.
   9 Basically, you can do anything with it, except claim that you wrote it.
  10
  11
  12 2. COMPILATION
  13
  14 You must have one of:
  15
  16         Linux version 0.99.13 or above
  17         NetBSD-current
  18         FreeBSD-current or FreeBSD 1.1
  19         OpenBSD/i386 2.1 or later
  20
  21 You also need to have libXpm installed on your system. The sources for
  22 it are probably available on the ftp site where you got Wine. They can
  23 also be found on ftp.x.org and all its mirror sites.
  24
  25 To build Wine, first do a "./configure" and then a "make depend; make".
  26 The executable "wine" will be built.  "wine" will load and run 16-bit
  27 Windows executables.
  28
  29 To build Winelib, do a "./configure --with-library", and then a "make
  30 depend; make". The library "winelib.a" will be built, allowing to
  31 compile Windows source code under Unix. If you have an ELF compiler,
  32 you can use "./configure --with-dll" instead to build a shared library.
  33
  34 To upgrade to a new release by using a patch file, first cd to the
  35 top-level directory of the release (the one containing this README
  36 file). Then do a "make clean", and patch the release with:
  37
  38     gunzip -c patch-file | patch -p1
  39
  40 where "patch-file" is the name of the patch file (something like
  41 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
  42 run "make depend; make".
  43
  44
  45 3. SETUP
  46
  47 Once Wine has been built correctly, you can do "make install"; this
  48 will install the wine executable and the man page.
  49
  50 Wine requires you to have a file /usr/local/etc/wine.conf (you can
  51 supply a different name when configuring wine) or a file called .winerc
  52 in your home directory.
  53
  54 The format of this file is explained in the man page. The file
  55 wine.ini contains a config file example.
  56
  57
  58 4. RUNNING PROGRAMS
  59
  60 When invoking Wine, you must specify the entire path to the executable,
  61 or a filename only.
  62
  63 For example: to run Windows' solitaire:
  64
  65         wine sol                   (using the searchpath to locate the file)
  66         wine sol.exe
  67
  68         wine c:\\windows\\sol.exe  (using a dosfilename)
  69
  70         wine /usr/windows/sol.exe  (using a unixfilename)
  71
  72 Note: the path of the file will also be added to the path when
  73       a full name is supplied on the commandline.
  74
  75 Have a nice game of solitaire, but be careful.  Emulation isn't perfect.
  76 So, occasionally it may crash.
  77
  78 UPDATE: Windows 95 components are known to cause more crashes compared
  79         to the equivalent Windows 3.1 libraries.
  80
  81
  82 5. GETTING MORE INFORMATION
  83
  84 The best place to get help or to report bugs is the Usenet newsgroup
  85 comp.emulators.ms-windows.wine. The Wine FAQ is posted there every
  86 month. Also, you may want to browse old messages on www.dejanews.com
  87 to check whether your problem is already fixed.
  88
  89 If you add something, or fix a bug, please send a patch ('diff -u'
  90 format preferred) to julliard@lrc.epfl.ch for inclusion in the next
  91 release.
  92
  93 --
  94 Alexandre Julliard
  95 julliard@lrc.epfl.ch