[docs] wineusr: Assorted formatting & tagging fixes (try 4)
Frédéric Delanoy
frederic.delanoy at gmail.com
Fri Aug 16 08:08:03 CDT 2013
A couple typos as well.
---
en/wineusr-bugs.sgml | 105 +++++++-------
en/wineusr-configuring.sgml | 326 ++++++++++++++++++++++---------------------
en/wineusr-getting.sgml | 35 ++---
en/wineusr-glossary.sgml | 12 +-
en/wineusr-introduction.sgml | 29 ++--
en/wineusr-running.sgml | 267 ++++++++++++++++++-----------------
6 files changed, 395 insertions(+), 379 deletions(-)
diff --git a/en/wineusr-bugs.sgml b/en/wineusr-bugs.sgml
index 7040d23..9762536 100644
--- a/en/wineusr-bugs.sgml
+++ b/en/wineusr-bugs.sgml
@@ -16,11 +16,10 @@
<sect2>
<title>Verify your wine configuration</title>
<para>
- Look at the output from <prompt>$ </prompt>
- <userinput>wine --version</userinput> to make sure you're running
- a recent version of Wine. Launch winecfg and look over the
+ Look at the output from <userinput>wine --version</userinput> to make sure you're running
+ a recent version of Wine. Launch <command>winecfg</command> and look over the
settings to make sure you have settings that look normal. Look
- in <filename>~/.wine/dosdevices</filename> to make sure your
+ in <filename class="directory">~/.wine/dosdevices</filename> to make sure your
c: points to where you think it should.
</para>
</sect2>
@@ -28,37 +27,33 @@
<sect2>
<title>Use different windows version settings</title>
- <para>
- In several cases using <link linkend="config-windows-versions">different windows version settings</link> can help.
+ <para>
+ In several cases <link linkend="config-windows-versions">using different Windows version
+ settings</link> can help.
</para>
</sect2>
<sect2>
<title>Use different startup paths</title>
- <para>
- This sometimes helps, too:
-
- Try
- <command>wine x:\\full\\path\\to\\prg.exe</command>
- ,
- <command>wine ~/.wine/drive_c/full/path/to/prg.exe</command>
- and
- <command>cd ~/.wine/drive_c/full/path/to/ && wine prg.exe</command>
- </para>
+ <para>
+ The following sometimes helps, too:
+ <userinput>wine x:\\full\\path\\to\\prg.exe</userinput>,
+ <userinput>wine ~/.wine/drive_c/full/path/to/prg.exe</userinput> and
+ <userinput>cd ~/.wine/drive_c/full/path/to/ && wine prg.exe</userinput>
+ </para>
</sect2>
<sect2>
<title>Fiddle with DLL configuration</title>
- <para>
- Run with WINEDEBUG=+loaddll to figure out which DLLs are
- being used, and whether they're being loaded as native or
- built-in.
- Then make sure you have proper native DLL files in your
- configured C:\windows\system32 directory and fiddle with DLL
- load order settings at command line or in config file.
- </para>
+ <para>
+ Run with <userinput><envar>WINEDEBUG</envar>=+loaddll</userinput> to figure out which
+ DLLs are being used, and whether they're being loaded as native or built-in.
+ Then make sure you have proper native DLL files in your
+ configured <filename class="directory">C:\windows\system32</filename> directory and
+ fiddle with DLL load order settings at command line or with <command>winecfg</command>.
+ </para>
</sect2>
<sect2>
@@ -70,17 +65,17 @@
Make sure that there are no problems whatsoever with the
packages
- that Wine depends on (gcc, glibc, X libraries, OpenGL (!), ...)
+ that Wine depends on (<command>gcc</command>, glibc, X libraries, OpenGL (!), ...)
</para>
</sect2>
<sect2>
<title>Use different GUI (Window Manager) modes</title>
-
- <para>
- Instruct Wine via Winecfg to use either desktop mode,
- or normal managed mode. That can make a lot of difference, too.
- </para>
+
+ <para>
+ Instruct Wine via <command>winecfg</command> to use either desktop mode,
+ or normal managed mode. That can make a lot of difference, too.
+ </para>
</sect2>
<sect2>
@@ -103,13 +98,13 @@
Wine account on these changes.
This is especially true if your setup was created long time ago.
- Rename your existing <filename>~/.wine</filename> directory
+ Rename your existing <filename class="directory">~/.wine</filename> directory
for backup purposes.
Use the setup process that's recommended for your Wine distribution
to create new configuration.
- Use information in old <filename>~/.wine</filename>
- directory as a reference. Later you can remove the new
- <filename>~/.wine</filename> directory and rename your old one back.
+ Use information in old <filename class="directory">~/.wine</filename>
+ directory as a reference. Later you can remove the new
+ <filename class="directory">~/.wine</filename> directory and rename your old one back.
</para>
</sect2>
@@ -150,13 +145,15 @@
</para>
</listitem>
<listitem>
- <para>
+ <para>
If you have a program that requires a redistributable runtime
- to be installed, e.g. for mfc42.dll, Visual Basic and so on, winetricks
+ to be installed, e.g. for <filename>mfc42.dll</filename>, Visual
+ Basic and so on, <command>winetricks</command>
can be used to supply this. Note, these components are subject to
their own license and are not part of the Wine project.
- For further information on winetricks see <ulink url="http://wiki.winehq.org/winetricks">the winetricks wiki entry.</ulink>
+ For further information on winetricks see <ulink
+ url="http://wiki.winehq.org/winetricks">the winetricks wiki entry</ulink>.
</para>
</listitem>
<listitem>
@@ -219,14 +216,14 @@
Post as much relevant information as possible.
</para>
<para>
- This means we need more information than a simple "MS
- Word crashes whenever I run it. Do you know why?"
+ This means we need more information than a simple <quote>MS
+ Word crashes whenever I run it. Do you know why?</quote>
Include at least the following information:
</para>
<itemizedlist spacing="compact">
<listitem>
<para>
- Which version of Wine you're using (run <command>wine --version</command>)
+ Which version of Wine you're using (run <userinput>wine --version</userinput>)
</para>
</listitem>
<listitem>
@@ -237,8 +234,8 @@
</listitem>
<listitem>
<para>
- Which compiler and version, (run <command>gcc -v</command>).
- If you didn't compile wine then the name of the package and
+ Which compiler and version (run <userinput>gcc -v</userinput>).
+ If you didn't compile Wine then the name of the package and
where you got it from.
</para>
</listitem>
@@ -251,8 +248,8 @@
</listitem>
<listitem>
<para>
- The exact command line you used to start wine.
- (e.g. <command>wine "C:\Program Files\Test\program.exe"</command>).
+ The exact command line you used to start wine.
+ (e.g. <userinput>wine "C:\Program Files\Test\program.exe"</userinput>).
</para>
</listitem>
<listitem>
@@ -271,10 +268,10 @@
<listitem>
<para>
Create an attachment with full terminal output in a text file.
- <literallayout>
- <command>cd ~/.wine/drive_c/Games/Tron</command>
- <command>wine tron.exe &> log.txt</command>
- </literallayout>
+ <screen>
+ cd ~/.wine/drive_c/Games/Tron
+ wine tron.exe &> log.txt
+ </screen>
</para>
</listitem>
<listitem>
@@ -293,16 +290,16 @@
</listitem>
<listitem>
<para>
- You may be asked to re-run the program with the WINEDEBUG environment variable <parameter>
- WINEDEBUG=+relay,+seh,+tid</parameter> option (e.g. <command>WINEDEBUG=+relay,+seh,+tid
- wine sol.exe &> log.txt</command>).
+ You may be asked to re-run the program using a custom <envar>WINEBUG</envar> environment
+ variable value, e.g. <userinput><envar>WINEDEBUG</envar>=+relay,+seh,+tid
+ wine sol.exe &> log.txt</userinput>.
</para>
<para>
This will produce additional information which may include the cause
for a crash or may be helpful in debugging the program. It also
- slows the execution of program. There are some cases where
- the bug seems to disappear when <parameter> +relay
- </parameter> is used. Please mention that in the bug report.
+ slows the execution of program. There are some cases where
+ the bug seems to disappear when <literal>+relay</literal> is used.
+ Please mention that in the bug report.
</para>
</listitem>
</orderedlist>
diff --git a/en/wineusr-configuring.sgml b/en/wineusr-configuring.sgml
index bb5307a..4b67d8a 100644
--- a/en/wineusr-configuring.sgml
+++ b/en/wineusr-configuring.sgml
@@ -2,13 +2,13 @@
<title>Configuring Wine</title>
<para>
Most of the most common configuration changes can be done with the
- Winecfg tool. We'll go through an easy, step-by-step introduction
- to Winecfg and outline the options available.
+ <command>winecfg</command> tool. We'll go through an easy, step-by-step introduction
+ to <command>winecfg</command> and outline the options available.
In the next section we'll go over more advanced changes you can make
- using regedit as well as provide a complete reference to all Wine
+ using <command>regedit</command> as well as provide a complete reference to all Wine
configuration settings. Finally, some things you might want to
- configure fall out of the scope of Winecfg and regedit, and we'll
- go over those.
+ configure fall out of the scope of <command>winecfg</command> and
+ <command>regedit</command>, and we'll go over those.
</para>
<sect1 id="using-winecfg">
<title>Using Winecfg</title>
@@ -22,12 +22,7 @@
<para>
Winecfg should have been installed on your computer along with the
rest of the Wine programs. If you can't figure out how to start it,
- try running the command:
- <prompt>$ </prompt><userinput>/usr/local/bin/winecfg</userinput>
- </para>
- <para>
- or possibly just:
- <prompt>$ </prompt><userinput>winecfg</userinput>
+ try running <command>winecfg</command>.
</para>
<para>
When the program starts you'll notice there are tabs along the top
@@ -70,22 +65,22 @@
</listitem>
</itemizedlist>
</para>
- <para>
+ <para>
Changing settings in the
- <emphasis>Applications</emphasis> and <emphasis>Libraries</emphasis>
- tab will have the most impact on getting an application to run. The
+ <guilabel>Applications</guilabel> and <guilabel>Libraries</guilabel>
+ tabs will have the most impact on getting an application to run. The
other settings focus on getting Wine itself to behave the way
- you want it to.
+ you want it to.
</para>
<para>
- Note: The Applications, Libraries, and Graphics tabs are linked
- together! If you have Default Settings selected under Applications,
- all of the changes made within the Libraries and Graphics tabs will
- be changed for all applications. If you've configured a specific
- application under the Applications tab and have it selected, then
- any changes made in Libraries or Graphics will affect only that
- application. This allows for custom settings for specific
- applications.
+ Note: The <guilabel>Applications</guilabel>, <guilabel>Libraries</guilabel>, and
+ <guilabel>Graphics</guilabel> tabs are linked together! If you have <quote>Default
+ Settings</quote> selected under <guilabel>Applications</guilabel>, all of the changes made
+ within the <guilabel>Libraries</guilabel> and <guilabel>Graphics</guilabel> tabs will
+ be changed for all applications. If you've configured a specific application under the
+ <guilabel>Applications</guilabel> tab and have it selected, then any changes made in
+ <guilabel>Libraries</guilabel> or <guilabel>Graphics</guilabel> will affect only that
+ application. This allows for custom settings for specific applications.
</para>
<sect2 id="config-windows-versions">
<title>Application Settings</title>
@@ -94,7 +89,7 @@
Windows. In general, the biggest difference is whether Wine
behaves as a Win9x version or an NT version. Some applications
require a specific behavior in order to function and changing
- this setting may cause a buggy app to work. Wine's default Windows version
+ this setting may cause a buggy app to work. Wine default Windows version
is Windows XP. Some applications may perform better if you
choose Windows 98.
</para>
@@ -107,12 +102,12 @@
<orderedlist>
<listitem>
<para>
- Click on the <emphasis>Add application</emphasis> button.
+ Click on the <guibutton>Add application</guibutton> button.
</para>
</listitem>
<listitem>
<para>
- Browse until you locate the .exe
+ Browse until you locate the executable.
</para>
</listitem>
<listitem>
@@ -131,7 +126,7 @@
to run. Wine reproduces the Windows system libraries (so-called
native DLLs) with completely custom versions designed to
function exactly the same way but without requiring licenses
- from Microsoft. Wine has many known deficiencies in it's
+ from Microsoft. Wine has many known deficiencies in its
built-in versions, but in many instances the functionality
is sufficient. Using only builtin DLLs ensures that your
system is Microsoft-free. However, Wine has the ability to
@@ -144,9 +139,9 @@
DLLs, but sometimes native versions will be recommended as
a workaround for a specific problem.
Some may be directly copied to the directory configured
- as <filename>c:\windows\system32</filename> (more on that in
+ as <filename class="directory">c:\windows\system32</filename> (more on that in
the drives section) while others may require an installer, see
- the next section on winetricks.
+ the next section on <command>winetricks</command>.
Native versions of these DLLs do not work:
<filename>kernel32.dll</filename>,
<filename>gdi32.dll</filename>,
@@ -160,20 +155,20 @@
tell Wine to try to use it. You can configure Wine to choose
between native and builtin DLLs at two different levels.
If you have <emphasis>Default Settings</emphasis> selected
- in the <emphasis>Applications</emphasis> tab, the changes you
+ in the <guilabel>Applications</guilabel> tab, the changes you
make will affect all applications. Or, you can override the
global settings on a per-application level by adding and
- selecting an application in the <emphasis>Applications</emphasis>
- tab.
+ selecting an application in the <guilabel>Applications</guilabel> tab.
</para>
<para>
- To add an override for FOO.DLL, enter "FOO" into the box
- labeled <emphasis>New override for library:</emphasis> and
- click on the <emphasis>Add</emphasis> button. To change how
- the DLL behaves, select it within the <emphasis>Existing
- overrides:</emphasis> box and choose <emphasis>Edit</emphasis>.
+ To add an override for <filename>FOO.DLL,</filename> enter
+ <userinput>FOO</userinput> into the box
+ labeled <guilabel>New override for library:</guilabel> and
+ click on the <guibutton>Add</guibutton> button. To change how
+ the DLL behaves, select it within the <guilabel>Existing
+ overrides:</guilabel> box and choose <guibutton>Edit</guibutton>.
By default the new load order will be native Windows libraries
- before Wine's own builtin ones (<emphasis>Native then
+ before Wine builtin ones (<emphasis>Native then
Builtin</emphasis>). You can also choose native only, builtin
only, or disable it altogether.
</para>
@@ -202,7 +197,7 @@
</listitem>
<listitem>
<para>
- The PATH variable directories.
+ The <envar>PATH</envar> variable directories.
</para>
</listitem>
</orderedlist>
@@ -230,8 +225,9 @@
</programlisting>
<para>
Redistributable packages which install the necessary runtimes can
- be obtained through the use of <ulink url="http://wiki.winehq.org/winetricks">
- winetricks</ulink>. Note, these components are subject to their own
+ be obtained through the use of <ulink
+ url="http://wiki.winehq.org/winetricks">winetricks</ulink>. Note
+ these components are subject to their own
license and are not part of the Wine project. You should refer to
the application's <ulink url="http://appdb.winehq.org">AppDB</ulink>
entry for advice on what is required.
@@ -252,8 +248,7 @@
a virtual desktop.
</para>
<para>
- You may find it helpful to <emphasis>Emulate a virtual
- desktop</emphasis>.
+ You may find it helpful to tick <guilabel>Emulate a virtual desktop</guilabel>.
In this case, all programs will run in a separate window. You
may find this useful as a way to test buggy games that change
(possibly unsuccessfully) the screen resolution. Confining them
@@ -267,51 +262,51 @@
<para>
Windows requires a fairly rigid drive configuration that Wine
imitates. Most people are familiar with the standard notation
- of the "A:" drive representing the floppy disk, the "C:"
+ of the <quote>A:</quote> drive representing the floppy disk, the <quote>C:</quote>
drive representing the primary system disk, etc. Wine uses
the same concept and maps those drives to the underlying native
filesystem.
</para><para>
- Wine's drive configuration is relatively simple.
- In Winecfg under the <emphasis>Drives</emphasis> tab you'll
+ Wine drive configuration is relatively simple.
+ In <command>winecfg</command> under the <guilabel>Drives</guilabel> tab you'll
see buttons to add and remove available drives.
When you choose to add a drive, a new entry will be made
and a default drive mapping will appear. You can change where
this drive points to by changing what's in the
- <emphasis>Path:</emphasis> box. If you're unsure of the
- exact path you can choose "Browse" to search for it.
+ <guilabel>Path:</guilabel> box. If you're unsure of the
+ exact path you can choose <guibutton>Browse</guibutton> to search for it.
Removing a drive is as easy as selecting the drive and
- clicking "Remove".
+ clicking <guibutton>Remove</guibutton>.
</para><para>
- Winecfg has the ability to automatically detect the drives
+ <command>winecfg</command> has the ability to automatically detect the drives
available on your system. It's recommended you try this
before attempting to configure drives manually. Simply
- click on the <emphasis>Autodetect</emphasis> button to
+ click on the <guibutton>Autodetect</guibutton> button to
have Wine search for drives on your system.
</para><para>
You may be interested in configuring your drive settings
- outside of Winecfg, in which case you're in luck because it's
+ outside of <command>winecfg</command>, in which case you're in luck because it's
quite easy. All of the drive settings reside in a special
- directory, <filename>~/.wine/dosdevices</filename>. Each "drive"
- is simply a link to where it actually resides. Wine automatically
+ directory, <filename class="directory">~/.wine/dosdevices</filename>. Each
+ <quote>drive</quote> is simply a link to where it actually resides. Wine automatically
sets up two drives the first time you run Wine:
</para>
- <programlisting>
- $ ls -la ~/.wine/dosdevices/
- lrwxrwxrwx 1 wineuser wineuser 10 Jul 23 15:12 c: -> ../drive_c
- lrwxrwxrwx 1 wineuser wineuser 1 Jul 23 15:12 z: -> /
- </programlisting>
+ <screen>
+ <prompt>$ </prompt><userinput>ls -la ~/.wine/dosdevices/</userinput>
+ <computeroutput>lrwxrwxrwx 1 wineuser wineuser 10 Jul 23 15:12 c: -> ../drive_c</computeroutput>
+ <computeroutput>lrwxrwxrwx 1 wineuser wineuser 1 Jul 23 15:12 z: -> /</computeroutput>
+ </screen>
<para>
To add another drive, for example your CD-ROM, just create a new
link pointing to it:
<prompt>$ </prompt>
<userinput>ln -s /mnt/cdrom ~/.wine/dosdevices/d:</userinput>
Take note of the DOS-style naming convention used for links -
- the format is a letter followed by a colon, such as "a:". So,
+ the format is a letter followed by a colon, such as <quote>a:</quote>. So,
if the link to your c: drive points to
- <filename> ~/.wine/drive_c</filename>, you
- can interpret references to <filename>c:\windows\system32</filename>
- to mean <filename>~/.wine/drive_c/windows/system32</filename>.
+ <filename class="directory"> ~/.wine/drive_c</filename>, you
+ can interpret references to <filename class="directory">c:\windows\system32</filename>
+ to mean <filename class="directory">~/.wine/drive_c/windows/system32</filename>.
</para>
</sect2>
<sect2>
@@ -319,7 +314,7 @@
<para>
Wine can work with quite a few different audio subsystems.
You can see the selected driver that Wine figures out for you
- under the "Audio" tab.
+ under the <guilabel>Audio</guilabel> tab.
</para>
<para>
You can manually select which device will be used for
@@ -334,21 +329,22 @@
this certainly isn't necessary in order to use Wine or applications,
it does allow you to customize the look and feel of a program. Wine
supports the newer MSStyles type of themes. Unlike the older Microsoft
- Plus! style themes, the uxtheme engine supports special .msstyles files
+ Plus! style themes, the <literal>uxtheme</literal> engine supports special
+ <filename>.msstyles</filename> files
that can retheme all of the Windows controls. This is more or less the
same kind of theming that modern Linux desktops have supported for
years. If you'd like to try this out:
<orderedlist>
<listitem>
<para>
- Download a Windows XP theme. Be sure it contains a .msstyles
- file.
+ Download a Windows XP theme. Be sure it contains a
+ <filename>.msstyles</filename> file.
</para>
</listitem>
<listitem>
<para>
- Use the Desktop Integration tab of winecfg to install and select
- the new theme.
+ Use the <guilabel>Desktop Integration</guilabel> tab of
+ <command>winecfg</command> to install and select the new theme.
</para>
</listitem>
</orderedlist>
@@ -358,14 +354,14 @@
<sect1 id="using-regedit">
<title>Using the Registry and Regedit</title>
<para>
- All of the settings you change in Winecfg, with exception of
+ All of the settings you change in <command>winecfg</command>, with exception of
the drive settings, are ultimately stored in the registry.
In Windows, this is a central repository for the configuration
of applications and the operating system. Likewise, Wine
implements a registry and some settings not found in Winecfg
- can be changed within it. (There's actually more of a chance
- you'll need to dip into the registry to change an application's
- settings than Wine itself.)
+ can be changed within it (there's actually more of a chance
+ you'll need to dip into the registry to change the settings of an application
+ than Wine itself).
</para>
<para>
Now, the fact that Wine itself uses the registry to store settings
@@ -380,28 +376,28 @@
<sect2>
<title>Registry Structure</title>
<para>
- Okay.. with that out of the way, let's dig into the registry a bit
+ Okay... with that out of the way, let's dig into the registry a bit
to see how it's laid out. The Windows registry is an elaborate tree
structure, and not even most Windows programmers are fully aware of
- how the registry is laid out, with its different "hives" and numerous
+ how the registry is laid out, with its different <quote>hives</quote> and numerous
links between them; a full coverage is out of the scope of
this document. But here are the basic registry keys you might
need to know about for now:
</para>
<variablelist>
<varlistentry>
- <term>HKEY_LOCAL_MACHINE</term>
+ <term><literal>HKEY_LOCAL_MACHINE</literal></term>
<listitem>
<para>
This fundamental root key (in win9x it's stored in the
hidden file <filename>system.dat</filename>) contains
everything pertaining to the current Windows
- installation. This is often abbreviated HKLM.
+ installation. This is often abbreviated <literal>HKLM</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>HKEY_USERS</term>
+ <term><literal>HKEY_USERS</literal></term>
<listitem>
<para>
This fundamental root key (in win9x it's stored in the
@@ -411,20 +407,21 @@
</listitem>
</varlistentry>
<varlistentry>
- <term>HKEY_CLASSES_ROOT</term>
+ <term><literal>HKEY_CLASSES_ROOT</literal></term>
<listitem>
<para>
- This is a link to HKEY_LOCAL_MACHINE\Software\Classes.
+ This is a link to <literal>HKEY_LOCAL_MACHINE\Software\Classes</literal>.
It contains data describing things like file
associations, OLE document handlers, and COM classes.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term>HKEY_CURRENT_USER</term>
+ <term><literal>HKEY_CURRENT_USER</literal></term>
<listitem>
<para>
- This is a link to HKEY_USERS\your_username, i.e., your
+ This is a link to
+ <literal>HKEY_USERS\<replaceable>your_username</replaceable></literal>, i.e., your
personal configuration.
</para>
</listitem>
@@ -435,16 +432,16 @@
<title>Registry Files</title>
<para>
Now, what you're probably wondering is how that translates
- into Wine's structure. The registry layout described above
+ into Wine structure. The registry layout described above
actually lives in three different files within each user's
- ~/.wine directory:
+ <filename class="directory">~/.wine</filename> directory:
</para>
<variablelist>
<varlistentry>
<term><filename>system.reg</filename></term>
<listitem>
<para>
- This file contains HKEY_LOCAL_MACHINE.
+ This file contains <literal>HKEY_LOCAL_MACHINE</literal>.
</para>
</listitem>
</varlistentry>
@@ -452,7 +449,7 @@
<term><filename>user.reg</filename></term>
<listitem>
<para>
- This file contains HKEY_CURRENT_USER.
+ This file contains <literal>HKEY_CURRENT_USER</literal>.
</para>
</listitem>
</varlistentry>
@@ -460,7 +457,7 @@
<term><filename>userdef.reg</filename></term>
<listitem>
<para>
- This file contains HKEY_USERS\.Default (i.e. the default
+ This file contains <literal>HKEY_USERS\.Default</literal> (i.e. the default
user settings).
</para>
</listitem>
@@ -470,7 +467,7 @@
These files are automatically created the first time you use
Wine. A set of global settings is stored in the
<filename>wine.inf</filename> file and is processed by
- the <filename>rundll32.exe</filename> program. The first
+ the <command>rundll32.exe</command> program. The first
time you run Wine the <filename>wine.inf</filename> file
gets processed to populate the initial registry. The
registry is also updated automatically
@@ -484,36 +481,35 @@
</para>
<para>
It is not advisable to edit these files to modify the registry
- as they are managed by Wine internally. Use regedit.exe, reg.exe
- or any program which uses the standard registry functions.
+ as they are managed by Wine internally. Use <command>regedit.exe</command>,
+ <command>reg.exe</command> or any program which uses the standard registry functions.
</para>
</sect2>
<sect2>
<title>Using Regedit</title>
<para>
An easy way to access and change the registry is with the
- tool <filename>regedit</filename>. Similar to the Windows
- program it replaces, regedit serves to provide a system level
- view of the registry containing all of the keys. Simply run
- <emphasis>regedit</emphasis> and it should pop up. You'll
- immediately notice that the cryptic keys displayed in the text file
+ <command>regedit</command> tool. Similar to the Windows
+ program it replaces, <command>regedit</command> serves to provide a system level
+ view of the registry containing all of the keys. When you start it, you'll
+ immediately notice that the cryptic keys displayed in the text file
are organized in a hierarchical fashion.
</para>
<para>
To navigate through the registry, click on the keys on the
left to drill down deeper. To delete a key, click on it and
- choose "Delete" from the Edit menu. To add a key or value,
- locate where you want to put it and choose "New" from the
- Edit menu. Likewise, you modify an existing key by highlighting
- it in the right-hand window pane and choosing "Modify" from the
- Edit menu. Another way to perform these same actions is to
- right-click on the key or value.
+ choose <guimenuitem>Delete</guimenuitem> from the <guimenu>Edit</guimenu> menu. To add a
+ key or value, locate where you want to put it and choose <guimenuitem>New</guimenuitem>
+ from the <guimenu>Edit</guimenu> menu. Likewise, you modify an existing key by
+ highlighting it in the right-hand window pane and choosing
+ <guimenuitem>Modify</guimenuitem> from the <guimenu>Edit</guimenu> menu. Another way to
+ perform these same actions is to right-click on the key or value.
</para>
<para>
Of particular interest to Wine users are the settings stored in
- <filename>HKEY_CURRENT_USER\Software\Wine</filename>. Most of
- the settings you change within winecfg are written to this area
- of the registry.
+ <literal>HKEY_CURRENT_USER\Software\Wine</literal>. Most of
+ the settings you change within <command>winecfg</command> are written to this area
+ of the registry.
</para>
</sect2>
<sect2>
@@ -528,19 +524,19 @@
to have access to, copy the resulting
<filename>system.reg</filename> and
over to the global registry files (which we assume will reside in
- <filename>/usr/local/etc</filename> here), with:
+ <filename class="directory">/usr/local/etc</filename> here), with:
</para>
- <programlisting>
+ <screen>
cd ~root/.wine
cp system.reg /usr/local/etc/wine.systemreg
- </programlisting>
+ </screen>
<para>
and perhaps even symlink these back to the administrator's
account, to make it easier to install apps system-wide later:
</para>
- <programlisting>
+ <screen>
ln -sf /usr/local/etc/wine.systemreg system.reg
- </programlisting>
+ </screen>
<para>
You might be tempted to do the same for <filename>user.reg</filename>
as well, however that file contains user specific settings.
@@ -549,19 +545,19 @@
</para>
<para>
You'll want to pay attention to drive mappings. If
- you're sharing the system.reg file you'll want to make sure
+ you're sharing the <filename>system.reg</filename> file you'll want to make sure
the registry settings are compatible with the drive mappings
- in <filename>~/.wine/dosdevices</filename>
+ in <filename class="directory">~/.wine/dosdevices</filename>
of each individual user. As a general rule of thumb, the closer
you keep your drive mappings to the default configuration, the easier
this will be to manage. You may or may not be able to share
- some or all of the actual "<filename>c:</filename>" drive you
+ some or all of the actual <filename>c:</filename> drive you
originally installed the application to. Some applications
require the ability to write specific settings to the drive,
especially those designed for Windows 95/98/ME.
</para>
<para>
- Note that the <filename>tools/wineinstall</filename> script
+ Note that the <command>tools/wineinstall</command> script
used to do some of this if you installed Wine source as root, however
it no longer does.
</para>
@@ -580,7 +576,7 @@
<title>Complete List of Registry Keys</title>
<para>
You'll find an up-to-date list of useful registry keys and values in
- the <ulink url="http://wiki.winehq.org/UsefulRegistryKeys">developer's wiki</ulink>.
+ the <ulink url="http://wiki.winehq.org/UsefulRegistryKeys">developers' wiki</ulink>.
</para>
</sect2>
</sect1>
@@ -596,38 +592,42 @@
<para>
Serial and parallel port configuration is very similar to drive
configuration - simply create a symbolic link in
- <filename>~/.wine/dosdevices</filename> with the name of the
+ <filename class="directory">~/.wine/dosdevices</filename> with the name of the
device. Windows serial ports follow a naming convention of the
- word "com" followed by a number, such as
+ word <literal>com</literal> followed by a number, such as
<filename>com1</filename>, <filename>com2</filename>, etc.
- Similarly, parallel ports use "lpt" followed by a number, such as
- <filename>lpt1</filename>.
+ Similarly, parallel ports use <literal>lpt</literal> followed by a
+ number, such as <filename>lpt1</filename>.
You should link these directly to the corresponding Unix
- devices, such as /dev/ttyS0 and /dev/lp0. For example, to configure
+ devices, such as <filename>/dev/ttyS0</filename> and
+ <filename>/dev/lp0</filename>. For example, to configure
one serial port and one parallel port, run the following commands:
</para>
- <programlisting>
+ <screen>
ln -s /dev/ttyS0 com1
ln -s /dev/lp0 lpt1
- </programlisting>
+ </screen>
</sect2>
<sect2>
<title>Network Shares</title>
<para>
- Windows shares can are mapped into the <filename>unc/</filename>
+ Windows shares can are mapped into the <filename class="directory">unc/</filename>
directory so anything trying to access
- <filename>\\myserver\some\file</filename> will look in
- <filename>~/.wine/dosdevices/unc/myserver/some/file/</filename>.
+ <filename>\\<replaceable>myserver</replaceable>\<replaceable>some</replaceable>\<replaceable>file</replaceable></filename>
+ will look in
+ <filename>~/.wine/dosdevices/unc/<replaceable>myserver</replaceable>/<replaceable>some</replaceable>/<replaceable>file</replaceable></filename>.
For example, if you used Samba to mount
- <filename>\\myserver\some</filename> on
- <filename>/mnt/smb/myserver/some</filename> then you can do
- <programlisting>
- ln -s /mnt/smb/myserver/some unc/myserver/some
- </programlisting>
+ <filename class="directory">\\<replaceable>myserver</replaceable>\<replaceable>some</replaceable></filename> on
+ <filename
+ class="directory">/mnt/smb/<replaceable>myserver</replaceable>/<replaceable>some</replaceable></filename>
+ then you can do
+ <screen>
+ ln -s /mnt/smb/<replaceable>myserver</replaceable>/<replaceable>some</replaceable> unc/<replaceable>myserver</replaceable>/<replaceable>some</replaceable>
+ </screen>
- to make it available in wine (don't forget to create the unc
- directory if it doesn't already exist).
+ to make it available in Wine (don't forget to create the <filename
+ class="directory">unc</filename> directory if it doesn't already exist).
</para>
</sect2>
<sect2>
@@ -636,7 +636,7 @@
Font configuration, once a nasty problem, is now much simpler.
If you have a collection of TrueType fonts in Windows it's
simply a matter of copying the <filename>.ttf</filename> files
- into <filename>c:\windows\fonts</filename>.
+ into <filename class="directory">c:\windows\fonts</filename>.
</para>
</sect2>
<sect2>
@@ -645,8 +645,8 @@
Wine can interact directly with the local CUPS printing system to
find the printers available on your system. Configuring
printers with Wine is as simple as making sure your CUPS
- configuration works. Wine still needs the command
- <userinput>lpr</userinput> (from CUPS), when printing a document.
+ configuration works. Wine still needs the
+ <command>lpr</command> command (from CUPS), when printing a document.
</para>
<para>
If you do not use CUPS, the old BSD-Printing system is used:
@@ -658,12 +658,13 @@
</listitem>
<listitem>
<para>
- Wine needs a PPD-File for every Printer (generic.ppd comes with Wine)
+ Wine needs a PPD file for every Printer (<filename>generic.ppd</filename>
+ comes with Wine).
</para>
</listitem>
<listitem>
<para>
- The command <userinput>lpr</userinput> is called when printing a document
+ The <command>lpr</command> command is called when printing a document
</para>
</listitem>
</itemizedlist>
@@ -673,12 +674,13 @@
<title>Scanners</title>
<para>
In Windows, scanners use the TWAIN API to access the underlying
- hardware. Wine's builtin TWAIN DLL simply forwards those requests
+ hardware. Wine builtin TWAIN DLL simply forwards those requests
to the Linux SANE libraries. So, to utilize your scanner under
Wine you'll first need to make sure you can access it using
- SANE. After that you'll need to make sure you have
- <filename>xscanimage</filename> available for use. Currently
- xscanimage is shipped with the sane-frontends package but it
+ SANE. After that you'll need to make sure you have
+ <command>xscanimage</command> available for use. Currently
+ <command>xscanimage</command> is shipped with the
+ <literal>sane-frontends</literal> package but it
may not be installed with your distribution. Scanner access
is currently known to have problems. If you find it works for
you, please consider updating this section of the user guide to
@@ -692,10 +694,11 @@
to hook across to the Unix system at a high level. Rather than
ensuring that all the windows code works under wine it uses a suitable
Unix ODBC provider, such as UnixODBC. Thus if you configure Wine to
- use the built-in odbc32.dll, that Wine DLL will interface to your
+ use the built-in <filename>odbc32.dll</filename>,
+ that Wine DLL will interface to your
Unix ODBC package and let that do the work, whereas if you configure
- Wine to use the native odbc32.dll it will try to use the native
- ODBC32 drivers etc.
+ Wine to use the native <filename>odbc32.dll</filename>
+ it will try to use the native ODBC32 drivers etc.
</para>
<sect3>
<title>Configuring ODBC on Unix</title>
@@ -712,32 +715,36 @@
</para>
<para>
The next step is to hook the Unix ODBC library to the wine built-in
- odbc32 DLL. The built-in odbc32 (currently) looks to the
- environment variable <emphasis>LIB_ODBC_DRIVER_MANAGER</emphasis>
- for the name of the ODBC library. For example in the author's
- .bashrc file is the line:
+ <filename>odbc32</filename> DLL. The built-in <filename>odbc32</filename> (currently)
+ looks to the environment variable
+ <envar>LIB_ODBC_DRIVER_MANAGER</envar> for the name of the ODBC
+ library. For example in the author's
+ <filename>.bashrc</filename> file is the line:
</para>
- <programlisting>
+ <screen>
export LIB_ODBC_DRIVER_MANAGER=/usr/lib/libodbc.so.1.0.0
- </programlisting>
+ </screen>
<para>
If that environment variable is not set then it looks for a
- library called libodbc.so and so you can add a symbolic link to
+ library called <filename>libodbc.so</filename> and so
+ you can add a symbolic link to
equate that to your own library. For example as root you could
run the commands:
</para>
- <programlisting>
- <prompt>$ </prompt><userinput>ln -s libodbc.so.1.0.0 /usr/lib/libodbc.so</userinput>
- <prompt>$ </prompt><userinput>/sbin/ldconfig</userinput>
- </programlisting>
+ <screen>
+ <prompt># </prompt><userinput>ln -s libodbc.so.1.0.0 /usr/lib/libodbc.so</userinput>
+ <prompt># </prompt><userinput>/sbin/ldconfig</userinput>
+ </screen>
<para>
The last step in configuring this is to ensure that Wine is set up
- to run the built-in version of odbc32.dll, by modifying the DLL
+ to run the built-in version of <filename>odbc32.dll</filename>,
+ by modifying the DLL
configuration. This built-in DLL merely acts as a stub between the
calling code and the Unix ODBC library.
</para>
<para>
- If you have any problems then you can use WINEDEBUG=+odbc32 command
+ If you have any problems then you can use
+ <userinput><envar>WINEDEBUG</envar>=+odbc32</userinput> command
before running wine to trace what is happening. One word of
warning. Some programs actually cheat a little and bypass the ODBC
library. For example the Crystal Reports engine goes to the registry
@@ -756,9 +763,10 @@
</para>
<para>
In order to set up MSSQL support you will first need to download
- and run the mdac_typ.exe installer from microsoft.com. In order to
- configure your ODBC connections you must then run CLICONFG.EXE and
- ODBCAD32.EXE under Wine. You can find them in the windows\system
+ and run the <command>mdac_typ.exe</command> installer from microsoft.com. In order to
+ configure your ODBC connections you must then run <command>CLICONFG.EXE</command>
+ and <command>ODBCAD32.EXE</command> under Wine. You can find them in the
+ <filename class="directory">windows\system</filename>
directory after mdac_typ runs. Compare the output of these programs
with the output on a native Windows machine. Some things, such
as protocols, may be missing because they rely on being installed
diff --git a/en/wineusr-getting.sgml b/en/wineusr-getting.sgml
index ef8a13d..98878e0 100644
--- a/en/wineusr-getting.sgml
+++ b/en/wineusr-getting.sgml
@@ -20,9 +20,9 @@
</para>
<para>
Packages are the recommended method for installing Wine. We make
- them easily available at the
- <ulink url="http://www.winehq.org/site/download">WineHQ downloads page
- </ulink>, and these are always the latest packages available. Being
+ them easily available at the <ulink
+ url="http://www.winehq.org/site/download">WineHQ downloads page</ulink>,
+ and these are always the latest packages available. Being
popular, Wine packages can also be found elsewhere in official
distribution repositories. These can, however, sometimes be out of
date, depending on the distribution. Packages are easily upgradable
@@ -41,16 +41,16 @@
perhaps you want to build wine using your own compiler optimizations
or with some options disabled, or perhaps you need to modify a
specific part of the source code before compilation. Being an open
- source project, you are free to do all of these things with Wine's
+ source project, you are free to do all of these things with Wine
source code, which is provided with every Wine release. This method
of installation can be done by downloading a Wine source archive and
compiling from the command line. If you are comfortable with such
things and have special needs, this option may be for you.
</para>
<para>
- Getting Wine source archives is simple. Every release, we put a
- source package in compressed tar.bz2 format at the
- <ulink url="http://www.winehq.org/site/download">WineHQ downloads
+ Getting Wine source archives is simple. Every release, we put a
+ source package in compressed <filename>tar.bz2</filename> format
+ at the <ulink url="http://www.winehq.org/site/download">WineHQ downloads
page</ulink>. Compiling and installing Wine from source is slightly
more difficult than using a package, however we will cover it in
depth and attempt to hold your hand along the way.
@@ -93,8 +93,8 @@
should upgrade and replace them automatically. If you installed
Wine from source code, however, you should remove it before
installing a Wine package. See the section on <link
- linkend="uninstalling-wine-source">uninstalling Wine from source
- </link> for proper instructions.
+ linkend="uninstalling-wine-source">uninstalling Wine from source</link>
+ for proper instructions.
</para>
</sect2>
<sect2>
@@ -137,7 +137,7 @@
<para>
Wine makes use of many open source libraries during its operation.
While Wine is not strictly dependent on these libraries and will
- compile without most of them, much of Wine's functionality is
+ compile without most of them, much of Wine functionality is
improved by having them available at compile time. In the past,
many user problems were caused by people not having the necessary
development libraries when they built Wine from source; because of
@@ -148,12 +148,13 @@
<para>
If you wish to install build dependencies by hand, there are several
ways to see if you're missing some useful development libraries.
- The most straightforward approach is to watch the configure program's
- output before you compile Wine and see if anything important is
- missing; if it is, simply install what's missing and rerun configure
- before compiling. You can also check the file configure generates,
- (include/config.h) and see if what files configure is looking for
- but not finding.
+ The most straightforward approach is to watch the output of
+ <command>configure</command> before you compile Wine and see if anything
+ important is missing; if it is, simply install what's missing and rerun
+ <command>configure</command> before compiling. You can also check the file
+ <command>configure</command> generates (<filename
+ class="headerfile">include/config.h</filename>) and see what files
+ <command>configure</command> is looking for but not finding.
</para>
</sect2>
<sect2 id="compiling-wine">
@@ -184,7 +185,7 @@
This command will require root privileges, and should remove all of
the Wine binary files from your system. It will not, however,
remove your Wine configuration and applications located in your
- user's home directory, so you are free to install another version of
+ user home directory, so you are free to install another version of
Wine or delete that configuration by hand.
</para>
</sect2>
diff --git a/en/wineusr-glossary.sgml b/en/wineusr-glossary.sgml
index 247cb69..a90d702 100644
--- a/en/wineusr-glossary.sgml
+++ b/en/wineusr-glossary.sgml
@@ -30,7 +30,8 @@ EXAMPLE:
<glossterm>Distribution</glossterm>
<glossdef>
<para>
- A distribution is usually the way in which some "vendor" ships operating system CDs (usually mentioned in the context of Linux).
+ A distribution is usually the way in which some <quote>vendor</quote> ships operating system CDs
+ (usually mentioned in the context of Linux).
A Linux environment can be shipped in lots of different configurations: e.g. distributions could be built to be suitable for games, scientific
applications, server operation, desktop systems, etc.
</para>
@@ -55,11 +56,14 @@ EXAMPLE:
Linux.
</para>
<para>
- Examples of graphical editors are: nedit, gedit, kedit, xemacs,
- gxedit.
+ Examples of graphical editors are: <command>nedit</command>,
+ <command>gedit</command>, <command>kedit</command>,
+ <command>xemacs</command>, <command>gxedit</command>.
</para>
<para>
- Examples of text mode editors are: joe, ae, emacs, vim, vi.
+ Examples of text mode editors are: <command>joe</command>,
+ <command>ae</command>, <command>emacs</command>, <command>vim</command>,
+ <command>vi</command>.
In a <glossterm>terminal</glossterm>, simply run them via:
</para>
<screen>
diff --git a/en/wineusr-introduction.sgml b/en/wineusr-introduction.sgml
index 94051e5..c510b45 100644
--- a/en/wineusr-introduction.sgml
+++ b/en/wineusr-introduction.sgml
@@ -30,7 +30,7 @@
believe that something can be explained better, you can file
a <ulink url="http://bugs.winehq.org/">bug report</ulink>
or <ulink url="http://wiki.winehq.org/SubmittingPatches">post
- a patch</ulink> on Wine's documentation itself.
+ a patch</ulink> on Wines documentation itself.
</para>
</sect2>
@@ -70,16 +70,15 @@
</listitem>
<listitem>
<para>
- Optionally configure wine using the <link
- linkend="config-wine-main"><emphasis><filename>winecfg</filename></emphasis>
- </link> command. Wine should work without any
- additional configuration options.
+ Optionally configure wine using the <link
+ linkend="config-wine-main"><command>winecfg</command></link> command.
+ Wine should work without any additional configuration options.
</para>
</listitem>
<listitem>
<para>
- To test your installation run wine's notepad clone
- using the <filename>wine notepad</filename> command.
+ To test your installation run Wine notepad clone
+ using the <userinput>wine notepad</userinput> command.
</para>
</listitem>
<listitem>
@@ -91,13 +90,13 @@
</listitem>
<listitem>
<para>
- Run wine using the <link
- linkend="running"><emphasis><filename>wine</filename>
- <filename>filespec/appname.exe</filename></emphasis></link> command.
+ Run Wine using the <link
+ linkend="running"><userinput>wine
+ <replaceable>filespec</replaceable>/<replaceable>appname.exe</replaceable></userinput></link> command.
</para>
<para>
The first command you will run will be to install an application.
- Typically something like <command>wine /media/cdrom/setup.exe</command>
+ Typically something like <userinput>wine /media/cdrom/setup.exe</userinput>
or the equivalent path might be used
to install an application from CD.
</para>
@@ -127,7 +126,7 @@
This situation presents a fundamental problem for anyone who
wants to run software for both Windows and Linux. A common
solution to this problem is to install both operating systems on
- the same computer, known as "dual booting." When a Windows
+ the same computer, known as <quote>dual booting</quote>. When a Windows
program is needed, the user boots the machine into Windows to
run it; when a Linux program is then needed, the user then
reboots the machine into Linux. This option presents great
@@ -157,7 +156,7 @@
to the window manager using the standard X11 protocol.
</para>
<para>
- If you have access to the Windows program's source code, Wine
+ If you have access to the Windows program source code, Wine
can also be used to recompile a program into a format that Linux
can understand more easily. Wine is still needed to launch the
program in its recompiled form, however there are many advantages
@@ -217,8 +216,8 @@
</listitem>
<listitem>
<para>
- Printing: PostScript interface driver (psdrv) to standard
- Unix PostScript print services
+ Printing: PostScript interface driver (<literal>psdrv</literal>) to standard
+ Unix PostScript print services
</para>
</listitem>
<listitem>
diff --git a/en/wineusr-running.sgml b/en/wineusr-running.sgml
index 51fcd4b..65d7cbd 100644
--- a/en/wineusr-running.sgml
+++ b/en/wineusr-running.sgml
@@ -13,7 +13,7 @@
Applications are installed under Wine the same way you would
in Windows: by running the installer. You can just accept the
defaults for where to install, most installers will default to
- "C:\Program Files", which is fine. If the application
+ <filename class="directory">C:\Program Files</filename>, which is fine. If the application
installer requests it, you may find that Wine creates icons on
your desktop and in your app menu. If that happens, you can
start the app by clicking on them.
@@ -21,11 +21,11 @@
<para>
The standard way to uninstall things is for the application to
- provide an uninstaller, usually registered with the "Add/Remove
- Programs" control panel applet.
+ provide an uninstaller, usually registered with the <quote>Add/Remove
+ Programs</quote> control panel applet.
To access the Wine equivalent, run the <command>uninstaller</command>
program (it is located in the
- <filename>programs/uninstaller/</filename> directory in a Wine
+ <filename class="directory">programs/uninstaller/</filename> directory in a Wine
source directory) in a <glossterm>terminal</glossterm>:
</para>
@@ -41,7 +41,7 @@
</para>
<screen>
- <prompt>$</prompt> <userinput>wine control</userinput>
+ <prompt>$</prompt> <userinput>wine control</userinput>
</screen>
<para>
@@ -56,15 +56,15 @@
</para>
<screen>
- <prompt>$</prompt> <userinput>wine "c:\program files\appname\appname.exe"</userinput>
+ <prompt>$</prompt> <userinput>wine "C:\Program Files\<replaceable>appname</replaceable>\<replaceable>appname.exe</replaceable>"</userinput>
</screen>
<para>
will probably do the trick. The path isn't case sensitive, but
remember to include the double quotes. Some programs don't
- always use obvious naming for their directories and EXE files,
- so you might have to look inside the program files directory to
- see what was put where.
+ always use obvious naming for their directories and executable files,
+ so you might have to look inside the <filename class="directory">Program Files</filename>
+ directory to see what was put where.
</para>
</sect1>
@@ -76,20 +76,20 @@
get a small help message:
</para>
<para>
- <screen>
+ <programlisting>
Usage: wine PROGRAM [ARGUMENTS...] Run the specified program
wine --help Display this help and exit
wine --version Output version information and exit
- </screen>
+ </programlisting>
</para>
<para>
The first argument should be the name of the file you
want <command>wine</command> to execute. If the executable is
- in the <parameter>Path</parameter> environment variable, you can
+ in the <envar>Path</envar> environment variable, you can
simply give the executable file name. However, if the executable
- is not in <parameter>Path</parameter>, you must give the full path to
- the executable. For example, given a <parameter>Path</parameter>
+ is not in <envar>Path</envar>, you must give the full path to
+ the executable. For example, given a <envar>Path</envar>
of the following:
</para>
<screen>
@@ -110,7 +110,7 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
<prompt>$</prompt> <userinput>wine c:\\myapps\\foo.exe</userinput>
</screen>
<para>
- (note the backslash-escaped "\" !)
+ (note the backslash-escaped '\')
or:
</para>
<screen>
@@ -127,11 +127,11 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
<para>
If you prefer using a graphical interface to manage your
- files you might want to consider using Winefile. This Winelib
+ files you might want to consider using <command>winefile</command>. This Winelib
application comes with Wine and can be found with the other
Wine programs. It is a useful way to view your drive configuration
and locate files, plus you can execute programs directly from
- Winefile. Please note, many functions are not yet implemented.
+ <command>winefile</command>. Please note that many functions are not yet implemented.
</para>
</sect1>
@@ -139,14 +139,14 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
<title>Wine Command Line Options</title>
<sect2>
- <title>--help</title>
+ <title><option>--help</option></title>
<para>
Shows a small command line help page.
</para>
</sect2>
<sect2>
- <title>--version</title>
+ <title><option>--version</option></title>
<para>
Shows the Wine version string. Useful to verify your installation.
</para>
@@ -156,7 +156,7 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
<sect1>
<title>Environment variables</title>
<sect2>
- <title>WINEDEBUG=[channels]</title>
+ <title><envar>WINEDEBUG</envar>=<replaceable>channels</replaceable></title>
<para>
Wine isn't perfect, and many Windows applications still
don't run without bugs under Wine (but then, a lot of programs
@@ -172,19 +172,19 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
messages to a file and examine it at your leisure. But be
forewarned! Some debug channels can generate incredible
volumes of log messages. Among the most prolific offenders
- are <parameter>relay</parameter> which spits out a log
+ are <literal>relay</literal> which spits out a log
message every time a win32 function is called,
- <parameter>win</parameter> which tracks windows message
- passing, and of course <parameter>all</parameter> which is
+ <literal>win</literal> which tracks windows message
+ passing, and of course <literal>all</literal> which is
an alias for every single debug channel that exists. For a
complex application, your debug logs can easily top 1 MB and
- higher. A <parameter>relay</parameter> trace can often
+ higher. A <literal>relay</literal> trace can often
generate more than 10 MB of log messages, depending on how
long you run the application. (You'll want to check out
- RelayExclude registry key to
- modify what the <parameter>relay</parameter> trace reports).
+ <literal>RelayExclude</literal> registry key to
+ modify what the <literal>relay</literal> trace reports).
Logging does slow down Wine
- quite a bit, so don't use <parameter>WINEDEBUG</parameter>
+ quite a bit, so don't use <envar>WINEDEBUG</envar>
unless you really do want log files.
</para>
<para>
@@ -193,20 +193,21 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
different severities of errors. The four message classes
are:
<simplelist type="inline">
- <member><parameter>trace</parameter></member>
- <member><parameter>fixme</parameter></member>
- <member><parameter>warn</parameter></member>
- <member><parameter>err</parameter></member>
+ <member><literal>trace</literal></member>
+ <member><literal>fixme</literal></member>
+ <member><literal>warn</literal></member>
+ <member><literal>err</literal></member>
</simplelist>.
</para>
<para>
To turn on a debug channel, use the form
- <parameter>class+channel</parameter>. To turn it off, use
- <parameter>class-channel</parameter>. To list more than one
- channel in the same <parameter>WINEDEBUG</parameter>
+ <literal><replaceable>class</replaceable>+<replaceable>channel</replaceable></literal>.
+ To turn it off, use
+ <literal><replaceable>class</replaceable>-<replaceable>channel</replaceable></literal>.
+ To list more than one channel in the same <envar>WINEDEBUG</envar>
option, separate them with commas. For example, to request
- <parameter>warn</parameter> class messages in the
- <parameter>heap</parameter> debug channel, you could invoke
+ <literal>warn</literal> class messages in the
+ <literal>heap</literal> debug channel, you could invoke
<command>wine</command> like this:
</para>
<screen>
@@ -228,23 +229,21 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
</screen>
<para>
You can find a list of the debug channels and classes at
- <ulink url="http://wiki.winehq.org/DebugChannels">
- DebugChannels</ulink>. More channels will be added to
- (or subtracted from) later versions.
+ <ulink url="http://wiki.winehq.org/DebugChannels">DebugChannels</ulink>.
+ More channels will be added to (or subtracted from) later versions.
</para>
<para>
For more details about debug channels, check out the
- <ulink url="http://www.winehq.org/docs/winedev-guide/">
- The Wine Developer's Guide</ulink>.
+ <ulink url="http://www.winehq.org/docs/winedev-guide/">The Wine Developer's Guide</ulink>.
</para>
</sect2>
<sect2>
- <title>WINEDLLOVERRIDES=[DLL Overrides]</title>
+ <title><envar>WINEDLLOVERRIDES</envar>=<replaceable>DLL Overrides</replaceable></title>
<para>
It's not always possible to run an application on builtin
DLLs. Sometimes native DLLs simply work better. Although
- these DLL overrides can be set using winecfg you might want
- to use the WINEDLLOVERRIDES environment variable to set them.
+ these DLL overrides can be set using <command>winecfg</command> you might want
+ to use the <envar>WINEDLLOVERRIDES</envar> environment variable to set them.
</para>
<para>
Examples:
@@ -253,24 +252,26 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
<prompt>$</prompt> <userinput>WINEDLLOVERRIDES="comdlg32,shell32=n,b" wine <replaceable>program_name</replaceable></userinput>
</screen>
<para>
- Try to load comdlg32 and shell32 as native windows dll first and try
- the builtin version if the native load fails.
+ Try to load <filename>comdlg32</filename> and <filename>shell32</filename> as native
+ windows DLLs first and try the builtin version if the native load fails.
</para>
<screen>
<prompt>$</prompt> <userinput>WINEDLLOVERRIDES="comdlg32,shell32=n;c:\\foo\\bar\\baz=b" wine <replaceable>program_name</replaceable></userinput>
</screen>
<para>
- Try to load the libraries comdlg32 and shell32 as native windows dlls.
- Furthermore, if an application request to load c:\foo\bar\baz.dll load
- the builtin library baz.
+ Try to load the libraries <filename>comdlg32</filename> and <filename>shell32</filename>
+ as native windows DLLs. Furthermore, if an application requests to load
+ <filename>c:\foo\bar\baz.dll</filename> load
+ the builtin library <filename>baz</filename>.
</para>
<screen>
<prompt>$</prompt> <userinput>WINEDLLOVERRIDES="comdlg32=b,n;shell32=b;comctl32=n;oleaut32=" wine <replaceable>program_name</replaceable></userinput>
</screen>
<para>
- Try to load comdlg32 as builtin first and try the native version if
- the builtin load fails; load shell32 always as builtin and comctl32
- always as native. Oleaut32 will be disabled.
+ Try to load <filename>comdlg32</filename> as builtin first and try the native version if
+ the builtin load fails; load <filename>shell32</filename> always as builtin and
+ <filename>comctl32</filename> always as native. <filename>oleaut32</filename> will be
+ disabled.
</para>
<para>
For more information about DLL overrides, please refer to the <link
@@ -278,14 +279,15 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
</para>
</sect2>
<sect2>
- <title>WINEARCH</title>
+ <title><envar>WINEARCH</envar></title>
<para>
Specifies the Windows architecture to support. It can be set either to
- win32 (support only 32-bit applications), or to win64
- (support both 64-bit applications and 32-bit ones in WoW64 mode).
+ <literal>win32</literal> (support only 32-bit applications), or to
+ <literal>win64</literal> (support both 64-bit applications and 32-bit
+ ones in WoW64 mode).
The architecture supported by a given Wine prefix is set at prefix
creation time and cannot be changed afterwards. When running with an
- existing prefix, Wine will refuse to start if WINEARCH doesn't match
+ existing prefix, Wine will refuse to start if <envar>WINEARCH</envar> doesn't match
the prefix architecture.
</para>
</sect2>
@@ -293,22 +295,23 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
<title>OSS Audio Driver Settings</title>
<para>
If you are using the OSS audio driver and you have multiple devices,
- (i.e. /dev/dsp*, /dev/mixer*) you can specify which one you want to
+ (i.e. <filename>/dev/dsp*</filename>, <filename>/dev/mixer*</filename>)
+ you can specify which one you want to
use with the following environment variables:
<itemizedlist>
<listitem>
<para>
- AUDIODEV=[audio device]
+ <userinput><envar>AUDIODEV</envar>=<replaceable>audio device</replaceable></userinput>
</para>
</listitem>
<listitem>
<para>
- MIXERDEV=[mixer device]
+ <userinput><envar>MIXERDEV</envar>=<replaceable>mixer device</replaceable></userinput>
</para>
</listitem>
<listitem>
<para>
- MIDIDEV=[MIDI device]
+ <userinput><envar>MIDIDEV</envar>=<replaceable>MIDI device</replaceable></userinput>
</para>
</listitem>
</itemizedlist>
@@ -323,50 +326,53 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
</sect1>
<sect1 id="wineserver-command-line-options">
- <title>wineserver Command Line Options</title>
+ <title><command>wineserver</command> Command Line Options</title>
<para>
- wineserver usually gets started automatically by Wine whenever
- the first wine process gets started.
- However, wineserver has some useful command line options that
+ <command>wineserver</command> usually gets started automatically by Wine whenever
+ the first wine process gets started.
+ However, <command>wineserver</command> has some useful command line options that
you can add if you start it up manually, e.g. via a user login
script or so.
</para>
<sect2 id="wineserver-config-parameter">
- <title>-d<n></title>
+ <title>-d <replaceable>n</replaceable></title>
<para>
- Sets the debug level for debug output in the terminal that
- wineserver got started in at level <n>.
- In other words: everything greater than 0 will enable
- wineserver specific debugging output.
+ Sets the debug level for debug output in the terminal that
+ <command>wineserver</command> got started in at level
+ <replaceable>n</replaceable>.
+ In other words: everything greater than 0 will enable
+ <command>wineserver</command> specific debugging output.
</para>
</sect2>
<sect2>
<title>-h</title>
<para>
- Display wineserver command line options help message.
+ Display <command>wineserver</command> command line options help message.
</para>
</sect2>
<sect2>
- <title>-k[n]</title>
+ <title>-k <optional><replaceable>n</replaceable></optional></title>
<para>
- Kill the current wineserver, optionally with signal n.
+ Kill the current <command>wineserver</command>, optionally with signal
+ <replaceable>n</replaceable>.
</para>
</sect2>
<sect2>
- <title>-p[n]</title>
+ <title>-p <optional><replaceable>n</replaceable></optional></title>
<para>
- This parameter makes wineserver persistent, optionally for n
- seconds. It will prevent wineserver from shutting down immediately.
- </para>
- <para>
- Usually, wineserver quits almost immediately after the last
- wine process using this wineserver terminated.
- However, since wineserver loads a lot of things on startup
+ This parameter makes <command>wineserver</command> persistent, optionally
+ for <replaceable>n</replaceable> seconds. It will prevent
+ <command>wineserver</command> from shutting down immediately.
+ </para>
+ <para>
+ Usually, <command>wineserver</command> quits almost immediately after the last
+ Wine process using this <command>wineserver</command> terminated.
+ However, since <command>wineserver</command> loads a lot of things on startup
(such as the whole Windows registry data), its startup might
be so slow that it's very useful to keep it from exiting after
the end of all Wine sessions, by making it persistent.
@@ -376,8 +382,8 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
<sect2>
<title>-w</title>
<para>
- This parameter makes a newly started wineserver wait until the
- currently active wineserver instance terminates.
+ This parameter makes a newly started <command>wineserver</command> wait until the
+ currently active <command>wineserver</command> instance terminates.
</para>
</sect2>
</sect1>
@@ -390,20 +396,19 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
In this case you need to set this environment variable in the
Linux shell, since Wine will pass on the entire shell environment
variable settings to the Windows environment variable space.
- Example for the bash shell (other shells may have a different syntax
- !):
+ Example for the <command>bash</command> shell (other shells may have a different syntax!):
<screen>
- export MYENVIRONMENTVAR=myenvironmentvarsetting
- </screen>
- This will make sure your Windows program can access the
- MYENVIRONMENTVAR environment variable once you start your program
- using Wine.
- If you want to have MYENVIRONMENTVAR set permanently, then you can
- place the setting into /etc/profile, or also ~/.bashrc in the case of
- bash.
+ export <envar>MYENVIRONMENTVAR</envar>=<replaceable>myenvironmentvarsetting</replaceable>
+ </screen>
+ This will make sure your Windows program can access the
+ <envar>MYENVIRONMENTVAR</envar> environment variable once you start your program using Wine.
+ If you want to have <envar>MYENVIRONMENTVAR</envar> set permanently, then you can
+ place the setting into <filename>/etc/profile</filename>, or also
+ <filename>~/.bashrc</filename> when using <command>bash</command>.
</para>
<para>Note however that there are some exceptions to the rule:
- If you want to change the PATH, SYSTEM or TEMP variables, then of course
+ If you want to change the <envar>PATH</envar>, <envar>SYSTEM</envar> or
+ <envar>TEMP</envar> variables, then of course
you can't modify it that way, since this will alter the Unix environment
settings. Instead, you should set them into the registry. To set them
you should launch <userinput>wine regedit</userinput> and then go to the
@@ -413,33 +418,31 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
<para>
<programlisting>"System" = "c:\\windows\\system"</programlisting>
This sets up where the windows system files are. The Windows
- system directory should reside below the directory used for the
+ system directory should reside below the directory used for the
<literal>Windows</literal> setting.
- Thus when using /usr/local/wine_c_windows as Windows path,
- the system directory would be
- <filename>/usr/local/wine_c/windows/system</filename>.
+ Thus when using <filename class="directory">/usr/local/wine_c_windows</filename>
+ as Windows path, the system directory would be
+ <filename class="directory">/usr/local/wine_c/windows/system</filename>.
It must be set with no trailing slash, and you must be sure that
you have write access to it.
</para>
<para>
<programlisting>"Temp" = "c:\\temp"</programlisting> This should
be the directory you want your temp files stored in,
- /usr/local/wine_c/temp in our previous example.
- Again, no trailing slash, and <emphasis>write
- access</emphasis>!!
+ <filename class="directory">/usr/local/wine_c/temp</filename> in our previous example.
+ Again, no trailing slash, and <emphasis>write access</emphasis>!!!
</para>
<para>
<programlisting>"Path" = "c:\\windows;c:\\windows\\system;c:\\blanco"</programlisting>
Behaves like the <envar>PATH</envar> setting on UNIX
- boxes. When wine is run like <userinput>wine
- sol.exe</userinput>, if <filename>sol.exe</filename>
- resides in a directory specified in the
- <literal>Path</literal> setting, wine will run it (Of
+ boxes. When wine is run like <userinput>wine sol.exe</userinput>, if
+ <filename>sol.exe</filename> resides in a directory specified in the
+ <literal>Path</literal> setting, wine will run it (of
course, if <filename>sol.exe</filename> resides in the
current directory, wine will run that one). Make sure it
- always has your <filename>windows</filename> directory and
- system directory (For this setup, it must have
- <filename>"c:\\windows;c:\\windows\\system"</filename>).
+ always has your <filename class="directory">windows</filename> directory
+ and system directory (for this setup, it must contain
+ <literal>"c:\\windows;c:\\windows\\system"</literal>).
</para>
</sect1>
@@ -467,20 +470,22 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
</listitem>
<listitem>
<para>
- wineconsole with user backend
+ <command>wineconsole</command> with <parameter>user</parameter> backend
</para>
</listitem>
<listitem>
<para>
- wineconsole with curses backend
+ <command>wineconsole</command> with <parameter>curses</parameter> backend
</para>
</listitem>
</itemizedlist>
</para>
- <para>The names here are a bit obscure. "bare streams" means
+ <para>
+ The names here are a bit obscure. <quote>bare streams</quote> means
that no extra support of wine is provided to map between the
unix console access and Windows console access. The two other
- ways require the use of a specific Wine program (wineconsole)
+ ways require the use of a specific Wine program
+ (<command>wineconsole</command>)
which provide extended facilities. The following table
describes what you can do (and cannot do) with those three
ways.
@@ -497,7 +502,7 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
</thead>
<tbody>
<row>
- <entry>How to run (assuming executable is called foo.exe)</entry>
+ <entry>How to run (assuming executable is called <filename>foo.exe</filename>)</entry>
<entry><msgtext>
<screen><prompt>$</prompt> <userinput>wine foo.exe</userinput></screen>
</msgtext></entry>
@@ -506,7 +511,7 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
</msgtext></entry>
<entry><msgtext>
<screen><prompt>$</prompt> <userinput>wineconsole foo.exe</userinput></screen>
- </msgtext>You can also use --backend=curses as an option</entry>
+ </msgtext>You can also use <userinput>--backend=curses</userinput> as an option</entry>
</row>
<row>
<entry>Good support for line oriented CUI applications
@@ -536,12 +541,12 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
standard Unix streams (stdin/stdout/stderr)
</entry>
<entry>
- Wineconsole will create a new Window (hence
+ <command>wineconsole</command> will create a new Window (hence
requiring the USER32 DLL is available) where all
information will be displayed
</entry>
<entry>
- Wineconsole will use existing unix console
+ <command>wineconsole</command> will use existing unix console
(from which the program is run) and with the help of
the (n)curses library take control of all the terminal
surface for interacting with the user
@@ -563,8 +568,8 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
<sect2 id="CUI-programs-config">
<title>Configuration of CUI executables</title>
<para>
- When wineconsole is used, several configuration options are
- available. Wine (as Windows do) stores, on a per application
+ When <command>wineconsole</command> is used, several configuration options are
+ available. Wine (as Windowses do) stores, on a per application
basis, several options in the registry. This let a user, for
example, define the default screen-buffer size he would like
to have for a given application.
@@ -581,7 +586,8 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
Default: this will edit the settings shared by all
applications which haven't been configured yet. So,
when an application is first run (on your machine,
- under your account) in wineconsole, wineconsole will
+ under your account) in <command>wineconsole</command>,
+ <command>wineconsole</command> will
inherit this default settings for the
application. Afterwards, the application will have its
own settings, that you'll be able to modify at your will.
@@ -624,7 +630,7 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
</thead>
<tbody>
<row>
- <entry>Cursor's size</entry>
+ <entry>Cursor size</entry>
<entry>
Defines the size of the cursor. Three options are
available: small (33% of character height), medium
@@ -634,11 +640,11 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
<row>
<entry>Popup menu</entry>
<entry>
- It's been said earlier that wineconsole
+ It's been said earlier that <command>wineconsole</command>
configuration popup was triggered using a right
click in the console's window. However, this can
be an issue when the application you run inside
- wineconsole expects the right click events to be
+ <command>wineconsole</command> expects the right click events to be
sent to it. By ticking control or shift you select
additional modifiers on the right click for
opening the popup. For example, ticking shift will
@@ -694,7 +700,7 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
<row>
<entry>Close on exit</entry>
<entry>
- If it's ticked, then the wineconsole will exit
+ If it's ticked, then the <command>wineconsole</command> will exit
when the application within terminates. Otherwise,
it'll remain opened until the user manually closes
it: this allows seeing the latest information of a
@@ -710,17 +716,18 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
choose between several edition modes:
<itemizedlist>
<listitem>
- <para>
- Emacs: the same keybindings as under
- emacs are available. For example, Ctrl-A
- will bring the cursor to the beginning
- of the edition line. See your emacs
- manual for the details of the commands.
- </para>
+ <para>
+ <literal>Emacs</literal>: the same keybindings as under
+ <command>emacs</command> are available. For example,
+ <keycombo><keycap>Ctrl</keycap><keycap>A</keycap></keycombo>
+ will bring the cursor to the beginning
+ of the edition line. See your <command>emacs</command>
+ manual for the details of the commands.
+ </para>
</listitem>
<listitem>
<para>
- Win32: these are the standard Windows
+ <literal>Win32</literal>: these are the standard Windows
console key-bindings (mainly using
arrows).
</para>
--
1.8.3.4
More information about the wine-patches
mailing list