2 <title>Running Wine</title>
5 This chapter will describe all aspects of running Wine, like e.g.
6 basic Wine invocation, command line parameters of various Wine
10 <sect1 id="basic-usage">
11 <title>Basic usage: applications and control panel applets</title>
13 Assuming you are using a fake Windows installation, you install
14 applications into Wine in the same way you would in Windows: by
15 running the installer. You can just accept the defaults for
16 where to install, most installers will default to "C:\Program
17 Files", which is fine. If the application installer requests it,
18 you may find that Wine creates icons on your desktop and in your
19 app menu. If that happens, you can start the app by clicking on
24 The standard way to uninstall things is for the application to
25 provide an uninstaller, usually registered with the "Add/Remove
26 Programs" control panel applet.
27 To access the Wine equivalent, run the <command>uninstaller</command>
28 program (it is located in the
29 <filename>programs/uninstaller/</filename> directory in a Wine
30 source directory) in a <glossterm>terminal</glossterm>:
34 <prompt>$</prompt> <userinput>uninstaller</userinput>
38 Some programs install associated control panel applets, examples
39 of this would be Internet Explorer and QuickTime. You can access
40 the Wine control panel by running in a
41 <glossterm>terminal</glossterm>:
45 <prompt>$</prompt> <userinput>wine control</userinput>
49 which will open a window with the installed control panel
50 applets in it, as in Windows.
54 If the application doesn't install menu or desktop items, you'll
55 need to run the app from the command line. Remembering where you
56 installed to, something like:
60 <prompt>$</prompt> <userinput>wine "c:\program files\appname\appname.exe"</userinput>
64 will probably do the trick. The path isn't case sensitive, but
65 remember to include the double quotes. Some programs don't
66 always use obvious naming for their directories and EXE files,
67 so you might have to look inside the program files directory to
68 see what was put where.
72 <sect1 id="running-wine">
73 <title>How to run Wine</title>
76 You can invoke the <command>wine --help</command> command to
77 get a listing of all Wine's command-line parameters:
81 Usage: ./wine [options] program_name [arguments]
84 --debugmsg name Turn debugging-messages on or off
85 --help,-h Show this help message
86 --version,-v Display the Wine version
91 You can specify as many options as you want, if any.
92 Typically, you will want to have your configuration file set
93 up with a sensible set of defaults; in this case, you can run
94 <command>wine</command> without explicitly listing any
95 options. In rare cases, you might want to override certain
96 parameters on the command line.
99 After the options, you should put the name of the file you
100 want <command>wine</command> to execute. If the executable is
101 in the <parameter>Path</parameter> parameter in the
102 configuration file, you can simply give the executable file
103 name. However, if the executable is not in
104 <parameter>Path</parameter>, you must give the full path to
105 the executable (in Windows format, not UNIX format!). For
106 example, given a <parameter>Path</parameter> of the following:
110 "Path"="c:\\windows;c:\\windows\\system;e:\\;e:\\test;f:\\"
113 You could run the file
114 <filename>c:\windows\system\foo.exe</filename> with:
117 <prompt>$</prompt> <userinput>wine foo.exe</userinput>
120 However, you would have to run the file
121 <filename>c:\myapps\foo.exe</filename> with this command:
124 <prompt>$</prompt> <userinput>wine c:\\myapps\\foo.exe</userinput>
127 (note the backslash-escaped "\" !)
130 For details on running text mode (CUI) executables, read the
131 <link linkend="CUI-programs">section</link> below.
135 <sect1 id="explorer-like-wine">
136 <title>Explorer-like graphical Wine environments</title>
139 If you don't feel like manually invoking Wine for every program
140 you want to run and instead want to have an integrated graphical
141 interface to run your Windows programs in, then installing e.g.
142 <ulink url="http://www.calmira.org">Calmira</ulink>, a
143 Win95-Explorer-like shell replacement, would probably be a great
144 idea. Calmira might still have a few problems running on Wine,
145 though. Other usable Explorer replacements should be listed here
150 <sect1 id="command-line-options">
151 <title>Wine Command Line Options</title>
153 <sect2 id="config-parameter">
154 <title>--debugmsg [channels]</title>
156 Wine isn't perfect, and many Windows applications still
157 don't run without bugs under Wine (but then, a lot of programs
158 don't run without bugs under native Windows either!). To
159 make it easier for people to track down the causes behind
160 each bug, Wine provides a number of <firstterm>debug
161 channels</firstterm> that you can tap into.
164 Each debug channel, when activated, will trigger logging
165 messages to be displayed to the console where you invoked
166 <command>wine</command>. From there you can redirect the
167 messages to a file and examine it at your leisure. But be
168 forewarned! Some debug channels can generate incredible
169 volumes of log messages. Among the most prolific offenders
170 are <parameter>relay</parameter> which spits out a log
171 message every time a win32 function is called,
172 <parameter>win</parameter> which tracks windows message
173 passing, and of course <parameter>all</parameter> which is
174 an alias for every single debug channel that exists. For a
175 complex application, your debug logs can easily top 1 MB and
176 higher. A <parameter>relay</parameter> trace can often
177 generate more than 10 MB of log messages, depending on how
178 long you run the application. (As described in the
179 <link linkend = "config-debug-etc">Debug</link>
180 section of configuring wine you can
181 modify what the <parameter>relay</parameter> trace reports).
182 Logging does slow down Wine
183 quite a bit, so don't use <parameter>--debugmsg</parameter>
184 unless you really do want log files.
187 Within each debug channel, you can further specify a
188 <firstterm>message class</firstterm>, to filter out the
189 different severities of errors. The four message classes
191 <simplelist type="inline">
192 <member><parameter>trace</parameter></member>
193 <member><parameter>fixme</parameter></member>
194 <member><parameter>warn</parameter></member>
195 <member><parameter>err</parameter></member>
199 To turn on a debug channel, use the form
200 <parameter>class+channel</parameter>. To turn it off, use
201 <parameter>class-channel</parameter>. To list more than one
202 channel in the same <parameter>--debugmsg</parameter>
203 option, separate them with commas. For example, to request
204 <parameter>warn</parameter> class messages in the
205 <parameter>heap</parameter> debug channel, you could invoke
206 <command>wine</command> like this:
209 <prompt>$</prompt> <userinput>wine --debugmsg warn+heap <replaceable>program_name</replaceable></userinput>
212 If you leave off the message class, <command>wine</command>
213 will display messages from all four classes for that channel:
216 <prompt>$</prompt> <userinput>wine --debugmsg +heap <replaceable>program_name</replaceable></userinput>
219 If you wanted to see log messages for everything except the
220 relay channel, you might do something like this:
223 <prompt>$</prompt> <userinput>wine --debugmsg +all,-relay <replaceable>program_name</replaceable></userinput>
226 Here is a list of the debug channels and classes in Wine.
227 More channels will be added to (or subtracted from) later
231 <table frame="none"><title>Debug Channels</title>
232 <tgroup cols=5 align="left">
234 <row> <entry>accel</entry> <entry>adpcm</entry> <entry>advapi</entry> <entry>animate</entry> <entry>aspi</entry> </row>
235 <row> <entry>atom</entry> <entry>avicap</entry> <entry>avifile</entry> <entry>bidi</entry> <entry>bitblt</entry> </row>
236 <row> <entry>bitmap</entry> <entry>cabinet</entry> <entry>capi</entry> <entry>caret</entry> <entry>cdrom</entry> </row>
237 <row> <entry>cfgmgr32</entry> <entry>class</entry> <entry>clipboard</entry> <entry>clipping</entry> <entry>combo</entry> </row>
238 <row> <entry>comboex</entry> <entry>comm</entry> <entry>commctrl</entry> <entry>commdlg</entry> <entry>computername</entry> </row>
239 <row> <entry>console</entry> <entry>crtdll</entry> <entry>crypt</entry> <entry>curses</entry> <entry>cursor</entry> </row>
240 <row> <entry>d3d</entry> <entry>d3d_shader</entry> <entry>d3d_surface</entry> <entry>datetime</entry> <entry>dc</entry> </row>
241 <row> <entry>ddeml</entry> <entry>ddraw</entry> <entry>ddraw_fps</entry> <entry>ddraw_geom</entry> <entry>ddraw_tex</entry> </row>
242 <row> <entry>debugstr</entry> <entry>devenum</entry> <entry>dialog</entry> <entry>dinput</entry> <entry>dll</entry> </row>
243 <row> <entry>dma</entry> <entry>dmband</entry> <entry>dmcompos</entry> <entry>dmfile</entry> <entry>dmfiledat</entry> </row>
244 <row> <entry>dmime</entry> <entry>dmloader</entry> <entry>dmscript</entry> <entry>dmstyle</entry> <entry>dmsynth</entry> </row>
245 <row> <entry>dmusic</entry> <entry>dosfs</entry> <entry>dosmem</entry> <entry>dplay</entry> <entry>dplayx</entry> </row>
246 <row> <entry>dpnhpast</entry> <entry>driver</entry> <entry>dsound</entry> <entry>dsound3d</entry> <entry>edit</entry> </row>
247 <row> <entry>enhmetafile</entry> <entry>environ</entry> <entry>event</entry> <entry>eventlog</entry> <entry>exec</entry> </row>
248 <row> <entry>file</entry> <entry>fixup</entry> <entry>font</entry> <entry>fps</entry> <entry>g711</entry> </row>
249 <row> <entry>gdi</entry> <entry>global</entry> <entry>glu</entry> <entry>graphics</entry> <entry>header</entry> </row>
250 <row> <entry>heap</entry> <entry>hook</entry> <entry>hotkey</entry> <entry>icmp</entry> <entry>icon</entry> </row>
251 <row> <entry>imagehlp</entry> <entry>imagelist</entry> <entry>imm</entry> <entry>int</entry> <entry>int21</entry> </row>
252 <row> <entry>int31</entry> <entry>io</entry> <entry>ipaddress</entry> <entry>iphlpapi</entry> <entry>jack</entry> </row>
253 <row> <entry>joystick</entry> <entry>key</entry> <entry>keyboard</entry> <entry>listbox</entry> <entry>listview</entry> </row>
254 <row> <entry>loaddll</entry> <entry>local</entry> <entry>mapi</entry> <entry>mci</entry> <entry>mcianim</entry> </row>
255 <row> <entry>mciavi</entry> <entry>mcicda</entry> <entry>mcimidi</entry> <entry>mciwave</entry> <entry>mdi</entry> </row>
256 <row> <entry>menu</entry> <entry>menubuilder</entry> <entry>message</entry> <entry>metafile</entry> <entry>midi</entry> </row>
257 <row> <entry>mmaux</entry> <entry>mmio</entry> <entry>mmsys</entry> <entry>mmtime</entry> <entry>module</entry> </row>
258 <row> <entry>monthcal</entry> <entry>mpeg3</entry> <entry>mpr</entry> <entry>msacm</entry> <entry>msdmo</entry> </row>
259 <row> <entry>msg</entry> <entry>mshtml</entry> <entry>msi</entry> <entry>msimg32</entry> <entry>msisys</entry> </row>
260 <row> <entry>msrle32</entry> <entry>msvcrt</entry> <entry>msvideo</entry> <entry>mswsock</entry> <entry>nativefont</entry> </row>
261 <row> <entry>netapi32</entry> <entry>netbios</entry> <entry>nls</entry> <entry>nonclient</entry> <entry>ntdll</entry> </row>
262 <row> <entry>odbc</entry> <entry>ole</entry> <entry>oledlg</entry> <entry>olerelay</entry> <entry>opengl</entry> </row>
263 <row> <entry>pager</entry> <entry>palette</entry> <entry>pidl</entry> <entry>powermgnt</entry> <entry>print</entry> </row>
264 <row> <entry>process</entry> <entry>profile</entry> <entry>progress</entry> <entry>propsheet</entry> <entry>psapi</entry> </row>
265 <row> <entry>psdrv</entry> <entry>qcap</entry> <entry>quartz</entry> <entry>ras</entry> <entry>rebar</entry> </row>
266 <row> <entry>reg</entry> <entry>region</entry> <entry>relay</entry> <entry>resource</entry> <entry>richedit</entry> </row>
267 <row> <entry>rundll32</entry> <entry>sblaster</entry> <entry>scroll</entry> <entry>seh</entry> <entry>selector</entry> </row>
268 <row> <entry>server</entry> <entry>setupapi</entry> <entry>shdocvw</entry> <entry>shell</entry> <entry>shlctrl</entry> </row>
269 <row> <entry>snmpapi</entry> <entry>snoop</entry> <entry>sound</entry> <entry>static</entry> <entry>statusbar</entry> </row>
270 <row> <entry>storage</entry> <entry>stress</entry> <entry>string</entry> <entry>syscolor</entry> <entry>system</entry> </row>
271 <row> <entry>tab</entry> <entry>tape</entry> <entry>tapi</entry> <entry>task</entry> <entry>text</entry> </row>
272 <row> <entry>thread</entry> <entry>thunk</entry> <entry>tid</entry> <entry>timer</entry> <entry>toolbar</entry> </row>
273 <row> <entry>toolhelp</entry> <entry>tooltips</entry> <entry>trackbar</entry> <entry>treeview</entry> <entry>ttydrv</entry> </row>
274 <row> <entry>twain</entry> <entry>typelib</entry> <entry>uninstaller</entry> <entry>updown</entry> <entry>urlmon</entry> </row>
275 <row> <entry>uxtheme</entry> <entry>ver</entry> <entry>virtual</entry> <entry>vxd</entry> <entry>wave</entry> </row>
276 <row> <entry>wc_font</entry> <entry>win</entry> <entry>win32</entry> <entry>wineboot</entry> <entry>winecfg</entry> </row>
277 <row> <entry>wineconsole</entry> <entry>wine_d3d</entry> <entry>winevdm</entry> <entry>wing</entry> <entry>winhelp</entry> </row>
278 <row> <entry>wininet</entry> <entry>winmm</entry> <entry>winsock</entry> <entry>winspool</entry> <entry>wintab</entry> </row>
279 <row> <entry>wintab32</entry> <entry>wnet</entry> <entry>x11drv</entry> <entry>x11settings</entry> <entry>xdnd</entry> </row>
280 <row> <entry>xrandr</entry> <entry>xrender</entry> <entry>xvidmode</entry> </row>
286 For more details about debug channels, check out the
287 <ulink url="http://wine.codeweavers.com/docs/wine-devel/">
288 The Wine Developer's Guide</ulink>.
293 <title>--help</title>
295 Shows a small command line help page.
300 <title>--version</title>
302 Shows the Wine version string. Useful to verify your installation.
307 <sect1 id="wineserver-command-line-options">
308 <title>wineserver Command Line Options</title>
311 wineserver usually gets started automatically by Wine whenever
312 the first wine process gets started.
313 However, wineserver has some useful command line options that
314 you can add if you start it up manually, e.g. via a user login
318 <sect2 id="wineserver-config-parameter">
319 <title>-d<n></title>
321 Sets the debug level for debug output in the terminal that
322 wineserver got started in at level <n>.
323 In other words: everything greater than 0 will enable
324 wineserver specific debugging output (not to confuse with Wine's wineserver logging channel, --debugmsg +server, though!).
331 Display wineserver command line options help message.
338 Kill the current wineserver, optionally with signal n.
345 This parameter makes wineserver persistent, optionally for n
346 seconds. It will prevent wineserver from shutting down immediately.
349 Usually, wineserver quits almost immediately after the last
350 wine process using this wineserver terminated.
351 However, since wineserver loads a lot of things on startup
352 (such as the whole Windows registry data), its startup might
353 be so slow that it's very useful to keep it from exiting after
354 the end of all Wine sessions, by making it persistent.
361 This parameter makes a newly started wineserver wait until the
362 currently active wineserver instance terminates.
367 <sect1 id="environment-variables">
368 <title>Setting Windows/DOS environment variables</title>
370 Your program might require some environment variable to be set
371 properly in order to run successfully.
372 In this case you need to set this environment variable in the
373 Linux shell, since Wine will pass on the entire shell environment
374 variable settings to the Windows environment variable space.
375 Example for the bash shell (other shells may have a different syntax
378 export MYENVIRONMENTVAR=myenvironmentvarsetting
380 This will make sure your Windows program can access the
381 MYENVIRONMENTVAR environment variable once you start your program
383 If you want to have MYENVIRONMENTVAR set permanently, then you can
384 place the setting into /etc/profile, or also ~/.bashrc in the case of
388 Note however that there is an exception to the rule:
389 If you want to change the PATH environment variable, then of
390 course you can't modify it that way, since this will alter the
391 Unix PATH environment setting. Instead, you should set the
392 WINEPATH environment variable. An alternative way to
393 indicate the content of the DOS PATH environment variable would
394 be to change the "path" setting in the wine config file's <link
395 linkend="config-wine">[wine]</link> section.
400 <sect1 id="CUI-programs">
401 <title>Text mode programs (CUI: Console User Interface)</title>
402 <para>Text mode programs are program which output is only made
403 out of text (surprise!). In Windows terminology, they are
404 called CUI (Console User Interface) executables, by opposition
405 to GUI (Graphical User Interface) executables. Win32 API
406 provide a complete set of APIs to handle this situation, which
407 goes from basic features like text printing, up to high level
408 functionalities (like full screen editing, color support,
409 cursor motion, mouse support), going through features like
410 line editing or raw/cooked input stream support
413 Given the wide scope of features above, and the current usage
414 in Un*x world, Wine comes out with three different ways for
415 running a console program (aka a CUI executable):
424 wineconsole with user backend
429 wineconsole with curses backend
434 <para>The names here are a bit obscure. "bare streams" means
435 that no extra support of wine is provide to map between the
436 unix console access and Windows console access. The two other
437 ways require the use of a specific Wine program (wineconsole)
438 which provide extended facilities. The following table
439 describes what you can do (and cannot do) with those three
442 <title>Basic differences in consoles</title>
443 <tgroup cols="4" align="left">
446 <entry>Function</entry>
447 <entry>Bare streams</entry>
448 <entry>Wineconsole & user backend</entry>
449 <entry>Wineconsole & curses backend</entry>
454 <entry>How to run (assuming executable is called foo.exe)</entry>
456 <screen><prompt>$</prompt> <userinput>wine foo.exe</userinput></screen>
459 <screen><prompt>$</prompt> <userinput>wineconsole -- --backend=user foo.exe</userinput></screen>
462 <screen><prompt>$</prompt> <userinput>wineconsole foo.exe</userinput></screen>
463 </msgtext>You can also use --backend=curses as an option</entry>
466 <entry>Good support for line oriented CUI applications
467 (which print information line after line)
474 <entry>Good support for full screen CUI
475 applications (including but not limited to color
476 support, mouse support...)</entry>
482 <entry>Can be run even if X11 is not running</entry>
488 <entry>Implementation</entry>
489 <entry>Maps the standard Windows streams to the
490 standard Unix streams (stdin/stdout/stderr)
493 Wineconsole will create a new Window (hence
494 requiring the USER32 DLL is available) where all
495 information will be displayed
498 Wineconsole will use existing unix console
499 (from which the program is run) and with the help of
500 the (n)curses library take control of all the terminal
501 surface for interacting with the user
505 <entry>Known limitations</entry>
509 Will produce strange behavior if two (or more)
510 Windows consoles are used on the same Un*x terminal.
517 <sect2 id="CUI-programs-config">
518 <title>Configuration of CUI executables</title>
520 When wineconsole is used, several configuration options are
521 available. Wine (as Windows do) stores, on a per application
522 basis, several options in the registry. This let a user, for
523 example, define the default screen-buffer size he would like
524 to have for a given application.
527 As of today, only the USER backend allows you to edit those
528 options (we don't recommend editing by hand the registry
529 contents). This edition is fired when a user right click in
530 the console (this popups a menu), where you can either
535 Default: this will edit the settings shared by all
536 applications which haven't been configured yet. So,
537 when an application is first run (on your machine,
538 under your account) in wineconsole, wineconsole will
539 inherit this default settings for the
540 application. Afterwards, the application will have its
541 own settings, that you'll be able to modify at your will.
544 Properties: this will edit the application's
545 settings. When you're done, with the edition, you'll
546 be prompted whether you want to:
550 Keep these modified settings only for this
551 session (next time you run the application, you
552 will not see the modification you've just made).
557 Use the settings for this session and save them
558 as well, so that next you run your application,
559 you'll use these new settings again.
568 Here's the list of the items you can configure, and their
571 <title>Wineconsole configuration options</title>
572 <tgroup cols="2" align="left">
575 <entry>Configuration option</entry>
576 <entry>Meaning</entry>
581 <entry>Cursor's size</entry>
583 Defines the size of the cursor. Three options are
584 available: small (33% of character height), medium
585 (66%) and large (100%)
589 <entry>Popup menu</entry>
591 It's been said earlier that wineconsole
592 configuration popup was triggered using a right
593 click in the console's window. However, this can
594 be an issue when the application you run inside
595 wineconsole expects the right click events to be
596 sent to it. By ticking control or shift you select
597 additional modifiers on the right click for
598 opening the popup. For example, ticking shift will
599 send events to the application when you right
600 click the window without shift being hold down,
601 and open the window when you right-click while
602 shift being hold down.
606 <entry>Quick edit</entry>
608 This tick box lets you decide whether left-click
609 mouse events shall be interpreted as events to be
610 sent to the underlying application (tick off) or
611 as a selection of rectangular part of the screen
612 to be later on copied onto the clipboard (tick on).
616 <entry>History</entry>
618 This lets you pick up how many commands you want
619 the console to recall. You can also drive whether
620 you want, when entering several times the same
621 command - potentially intertwined with others -
622 whether you want to store all of them (tick off)
623 or only the last one (tick on).
627 <entry>Police</entry>
629 The Police property sheet allows you to pick the
630 default font for the console (font file, size,
631 background and foreground color).
635 <entry>Screenbuffer & window size</entry>
637 The console as you see it is made of two different
638 parts. On one hand there's the screenbuffer which
639 contains all the information your application puts
640 on the screen, and the window which displays a
641 given area of this screen buffer. Note that the
642 window is always smaller or of the same size than
643 the screen buffer. Having a stricly smaller window
644 size will put on scrollbars on the window so that
645 you can see the whole screenbuffer's content.
649 <entry>Close on exit</entry>
651 If it's ticked, then the wineconsole will exit
652 when the application within terminates. Otherwise,
653 it'll remain opened until the user manually closes
654 it: this allows seeing the latest information of a
655 program after it has terminated.
659 <entry>Edition mode</entry>
663 When the user enter commands, he or she can
664 choose between several edition modes:
668 Emacs: the same keybindings as under
669 emacs are available. For example, Ctrl-A
670 will bring the cursor to the beginning
671 of the edition line. See your emacs
672 manual for the details of the commands.
677 Win32: this are the standard Windows
678 console key-bindings (mainly using
695 <!-- Keep this comment at the end of the file
698 sgml-parent-document:("wine-user.sgml" "set" "book" "chapter" "")