Fixed references to old documentation location.
[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 (called Winelib) that implements Windows
7 API calls using their Unix or X11 equivalents.  The library may also
8 be used for 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 Whenever you compile from source, it is recommended to use the Wine
17 Installer to build and install Wine.  From the top-level Wine
18 directory (which contains this file), run:
19
20 ./tools/wineinstall
21
22 Run programs as "wine [options] program".  For more information and
23 problem resolution, read the rest of this file, the Wine man page,
24 the files in the documentation directory in the Wine source, and
25 especially the wealth of information found at http://www.winehq.com.
26
27 3. REQUIREMENTS
28
29 To compile and run Wine, you must have one of the following:
30
31         Linux version 2.0.36 or above
32         FreeBSD 4.x or FreeBSD 5-CURRENT
33         Solaris x86 2.5 or later
34
35 Linux info:
36   Although Linux version 2.0.x will mostly work, certain features
37   (specifically LDT sharing) required for properly supporting Win32
38   threads were not implemented until kernel version 2.2.  If you get
39   consistent thread-related crashes, you may want to upgrade to 2.2.
40   Also, some bugs were fixed and additional features were added
41   late in the Linux 2.0.x series, so if you have a very old Linux kernel,
42   you may want to upgrade to at least the latest 2.0.x release.
43
44 FreeBSD info:
45   Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
46   turned on in your kernel.
47   More information including patches for the 4-STABLE branch is in the
48   ports tree:
49   ftp://ftp.freebsd.org/pub/FreeBSD/FreeBSD-current/ports/emulators/wine/files/
50
51 Solaris info:
52   You will most likely need to build Wine with the GNU toolchain
53   (gcc, gas, etc.)
54
55 Wine requires kernel-level threads to run. Currently, only Linux
56 version 2.0 or later, FreeBSD-current or FreeBSD 3.0 or later,
57 and Solaris x86 version 2.5 or later are supported.
58 Other operating systems which support kernel threads may be supported
59 in the future.
60
61 You need to have the X11 development include files installed
62 (called xlib6g-dev in Debian and XFree86-devel in RedHat).
63 To use Wine's support for multi-threaded applications, your X libraries
64 must be reentrant, which is probably the default by now.
65 If you have libc6 (glibc2), or you compiled the X libraries yourself,
66 they were probably compiled with the reentrant option enabled.
67
68 You also need to have libXpm installed on your system. The sources for
69 it are available at ftp.x.org and all its mirror sites in the directory
70 /contrib/libraries. If you are using RedHat, libXpm is distributed as the
71 xpm and xpm-devel packages. Debian distributes libXpm as xpm4.7, xpm4g,
72 and xpm4g-dev. SuSE calls these packages xpm and xpm-devel.
73
74 On x86 Systems gcc >= 2.7.2 is required.
75 Versions earlier than 2.7.2.3 may have problems when certain files
76 are compiled with optimization, often due to problems with header file
77 management. pgcc currently doesn't work with Wine. The cause of this problem
78 is unknown.
79
80 You also need flex version 2.5 or later and yacc.
81 Bison will work as a replacement for yacc. If you are
82 using RedHat or Debian, install the flex and bison packages.
83
84 In case you want to build the documentation yourself, you'll also
85 need the DocBook tools (db2html, db2ps, db2pdf).
86
87 4. COMPILATION
88
89 In case you chose to not use wineinstall, run the following commands
90 to build Wine:
91
92 ./configure
93 make depend
94 make
95
96 This will build the program "wine" and numerous support libraries/binaries.  
97 The program "wine" will load and run Windows executables.
98 The library "libwine" ("Winelib") can be used to compile and link
99 Windows source code under Unix.
100
101 To see compile configuration options, do ./configure --help.
102
103 To upgrade to a new release by using a patch file, first cd to the
104 top-level directory of the release (the one containing this README
105 file). Then do a "make clean", and patch the release with:
106
107     gunzip -c patch-file | patch -p1
108
109 where "patch-file" is the name of the patch file (something like
110 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
111 run "make depend && make".
112
113
114 5. SETUP
115
116 Once Wine has been built correctly, you can do "make install"; this
117 will install the wine executable, the Wine man page, and a few other
118 needed files.
119
120 Don't forget to uninstall any conflicting previous Wine installation
121 first.  Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
122 before installing.
123
124 If you want to build the documentation, you can run "make" in the
125 documentation directory.
126
127 Wine requires a configuration file named named "config" in your
128 ~/.wine directory. The format of this file is explained in the man
129 page. The file documentation/samples/config contains an example
130 configuration file which has to be adapted and copied to the location
131 mentioned above.
132
133 See http://www.winehq.com/support.shtml for further configuration hints.
134
135 In order to verify the correctness of the environment you need for
136 Wine to run successfully, run "./tools/winecheck | less".  You'll get
137 a percentage score indicating "Wine configuration correctness".
138
139 6. RUNNING PROGRAMS
140
141 When invoking Wine, you may specify the entire path to the executable,
142 or a filename only.
143
144 For example: to run Solitaire:
145
146         wine sol                   (using the searchpath to locate the file)
147         wine sol.exe
148
149         wine c:\\windows\\sol.exe  (using a DOS filename)
150
151         wine /usr/windows/sol.exe  (using a Unix filename)
152
153 Note: the path of the file will also be added to the path when
154       a full name is supplied on the commandline.
155
156 Wine is not yet complete, so some programs may crash. Provided you set up
157 winedbg correctly according to documentation/debugger.sgml, you will be dropped
158 into a debugger so that you can investigate and fix the problem. For more
159 information on how to do this, please read the file documentation/debugging.
160 If you post a bug report, please read the file documentation/bugreports to
161 see what information is required.
162
163 You should backup all your important files that you give Wine access
164 to, or use a special Wine copy of them, as there have been some cases
165 of users reporting file corruption. Do NOT run Explorer, for instance,
166 if you don't have a proper backup, as it renames/cripples several
167 directories sometimes.
168
169
170 7. GETTING MORE INFORMATION
171
172 WWW:    A great deal of information about Wine is available from WineHQ at
173         http://www.winehq.com/ : various user guides, application database,
174         bug tracking. This is probably the best starting point.
175
176 FAQ:    The Wine FAQ is located at http://www.winehq.com/FAQ
177
178 HOWTO:  The Wine HOWTO is available at
179         http://www.westfalen.de/witch/wine-HOWTO.txt .
180
181 Usenet: The best place to get help or to report bugs is the Usenet newsgroup
182         comp.emulators.ms-windows.wine. Please read the file 
183         documentation/bugreports to see what information should be included 
184         in a bug report.
185
186         Please browse old messages on http://groups.google.com/ to check
187         whether your problem is already fixed before posting a bug report
188         to the newsgroup. 
189
190 IRC:    Online help is available at channel #WineHQ on irc.openprojects.net.
191
192 CVS:    The current Wine development tree is available through CVS.
193         Go to http://www.winehq.com/dev.shtml for more information.
194
195 Mailing lists:
196         There are several mailing lists for Wine developers; see 
197         http://www.winehq.com/dev.shtml#ml for more information.
198
199 If you add something, or fix a bug, please send a patch ('diff -u'
200 format preferred) to julliard@winehq.com or to the
201 wine-patches@winehq.com mailing list for inclusion in the next
202 release.
203
204 --
205 Alexandre Julliard
206 julliard@winehq.com