Fixed _copy_registry().
[wine] / documentation / wine.man.in
1 .\" -*- nroff -*-
2 .TH WINE 1 "July 16, 1999" "Version 990704" "Windows On Unix"
3 .SH NAME
4 wine \- run Windows programs on Unix
5 .SH SYNOPSIS
6 .BI "wine " "[wine_options] " "program1 " "[program2 ... ]"
7 .PP
8 For instructions on passing arguments to Windows programs, please see the 
9 .B
10 PROGRAM/ARGUMENTS
11 section of the man page.
12 .SH DESCRIPTION
13 .B wine
14 .I program
15 loads and runs the given program, where the program is a DOS, Windows 3.x,
16 or Win32 executable (x86 binaries only).
17 .PP
18 .B wine 
19 currently runs a growing list of applications written for Win3.1,
20 Win95, Win95, and Windows NT. Older, simpler applications work better than
21 newer, more complex ones.  A large percentage of the API has been implemented,
22 although there are still several major pieces of work left to do.
23 .SH REQUIREMENTS
24 .B wine
25 requires kernel-level threads to run. Currently, only Linux version 2.0
26 or later, FreeBSD-current or FreeBSD 3.0 or later, and Solaris x86
27 version 2.5 or later are supported. Other operating systems which support
28 kernel threads may be supported in the future.
29 .PP
30 Although Linux version 2.0 will mostly work, certain features (specifically
31 LDT sharing) required for properly supporting Win32 threads were not
32 implemented until kernel version 2.2. If you get consistent thread-related
33 crashes, you may want to upgrade to 2.2. Also, some bugs were fixed and
34 additional features were added late in the Linux 2.0.x series, so if you have
35 a very old Linux kernel, you may want to upgrade to at least the latest 2.0.x
36 release.
37 .PP
38 If you have FreeBSD, make sure you have the USER_LDT,
39 SYSVSHM, SYSVSEM, and SYSVMSG options turned on in your kernel. If you
40 are building Wine on Solaris, you will most likely need to build Wine
41 with the GNU toolchain (gcc, gas, etc.)
42 .PP
43 .B X
44 must be installed.  To use Wine's support for multithreaded applications,
45 your X libraries must be reentrant.  If you have libc6 (glibc2), or you 
46 compiled the X libraries yourself, they were probably compiled with the 
47 reentrant option enabled.  
48 .PP
49 .B libXpm
50 must be installed.  If you're using Red Hat, make sure the following
51 packages are installed: XFree86-devel, xpm, and xpm-devel. If you're
52 using Debian, the packages you need are xpm4g and xpm4g-dev. If you 
53 have some other distribution, please send a list of packages required
54 to the address listed in the 
55 .B
56 BUGS
57 section to get it included in this man page.
58 .PP
59 .B gcc
60 2.7.2 or later is required to build
61 .B wine.
62 Versions earlier than 2.7.2.3 may have problems when certain files are
63 compiled with optimization, often due to problems with header file
64 management.
65 .B
66 pgcc
67 currently doesn't work with wine.  The cause of this problem is unknown. 
68 .PP
69 .B flex
70 version 2.5 or later and 
71 .B yacc
72 are required.  Bison can be used in replace of yacc. If you have Redhat,
73 make sure the bison and flex packages are installed.
74 .SH INSTALLATION
75 To install 
76 .B Wine,
77 run "./configure" in the top-level directory of the source, which will 
78 detect your specific setup and create the Makefiles.  You can run 
79 "./configure --help" to see the available configuration options.  Then do 
80 "make depend && make" to build the
81 .B wine
82 executable, and then "make install" to install it. By default,
83 .B wine
84 is installed in the /usr/local/ hierarchy (current configuration has it in
85 the @prefix@ hierarchy); you can specify a different path with
86 the --prefix or --sysconfdir options when running
87 .B configure.
88 .PP
89 For more information, see the 
90 .I README
91 file contained in the source distribution.
92 .SH OPTIONS
93 .TP
94 .I -backingstore
95 Turn on backing store
96 .TP
97 .I -config filename
98 Use the named configuration file rather than the default
99 (@sysconfdir@/wine.conf or ~/.winerc).
100 .TP
101 .I -debug
102 Enter the debugger before starting application
103 .TP
104 .I -debugmsg [xxx]#name[,[xxx1]#name1][,<+|->relay=yyy1[:yyy2]]
105 Turn debugging messages on or off.  
106 .RS +7
107 .PP
108 xxx is optional and can be one of the following: 
109 .I err, 
110 .I warn, 
111 .I fixme, 
112 or 
113 .I trace. 
114 If xxx is not specified, all debugging messages for the specified
115 channel are turned on.  Each channel will print messages about a particular
116 component of Wine.  # is required and can be either + or -.  Note that 
117 there is not a space after the comma between names. yyy are either the
118 name of a whole DLL or a single API entry by Name you either
119 want to include or exclude from the relay listing. These names must be in
120 the case as names used in the relaylisting. You can do the same for snoop.
121 .PP
122 For instance:
123 .PP
124 .I -debugmsg warn+dll,+heap
125 will turn on DLL warning messages and all heap messages.  
126 .br
127 .I -debugmsg fixme-all,warn+cursor,+relay
128 will turn off all FIXME messages, turn on cursor warning messages, and turn
129 on all relay messages (API calls).
130 .br 
131 .I -debugmsg -relay=LeaveCriticalSection:EnterCriticalSection
132 will turn on all relay messages except for LeaveCriticalSection and
133 EnterCriticalSection.
134 .br 
135 .I -debugmsg +relay=ADVAPI32
136 will only turn on relay messages into the ADVAPI32 code.
137 .PP
138 The full list of names is: all, accel, advapi, animate, aspi, atom, 
139 bitblt, bitmap, caret, cd, cdaudio, class, clipboard, clipping, combo, 
140 comboex, comm, commctrl, commdlg, console, crtdll, cursor, datetime, dc, 
141 dde, ddeml, ddraw, debug, dialog, dinput, dll, dosfs, dosmem, dplay, driver, 
142 dsound, edit, event, exec, file, fixup, font, gdi, global, graphics, header, 
143 heap, hook, hotkey, icon, imagehlp, imagelist, imm, int, int10, int16, int17, 
144 int19, int21, int31, io, ipaddress, key, keyboard, ldt, listbox, listview, 
145 local, mci, mcianim, mciwave, mdi, menu, message, metafile, midi, mmaux, mmio, 
146 mmsys, mmtime, module, monthcal, mpr, msacm, msg, nativefont, nonclient, ntdll, 
147 ole, pager, palette, pidl, print, process, profile, progress, prop, psapi, 
148 psdrv, rebar, reg, region, relay, resource, s, scroll, security, segment, 
149 selector, sem, sendmsg, server, shell, shm, snoop, sound, static, statusbar, 
150 stress, string, syscolor, system, tab, task, text, thread, thunk, timer, 
151 toolbar, toolhelp, tooltips, trackbar, treeview, tweak, uitools, updown, ver, 
152 virtual, vxd, win, win16drv, win32, wing, winsock, wnet, x11, x11drv.
153 .PP
154 For more information on debugging messages, see the file 
155 .I documentation/debug-msgs
156 in the source distribution.
157 .RE
158 .TP
159 .I -depth n
160 Change the depth to use for multiple-depth screens
161 .TP
162 .I -desktop geom
163 Use a desktop window of the given geometry, e.g. "640x480"
164 .TP
165 .I -display name
166 Use the specified X display
167 .TP
168 .I -dll name[,name[,...]]={native|elfdll|so|builtin}[,{n|e|s|b}[,...]][:...]
169 Selects the override type and load order of dll used in the loading process
170 for any dll. The default is set in @sysconfdir@/wine.conf or ~/.winerc. There
171 are currently four types of libraries that can be loaded into a process' address
172 space: Native windows dlls (
173 .I native
174 ), ELF encapsulated windows dlls (
175 .I elfdll
176 ), native ELF libraries (
177 .I so
178 )and wine internal dlls (
179 .I builtin
180 ). The type may be abbreviated with the first letter of the type (
181 .I n, e, s, b
182 ). Each sequence of orders must be separated by commas.
183 .br
184 Each dll may have its own specific load order. The load order determines
185 which verion of the dll is attempted to be loaded into the address space. If
186 the first fails, then the next is tried and so on. Different load orders can
187 be specified by separating the entries with a colon. Multiple libraries
188 with the same load order can be separated with commas.
189 .br
190 Examples:
191 .br
192 .I -dll comdlg32,commdlg=n,b
193 .br
194 Try to load comdlg32 and commdlg as native windows dll first and try
195 the builtin version if the native load fails.
196 .br
197 .I -dll comdlg32,commdlg=e,n:shell,shell32=b:comctl32,commctrl=n
198 .br
199 Try to load comdlg32 and commdlg as elfdll first and try the native version
200 if the elfdll load fails; load shell32/shell always as builtin and
201 comctl32/commctrl always as native.
202 .br
203 Note: It is wise to keep dll pairs (comdlg32/commdlg, shell/shell32, etc.)
204 having exactly the same load order. This will prevent mismatches at runtime.
205 See also configuration file format below.
206 .TP
207 .I -failreadonly
208 Read only files may not be opened in write mode (the default is to
209 allow opening read-only files for writing, because most Windows
210 programs always request read-write access, even on CD-ROM drives...).
211 .TP
212 .I -fixedmap
213 Use a "standard" color map.
214 .TP
215 .I -iconic
216 Start as an icon
217 .TP
218 .I -language xx
219 Set the language to
220 .I xx
221 (one of Ca, Cs, Da, De, En, Eo, Es, Fi, Fr, Hu, It, Ko, No, Pl, Pt, Ru, Sv, Wa)
222 .TP
223 .I -managed
224 Create each top-level window as a properly managed X window instead of
225 creating our own "sticky" window.
226 .TP
227 .I -mode modename
228 Determines the mode in which
229 .B wine
230 is started. Possible mode names are
231 .I standard
232 and
233 .I enhanced.
234 Enhanced mode is the default (when no -mode option is specified).
235 .TP
236 .I -name name
237 Set the application name
238 .TP
239 .I -privatemap
240 Use a private color map
241 .TP
242 .I -synchronous
243 Turn on synchronous display mode. Useful for debugging X11 graphics problems.
244 .TP
245 .I -winver version
246 Specify which Windows version WINE should imitate.
247 Possible arguments are: win31, win95, nt351, and nt40.
248 .PD 1
249 .SH PROGRAM/ARGUMENTS
250 The program name may be specified in DOS format (
251 .I
252 C:\\WINDOWS\\SOL.EXE)
253 or in Unix format (
254 .I /msdos/windows/sol.exe
255 ).  The program being executed may be passed arguments by adding them on 
256 to the end of the command line invoking
257 .B wine
258 (such as: wine "notepad C:\\TEMP\\README.TXT").  Note that
259 the program name and its arguments 
260 .I must
261 be passed as a single parameter, which is usually accomplished by placing
262 them together in quotation marks.  Multiple applications may be started
263 by placing all of them on the command line (such as: wine notepad clock).
264 .SH ENVIRONMENT VARIABLES
265 .B wine
266 makes the environment variables of the shell from which
267 .B wine
268 is started accessible to the windows/dos processes started. So use the
269 appropriate syntax for your shell to enter environment variables you need.
270 .SH CONFIGURATION FILE
271 .B wine
272 expects a configuration file (
273 .I @sysconfdir@/wine.conf
274 ), which must conform to the format specified in the
275 .BR wine.conf (5)
276 man page. A sample configuration file is wine.ini in the home directory of the Wine
277 source archive.
278 .SH AUTHORS
279 .B Wine
280 is available thanks to the work of many developers. For a listing
281 of the authors, please see the file 
282 .B AUTHORS
283 in the top-level directory of the source distribution.
284 .SH BUGS
285 .PP
286 A status report on many appplications is available from
287 .I http://www.winehq.com/Apps.
288 Please add entries to this list for applications you currently run.
289 .PP
290 Bug reports and successes may be posted to 
291 .I comp.emulators.ms-windows.wine.
292 If you want to post a bug report, please read the file
293 .I documentation/bugreports
294 in the Wine source to see what information is necessary.
295 .PP
296 For problems and suggestions with this manpage, please send a note to
297 James Juran <jrj120@psu.edu>.
298 .SH AVAILABILITY
299 The most recent public version of 
300 .B wine
301 can be obtained via FTP from metalab.unc.edu or tsx-11.mit.edu in the 
302 /pub/linux/ALPHA/Wine/development directory.  The releases are in the 
303 format 'Wine-yymmdd.tar.gz', or 'Wine-yymmdd.diff.gz' for the diff's 
304 from the previous release.
305 .PP
306 The latest snapshot of the code may be obtained via CVS.  For information
307 on how to do this, please see
308 .I
309 http://www.winehq.com/dev.html
310 .PP
311 WineHQ, the
312 .B wine
313 development headquarters, is at
314 .I http://www.winehq.com/.
315 This website contains a great deal of information about
316 .B wine.
317 .PP
318 The
319 .B wine 
320 newsgroup is 
321 .I comp.emulators.ms-windows.wine.
322 It is used for discussion of various Wine end user aspects/help.
323 .PP
324 For further information about Wine development, you might want to
325 subscribe to the wine "cvs", "devel" and "patches" mailing lists at
326 .I http://www.winehq.com/dev.html#ml.
327 .SH FILES
328 .PD 0
329 .TP
330 .I @prefix@/bin/wine
331 The Wine program loader.
332 .TP
333 .I @prefix@/bin/dosmod
334 The DOS program loader.
335 .TP
336 .I @sysconfdir@/wine.conf
337 Global configuration file for wine.
338 .TP
339 .I ~/.winerc
340 User-specific configuration file
341 .TP
342 .I @prefix@/lib/wine.sym
343 Global symbol table (used in debugger)
344 .SH "SEE ALSO"
345 .BR wine.conf (5),
346 .BR clone (2)