Skip to content

W
wine-cw
Commit 5ec74d6f authored by Andreas Mohr's avatar Andreas Mohr Committed by Alexandre Julliard
Browse files
Options

- Move "questions and comments" at the top of the document.

- Removed elfdll documentation. - Properly documented Desktop and Managed config. - Rearranged config entries according to importance. - "wine.conf" -> "the wine config file" in some cases. - Updated to new FTP URLs. - Fix non-backslash-escaped paths (ouch !). - Replace text references by real links. - Misc. other updates.
parent e1ae23e0
Expand all Show whitespace changes
Inline Side-by-side
Showing with 95 additions and 77 deletions
documentation/authors.ent
View file @ 5ec74d6f
......@@ -13,6 +13,9 @@
-->
<!entity name-web-admin "WineHQ Web-Admin">
<!entity email-web-admin "web-admin@winehq.com">
<!entity name-jonathan-buzzard "Jonathan Buzzard">
<!entity email-jonathan-buzzard "jab@hex.prestel.co.uk">
......@@ -112,5 +115,3 @@
<!entity name-koen-deforche "Koen Deforche">
<!entity email-koen-deforche "jozef@kotnet.org">
documentation/bugs.sgml
View file @ 5ec74d6f
......@@ -210,17 +210,6 @@
</listitem>
</orderedlist>
</sect2>
<sect2>
<title>Questions and comments</title>
<para>
If after reading this document there is something you
couldn't figure out, or think could be explained better, or
that should have been included, please post to
<ulink url="http://bugs.winehq.com/">Wine Bugzilla</ulink> to
let us know how this document can be improved.
</para>
</sect2>
</sect1>
</chapter>
......
documentation/consoles.sgml
View file @ 5ec74d6f
......@@ -236,10 +236,10 @@ wine -console ncurses+xterm &lt;application&gt;
</sect3>
<sect3>
<title>II. <filename>wine.conf</filename> Configuration</title>
<title>II. wine config file configuration</title>
<para>
In the <filename>wine.conf</filename> file, you can create
In the wine config file, you can create
a section called [console] that contains configuration
options that are respected by the assorted console
drivers.
......@@ -370,7 +370,7 @@ wine -console ncurses+xterm &lt;application&gt;
As X terminals typically use a 24x80 screen resolution
rather than the typical 25x80 one, it is necessary to
resize the screen to allow a DOS program to work
full-screen. There is a <filename>wine.conf</filename>
full-screen. There is a wine config file
option to work around this in some cases but run-time
resizing will be disabled.
</para>
......
documentation/debugging.sgml
View file @ 5ec74d6f
......@@ -760,7 +760,7 @@ HRSRC16 WINAPI FindResource16( HMODULE16 hModule, SEGPTR name, SEGPTR type )
<listitem>
<para>
for messages intended for the user (specifically those that
report errors in <filename>wine.conf</filename>), use the
report errors in the wine config file), use the
<literal>MSG</literal> macro. Use it like a
<function>printf</function>:
<programlisting>
......
documentation/fonts.sgml
View file @ 5ec74d6f
......@@ -398,7 +398,7 @@ Resolution = &lt;integer value&gt;
<orderedlist>
<listitem>
<para>Get <filename>freetype-1.0.full.tar.gz</filename></para>
<para>Get a freetype source archive (<filename>freetype-X.Y.tar.gz</filename> ?).</para>
</listitem>
<listitem>
<para>Read docs, unpack, configure and install</para>
......@@ -485,7 +485,7 @@ FontPath "tcp/localhost:7100"
</para>
</listitem>
<listitem>
<para>Test with e.g <command>xlsfont | grep arial</command></para>
<para>Test with e.g. <command>xlsfont | grep arial</command></para>
</listitem>
</orderedlist>
......
documentation/getting.sgml
View file @ 5ec74d6f
......@@ -25,7 +25,7 @@
linkend="getting-dist-other">other</link> distributions.
</para>
<para>
If you're not lucky enough to have an available package for
If you're not lucky enough to have a package available for
your operating system, or if you'd prefer a newer version of
Wine than already exists as a package, you may have to
download the Wine source code and compile it yourself on your
......@@ -33,7 +33,7 @@
especially with the many helpful tools that come with Wine.
You don't need any programming experience to compile and
install Wine, although it might be nice to have some minor
UNIX administrative skill. We'll cover how to retrieve and
UNIX administrative skills. We'll cover how to retrieve and
compile the official source releases from the <link
linkend="getting-source-ftp">FTP archives</link>, and also how
to get the cutting edge up-to-the-minute fresh Wine source
......@@ -160,7 +160,7 @@ $ su -
<para>
The safest way to grab the source is from one of the official
FTP archives. An up to date listing is in the <ulink
url="http://www.winehq.com/source/ANNOUNCE">ANNOUNCE </ulink>
url="http://www.winehq.com/source/ANNOUNCE">ANNOUNCE</ulink>
file in the Wine distribution (which you would have if you
already downloaded it). Here is a (possibly out of date) list
of FTP servers carrying Wine:
......@@ -168,22 +168,22 @@ $ su -
<itemizedlist>
<listitem>
<para>
<ulink url="ftp://metalab.unc.edu/pub/Linux/ALPHA/wine/development/">
ftp://metalab.unc.edu/pub/Linux/ALPHA/wine/development/
<ulink url="ftp://ftp.ibiblio.org/pub/Linux/ALPHA/wine/development/">
ftp://ftp.ibiblio.org/pub/Linux/ALPHA/wine/development/
</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="ftp://tsx-11.mit.edu/pub/linux/ALPHA/Wine/development/">
ftp://tsx-11.mit.edu/pub/linux/ALPHA/Wine/development/
<ulink url="ftp://ftp.infomagic.com/pub/mirrors/linux/sunsite/ALPHA/wine/development/">
ftp://ftp.infomagic.com/pub/mirrors/linux/sunsite/ALPHA/wine/development/
</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="ftp://ftp.infomagic.com/pub/mirrors/linux/sunsite/ALPHA/wine/development/">
ftp://ftp.infomagic.com/pub/mirrors/linux/sunsite/ALPHA/wine/development/
<ulink url="ftp://sunsite.informatik.rwth-aachen.de/pub/Linux/sunsite.unc.edu/ALPHA/wine/development/">
ftp://sunsite.informatik.rwth-aachen.de/pub/Linux/sunsite.unc.edu/ALPHA/wine/development/
</ulink>
</para>
</listitem>
......@@ -237,13 +237,13 @@ $ cvs checkout wine
the updates:
</para>
<screen>
$ cvs -dP update
$ cvs -PAd update
</screen>
<para>
<command>cvs update</command> works from inside the source tree.
You don't need the <envar>CVSROOT</envar> environment variable
to run it either. You just have to be inside the source tree.
The <parameter>-d</parameter> and <parameter>-P</parameter>
The <parameter>-P</parameter>, <parameter>-A</parameter> and <parameter>-d</parameter>
options make sure your local Wine tree directory structure stays
in sync with the remote repository.
</para>
......
documentation/installing.sgml
View file @ 5ec74d6f
......@@ -72,7 +72,8 @@
paths, class IDs, and more; it must be installed before most
<filename>INSTALL.EXE</filename> or
<filename>SETUP.EXE</filename> applications will work. The
registry is covered in more detail in an earlier article.
registry is covered in more detail <link
linkend="registry">here</link>.
</para>
</sect2>
......@@ -134,9 +135,9 @@ C:\ Root directory of primary disk drive
file existence to determine whether a particular feature
(such as Winsock and its TCP/IP networking) is available. If
this is a problem for you, you can create empty files in the
<filename>system</filename> directory to make the
application think it's there, and Wine's built-in DLL will
be loaded when the application actually asks for it.
configured <filename>c:\windows\system</filename> directory
to make the application think it's there, and Wine's built-in DLL
will be loaded when the application actually asks for it.
(Unfortunately, <filename>tools/wineinstall</filename> does
not create such empty files itself.)
</para>
......@@ -242,10 +243,10 @@ C:\ Root directory of primary disk drive
<listitem>
<para>
Run the application with <parameter>--debugmsg
+module,+file</parameter> to find out which files are
+loaddll</parameter> to find out which files are
needed. Copy the required DLLs one by one to the
<filename>C:\windows\system</filename> directory. Do not
copy KERNEL/KERNEL32, GDI/GDI32, or USER/USER32. These
copy KERNEL/KERNEL32, GDI/GDI32, USER/USER32 or NTDLL. These
implement the core functionality of the Windows API, and
the Wine internal versions must be used.
</para>
......
documentation/introduction.sgml
View file @ 5ec74d6f
......@@ -48,7 +48,7 @@
</footnote>
However, Wine makes it possible to run native Windows
applications alongside native Linux applications on a Linux
(or Solaris) system. You can share desktop space between MS
(or BSD or Solaris) system. You can share desktop space between MS
Word and GnuCash, overlapping their windows, iconizing them,
and even running them from the same launcher.
</para>
......@@ -98,6 +98,21 @@
<para>
</para>
</sect2>
<sect2>
<title>Burning questions and comments</title>
<para>
If during reading this document there is something you
can't figure out, or think could be explained better, or
that should have been included, please immediately mail to
&name-web-admin; <email>&email-web-admin</email> or
post a bug report at the
<ulink url="http://bugs.winehq.com/">Wine Bugzilla</ulink> to
let us know how this document can be improved.
Remember, Open Source is
"free as in free speech, not as in free beer":
it can only work in case of very active involvement of its users !
</para>
</sect2>
</sect1>
<!-- *** Not really useful as is, but may be able to recycle this elsewhere...
......@@ -142,7 +157,7 @@
<listitem>
<para>
a computer ;-) Wine: only PCs >= i386 are supported at
the moment. Winelib: other platforms might be
the moment. Winelib: other platforms may be
supported, but can be tricky.
</para>
</listitem>
......@@ -155,7 +170,7 @@
<listitem>
<para>
>= 16MB of RAM. Everything below is pretty much
unusable. >= 64 MB is needed for a "good" execution.
unusable. >= 64 MB is needed for "good" execution.
</para>
</listitem>
<listitem>
......@@ -163,7 +178,7 @@
an X11 window system (XFree86 etc.). Wine is prepared
for other graphics display drivers, but writing
support is not too easy. The text console display
driver is nearly usable.
driver (ttydrv) is nearly usable.
</para>
</listitem>
</itemizedlist>
......@@ -181,7 +196,7 @@
<itemizedlist>
<listitem>
<para>
Support for executing DOS, Win 3.x and Win9x/NT/Win2000
Support for executing DOS, Win 3.x and Win9x/NT/Win2000/XP
programs (most of Win32's controls are supported)
</para>
</listitem>
......
documentation/multimedia.sgml
View file @ 5ec74d6f
......@@ -820,7 +820,7 @@
occurs when the MCI procedures are initialised. Make sure that this is
not in the list from above. Try adding:
mci=CDAUDIO:SEQUENCER:WAVEAUDIO:AVIVIDEO:MPEGVIDEO
to the [options] section of wine.conf.
to the [options] section of the wine config file.
</para>
<para>TODO:
......@@ -977,7 +977,7 @@
<para>
The list of loadable (recognized) MCI drivers can be altered in the
[option] section of wine.conf, like:
[option] section of the wine config file, like:
mci=CDAUDIO:SEQUENCER:WAVEAUDIO:AVIVIDEO:MPEGVIDEO
</para>
......
documentation/packaging.sgml
View file @ 5ec74d6f
......@@ -813,6 +813,8 @@
This is the global Wine configuration file. It
is only used if the user running Wine has
no local configuration file.
Global wine configuration is currently not possible;
this might get reenabled at some time.
</para>
<para>
Some packagers feel that this file should not
......
documentation/printing.sgml
View file @ 5ec74d6f
......@@ -59,8 +59,7 @@
printer=on
</screen>
<para>
to the [wine] section of <filename>wine.conf</filename> (or
<filename>~/.wine/config</filename>). This lets
to the [wine] section of the wine config file. This lets
<function>CreateDC</function> proceed if its driver argument is a 16
bit driver. You will probably also need to add
</para>
......@@ -77,7 +76,7 @@ printer=on
<title>Spooling</title>
<para>
Spooling is rather primitive. The [spooler] section of
<filename>wine.conf</filename> maps a port (e.g.
the wine config file maps a port (e.g.
<systemitem>LPT1:</systemitem>) to a file or a command via a pipe. For
example the following lines
</para>
......@@ -133,7 +132,7 @@ printer=on
<title>Installation of LPR /etc/printcap based printers</title>
<para>
If your system is not yet using CUPS, it probably uses LPRng
or a LPR based system with configuration based on /etc/printcap.
or a LPR based system with configuration based on <filename>/etc/printcap</filename>.
</para>
<para>
If it does, your printers in <filename>/etc/printcap</filename>
......@@ -238,7 +237,7 @@ printer=on
</para>
<para>
Note that you need not set <literal>printer=on</literal> in
the [wine] section of <filename>wine.conf</filename>, this
the [wine] section of the wine config file, this
enables printing via external printer drivers and does not
affect the builtin PostScript driver.
</para>
......
documentation/registry.sgml
View file @ 5ec74d6f
......@@ -36,7 +36,7 @@
<term>HKEY_LOCAL_MACHINE</term>
<listitem>
<para>
This fundamental root key (in win9x, stored in the
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.
......@@ -47,7 +47,7 @@
<term>HKEY_USERS</term>
<listitem>
<para>
This fundamental root key (in win9x, stored in the
This fundamental root key (in win9x it's stored in the
hidden file <filename>user.dat</filename>) contains
configuration data for every user of the installation.
</para>
......@@ -149,9 +149,12 @@
<para>
All of these files are human-readable text files, so unlike
Windows, you can actually use an ordinary text editor on them
if you must.
if you want (make sure you don't have Wine running when modifying
them, otherwise your changes will be discarded).
</para>
<para>
FIXME: global config currently not implemented.
In addition to these files, Wine can also optionally load from
global registry files residing in the same directory as the
global <filename>wine.conf</filename> (i.e.
......@@ -248,7 +251,7 @@ ln -sf /usr/local/etc/wine.userreg wine.userreg
<para>
With the above information fresh in mind, let's look at the
<filename>wine.conf</filename>/<filename>~/.wine/config</filename>
<filename>wine.conf</filename> / <filename>~/.wine/config</filename>
options for handling the registry.
</para>
......@@ -295,12 +298,17 @@ ln -sf /usr/local/etc/wine.userreg wine.userreg
</listitem>
</varlistentry>
<varlistentry>
<term>UseNewFormat</term>
<term>SaveOnlyUpdatedKeys</term>
<listitem>
<para>
This option is obsolete. Wine now always uses the new
format; support for the old format was removed a while
ago.
Controls whether the entire registry is saved to the
user's registry files, or only subkeys the user have
actually changed. Considering that the user's registry
will override any global registry files and Windows
registry files, it usually makes sense to only save
user-modified subkeys; that way, changes to the rest of
the global or Windows registries will still affect the
user.
</para>
</listitem>
</varlistentry>
......@@ -316,17 +324,12 @@ ln -sf /usr/local/etc/wine.userreg wine.userreg
</listitem>
</varlistentry>
<varlistentry>
<term>SaveOnlyUpdatedKeys</term>
<term>UseNewFormat</term>
<listitem>
<para>
Controls whether the entire registry is saved to the
user's registry files, or only subkeys the user have
actually changed. Considering that the user's registry
will override any global registry files and Windows
registry files, it usually makes sense to only save
user-modified subkeys; that way, changes to the rest of
the global or Windows registries will still affect the
user.
This option is obsolete. Wine now always uses the new
format; support for the old format was removed a while
ago.
</para>
</listitem>
</varlistentry>
......
documentation/running.sgml
View file @ 5ec74d6f
......@@ -53,7 +53,7 @@ Options:
</para>
<screen>
[wine]
"Path"="c:\windows;c:\windows\system;e:\;e:\test;f:\"
"Path"="c:\\windows;c:\\windows\\system;e:\\;e:\\test;f:\\"
</screen>
<para>
You could run the file
......@@ -67,18 +67,20 @@ Options:
<filename>c:\myapps\foo.exe</filename> with this command:
</para>
<screen>
<prompt>$</prompt> <userinput>wine c:\myapps\foo.exe</userinput>
<prompt>$</prompt> <userinput>wine c:\\myapps\\foo.exe</userinput>
</screen>
<para>
(note the backslash-escaped "\" !)
</para>
<para>
If you want to run a console program (aka a CUI executable), use
<command>wineconsole</command> instead of <command>wine</command>
to start it. It will display the program in a separate Window
(this requires X11 to be run). If you don't, you'll still be able
to run able your program, in the Unix console were you're started
your program, but with very limited capacities (so, your program
might work, but your mileage may vary). This shall be improved
in the future.
to run your program directly in the Unix console where you started it,
but with very limited capacities (so your program might work,
but your mileage may vary). This shall be improved in the future.
</para>
</sect1>
......@@ -89,7 +91,7 @@ Options:
<title>--debugmsg [channels]</title>
<para>
Wine isn't perfect, and many Windows applications still
don't run without bugs under Wine (but then, many of them
don't run without bugs under Wine (but then, a lot of programs
don't run without bugs under native Windows either!). To
make it easier for people to track down the causes behind
each bug, Wine provides a number of <firstterm>debug
......@@ -155,7 +157,7 @@ Options:
</screen>
<para>
Here is a master list of all the debug channels and classes
in Wine. More channels might be added to (or subtracted
in Wine. More channels will be added to (or subtracted
from) later versions.
</para>
......@@ -245,21 +247,27 @@ winspool</><entry>wnet</><entry>x11</>
<sect2>
<title>--dll</title>
<para>
Specifies whether to load the builtin or the native (if
available) version of a DLL.
Example:
<screen>
<prompt>$</prompt> <userinput>wine --dll setupx=n foo.exe</userinput>
</screen>
See the <link linkend="dlls">DLL chapter</link> for more details.
</para>
</sect2>
<sect2>
<title>--help</title>
<para>
Shows a small command line help page.
</para>
</sect2>
<sect2>
<title>--version</title>
<para>
Shows the Wine version string. Useful to verify your installation.
</para>
</sect2>
</sect1>
......
documentation/winelib-porting.sgml
View file @ 5ec74d6f
......@@ -354,7 +354,7 @@ printf("Processor architecture=%d\n",si ANONS .wProcessorArchitecture);
</listitem>
</itemizedlist>
<para>
This may sound complex by Winemaker makes it simple. Just specify
This may sound complex but Winemaker makes it simple. Just specify
<option>--wrap</option> or <option>--mfc</option> on the command line
and it will adapt its makefiles to build the wrapper and the
application library.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment