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