Winspool DocumentProperties and DeviceCapabilities should now work on
[wine.git] / README
blobf70feaf5ef32444ac3cca063dddf0b0e254c2986
1 1. INTRODUCTION
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.
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.
14 2. QUICK START
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:
19 ./tools/wineinstall
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.
25 3. REQUIREMENTS
27 To compile and run Wine, you must have one of the following:
29         Linux version 2.0.36 or above
30         FreeBSD-current or FreeBSD 3.0 or later
31         Solaris x86 2.5 or later
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.
38 You also need to have libXpm installed on your system. The sources for
39 it are available at ftp.x.org and all its mirror sites in the directory
40 /contrib/libraries. If you are using RedHat, libXpm is distributed as the
41 xpm and xpm-devel packages. Debian distributes libXpm as xpm4.7, xpm4g,
42 and xpm4g-dev 3.4j. SuSE calls these packages xpm and xpm-devel.
44 On x86 Systems gcc >= 2.7.2 is required. You also need flex version 2.5
45 or later and yacc. Bison will work as a replacement for yacc. If you are
46 using RedHat, install the flex and bison packages.
48 4. COMPILATION
50 To build Wine, run the following commands:
52 ./configure
53 make depend
54 make
56 This will build the library "libwine.a" and the program "wine".  
57 The program "wine" will load and run Windows executables.
58 The library "libwine.a" can be used to compile and link Windows source
59 code under Unix.
61 If you do not intend to compile Windows source code, use
62 "./configure --disable-lib" to skip building the library and reduce disk
63 space requirements. If you have an ELF compiler (which you probably do),
64 you can use "./configure --enable-dll" to build a shared library instead.
65 To see other configuration options, do ./configure --help.
67 To upgrade to a new release by using a patch file, first cd to the
68 top-level directory of the release (the one containing this README
69 file). Then do a "make clean", and patch the release with:
71     gunzip -c patch-file | patch -p1
73 where "patch-file" is the name of the patch file (something like
74 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
75 run "make depend && make".
78 5. SETUP
80 Once Wine has been built correctly, you can do "make install"; this
81 will install the wine executable, the Wine man page, and a few other
82 needed files.
84 Wine requires a configuration file named wine.conf. Its default location is
85 /usr/local/etc, but you can supply a different name when configuring wine by
86 using the --prefix or --sysconfdir options to ./configure. You can also override
87 the global configuration file with a .winerc file in your home directory.
89 The format of this file is explained in the man page. The file
90 wine.ini contains an example configuration file which has to be adapted
91 and copied to one of the two locations mentioned above.
93 See http://www.winehq.com/config.html for further configuration hints.
96 6. RUNNING PROGRAMS
98 When invoking Wine, you may specify the entire path to the executable,
99 or a filename only.
101 For example: to run Solitaire:
103         wine sol                   (using the searchpath to locate the file)
104         wine sol.exe
106         wine c:\\windows\\sol.exe  (using a DOS filename)
108         wine /usr/windows/sol.exe  (using a Unix filename)
110 Note: the path of the file will also be added to the path when
111       a full name is supplied on the commandline.
113 Wine is not yet complete, so some programs may crash. You will be dropped
114 into a debugger so that you can investigate and fix the problem. For more
115 information on how to do this, please read the file documentation/debugging.
116 If you post a bug report, please read the file documentation/bugreports to
117 see what information is required.
120 7. GETTING MORE INFORMATION
122 FAQ:    The Wine FAQ is located at http://www.winehq.com/faq.html.
124 WWW:    A great deal of information about Wine is available from WineHQ at
125         http://www.winehq.com/. Untested patches against the current release
126         are available on the wine-patches mailing list; see 
127         http://www.winehq.com/dev.html#ml for more information.
129 HOWTO:  A pre-release version of the Wine HOWTO is available at
130         http://www.westfalen.de/witch/wine-HOWTO.txt .
132 Usenet: Please browse old messages on http://www.dejanews.com/ to check whether 
133         your problem is already fixed before posting a bug report to the 
134         newsgroup. 
136         The best place to get help or to report bugs is the Usenet newsgroup
137         comp.emulators.ms-windows.wine. Please read the file 
138         documentation/bugreports to see what information should be included 
139         in a bug report.
141 CVS:    The current Wine development tree is available through CVS.
142         Go to http://www.winehq.com/dev.html for more information.
144 If you add something, or fix a bug, please send a patch ('diff -u'
145 format preferred) to julliard@lrc.epfl.ch for inclusion in the next
146 release.
149 Alexandre Julliard
150 julliard@lrc.epfl.ch