loader/wine.man.in

   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 ). 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"
 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.
 205 .RE
 206 .TP
 207 .I DISPLAY
 208 Specifies the X11 display to use.
 209 .SH FILES
 210 .TP
 211 .I @bindir@/wine
 212 The
 213 .B wine
 214 program loader.
 215 .TP
 216 .I @bindir@/wineconsole
 217 The
 218 .B wine
 219 program loader for CUI (console) applications.
 220 .TP
 221 .I @bindir@/wineserver
 222 The
 223 .B wine
 224 server
 225 .TP
 226 .I @bindir@/winedbg
 227 The
 228 .B wine
 229 debugger
 230 .TP
 231 .I @dlldir@
 232 Directory containing
 233 .B wine's
 234 shared libraries
 235 .TP
 236 .I $WINEPREFIX/dosdevices
 237 Directory containing the DOS device mappings. Each file in that
 238 directory is a symlink to the Unix device file implementing a given
 239 device. For instance, if COM1 is mapped to /dev/ttyS0 you'd have a
 240 symlink of the form $WINEPREFIX/dosdevices/com1 -> /dev/ttyS0.
 241 .br
 242 DOS drives are also specified with symlinks; for instance if drive D:
 243 corresponds to the CDROM mounted at /mnt/cdrom, you'd have a symlink
 244 $WINEPREFIX/dosdevices/d: -> /mnt/cdrom. The Unix device corresponding
 245 to a DOS drive can be specified the same way, except with '::' instead
 246 of ':'. So for the previous example, if the CDROM device is mounted
 247 from /dev/hdc, the corresponding symlink would be
 248 $WINEPREFIX/dosdevices/d:: -> /dev/hdc.
 249 .SH AUTHORS
 250 .B wine
 251 is available thanks to the work of many developers. For a listing
 252 of the authors, please see the file
 253 .B AUTHORS
 254 in the top-level directory of the source distribution.
 255 .SH COPYRIGHT
 256 .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.
 261 .SH BUGS
 262 .PP
 263 A status report on many applications is available from
 264 .I http://appdb.winehq.org.
 265 Please add entries to this list for applications you currently run.
 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 in the
 272 .B wine
 273 source to see what information is necessary
 274 .PP
 275 Problems and suggestions with this manpage please also report to
 276 .I http://bugs.winehq.org
 277 .SH AVAILABILITY
 278 The most recent public version of
 279 .B wine
 280 can be downloaded from
 281 .I http://www.winehq.org/download
 282 .PP
 283 The latest snapshot of the code may be obtained via GIT.  For information
 284 on how to do this, please see
 285 .I
 286 http://www.winehq.org/site/git
 287 .PP
 288 WineHQ, the
 289 .B wine
 290 development headquarters, is at
 291 .I http://www.winehq.org.
 292 This website contains a great deal of information about
 293 .B wine.
 294 .PP
 295 For further information about
 296 .B wine
 297 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)