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