| blob | 6779b4430abb7a9117b03a56e0714f03d3dc4a8a |
1 .\" -*- nroff -*-
2 .TH WINE 1 "October 2005" "@PACKAGE_STRING@" "Windows On Unix"
3 .SH NAME
4 wine \- run Windows programs on Unix
5 .SH SYNOPSIS
6 .BI "wine " program
7 [arguments ... ]
8 .br
9 .B wine --help
10 .br
11 .B wine --version
12 .PP
13 For instructions on passing arguments to Windows programs, please see the
14 .B
15 PROGRAM/ARGUMENTS
16 section of the man page.
17 .SH DESCRIPTION
18 .B wine
19 loads and runs the given program, where the program is a DOS, Windows
20 3.x, or Win32 executable (x86 binaries only).
21 .PP
22 For debugging wine, use
23 .B winedbg
24 instead.
25 .PP
26 For running CUI executables (Windows console programs), use
27 .B wineconsole
28 instead of
29 .BR wine .
30 This will display all the output in a separate windows (this requires X11 to
31 run). Not using
32 .B wineconsole
33 for CUI programs will only provide very limited console support, and your
34 program might not function properly.
35 .PP
36 When invoked with
37 .B --help
38 or
39 .B --version
40 as the only argument,
41 .B wine
42 will simply print a small help message or its version respectively and exit.
43 .SH PROGRAM/ARGUMENTS
44 The program name may be specified in DOS format
45 .RI ( C:\(rs\(rsWINDOWS\(rs\(rsSOL.EXE )
46 or in Unix format
47 .RI ( /msdos/windows/sol.exe ).
48 You may pass arguments to the program being executed by adding them to the
49 end of the command line invoking
50 .B wine
51 (such as: wine notepad C:\(rs\(rsTEMP\(rs\(rsREADME.TXT).
52 Note that you need to '\(rs' escape special characters (and spaces) when invoking Wine via
53 a shell, e.g.
54 .PP
55 wine C:\(rs\(rsProgram\(rs Files\(rs\(rsMyPrg\(rs\(rstest.exe
56 .PP
57 .SH ENVIRONMENT VARIABLES
58 .B wine
59 makes the environment variables of the shell from which
60 .B wine
61 is started accessible to the windows/dos processes started. So use the
62 appropriate syntax for your shell to enter environment variables you need.
63 .TP
64 .I WINEPREFIX
65 If set, the content of this variable is taken as the name of the directory where
66 .B wine
67 stores its data (the default is
68 .IR $HOME/.wine ).
69 This directory is also used to identify the socket which is used to
70 communicate with the
71 .IR wineserver .
72 All
73 .B wine
74 processes using the same
75 .B wineserver
76 (i.e.: same user) share certain things like registry, shared memory,
77 and config file.
78 By setting
79 .I WINEPREFIX
80 to different values for different
81 .B wine
82 processes, it is possible to run a number of truly independent
83 .B wine
84 processes.
85 .TP
86 .I WINESERVER
87 Specifies the path and name of the
88 .B wineserver
89 binary. If not set, Wine will try to load
90 .BR @bindir@/wineserver ,
91 and if this doesn't exist it will then look for a file named
92 "wineserver" in the path and in a few other likely locations.
93 .TP
94 .I WINELOADER
95 Specifies the path and name of the
96 .B wine
97 binary to use to launch new Windows processes. If not set, Wine will
98 try to load
99 .BR @bindir@/wine ,
100 and if this doesn't exist it will then look for a file named "wine" in
101 the path and in a few other likely locations.
102 .TP
103 .I WINEDEBUG
104 Turns debugging messages on or off. The syntax of the variable is
105 of the form
106 .RI [ class ][+/-] channel [,[ class2 ][+/-] channel2 ].
107 .RS +7
108 .PP
109 .I class
110 is optional and can be one of the following:
111 .BR err ,
112 .BR warn ,
113 .BR fixme ,
114 or
115 .BR trace .
116 If
117 .I class
118 is not specified, all debugging messages for the specified
119 channel are turned on. Each channel will print messages about a particular
120 component of
121 .BR wine .
122 The following character can be either + or - to switch the specified
123 channel on or off respectively. If there is no
124 .I class
125 part before it, a leading + can be omitted. Note that spaces are not
126 allowed anywhere in the string.
127 .PP
128 Examples:
129 .TP
130 WINEDEBUG=warn+all
131 will turn on all warning messages (recommended for debugging).
132 .br
133 .TP
134 WINEDEBUG=warn+dll,+heap
135 will turn on DLL warning messages and all heap messages.
136 .br
137 .TP
138 WINEDEBUG=fixme-all,warn+cursor,+relay
139 will turn off all FIXME messages, turn on cursor warning messages, and turn
140 on all relay messages (API calls).
141 .br
142 .TP
143 WINEDEBUG=relay
144 will turn on all relay messages. For more control on including or excluding
145 functions and dlls from the relay trace, look into the
146 .B HKEY_CURRENT_USER\\\\Software\\\\Wine\\\\Debug
147 registry key.
148 .PP
149 For more information on debugging messages, see the
150 .I Running Wine
151 chapter of the Wine User Guide.
152 .RE
153 .TP
154 .I WINEDLLPATH
155 Specifies the path(s) in which to search for builtin dlls and Winelib
156 applications. This is a list of directories separated by ":". In
157 addition to any directory specified in
158 .IR WINEDLLPATH ,
159 Wine will also look in
160 .BR @dlldir@ .
161 .TP
162 .I WINEDLLOVERRIDES
163 Defines the override type and load order of dlls used in the loading
164 process for any dll. There are currently two types of libraries that can be loaded
165 into a process' address space: native windows dlls
166 .RI ( native ),
167 .B wine
168 internal dlls
169 .RI ( builtin ).
170 The type may be abbreviated with the first letter of the type
171 .RI ( n ", " b ).
172 The library may also be disabled (''). Each sequence of orders must be separated by commas.
173 .RS
174 .PP
175 Each dll may have its own specific load order. The load order
176 determines which version of the dll is attempted to be loaded into the
177 address space. If the first fails, then the next is tried and so
178 on. Multiple libraries with the same load order can be separated with
179 commas. It is also possible to use specify different loadorders for
180 different libraries by separating the entries by ";".
181 .PP
182 The load order for a 16-bit dll is always defined by the load order of
183 the 32-bit dll that contains it (which can be identified by looking at
184 the symbolic link of the 16-bit .dll.so file). For instance if
185 ole32.dll is configured as builtin, storage.dll will be loaded as
186 builtin too, since the 32-bit ole32.dll contains the 16-bit
187 storage.dll.
188 .PP
189 Examples:
190 .TP
191 WINEDLLOVERRIDES="comdlg32,shell32=n,b"
192 .br
193 Try to load comdlg32 and shell32 as native windows dll first and try
194 the builtin version if the native load fails.
195 .TP
196 WINEDLLOVERRIDES="comdlg32,shell32=n;c:\(rs\(rsfoo\(rs\(rsbar\(rs\(rsbaz=b"
197 .br
198 Try to load the libraries comdlg32 and shell32 as native windows dlls. Furthermore, if
199 an application request to load c:\(rsfoo\(rsbar\(rsbaz.dll load the builtin library baz.
200 .TP
201 WINEDLLOVERRIDES="comdlg32=b,n;shell32=b;comctl32=n;oleaut32="
202 .br
203 Try to load comdlg32 as builtin first and try the native version if
204 the builtin load fails; load shell32 always as builtin and comctl32
205 always as native. Oleaut32 will be disabled.
206 .RE
207 .TP
208 .I WINEARCH
209 Specifies the Windows architecture to support. It can be set either to
210 .B win32
211 (support only 32-bit applications), or to
212 .B win64
213 (support both 64-bit applications and 32-bit ones in WoW64 mode).
214 .br
215 The architecture supported by a given Wine prefix is set at prefix
216 creation time and cannot be changed afterwards. When running with an
217 existing prefix, Wine will refuse to start if
218 .I WINEARCH
219 doesn't match the prefix architecture.
220 .TP
221 .I DISPLAY
222 Specifies the X11 display to use.
223 .TP
224 OSS sound driver configuration variables
225 .TP
226 .I AUDIODEV
227 Set the device for audio input / output. Default
228 .BR /dev/dsp .
229 .TP
230 .I MIXERDEV
231 Set the device for mixer controls. Default
232 .BR /dev/mixer .
233 .TP
234 .I MIDIDEV
235 Set the MIDI (sequencer) device. Default
236 .BR /dev/sequencer .
237 .SH FILES
238 .TP
239 .I @bindir@/wine
240 The
241 .B wine
242 program loader.
243 .TP
244 .I @bindir@/wineconsole
245 The
246 .B wine
247 program loader for CUI (console) applications.
248 .TP
249 .I @bindir@/wineserver
250 The
251 .B wine
252 server
253 .TP
254 .I @bindir@/winedbg
255 The
256 .B wine
257 debugger
258 .TP
259 .I @dlldir@
260 Directory containing
261 .BR wine 's
262 shared libraries
263 .TP
264 .I $WINEPREFIX/dosdevices
265 Directory containing the DOS device mappings. Each file in that
266 directory is a symlink to the Unix device file implementing a given
267 device. For instance, if COM1 is mapped to /dev/ttyS0 you'd have a
268 symlink of the form $WINEPREFIX/dosdevices/com1 -> /dev/ttyS0.
269 .br
270 DOS drives are also specified with symlinks; for instance if drive D:
271 corresponds to the CDROM mounted at /mnt/cdrom, you'd have a symlink
272 $WINEPREFIX/dosdevices/d: -> /mnt/cdrom. The Unix device corresponding
273 to a DOS drive can be specified the same way, except with '::' instead
274 of ':'. So for the previous example, if the CDROM device is mounted
275 from /dev/hdc, the corresponding symlink would be
276 $WINEPREFIX/dosdevices/d:: -> /dev/hdc.
277 .SH AUTHORS
278 .B wine
279 is available thanks to the work of many developers. For a listing
280 of the authors, please see the file
281 .B AUTHORS
282 in the top-level directory of the source distribution.
283 .SH COPYRIGHT
284 .B wine
285 can be distributed under the terms of the LGPL license. A copy of the
286 license is in the file
287 .B COPYING.LIB
288 in the top-level directory of the source distribution.
289 .SH BUGS
290 .PP
291 A status report on many applications is available from
292 .IR http://appdb.winehq.org .
293 Please add entries to this list for applications you currently run, if
294 there is no entry for this application.
295 .PP
296 Bug reports may be posted to Wine Bugzilla
297 .I http://bugs.winehq.org
298 If you want to post a bug report, please see
299 .I http://wiki.winehq.org/Bugs
300 in the
301 .B wine
302 source to see what information is necessary
303 .PP
304 Problems and suggestions with this manpage please also report to
305 .I http://bugs.winehq.org
306 .SH AVAILABILITY
307 The most recent public version of
308 .B wine
309 can be downloaded from
310 .I http://www.winehq.org/download
311 .PP
312 The latest snapshot of the code may be obtained via GIT. For information
313 on how to do this, please see
314 .I
315 http://www.winehq.org/site/git
316 .PP
317 WineHQ, the
318 .B wine
319 development headquarters, is at
320 .IR http://www.winehq.org .
321 This website contains a great deal of information about
322 .BR wine .
323 .PP
324 For further information about
325 .B wine
326 development, you might want to subscribe to the
327 .B wine
328 mailing lists at
329 .I http://www.winehq.org/forums
331 .SH "SEE ALSO"
332 .BR wineserver (1),
333 .BR winedbg (1)