git.oblomov.eu Git - wine/blob - documentation/wine.man

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