documentation/wine.man

   1 .\" -*- nroff -*-
   2 .TH WINE 1 "October 20, 1998" "Version 981018" "Windows Emulator"
   3 .SH NAME
   4 wine \- run Windows programs under Unix
   5 .SH SYNOPSIS
   6 .B wine
   7 [
   8 .I wine_options
   9 ] "
  10 .I program_name
  11 [
  12 .I program_args
  13 ] "
  14 [ "
  15 .I program_name
  16 [
  17 .I program_args
  18 ]"
  19 .I ...
  20 ]
  21 .SH DESCRIPTION
  22 .B wine
  23 invokes the Windows emulator.
  24 .PP
  25 .B wine
  26 currently runs a growing list of applications written for both Win3.1 and
  27 Win95.  Older, simpler applications work better than newer, more complex
  28 ones.  A large percentage of the API has been implemented, although there
  29 are still several major pieces of work left to do.
  30 .SH REQUIREMENTS
  31 At present,
  32 .B wine
  33 will run under any Linux kernel more recent than 0.99.13, or
  34 under recent releases of NetBSD/i386, FreeBSD and OpenBSD/i386.
  35 .PP
  36 The current support for multithreaded applications relies on the
  37 .B clone(2)
  38 system call, which is currently available only on Linux systems running
  39 libc6 (glibc2).
  40 .PP
  41 .B X
  42 must be installed.  To use Wine's support for multithreaded applications,
  43 your X libraries must be reetrant.  If you have libc6 (glibc2), or you
  44 compiled the libraries yourself, they were probably compiled with the
  45 reetrant option enabled.
  46 .PP
  47 .B libXpm
  48 must be installed.  If you're using Red Hat, the name of the package is
  49 XFree86-devel.  The sources may be obtained via FTP from ftp.Xfree86.org
  50 or its mirrors.
  51 .PP
  52 .B gcc
  53 2.7.x or later is required to build
  54 .B wine.
  55 Versions earlier than 2.7.2.3 may have problems when certain files are
  56 compiled with optimization.
  57 .SH INSTALLATION
  58 To install
  59 .B Wine,
  60 run "./configure" in the top-level directory of the source, which will
  61 detect your specific setup and create the Makefiles.  You can run
  62 "./configure --help" to see the available configuration options.  Then do
  63 "make depend; make" to build the
  64 .B wine
  65 executable, and then "make install" to install it. By default,
  66 .B wine
  67 is installed in /usr/local/bin; you can specify a different path with
  68 the --prefix option when running
  69 .B configure.
  70 .PP
  71 For more information, see the
  72 .B README
  73 file contained in the source distribution.
  74 .SH OPTIONS
  75 .TP
  76 .I -backingstore
  77 Turn on backing store
  78 .TP
  79 .I -config filename
  80 Use the named configuration file rather than the default
  81 (/usr/local/etc/wine.conf or ~/.winerc).
  82 .TP
  83 .I -debug
  84 Enter the debugger before starting application
  85 .TP
  86 .I -debugmsg [xxx]#name[,[xxx1]#name1]
  87 Turn debugging messages on or off.
  88 .RS +7
  89 .PP
  90 xxx is optional and can be one of the following:
  91 .I err,
  92 .I warn,
  93 .I fixme,
  94 or
  95 .I trace.
  96 If xxx is not specified, all debugging messages for the specified
  97 channel are turned on.  Each channel will print messages about a particular
  98 component of Wine.  # is required and can be either + or -.  Note that
  99 there is not a space after the comma between names.
 100 .PP
 101 For instance:
 102 .PP
 103 .I -debugmsg warn+dll,+heap
 104 will turn on DLL warning messages and all heap messages.
 105 .br
 106 .I -debugmsg fixme-all,warn+cursor,+relay
 107 will turn off all FIXME messages, turn on cursor warning messages, and turn
 108 on all relay messages (API calls).
 109 .PP
 110 The full list of names is: all, accel, advapi, animate, aspi, atom,
 111 bitblt, bitmap, caret, cd, cdaudio, class, clipboard, clipping, combo,
 112 comboex, comm, commctrl, commdlg, console, crtdll, cursor, dc, dde, ddeml,
 113 ddraw, debug, dialog, dinput, dll, dosfs, dosmem, dplay, driver, dsound,
 114 edit, event, exec, file, fixup, font, gdi, global, graphics, header, heap,
 115 hook, hotkey, icon, imagehlp, imagelist, imm, int, int10, int16, int21,
 116 int31, ipaddress, key, keyboard, ldt, listbox, local, mci, mcianim, mciwave, mdi, menu, message, metafile, midi, mmaux, mmio, mmsys, mmtime, module, mpr,
 117 msg, nativefont, nonclient, ntdll, ole, pager, palette, pidl, print, process,
 118 profile, progress, prop, psapi, psdrv, rebar, reg, region, relay, resource,
 119 s, scroll, security, segment, selector, sem, sendmsg, shell, shm, snoop,
 120 sound, static, statusbar, stress, string, syscolor, system, tab, task, text,
 121 thread, thunk, timer, toolbar, toolhelp, tooltips, trackbar, treeview, tweak,
 122 uitools, updown, ver, virtual, vxd, win, win16drv, win32, wing, winsock,
 123 wnet, x11, x11drv.
 124 .PP
 125 For more information on debugging messages, see the file
 126 .I documentation/debug-msgs
 127 in the source distribution.
 128 .RE
 129 .TP
 130 .I -depth n
 131 Change the depth to use for multiple-depth screens
 132 .TP
 133 .I -desktop geom
 134 Use a desktop window of the given geometry
 135 .TP
 136 .I -display name
 137 Use the specified display
 138 .TP
 139 .I -dll name
 140 Enables/disables built-in DLL's - starting wine with
 141 .I -dll -commdlg
 142 is probably a good idea.
 143 The full list of DLLs modifiable by this is:
 144 ADVAPI32, AVIFILE, COMCTL32, COMDLG32, COMM, COMMDLG, COMPOBJ, CRTDLL,
 145 DCIMAN32, DDEML, DDRAW, DINPUT, DISPLAY, DPLAY, DPLAYX, DSOUND, GDI, GDI32,
 146 IMAGEHLP, IMM32, KEYBOARD, LZ32, LZEXPAND, MMSYSTEM, MOUSE, MPR, MSACM,
 147 MSACM32, MSNET32, MSVFW32, MSVIDEO, OLE2, OLE32, OLE2CONV, OLE2DISP, OLE2NLS,
 148 OLE2PROX, OLE2THK, OLEAUT32, OLECLI, OLECLI32, OLEDLG, OLESVR, OLESVR32,
 149 PSAPI, RASAPI16, RASAPI32, SHELL, SHELL32, SOUND, STORAGE, STRESS, SYSTEM,
 150 TAPI32, TOOLHELP, TYPELIB, USER, USER32, VER, VERSION, W32SKRNL, W32SYS,
 151 WIN32S16, WIN87EM, WINASPI, WINDEBUG, WINEPS, WINMM, WING, WINSOCK, WINSPOOL,
 152 WNASPI32, WOW32, WPROCS, WSOCK32
 153 .TP
 154 .I -failreadonly
 155 Read only files may not be opened in write mode (the default is to
 156 allow opening read-only files for writing, because most Windows
 157 programs always request read-write access, even on CD-ROM drives...).
 158 .TP
 159 .I -fixedmap
 160 Use a "standard" color map.
 161 .TP
 162 .I -iconic
 163 Start as an icon
 164 .TP
 165 .I -language xx
 166 Set the language to
 167 .I xx
 168 (one of En, Es, De, No, Fr, Fi, Da, Cz, Eo, It, Ko, Hu, Pl, Po, Sw, Ca)
 169 .TP
 170 .I -managed
 171 Create each top-level window as a properly managed X window
 172 .TP
 173 .I -mode modename
 174 Determines the mode in which
 175 .B wine
 176 is started. Possible mode names are
 177 .I standard
 178 and
 179 .I enhanced.
 180 Enhanced mode is the default (when no -mode option is specified).
 181 .TP
 182 .I -name name
 183 Set the application name
 184 .TP
 185 .I -privatemap
 186 Use a private color map
 187 .TP
 188 .I -synchronous
 189 Turn on synchronous display mode
 190 .TP
 191 .I -winver version
 192 Specify which Windows version WINE should imitate.
 193 Possible arguments are: win31, win95, nt351, and nt40.
 194 .PD 1
 195 .SH PROGRAM/ARGUMENTS
 196 The program name may be specified in DOS format (C:\\WINDOWS\\SOL.EXE) or in
 197 Unix format (/msdos/windows/sol.exe).  The program being executed may be
 198 passed arguments by adding them on to the end of the command line invoking
 199 .B wine
 200 (such as: wine "notepad C:\\TEMP\\README.TXT").  Note that
 201 the program name and its arguments
 202 .I must
 203 be passed as a single parameter, which is usually accomplished by placing
 204 them together in quotation marks.  Multiple applications may be started
 205 by placing all of them on the command line (such as: wine notepad clock).
 206 .SH CONFIGURATION FILE
 207 .B wine
 208 expects a configuration file (/usr/local/etc/wine.conf), which should
 209 conform to the following rules (the format is just like a Windows .ini
 210 file).  The actual file name may be specified during the execution of
 211 the
 212 .B configure
 213 script.  Alternatively, you may have a
 214 .I .winerc
 215 file of this format in your home directory or have the environment variable
 216 .B WINE_INI
 217 pointing to a configuration file, or use the -config option on the command
 218 line.
 219 .SH CONFIGURATION FILE FORMAT
 220 All entries are grouped in sections; a section begins with the line
 221 .br
 222 .I [section name]
 223 .br
 224 and continues until the next section starts. Individual entries
 225 consist of lines of the form
 226 .br
 227 .I entry=value
 228 .br
 229 The value can be any text string, optionally included in single or
 230 double quotes; it can also contain references to environment variables
 231 surrounded by
 232 .I ${}.
 233 Supported section names and entries are listed below.
 234 .PP
 235 .B [Drive X]
 236 .br
 237 This section is used to specify the root directory and type of each
 238 .B DOS
 239 drive, since most Windows applications require a DOS/MS-Windows based
 240 disk drive & directory scheme. There is one such section for every
 241 drive you want to configure.
 242 .PP
 243 .I format: Path = <rootdirectory>
 244 .br
 245 default: none
 246 .br
 247 If you mounted your dos partition as
 248 .I /dos
 249 and installed Microsoft Windows in
 250 C:\\WINDOWS then you should specify
 251 .I Path=/dos
 252 in the
 253 .I [Drive C]
 254 section.
 255 .PP
 256 .I format: Type = <type>
 257 .br
 258 default: hd
 259 .br
 260 Used to specify the drive type; supported types are floppy, hd, cdrom
 261 and network.
 262 .PP
 263 .I format: Label = <label>
 264 .br
 265 default: 'Drive X'
 266 .br
 267 Used to specify the drive label; limited to 11 characters.
 268 .PP
 269 .I format: Serial = <serial>
 270 .br
 271 default: 12345678
 272 .br
 273 Used to specify the drive serial number, as an 8-character hexadecimal
 274 number.
 275 .PP
 276 .I format: Filesystem = <fstype>
 277 .br
 278 default: unix
 279 .br
 280 Used to specify the type of the filesystem on which the drive resides;
 281 supported types are msdos (or fat), win95 (or vfat), unix. If the
 282 drive spans several different filesystems, say unix.
 283 .PP
 284 .B [wine]
 285 .br
 286 .I format: windows = <directory>
 287 .br
 288 default: C:\\WINDOWS
 289 .br
 290 Used to specify a different Windows directory
 291 .PP
 292 .I format: system = <directory>
 293 .br
 294 default: C:\\WINDOWS\\SYSTEM
 295 .br
 296 Used to specify a different system directory
 297 .PP
 298 .I format: temp = <directory>
 299 .br
 300 default: C:\\TEMP
 301 .br
 302 Used to specify a directory where Windows applications can store
 303 temporary files.
 304 .PP
 305 .I format: path = <directories separated by semi-colons>
 306 .br
 307 default: C:\\WINDOWS;C:\\WINDOWS\\SYSTEM
 308 .br
 309 Used to specify the path which will be used to find executables and .DLL's.
 310 .PP
 311 .I format: symboltablefile = <filename>
 312 .br
 313 default: wine.sym
 314 .br
 315 Used to specify the path and file name of the symbol table used by the built-in
 316 debugger.
 317 .PP
 318 .B [serialports]
 319 .br
 320 .I format: com[12345678] = <devicename>
 321 .br
 322 default: none
 323 .br
 324 Used to specify the devices which are used as com1 - com8.
 325 .PP
 326 .B [parallelports]
 327 .br
 328 .I format: lpt[12345678] = <devicename>
 329 .br
 330 default: none
 331 .br
 332 Used to specify the devices which are used as lpt1 - lpt8.
 333 .PP
 334 .B [spy]
 335 .br
 336 .I format: file = <filename or CON when logging to stdout>
 337 .br
 338 default: none
 339 .br
 340 Used to specify the file which will be used as
 341 .B logfile.
 342 .PP
 343 .I format: exclude = <message names separated by semicolons>
 344 .br
 345 default: none
 346 .br
 347 Used to specify which messages will be excluded from the logfile.
 348 .PP
 349 .I format: include = <message names separated by semicolons>
 350 .br
 351 default: none
 352 .br Used to specify which messages will be included in the logfile.
 353 .PP
 354 .B [Tweak.Layout]
 355 .br
 356 .I format: WineLook=<Win31|Win95|Win98>
 357 .br
 358 default: Win31
 359 .br
 360 Use Win95-like window displays or Win3.1-like window displays.
 361 .SH SAMPLE CONFIGURATION FILE
 362 [Drive A]
 363 .br
 364 Path=/mnt/fd0
 365 .br
 366 Type=floppy
 367 .PP
 368 [Drive C]
 369 .br
 370 Path=/dos
 371 .br
 372 Type=hd
 373 .br
 374 Label=DOS disk
 375 .PP
 376 [Drive D]
 377 .br
 378 Path=${HOME}/Wine
 379 .PP
 380 [wine]
 381 .br
 382 windows=c:\\windows
 383 .br
 384 system=c:\\windows\\system
 385 .br
 386 temp=c:\\temp
 387 .br
 388 path=c:\\windows;c:\\windows\\system;c:\\winapps\\word
 389 .br
 390 symboltablefile=/usr/local/lib/wine.sym
 391 .PP
 392 [serialports]
 393 .br
 394 com1=/dev/cua1
 395 .br
 396 com2=/dev/cua1
 397 .PP
 398 [parallelports]
 399 .br
 400 lpt1=/dev/lp0
 401 .PP
 402 [spy]
 403 .br
 404 ;File=CON
 405 .br
 406 ;File=spy.log
 407 .br
 408 Exclude=WM_TIMER;WM_SETCURSOR;WM_MOUSEMOVE;WM_NCHITTEST;
 409 .br
 410 Include=WM_COMMAND;
 411 .PP
 412 [Tweak.Layout]
 413 .br
 414 WineLook=Win95
 415 .SH AUTHORS
 416 .B Wine
 417 is available thanks to the work of many developers. For a listing
 418 of the authors, please see the file
 419 .B AUTHORS
 420 in the top-level directory of the source distribution.
 421 .SH BUGS
 422 There are too many to count, much less list.  Some bugs of note, however,
 423 are that programs requiring VBRUNxxx.DLL are unreliable (with reports of
 424 some working), OLE is not in place, the internal COMMDLG support is not yet
 425 at 100% (although rapidly improving).  Color support for other than 8bpp
 426 (256 colors) is currently flaky.
 427 .PP
 428 A status report on many appplications is available from
 429 .I http://www.winehq.com/apps.cgi.
 430 Users can add, modify, and delete entries on this list.
 431 .PP
 432 Bug reports and successes may be posted to
 433 .I comp.emulators.ms-windows.wine.
 434 .SH AVAILABILITY
 435 The most recent public version of
 436 .B wine
 437 can be obtained via FTP from sunsite.unc.edu or tsx-11.mit.edu in the /pub/linux/ALPHA/Wine/development
 438 directory.  The releases are in the format 'Wine-yymmdd.tar.gz',
 439 or 'Wine-yymmdd.diff.gz' for the diff's from the previous release.
 440 .PP
 441 The latest snapshot of the code may be obtained via CVS.  For information
 442 on how to do this, please see
 443 .I
 444 http://www.winehq.com/cvs.html
 445 .PP
 446 The
 447 .B wine
 448 homepage is at
 449 .I http://www.winehq.com.
 450 This website contains a great deal of information about
 451 .B wine
 452 as well as a collection of unofficial patches against the current release.
 453 .PP
 454 The
 455 .B wine
 456 newsgroup is
 457 .I comp.emulators.ms-windows.wine.
 458 All discussions about the project take place in this forum.
 459 .SH FILES
 460 .PD 0
 461 .TP
 462 .I /usr/local/bin/wine
 463 The invoker program.
 464 .TP
 465 .I /usr/local/etc/wine.conf
 466 Global configuration file for wine.
 467 .TP
 468 .I /usr/local/lib/wine.sym
 469 Global symbol table (used in debugger)
 470 .TP
 471 .I ~/.winerc
 472 User-specific configuration file
 473 .SH "SEE ALSO"
 474 clone(2)