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