blob: 393268dd803d6f59e2449cb7f25af66ade021231 [file] [log] [blame]
Alexandre Julliard3a5816f1994-12-27 14:11:53 +000011. INTRODUCTION
Alexandre Julliard2c25c3e1993-06-29 16:33:12 +00002
Douglas Ridgway692389d1998-11-22 16:56:44 +00003Wine is a program which allows running Microsoft Windows programs
4(including DOS, Windows 3.x and Win32 executables) on Unix. It
5consists of a program loader which loads and executes an Microsoft
6Windows binary, and a library that implements Windows API calls using
7their Unix or X11 equivalents. The library may also be used for
8porting Win32 code into native Unix executables.
Alexandre Julliard8d24ae61994-04-05 21:42:43 +00009
Douglas Ridgway692389d1998-11-22 16:56:44 +000010Wine is free software, and its license (contained in the file LICENSE)
11is BSD style. Basically, you can do anything with it except claim
12that you wrote it.
Alexandre Julliard1f579291994-05-25 16:25:21 +000013
Alexandre Julliard3a5816f1994-12-27 14:11:53 +000014
152. COMPILATION
Alexandre Julliard401710d1993-09-04 10:09:32 +000016
Douglas Ridgway692389d1998-11-22 16:56:44 +000017To compile Wine, you must have one of:
Alexandre Julliardf41aeca1993-09-14 16:47:10 +000018
Alexandre Julliardfb9a9191994-03-01 19:48:04 +000019 Linux version 0.99.13 or above
20 NetBSD-current
Alexandre Julliard767e6f61998-08-09 12:47:43 +000021 FreeBSD-current or FreeBSD 1.1 or later
Alexandre Julliardd37eb361997-07-20 16:23:21 +000022 OpenBSD/i386 2.1 or later
Alexandre Julliarda69b88b1998-03-15 20:29:56 +000023 Solaris x86 2.5 or later
Alexandre Julliardf41aeca1993-09-14 16:47:10 +000024
Alexandre Julliard6abb89c1995-03-02 17:33:47 +000025You also need to have libXpm installed on your system. The sources for
26it are probably available on the ftp site where you got Wine. They can
James Juran38a3d261999-01-01 18:45:52 +000027also be found on ftp.x.org and all its mirror sites. If you are using
28RedHat, install the xpm and xpm-devel packages.
Alexandre Julliard6abb89c1995-03-02 17:33:47 +000029
James Juran38a3d261999-01-01 18:45:52 +000030On x86 Systems gcc >= 2.7.0 is required. You also need flex and yacc.
31Bison will work as a replacement for yacc. If you are using RedHat,
32install the flex and bison packages.
Alexandre Julliarda69b88b1998-03-15 20:29:56 +000033
James Juran38a3d261999-01-01 18:45:52 +000034To build Wine, first run "./configure" and then run "make depend; make".
Alexandre Julliarda0b2b1d1997-11-16 17:38:29 +000035This will build the library "libwine.a" and the program "wine".
Alexandre Julliard401710d1993-09-04 10:09:32 +000036
Alexandre Julliarda0b2b1d1997-11-16 17:38:29 +000037The program "wine" will load and run Windows executables.
38The library "libwine.a" can be used to compile and link Windows source
39code under Unix. If you have an ELF compiler, you can use
James Juran38a3d261999-01-01 18:45:52 +000040"./configure --enable-dll" to build a shared library instead. To see
41other configuration options, do ./configure --help.
Alexandre Julliarde2bfa4c1996-05-16 18:21:06 +000042
Alexandre Julliard3a5816f1994-12-27 14:11:53 +000043To upgrade to a new release by using a patch file, first cd to the
44top-level directory of the release (the one containing this README
45file). Then do a "make clean", and patch the release with:
46
47 gunzip -c patch-file | patch -p1
48
49where "patch-file" is the name of the patch file (something like
Alexandre Julliardff8331e1995-09-18 11:19:54 +000050Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
51run "make depend; make".
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000052
53
Alexandre Julliard3a5816f1994-12-27 14:11:53 +0000543. SETUP
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000055
Alexandre Julliard7e56f681996-01-31 19:02:28 +000056Once Wine has been built correctly, you can do "make install"; this
James Juran38a3d261999-01-01 18:45:52 +000057will install the wine executable, the Wine man page, and a few other
58needed files.
Alexandre Julliard7e56f681996-01-31 19:02:28 +000059
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000060Wine requires you to have a file /usr/local/etc/wine.conf (you can
61supply a different name when configuring wine) or a file called .winerc
Alexandre Julliard3a5816f1994-12-27 14:11:53 +000062in your home directory.
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000063
Alexandre Julliard7e56f681996-01-31 19:02:28 +000064The format of this file is explained in the man page. The file
Andreas Mohr8a829911999-01-30 13:40:05 +000065wine.ini contains a config file example which has to be adapted
66and copied to one of the two locations mentioned above.
67
68See www.winehq.com/config.html for further configuration hints.
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000069
70
Alexandre Julliard3a5816f1994-12-27 14:11:53 +0000714. RUNNING PROGRAMS
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000072
James Juran38a3d261999-01-01 18:45:52 +000073When invoking Wine, you may specify the entire path to the executable,
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000074or a filename only.
Alexandre Julliardf41aeca1993-09-14 16:47:10 +000075
Douglas Ridgway692389d1998-11-22 16:56:44 +000076For example: to run Solitaire:
Alexandre Julliard5f721f81994-01-04 20:14:34 +000077
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000078 wine sol (using the searchpath to locate the file)
79 wine sol.exe
Alexandre Julliard5f721f81994-01-04 20:14:34 +000080
Douglas Ridgway692389d1998-11-22 16:56:44 +000081 wine c:\\windows\\sol.exe (using a DOS filename)
Alexandre Julliard5f721f81994-01-04 20:14:34 +000082
Douglas Ridgway692389d1998-11-22 16:56:44 +000083 wine /usr/windows/sol.exe (using a Unix filename)
Alexandre Julliardf41aeca1993-09-14 16:47:10 +000084
Alexandre Julliard3a5816f1994-12-27 14:11:53 +000085Note: the path of the file will also be added to the path when
Alexandre Julliard58199531994-04-21 01:20:00 +000086 a full name is supplied on the commandline.
87
Douglas Ridgway692389d1998-11-22 16:56:44 +000088Wine is not yet complete, so some programs may crash. You will be dropped
James Juran38a3d261999-01-01 18:45:52 +000089into a debugger so that you can investigate and fix the problem. For more
90information on how to do this, please read the file documentation/debugging.
91If you post a bug report, please read the file documentation/bugreports to
92see what information is required.
93
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000094
Alexandre Julliard3a5816f1994-12-27 14:11:53 +0000955. GETTING MORE INFORMATION
Alexandre Julliard8d24ae61994-04-05 21:42:43 +000096
James Juran38a3d261999-01-01 18:45:52 +000097FAQ: The Wine FAQ is located at http://pw1.netcom.com/~dagar/wine.html.
Alexandre Julliard46ea8b31998-05-03 19:01:20 +000098
James Juran38a3d261999-01-01 18:45:52 +000099WWW: A great deal of information about Wine is available from WineHQ at
Douglas Ridgway692389d1998-11-22 16:56:44 +0000100 http://www.winehq.com/. Untested patches against the current release
101 are available on the wine-patches mailing list; see
102 http://www.winehq.com/dev.html#ml for more information.
Alexandre Julliard46ea8b31998-05-03 19:01:20 +0000103
James Juran38a3d261999-01-01 18:45:52 +0000104Usenet: Please browse old messages on http://www.dejanews.com/ to check whether
105 your problem is already fixed before posting a bug report to the
106 newsgroup.
107
108 The best place to get help or to report bugs is the Usenet newsgroup
109 comp.emulators.ms-windows.wine. Please read the file
110 documentation/bugreports to see what information should be included
111 in a bug report.
112
Alexandre Julliard9d7fbc41998-10-18 16:32:47 +0000113CVS: The current Wine development tree is available through CVS.
Douglas Ridgway692389d1998-11-22 16:56:44 +0000114 Go to http://www.winehq.com/dev.html for more information.
Alexandre Julliard46ea8b31998-05-03 19:01:20 +0000115
Alexandre Julliardff8331e1995-09-18 11:19:54 +0000116If you add something, or fix a bug, please send a patch ('diff -u'
Alexandre Julliard0c126c71996-02-18 18:44:41 +0000117format preferred) to julliard@lrc.epfl.ch for inclusion in the next
Alexandre Julliardff8331e1995-09-18 11:19:54 +0000118release.
Alexandre Julliard8d24ae61994-04-05 21:42:43 +0000119
Alexandre Julliard3a5816f1994-12-27 14:11:53 +0000120--
121Alexandre Julliard
Alexandre Julliardff8331e1995-09-18 11:19:54 +0000122julliard@lrc.epfl.ch