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