| blob | 0f71f959445cca7430fad1bb869453bd97207c35 |
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 " "[arguments ... ]"
7 .br
8 .B wine --help
9 .br
10 .B wine --version
11 .PP
12 For instructions on passing arguments to Windows programs, please see the
13 .B
14 PROGRAM/ARGUMENTS
15 section of the man page.
16 .SH DESCRIPTION
17 .B wine
18 loads and runs the given program, where the program is a DOS, Windows
19 3.x, or Win32 executable (x86 binaries only).
20 .PP
21 For debugging wine, use
22 .B winedbg
23 instead.
24 .PP
25 For running CUI executables (Windows console programs), use
26 .B wineconsole
27 instead of
28 .B wine.
29 This will display all the output in a separate windows (this requires X11 to
30 run). Not using
31 .B wineconsole
32 for CUI programs will only provide very limited console support, and your
33 program might not function properly.
34 .PP
35 When invoked with
36 .B --help
37 or
38 .B --version
39 as the only argument,
40 .B wine
41 will simply print a small help message or its version respectively and exit.
42 .SH PROGRAM/ARGUMENTS
43 The program name may be specified in DOS format (
44 .I
45 C:\(rs\(rsWINDOWS\(rs\(rsSOL.EXE)
46 or in Unix format (
47 .I /msdos/windows/sol.exe
48 ). You may pass arguments to the program being executed by adding them
49 to the 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 .I $HOME/.wine
69 ). This directory is also used to identify the socket which is used to
70 communicate with the
71 .I 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 .B @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 .B @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 .B err, warn, fixme,
112 or
113 .B trace.
114 If
115 .I class
116 is not specified, all debugging messages for the specified
117 channel are turned on. Each channel will print messages about a particular
118 component of
119 .B wine.
120 The following character can be either + or - to switch the specified
121 channel on or off respectively. If there is no
122 .I class
123 part before it, a leading + can be omitted. Note that spaces are not
124 allowed anywhere in the string.
125 .PP
126 Examples:
127 .TP
128 WINEDEBUG=warn+all
129 will turn on all warning messages (recommended for debugging).
130 .br
131 .TP
132 WINEDEBUG=warn+dll,+heap
133 will turn on DLL warning messages and all heap messages.
134 .br
135 .TP
136 WINEDEBUG=fixme-all,warn+cursor,+relay
137 will turn off all FIXME messages, turn on cursor warning messages, and turn
138 on all relay messages (API calls).
139 .br
140 .TP
141 WINEDEBUG=relay
142 will turn on all relay messages. For more control on including or excluding
143 functions and dlls from the relay trace look into the [Debug] section
144 of the wine configuration file.
145 .PP
146 For more information on debugging messages, see the
147 .I Running Wine
148 chapter of the Wine User Guide.
149 .RE
150 .TP
151 .I WINEDLLPATH
152 Specifies the path(s) in which to search for builtin dlls and Winelib
153 applications. This is a list of directories separated by ":". In
154 addition to any directory specified in
155 .I WINEDLLPATH,
156 Wine will also look in
157 .B @dlldir@.
158 .TP
159 .I WINEDLLOVERRIDES
160 Defines the override type and load order of dlls used in the loading
161 process for any dll. The default is set in the configuration
162 file. There are currently two types of libraries that can be loaded
163 into a process' address space: Native windows dlls (
164 .I native
165 ),
166 .B wine
167 internal dlls (
168 .I builtin
169 ). The type may be abbreviated with the first letter of the type (
170 .I n, b
171 ). The library may also be disabled (''). Each sequence of orders must be separated by commas.
172 .RS
173 .PP
174 Each dll may have its own specific load order. The load order
175 determines which version of the dll is attempted to be loaded into the
176 address space. If the first fails, then the next is tried and so
177 on. Multiple libraries with the same load order can be separated with
178 commas. It is also possible to use specify different loadorders for
179 different libraries by separating the entries by ";".
180 .PP
181 The load order for a 16-bit dll is always defined by the load order of
182 the 32-bit dll that contains it (which can be identified by looking at
183 the symbolic link of the 16-bit .dll.so file). For instance if
184 ole32.dll is configured as builtin, storage.dll will be loaded as
185 builtin too, since the 32-bit ole32.dll contains the 16-bit
186 storage.dll.
187 .PP
188 Examples:
189 .TP
190 WINEDLLOVERRIDES="comdlg32,shell32=n,b"
191 .br
192 Try to load comdlg32 and shell32 as native windows dll first and try
193 the builtin version if the native load fails.
194 .TP
195 WINEDLLOVERRIDES="comdlg32,shell32=n;c:\(rs\(rsfoo\(rs\(rsbar\(rs\(rsbaz=b"
196 .br
197 Try to load the libraries comdlg32 and shell32 as native windows dlls. Furthermore, if
198 an application request to load c:\(rsfoo\(rsbar\(rsbaz.dll load the builtin library baz.
199 .TP
200 WINEDLLOVERRIDES="comdlg32=b,n;shell32=b;comctl32=n;oleaut32="
201 .br
202 Try to load comdlg32 as builtin first and try the native version if
203 the builtin load fails; load shell32 always as builtin and comctl32
204 always as native. Oleaut32 will be disabled.
205 .RE
206 .TP
207 .I DISPLAY
208 Specifies the X11 display to use.
209 .TP
210 OSS sound driver configuration variables
211 .TP
212 .I AUDIODEV
213 Set the device for audio input / output. Default
214 .B /dev/dsp.
215 .TP
216 .I MIXERDEV
217 Set the device for mixer controls. Default
218 .B /dev/mixer.
219 .TP
220 .I MIDIDEV
221 Set the MIDI (sequencer) device. Default
222 .B /dev/sequencer.
223 .SH FILES
224 .TP
225 .I @bindir@/wine
226 The
227 .B wine
228 program loader.
229 .TP
230 .I @bindir@/wineconsole
231 The
232 .B wine
233 program loader for CUI (console) applications.
234 .TP
235 .I @bindir@/wineserver
236 The
237 .B wine
238 server
239 .TP
240 .I @bindir@/winedbg
241 The
242 .B wine
243 debugger
244 .TP
245 .I @dlldir@
246 Directory containing
247 .B wine's
248 shared libraries
249 .TP
250 .I $WINEPREFIX/dosdevices
251 Directory containing the DOS device mappings. Each file in that
252 directory is a symlink to the Unix device file implementing a given
253 device. For instance, if COM1 is mapped to /dev/ttyS0 you'd have a
254 symlink of the form $WINEPREFIX/dosdevices/com1 -> /dev/ttyS0.
255 .br
256 DOS drives are also specified with symlinks; for instance if drive D:
257 corresponds to the CDROM mounted at /mnt/cdrom, you'd have a symlink
258 $WINEPREFIX/dosdevices/d: -> /mnt/cdrom. The Unix device corresponding
259 to a DOS drive can be specified the same way, except with '::' instead
260 of ':'. So for the previous example, if the CDROM device is mounted
261 from /dev/hdc, the corresponding symlink would be
262 $WINEPREFIX/dosdevices/d:: -> /dev/hdc.
263 .SH AUTHORS
264 .B wine
265 is available thanks to the work of many developers. For a listing
266 of the authors, please see the file
267 .B AUTHORS
268 in the top-level directory of the source distribution.
269 .SH COPYRIGHT
270 .B wine
271 can be distributed under the terms of the LGPL license. A copy of the
272 license is in the file
273 .B COPYING.LIB
274 in the top-level directory of the source distribution.
275 .SH BUGS
276 .PP
277 A status report on many applications is available from
278 .I http://appdb.winehq.org.
279 Please add entries to this list for applications you currently run, if
280 there is no entry for this application.
281 .PP
282 Bug reports may be posted to Wine Bugzilla
283 .I http://bugs.winehq.org
284 If you want to post a bug report, please read the file
285 .I documentation/bugs.sgml
286 in the
287 .B wine
288 source to see what information is necessary
289 .PP
290 Problems and suggestions with this manpage please also report to
291 .I http://bugs.winehq.org
292 .SH AVAILABILITY
293 The most recent public version of
294 .B wine
295 can be downloaded from
296 .I http://www.winehq.org/download
297 .PP
298 The latest snapshot of the code may be obtained via GIT. For information
299 on how to do this, please see
300 .I
301 http://www.winehq.org/site/git
302 .PP
303 WineHQ, the
304 .B wine
305 development headquarters, is at
306 .I http://www.winehq.org.
307 This website contains a great deal of information about
308 .B wine.
309 .PP
310 For further information about
311 .B wine
312 development, you might want to subscribe to the
313 .B wine
314 mailing lists at
315 .I http://www.winehq.org/forums
317 .SH "SEE ALSO"
318 .BR wineserver (1),\ winedbg (1)