documentation/wine.man.in

   1 .\" -*- nroff -*-
   2 .TH WINE 1 "May 2002" "@PACKAGE_STRING@" "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 loads and runs the given program, where the program is a DOS, Windows
  15 3.x, or Win32 executable (x86 binaries only).
  16 .PP
  17 For debugging wine, use
  18 .B winedbg
  19 instead.
  20 .PP
  21 For running CUI executables (Windows console programs), use
  22 .B wineconsole
  23 instead of
  24 .B wine.
  25 This will display all the output in a separate windows (this requires X11 to
  26 run). Not using
  27 .B wineconsole
  28 for CUI programs will only provide very limited console support, and your
  29 program might not function properly.
  30 .PP
  31 .B wine
  32 currently runs a growing list of applications written for all kinds of
  33 Windows versions >= Win2.0, e.g. Win3.1, Win95/98, NT.
  34 Older, simpler applications work better than newer, more complex ones.
  35 Using Windows ME or Win2000 components with Wine is more problematic than
  36 using none at all or the ones from older Windows versions.
  37 A large percentage of the API has been implemented,
  38 although there are still several major pieces of work left to do.
  39 .SH REQUIREMENTS AND INSTALLATION
  40 Read the README file in the Wine source distribution and the
  41 .BR wine.conf (5)
  42 man page to know what Wine requires and how it is installed from
  43 source.
  44 .SH OPTIONS
  45 .TP
  46 .I --debugmsg [xxx]#name[,[xxx1]#name1]
  47 Turn debugging messages on or off.  This option is deprecated, you
  48 should use the
  49 .I WINEDEBUG
  50 environment variable instead (see below).
  51 .PD 1
  52 .SH PROGRAM/ARGUMENTS
  53 The program name may be specified in DOS format (
  54 .I
  55 C:\(rs\(rsWINDOWS\(rs\(rsSOL.EXE)
  56 or in Unix format (
  57 .I /msdos/windows/sol.exe
  58 ).  You may pass arguments to the program being executed by adding them
  59 to the end of the command line invoking
  60 .B wine
  61 (such as: wine notepad C:\(rs\(rsTEMP\(rs\(rsREADME.TXT).
  62 Note that you need to '\(rs' escape special characters (and spaces) when invoking Wine via
  63 a shell, e.g.
  64 .PP
  65 wine C:\(rs\(rsProgram\(rs Files\(rs\(rsMyPrg\(rs\(rstest.exe
  66 .PP
  67 Command line processing goes as
  68 follows: first
  69 .B wine
  70 checks whether one or more of the above mentioned
  71 .B wine
  72 options have been specified. These
  73 are removed from the command line, which is passed to the windows program. You can use
  74 the parameter
  75 .I --
  76 to indicate that
  77 .B wine
  78 should stop command line processing. This is needed in case a windows program understands
  79 an option that is usually interpreted (and thus removed from the command line)
  80 by
  81 .B wine.
  82 For example, if you want to execute
  83 .B wine
  84 with the options
  85 .I --debugmsg +module
  86 and if
  87 .B wine
  88 should run the program
  89 .I myapp.exe
  90 with the arguments
  91 .I --display 3d somefile
  92 , then you could use the following command line to invoke
  93 .B wine:
  94 .PP
  95 .I wine --debugmsg +module -- myapp.exe --display 3d somefile
  96 .PP
  97 Note that in contrast to previous versions of
  98 .B wine,
  99 you must not pass
 100 program name and program option in one argument to
 101 .B wine.
 102 To run more
 103 than one windows program, just execute
 104 .B wine
 105 once with the name of each program as argument.
 106 .SH ENVIRONMENT VARIABLES
 107 .B wine
 108 makes the environment variables of the shell from which
 109 .B wine
 110 is started accessible to the windows/dos processes started. So use the
 111 appropriate syntax for your shell to enter environment variables you need.
 112 .TP
 113 .I WINEPREFIX
 114 If set, the content of this variable is taken as the name of the directory where
 115 .B wine
 116 stores its data (the default is
 117 .I $HOME/.wine
 118 ). This directory contains also the socket, which is used to communicate with the
 119 .I wineserver.
 120 All
 121 .B wine
 122 processes using the same
 123 .B wineserver
 124 (i.e.: same user) share certain things like registry, shared memory,
 125 and config file.
 126 By setting
 127 .I WINEPREFIX
 128 to different values for different
 129 .B wine
 130 processes, it is possible to run a number of truly independent
 131 .B wine
 132 processes.
 133 .TP
 134 .I WINESERVER
 135 Specifies the path and name of the
 136 .B wineserver
 137 binary. If not set, Wine will try to load
 138 .B @bindir@/wineserver,
 139 and if this doesn't exist it will then look for a file named
 140 "wineserver" in the path and in a few other likely locations.
 141 .TP
 142 .I WINELOADER
 143 Specifies the path and name of the
 144 .B wine
 145 binary to use to launch new Windows processes. If not set, Wine will
 146 try to load
 147 .B @bindir@/wine,
 148 and if this doesn't exist it will then look for a file named "wine" in
 149 the path and in a few other likely locations.
 150 .TP
 151 .I WINEDEBUG
 152 Turns debugging messages on or off. The syntax of the variable is
 153 of the form
 154 .RI [ class ][+/-] channel [,[ class2 ][+/-] channel2 ].
 155 .RS +7
 156 .PP
 157 .I class
 158 is optional and can be one of the following:
 159 .B err, warn, fixme,
 160 or
 161 .B trace.
 162 If
 163 .I class
 164 is not specified, all debugging messages for the specified
 165 channel are turned on.  Each channel will print messages about a particular
 166 component of
 167 .B wine.
 168 The following character can be either + or - to switch the specified
 169 channel on or off respectively.  If there is no
 170 .I class
 171 part before it, a leading + can be omitted. Note that spaces are not
 172 allowed anywhere in the string.
 173 .PP
 174 Examples:
 175 .TP
 176 WINEDEBUG=warn+all
 177 will turn on all warning messages (recommended for debugging).
 178 .br
 179 .TP
 180 WINEDEBUG=warn+dll,+heap
 181 will turn on DLL warning messages and all heap messages.
 182 .br
 183 .TP
 184 WINEDEBUG=fixme-all,warn+cursor,+relay
 185 will turn off all FIXME messages, turn on cursor warning messages, and turn
 186 on all relay messages (API calls).
 187 .br
 188 .TP
 189 WINEDEBUG=relay
 190 will turn on all relay messages. For more control on including or excluding
 191 functions and dlls from the relay trace look into the [Debug] section
 192 of the wine configuration file.
 193 .PP
 194 For more information on debugging messages, see the
 195 .I Running Wine
 196 chapter of the Wine User Guide.
 197 .RE
 198 .TP
 199 .I WINEDLLPATH
 200 Specifies the path(s) in which to search for builtin dlls and Winelib
 201 applications. This is a list of directories separated by ":". In
 202 addition to any directory specified in
 203 .I WINEDLLPATH,
 204 Wine will also look in
 205 .B @dlldir@.
 206 .TP
 207 .I WINEDLLOVERRIDES
 208 Defines the override type and load order of dlls used in the loading
 209 process for any dll. The default is set in the configuration
 210 file. There are currently two types of libraries that can be loaded
 211 into a process' address space: Native windows dlls (
 212 .I native
 213 ),
 214 .B wine
 215 internal dlls (
 216 .I builtin
 217 ). The type may be abbreviated with the first letter of the type (
 218 .I n, b
 219 ). Each sequence of orders must be separated by commas.
 220 .RS
 221 .PP
 222 Each dll may have its own specific load order. The load order
 223 determines which version of the dll is attempted to be loaded into the
 224 address space. If the first fails, then the next is tried and so
 225 on. Multiple libraries with the same load order can be separated with
 226 commas. It is also possible to use specify different loadorders for
 227 different libraries by separating the entries by ";".
 228 .PP
 229 The load order for a 16-bit dll is always defined by the load order of
 230 the 32-bit dll that contains it (which can be identified by looking at
 231 the symbolic link of the 16-bit .dll.so file). For instance if
 232 ole32.dll is configured as builtin, storage.dll will be loaded as
 233 builtin too, since the 32-bit ole32.dll contains the 16-bit
 234 storage.dll.
 235 .PP
 236 Examples:
 237 .TP
 238 WINEDLLOVERRIDES="comdlg32,shell32=n,b"
 239 .br
 240 Try to load comdlg32 and shell32 as native windows dll first and try
 241 the builtin version if the native load fails.
 242 .TP
 243 WINEDLLOVERRIDES="comdlg32,shell32=n;c:\(rs\(rsfoo\(rs\(rsbar\(rs\(rsbaz=b"
 244 .br
 245 Try to load the libraries comdlg32 and shell32 as native windows dlls. Furthermore, if
 246 an application request to load c:\(rsfoo\(rsbar\(rsbaz.dll load the builtin library baz.
 247 .TP
 248 WINEDLLOVERRIDES="comdlg32=b,n;shell32=b;comctl32=n"
 249 .br
 250 Try to load comdlg32 as builtin first and try the native version if
 251 the builtin load fails; load shell32 always as builtin and comctl32
 252 always as native.
 253 .RE
 254 .TP
 255 .I DISPLAY
 256 Specifies the X11 display to use.
 257 .SH CONFIGURATION FILE
 258 .B wine
 259 expects a configuration file (
 260 .I $WINEPREFIX/config
 261 or
 262 .I ~/.wine/config
 263 if WINEPREFIX is not set), which must conform to the format specified
 264 in the
 265 .BR wine.conf (5)
 266 man page. A sample configuration file is documentation/samples/config in the
 267 .B wine
 268 source archive.
 269 .SH AUTHORS
 270 .B wine
 271 is available thanks to the work of many developers. For a listing
 272 of the authors, please see the file
 273 .B AUTHORS
 274 in the top-level directory of the source distribution.
 275 .SH COPYRIGHT
 276 .B wine
 277 can be distributed under the terms of the LGPL license. A copy of the
 278 license is in the file
 279 .B LICENSE
 280 in the top-level directory of the source distribution.
 281 .SH BUGS
 282 .PP
 283 A status report on many applications is available from
 284 .I http://www.winehq.org/Apps.
 285 Please add entries to this list for applications you currently run.
 286 .PP
 287 Bug reports may be posted to Wine Bugzilla
 288 .I http://bugs.winehq.org
 289 If you want to post a bug report, please read the file
 290 .I documentation/bugs.sgml
 291 in the
 292 .B wine
 293 source to see what information is necessary
 294 .PP
 295 Problems and suggestions with this manpage please also report to
 296 .I http://bugs.winehq.org
 297 .SH AVAILABILITY
 298 The most recent public version of
 299 .B wine
 300 can be downloaded from
 301 .I http://www.winehq.org/download
 302 .PP
 303 The latest snapshot of the code may be obtained via CVS.  For information
 304 on how to do this, please see
 305 .I
 306 http://www.winehq.org/cvs
 307 .PP
 308 WineHQ, the
 309 .B wine
 310 development headquarters, is at
 311 .I http://www.winehq.org/.
 312 This website contains a great deal of information about
 313 .B wine.
 314 .PP
 315 The
 316 .B wine
 317 newsgroup is
 318 .I comp.emulators.ms-windows.wine.
 319 It is used for discussion of various
 320 .B wine
 321 end user aspects/help.
 322 .PP
 323 For further information about
 324 .B wine
 325 development, you might want to subscribe to the
 326 .B wine
 327 mailing lists at
 328 .I http://www.winehq.org/forums
 329 .SH FILES
 330 .PD 0
 331 .TP
 332 .I @bindir@/wine
 333 The
 334 .B wine
 335 program loader.
 336 .TP
 337 .I @bindir@/wineconsole
 338 The
 339 .B wine
 340 program loader for CUI (console) applications.
 341 .TP
 342 .I @bindir@/wineserver
 343 The
 344 .B wine
 345 server
 346 .TP
 347 .I @bindir@/winedbg
 348 The
 349 .B wine
 350 debugger
 351 .TP
 352 .I @bindir@/wineclipsrv
 353 The
 354 .B wine
 355 clipboard server
 356 .TP
 357 .I @dlldir@
 358 Directory containing
 359 .B wine's
 360 shared libraries
 361 .TP
 362 .I ~/.wine/config
 363 User-specific configuration file
 364 .TP
 365 .I ~/.wine
 366 Directory containing user specific data managed by
 367 .B wine.
 368
 369 .SH "SEE ALSO"
 370 .BR wine.conf (5)