wine.man

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