Skip to content

W
wine-winehq
Commit a5589d56 authored by Andreas Mohr's avatar Andreas Mohr Committed by Alexandre Julliard
Browse files
Options

Documentation improvements.

parent 957f1f98
Show whitespace changes
Inline Side-by-side
Showing with 192 additions and 118 deletions
README
View file @ a5589d56
...@@ -86,10 +86,15 @@ are compiled with optimization, often due to problems with header file ...@@ -86,10 +86,15 @@ are compiled with optimization, often due to problems with header file
management. pgcc currently doesn't work with Wine. The cause of this problem management. pgcc currently doesn't work with Wine. The cause of this problem
is unknown. is unknown.
Of course you also need "make" (most likely GNU make).
You also need flex version 2.5 or later and yacc. You also need flex version 2.5 or later and yacc.
Bison will work as a replacement for yacc. If you are Bison will work as a replacement for yacc. If you are
using RedHat or Debian, install the flex and bison packages. using RedHat or Debian, install the flex and bison packages.
For the automatic processing of the test suite scripts, you also need
libperl development header support (libperl-dev package on Debian).
For requirements in case you intend to build the documentation yourself, For requirements in case you intend to build the documentation yourself,
see "DOCUMENTATION" section. see "DOCUMENTATION" section.
...@@ -217,9 +222,6 @@ Bugs: Report bugs to Wine Bugzilla at http://bugs.winehq.com/. ...@@ -217,9 +222,6 @@ Bugs: Report bugs to Wine Bugzilla at http://bugs.winehq.com/.
Please read the file documentation/bugs.sgml to see what Please read the file documentation/bugs.sgml to see what
information is required. information is required.
HOWTO: The Wine HOWTO (outdated !) is available at
http://www.westfalen.de/witch/wine-HOWTO.txt .
IRC: Online help is available at channel #WineHQ on irc.openprojects.net. IRC: Online help is available at channel #WineHQ on irc.openprojects.net.
CVS: The current Wine development tree is available through CVS. CVS: The current Wine development tree is available through CVS.
......
documentation/configuring.sgml
View file @ a5589d56
...@@ -180,64 +180,77 @@ ...@@ -180,64 +180,77 @@
<sect3> <sect3>
<title>The [Drive X] Section</title> <title>The [Drive X] Section</title>
<para> <para>
It should be pretty self explanatory, but here is an These sections are supposed to make certain Unix
in-depth tutorial about them. There are up to 6 lines for directory locations accessible to Wine as a DOS/Windows drive
each drive in Wine. (drive 'X:') and thus accessible to Windows programs
under the drive name you specified.
Every DOS/Windows program sort of expects at least a C: drive (and
sometimes also an A: floppy drive), so your config file should
at least contain the corresponding sections, [Drive C] and
[Drive A].
You need to decide on whether you want to use an existing Windows
partition as the C drive or whether you want to create your own
Wine drive C directory tree somewhere (take care about
permissions !).
Each drive section may specify up to 6 different settings
as explained below.
</para> </para>
<para> <para>
<programlisting>[Drive X]</programlisting> <programlisting>[Drive X]</programlisting>
The above line begins the section for a drive whose letter is X. The above line begins the section for a drive whose letter is X
</para> (DOS notation: drive 'X:').
<para> You could e.g. create an equivalent to a drive 'C:'
<programlisting>Path=/dir/to/path</programlisting> This under DOS/Windows by using a [Drive C] section name.
path is where the drive will begin. When Wine is browsing </para>
in drive X, it will see the files that are in the <para>
directory <filename>/dir/to/path</filename>. Don't forget <programlisting>"Path" = "/dir/to/path"</programlisting>
to leave off the trailing slash! This specifies the directory where the drive will begin.
</para> When Wine is browsing in drive X, it will be able
<para> to see the files that are in the directory
<programlisting>"Type" = "floppy|hd|cdrom|network"</programlisting> <filename>/dir/to/path</filename> and below.
(note that symlinks to directories won't get included !
see "<link linkend="dirsymlinks">ShowDirSymlinks</link>"
config setting)
You can also make use of environment variables like $HOME here,
an example for using a mywinedrive directory in your home dir
would be
"Path" = "${HOME}/mywinedrive"
Don't forget to leave off the trailing slash!
</para>
<para>
<programlisting>"Type" = "hd|cdrom|network|floppy"</programlisting>
Sets up the type of drive Wine will see it as. Type must Sets up the type of drive Wine will see it as. Type must
equal one of the four <literal>floppy</literal>, equal one of the four <literal>floppy</literal>,
<literal>hd</literal>, <literal>cdrom</literal>, or <literal>hd</literal>, <literal>cdrom</literal>, or
<literal>network</literal>. They are self-explanatory. <literal>network</literal>. They are self-explanatory.
(The |'s mean "Type = '&lt;one of the options&gt;'".) (The |'s mean "Type = '&lt;one of the options&gt;'".)
Usually, you choose "hd" for a drive ("hd" is default anyway).
</para> </para>
<para> <para>
<programlisting>"Label" = "blah"</programlisting> Defines the <programlisting>"Label" = "blah"</programlisting>
drive label. Generally only needed for programs that look Defines the drive label. Generally only needed
for a special CD-ROM. Info on finding the lable is in for programs that look for a special CD-ROM.
<literal>&lt;dirs to wine>/documentation/cdrom-labels</literal>.
The label may be up to 11 characters. The label may be up to 11 characters.
Note that the preferred way of managing labels and serial numbers
of CD-ROMs and floppies is to give Wine raw device access for
reading these on a per-CD case (see "Device" below) instead of
hardcoding one specific "Label".
</para> </para>
<para> <para>
<programlisting>"Serial" = "deadbeef"</programlisting> <programlisting>"Serial" = "deadbeef"</programlisting>
Tells Wine the serial number of the drive. A few programs with Tells Wine the serial number of the drive. A few programs with
intense protection for pirating might need this, but otherwise intense protection for pirating might need this, but otherwise
don't use it. Up to 8 characters and hexadecimal. it's not needed. Up to 8 characters and hexadecimal.
Using a "Device" entry instead of hardcoding the "Serial" probably
is a smarter choice.
</para> </para>
<para> <para>
<programlisting>"Filesystem" = "msdos|win95|unix"</programlisting> <programlisting>"Filesystem" = "win95|unix|msdos"</programlisting>
Sets up the way Wine looks at files on the drive. Sets up the way Wine looks at files on the drive.
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><literal>msdos</literal></term>
<listitem>
<para>
Case insensitive filesystem. Alike to DOS and
Windows 3.x. <literal>8.3</literal> is the maximum
length of files (eightdot.123) - longer ones will be
truncated. (NOTE: this is a very bad choice if you
plan on running apps that use long filenames. win95
should work fine with apps that were designed to run
under the msdos system. In other words, you might
not want to use this.)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>win95</literal></term> <term><literal>win95</literal></term>
<listitem> <listitem>
<para> <para>
...@@ -260,42 +273,62 @@ ...@@ -260,42 +273,62 @@
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><literal>msdos</literal></term>
<listitem>
<para>
Case insensitive filesystem. Alike to DOS and
Windows 3.x. <literal>8.3</literal> is the maximum
length of files (eightdot.123) - longer ones will be
truncated. (NOTE: this is a very bad choice if you
plan on running apps that use long filenames. win95
should work fine with apps that were designed to run
under the msdos system. In other words, you might
not want to use this.)
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
<programlisting>"Device" = "/dev/xx"</programlisting> <programlisting>"Device" = "/dev/xx"</programlisting>
<para> <para>
Needed for raw device access and label and serial number reading.
Use this ONLY for floppy and cdrom devices. Using it on Use this ONLY for floppy and cdrom devices. Using it on
Extended2 partitions can have dire results (when a windows Extended2 or other Unix file systems can have dire results
app tries to do a lowlevel write, they do it in a FAT way (when a windows app tries to do a lowlevel write,
-- FAT does not mix with Extended2). they do it in a FAT way -- FAT format is completely different from
any Unix file system).
Also, make sure that you have proper permissions to this device
file.
</para> </para>
<note> <note>
<para> <para>
This setting is not really important; almost all apps This setting is not really important; almost all apps
will have no problem if it remains unspecified. For will have no problem if it remains unspecified. For
CD-ROMs you might want to add it to get automatic label CD-ROMs it's quite useful in order to get automatic label
detection, though. If you are unsure about specifying detection, though. If you are unsure about specifying
device names, just leave out this setting for your device names, just leave out this setting for your
drives. drives.
</para> </para>
</note> </note>
<para> <para>
Here is a setup for Drive X, a generic hard drive: Here are a few sample entries:
<programlisting> <programlisting>
[Drive X] Here is a setup for Drive C, a generic hard drive:
"Path" = "/dos-a" [Drive C]
"Path" = "/dosc"
"Type" = "hd" "Type" = "hd"
"Label" = "Hard Drive" "Label" = "Hard Drive"
"Filesystem" = "win95" "Filesystem" = "win95"
This is a setup for Drive X, a generic CD-ROM drive: This is a setup for Drive E, a generic CD-ROM drive:
[Drive X] [Drive E]
"Path" = "/dos-d" "Path" = "/mnt/cdrom"
"Type" = "cdrom" "Type" = "cdrom"
"Label" = "Total Annihilation" "Label" = "Total Annihilation"
"Filesystem" = "win95" "Filesystem" = "win95"
"Device" = "/dev/hdc" "Device" = "/dev/cdrom"
And here is a setup for Drive X, a generic floppy drive: And here is a setup for Drive A, a generic floppy drive:
[Drive X] [Drive A]
"Type" = "floppy" "Type" = "floppy"
"Path" = "/mnt/floppy" "Path" = "/mnt/floppy"
"Label" = "Floppy Drive" "Label" = "Floppy Drive"
...@@ -310,31 +343,39 @@ And here is a setup for Drive X, a generic floppy drive: ...@@ -310,31 +343,39 @@ And here is a setup for Drive X, a generic floppy drive:
<title>The [wine] Section </title> <title>The [wine] Section </title>
<para> <para>
The [wine] section of the configuration file contains all kinds The [wine] section of the configuration file contains all kinds
of general settings for Wine. When specifying the directories of general settings for Wine.
for the directory related settings, make them as they would
appear in wine. If your drive <medialabel>C</medialabel>
has a path of <filename>/dos</filename>, and your
<filename>windows</filename> directory is located in
<filename>/dos/windows</filename>, then use:
<programlisting>"Windows" = "c:\\windows"</programlisting>
</para> </para>
<para> <para>
This sets up the <filename>windows</filename> directory. <programlisting>"Windows" = "c:\\windows"</programlisting>
Make one if you don't already have one. NO TRAILING SLASH This tells Wine and Windows programs where the
(NOT <filename>C:\\windows\</filename>)! <filename>Windows</filename> directory is. It is
recommended to have this directory somewhere on your
configured <medialabel>C</medialabel> drive, and it's also
recommended to just call the directory "windows" (this is
the default setup on Windows, and some stupid applications
might rely on this). So in case you chose a "Windows"
setting of "c:\\windows" and you chose to set up a drive C
e.g. at <filename>/usr/local/wine_c</filename>, the
corresponding directory would be
<filename>/usr/local/wine_c/windows</filename>. Make one
if you don't already have one. NO TRAILING SLASH (NOT
<filename>C:\\windows\</filename>)! Write access strongly
recommended!
</para> </para>
<para> <para>
<programlisting>"System" = "c:\\windows\\system"</programlisting> <programlisting>"System" = "c:\\windows\\system"</programlisting>
This sets up where the windows system files are. Should This sets up where the windows system files are. The Windows
reside in the directory used for the system directory should reside below the directory used for the
<literal>Windows</literal> setting. If you don't have <literal>Windows</literal> setting.
<filename>windows</filename> then this is where the system Thus when using the example above, the system directory would be
files will go. Again, NO TRAILING SLASH! <filename>/usr/local/wine_c/windows/system</filename>.
Again, no trailing slash, and write access!
</para> </para>
<para> <para>
<programlisting>"Temp" = "c:\\temp"</programlisting> This should <programlisting>"Temp" = "c:\\temp"</programlisting> This should
be the directory you want your temp files stored in. YOU be the directory you want your temp files stored in,
MUST HAVE WRITE ACCESS TO IT. /usr/local/wine_c/temp in our example.
Again, no trailing slash, and WRITE ACCESS!!
</para> </para>
<para> <para>
<programlisting> <programlisting>
...@@ -380,7 +421,7 @@ And here is a setup for Drive X, a generic floppy drive: ...@@ -380,7 +421,7 @@ And here is a setup for Drive X, a generic floppy drive:
making use of appropriate shell32.dll functionality to create making use of appropriate shell32.dll functionality to create
icons on the desktop/start menu during installation. icons on the desktop/start menu during installation.
</para> </para>
<para> <para id="dirsymlinks">
<programlisting>"ShowDirSymlinks" = "1"</programlisting> <programlisting>"ShowDirSymlinks" = "1"</programlisting>
Wine doesn't pass directory symlinks to Windows programs by Wine doesn't pass directory symlinks to Windows programs by
default, as doing so may crash some programs that do default, as doing so may crash some programs that do
...@@ -957,48 +998,6 @@ OPTIONAL: ...@@ -957,48 +998,6 @@ OPTIONAL:
</sect2> </sect2>
</sect1> </sect1>
<sect1 id="win95look">
<title>Win95/98 Look</title>
<para>
Written by &name-david-cuthbert; <email>&email-david-cuthbert;</email>
</para>
<para>
(Extracted from <filename>wine/documentation/win95look</filename>)
</para>
<para>
Win95/Win98 interface code is being introduced.
</para>
<para>
Instead of compiling Wine for Win3.1 vs. Win95 using
<constant>#define</constant> switches, the code now looks in a
special [Tweak.Layout] section of
<filename>~/.wine/config</filename> for a
<literal>"WineLook" = "Win95"</literal> or
<literal>"WineLook" = "Win98"</literal> entry.
</para>
<para>
A few new sections and a number of entries have been added to
the <filename>~/.wine/config</filename> file -- these are for
debugging the Win95 tweaks only and may be removed in a future
release! These entries/sections are:
</para>
<programlisting>
[Tweak.Fonts]
"System.Height" = "&lt;point size>" # Sets the height of the system typeface
"System.Bold" = "[true|false]" # Whether the system font should be boldfaced
"System.Italic" = "[true|false]" # Whether the system font should be italicized
"System.Underline" = "[true|false]" # Whether the system font should be underlined
"System.StrikeOut" = "[true|false]" # Whether the system font should be struck out
"OEMFixed.xxx" # Same parameters for the OEM fixed typeface
"AnsiFixed.xxx" # Same parameters for the Ansi fixed typeface
"AnsiVar.xxx" # Same parameters for the Ansi variable typeface
"SystemFixed.xxx" # Same parameters for the System fixed typeface
[Tweak.Layout]
"WineLook" = "[Win31|Win95|Win98]" # Changes Wine's look and feel
</programlisting>
</sect1>
<sect1 id="x11drv"> <sect1 id="x11drv">
<title>Configuring the x11drv Driver</title> <title>Configuring the x11drv Driver</title>
...@@ -1856,6 +1855,51 @@ OPTIONAL: ...@@ -1856,6 +1855,51 @@ OPTIONAL:
</sect2> </sect2>
</sect1> </sect1>
&fonts;
&printing;
<sect1 id="win95look">
<title>Win95/98 Look</title>
<para>
Written by &name-david-cuthbert; <email>&email-david-cuthbert;</email>
</para>
<para>
(Extracted from <filename>wine/documentation/win95look</filename>)
</para>
<para>
Win95/Win98 interface code is being introduced.
</para>
<para>
Instead of compiling Wine for Win3.1 vs. Win95 using
<constant>#define</constant> switches, the code now looks in a
special [Tweak.Layout] section of
<filename>~/.wine/config</filename> for a
<literal>"WineLook" = "Win95"</literal> or
<literal>"WineLook" = "Win98"</literal> entry.
</para>
<para>
A few new sections and a number of entries have been added to
the <filename>~/.wine/config</filename> file -- these are for
debugging the Win95 tweaks only and may be removed in a future
release! These entries/sections are:
</para>
<programlisting>
[Tweak.Fonts]
"System.Height" = "&lt;point size>" # Sets the height of the system typeface
"System.Bold" = "[true|false]" # Whether the system font should be boldfaced
"System.Italic" = "[true|false]" # Whether the system font should be italicized
"System.Underline" = "[true|false]" # Whether the system font should be underlined
"System.StrikeOut" = "[true|false]" # Whether the system font should be struck out
"OEMFixed.xxx" # Same parameters for the OEM fixed typeface
"AnsiFixed.xxx" # Same parameters for the Ansi fixed typeface
"AnsiVar.xxx" # Same parameters for the Ansi variable typeface
"SystemFixed.xxx" # Same parameters for the System fixed typeface
[Tweak.Layout]
"WineLook" = "[Win31|Win95|Win98]" # Changes Wine's look and feel
</programlisting>
</sect1>
<sect1 id="keyboard"> <sect1 id="keyboard">
<title>Keyboard</title> <title>Keyboard</title>
...@@ -2036,9 +2080,6 @@ diff -u the_backup_file_you_made dlls/x11drv/keyboard.c > layout.diff ...@@ -2036,9 +2080,6 @@ diff -u the_backup_file_you_made dlls/x11drv/keyboard.c > layout.diff
</para> </para>
</sect1> </sect1>
&fonts;
&printing;
</chapter> </chapter>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
......
documentation/fonts.sgml
View file @ a5589d56
...@@ -106,7 +106,8 @@ STUB: AddFontResource( SOMEFILE.FON ) ...@@ -106,7 +106,8 @@ STUB: AddFontResource( SOMEFILE.FON )
if you're on FreeBSD you can use the port in if you're on FreeBSD you can use the port in
<filename>/usr/ports/x11-servers/Xfstt</filename>. And <filename>/usr/ports/x11-servers/Xfstt</filename>. And
there is <command>xfsft</command> which uses the freetype there is <command>xfsft</command> which uses the freetype
library, see <filename>documentation/ttfserver</filename>). library, see <link linkend="ttfont-server">freetype</link>
description).
</para> </para>
<para> <para>
However, there is a possibility of the native TrueType However, there is a possibility of the native TrueType
......
documentation/implementation.sgml
View file @ a5589d56
...@@ -397,7 +397,7 @@ XXXX &gt; YY @ ZZZZ:ZZZZ ...@@ -397,7 +397,7 @@ XXXX &gt; YY @ ZZZZ:ZZZZ
0x37a &gt; 04 @ 0297:0211 0x37a &gt; 04 @ 0297:0211
</programlisting> </programlisting>
<para> <para>
As you can see their is a repeating structure starting at As you can see there is a repeating structure starting at
address <literal>0297:01ec</literal> that consists of four io address <literal>0297:01ec</literal> that consists of four io
accesses on the parallel port. Looking at it the first io accesses on the parallel port. Looking at it the first io
access writes a changing byte to the data port the second access writes a changing byte to the data port the second
......
documentation/installing.sgml
View file @ a5589d56
...@@ -153,8 +153,10 @@ C:\ Root directory of primary disk drive ...@@ -153,8 +153,10 @@ C:\ Root directory of primary disk drive
And there are of course DLLs that wine does not currently And there are of course DLLs that wine does not currently
implement very well (or at all). If you do not have a real implement very well (or at all). If you do not have a real
Windows you can steal necessary DLLs from, you can always Windows you can steal necessary DLLs from, you can always
get some from a DLL archive such as get some from one of the Windows DLL archive sites
<ulink url="http://solo.abac.com/dllarchive/">http://solo.abac.com/dllarchive/</ulink>. that can be found via internet search engine.
Please make sure to obey any licenses on the DLLs you fetch...
(some are redistributable, some aren't).
</para> </para>
</sect2> </sect2>
</sect1> </sect1>
......
documentation/samples/config
View file @ a5589d56
...@@ -26,6 +26,7 @@ WINE REGISTRY Version 2 ...@@ -26,6 +26,7 @@ WINE REGISTRY Version 2
"Path" = "/mnt/fd0" "Path" = "/mnt/fd0"
"Type" = "floppy" "Type" = "floppy"
"Label" = "Floppy" "Label" = "Floppy"
"Filesystem" = "win95"
"Serial" = "87654321" "Serial" = "87654321"
"Device" = "/dev/fd0" "Device" = "/dev/fd0"
...@@ -174,6 +175,13 @@ WINE REGISTRY Version 2 ...@@ -174,6 +175,13 @@ WINE REGISTRY Version 2
;"DefaultSerif" = "-cronyx-times-" ;"DefaultSerif" = "-cronyx-times-"
;"DefaultSansSerif" = "-cronyx-helvetica-" ;"DefaultSansSerif" = "-cronyx-helvetica-"
; the TrueType font dirs you want to make accessible to wine
[FontDirs]
;"dir1" = "/usr/X11R6/lib/X11/fonts/TrueType"
;"dir2" = "/usr/share/fonts/truetype"
;"dir3" = "/usr/X11R6/lib/X11/fonts/TT"
;"dir4" = "/usr/share/fonts/TT"
[serialports] [serialports]
"Com1" = "/dev/ttyS0" "Com1" = "/dev/ttyS0"
"Com2" = "/dev/ttyS1" "Com2" = "/dev/ttyS1"
......
documentation/wine.conf.man
View file @ a5589d56
...@@ -153,6 +153,26 @@ Tells Wine which graphics driver to use. Normally you'd want to use ...@@ -153,6 +153,26 @@ Tells Wine which graphics driver to use. Normally you'd want to use
x11drv (for X11). In case you want to run programs as text console/TTY only x11drv (for X11). In case you want to run programs as text console/TTY only
without having Wine rely on X11 support, then use ttydrv. without having Wine rely on X11 support, then use ttydrv.
.PP .PP
.B [Version]
.br
.I format: """Windows""=""<version string>"""
.br
default: none; chosen by semi-intelligent detection mechanism based on DLL environment
.br
Used to specify which Windows version to return to programs (forced value,
overrides standard detection mechanism !).
Valid settings are e.g. "win31", "win95", "win98", "win2k", "winxp".
Also valid as an AppDefaults setting (recommended/preferred use).
.PP
.I format: """DOS""=""<version string>"""
.br
default: "<Windows version specific>"
.br
Used to specify the DOS version that should be returned to programs.
Only takes effect in case Wine acts as "win31" Windows version !
Common DOS version settings include 6.22, 6.20, 6.00, 5.00, 4.00, 3.30, 3.10.
Also valid as an AppDefaults setting (recommended/preferred use).
.PP
.B [DllOverrides] .B [DllOverrides]
.br .br
.I format: """modulename""=""native,so,builtin""" .I format: """modulename""=""native,so,builtin"""
......
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