wine.man

   1 .\" -*- nroff -*-
   2 .TH WINE 1 "September 1, 1995" "Version 9/1/95" "Windows Emulation"
   3 .SH NAME
   4 wine \- run Windows programs under Unix
   5 .SH SYNOPSIS
   6 .B wine
   7 [
   8 .I options
   9 ]
  10 .I program_name
  11 [
  12 .I arguments
  13 ]
  14 .SH DESCRIPTION
  15 .B wine
  16 invokes the Windows emulator.
  17 .PP
  18 .B wine
  19 currently runs a number of games and small applications (approximately
  20 half of the applets and common games actually run), although the entire API
  21 has not been implemented.
  22 .PP
  23 See the files
  24 .B README,
  25 .B ChangeLog,
  26 .B configure,
  27 and the
  28 .B Makefile
  29 contained in the source distribution
  30 to compile
  31 .B wine.
  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 and FreeBSD.
  37 .PP
  38 .B X
  39 must be installed.
  40 .PP
  41 .B libXpm
  42 must be installed.  (It is probably available from the same site
  43 .B wine
  44 was, or the sources may be FTP'd from ftp.x.org).
  45 .SH INSTALLATION
  46 To install
  47 .B Wine,
  48 run "./configure", which will detect your specific setup and create
  49 the Makefiles. You can run "./configure --help" to see the available
  50 configuration options. Then do "make depend; make" to build the
  51 .B wine
  52 executable, and then "make install" to install it. By default,
  53 .B wine
  54 is installed in /usr/local/bin; you can specify a different path with
  55 the --prefix option when running
  56 .B configure.
  57 .SH OPTIONS
  58 .TP
  59 .I -allowreadonly
  60 Read only files may be opened in write mode
  61 .TP
  62 .I -backingstore
  63 Turn on backing store
  64 .TP
  65 .I -debug
  66 Enter the debugger before starting application
  67 .TP
  68 .I -debugmsg name[,name]
  69 Turn debugging messages on or off - for instance,
  70 .I -debugmsg +dll,+heap
  71 will turn on DLL and heap debugging messages.  The full list is:
  72 all, accel, bitblt, bitmap, caret, catch, cdaudio, class, clipboard, clipping,
  73 combo, comm, cursor, dc, dialog, dll, dosfs, driver, edit, enum, event, exec,
  74 file, fixup, font, gdi, global, graphics, icon, int, key, keyboard, ldt,
  75 listbox, local, malloc, mci, mcianim, mciwave, mdi, menu, menucalc, message,
  76 metafile, midi, mmio, mmsys, mmtime, module, msg, nonclient, ole, palette,
  77 profile, prop, reg, region, relay, resource, scroll, selector, selectors,
  78 stress, syscolor, task, text, timer, toolhelp, utility, win, winsock.
  79 .TP
  80 .I -depth n
  81 Change the depth to use for multiple-depth screens
  82 .TP
  83 .I -desktop geom
  84 Use a desktop window of the given geometry
  85 .TP
  86 .I -display name
  87 Use the specified display
  88 .TP
  89 .I -dll name
  90 Enables/disables built-in DLL's - starting wine with
  91 .I -dll -commdlg
  92 is probably a good idea.
  93 The full list of DLLs modifiable by this is:
  94 KERNEL, USER, GDI, WIN87EM, SHELL, SOUND, KEYBOARD, WINSOCK, STRESS, MMSYSTEM,
  95 SYSTEM, TOOLHELP, MOUSE, COMMDLG, OLE2, OLE2CONV, OLE2DISP, OLE2NLS, OLE2PROX,
  96 OLECLI, OLESVR, COMPOBJ, STORAGE, WINPROCS, DDEML
  97 .TP
  98 .I -fixedmap
  99 Use a "standard" color map.
 100 .TP
 101 .I -iconic
 102 Start as an icon
 103 .TP
 104 .I -language xx
 105 Set the language to
 106 .I xx
 107 (one of En, Es, De, No, Fr, Fi, Da, Cz, Eo, It, Ko)
 108 .TP
 109 .I -managed
 110 Create each top-level window as a properly managed X window
 111 .TP
 112 .I -mode modename
 113 Determines the mode in which
 114 .B wine
 115 is started. Possible mode names are
 116 .I standard
 117 and
 118 .I enhanced.
 119 Enhanced mode is the default (when no -mode option is specified).
 120 .TP
 121 .I -name name
 122 Set the application name
 123 .TP
 124 .I -privatemap
 125 Use a private color map
 126 .TP
 127 .I -synchronous
 128 Turn on synchronous display mode
 129 .PD 1
 130 .SH PROGRAM/ARGUMENTS
 131 The program name may be specified in DOS format (C:\\WINDOWS\\SOL.EXE) or in
 132 Linux format (/msdos/windows/sol.exe).  The program being executed may be
 133 passed arguments by adding them on to the end of the command line invoking
 134 .B wine
 135 (such as: wine "notepad C:\\TEMP\\README.TXT").  Note that
 136 the program name and its arguments
 137 .I must
 138 be passed as a single parameter, which is usually accomplished by placing
 139 them together in quotation marks.  Multiple applications may be started
 140 by placing all of them on the command line (such as: wine notepad clock).
 141 .SH CONFIGURATION FILE
 142 .B wine
 143 expects a configuration file (/usr/local/etc/wine.conf), which should
 144 conform to the following rules (the format is just like a Windows .ini
 145 file).  The actual file name may be specified during the execution of
 146 the
 147 .B configure
 148 script.  Alternatively, you may have a
 149 .I .winerc
 150 file of this format in your home directory.
 151 .SH CONFIGURATION FILE FORMAT
 152 All entries are grouped in sections; a section begins with the line
 153 .br
 154 .I [section name]
 155 .br
 156 and continues until the next section starts. Individual entries
 157 consist of lines of the form
 158 .br
 159 .I entry=value
 160 .br
 161 The value can be any text string, optionally included in single or
 162 double quotes; it can also contain references to environment variables
 163 surrounded by
 164 .I ${}.
 165 Supported section names and entries are listed below.
 166 .PP
 167 .B [Drive X]
 168 .br
 169 This section is used to specify the root directory and type of each
 170 .B DOS
 171 drive, since most Windows applications require a DOS/MS-Windows based
 172 disk drive & directory scheme. There is one such section for every
 173 drive you want to configure.
 174 .PP
 175 .I format: Path = <rootdirectory>
 176 .br
 177 default: none
 178 .br
 179 If you mounted your dos partition as
 180 .I /dos
 181 and installed Microsoft Windows in
 182 C:\\WINDOWS then you should specify
 183 .I Path=/dos
 184 in the
 185 .I [Drive C]
 186 section.
 187 .PP
 188 .I format: Type = <type>
 189 .br
 190 default: hd
 191 .br
 192 Used to specify the drive type; supported types are floppy, hd, cdrom
 193 and network.
 194 .PP
 195 .I format: Label = <label>
 196 .br
 197 default: 'Drive X'
 198 .br
 199 Used to specify the drive label; limited to 11 characters.
 200 .PP
 201 .I format: Serial = <serial>
 202 .br
 203 default: 12345678
 204 .br
 205 Used to specify the drive serial number, as an 8-character hexadecimal
 206 number.
 207 .PP
 208 .I format: Filesystem = <fstype>
 209 .br
 210 default: unix
 211 .br
 212 Used to specify the type of the filesystem on which the drive resides;
 213 supported types are msdos (or fat), win95 (or vfat), unix. If the
 214 drive spans several different filesystems, say unix.
 215 .PP
 216 .B [wine]
 217 .br
 218 .I format: windows = <directory>
 219 .br
 220 default: C:\\WINDOWS
 221 .br
 222 Used to specify a different Windows directory
 223 .PP
 224 .I format: system = <directory>
 225 .br
 226 default: C:\\WINDOWS\\SYSTEM
 227 .br
 228 Used to specify a different system directory
 229 .PP
 230 .I format: temp = <directory>
 231 .br
 232 default: C:\\TEMP
 233 .br
 234 Used to specify a directory where Windows applications can store
 235 temporary files.
 236 .PP
 237 .I format: path = <directories separated by semi-colons>
 238 .br
 239 default: C:\\WINDOWS;C:\\WINDOWS\\SYSTEM
 240 .br
 241 Used to specify the path which will be used to find executables and .DLL's.
 242 .PP
 243 .I format: symboltablefile = <filename>
 244 .br
 245 default: wine.sym
 246 .br
 247 Used to specify the path and file name of the symbol table used by the built-in
 248 debugger.
 249 .PP
 250 .B [serialports]
 251 .br
 252 .I format: com[12345678] = <devicename>
 253 .br
 254 default: none
 255 .br
 256 Used to specify the devices which are used as com1 - com8.
 257 .PP
 258 .B [parallelports]
 259 .br
 260 .I format: lpt[12345678] = <devicename>
 261 .br
 262 default: none
 263 .br
 264 Used to specify the devices which are used as lpt1 - lpt8.
 265 .PP
 266 .B [spy]
 267 .br
 268 .I format: file = <filename or CON when logging to stdout>
 269 .br
 270 default: none
 271 .br
 272 Used to specify the file which will be used as
 273 .B logfile.
 274 .PP
 275 .I format: exclude = <message names separated by semicolons>
 276 .br
 277 default: none
 278 .br
 279 Used to specify which messages will be excluded from the logfile.
 280 .PP
 281 .I format: include = <message names separated by semicolons>
 282 .br
 283 default: none
 284 .br Used to specify which messages will be included in the logfile.
 285 .SH SAMPLE CONFIGURATION FILE
 286 [Drive A]
 287 .br
 288 Path=/mnt/fd0
 289 .br
 290 Type=floppy
 291 .PP
 292 [Drive C]
 293 .br
 294 Path=/dos
 295 .br
 296 Type=hd
 297 .br
 298 Label=DOS disk
 299 .PP
 300 [Drive D]
 301 .br
 302 Path=${HOME}/Wine
 303 .PP
 304 [wine]
 305 .br
 306 windows=c:\\windows
 307 .br
 308 system=c:\\windows\\system
 309 .br
 310 temp=c:\\temp
 311 .br
 312 path=c:\\windows;c:\\windows\\system;c:\\winapps\\word
 313 .br
 314 symboltablefile=/usr/local/lib/wine.sym
 315 .PP
 316 [serialports]
 317 .br
 318 com1=/dev/cua1
 319 .br
 320 com2=/dev/cua1
 321 .PP
 322 [parallelports]
 323 .br
 324 lpt1=/dev/lp0
 325 .PP
 326 [spy]
 327 .br
 328 ;File=CON
 329 .br
 330 ;File=spy.log
 331 .br
 332 Exclude=WM_TIMER;WM_SETCURSOR;WM_MOUSEMOVE;WM_NCHITTEST;
 333 .br
 334 Include=WM_COMMAND;
 335 .SH AUTHORS
 336 .B Wine
 337 is available thanks to the work of Bob Amstadt, Dag Asheim,
 338 Martin Ayotte, Ross Biro, Erik Bos, Fons Botman, John Brezak,
 339 Andrew Bulhak, John Burton, Paul Falstad, Olaf Flebbe, Peter Galbavy,
 340 Ramon Garcia, Hans de Graaf, Charles M. Hannum, Cameron Heide,
 341 Jochen Hoenicke, Jeffrey Hsu, Miguel de Icaza, Alexandre Julliard,
 342 Jon Konrath, Scott A. Laird, Martin von Loewis, Kenneth MacDonald,
 343 Peter MacDonald, William Magro, Marcus Meissner, Graham Menhennitt,
 344 David Metcalfe, Michael Patra, John Richardson, Johannes Ruscheinski,
 345 Thomas Sandford, Constantine Sapuntzakis, Daniel Schepler,
 346 Bernd Schmidt, Yngvi Sigurjonsson, Rick Sladkey, William Smith,
 347 Erik Svendsen, Goran Thyni, Jimmy Tirtawangsa, Jon Tombs,
 348 Linus Torvalds, Gregory Trubetskoy, Michael Veksler, Morten Welinder,
 349 Jan Willamowius, Carl Williams, Karl Guenter Wuensch, Eric Youngdale,
 350 and James Youngman.
 351 .PP
 352 This man page is maintained by Mike Phillips (msphil@facstaff.wm.edu), so
 353 please send all corrections, comments, flames, etc., to him.
 354 .SH BUGS
 355 There are too many to count, much less list.  Some bugs of note, however,
 356 are that programs requiring VBRUNxxx.DLL are unreliable (with reports of
 357 some working), OLE is not in place, the internal COMMDLG support is not yet
 358 at 100% (although rapidly improving).  Color support for other than 8bpp
 359 (256 colors) is currently flaky.
 360 .PP
 361 A partial list of applications known to work with
 362 .B wine
 363 include: sol, cruel, golf, clock, notepad, charmap, calc, and wzip11.
 364 The following URLs point to different success/testing lists:
 365 .br
 366 .I http://www.ifi.uio.no/~dash/wine/working-apps.html
 367 .br
 368 .I http://dutifp.twi.tudelft.nl:8000/wine/
 369 .PP
 370 We would like to hear about what software does run under
 371 .B Wine,
 372 and such reports may be posted to
 373 .I comp.emulators.ms-windows.wine.
 374 .SH AVAILABILITY
 375 The most recent public version of
 376 .B wine
 377 can be ftp'ed from tsx-11.mit.edu in the /pub/linux/ALPHA/Wine/development
 378 directory.  The releases are in the format 'Wine-yymmdd.tar.gz',
 379 or 'Wine-yymmdd.diff.gz' for the diff's from the previous release.
 380 .SH FILES
 381 .PD 0
 382 .TP
 383 .I /usr/local/bin/wine
 384 The invoker program.
 385 .TP
 386 .I /usr/local/etc/wine.conf
 387 Main configuration file for wine.
 388 .TP
 389 .I ChangeLog
 390 Changes in Wine, since the beginning (most recent changes first)
 391 .TP
 392 .I configure
 393 Shell script to automatically generate Makefiles.  Usually followed by
 394 make to compile wine.
 395 .TP
 396 .I Wine newsgroup
 397 Subscribe to comp.emulators.ms-windows.wine