Skip to content

W
wine-winehq
Commit 473d7ac0 authored by Vincent Béron's avatar Vincent Béron Committed by Alexandre Julliard
Browse files
Options

Begin to uniformize sample commands in documentation.

parent 7006ab14
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 94 additions and 110 deletions
documentation/getting.sgml
View file @ 473d7ac0
...@@ -265,11 +265,10 @@ ...@@ -265,11 +265,10 @@
<title>Red Hat Linux</title> <title>Red Hat Linux</title>
<para> <para>
Red Hat users can use <ulink url="http://rpmfind.net/linux/RPM/"> Red Hat users can use the
rpmfind.net</ulink> to track down available Wine RPM binaries. <ulink url="http://sourceforge.net/project/showfiles.php?group_id=6241">
<ulink url="http://rpmfind.net/linux/RPM/WByName.html">This sourceforge.net Wine page</ulink> to get the RPM most suitable for
page</ulink> contains a list of all rpmfind packages that start with their system.
the letter "W", including a few Wine packages.
</para> </para>
</sect2> </sect2>
...@@ -301,12 +300,12 @@ ...@@ -301,12 +300,12 @@
If you want to install Wine from the FreeBSD CD-ROM, run in a If you want to install Wine from the FreeBSD CD-ROM, run in a
<glossterm>terminal</glossterm>: <glossterm>terminal</glossterm>:
</para> </para>
<screen> <screen>
<prompt>$ </><userinput>su -</> <prompt>$ </><userinput>su -</>
<prompt># </><userinput>mount /cdrom</> <prompt># </><userinput>mount /cdrom</>
<prompt># </><userinput>cd /cdrom/packages/All</> <prompt># </><userinput>cd /cdrom/packages/All</>
<prompt># </><userinput>pkg_add wine_.X.X.X.tgz</> <prompt># </><userinput>pkg_add wine_.X.X.X.tgz</>
</screen> </screen>
<para> <para>
</para> </para>
<para> <para>
...@@ -407,22 +406,8 @@ ...@@ -407,22 +406,8 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<ulink url="ftp://ftp.infomagic.com/pub/mirrors/linux/sunsite/ALPHA/wine/development/"> <ulink url="http://prdownloads.sourceforge.net/wine/">
ftp://ftp.infomagic.com/pub/mirrors/linux/sunsite/ALPHA/wine/development/ http://prdownloads.sourceforge.net/wine/
</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="ftp://ftp.fu-berlin.de/unix/linux/mirrors/sunsite.unc.edu/ALPHA/wine/development/">
ftp://ftp.fu-berlin.de/unix/linux/mirrors/sunsite.unc.edu/ALPHA/wine/development/
</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="ftp://orcus.progsoc.uts.edu.au/pub/Wine/development/">
ftp://orcus.progsoc.uts.edu.au/pub/Wine/development/
</ulink> </ulink>
</para> </para>
</listitem> </listitem>
...@@ -443,9 +428,9 @@ ...@@ -443,9 +428,9 @@
switch to the directory containing the file you just switch to the directory containing the file you just
downloaded. Then extract the source in a downloaded. Then extract the source in a
<glossterm>terminal</glossterm> with (e.g.): <glossterm>terminal</glossterm> with (e.g.):
<screen> <screen>
<prompt>$ </><userinput>tar xvzf wine-<replaceable>20030115</>.tar.gz</> <prompt>$ </><userinput>tar xvzf wine-<replaceable>20030115</>.tar.gz</>
</screen> </screen>
</para> </para>
<para> <para>
Just in case you happen to get a Wine archive that uses Just in case you happen to get a Wine archive that uses
...@@ -484,9 +469,9 @@ ...@@ -484,9 +469,9 @@
To check whether this is the case, please run in a To check whether this is the case, please run in a
<glossterm>terminal</glossterm>: <glossterm>terminal</glossterm>:
</para> </para>
<screen> <screen>
<prompt>$ </><userinput>cvs</> <prompt>$ </><userinput>cvs</>
</screen> </screen>
<para> <para>
If this was successful, then you should have gotten a nice CVS If this was successful, then you should have gotten a nice CVS
"Usage" help output. Otherwise (e.g. an error "cvs: command "Usage" help output. Otherwise (e.g. an error "cvs: command
...@@ -503,9 +488,9 @@ ...@@ -503,9 +488,9 @@
<para> <para>
First, you should do a First, you should do a
</para> </para>
<screen> <screen>
<prompt>$ </><userinput>touch ~/.cvspass</> <prompt>$ </><userinput>touch ~/.cvspass</>
</screen> </screen>
<para> <para>
to create or update the file <filename>.cvspass</filename> in to create or update the file <filename>.cvspass</filename> in
your home directory, since CVS needs this file (for password your home directory, since CVS needs this file (for password
...@@ -527,9 +512,9 @@ checkout -P ...@@ -527,9 +512,9 @@ checkout -P
</programlisting> </programlisting>
Create the file with an <glossterm>editor</glossterm> Create the file with an <glossterm>editor</glossterm>
of your choice, either by running of your choice, either by running
<screen> <screen>
<prompt>$ </><userinput>&lt;editor&gt; ~/.cvsrc</> <prompt>$ </><userinput>&lt;editor&gt; ~/.cvsrc</>
</screen> </screen>
, where &lt;editor&gt; is the editor you want to use (e.g. , where &lt;editor&gt; is the editor you want to use (e.g.
<command>joe</command>, <command>ae</command>, <command>joe</command>, <command>ae</command>,
<command>vi</command>), <command>vi</command>),
...@@ -548,9 +533,9 @@ checkout -P ...@@ -548,9 +533,9 @@ checkout -P
server and checkout (download) the Wine source code. server and checkout (download) the Wine source code.
First, let's do the server login: First, let's do the server login:
</para> </para>
<screen> <screen>
<prompt>$ </><userinput>cvs -d :pserver:cvs@cvs.winehq.com:/home/wine login</> <prompt>$ </><userinput>cvs -d :pserver:cvs@cvs.winehq.com:/home/wine login</>
</screen> </screen>
<para> <para>
If <command>cvs</command> successfully connects to the CVS server, If <command>cvs</command> successfully connects to the CVS server,
then you will get a "CVS password:" prompt. then you will get a "CVS password:" prompt.
...@@ -568,9 +553,9 @@ checkout -P ...@@ -568,9 +553,9 @@ checkout -P
might be your user's home directory. might be your user's home directory.
To download the Wine tree into the subdirectory <filename>wine/</filename>, run: To download the Wine tree into the subdirectory <filename>wine/</filename>, run:
</para> </para>
<screen> <screen>
<prompt>$ </><userinput>cvs -d :pserver:cvs@cvs.winehq.com:/home/wine checkout wine</> <prompt>$ </><userinput>cvs -d :pserver:cvs@cvs.winehq.com:/home/wine checkout wine</>
</screen> </screen>
<para> <para>
Downloading the CVS tree might take a while (some minutes Downloading the CVS tree might take a while (some minutes
to few hours), depending on your connection speed. to few hours), depending on your connection speed.
...@@ -579,24 +564,24 @@ checkout -P ...@@ -579,24 +564,24 @@ checkout -P
<filename>wine/</filename> directory is in, by running <filename>wine/</filename> directory is in, by running
<command>pwd</command> (Print Working Directory): <command>pwd</command> (Print Working Directory):
</para> </para>
<screen> <screen>
<prompt>$ </><userinput>pwd</> <prompt>$ </><userinput>pwd</>
</screen> </screen>
<para> <para>
Later, you will be able to change to this directory by Later, you will be able to change to this directory by
running: running:
</para> </para>
<screen> <screen>
<prompt>$ </><userinput>cd <replaceable>&lt;some_dir&gt;</></> <prompt>$ </><userinput>cd <replaceable>&lt;some_dir&gt;</></>
</screen> </screen>
<para> <para>
, where &lt;some_dir&gt; is the directory that , where &lt;some_dir&gt; is the directory that
<command>pwd</command> gave you. <command>pwd</command> gave you.
By running By running
</para> </para>
<screen> <screen>
<prompt>$ </><userinput>cd wine</> <prompt>$ </><userinput>cd wine</>
</screen> </screen>
<para> <para>
, you can now change to the directory of the Wine CVS tree , you can now change to the directory of the Wine CVS tree
you just downloaded. Since you now have a fully working Wine you just downloaded. Since you now have a fully working Wine
...@@ -621,10 +606,10 @@ checkout -P ...@@ -621,10 +606,10 @@ checkout -P
To proceed with updating Wine, simply <command>cd</command> To proceed with updating Wine, simply <command>cd</command>
to the Wine CVS tree directory, then run: to the Wine CVS tree directory, then run:
</para> </para>
<screen> <screen>
<prompt>$ </><userinput>make distclean</> <prompt>$ </><userinput>make distclean</>
<prompt>$ </><userinput>cvs -d :pserver:cvs@cvs.winehq.com:/home/wine update</> <prompt>$ </><userinput>cvs -d :pserver:cvs@cvs.winehq.com:/home/wine update</>
</screen> </screen>
<para> <para>
The <command>make distclean</command> part is optional, but The <command>make distclean</command> part is optional, but
it's a good idea to remove old build and compile configuration it's a good idea to remove old build and compile configuration
...@@ -645,16 +630,16 @@ checkout -P ...@@ -645,16 +630,16 @@ checkout -P
mailing list</>, and received a patch file to fix the bug. mailing list</>, and received a patch file to fix the bug.
You can apply the patch with the <command>patch</> command, You can apply the patch with the <command>patch</> command,
which takes a streamed patch from <filename>stdin</>: which takes a streamed patch from <filename>stdin</>:
<screen> <screen>
<prompt>$ </><userinput>cd wine</> <prompt>$ </><userinput>cd wine</>
<prompt>$ </><userinput>patch -p0 &lt;<replaceable>../patch_to_apply.diff</></> <prompt>$ </><userinput>patch -p0 &lt;<replaceable>../patch_to_apply.diff</></>
</screen> </screen>
</para> </para>
<para> <para>
To remove the patch, use the <parameter>-R</> option: To remove the patch, use the <parameter>-R</> option:
<screen> <screen>
<prompt>$ </><userinput>patch -p0 -R &lt;<replaceable>../patch_to_apply.diff</></> <prompt>$ </><userinput>patch -p0 -R &lt;<replaceable>../patch_to_apply.diff</></>
</screen> </screen>
</para> </para>
<para> <para>
If you want to do a test run to see if the patch will apply If you want to do a test run to see if the patch will apply
...@@ -662,10 +647,9 @@ checkout -P ...@@ -662,10 +647,9 @@ checkout -P
newer version of the tree), you can use the newer version of the tree), you can use the
<parameter>--dry-run</> parameter to run the patch <parameter>--dry-run</> parameter to run the patch
without writing to any files: without writing to any files:
<screen> <screen>
<prompt>$ </><userinput>patch -p0 --dry-run &lt;<replaceable>../patch_to_apply.d <prompt>$ </><userinput>patch -p0 --dry-run &lt;<replaceable>../patch_to_apply.diff</></>
iff</></> </screen>
</screen>
</para> </para>
<para> <para>
<command>patch</> is pretty smart about extracting <command>patch</> is pretty smart about extracting
......
documentation/installing.sgml
View file @ 473d7ac0
...@@ -48,12 +48,12 @@ ...@@ -48,12 +48,12 @@
.deb package file to. Once there, type these commands, .deb package file to. Once there, type these commands,
adapting the package file name as required: adapting the package file name as required:
</para> </para>
<screen> <screen>
<prompt>$ </><userinput>su -</> <prompt>$ </><userinput>su -</>
Password: Password:
<prompt># </><userinput>cd /home/user</> <prompt># </><userinput>cd /home/user</>
<prompt># </><userinput>dpkg -i wine_<replaceable>0.0.20030115-1</>.deb</> <prompt># </><userinput>dpkg -i wine_<replaceable>0.0.20030115-1</>.deb</>
</screen> </screen>
<para> <para>
(Type the root password at the "Password:" prompt) (Type the root password at the "Password:" prompt)
</para> </para>
...@@ -69,17 +69,17 @@ Password: ...@@ -69,17 +69,17 @@ Password:
Uninstalling an installed Wine Debian package can be done by Uninstalling an installed Wine Debian package can be done by
running: running:
</para> </para>
<screen> <screen>
<prompt># </><userinput>dpkg -l|grep wine</> <prompt># </><userinput>dpkg -l|grep wine</>
</screen> </screen>
<para> <para>
The second column of the output (if any) of this command will The second column of the output (if any) of this command will
indicate the installed packages dealing with "wine". indicate the installed packages dealing with "wine".
The corresponding packages can be uninstalled by running: The corresponding packages can be uninstalled by running:
</para> </para>
<screen> <screen>
<prompt># </><userinput>dpkg -r <replaceable>&lt;package_name&gt;</></> <prompt># </><userinput>dpkg -r <replaceable>&lt;package_name&gt;</></>
</screen> </screen>
<para> <para>
where &lt;package_name&gt; is the name of the Wine-related package where &lt;package_name&gt; is the name of the Wine-related package
which you want to uninstall. which you want to uninstall.
...@@ -93,9 +93,9 @@ Password: ...@@ -93,9 +93,9 @@ Password:
Once there, type this one command as root, adapting the Once there, type this one command as root, adapting the
package file name as required: package file name as required:
</para> </para>
<screen> <screen>
<prompt># </><userinput>rpm -ivh wine-<replaceable>20020605-2.i386</>.rpm</> <prompt># </><userinput>rpm -ivh wine-<replaceable>20020605-2.i386</>.rpm</>
</screen> </screen>
<para> <para>
You may also want to install the You may also want to install the
<systemitem>wine-devel</systemitem> package. <systemitem>wine-devel</systemitem> package.
...@@ -104,16 +104,16 @@ Password: ...@@ -104,16 +104,16 @@ Password:
Uninstalling an installed Wine RPM package can be done by Uninstalling an installed Wine RPM package can be done by
running: running:
</para> </para>
<screen> <screen>
<prompt># </><userinput>rpm -qa|grep -i wine</> <prompt># </><userinput>rpm -qa|grep -i wine</>
</screen> </screen>
<para> <para>
This command will indicate the installed packages dealing with "wine". This command will indicate the installed packages dealing with "wine".
The corresponding packages can be uninstalled by running: The corresponding packages can be uninstalled by running:
</para> </para>
<screen> <screen>
<prompt># </><userinput>rpm -e <replaceable>&lt;package_name&gt;</></> <prompt># </><userinput>rpm -e <replaceable>&lt;package_name&gt;</></>
</screen> </screen>
<para> <para>
where &lt;package_name&gt; is the name of the Wine-related package where &lt;package_name&gt; is the name of the Wine-related package
which you want to uninstall. which you want to uninstall.
...@@ -128,9 +128,9 @@ Password: ...@@ -128,9 +128,9 @@ Password:
If you are in the directory of the Wine version that you just If you are in the directory of the Wine version that you just
compiled (e.g. by having run <command>make depend && make</command>), then you may now install this Wine version by running as <glossterm>root</glossterm>: compiled (e.g. by having run <command>make depend && make</command>), then you may now install this Wine version by running as <glossterm>root</glossterm>:
</para> </para>
<screen> <screen>
<prompt># </><userinput>make install</> <prompt># </><userinput>make install</>
</screen> </screen>
<para> <para>
This will copy the Wine binary files to their final destination This will copy the Wine binary files to their final destination
in your system. You can then proceed to the <link in your system. You can then proceed to the <link
...@@ -143,9 +143,9 @@ Password: ...@@ -143,9 +143,9 @@ Password:
source code version, then change to the main directory of this source code version, then change to the main directory of this
version and run as <glossterm>root</glossterm>: version and run as <glossterm>root</glossterm>:
</para> </para>
<screen> <screen>
<prompt># </><userinput>make uninstall</> <prompt># </><userinput>make uninstall</>
</screen> </screen>
</sect1> </sect1>
</chapter> </chapter>
......
documentation/introduction.sgml
View file @ 473d7ac0
...@@ -520,7 +520,7 @@ ...@@ -520,7 +520,7 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<literallayout>A computer ;-)</literallayout> A computer ;-)
<literallayout> Wine: only PCs >= i386 are supported at the moment.</literallayout> <literallayout> Wine: only PCs >= i386 are supported at the moment.</literallayout>
<literallayout> Winelib: selected other platforms are supported, but can be tricky.</literallayout> <literallayout> Winelib: selected other platforms are supported, but can be tricky.</literallayout>
</para> </para>
......
documentation/registry.sgml
View file @ 473d7ac0
...@@ -36,10 +36,10 @@ ...@@ -36,10 +36,10 @@
workarounds for certain programs etc.). workarounds for certain programs etc.).
In the main Wine source code directory in a <glossterm>terminal</glossterm>, run: In the main Wine source code directory in a <glossterm>terminal</glossterm>, run:
</para> </para>
<screen> <screen>
<prompt>$ </><userinput>cd programs/regedit</> <prompt>$ </><userinput>cd programs/regedit</>
<prompt>$ </><userinput>./regedit ../../winedefault.reg</> <prompt>$ </><userinput>./regedit ../../winedefault.reg</>
</screen> </screen>
</sect2> </sect2>
<sect2> <sect2>
...@@ -232,19 +232,19 @@ ...@@ -232,19 +232,19 @@
files (which we assume will reside in files (which we assume will reside in
<filename>/usr/local/etc</filename> here), with: <filename>/usr/local/etc</filename> here), with:
</para> </para>
<screen> <screen>
cd ~/.wine cd ~/.wine
cp system.reg /usr/local/etc/wine.systemreg cp system.reg /usr/local/etc/wine.systemreg
cp wine.userreg /usr/local/etc/wine.userreg cp wine.userreg /usr/local/etc/wine.userreg
</screen> </screen>
<para> <para>
and perhaps even symlink these back to the administrator's and perhaps even symlink these back to the administrator's
account, to make it easier to install apps system-wide later: account, to make it easier to install apps system-wide later:
</para> </para>
<screen> <screen>
ln -sf /usr/local/etc/wine.systemreg system.reg ln -sf /usr/local/etc/wine.systemreg system.reg
ln -sf /usr/local/etc/wine.userreg wine.userreg ln -sf /usr/local/etc/wine.userreg wine.userreg
</screen> </screen>
<para> <para>
Note that the <filename>tools/wineinstall</filename> script Note that the <filename>tools/wineinstall</filename> script
already does all of this for you, if you install Wine source as root. already does all of this for you, if you install Wine source as root.
......
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