Release 980201
[wine.git] / README
blobbd900e2fae708087c30f96e20bef46710b8b44f7
1 1. INTRODUCTION
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.
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.
12 2. COMPILATION
14 You must have one of:
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
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.
25 To build Wine, first do a "./configure" and then a "make depend; make".
26 This will build the library "libwine.a" and the program "wine".
28 The program "wine" will load and run Windows executables.
29 The library "libwine.a" can be used to compile and link Windows source
30 code under Unix.  If you have an ELF compiler, you can use
31 "./configure --enable-dll" to build a shared library instead.
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:
37     gunzip -c patch-file | patch -p1
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".
44 3. SETUP
46 Once Wine has been built correctly, you can do "make install"; this
47 will install the wine executable and the man page.
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.
53 The format of this file is explained in the man page. The file
54 wine.ini contains a config file example.
57 4. RUNNING PROGRAMS
59 When invoking Wine, you must specify the entire path to the executable,
60 or a filename only.
62 For example: to run Windows' solitaire:
64         wine sol                   (using the searchpath to locate the file)
65         wine sol.exe
67         wine c:\\windows\\sol.exe  (using a dosfilename)
69         wine /usr/windows/sol.exe  (using a unixfilename)
71 Note: the path of the file will also be added to the path when
72       a full name is supplied on the commandline.
74 Have a nice game of solitaire, but be careful.  Emulation isn't perfect.
75 So, occasionally it may crash.
77 UPDATE: Windows 95 components are known to cause more crashes compared
78         to the equivalent Windows 3.1 libraries.
81 5. GETTING MORE INFORMATION
83 The best place to get help or to report bugs is the Usenet newsgroup
84 comp.emulators.ms-windows.wine. The Wine FAQ is posted there every
85 month. Also, you may want to browse old messages on www.dejanews.com 
86 to check whether your problem is already fixed. 
88 If you add something, or fix a bug, please send a patch ('diff -u'
89 format preferred) to julliard@lrc.epfl.ch for inclusion in the next
90 release.
93 Alexandre Julliard
94 julliard@lrc.epfl.ch