wine.man.in 8.61 KB
Newer Older
Alexandre Julliard's avatar
Alexandre Julliard committed
1
.\" -*- nroff -*-
2
.TH WINE 1 "October 2005" "@PACKAGE_STRING@" "Windows On Unix"
Alexandre Julliard's avatar
Alexandre Julliard committed
3
.SH NAME
4
wine \- run Windows programs on Unix
Alexandre Julliard's avatar
Alexandre Julliard committed
5
.SH SYNOPSIS
6 7 8 9 10
.BI "wine " "program " "[arguments ... ]"
.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, where the program is a DOS, Windows
3.x, or Win32 executable (x86 binaries only).
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 29
.B wine.
This will display all the output in a separate windows (this requires X11 to
30 31 32 33 34
run). Not using
.B wineconsole
for CUI programs will only provide very limited console support, and your
program might not function properly.
.PP
35 36 37 38 39 40 41
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
42
.SH PROGRAM/ARGUMENTS
James Juran's avatar
James Juran committed
43 44
The program name may be specified in DOS format (
.I
45
C:\(rs\(rsWINDOWS\(rs\(rsSOL.EXE)
James Juran's avatar
James Juran committed
46 47
or in Unix format (
.I /msdos/windows/sol.exe
Andreas Mohr's avatar
Andreas Mohr committed
48
).  You may pass arguments to the program being executed by adding them 
James Juran's avatar
James Juran committed
49
to the end of the command line invoking
Alexandre Julliard's avatar
Alexandre Julliard committed
50
.B wine
Andreas Mohr's avatar
Andreas Mohr committed
51 52 53 54 55 56
(such as: wine notepad C:\(rs\(rsTEMP\(rs\(rsREADME.TXT).
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
57 58 59 60 61 62
.SH ENVIRONMENT VARIABLES
.B wine
makes the environment variables of the shell from which
.B wine
is started accessible to the windows/dos processes started. So use the
appropriate syntax for your shell to enter environment variables you need.
63 64
.TP 
.I WINEPREFIX
Andreas Mohr's avatar
Andreas Mohr committed
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 70
). This directory is also used to identify the socket which is used to
communicate with the
71 72 73
.I wineserver.
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 80 81 82 83 84
.I WINEPREFIX
to different values for different 
.B wine
processes, it is possible to run a number of truly independent 
.B wine
processes. 
85 86 87 88
.TP
.I WINESERVER
Specifies the path and name of the
.B wineserver
89 90
binary. If not set, Wine will try to load
.B @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 94 95 96
.TP
.I WINELOADER
Specifies the path and name of the
.B wine
97 98 99
binary to use to launch new Windows processes. If not set, Wine will
try to load
.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 104
.I WINEDEBUG
Turns debugging messages on or off. The syntax of the variable is
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
of the form
.RI [ class ][+/-] channel [,[ class2 ][+/-] channel2 ].
.RS +7
.PP
.I class
is optional and can be one of the following: 
.B err, warn, fixme,
or 
.B trace. 
If
.I class
is not specified, all debugging messages for the specified
channel are turned on.  Each channel will print messages about a particular
component of 
.B wine.  
The following character can be either + or - to switch the specified
channel on or off respectively.  If there is no
.I class
part before it, a leading + can be omitted. Note that spaces are not
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
functions and dlls from the relay trace look into the [Debug] section
of the wine configuration file.
.PP
For more information on debugging messages, see the
.I Running Wine
chapter of the Wine User Guide.
.RE
150
.TP
151
.I WINEDLLPATH
152 153 154 155 156 157
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
.I WINEDLLPATH,
Wine will also look in
.B @dlldir@.
158
.TP
159 160 161 162 163 164 165 166 167 168 169 170 171
.I WINEDLLOVERRIDES
Defines the override type and load order of dlls used in the loading
process for any dll. The default is set in the configuration
file. There are currently two types of libraries that can be loaded
into a process' address space: Native windows dlls (
.I native
), 
.B wine 
internal dlls (
.I builtin
). The type may be abbreviated with the first letter of the type (
.I n, b
). Each sequence of orders must be separated by commas.
172 173
.RS
.PP
174 175 176 177 178 179
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 ";".
180
.PP
181 182 183 184 185 186
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
ole32.dll is configured as builtin, storage.dll will be loaded as
builtin too, since the 32-bit ole32.dll contains the 16-bit
storage.dll.
187
.PP
188 189
Examples:
.TP
190
WINEDLLOVERRIDES="comdlg32,shell32=n,b"
191
.br
192
Try to load comdlg32 and shell32 as native windows dll first and try
193 194
the builtin version if the native load fails.
.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 199
an application request to load c:\(rsfoo\(rsbar\(rsbaz.dll load the builtin library baz. 
.TP
200
WINEDLLOVERRIDES="comdlg32=b,n;shell32=b;comctl32=n"
201
.br
202 203 204
Try to load comdlg32 as builtin first and try the native version if
the builtin load fails; load shell32 always as builtin and comctl32
always as native.
205 206
.RE
.TP
207 208
.I DISPLAY
Specifies the X11 display to use.
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
.SH FILES
.TP
.I @bindir@/wine
The 
.B wine 
program loader.
.TP
.I @bindir@/wineconsole
The 
.B wine 
program loader for CUI (console) applications.
.TP
.I @bindir@/wineserver
The 
.B wine 
server 
.TP 
.I @bindir@/winedbg
The 
.B wine 
debugger
.TP 
.I @dlldir@
Directory containing 
.B wine's
shared libraries 
.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
device. For instance, if COM1 is mapped to /dev/ttyS0 you'd have a
symlink of the form $WINEPREFIX/dosdevices/com1 -> /dev/ttyS0.
.br
DOS drives are also specified with symlinks; for instance if drive D:
corresponds to the CDROM mounted at /mnt/cdrom, you'd have a symlink
$WINEPREFIX/dosdevices/d: -> /mnt/cdrom. The Unix device corresponding
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
from /dev/hdc, the corresponding symlink would be
$WINEPREFIX/dosdevices/d:: -> /dev/hdc.
Alexandre Julliard's avatar
Alexandre Julliard committed
249
.SH AUTHORS
250
.B wine
Alexandre Julliard's avatar
Alexandre Julliard committed
251 252 253 254
is available thanks to the work of many developers. For a listing
of the authors, please see the file 
.B AUTHORS
in the top-level directory of the source distribution.
255 256
.SH COPYRIGHT
.B wine
257
can be distributed under the terms of the LGPL license. A copy of the
258
license is in the file
259
.B COPYING.LIB
260
in the top-level directory of the source distribution.
Alexandre Julliard's avatar
Alexandre Julliard committed
261 262
.SH BUGS
.PP
Andreas Mohr's avatar
Andreas Mohr committed
263
A status report on many applications is available from
264
.I http://appdb.winehq.org.
James Juran's avatar
James Juran committed
265
Please add entries to this list for applications you currently run.
Alexandre Julliard's avatar
Alexandre Julliard committed
266
.PP
267
Bug reports may be posted to Wine Bugzilla
268
.I http://bugs.winehq.org
269
If you want to post a bug report, please read the file
270
.I documentation/bugs.sgml
271 272
in the 
.B wine 
273
source to see what information is necessary
James Juran's avatar
James Juran committed
274
.PP
275
Problems and suggestions with this manpage please also report to
276
.I http://bugs.winehq.org
Alexandre Julliard's avatar
Alexandre Julliard committed
277 278 279
.SH AVAILABILITY
The most recent public version of 
.B wine
280 281
can be downloaded from
.I http://www.winehq.org/download
Alexandre Julliard's avatar
Alexandre Julliard committed
282
.PP
283
The latest snapshot of the code may be obtained via GIT.  For information
James Juran's avatar
James Juran committed
284 285
on how to do this, please see
.I
286
http://www.winehq.org/site/git
James Juran's avatar
James Juran committed
287
.PP
288
WineHQ, the
Alexandre Julliard's avatar
Alexandre Julliard committed
289
.B wine
290
development headquarters, is at
291
.I http://www.winehq.org.
Alexandre Julliard's avatar
Alexandre Julliard committed
292
This website contains a great deal of information about
293
.B wine.
Alexandre Julliard's avatar
Alexandre Julliard committed
294
.PP
295
For further information about 
Andreas Mohr's avatar
Andreas Mohr committed
296 297
.B wine
development, you might want to subscribe to the 
298
.B wine 
299
mailing lists at
300
.I http://www.winehq.org/forums
301

302
.SH "SEE ALSO"
303
.BR wineserver (1),\  winedbg (1)