Improved shortcuts - follows jumps in trying to avoid switching to
[wine] / README
1 1. INTRODUCTION
2
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 a 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.
9
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.
13
14
15 2. REQUIREMENTS
16
17 To compile and run Wine, you must have one of the following:
18
19         Linux version 2.0.36 or above
20         FreeBSD-current or FreeBSD 3.0 or later
21         Solaris x86 2.5 or later
22
23 Although Linux version 2.0.x will mostly work, certain features
24 (specifically LDT sharing) required for properly supporting Win32
25 threads were not implemented until kernel version 2.2.  If you get
26 consistent thread-related crashes, you may want to upgrade to 2.2.
27
28 You also need to have libXpm installed on your system. The sources for
29 it are probably available on the FTP site where you got Wine. They can
30 also be found on ftp.x.org and all its mirror sites. If you are using
31 RedHat, install the xpm and xpm-devel packages. Debian users need
32 xpm4.7, xpm4g, and xpm4g-dev 3.4j.
33
34 On x86 Systems gcc >= 2.7.2 is required. You also need flex version 2.5
35 or later and yacc. Bison will work as a replacement for yacc. If you are
36 using RedHat, install the flex and bison packages.
37
38 3. COMPILATION
39
40 To build Wine, first run "./configure" and then run "make depend; make".
41 This will build the library "libwine.a" and the program "wine".
42
43 The program "wine" will load and run Windows executables.
44 The library "libwine.a" can be used to compile and link Windows source
45 code under Unix.  If you have an ELF compiler, you can use
46 "./configure --enable-dll" to build a shared library instead. To see
47 other configuration options, do ./configure --help.
48
49 To upgrade to a new release by using a patch file, first cd to the
50 top-level directory of the release (the one containing this README
51 file). Then do a "make clean", and patch the release with:
52
53     gunzip -c patch-file | patch -p1
54
55 where "patch-file" is the name of the patch file (something like
56 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
57 run "make depend; make".
58
59
60 4. SETUP
61
62 Once Wine has been built correctly, you can do "make install"; this
63 will install the wine executable, the Wine man page, and a few other
64 needed files.
65
66 Wine requires you to have a file /usr/local/etc/wine.conf (you can
67 supply a different name when configuring wine) or a file called .winerc
68 in your home directory.
69
70 The format of this file is explained in the man page. The file
71 wine.ini contains a config file example which has to be adapted
72 and copied to one of the two locations mentioned above.
73
74 See www.winehq.com/config.html for further configuration hints.
75
76
77 5. RUNNING PROGRAMS
78
79 When invoking Wine, you may specify the entire path to the executable,
80 or a filename only.
81
82 For example: to run Solitaire:
83
84         wine sol                   (using the searchpath to locate the file)
85         wine sol.exe
86
87         wine c:\\windows\\sol.exe  (using a DOS filename)
88
89         wine /usr/windows/sol.exe  (using a Unix filename)
90
91 Note: the path of the file will also be added to the path when
92       a full name is supplied on the commandline.
93
94 Wine is not yet complete, so some programs may crash. You will be dropped
95 into a debugger so that you can investigate and fix the problem. For more
96 information on how to do this, please read the file documentation/debugging.
97 If you post a bug report, please read the file documentation/bugreports to
98 see what information is required.
99
100
101 6. GETTING MORE INFORMATION
102
103 FAQ:    The Wine FAQ is located at http://www.winehq.com/faq.html.
104
105 WWW:    A great deal of information about Wine is available from WineHQ at
106         http://www.winehq.com/. Untested patches against the current release
107         are available on the wine-patches mailing list; see 
108         http://www.winehq.com/dev.html#ml for more information.
109
110 HOWTO:  A pre-release version of the Wine HOWTO is available at
111         http://www.westfalen.de/witch/wine-HOWTO.txt .
112
113 Usenet: Please browse old messages on http://www.dejanews.com/ to check whether 
114         your problem is already fixed before posting a bug report to the 
115         newsgroup. 
116
117         The best place to get help or to report bugs is the Usenet newsgroup
118         comp.emulators.ms-windows.wine. Please read the file 
119         documentation/bugreports to see what information should be included 
120         in a bug report.
121
122 CVS:    The current Wine development tree is available through CVS.
123         Go to http://www.winehq.com/dev.html for more information.
124
125 If you add something, or fix a bug, please send a patch ('diff -u'
126 format preferred) to julliard@lrc.epfl.ch for inclusion in the next
127 release.
128
129 --
130 Alexandre Julliard
131 julliard@lrc.epfl.ch