| blob | 30ad4c1dbbb31d1cfb08c3cd6b4098a0d8e22e4c |
1 .\" -*- nroff -*-
2 .TH WINE 1 "Feb 13, 2001" "Version 20010112" "Windows On Unix"
3 .SH NAME
4 wine \- run Windows programs on Unix
5 .SH SYNOPSIS
6 .BI "wine " "[wine_options] " "[--] " "program " "[arguments ... ]"
7 .PP
8 For instructions on passing arguments to Windows programs, please see the
9 .B
10 PROGRAM/ARGUMENTS
11 section of the man page.
12 .SH DESCRIPTION
13 .B wine
14 .I program
15 loads and runs the given program, where the program is a DOS, Windows 3.x,
16 or Win32 executable (x86 binaries only).
17 .PP
18 For debugging wine, use
19 .B winedbg
20 .I program
21 instead.
22 .PP
23 .B wine
24 currently runs a growing list of applications written for all kinds of
25 Windows versions >= Win2.0, e.g. Win3.1, Win95/98, NT.
26 Older, simpler applications work better than newer, more complex ones.
27 Using Windows ME or Win2000 components with Wine is more problematic than
28 using none at all or the ones from older Windows versions.
29 A large percentage of the API has been implemented,
30 although there are still several major pieces of work left to do.
31 .SH REQUIREMENTS AND INSTALLATION
32 Read the README file in the Wine source distribution to know what Wine
33 requires and how it is installed from source.
34 .SH OPTIONS
35 .TP
36 .I --debugmsg [xxx]#name[,[xxx1]#name1][,<+|->relay=yyy1[:yyy2]]
37 Turn debugging messages on or off.
38 .RS +7
39 .PP
40 xxx is optional and can be one of the following:
41 .I err,
42 .I warn,
43 .I fixme,
44 or
45 .I trace.
46 If xxx is not specified, all debugging messages for the specified
47 channel are turned on. Each channel will print messages about a particular
48 component of
49 .B wine.
50 # is required and can be either + or -. Note that
51 there is not a space after the comma between names. yyy are either the
52 name of a whole DLL or a single API entry by name you either
53 want to include or exclude from the relay listing. Case doesn't matter
54 for these. You can do the same for snoop.
55 .PP
56 For instance:
57 .PP
58 .I --debugmsg warn+all
59 will turn on all warning messages (recommended for debugging)
60 .br
61 .I --debugmsg warn+dll,+heap
62 will turn on DLL warning messages and all heap messages.
63 .br
64 .I --debugmsg fixme-all,warn+cursor,+relay
65 will turn off all FIXME messages, turn on cursor warning messages, and turn
66 on all relay messages (API calls).
67 .br
68 .I --debugmsg -relay=rtlleavecriticalsection:RtlEnterCriticalSection
69 will turn on all relay messages except for RtlLeaveCriticalSection and
70 RtlEnterCriticalSection.
71 .br
72 .I --debugmsg +relay=advapi32
73 will only turn on relay messages into the ADVAPI32 code.
74 .PP
75 The full list of names is:
76 all, accel, advapi, animate, aspi, atom, avifile, bitblt, bitmap, caret,
77 cdrom, class, clipboard, clipping, combo, comboex, comm, commctrl, commdlg,
78 console, crtdll, cursor, datetime, dc, ddeml, ddraw, debug, debugstr,
79 delayhlp, dialog, dinput, dll, dosfs, dosmem, dplay, driver, dsound, edit,
80 elfdll, enhmetafile, event, exec, file, fixup, font, gdi, global, graphics,
81 header, heap, hook, hotkey, icmp, icon, imagehlp, imagelist, imm, int, int10,
82 int16, int17, int19, int21, int31, io, ipaddress, joystick, key, keyboard,
83 ldt, listbox, listview, local, mci, mcianim, mciavi, mcicda, mcimidi,
84 mciwave, mdi, menu, message, metafile, midi, mmaux, mmio, mmsys, mmtime,
85 module, monthcal, mpr, msacm, msg, msvideo, nativefont, nonclient, ntdll,
86 odbc, ole, pager, palette, pidl, print, process, profile, progress, prop,
87 propsheet, psapi, psdrv, ras, rebar, reg, region, relay, resource, scroll,
88 segment, seh, selector, sendmsg, server, setupx, shell, snoop, sound,
89 static, statusbar, storage, stress, string, syscolor, system, tab, tape,
90 tapi, task, text, thread, thunk, timer, toolbar, toolhelp, tooltips,
91 trackbar, treeview, ttydrv, tweak, typelib, updown, ver, virtual, vxd, wave,
92 win, win16drv, win32, winedbg, wing, winsock, winspool, wnet, x11 and x11drv.
94 .PP
95 For more information on debugging messages, see the file
96 .I documentation/debug-msgs
97 in the source distribution (FIXME: outdated).
98 .RE
99 .TP
100 .I --desktop geom
101 Use a desktop window of the given geometry, e.g. "640x480"
102 .TP
103 .I --display name
104 Use the specified X display
105 .TP
106 .I --dll name[,name[,...]]={native|so|builtin}[,{n|s|b}[,...]]
107 Selects the override type and load order of dll used in the loading
108 process for any dll. The default is set in the configuration
109 file. There are currently three types of libraries that can be loaded
110 into a process' address space: Native windows dlls (
111 .I native
112 ), native ELF libraries (
113 .I so
114 )and
115 .B wine
116 internal dlls (
117 .I builtin
118 ). The type may be abbreviated with the first letter of the type (
119 .I n, s, b
120 ). Each sequence of orders must be separated by commas.
121 .br
122 Each dll may have its own specific load order. The load order
123 determines which version of the dll is attempted to be loaded into the
124 address space. If the first fails, then the next is tried and so
125 on. Multiple libraries with the same load order can be separated with
126 commas. It is also possible to use the --dll option several times, to
127 specify different loadorders for different libraries
128 .br
129 Examples:
130 .br
131 .I --dll comdlg32,commdlg=n,b
132 .br
133 Try to load comdlg32 and commdlg as native windows dll first and try
134 the builtin version if the native load fails.
135 .br
136 .I --dll shell,shell32=n --dll c:\(rs\(rsfoo\(rs\(rsbar\(rs\(rsbaz=b
137 .br
138 Try to load the libraries shell and shell32 as native windows dlls. Furthermore, if
139 an application request to load c:\(rsfoo\(rsbar\(rsbaz.dll load the builtin library baz.
140 .br
141 .I --dll comdlg32,commdlg=b,n --dll shell,shell32=b --dll comctl32,commctrl=n
142 .br
143 Try to load comdlg32 and commdlg as builtin first and try the native version
144 if the builtin load fails; load shell32/shell always as builtin and
145 comctl32/commctrl always as native.
146 .br
147 Note: It is wise to keep dll pairs (comdlg32/commdlg, shell/shell32, etc.)
148 having exactly the same load order. This will prevent mismatches at runtime.
149 See also configuration file format below.
150 .TP
151 .I --dosver version
152 Specify the DOS version
153 .B wine
154 should imitate (e.g. 6.22) This option
155 is only valid when used in conjunction with --winver win31.
156 .TP
157 .I --language xx
158 Set the language to
159 .I xx
160 (one of Br, Ca, Cs, Cy, Da, De, En, Eo, Es, Fi, Fr, Ga, Gd, Gv, Hr,
161 Hu, It, Ko, Kw, No, Pl, Pt, Ru, Sk, Sv, Wa)
162 .TP
163 .I --managed
164 Create each top-level window as a properly managed X window instead of
165 creating our own "sticky" window.
166 .TP
167 .I --synchronous
168 Turn on synchronous display mode. Useful for debugging X11 graphics problems.
169 .TP
170 .I --winver version
171 Specify which Windows version
172 .B wine
173 should imitate.
174 Possible arguments are: win95, nt40, win31, win2000, win98, nt351, win30
175 and win20.
176 .PD 1
177 .SH PROGRAM/ARGUMENTS
178 The program name may be specified in DOS format (
179 .I
180 C:\(rs\(rsWINDOWS\(rs\(rsSOL.EXE)
181 or in Unix format (
182 .I /msdos/windows/sol.exe
183 ). You may pass arguments to the program being executed by adding them
184 to the end of the command line invoking
185 .B wine
186 (such as: wine notepad C:\(rs\(rsTEMP\(rs\(rsREADME.TXT). Command line processing goes as
187 follows: first
188 .B wine
189 checks whether one or more of the above mentioned
190 .B wine
191 options have been specified. These
192 are removed from the command line, which is passed to the windows program. You can use
193 the parameter
194 .I --
195 to indicate that
196 .B wine
197 should stop command line processing. This is needed in case a windows program understands
198 an option that is usually interpreted (and thus removed from the command line)
199 by
200 .B wine.
201 For example, if you want to execute
202 .B wine
203 with the options
204 .I --managed --display :0.2
205 and if
206 .B wine
207 should run the program
208 .I myapp.exe
209 with the arguments
210 .I --display 3d somefile
211 , then you could use the following command line to invoke
212 .B wine:
213 .PP
214 .I wine --managed --display :0.2 -- myapp.exe --display 3d somefile
215 .PP
216 Note that in contrast to previous versions of
217 .B wine,
218 you must not pass
219 program name and program option in one argument to
220 .B wine.
221 To run more
222 than one windows program, just execute
223 .B wine
224 once with the name of each program as argument.
225 .SH ENVIRONMENT VARIABLES
226 .B wine
227 makes the environment variables of the shell from which
228 .B wine
229 is started accessible to the windows/dos processes started. So use the
230 appropriate syntax for your shell to enter environment variables you need.
231 .TP
232 .I WINEPREFIX
233 If set, the content of this variable is taken as the name of the directory where
234 .B wine
235 stores its data (the default is
236 .I $HOME/.wine
237 ). This directory contains also the socket, which is used to communicate with the
238 .I wineserver.
239 All
240 .B wine
241 processes using the same
242 .B wineserver
243 (i.e.: same user) share certain things like registry and shared memory.
244 By setting
245 .I WINEPREFIX
246 to different values for different
247 .B wine
248 processes, it is possible to run a number of truly independent
249 .B wine
250 processes.
251 .TP
252 .I WINESERVER
253 Specifies the path and name of the
254 .B wineserver
255 binary. If not set, a file named "wineserver" is searched in the
256 path and in a few other likely locations.
257 .TP
258 .I WINELOADER
259 Specifies the path and name of the
260 .B wine
261 binary to use to launch new Windows processes. If not set, a binary
262 named "wine" is searched in the path and in a few other likely
263 locations.
264 .TP
265 .I WINEDLLPATH
266 Specifies the path(s) in which to search for builtin dll files. This
267 is a list of directories separated by ":". Builtin dlls are also
268 searched in the directories specified by the standard
269 .I LD_LIBRARY_PATH
270 if they are not found in the directories listed in
271 .I WINEDLLPATH.
273 .SH CONFIGURATION FILE
274 .B wine
275 expects a configuration file (
276 .I @sysconfdir@/wine.conf
277 ), which must conform to the format specified in the
278 .BR wine.conf (5)
279 man page. A sample configuration file is documentation/samples/config in the
280 .B wine
281 source archive. Alternatively a configuration file with the name
282 .I config
283 in the ~/.wine directory of the user running
284 .B wine
285 can be used.
286 .SH AUTHORS
287 .B wine
288 is available thanks to the work of many developers. For a listing
289 of the authors, please see the file
290 .B AUTHORS
291 in the top-level directory of the source distribution.
292 .SH COPYRIGHT
293 .B wine
294 can be distributed under the terms of the X11 license. A copy of the
295 license is in the file
296 .B LICENSE
297 in the top-level directory of the source distribution.
298 .SH BUGS
299 .PP
300 A status report on many applications is available from
301 .I http://www.winehq.com/Apps.
302 Please add entries to this list for applications you currently run.
303 .PP
304 Bug reports and successes may be posted to
305 .I comp.emulators.ms-windows.wine.
306 If you want to post a bug report, please read the file
307 .I documentation/bugreports
308 in the
309 .B wine
310 source to see what information is necessary (FIXME: outdated).
311 .PP
312 For problems and suggestions with this manpage, please send a note to
313 James Juran <jrj120@psu.edu>.
314 .SH AVAILABILITY
315 The most recent public version of
316 .B wine
317 can be obtained via FTP from ibiblio.org in the
318 /pub/Linux/ALPHA/Wine/development directory. The releases are in the
319 format 'Wine-yyyymmdd.tar.gz', or 'Wine-yyyymmdd.diff.gz' for the
320 diff's from the previous release. The same directory holds the
321 pre-built contents of the documentation in various formats
322 (wine-doc.xxx.gz).
323 .PP
324 The latest snapshot of the code may be obtained via CVS. For information
325 on how to do this, please see
326 .I
327 http://www.winehq.com/dev.html
328 .PP
329 WineHQ, the
330 .B wine
331 development headquarters, is at
332 .I http://www.winehq.com/.
333 This website contains a great deal of information about
334 .B wine.
335 .PP
336 The
337 .B wine
338 newsgroup is
339 .I comp.emulators.ms-windows.wine.
340 It is used for discussion of various
341 .B wine end user aspects/help.
342 .PP
343 For further information about
344 .B wine
345 development, you might want to subscribe to the
346 .B wine
347 "cvs", "devel" and "patches" mailing lists at
348 .I http://www.winehq.com/dev.html#ml.
349 .SH FILES
350 .PD 0
351 .TP
352 .I @prefix@/bin/wine
353 The
354 .B wine
355 program loader.
356 .TP
357 .I @prefix@/bin/dosmod
358 The DOS program loader.
359 .TP
360 .I @prefix@/bin/wineserver
361 The
362 .B wine
363 server
364 .TP
365 .I @prefix@/bin/winedbg
366 The
367 .B wine
368 debugger
369 .TP
370 .I @prefix@/bin/wineclpsrv
371 The
372 .B wine
373 clipboard server
374 .TP
375 .I @prefix@/lib/
376 Directory containing
377 .B wine's
378 shared libraries
379 .TP
380 .I @sysconfdir@/wine.conf
381 Global configuration file for
382 .B wine.
383 .TP
384 .I ~/.wine/config
385 User-specific configuration file
386 .TP
387 .I ~/.wine
388 Directory containing user specific data managed by
389 .B wine.
391 .SH "SEE ALSO"
392 .BR wine.conf (5)