Wine.man

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