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