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 To compile the emulator, you must have one of:
  15
  16         Linux version 0.99.13 or above
  17         NetBSD-current
  18         FreeBSD-current or FreeBSD 1.1 or later
  19         OpenBSD/i386 2.1 or later
  20         Solaris x86 2.5 or later
  21
  22 You also need to have libXpm installed on your system. The sources for
  23 it are probably available on the ftp site where you got Wine. They can
  24 also be found on ftp.x.org and all its mirror sites.
  25
  26 On x86 Systems gcc >= 2.7.0 is required. You will probably need flex too.
  27
  28 To build Wine, first do a "./configure" and then a "make depend; make".
  29 This will build the library "libwine.a" and the program "wine".
  30
  31 The program "wine" will load and run Windows executables.
  32 The library "libwine.a" can be used to compile and link Windows source
  33 code under Unix.  If you have an ELF compiler, you can use
  34 "./configure --enable-dll" to build a shared library instead.
  35
  36 To upgrade to a new release by using a patch file, first cd to the
  37 top-level directory of the release (the one containing this README
  38 file). Then do a "make clean", and patch the release with:
  39
  40     gunzip -c patch-file | patch -p1
  41
  42 where "patch-file" is the name of the patch file (something like
  43 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
  44 run "make depend; make".
  45
  46
  47 3. SETUP
  48
  49 Once Wine has been built correctly, you can do "make install"; this
  50 will install the wine executable and the man page.
  51
  52 Wine requires you to have a file /usr/local/etc/wine.conf (you can
  53 supply a different name when configuring wine) or a file called .winerc
  54 in your home directory.
  55
  56 The format of this file is explained in the man page. The file
  57 wine.ini contains a config file example.
  58
  59
  60 4. RUNNING PROGRAMS
  61
  62 When invoking Wine, you must specify the entire path to the executable,
  63 or a filename only.
  64
  65 For example: to run Windows' solitaire:
  66
  67         wine sol                   (using the searchpath to locate the file)
  68         wine sol.exe
  69
  70         wine c:\\windows\\sol.exe  (using a dosfilename)
  71
  72         wine /usr/windows/sol.exe  (using a unixfilename)
  73
  74 Note: the path of the file will also be added to the path when
  75       a full name is supplied on the commandline.
  76
  77 Have a nice game of solitaire, but be careful.  Emulation isn't perfect.
  78 So, occasionally it may crash.
  79
  80 UPDATE: Windows 95 components are known to cause more crashes compared
  81         to the equivalent Windows 3.1 libraries.
  82
  83
  84 5. GETTING MORE INFORMATION
  85
  86 Usenet: The best place to get help or to report bugs is the Usenet newsgroup
  87         comp.emulators.ms-windows.wine. The Wine FAQ is posted there every
  88         month.
  89
  90 WWW:    Please browse old messages on http://www.dejanews.com to check whether
  91         your problem is already fixed before posting a bug report to the
  92         newsgroup.
  93
  94         A great deal of information about Wine is available from WineHQ at
  95         http://www.winehq.com. Untested patches against the current
  96         release are available at http://www.winehq.com/patches.
  97
  98 CVS:    The current Wine development tree is available through CVS.
  99         Go to http://www.winehq.com/cvs.html for more information.
 100
 101 FAQ:    The Wine FAQ is located at http://pw1.netcom.com/~dagar/wine.html.
 102
 103
 104 If you add something, or fix a bug, please send a patch ('diff -u'
 105 format preferred) to julliard@lrc.epfl.ch for inclusion in the next
 106 release.
 107
 108 --
 109 Alexandre Julliard
 110 julliard@lrc.epfl.ch