Alexandre Julliard | 3a5816f | 1994-12-27 14:11:53 +0000 | [diff] [blame] | 1 | 1. INTRODUCTION |
Alexandre Julliard | 2c25c3e | 1993-06-29 16:33:12 +0000 | [diff] [blame] | 2 | |
Douglas Ridgway | 692389d | 1998-11-22 16:56:44 +0000 | [diff] [blame] | 3 | Wine is a program which allows running Microsoft Windows programs |
| 4 | (including DOS, Windows 3.x and Win32 executables) on Unix. It |
| 5 | consists of a program loader which loads and executes an Microsoft |
| 6 | Windows binary, and a library that implements Windows API calls using |
| 7 | their Unix or X11 equivalents. The library may also be used for |
| 8 | porting Win32 code into native Unix executables. |
Alexandre Julliard | 8d24ae6 | 1994-04-05 21:42:43 +0000 | [diff] [blame] | 9 | |
Douglas Ridgway | 692389d | 1998-11-22 16:56:44 +0000 | [diff] [blame] | 10 | Wine is free software, and its license (contained in the file LICENSE) |
| 11 | is BSD style. Basically, you can do anything with it except claim |
| 12 | that you wrote it. |
Alexandre Julliard | 1f57929 | 1994-05-25 16:25:21 +0000 | [diff] [blame] | 13 | |
Alexandre Julliard | 3a5816f | 1994-12-27 14:11:53 +0000 | [diff] [blame] | 14 | |
| 15 | 2. COMPILATION |
Alexandre Julliard | 401710d | 1993-09-04 10:09:32 +0000 | [diff] [blame] | 16 | |
Douglas Ridgway | 692389d | 1998-11-22 16:56:44 +0000 | [diff] [blame] | 17 | To compile Wine, you must have one of: |
Alexandre Julliard | f41aeca | 1993-09-14 16:47:10 +0000 | [diff] [blame] | 18 | |
Alexandre Julliard | fb9a919 | 1994-03-01 19:48:04 +0000 | [diff] [blame] | 19 | Linux version 0.99.13 or above |
| 20 | NetBSD-current |
Alexandre Julliard | 767e6f6 | 1998-08-09 12:47:43 +0000 | [diff] [blame] | 21 | FreeBSD-current or FreeBSD 1.1 or later |
Alexandre Julliard | d37eb36 | 1997-07-20 16:23:21 +0000 | [diff] [blame] | 22 | OpenBSD/i386 2.1 or later |
Alexandre Julliard | a69b88b | 1998-03-15 20:29:56 +0000 | [diff] [blame] | 23 | Solaris x86 2.5 or later |
Alexandre Julliard | f41aeca | 1993-09-14 16:47:10 +0000 | [diff] [blame] | 24 | |
Alexandre Julliard | 6abb89c | 1995-03-02 17:33:47 +0000 | [diff] [blame] | 25 | You also need to have libXpm installed on your system. The sources for |
| 26 | it are probably available on the ftp site where you got Wine. They can |
James Juran | 38a3d26 | 1999-01-01 18:45:52 +0000 | [diff] [blame] | 27 | also be found on ftp.x.org and all its mirror sites. If you are using |
| 28 | RedHat, install the xpm and xpm-devel packages. |
Alexandre Julliard | 6abb89c | 1995-03-02 17:33:47 +0000 | [diff] [blame] | 29 | |
James Juran | 38a3d26 | 1999-01-01 18:45:52 +0000 | [diff] [blame] | 30 | On x86 Systems gcc >= 2.7.0 is required. You also need flex and yacc. |
| 31 | Bison will work as a replacement for yacc. If you are using RedHat, |
| 32 | install the flex and bison packages. |
Alexandre Julliard | a69b88b | 1998-03-15 20:29:56 +0000 | [diff] [blame] | 33 | |
James Juran | 38a3d26 | 1999-01-01 18:45:52 +0000 | [diff] [blame] | 34 | To build Wine, first run "./configure" and then run "make depend; make". |
Alexandre Julliard | a0b2b1d | 1997-11-16 17:38:29 +0000 | [diff] [blame] | 35 | This will build the library "libwine.a" and the program "wine". |
Alexandre Julliard | 401710d | 1993-09-04 10:09:32 +0000 | [diff] [blame] | 36 | |
Alexandre Julliard | a0b2b1d | 1997-11-16 17:38:29 +0000 | [diff] [blame] | 37 | The program "wine" will load and run Windows executables. |
| 38 | The library "libwine.a" can be used to compile and link Windows source |
| 39 | code under Unix. If you have an ELF compiler, you can use |
James Juran | 38a3d26 | 1999-01-01 18:45:52 +0000 | [diff] [blame] | 40 | "./configure --enable-dll" to build a shared library instead. To see |
| 41 | other configuration options, do ./configure --help. |
Alexandre Julliard | e2bfa4c | 1996-05-16 18:21:06 +0000 | [diff] [blame] | 42 | |
Alexandre Julliard | 3a5816f | 1994-12-27 14:11:53 +0000 | [diff] [blame] | 43 | To upgrade to a new release by using a patch file, first cd to the |
| 44 | top-level directory of the release (the one containing this README |
| 45 | file). Then do a "make clean", and patch the release with: |
| 46 | |
| 47 | gunzip -c patch-file | patch -p1 |
| 48 | |
| 49 | where "patch-file" is the name of the patch file (something like |
Alexandre Julliard | ff8331e | 1995-09-18 11:19:54 +0000 | [diff] [blame] | 50 | Wine-yymmdd.diff.gz). You can then re-run "./configure", and then |
| 51 | run "make depend; make". |
Alexandre Julliard | 8d24ae6 | 1994-04-05 21:42:43 +0000 | [diff] [blame] | 52 | |
| 53 | |
Alexandre Julliard | 3a5816f | 1994-12-27 14:11:53 +0000 | [diff] [blame] | 54 | 3. SETUP |
Alexandre Julliard | 8d24ae6 | 1994-04-05 21:42:43 +0000 | [diff] [blame] | 55 | |
Alexandre Julliard | 7e56f68 | 1996-01-31 19:02:28 +0000 | [diff] [blame] | 56 | Once Wine has been built correctly, you can do "make install"; this |
James Juran | 38a3d26 | 1999-01-01 18:45:52 +0000 | [diff] [blame] | 57 | will install the wine executable, the Wine man page, and a few other |
| 58 | needed files. |
Alexandre Julliard | 7e56f68 | 1996-01-31 19:02:28 +0000 | [diff] [blame] | 59 | |
Alexandre Julliard | 8d24ae6 | 1994-04-05 21:42:43 +0000 | [diff] [blame] | 60 | Wine requires you to have a file /usr/local/etc/wine.conf (you can |
| 61 | supply a different name when configuring wine) or a file called .winerc |
Alexandre Julliard | 3a5816f | 1994-12-27 14:11:53 +0000 | [diff] [blame] | 62 | in your home directory. |
Alexandre Julliard | 8d24ae6 | 1994-04-05 21:42:43 +0000 | [diff] [blame] | 63 | |
Alexandre Julliard | 7e56f68 | 1996-01-31 19:02:28 +0000 | [diff] [blame] | 64 | The format of this file is explained in the man page. The file |
Andreas Mohr | 8a82991 | 1999-01-30 13:40:05 +0000 | [diff] [blame] | 65 | wine.ini contains a config file example which has to be adapted |
| 66 | and copied to one of the two locations mentioned above. |
| 67 | |
| 68 | See www.winehq.com/config.html for further configuration hints. |
Alexandre Julliard | 8d24ae6 | 1994-04-05 21:42:43 +0000 | [diff] [blame] | 69 | |
| 70 | |
Alexandre Julliard | 3a5816f | 1994-12-27 14:11:53 +0000 | [diff] [blame] | 71 | 4. RUNNING PROGRAMS |
Alexandre Julliard | 8d24ae6 | 1994-04-05 21:42:43 +0000 | [diff] [blame] | 72 | |
James Juran | 38a3d26 | 1999-01-01 18:45:52 +0000 | [diff] [blame] | 73 | When invoking Wine, you may specify the entire path to the executable, |
Alexandre Julliard | 8d24ae6 | 1994-04-05 21:42:43 +0000 | [diff] [blame] | 74 | or a filename only. |
Alexandre Julliard | f41aeca | 1993-09-14 16:47:10 +0000 | [diff] [blame] | 75 | |
Douglas Ridgway | 692389d | 1998-11-22 16:56:44 +0000 | [diff] [blame] | 76 | For example: to run Solitaire: |
Alexandre Julliard | 5f721f8 | 1994-01-04 20:14:34 +0000 | [diff] [blame] | 77 | |
Alexandre Julliard | 8d24ae6 | 1994-04-05 21:42:43 +0000 | [diff] [blame] | 78 | wine sol (using the searchpath to locate the file) |
| 79 | wine sol.exe |
Alexandre Julliard | 5f721f8 | 1994-01-04 20:14:34 +0000 | [diff] [blame] | 80 | |
Douglas Ridgway | 692389d | 1998-11-22 16:56:44 +0000 | [diff] [blame] | 81 | wine c:\\windows\\sol.exe (using a DOS filename) |
Alexandre Julliard | 5f721f8 | 1994-01-04 20:14:34 +0000 | [diff] [blame] | 82 | |
Douglas Ridgway | 692389d | 1998-11-22 16:56:44 +0000 | [diff] [blame] | 83 | wine /usr/windows/sol.exe (using a Unix filename) |
Alexandre Julliard | f41aeca | 1993-09-14 16:47:10 +0000 | [diff] [blame] | 84 | |
Alexandre Julliard | 3a5816f | 1994-12-27 14:11:53 +0000 | [diff] [blame] | 85 | Note: the path of the file will also be added to the path when |
Alexandre Julliard | 5819953 | 1994-04-21 01:20:00 +0000 | [diff] [blame] | 86 | a full name is supplied on the commandline. |
| 87 | |
Douglas Ridgway | 692389d | 1998-11-22 16:56:44 +0000 | [diff] [blame] | 88 | Wine is not yet complete, so some programs may crash. You will be dropped |
James Juran | 38a3d26 | 1999-01-01 18:45:52 +0000 | [diff] [blame] | 89 | into a debugger so that you can investigate and fix the problem. For more |
| 90 | information on how to do this, please read the file documentation/debugging. |
| 91 | If you post a bug report, please read the file documentation/bugreports to |
| 92 | see what information is required. |
| 93 | |
Alexandre Julliard | 8d24ae6 | 1994-04-05 21:42:43 +0000 | [diff] [blame] | 94 | |
Alexandre Julliard | 3a5816f | 1994-12-27 14:11:53 +0000 | [diff] [blame] | 95 | 5. GETTING MORE INFORMATION |
Alexandre Julliard | 8d24ae6 | 1994-04-05 21:42:43 +0000 | [diff] [blame] | 96 | |
James Juran | 38a3d26 | 1999-01-01 18:45:52 +0000 | [diff] [blame] | 97 | FAQ: The Wine FAQ is located at http://pw1.netcom.com/~dagar/wine.html. |
Alexandre Julliard | 46ea8b3 | 1998-05-03 19:01:20 +0000 | [diff] [blame] | 98 | |
James Juran | 38a3d26 | 1999-01-01 18:45:52 +0000 | [diff] [blame] | 99 | WWW: A great deal of information about Wine is available from WineHQ at |
Douglas Ridgway | 692389d | 1998-11-22 16:56:44 +0000 | [diff] [blame] | 100 | 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 Julliard | 46ea8b3 | 1998-05-03 19:01:20 +0000 | [diff] [blame] | 103 | |
James Juran | 38a3d26 | 1999-01-01 18:45:52 +0000 | [diff] [blame] | 104 | Usenet: 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 Julliard | 9d7fbc4 | 1998-10-18 16:32:47 +0000 | [diff] [blame] | 113 | CVS: The current Wine development tree is available through CVS. |
Douglas Ridgway | 692389d | 1998-11-22 16:56:44 +0000 | [diff] [blame] | 114 | Go to http://www.winehq.com/dev.html for more information. |
Alexandre Julliard | 46ea8b3 | 1998-05-03 19:01:20 +0000 | [diff] [blame] | 115 | |
Alexandre Julliard | ff8331e | 1995-09-18 11:19:54 +0000 | [diff] [blame] | 116 | If you add something, or fix a bug, please send a patch ('diff -u' |
Alexandre Julliard | 0c126c7 | 1996-02-18 18:44:41 +0000 | [diff] [blame] | 117 | format preferred) to julliard@lrc.epfl.ch for inclusion in the next |
Alexandre Julliard | ff8331e | 1995-09-18 11:19:54 +0000 | [diff] [blame] | 118 | release. |
Alexandre Julliard | 8d24ae6 | 1994-04-05 21:42:43 +0000 | [diff] [blame] | 119 | |
Alexandre Julliard | 3a5816f | 1994-12-27 14:11:53 +0000 | [diff] [blame] | 120 | -- |
| 121 | Alexandre Julliard |
Alexandre Julliard | ff8331e | 1995-09-18 11:19:54 +0000 | [diff] [blame] | 122 | julliard@lrc.epfl.ch |