New TTY driver for GDI.
[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 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.
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. COMPILATION
16
17 To compile Wine, you must have one of:
18
19         Linux version 0.99.13 or above
20         NetBSD-current
21         FreeBSD-current or FreeBSD 1.1 or later
22         OpenBSD/i386 2.1 or later
23         Solaris x86 2.5 or later
24
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
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.
29
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.
33
34 To build Wine, first run "./configure" and then run "make depend; make".
35 This will build the library "libwine.a" and the program "wine".
36
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
40 "./configure --enable-dll" to build a shared library instead. To see
41 other configuration options, do ./configure --help.
42
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
50 Wine-yymmdd.diff.gz). You can then re-run "./configure", and then
51 run "make depend; make".
52
53
54 3. SETUP
55
56 Once Wine has been built correctly, you can do "make install"; this
57 will install the wine executable, the Wine man page, and a few other
58 needed files.
59
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
62 in your home directory.
63
64 The format of this file is explained in the man page. The file
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.
69
70
71 4. RUNNING PROGRAMS
72
73 When invoking Wine, you may specify the entire path to the executable,
74 or a filename only.
75
76 For example: to run Solitaire:
77
78         wine sol                   (using the searchpath to locate the file)
79         wine sol.exe
80
81         wine c:\\windows\\sol.exe  (using a DOS filename)
82
83         wine /usr/windows/sol.exe  (using a Unix filename)
84
85 Note: the path of the file will also be added to the path when
86       a full name is supplied on the commandline.
87
88 Wine is not yet complete, so some programs may crash. You will be dropped
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
94
95 5. GETTING MORE INFORMATION
96
97 FAQ:    The Wine FAQ is located at http://pw1.netcom.com/~dagar/wine.html.
98
99 WWW:    A great deal of information about Wine is available from WineHQ at
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.
103
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
113 CVS:    The current Wine development tree is available through CVS.
114         Go to http://www.winehq.com/dev.html for more information.
115
116 If you add something, or fix a bug, please send a patch ('diff -u'
117 format preferred) to julliard@lrc.epfl.ch for inclusion in the next
118 release.
119
120 --
121 Alexandre Julliard
122 julliard@lrc.epfl.ch