documentation/wine.man.in

   1 .\" -*- nroff -*-
   2 .TH WINE 1 "July 16, 1999" "Version 20000326" "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 .I program
  15 loads and runs the given program, where the program is a DOS, Windows 3.x,
  16 or Win32 executable (x86 binaries only).
  17 .PP
  18 For debugging wine, use
  19 .B winedbg
  20 .I program
  21 instead.
  22 .PP
  23 .B wine
  24 currently runs a growing list of applications written for Win3.1,
  25 Win95, Win98, and Windows NT. Older, simpler applications work better than
  26 newer, more complex ones.  A large percentage of the API has been implemented,
  27 although there are still several major pieces of work left to do.
  28 .SH REQUIREMENTS
  29 .B wine
  30 requires kernel-level threads to run. Currently, only Linux version 2.0
  31 or later, FreeBSD-current or FreeBSD 3.0 or later, and Solaris x86
  32 version 2.5 or later are supported. Other operating systems which support
  33 kernel threads may be supported in the future.
  34 .PP
  35 Although Linux version 2.0 will mostly work, certain features (specifically
  36 LDT sharing) required for properly supporting Win32 threads were not
  37 implemented until kernel version 2.2. If you get consistent thread-related
  38 crashes, you may want to upgrade to 2.2. Also, some bugs were fixed and
  39 additional features were added late in the Linux 2.0.x series, so if you have
  40 a very old Linux kernel, you may want to upgrade to at least the latest 2.0.x
  41 release.
  42 .PP
  43 If you have FreeBSD, make sure you have the USER_LDT,
  44 SYSVSHM, SYSVSEM, and SYSVMSG options turned on in your kernel. If you
  45 are building
  46 .B wine
  47 on Solaris, you will most likely need to build wine with the GNU toolchain
  48 (gcc, gas, etc.)
  49 .PP
  50 .B X
  51 must be installed.  To use
  52 .B wine's
  53 support for multithreaded applications, your X libraries must be reentrant.
  54 If you have libc6 (glibc2), or you
  55 compiled the X libraries yourself, they were probably compiled with the
  56 reentrant option enabled.
  57 .PP
  58 .B libXpm
  59 must be installed.  If you're using Red Hat, make sure the following
  60 packages are installed: XFree86-devel, xpm, and xpm-devel. If you're
  61 using Debian, the packages you need are xpm4g and xpm4g-dev. If you
  62 have some other distribution, please send a list of packages required
  63 to the address listed in the
  64 .B
  65 BUGS
  66 section to get it included in this man page.
  67 .PP
  68 .B gcc
  69 2.7.2 or later is required to build
  70 .B wine.
  71 Versions earlier than 2.7.2.3 may have problems when certain files are
  72 compiled with optimization, often due to problems with header file
  73 management.
  74 .B
  75 pgcc
  76 currently doesn't work with
  77 .B wine.
  78 The cause of this problem is unknown.
  79 .PP
  80 .B flex
  81 version 2.5 or later and
  82 .B yacc
  83 are required.  Bison can be used in replace of yacc. If you have Redhat
  84 or Debian, make sure the bison and flex packages are installed.
  85 .SH INSTALLATION
  86 To install
  87 .B wine,
  88 run "./configure" in the top-level directory of the source, which will
  89 detect your specific setup and create the Makefiles.  You can run
  90 "./configure --help" to see the available configuration options.  Then do
  91 "make depend && make" to build the
  92 .B wine
  93 executable, and then "make install" to install it. By default,
  94 .B wine
  95 is installed in the /usr/local/ hierarchy (current configuration has it in
  96 the @prefix@ hierarchy); you can specify a different path with
  97 the --prefix or --sysconfdir options when running
  98 .B configure.
  99 .PP
 100 For more information, see the
 101 .I README
 102 file contained in the source distribution.
 103 .SH OPTIONS
 104 .TP
 105 .I --config filename
 106 Use the named configuration file rather than the default
 107 (@sysconfdir@/wine.conf or ~/.winerc).
 108 .TP
 109 .I --debugmsg [xxx]#name[,[xxx1]#name1][,<+|->relay=yyy1[:yyy2]]
 110 Turn debugging messages on or off.
 111 .RS +7
 112 .PP
 113 xxx is optional and can be one of the following:
 114 .I err,
 115 .I warn,
 116 .I fixme,
 117 or
 118 .I trace.
 119 If xxx is not specified, all debugging messages for the specified
 120 channel are turned on.  Each channel will print messages about a particular
 121 component of
 122 .B wine.
 123 # is required and can be either + or -.  Note that
 124 there is not a space after the comma between names. yyy are either the
 125 name of a whole DLL or a single API entry by Name you either
 126 want to include or exclude from the relay listing. These names must be in
 127 the case as names used in the relaylisting. You can do the same for snoop.
 128 .PP
 129 For instance:
 130 .PP
 131 .I --debugmsg warn+dll,+heap
 132 will turn on DLL warning messages and all heap messages.
 133 .br
 134 .I --debugmsg fixme-all,warn+cursor,+relay
 135 will turn off all FIXME messages, turn on cursor warning messages, and turn
 136 on all relay messages (API calls).
 137 .br
 138 .I --debugmsg -relay=LeaveCriticalSection:EnterCriticalSection
 139 will turn on all relay messages except for LeaveCriticalSection and
 140 EnterCriticalSection.
 141 .br
 142 .I --debugmsg +relay=ADVAPI32
 143 will only turn on relay messages into the ADVAPI32 code.
 144 .PP
 145 The full list of names is: all, accel, advapi, animate, aspi, atom, avifile, bitblt,
 146 bitmap, caret, cdrom, class, clipboard, clipping, combo, comboex, comm, commctrl,
 147 commdlg, console, crtdll, cursor, datetime, dc, ddeml, ddraw, debug, debugstr, delayhlp,
 148 dialog, dinput, dll, dosfs, dosmem, dplay, driver, dsound, edit, elfdll, enhmetafile,
 149 event, exec, file, fixup, font, gdi, global, graphics, header, heap, hook, hotkey,
 150 icmp, icon, imagehlp, imagelist, imm, int, int10, int16, int17, int19, int21, int31,
 151 io, ipaddress, joystick, key, keyboard, ldt, listbox, listview, local, mci, mcianim,
 152 mciavi, mcicda, mcimidi, mciwave, mdi, menu, message, metafile, midi, mmaux, mmio,
 153 mmsys, mmtime, module, monthcal, mpr, msacm, msg, msvideo, nativefont, nonclientntdll,
 154 odbc, ole, pager, palette, pidl, print, process, profile, progress, prop, propsheet,
 155 psapi, psdrv, ras, rebar, reg, region, relay, resource, scroll, segment, seh, selector,
 156 sendmsg, server, setupx, shell, snoop, sound, static, statusbar, storage, stress, string,
 157 syscolor, system, tab, tape, tapi, task, text, thread, thunk, timer, toolbar, toolhelp,
 158 tooltips, trackbar, treeview, ttydrv, tweak, typelib, updown, ver, virtual, vxd, wave,
 159 win, win16drv, win32, winedbg, wing, winsock, winspool, wnet, x11 and x11drv.
 160
 161 .PP
 162 For more information on debugging messages, see the file
 163 .I documentation/debug-msgs
 164 in the source distribution.
 165 .RE
 166 .TP
 167 .I --desktop geom
 168 Use a desktop window of the given geometry, e.g. "640x480"
 169 .TP
 170 .I --display name
 171 Use the specified X display
 172 .TP
 173 .I --dll name[,name[,...]]={native|elfdll|so|builtin}[,{n|e|s|b}[,...]][:...]
 174 Selects the override type and load order of dll used in the loading process
 175 for any dll. The default is set in @sysconfdir@/wine.conf or ~/.winerc. There
 176 are currently four types of libraries that can be loaded into a process' address
 177 space: Native windows dlls (
 178 .I native
 179 ), ELF encapsulated windows dlls (
 180 .I elfdll
 181 ), native ELF libraries (
 182 .I so
 183 )and
 184 .B wine
 185 internal dlls (
 186 .I builtin
 187 ). The type may be abbreviated with the first letter of the type (
 188 .I n, e, s, b
 189 ). Each sequence of orders must be separated by commas.
 190 .br
 191 Each dll may have its own specific load order. The load order determines
 192 which verion of the dll is attempted to be loaded into the address space. If
 193 the first fails, then the next is tried and so on. Different load orders can
 194 be specified by separating the entries with a colon. Multiple libraries
 195 with the same load order can be separated with commas.
 196 .br
 197 Examples:
 198 .br
 199 .I --dll comdlg32,commdlg=n,b
 200 .br
 201 Try to load comdlg32 and commdlg as native windows dll first and try
 202 the builtin version if the native load fails.
 203 .br
 204 .I --dll comdlg32,commdlg=e,n:shell,shell32=b:comctl32,commctrl=n
 205 .br
 206 Try to load comdlg32 and commdlg as elfdll first and try the native version
 207 if the elfdll load fails; load shell32/shell always as builtin and
 208 comctl32/commctrl always as native.
 209 .br
 210 Note: It is wise to keep dll pairs (comdlg32/commdlg, shell/shell32, etc.)
 211 having exactly the same load order. This will prevent mismatches at runtime.
 212 See also configuration file format below.
 213 .TP
 214 .I --dosver version
 215 Specify the DOS version
 216 .B wine
 217 should imitate (e.g. 6.22) This option
 218 is only valid when used in conjunction with --winver win31.
 219 .TP
 220 .I --language xx
 221 Set the language to
 222 .I xx
 223 (one of Br, Ca, Cs, Cy, Da, De, En, Eo, Es, Fi, Fr, Ga, Gd, Gv, Hr,
 224 Hu, It, Ko, Kw, No, Pl, Pt, Ru, Sk, Sv, Wa)
 225 .TP
 226 .I --managed
 227 Create each top-level window as a properly managed X window instead of
 228 creating our own "sticky" window.
 229 .TP
 230 .I --synchronous
 231 Turn on synchronous display mode. Useful for debugging X11 graphics problems.
 232 .TP
 233 .I --winver version
 234 Specify which Windows version
 235 .B wine
 236 should imitate.
 237 Possible arguments are: win31, win95, nt351, and nt40.
 238 .PD 1
 239 .SH PROGRAM/ARGUMENTS
 240 The program name may be specified in DOS format (
 241 .I
 242 C:\\WINDOWS\\SOL.EXE)
 243 or in Unix format (
 244 .I /msdos/windows/sol.exe
 245 ).  The program being executed may be passed arguments by adding them on
 246 to the end of the command line invoking
 247 .B wine
 248 (such as: wine notepad C:\\TEMP\\README.TXT). Command line processing goes as
 249 follows: first
 250 .B wine
 251 checks, if one or more of the above mentioned
 252 .B wine
 253 options have been specified. These
 254 are removed from the command line, which is passed to the windows program. You can use
 255 the Parameter
 256 .I --
 257 to indicate, that
 258 .B wine
 259 should stop command line processing. This is needed, if a windows program understands
 260 a option, which is usually interpreted (and thus removed from the command line)
 261 by
 262 .B wine.
 263 For example, if you want to execute
 264 .B wine
 265 with the options
 266 .I --managed --config myapp.winerc
 267 and if
 268 .B wine
 269 should run the program
 270 .I myapp.exe
 271 with the arguments
 272 .I --config my.ini somefile
 273 , then you could use the following command line to invoke
 274 .B wine:
 275 .PP
 276 .I wine --managed --config myapp.winerc -- myapp.exe --config my.ini somefile
 277 .PP
 278 Note that in contrast to previous versions of
 279 .B wine,
 280 you must not pass
 281 program name and program option in one argument to
 282 .B wine.
 283 To run more
 284 that one windows program, just execute
 285 .B wine
 286 once with the name
 287 of each program as argument.
 288 .SH ENVIRONMENT VARIABLES
 289 .B wine
 290 makes the environment variables of the shell from which
 291 .B wine
 292 is started accessible to the windows/dos processes started. So use the
 293 appropriate syntax for your shell to enter environment variables you need.
 294 .TP
 295 .I WINEPREFIX
 296 If set, the content of this variable is taken as the name of the directory, where
 297 .B wine
 298 stores its data (usually
 299 .I $HOME/.wine
 300 ). This directory contains also the socket, which is used to communicate with the
 301 .I wineserver.
 302 All
 303 .B wine
 304 processes, using the same
 305 .B wineserver
 306 share certain things like registry and shared memory. By setting
 307 .I WINEPREFIX
 308 to different values for different
 309 .B wine
 310 processes, it is possible to run a number of truly independent
 311 .B wine
 312 processes.
 313
 314 .SH CONFIGURATION FILE
 315 .B wine
 316 expects a configuration file (
 317 .I @sysconfdir@/wine.conf
 318 ), which must conform to the format specified in the
 319 .BR wine.conf (5)
 320 man page. A sample configuration file is wine.ini in the base directory of the
 321 .B wine
 322 source archive. Alternatively a configuration file with the name
 323 .I winerc
 324 in the home directory of the user running
 325 .B wine
 326 can be used. The third option is to specify the name of the
 327 configuration file with the
 328 .B --config
 329 option.
 330 .SH AUTHORS
 331 .B wine
 332 is available thanks to the work of many developers. For a listing
 333 of the authors, please see the file
 334 .B AUTHORS
 335 in the top-level directory of the source distribution.
 336 .SH BUGS
 337 .PP
 338 A status report on many appplications is available from
 339 .I http://www.winehq.com/Apps.
 340 Please add entries to this list for applications you currently run.
 341 .PP
 342 Bug reports and successes may be posted to
 343 .I comp.emulators.ms-windows.wine.
 344 If you want to post a bug report, please read the file
 345 .I documentation/bugreports
 346 in the
 347 .B wine
 348 source to see what information is necessary.
 349 .PP
 350 For problems and suggestions with this manpage, please send a note to
 351 James Juran <jrj120@psu.edu>.
 352 .SH AVAILABILITY
 353 The most recent public version of
 354 .B wine
 355 can be obtained via FTP from metalab.unc.edu or tsx-11.mit.edu in the
 356 /pub/linux/ALPHA/Wine/development directory.  The releases are in the
 357 format 'Wine-yyyymmdd.tar.gz', or 'Wine-yyyymmdd.diff.gz' for the diff's
 358 from the previous release.
 359 .PP
 360 The latest snapshot of the code may be obtained via CVS.  For information
 361 on how to do this, please see
 362 .I
 363 http://www.winehq.com/dev.html
 364 .PP
 365 WineHQ, the
 366 .B wine
 367 development headquarters, is at
 368 .I http://www.winehq.com/.
 369 This website contains a great deal of information about
 370 .B wine.
 371 .PP
 372 The
 373 .B wine
 374 newsgroup is
 375 .I comp.emulators.ms-windows.wine.
 376 It is used for discussion of various
 377 .B wine end user aspects/help.
 378 .PP
 379 For further information about
 380 .B wine development, you might want to
 381 subscribe to the
 382 .B wine
 383 "cvs", "devel" and "patches" mailing lists at
 384 .I http://www.winehq.com/dev.html#ml.
 385 .SH FILES
 386 .PD 0
 387 .TP
 388 .I @prefix@/bin/wine
 389 The
 390 .B wine
 391 program loader.
 392 .TP
 393 .I @prefix@/bin/dosmod
 394 The DOS program loader.
 395 .TP
 396 .I @prefix@/bin/wineserver
 397 The
 398 .B wine
 399 server
 400 .TP
 401 .I @prefix@/bin/wineclpsrv
 402 The
 403 .B wine
 404 clipboard server
 405 .TP
 406 .I @prefix@/lib/
 407 Directory containing
 408 .B wines's
 409 shared libraries
 410 .TP
 411 .I @sysconfdir@/wine.conf
 412 Global configuration file for
 413 .B wine.
 414 .TP
 415 .I ~/.winerc
 416 User-specific configuration file
 417 .TP
 418 .I ~/.wine
 419 Directory containing user specific data managed by
 420 .B wine.
 421 .TP
 422 .I @prefix@/lib/wine.sym
 423 Global symbol table (used in debugger)
 424 .SH "SEE ALSO"
 425 .BR wine.conf (5),
 426 .BR clone (2)
 427