Release 950122
[wine] / README
1 1. INTRODUCTION
2
3 Wine is a program that allows running MS-Windows programs under X11.
4 It consists of a program loader, that loads and executes an
5 MS-Windows binary, and of an emulation library that translates Windows
6 API calls to their Unix/X11 equivalent.
7
8 Wine is free software. See the file LICENSE for the details.
9 Basically, you can do anything with it, except claim that you wrote it.
10
11
12 2. COMPILATION
13
14 You must have one of:
15
16         Linux version 0.99.13 or above
17         NetBSD-current
18         FreeBSD-current or FreeBSD 1.1
19
20 To build Wine, first do a "./Configure" and then a "make" (or "gmake"
21 if you're running *BSD).  The executable "wine" will be built.  "wine"
22 will load and run 16-bit Windows' executables. 
23
24 To upgrade to a new release by using a patch file, first cd to the
25 top-level directory of the release (the one containing this README
26 file). Then do a "make clean", and patch the release with:
27
28     gunzip -c patch-file | patch -p1
29
30 where "patch-file" is the name of the patch file (something like
31 Wine-yymmdd.diff.gz). You can then re-run "./Configure", and then
32 run "make". 
33
34
35 3. SETUP
36
37 Wine requires you to have a file /usr/local/etc/wine.conf (you can
38 supply a different name when configuring wine) or a file called .winerc
39 in your home directory.
40
41 The format of this config file is just like a Windows .ini file.
42 The file wine.ini contains a config file example.
43
44 Here's an explanation of each section:
45
46 * [drives]
47
48 format: <driveletter> = <rootdirectory>
49 default: none
50
51 This section is used to specify the root directory of each `dos'drive 
52 as Windows' applications require a dos/mswindows based diskdrive & 
53 directory scheme. 
54
55 If you mounted your dos-partition as /dos and installed Microsoft Windows 
56 in c:\windows than you should specify c=/dos in the drives section.
57
58 * [wine]
59
60 format: windows = <directory>
61 default: c:\windows
62
63 Used to specify an different windows directory.
64
65 format: system = <directory>
66 default: c:\windows\system
67
68 Used to specify an different system directory.
69
70 format: temp = <directory>
71 default: c:\temp
72
73 Used to specify a directory where Windows applications can store temporary
74 files.
75
76 format: path = <directories separated by semi-colons>
77 default: c:\windows;c:\windows\system
78
79 Used to specify the path which will be used to find executables and DLL's.
80
81 format: systemresources = <filename>
82 default: c:\temp
83
84 Used to specify the name of sysres.dll, a dll which is used by Wine itself.
85
86 * [serialports]
87
88 format: com[12345678] = <devicename>
89 default: none
90
91 Used to specify the devices which are used as com1 - com8.
92
93 * [parallelports]
94
95 format: lpt[12345678] = <devicename>
96 default: none
97
98 Used to specify the devices which are used as lpt1 - lpt8.
99
100 * [spy]
101
102 format: file = <filename or CON when logging to stdout>
103 default: none
104
105 used to specify the file which will be used as logfile.
106
107 format: exclude = <message names separated by semicolons>
108 default: none
109
110 Used to specify which messages will be excluded from the logfile.
111
112 format: include = <message names separated by semicolons>
113 default: none
114
115 Used to specify which messages will be included in the logfile.
116
117
118 4. RUNNING PROGRAMS
119
120 When invoking Wine, you must specify the entire path to the executable,
121 or a filename only.
122
123 For example: to run Windows' solitaire:
124
125         wine sol                   (using the searchpath to locate the file)
126         wine sol.exe
127
128         wine c:\\windows\\sol.exe  (using a dosfilename)
129
130         wine /usr/windows/sol.exe  (using a unixfilename)
131
132 Note: the path of the file will also be added to the path when
133       a full name is supplied on the commandline.
134
135 Have a nice game of solitaire, but be careful.  Emulation isn't perfect.
136 So, occasionally it may crash.
137
138
139 5. GETTING MORE INFORMATION
140
141 The best place to get help or to report bugs is the Usenet newsgroup
142 comp.emulators.ms-windows.wine. The Wine FAQ is posted there every
143 month.
144
145 If you add something, or fix a bug, please send a patch to
146 wine-new@amscons.com for inclusion in the next release.
147
148 --
149 Alexandre Julliard
150 julliard@lamisun.epfl.ch