git.oblomov.eu Git - wine/blob - documentation/wine.man

   1 .\" -*- nroff -*-
   2 .TH WINE 1 "July 8, 1998" "Version 980628" "Windows Emulator"
   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 growing list of applications written for both Win3.1 and
  20 Win95.  Older, simpler applications work better than newer, more complex
  21 ones.  A large percentage of the API has been implemented, although there
  22 are still several major pieces of work left to do.
  23 .SH REQUIREMENTS
  24 At present,
  25 .B wine
  26 will run under any Linux kernel more recent than 0.99.13, or
  27 under recent releases of NetBSD/i386, FreeBSD and OpenBSD/i386.
  28 .PP
  29 The current support for multithreaded applications relies on the
  30 .B clone(2)
  31 system call, which is currently available only on Linux systems running
  32 libc6 (glibc2).
  33 .PP
  34 .B X
  35 must be installed.  To use Wine's support for multithreaded applications,
  36 your X libraries must be reetrant.  If you have libc6 (glibc2), or you
  37 compiled the libraries yourself, they were probably compiled with the
  38 reetrant option enabled.
  39 .PP
  40 .B libXpm
  41 must be installed.  If you're using Red Hat, the name of the package is
  42 XFree86-devel.  The sources may be FTP'd from ftp.Xfree86.org or its
  43 mirrors.
  44 .PP
  45 .B gcc
  46 2.7.x or later is required to build
  47 .B wine.
  48 Versions earlier than 2.7.2.3 may have problems when certain files are
  49 compiled with optimization.
  50 .SH INSTALLATION
  51 To install
  52 .B Wine,
  53 run "./configure" in the top-level directory of the source, which will
  54 detect your specific setup and create the Makefiles.  You can run
  55 "./configure --help" to see the available configuration options.  Then do
  56 "make depend; make" to build the
  57 .B wine
  58 executable, and then "make install" to install it. By default,
  59 .B wine
  60 is installed in /usr/local/bin; you can specify a different path with
  61 the --prefix option when running
  62 .B configure.
  63 .PP
  64 For more information, see the
  65 .B README
  66 file contained in the source distribution.
  67 .SH OPTIONS
  68 .TP
  69 .I -backingstore
  70 Turn on backing store
  71 .TP
  72 .I -debug
  73 Enter the debugger before starting application
  74 .TP
  75 .I -debugmsg [xxx]#name[,[xxx1]#name1]
  76 Turn debugging messages on or off.
  77 .RS +7
  78 .PP
  79 xxx is optional and can be one of the following:
  80 .I err,
  81 .I warn,
  82 .I fixme,
  83 or
  84 .I trace.
  85 If xxx is not specified, all debugging messages for the specified
  86 channel are turned on.  # is required and can be either + or -.  Note that
  87 there is not a space after the comma between names.
  88 .PP
  89 For instance:
  90 .PP
  91 .I -debugmsg warn+dll,+heap
  92 will turn on DLL warning messages and all heap messages.
  93 .br
  94 .I -debugmsg fixme-all,warn+cursor,+relay
  95 will turn off all FIXME messages, turn on cursor warning messages, and turn
  96 on all relay messages (API calls).
  97 .PP
  98 The full list of names is: all, accel, advapi, aspi, atom, bitblt, bitmap,
  99 caret, cd, cdaudio, class, clipboard, clipping, combo, comm, commctrl,
 100 commdlg, console, crtdll, cursor, dc, dde, ddeml, ddraw, debug, dialog,
 101 dinput, dll, dosfs, driver, dsound, edit, event, exec, file, fixup, font,
 102 gdi, global, graphics, header, heap, hook, icon, imagelist, int, int21,
 103 int31, key, keyboard, ldt, listbox, local, mci, mcianim, mciwave, mdi, menu,
 104 message, metafile, midi, mmaux, mmio, mmsys, mmtime, module, mpr, msg,
 105 nonclient, ntdll, ole, palette, print, process, profile, prop, reg, region,
 106 relay, resource, scroll, security, segment, selector, sem, sendmsg, shell,
 107 shm, snoop, sound, stress, string, syscolor, task, text, thread, thunk, timer,
 108 toolhelp, tweak, uitools, updown, ver, virtual, vxd, win, win16drv, win32,
 109 wing, winsock, wnet, x11, x11drv.
 110 .PP
 111 For more information on debugging messages, see the file
 112 .I documentation/debug-msgs
 113 in the source distribution.
 114 .RE
 115 .TP
 116 .I -depth n
 117 Change the depth to use for multiple-depth screens
 118 .TP
 119 .I -desktop geom
 120 Use a desktop window of the given geometry
 121 .TP
 122 .I -display name
 123 Use the specified display
 124 .TP
 125 .I -dll name
 126 Enables/disables built-in DLL's - starting wine with
 127 .I -dll -commdlg
 128 is probably a good idea.
 129 The full list of DLLs modifiable by this is:
 130 WIN87EM, SHELL, SOUND, KEYBOARD, WINSOCK, STRESS, MMSYSTEM, SYSTEM, TOOLHELP,
 131 MOUSE, COMMDLG, OLE2, OLE2CONV, OLE2DISP, OLE2NLS, OLE2PROX, OLECLI, OLESVR,
 132 COMPOBJ, STORAGE, WINPROCS, DDEML, ADVAPI32, COMCTL32, COMDLG32, CRTDLL,
 133 GDI32, LZ32, MPR, NTDLL, OLE32, SHELL32, USER32, VER, VERSION, W32SYS, WINMM,
 134 WINSPOOL, WSOCK32
 135 .TP
 136 .I -failreadonly
 137 Read only files may not be opened in write mode (the default is to
 138 allow opening read-only files for writing, because most Windows
 139 programs always request read-write access, even on CD-ROM drives...).
 140 .TP
 141 .I -fixedmap
 142 Use a "standard" color map.
 143 .TP
 144 .I -iconic
 145 Start as an icon
 146 .TP
 147 .I -language xx
 148 Set the language to
 149 .I xx
 150 (one of En, Es, De, No, Fr, Fi, Da, Cz, Eo, It, Ko, Hu, Pl, Po, Sw, Ca)
 151 .TP
 152 .I -managed
 153 Create each top-level window as a properly managed X window
 154 .TP
 155 .I -mode modename
 156 Determines the mode in which
 157 .B wine
 158 is started. Possible mode names are
 159 .I standard
 160 and
 161 .I enhanced.
 162 Enhanced mode is the default (when no -mode option is specified).
 163 .TP
 164 .I -name name
 165 Set the application name
 166 .TP
 167 .I -privatemap
 168 Use a private color map
 169 .TP
 170 .I -synchronous
 171 Turn on synchronous display mode
 172 .TP
 173 .I -winver version
 174 Specify which Windows version WINE should imitate.
 175 Possible arguments are: win31, win95, nt351, and nt40.
 176 .PD 1
 177 .SH PROGRAM/ARGUMENTS
 178 The program name may be specified in DOS format (C:\\WINDOWS\\SOL.EXE) or in
 179 Unix format (/msdos/windows/sol.exe).  The program being executed may be
 180 passed arguments by adding them on to the end of the command line invoking
 181 .B wine
 182 (such as: wine "notepad C:\\TEMP\\README.TXT").  Note that
 183 the program name and its arguments
 184 .I must
 185 be passed as a single parameter, which is usually accomplished by placing
 186 them together in quotation marks.  Multiple applications may be started
 187 by placing all of them on the command line (such as: wine notepad clock).
 188 .SH CONFIGURATION FILE
 189 .B wine
 190 expects a configuration file (/usr/local/etc/wine.conf), which should
 191 conform to the following rules (the format is just like a Windows .ini
 192 file).  The actual file name may be specified during the execution of
 193 the
 194 .B configure
 195 script.  Alternatively, you may have a
 196 .I .winerc
 197 file of this format in your home directory or have the environment variable
 198 .B WINE_INI
 199 pointing to a configuration file.
 200 .SH CONFIGURATION FILE FORMAT
 201 All entries are grouped in sections; a section begins with the line
 202 .br
 203 .I [section name]
 204 .br
 205 and continues until the next section starts. Individual entries
 206 consist of lines of the form
 207 .br
 208 .I entry=value
 209 .br
 210 The value can be any text string, optionally included in single or
 211 double quotes; it can also contain references to environment variables
 212 surrounded by
 213 .I ${}.
 214 Supported section names and entries are listed below.
 215 .PP
 216 .B [Drive X]
 217 .br
 218 This section is used to specify the root directory and type of each
 219 .B DOS
 220 drive, since most Windows applications require a DOS/MS-Windows based
 221 disk drive & directory scheme. There is one such section for every
 222 drive you want to configure.
 223 .PP
 224 .I format: Path = <rootdirectory>
 225 .br
 226 default: none
 227 .br
 228 If you mounted your dos partition as
 229 .I /dos
 230 and installed Microsoft Windows in
 231 C:\\WINDOWS then you should specify
 232 .I Path=/dos
 233 in the
 234 .I [Drive C]
 235 section.
 236 .PP
 237 .I format: Type = <type>
 238 .br
 239 default: hd
 240 .br
 241 Used to specify the drive type; supported types are floppy, hd, cdrom
 242 and network.
 243 .PP
 244 .I format: Label = <label>
 245 .br
 246 default: 'Drive X'
 247 .br
 248 Used to specify the drive label; limited to 11 characters.
 249 .PP
 250 .I format: Serial = <serial>
 251 .br
 252 default: 12345678
 253 .br
 254 Used to specify the drive serial number, as an 8-character hexadecimal
 255 number.
 256 .PP
 257 .I format: Filesystem = <fstype>
 258 .br
 259 default: unix
 260 .br
 261 Used to specify the type of the filesystem on which the drive resides;
 262 supported types are msdos (or fat), win95 (or vfat), unix. If the
 263 drive spans several different filesystems, say unix.
 264 .PP
 265 .B [wine]
 266 .br
 267 .I format: windows = <directory>
 268 .br
 269 default: C:\\WINDOWS
 270 .br
 271 Used to specify a different Windows directory
 272 .PP
 273 .I format: system = <directory>
 274 .br
 275 default: C:\\WINDOWS\\SYSTEM
 276 .br
 277 Used to specify a different system directory
 278 .PP
 279 .I format: temp = <directory>
 280 .br
 281 default: C:\\TEMP
 282 .br
 283 Used to specify a directory where Windows applications can store
 284 temporary files.
 285 .PP
 286 .I format: path = <directories separated by semi-colons>
 287 .br
 288 default: C:\\WINDOWS;C:\\WINDOWS\\SYSTEM
 289 .br
 290 Used to specify the path which will be used to find executables and .DLL's.
 291 .PP
 292 .I format: symboltablefile = <filename>
 293 .br
 294 default: wine.sym
 295 .br
 296 Used to specify the path and file name of the symbol table used by the built-in
 297 debugger.
 298 .PP
 299 .B [serialports]
 300 .br
 301 .I format: com[12345678] = <devicename>
 302 .br
 303 default: none
 304 .br
 305 Used to specify the devices which are used as com1 - com8.
 306 .PP
 307 .B [parallelports]
 308 .br
 309 .I format: lpt[12345678] = <devicename>
 310 .br
 311 default: none
 312 .br
 313 Used to specify the devices which are used as lpt1 - lpt8.
 314 .PP
 315 .B [spy]
 316 .br
 317 .I format: file = <filename or CON when logging to stdout>
 318 .br
 319 default: none
 320 .br
 321 Used to specify the file which will be used as
 322 .B logfile.
 323 .PP
 324 .I format: exclude = <message names separated by semicolons>
 325 .br
 326 default: none
 327 .br
 328 Used to specify which messages will be excluded from the logfile.
 329 .PP
 330 .I format: include = <message names separated by semicolons>
 331 .br
 332 default: none
 333 .br Used to specify which messages will be included in the logfile.
 334 .PP
 335 .B [Tweak.Layout]
 336 .br
 337 .I format: Win95Look=<true|false>
 338 .br
 339 default: false
 340 .br
 341 Use Win95-like window displays or Win3.1-like window displays.
 342 .SH SAMPLE CONFIGURATION FILE
 343 [Drive A]
 344 .br
 345 Path=/mnt/fd0
 346 .br
 347 Type=floppy
 348 .PP
 349 [Drive C]
 350 .br
 351 Path=/dos
 352 .br
 353 Type=hd
 354 .br
 355 Label=DOS disk
 356 .PP
 357 [Drive D]
 358 .br
 359 Path=${HOME}/Wine
 360 .PP
 361 [wine]
 362 .br
 363 windows=c:\\windows
 364 .br
 365 system=c:\\windows\\system
 366 .br
 367 temp=c:\\temp
 368 .br
 369 path=c:\\windows;c:\\windows\\system;c:\\winapps\\word
 370 .br
 371 symboltablefile=/usr/local/lib/wine.sym
 372 .PP
 373 [serialports]
 374 .br
 375 com1=/dev/cua1
 376 .br
 377 com2=/dev/cua1
 378 .PP
 379 [parallelports]
 380 .br
 381 lpt1=/dev/lp0
 382 .PP
 383 [spy]
 384 .br
 385 ;File=CON
 386 .br
 387 ;File=spy.log
 388 .br
 389 Exclude=WM_TIMER;WM_SETCURSOR;WM_MOUSEMOVE;WM_NCHITTEST;
 390 .br
 391 Include=WM_COMMAND;
 392 .PP
 393 [Tweak.Layout]
 394 .br
 395 Win95Look=true
 396 .SH AUTHORS
 397 .B Wine
 398 is available thanks to the work of many developers. For a listing
 399 of the authors, please see the file
 400 .B AUTHORS
 401 in the top-level directory of the source distribution.
 402 .SH BUGS
 403 There are too many to count, much less list.  Some bugs of note, however,
 404 are that programs requiring VBRUNxxx.DLL are unreliable (with reports of
 405 some working), OLE is not in place, the internal COMMDLG support is not yet
 406 at 100% (although rapidly improving).  Color support for other than 8bpp
 407 (256 colors) is currently flaky.
 408 .PP
 409 A status report on many appplications is available from
 410 .I http://www.winehq.com/apps.cgi.
 411 Users can add, modify, and delete entries on this list.
 412 .PP
 413 Bug reports and successes may be posted to
 414 .I comp.emulators.ms-windows.wine.
 415 .SH AVAILABILITY
 416 The most recent public version of
 417 .B wine
 418 can be ftp'ed from sunsite.unc.edu or tsx-11.mit.edu in the /pub/linux/ALPHA/Wine/development
 419 directory.  The releases are in the format 'Wine-yymmdd.tar.gz',
 420 or 'Wine-yymmdd.diff.gz' for the diff's from the previous release.
 421 .PP
 422 The
 423 .B wine
 424 homepage is at
 425 .I http://www.winehq.com.
 426 This website contains a great deal of information about
 427 .B wine
 428 as well as a collection of unofficial patches against the current release.
 429 .PP
 430 The
 431 .B wine
 432 newsgroup is
 433 .I comp.emulators.ms-windows.wine.
 434 All discussions about the project take place in this forum.
 435 .SH FILES
 436 .PD 0
 437 .TP
 438 .I /usr/local/bin/wine
 439 The invoker program.
 440 .TP
 441 .I /usr/local/etc/wine.conf
 442 Global configuration file for wine.
 443 .TP
 444 .I /usr/local/lib/wine.sym
 445 Global symbol table (used in debugger)
 446 .TP
 447 .I ~/.winerc
 448 User-specific configuration file
 449 .SH "SEE ALSO"
 450 clone(2)