README

   1 1. INTRODUCTION
   2
   3 Wine is a program that allows running MS-Windows programs under X11.
   4 It consists of a program loader, that loads and executes an
   5 MS-Windows binary, and of an emulation library that translates Windows
   6 API calls to their Unix/X11 equivalent.
   7
   8 Wine is free software. See the file LICENSE for the details.
   9 Basically, you can do anything with it, except claim that you wrote it.
  10
  11 Important note: current versions of Wine include a built-in debugger
  12 for 16-bit code, that is based on code from gdb. This means that if
  13 you redistribute a version of Wine that includes this debugger, you
  14 must follow the terms of the GNU General Public License.
  15
  16
  17 2. COMPILATION
  18
  19 You must have one of:
  20
  21         Linux version 0.99.13 or above
  22         NetBSD-current
  23         FreeBSD-current or FreeBSD 1.1
  24
  25 To build Wine, first do a "./Configure" and then a "make" (or "gmake"
  26 if you're running *BSD).  The executable "wine" will be built.  "wine"
  27 will load and run 16-bit Windows' executables.
  28
  29 To upgrade to a new release by using a patch file, first cd to the
  30 top-level directory of the release (the one containing this README
  31 file). Then do a "make clean", and patch the release with:
  32
  33     gunzip -c patch-file | patch -p1
  34
  35 where "patch-file" is the name of the patch file (something like
  36 Wine-yymmdd.diff.gz). You can then re-run "./Configure", and then
  37 run "make".
  38
  39
  40 3. SETUP
  41
  42 Wine requires you to have a file /usr/local/etc/wine.conf (you can
  43 supply a different name when configuring wine) or a file called .winerc
  44 in your home directory.
  45
  46 The format of this config file is just like a Windows .ini file.
  47 The file wine.ini contains a config file example.
  48
  49 Here's an explanation of each section:
  50
  51 * [drives]
  52
  53 format: <driveletter> = <rootdirectory>
  54 default: none
  55
  56 This section is used to specify the root directory of each `dos'drive
  57 as Windows' applications require a dos/mswindows based diskdrive &
  58 directory scheme.
  59
  60 If you mounted your dos-partition as /dos and installed Microsoft Windows
  61 in c:\windows than you should specify c=/dos in the drives section.
  62
  63 * [wine]
  64
  65 format: windows = <directory>
  66 default: c:\windows
  67
  68 Used to specify an different windows directory.
  69
  70 format: system = <directory>
  71 default: c:\windows\system
  72
  73 Used to specify an different system directory.
  74
  75 format: temp = <directory>
  76 default: c:\temp
  77
  78 Used to specify a directory where Windows applications can store temporary
  79 files.
  80
  81 format: path = <directories separated by semi-colons>
  82 default: c:\windows;c:\windows\system
  83
  84 Used to specify the path which will be used to find executables and DLL's.
  85
  86 format: systemresources = <filename>
  87 default: c:\temp
  88
  89 Used to specify the name of sysres.dll, a dll which is used by Wine itself.
  90
  91 * [serialports]
  92
  93 format: com[12345678] = <devicename>
  94 default: none
  95
  96 Used to specify the devices which are used as com1 - com8.
  97
  98 * [parallelports]
  99
 100 format: lpt[12345678] = <devicename>
 101 default: none
 102
 103 Used to specify the devices which are used as lpt1 - lpt8.
 104
 105 * [spy]
 106
 107 format: file = <filename or CON when logging to stdout>
 108 default: none
 109
 110 used to specify the file which will be used as logfile.
 111
 112 format: exclude = <message names separated by semicolons>
 113 default: none
 114
 115 Used to specify which messages will be excluded from the logfile.
 116
 117 format: include = <message names separated by semicolons>
 118 default: none
 119
 120 Used to specify which messages will be included in the logfile.
 121
 122
 123 4. RUNNING PROGRAMS
 124
 125 When invoking Wine, you must specify the entire path to the executable,
 126 or a filename only.
 127
 128 For example: to run Windows' solitaire:
 129
 130         wine sol                   (using the searchpath to locate the file)
 131         wine sol.exe
 132
 133         wine c:\\windows\\sol.exe  (using a dosfilename)
 134
 135         wine /usr/windows/sol.exe  (using a unixfilename)
 136
 137 Note: the path of the file will also be added to the path when
 138       a full name is supplied on the commandline.
 139
 140 Have a nice game of solitaire, but be careful.  Emulation isn't perfect.
 141 So, occasionally it may crash.
 142
 143
 144 5. GETTING MORE INFORMATION
 145
 146 The best place to get help or to report bugs is the Usenet newsgroup
 147 comp.emulators.ms-windows.wine. The Wine FAQ is posted there every
 148 month.
 149
 150 If you add something, or fix a bug, please send a patch to
 151 wine-new@amscons.com for inclusion in the next release.
 152
 153 --
 154 Alexandre Julliard
 155 julliard@lamisun.epfl.ch