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
  20 You also need to have libXpm installed on your system. The sources for
  21 it are probably available on the ftp site where you got Wine. They can
  22 also be found on ftp.x.org and all its mirror sites.
  23
  24 To build Wine, first do a "./configure" and then a "make depend; make".
  25 The executable "wine" will be built.  "wine" will load and run 16-bit
  26 Windows executables.
  27
  28 To build Winelib, do a "./configure --with-library", and then a "make
  29 depend; make". The library "winelib.a" will be built, allowing to
  30 compile Windows source code under Unix. If you have an ELF compiler,
  31 you can use "./configure --with-dll" instead to build a shared library.
  32
  33 To upgrade to a new release by using a patch file, first cd to the
  34 top-level directory of the release (the one containing this README
  35 file). Then do a "make clean", and patch the release with:
  36
  37     gunzip -c patch-file | patch -p1
  38
  39 where "patch-file" is the name of the patch file (something like
  40 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
  41 run "make depend; make".
  42
  43
  44 3. SETUP
  45
  46 Once Wine has been built correctly, you can do "make install"; this
  47 will install the wine executable and the man page.
  48
  49 Wine requires you to have a file /usr/local/etc/wine.conf (you can
  50 supply a different name when configuring wine) or a file called .winerc
  51 in your home directory.
  52
  53 The format of this file is explained in the man page. The file
  54 wine.ini contains a config file example.
  55
  56
  57 4. RUNNING PROGRAMS
  58
  59 When invoking Wine, you must specify the entire path to the executable,
  60 or a filename only.
  61
  62 For example: to run Windows' solitaire:
  63
  64         wine sol                   (using the searchpath to locate the file)
  65         wine sol.exe
  66
  67         wine c:\\windows\\sol.exe  (using a dosfilename)
  68
  69         wine /usr/windows/sol.exe  (using a unixfilename)
  70
  71 Note: the path of the file will also be added to the path when
  72       a full name is supplied on the commandline.
  73
  74 Have a nice game of solitaire, but be careful.  Emulation isn't perfect.
  75 So, occasionally it may crash.
  76
  77
  78 5. GETTING MORE INFORMATION
  79
  80 The best place to get help or to report bugs is the Usenet newsgroup
  81 comp.emulators.ms-windows.wine. The Wine FAQ is posted there every
  82 month.
  83
  84 If you add something, or fix a bug, please send a patch ('diff -u'
  85 format preferred) to julliard@lrc.epfl.ch for inclusion in the next
  86 release.
  87
  88 --
  89 Alexandre Julliard
  90 julliard@lrc.epfl.ch