blob: 25be8f4fc88d9f3e2b93caf14da347831e09f913 [file] [log] [blame]
Alexandre Julliard3a5816f1994-12-27 14:11:53 +000011. INTRODUCTION
Alexandre Julliard2c25c3e1993-06-29 16:33:12 +00002
Alexandre Julliard3a5816f1994-12-27 14:11:53 +00003Wine is a program that allows running MS-Windows programs under X11.
4It consists of a program loader, that loads and executes an
5MS-Windows binary, and of an emulation library that translates Windows
6API calls to their Unix/X11 equivalent.
Alexandre Julliard8d24ae61994-04-05 21:42:43 +00007
Alexandre Julliard3a5816f1994-12-27 14:11:53 +00008Wine is free software. See the file LICENSE for the details.
9Basically, you can do anything with it, except claim that you wrote it.
Alexandre Julliard1f579291994-05-25 16:25:21 +000010
Alexandre Julliard3a5816f1994-12-27 14:11:53 +000011
122. COMPILATION
Alexandre Julliard401710d1993-09-04 10:09:32 +000013
Alexandre Julliarda69b88b1998-03-15 20:29:56 +000014To compile the emulator, you must have one of:
Alexandre Julliardf41aeca1993-09-14 16:47:10 +000015
Alexandre Julliardfb9a9191994-03-01 19:48:04 +000016 Linux version 0.99.13 or above
17 NetBSD-current
18 FreeBSD-current or FreeBSD 1.1
Alexandre Julliardd37eb361997-07-20 16:23:21 +000019 OpenBSD/i386 2.1 or later
Alexandre Julliarda69b88b1998-03-15 20:29:56 +000020 Solaris x86 2.5 or later
Alexandre Julliardf41aeca1993-09-14 16:47:10 +000021
Alexandre Julliard6abb89c1995-03-02 17:33:47 +000022You also need to have libXpm installed on your system. The sources for
23it are probably available on the ftp site where you got Wine. They can
24also be found on ftp.x.org and all its mirror sites.
25
Alexandre Julliarda69b88b1998-03-15 20:29:56 +000026On x86 Systems gcc >= 2.7.0 is required. You will probably need flex too.
27
Alexandre Julliardff8331e1995-09-18 11:19:54 +000028To build Wine, first do a "./configure" and then a "make depend; make".
Alexandre Julliarda0b2b1d1997-11-16 17:38:29 +000029This will build the library "libwine.a" and the program "wine".
Alexandre Julliard401710d1993-09-04 10:09:32 +000030
Alexandre Julliarda0b2b1d1997-11-16 17:38:29 +000031The program "wine" will load and run Windows executables.
32The library "libwine.a" can be used to compile and link Windows source
33code under Unix. If you have an ELF compiler, you can use
34"./configure --enable-dll" to build a shared library instead.
Alexandre Julliarde2bfa4c1996-05-16 18:21:06 +000035
Alexandre Julliard3a5816f1994-12-27 14:11:53 +000036To upgrade to a new release by using a patch file, first cd to the
37top-level directory of the release (the one containing this README
38file). Then do a "make clean", and patch the release with:
39
40 gunzip -c patch-file | patch -p1
41
42where "patch-file" is the name of the patch file (something like
Alexandre Julliardff8331e1995-09-18 11:19:54 +000043Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
44run "make depend; make".
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000045
46
Alexandre Julliard3a5816f1994-12-27 14:11:53 +0000473. SETUP
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000048
Alexandre Julliard7e56f681996-01-31 19:02:28 +000049Once Wine has been built correctly, you can do "make install"; this
50will install the wine executable and the man page.
51
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000052Wine requires you to have a file /usr/local/etc/wine.conf (you can
53supply a different name when configuring wine) or a file called .winerc
Alexandre Julliard3a5816f1994-12-27 14:11:53 +000054in your home directory.
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000055
Alexandre Julliard7e56f681996-01-31 19:02:28 +000056The format of this file is explained in the man page. The file
57wine.ini contains a config file example.
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000058
59
Alexandre Julliard3a5816f1994-12-27 14:11:53 +0000604. RUNNING PROGRAMS
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000061
Alexandre Julliard3a5816f1994-12-27 14:11:53 +000062When invoking Wine, you must specify the entire path to the executable,
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000063or a filename only.
Alexandre Julliardf41aeca1993-09-14 16:47:10 +000064
Alexandre Julliard5f721f81994-01-04 20:14:34 +000065For example: to run Windows' solitaire:
66
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000067 wine sol (using the searchpath to locate the file)
68 wine sol.exe
Alexandre Julliard5f721f81994-01-04 20:14:34 +000069
70 wine c:\\windows\\sol.exe (using a dosfilename)
71
72 wine /usr/windows/sol.exe (using a unixfilename)
Alexandre Julliardf41aeca1993-09-14 16:47:10 +000073
Alexandre Julliard3a5816f1994-12-27 14:11:53 +000074Note: the path of the file will also be added to the path when
Alexandre Julliard58199531994-04-21 01:20:00 +000075 a full name is supplied on the commandline.
76
Alexandre Julliardf41aeca1993-09-14 16:47:10 +000077Have a nice game of solitaire, but be careful. Emulation isn't perfect.
Alexandre Julliard3a5816f1994-12-27 14:11:53 +000078So, occasionally it may crash.
Alexandre Julliardf41aeca1993-09-14 16:47:10 +000079
Alexandre Julliard23946ad1997-06-16 17:43:53 +000080UPDATE: Windows 95 components are known to cause more crashes compared
81 to the equivalent Windows 3.1 libraries.
82
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000083
Alexandre Julliard3a5816f1994-12-27 14:11:53 +0000845. GETTING MORE INFORMATION
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000085
Alexandre Julliard46ea8b31998-05-03 19:01:20 +000086Usenet: 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
90WWW: 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
99FAQ: The Wine FAQ is located at http://home.pacbell.net/dagar/wine.html.
100
Alexandre Julliard8d24ae61994-04-05 21:42:43 +0000101
Alexandre Julliardff8331e1995-09-18 11:19:54 +0000102If you add something, or fix a bug, please send a patch ('diff -u'
Alexandre Julliard0c126c71996-02-18 18:44:41 +0000103format preferred) to julliard@lrc.epfl.ch for inclusion in the next
Alexandre Julliardff8331e1995-09-18 11:19:54 +0000104release.
Alexandre Julliard8d24ae61994-04-05 21:42:43 +0000105
Alexandre Julliard3a5816f1994-12-27 14:11:53 +0000106--
107Alexandre Julliard
Alexandre Julliardff8331e1995-09-18 11:19:54 +0000108julliard@lrc.epfl.ch