- Added remaining DirectX 3D3 6&7 3D interfaces.
[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 2. QUICK START
15
16 For the impatient, use the Wine Installer to build and install wine.
17 From the top-level Wine directory (which contains this file), run:
18
19 ./tools/wineinstall
20
21 Run programs as "wine [options] program".  For more information and
22 problem resolution, read the rest of this file, the Wine manpage,
23 and the files in the documentation directory in the Wine source.
24
25 3. REQUIREMENTS
26
27 To compile and run Wine, you must have one of the following:
28
29         Linux version 2.0.36 or above
30         FreeBSD-current or FreeBSD 3.0 or later
31         Solaris x86 2.5 or later
32
33 Although Linux version 2.0.x will mostly work, certain features
34 (specifically LDT sharing) required for properly supporting Win32
35 threads were not implemented until kernel version 2.2.  If you get
36 consistent thread-related crashes, you may want to upgrade to 2.2.
37
38 Similarly if you are on FreeBSD you may want to apply an LDT sharing
39 patch too (unless you are tracking -current where it finally has
40 been committed just recently), and there also is a small sigtrap
41 fix thats needed for wine's debugger. (Actually now that its using
42 ptrace() by default it may no longer make a difference but it still
43 doesn't hurt...) And if you're running a system from the -stable
44 branch older than Nov 15 1999, like a 3.3-RELEASE, then you also
45 need to apply a signal handling change that was MFC'd at that date.
46 More information including patches for the -stable branch is in
47 the ports tree:
48 ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/ports/emulators/wine/files/
49
50 You also need to have libXpm installed on your system. The sources for
51 it are available at ftp.x.org and all its mirror sites in the directory
52 /contrib/libraries. If you are using RedHat, libXpm is distributed as the
53 xpm and xpm-devel packages. Debian distributes libXpm as xpm4.7, xpm4g,
54 and xpm4g-dev 3.4j. SuSE calls these packages xpm and xpm-devel.
55
56 On x86 Systems gcc >= 2.7.2 is required. You also need flex version 2.5
57 or later and yacc. Bison will work as a replacement for yacc. If you are
58 using RedHat, install the flex and bison packages.
59
60 4. COMPILATION
61
62 To build Wine, run the following commands:
63
64 ./configure
65 make depend
66 make
67
68 This will build the library "libwine.a" and the program "wine".  
69 The program "wine" will load and run Windows executables.
70 The library "libwine.a" can be used to compile and link Windows source
71 code under Unix.
72
73 If you do not intend to compile Windows source code, use
74 "./configure --disable-lib" to skip building the library and reduce disk
75 space requirements. If you have an ELF compiler (which you probably do),
76 you can use "./configure --enable-dll" to build a shared library instead.
77 To see other configuration options, do ./configure --help.
78
79 To upgrade to a new release by using a patch file, first cd to the
80 top-level directory of the release (the one containing this README
81 file). Then do a "make clean", and patch the release with:
82
83     gunzip -c patch-file | patch -p1
84
85 where "patch-file" is the name of the patch file (something like
86 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
87 run "make depend && make".
88
89
90 5. SETUP
91
92 Once Wine has been built correctly, you can do "make install"; this
93 will install the wine executable, the Wine man page, and a few other
94 needed files.
95
96 Wine requires a configuration file named wine.conf. Its default location is
97 /usr/local/etc, but you can supply a different name when configuring wine by
98 using the --prefix or --sysconfdir options to ./configure. You can also override
99 the global configuration file with a .winerc file in your home directory.
100
101 The format of this file is explained in the man page. The file
102 wine.ini contains an example configuration file which has to be adapted
103 and copied to one of the two locations mentioned above.
104
105 See http://www.winehq.com/config.html for further configuration hints.
106
107
108 6. RUNNING PROGRAMS
109
110 When invoking Wine, you may specify the entire path to the executable,
111 or a filename only.
112
113 For example: to run Solitaire:
114
115         wine sol                   (using the searchpath to locate the file)
116         wine sol.exe
117
118         wine c:\\windows\\sol.exe  (using a DOS filename)
119
120         wine /usr/windows/sol.exe  (using a Unix filename)
121
122 Note: the path of the file will also be added to the path when
123       a full name is supplied on the commandline.
124
125 Wine is not yet complete, so some programs may crash. You will be dropped
126 into a debugger so that you can investigate and fix the problem. For more
127 information on how to do this, please read the file documentation/debugging.
128 If you post a bug report, please read the file documentation/bugreports to
129 see what information is required.
130
131
132 7. GETTING MORE INFORMATION
133
134 DOCU:   grep -i "SearchString" `find documentation/`|more
135
136 FAQ:    The Wine FAQ is located at http://www.winehq.com/faq.html.
137
138 WWW:    A great deal of information about Wine is available from WineHQ at
139         http://www.winehq.com/. Untested patches against the current release
140         are available on the wine-patches mailing list; see 
141         http://www.winehq.com/dev.html#ml for more information.
142
143 HOWTO:  The Wine HOWTO is available at
144         http://www.westfalen.de/witch/wine-HOWTO.txt .
145
146 Usenet: Please browse old messages on http://www.dejanews.com/ to check whether 
147         your problem is already fixed before posting a bug report to the 
148         newsgroup. 
149
150         The best place to get help or to report bugs is the Usenet newsgroup
151         comp.emulators.ms-windows.wine. Please read the file 
152         documentation/bugreports to see what information should be included 
153         in a bug report.
154
155 IRC:    Online help is available at channel #WineHQ on IRCnet.
156
157 CVS:    The current Wine development tree is available through CVS.
158         Go to http://www.winehq.com/dev.html for more information.
159
160 If you add something, or fix a bug, please send a patch ('diff -u'
161 format preferred) to julliard@lrc.epfl.ch for inclusion in the next
162 release.
163
164 --
165 Alexandre Julliard
166 julliard@lrc.epfl.ch