| blob | 63d44b0d21d1b7b2c28e7bf9544a7974262f3522 |
1 .\" -*- nroff -*-
2 .TH WINE 1 "Aug 5, 2001" "Version 20010731" "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 --dll name[,name[,...]]={native|so|builtin}[,{n|s|b}[,...]]
101 Selects the override type and load order of dll used in the loading
102 process for any dll. The default is set in the configuration
103 file. There are currently three types of libraries that can be loaded
104 into a process' address space: Native windows dlls (
105 .I native
106 ), native ELF libraries (
107 .I so
108 )and
109 .B wine
110 internal dlls (
111 .I builtin
112 ). The type may be abbreviated with the first letter of the type (
113 .I n, s, b
114 ). Each sequence of orders must be separated by commas.
115 .br
116 Each dll may have its own specific load order. The load order
117 determines which version of the dll is attempted to be loaded into the
118 address space. If the first fails, then the next is tried and so
119 on. Multiple libraries with the same load order can be separated with
120 commas. It is also possible to use the --dll option several times, to
121 specify different loadorders for different libraries
122 .br
123 Examples:
124 .br
125 .I --dll comdlg32,commdlg=n,b
126 .br
127 Try to load comdlg32 and commdlg as native windows dll first and try
128 the builtin version if the native load fails.
129 .br
130 .I --dll shell,shell32=n --dll c:\(rs\(rsfoo\(rs\(rsbar\(rs\(rsbaz=b
131 .br
132 Try to load the libraries shell and shell32 as native windows dlls. Furthermore, if
133 an application request to load c:\(rsfoo\(rsbar\(rsbaz.dll load the builtin library baz.
134 .br
135 .I --dll comdlg32,commdlg=b,n --dll shell,shell32=b --dll comctl32,commctrl=n
136 .br
137 Try to load comdlg32 and commdlg as builtin first and try the native version
138 if the builtin load fails; load shell32/shell always as builtin and
139 comctl32/commctrl always as native.
140 .br
141 Note: It is wise to keep dll pairs (comdlg32/commdlg, shell/shell32, etc.)
142 having exactly the same load order. This will prevent mismatches at runtime.
143 See also configuration file format below.
144 .TP
145 .I --dosver version
146 Specify the DOS version
147 .B wine
148 should imitate (e.g. 6.22) This option
149 is only valid when used in conjunction with --winver win31.
150 .TP
151 .I --managed
152 Create each top-level window as a properly managed X window instead of
153 creating our own "sticky" window.
154 .TP
155 .I --winver version
156 Specify which Windows version
157 .B wine
158 should imitate.
159 Possible arguments are: win95, nt40, win31, win2000, win98, nt351, win30
160 and win20.
161 .PD 1
162 .SH PROGRAM/ARGUMENTS
163 The program name may be specified in DOS format (
164 .I
165 C:\(rs\(rsWINDOWS\(rs\(rsSOL.EXE)
166 or in Unix format (
167 .I /msdos/windows/sol.exe
168 ). You may pass arguments to the program being executed by adding them
169 to the end of the command line invoking
170 .B wine
171 (such as: wine notepad C:\(rs\(rsTEMP\(rs\(rsREADME.TXT).
172 Note that you need to '\(rs' escape special characters (and spaces) when invoking Wine via
173 a shell, e.g.
174 .PP
175 wine C:\(rs\(rsProgram\(rs Files\(rs\(rsMyPrg\(rs\(rstest.exe
176 .PP
177 Command line processing goes as
178 follows: first
179 .B wine
180 checks whether one or more of the above mentioned
181 .B wine
182 options have been specified. These
183 are removed from the command line, which is passed to the windows program. You can use
184 the parameter
185 .I --
186 to indicate that
187 .B wine
188 should stop command line processing. This is needed in case a windows program understands
189 an option that is usually interpreted (and thus removed from the command line)
190 by
191 .B wine.
192 For example, if you want to execute
193 .B wine
194 with the options
195 .I --managed --dll riched32=n
196 and if
197 .B wine
198 should run the program
199 .I myapp.exe
200 with the arguments
201 .I --display 3d somefile
202 , then you could use the following command line to invoke
203 .B wine:
204 .PP
205 .I wine --managed --dll riched32=n -- myapp.exe --display 3d somefile
206 .PP
207 Note that in contrast to previous versions of
208 .B wine,
209 you must not pass
210 program name and program option in one argument to
211 .B wine.
212 To run more
213 than one windows program, just execute
214 .B wine
215 once with the name of each program as argument.
216 .SH ENVIRONMENT VARIABLES
217 .B wine
218 makes the environment variables of the shell from which
219 .B wine
220 is started accessible to the windows/dos processes started. So use the
221 appropriate syntax for your shell to enter environment variables you need.
222 .TP
223 .I WINEPREFIX
224 If set, the content of this variable is taken as the name of the directory where
225 .B wine
226 stores its data (the default is
227 .I $HOME/.wine
228 ). This directory contains also the socket, which is used to communicate with the
229 .I wineserver.
230 All
231 .B wine
232 processes using the same
233 .B wineserver
234 (i.e.: same user) share certain things like registry, shared memory,
235 and config file.
236 By setting
237 .I WINEPREFIX
238 to different values for different
239 .B wine
240 processes, it is possible to run a number of truly independent
241 .B wine
242 processes.
243 .TP
244 .I WINEPRELOAD
245 If set, specifies the full name of a shared library that
246 .B wine
247 loads and runs as a Winelib application.
248 .TP
249 .I WINESERVER
250 Specifies the path and name of the
251 .B wineserver
252 binary. If not set, a file named "wineserver" is searched in the
253 path and in a few other likely locations.
254 .TP
255 .I WINELOADER
256 Specifies the path and name of the
257 .B wine
258 binary to use to launch new Windows processes. If not set, a binary
259 named "wine" is searched in the path and in a few other likely
260 locations.
261 .TP
262 .I WINEDLLPATH
263 Specifies the path(s) in which to search for builtin dll files. This
264 is a list of directories separated by ":". Builtin dlls are also
265 searched in the directories specified by the standard
266 .I LD_LIBRARY_PATH
267 if they are not found in the directories listed in
268 .I WINEDLLPATH.
269 .TP
270 .I DISPLAY
271 Specifies the X11 display to use.
272 .SH CONFIGURATION FILE
273 .B wine
274 expects a configuration file (
275 .I $WINEPREFIX/config
276 (~/.wine/config)
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.
282 .SH AUTHORS
283 .B wine
284 is available thanks to the work of many developers. For a listing
285 of the authors, please see the file
286 .B AUTHORS
287 in the top-level directory of the source distribution.
288 .SH COPYRIGHT
289 .B wine
290 can be distributed under the terms of the X11 license. A copy of the
291 license is in the file
292 .B LICENSE
293 in the top-level directory of the source distribution.
294 .SH BUGS
295 .PP
296 A status report on many applications is available from
297 .I http://www.winehq.com/Apps.
298 Please add entries to this list for applications you currently run.
299 .PP
300 Bug reports and successes may be posted to
301 .I comp.emulators.ms-windows.wine.
302 If you want to post a bug report, please read the file
303 .I documentation/bugreports
304 in the
305 .B wine
306 source to see what information is necessary (FIXME: outdated).
307 .PP
308 For problems and suggestions with this manpage, please send a note to
309 James Juran <jrj120@psu.edu>.
310 .SH AVAILABILITY
311 The most recent public version of
312 .B wine
313 can be obtained via FTP from ibiblio.org in the
314 /pub/Linux/ALPHA/Wine/development directory. The releases are in the
315 format 'Wine-yyyymmdd.tar.gz', or 'Wine-yyyymmdd.diff.gz' for the
316 diff's from the previous release. The same directory holds the
317 pre-built contents of the documentation in various formats
318 (wine-doc.xxx.gz).
319 .PP
320 The latest snapshot of the code may be obtained via CVS. For information
321 on how to do this, please see
322 .I
323 http://www.winehq.com/dev.html
324 .PP
325 WineHQ, the
326 .B wine
327 development headquarters, is at
328 .I http://www.winehq.com/.
329 This website contains a great deal of information about
330 .B wine.
331 .PP
332 The
333 .B wine
334 newsgroup is
335 .I comp.emulators.ms-windows.wine.
336 It is used for discussion of various
337 .B wine end user aspects/help.
338 .PP
339 For further information about
340 .B wine
341 development, you might want to subscribe to the
342 .B wine
343 "cvs", "devel" and "patches" mailing lists at
344 .I http://www.winehq.com/dev.html#ml.
345 .SH FILES
346 .PD 0
347 .TP
348 .I @prefix@/bin/wine
349 The
350 .B wine
351 program loader.
352 .TP
353 .I @prefix@/bin/dosmod
354 The DOS program loader.
355 .TP
356 .I @prefix@/bin/wineserver
357 The
358 .B wine
359 server
360 .TP
361 .I @prefix@/bin/winedbg
362 The
363 .B wine
364 debugger
365 .TP
366 .I @prefix@/bin/wineclpsrv
367 The
368 .B wine
369 clipboard server
370 .TP
371 .I @prefix@/lib/
372 Directory containing
373 .B wine's
374 shared libraries
375 .TP
376 .I ~/.wine/config
377 User-specific configuration file
378 .TP
379 .I ~/.wine
380 Directory containing user specific data managed by
381 .B wine.
383 .SH "SEE ALSO"
384 .BR wine.conf (5)