Release 980503
[wine] / documentation / wine.man
1 .\" -*- nroff -*-
2 .TH WINE 1 "September 1, 1995" "Version 9/1/95" "Windows Emulation"
3 .SH NAME
4 wine \- run Windows programs under Unix
5 .SH SYNOPSIS
6 .B wine
7 [
8 .I options
9 ]
10 .I program_name
11 [
12 .I program_name...
13 ]
14 .SH DESCRIPTION
15 .B wine
16 invokes the Windows emulator.
17 .PP
18 .B wine 
19 currently runs a number of games and small applications (approximately
20 half of the applets and common games actually run), although the entire API
21 has not been implemented.
22 .PP
23 See the files 
24 .B README,
25 .B ChangeLog, 
26 .B configure, 
27 and the
28 .B Makefile
29 contained in the source distribution
30 to compile
31 .B wine.
32 .SH REQUIREMENTS
33 At present, 
34 .B wine
35 will run under any Linux kernel more recent than 0.99.13, or
36 under recent releases of NetBSD/i386, FreeBSD and OpenBSD/i386.
37 .PP
38 .B X
39 must be installed.
40 .PP
41 .B libXpm
42 must be installed.  (It is probably available from the same site 
43 .B wine
44 was, or the sources may be FTP'd from ftp.x.org).
45 .SH INSTALLATION
46 To install 
47 .B Wine,
48 run "./configure", which will detect your specific setup and create
49 the Makefiles. You can run "./configure --help" to see the available
50 configuration options. Then do "make depend; make" to build the
51 .B wine
52 executable, and then "make install" to install it. By default,
53 .B wine
54 is installed in /usr/local/bin; you can specify a different path with
55 the --prefix option when running
56 .B configure.
57 .SH OPTIONS
58 .TP
59 .I -backingstore
60 Turn on backing store
61 .TP
62 .I -debug
63 Enter the debugger before starting application
64 .TP
65 .I -debugmsg name[,name]
66 Turn debugging messages on or off - for instance, 
67 .I -debugmsg +dll,+heap
68 will turn on DLL and heap debugging messages.  The full list is: all, accel,
69 atom, bitblt, bitmap, caret, cdaudio, class, clipboard, clipping, combo,
70 comm, commdlg, crtdll, cursor, dc, dde, dialog, dll, dosfs, driver, edit,
71 env, event, exec, file, fixup, font, gdi, global, graphics, heap, hook,
72 icon, int, key, keyboard, ldt, listbox, local, mci, mcianim, mciwave, mdi,
73 menu, message, metafile, midi, mmio, mmsys, mmtime, module, msg, nonclient,
74 ole, palette, profile, prop, reg, region, relay, resource, scroll, segment,
75 selector,sem, sendmsg, shm, stress, string, syscolor, task, text, timer, toolhelp,ver, vxd, win, win32, winsock.
76 .TP
77 .I -depth n
78 Change the depth to use for multiple-depth screens
79 .TP
80 .I -desktop geom
81 Use a desktop window of the given geometry
82 .TP
83 .I -display name
84 Use the specified display
85 .TP
86 .I -dll name
87 Enables/disables built-in DLL's - starting wine with
88 .I -dll -commdlg
89 is probably a good idea.
90 The full list of DLLs modifiable by this is:
91 WIN87EM, SHELL, SOUND, KEYBOARD, WINSOCK, STRESS, MMSYSTEM, SYSTEM, TOOLHELP,
92 MOUSE, COMMDLG, OLE2, OLE2CONV, OLE2DISP, OLE2NLS, OLE2PROX, OLECLI, OLESVR,
93 COMPOBJ, STORAGE, WINPROCS, DDEML, ADVAPI32, COMCTL32, COMDLG32, CRTDLL,
94 GDI32, LZ32, MPR, NTDLL, OLE32, SHELL32, USER32, VER, VERSION, W32SYS, WINMM,
95 WINSPOOL, WSOCK32
96 .TP
97 .I -failreadonly
98 Read only files may not be opened in write mode (the default is to
99 allow opening read-only files for writing, because most Windows
100 programs always request read-write access, even on CD-ROM drives...).
101 .TP
102 .I -fixedmap
103 Use a "standard" color map.
104 .TP
105 .I -iconic
106 Start as an icon
107 .TP
108 .I -language xx
109 Set the language to
110 .I xx
111 (one of En, Es, De, No, Fr, Fi, Da, Cz, Eo, It, Ko, Hu, Pl, Po, Sw, Ca)
112 .TP
113 .I -managed
114 Create each top-level window as a properly managed X window
115 .TP
116 .I -mode modename
117 Determines the mode in which
118 .B wine
119 is started. Possible mode names are
120 .I standard
121 and
122 .I enhanced.
123 Enhanced mode is the default (when no -mode option is specified).
124 .TP
125 .I -name name
126 Set the application name
127 .TP
128 .I -privatemap
129 Use a private color map
130 .TP
131 .I -synchronous
132 Turn on synchronous display mode
133 .TP
134 .I -winver version
135 Specify which Windows version WINE should imitate.
136 Possible arguments are: win31, win95 and nt351.
137 .PD 1
138 .SH PROGRAM/ARGUMENTS
139 The program name may be specified in DOS format (C:\\WINDOWS\\SOL.EXE) or in 
140 Linux format (/msdos/windows/sol.exe).  The program being executed may be 
141 passed arguments by adding them on to the end of the command line invoking
142 .B wine
143 (such as: wine "notepad C:\\TEMP\\README.TXT").  Note that
144 the program name and its arguments 
145 .I must
146 be passed as a single parameter, which is usually accomplished by placing
147 them together in quotation marks.  Multiple applications may be started
148 by placing all of them on the command line (such as: wine notepad clock).
149 .SH CONFIGURATION FILE
150 .B wine
151 expects a configuration file (/usr/local/etc/wine.conf), which should
152 conform to the following rules (the format is just like a Windows .ini
153 file).  The actual file name may be specified during the execution of
154 the
155 .B configure
156 script.  Alternatively, you may have a 
157 .I .winerc
158 file of this format in your home directory.
159 .SH CONFIGURATION FILE FORMAT
160 All entries are grouped in sections; a section begins with the line
161 .br
162 .I [section name]
163 .br
164 and continues until the next section starts. Individual entries
165 consist of lines of the form
166 .br
167 .I entry=value
168 .br
169 The value can be any text string, optionally included in single or
170 double quotes; it can also contain references to environment variables
171 surrounded by
172 .I ${}.
173 Supported section names and entries are listed below.
174 .PP
175 .B [Drive X]
176 .br
177 This section is used to specify the root directory and type of each
178 .B DOS
179 drive, since most Windows applications require a DOS/MS-Windows based 
180 disk drive & directory scheme. There is one such section for every
181 drive you want to configure.
182 .PP
183 .I format: Path = <rootdirectory>
184 .br
185 default: none
186 .br
187 If you mounted your dos partition as 
188 .I /dos
189 and installed Microsoft Windows in 
190 C:\\WINDOWS then you should specify 
191 .I Path=/dos
192 in the
193 .I [Drive C]
194 section.
195 .PP
196 .I format: Type = <type>
197 .br
198 default: hd
199 .br
200 Used to specify the drive type; supported types are floppy, hd, cdrom
201 and network.
202 .PP
203 .I format: Label = <label>
204 .br
205 default: 'Drive X'
206 .br
207 Used to specify the drive label; limited to 11 characters.
208 .PP
209 .I format: Serial = <serial>
210 .br
211 default: 12345678
212 .br
213 Used to specify the drive serial number, as an 8-character hexadecimal
214 number.
215 .PP
216 .I format: Filesystem = <fstype>
217 .br
218 default: unix
219 .br
220 Used to specify the type of the filesystem on which the drive resides;
221 supported types are msdos (or fat), win95 (or vfat), unix. If the
222 drive spans several different filesystems, say unix.
223 .PP
224 .B [wine]
225 .br
226 .I format: windows = <directory>
227 .br
228 default: C:\\WINDOWS
229 .br
230 Used to specify a different Windows directory
231 .PP
232 .I format: system = <directory>
233 .br
234 default: C:\\WINDOWS\\SYSTEM
235 .br
236 Used to specify a different system directory
237 .PP
238 .I format: temp = <directory>
239 .br
240 default: C:\\TEMP
241 .br
242 Used to specify a directory where Windows applications can store 
243 temporary files.
244 .PP
245 .I format: path = <directories separated by semi-colons>
246 .br
247 default: C:\\WINDOWS;C:\\WINDOWS\\SYSTEM
248 .br
249 Used to specify the path which will be used to find executables and .DLL's.
250 .PP
251 .I format: symboltablefile = <filename>
252 .br
253 default: wine.sym
254 .br
255 Used to specify the path and file name of the symbol table used by the built-in
256 debugger.
257 .PP
258 .B [serialports]
259 .br
260 .I format: com[12345678] = <devicename>
261 .br
262 default: none
263 .br
264 Used to specify the devices which are used as com1 - com8.
265 .PP
266 .B [parallelports]
267 .br
268 .I format: lpt[12345678] = <devicename>
269 .br
270 default: none
271 .br
272 Used to specify the devices which are used as lpt1 - lpt8.
273 .PP
274 .B [spy]
275 .br
276 .I format: file = <filename or CON when logging to stdout>
277 .br
278 default: none
279 .br
280 Used to specify the file which will be used as
281 .B logfile.
282 .PP
283 .I format: exclude = <message names separated by semicolons>
284 .br
285 default: none
286 .br
287 Used to specify which messages will be excluded from the logfile.
288 .PP
289 .I format: include = <message names separated by semicolons>
290 .br
291 default: none
292 .br Used to specify which messages will be included in the logfile.
293 .SH SAMPLE CONFIGURATION FILE
294 [Drive A]
295 .br
296 Path=/mnt/fd0
297 .br
298 Type=floppy
299 .PP
300 [Drive C]
301 .br
302 Path=/dos
303 .br
304 Type=hd
305 .br
306 Label=DOS disk
307 .PP
308 [Drive D]
309 .br
310 Path=${HOME}/Wine
311 .PP
312 [wine]
313 .br
314 windows=c:\\windows
315 .br
316 system=c:\\windows\\system
317 .br
318 temp=c:\\temp
319 .br
320 path=c:\\windows;c:\\windows\\system;c:\\winapps\\word
321 .br
322 symboltablefile=/usr/local/lib/wine.sym
323 .PP
324 [serialports]
325 .br
326 com1=/dev/cua1
327 .br
328 com2=/dev/cua1
329 .PP
330 [parallelports]
331 .br
332 lpt1=/dev/lp0
333 .PP
334 [spy]
335 .br
336 ;File=CON
337 .br
338 ;File=spy.log
339 .br
340 Exclude=WM_TIMER;WM_SETCURSOR;WM_MOUSEMOVE;WM_NCHITTEST;
341 .br
342 Include=WM_COMMAND;
343 .SH AUTHORS
344 .B Wine
345 is available thanks to the work of Bob Amstadt, Dag Asheim,
346 Martin Ayotte, Ross Biro, Erik Bos, Fons Botman, John Brezak,
347 Andrew Bulhak, John Burton, Paul Falstad, Olaf Flebbe, Peter Galbavy,
348 Ramon Garcia, Hans de Graaf, Charles M. Hannum, Cameron Heide,
349 Jochen Hoenicke, Jeffrey Hsu, Miguel de Icaza, Alexandre Julliard,
350 Jon Konrath, Scott A. Laird, Martin von Loewis, Kenneth MacDonald,
351 Peter MacDonald, William Magro, Marcus Meissner, Graham Menhennitt,
352 David Metcalfe, Michael Patra, John Richardson, Johannes Ruscheinski,
353 Thomas Sandford, Constantine Sapuntzakis, Daniel Schepler,
354 Bernd Schmidt, Yngvi Sigurjonsson, Rick Sladkey, William Smith,
355 Erik Svendsen, Goran Thyni, Jimmy Tirtawangsa, Jon Tombs,
356 Linus Torvalds, Gregory Trubetskoy, Michael Veksler, Morten Welinder,
357 Jan Willamowius, Carl Williams, Karl Guenter Wuensch, Eric Youngdale,
358 and James Youngman.
359 .PP
360 This man page is maintained by Mike Phillips (msphil@facstaff.wm.edu), so 
361 please send all corrections, comments, flames, etc., to him.
362 .SH BUGS
363 There are too many to count, much less list.  Some bugs of note, however,
364 are that programs requiring VBRUNxxx.DLL are unreliable (with reports of
365 some working), OLE is not in place, the internal COMMDLG support is not yet
366 at 100% (although rapidly improving).  Color support for other than 8bpp
367 (256 colors) is currently flaky.
368 .PP
369 A partial list of applications known to work with 
370 .B wine
371 include: sol, cruel, golf, clock, notepad, charmap, calc, and wzip11.
372 The following URLs point to different success/testing lists:
373 .br
374 .I http://www.ifi.uio.no/~dash/wine/working-apps.html
375 .br
376 .I http://dutifp.twi.tudelft.nl:8000/wine/
377 .PP
378 We would like to hear about what software does run under 
379 .B Wine,
380 and such reports may be posted to 
381 .I comp.emulators.ms-windows.wine.
382 .SH AVAILABILITY
383 The most recent public version of 
384 .B wine
385 can be ftp'ed from tsx-11.mit.edu in the /pub/linux/ALPHA/Wine/development 
386 directory.  The releases are in the format 'Wine-yymmdd.tar.gz', 
387 or 'Wine-yymmdd.diff.gz' for the diff's from the previous release.
388 .SH FILES
389 .PD 0
390 .TP
391 .I /usr/local/bin/wine
392 The invoker program.
393 .TP
394 .I /usr/local/etc/wine.conf
395 Main configuration file for wine.
396 .TP
397 .I ChangeLog
398 Changes in Wine, since the beginning (most recent changes first)
399 .TP
400 .I configure
401 Shell script to automatically generate Makefiles.  Usually followed by
402 make to compile wine.
403 .TP
404 .I Wine newsgroup
405 Subscribe to comp.emulators.ms-windows.wine