[3/3] [docs] wineusr: Do not indent verbatim environments
Frédéric Delanoy
frederic.delanoy at gmail.com
Tue Sep 10 01:37:53 CDT 2013
Verbatim block-mode environments, like <screen> or <programlisting> shouldn't be indented:
- this extra space yields an extraneous blank line after each such indented block when converted
- custom indentation/spacing for blocks should use stylesheets like DSSSL or XSL
---
en/wineusr-bugs.sgml | 8 ++---
en/wineusr-configuring.sgml | 64 +++++++++++++++++++-------------------
en/wineusr-getting.sgml | 18 +++++------
en/wineusr-glossary.sgml | 36 +++++++++++-----------
en/wineusr-running.sgml | 75 ++++++++++++++++++++++-----------------------
5 files changed, 99 insertions(+), 102 deletions(-)
diff --git a/en/wineusr-bugs.sgml b/en/wineusr-bugs.sgml
index fb67872..5a66456 100644
--- a/en/wineusr-bugs.sgml
+++ b/en/wineusr-bugs.sgml
@@ -282,10 +282,10 @@
<listitem>
<para>
Create an attachment with full terminal output in a text file.
- <screen>
- cd ~/.wine/drive_c/Games/Tron
- wine tron.exe &> log.txt
- </screen>
+<screen>
+cd ~/.wine/drive_c/Games/Tron
+wine tron.exe &> log.txt
+</screen>
</para>
</listitem>
<listitem>
diff --git a/en/wineusr-configuring.sgml b/en/wineusr-configuring.sgml
index 3d27fb5..1be0389 100644
--- a/en/wineusr-configuring.sgml
+++ b/en/wineusr-configuring.sgml
@@ -220,9 +220,9 @@
package has already been installed and subsequently fail to run when
the required dependencies are not met. For example:
</para>
- <programlisting>
- err:module:import_dll Library MFC42.DLL (which is needed by L"C:\\Program Files\\Foo\\Bar.dll") not found
- </programlisting>
+<screen>
+err:module:import_dll Library MFC42.DLL (which is needed by L"C:\\Program Files\\Foo\\Bar.dll") not found
+</screen>
<para>
Redistributable packages which install the necessary runtimes can
be obtained through the use of <ulink
@@ -292,18 +292,18 @@
<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>
- <screen>
- <prompt>$ </prompt><userinput>ls -la ~/.wine/dosdevices/</userinput>
- <computeroutput>lrwxrwxrwx 1 <replaceable>wineuser</replaceable> <replaceable>wineuser</replaceable> 10 Jul 23 15:12 c: -> ../drive_c</computeroutput>
- <computeroutput>lrwxrwxrwx 1 <replaceable>wineuser</replaceable> <replaceable>wineuser</replaceable> 1 Jul 23 15:12 z: -> /</computeroutput>
- </screen>
+<screen>
+<prompt>$ </prompt><userinput>ls -la ~/.wine/dosdevices/</userinput>
+<computeroutput>lrwxrwxrwx 1 <replaceable>wineuser</replaceable> <replaceable>wineuser</replaceable> 10 Jul 23 15:12 c: -> ../drive_c</computeroutput>
+<computeroutput>lrwxrwxrwx 1 <replaceable>wineuser</replaceable> <replaceable>wineuser</replaceable> 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:
</para>
- <screen>
- <prompt>$ </prompt><userinput>ln -s /mnt/cdrom ~/.wine/dosdevices/d:</userinput>
- </screen>
+<screen>
+<prompt>$ </prompt><userinput>ln -s /mnt/cdrom ~/.wine/dosdevices/d:</userinput>
+</screen>
<para>
Take note of the DOS-style naming convention used for links -
the format is a letter followed by a colon, such as <filename
@@ -531,17 +531,17 @@
over to the global registry files (which we assume will reside in
<filename class="directory">/usr/local/etc</filename> here), with:
</para>
- <screen>
- cd ~root/.wine
- cp system.reg /usr/local/etc/wine.systemreg
- </screen>
+<screen>
+cd ~root/.wine
+cp system.reg /usr/local/etc/wine.systemreg
+</screen>
<para>
and perhaps even symlink these back to the administrator's
account, to make it easier to install apps system-wide later:
</para>
- <screen>
- ln -sf /usr/local/etc/wine.systemreg system.reg
- </screen>
+<screen>
+ln -sf /usr/local/etc/wine.systemreg system.reg
+</screen>
<para>
You might be tempted to do the same for <filename>user.reg</filename>
as well, however that file contains user specific settings.
@@ -608,11 +608,11 @@
devices, such as <filename class="devicefile">/dev/ttyS0</filename> and
<filename class="devicefile">/dev/lp0</filename>. For example, to configure
one serial port and one parallel port, run the following commands:
+<screen>
+ln -s /dev/ttyS0 com1
+ln -s /dev/lp0 lpt1
+</screen>
</para>
- <screen>
- ln -s /dev/ttyS0 com1
- ln -s /dev/lp0 lpt1
- </screen>
</sect2>
<sect2>
<title>Network Shares</title>
@@ -628,9 +628,9 @@
<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>
+<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 <filename
class="directory">unc</filename> directory if it doesn't already exist).
@@ -726,9 +726,9 @@
<envar>LIB_ODBC_DRIVER_MANAGER</envar> for the name of the ODBC
library. For example:
</para>
- <screen>
- LIB_ODBC_DRIVER_MANAGER=/usr/lib/libodbc.so.1.0.0
- </screen>
+<screen>
+LIB_ODBC_DRIVER_MANAGER=/usr/lib/libodbc.so.1.0.0
+</screen>
<para>
If that environment variable is not set then it looks for a
library called <filename class="libraryfile">libodbc.so</filename> and so
@@ -736,10 +736,10 @@
equate that to your own library. For example as root you could
run the commands:
</para>
- <screen>
- <prompt># </prompt><userinput>ln -s libodbc.so.1.0.0 /usr/lib/libodbc.so</userinput>
- <prompt># </prompt><userinput>/sbin/ldconfig</userinput>
- </screen>
+<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 <filename class="libraryfile">odbc32.dll</filename>,
diff --git a/en/wineusr-getting.sgml b/en/wineusr-getting.sgml
index c8dc00e..a7221d8 100644
--- a/en/wineusr-getting.sgml
+++ b/en/wineusr-getting.sgml
@@ -163,12 +163,12 @@
Once you've installed the build dependencies you need, you're ready
to compile the package. In the terminal window, after having
navigated to the Wine source tree, run the following commands:
- <screen>
- <prompt>$ </prompt><userinput>./configure</userinput>
- <prompt>$ </prompt><userinput>make depend</userinput>
- <prompt>$ </prompt><userinput>make</userinput>
- <prompt># </prompt><userinput>make install</userinput>
- </screen>
+<screen>
+<prompt>$ </prompt><userinput>./configure</userinput>
+<prompt>$ </prompt><userinput>make depend</userinput>
+<prompt>$ </prompt><userinput>make</userinput>
+<prompt># </prompt><userinput>make install</userinput>
+</screen>
The last command requires root privileges. Although you should
never run Wine as root, you will need to install it this way.
</para>
@@ -179,9 +179,9 @@
To uninstall Wine from source, once again navigate to the same
source folder that you used to install Wine using the terminal.
Then, run the following command:
- <screen>
- <prompt># </prompt><userinput>make uninstall</userinput>
- </screen>
+<screen>
+<prompt># </prompt><userinput>make uninstall</userinput>
+</screen>
This command will require root privileges, and should remove all of
the Wine files from your system. It will not, however,
remove your Wine configuration and applications located in your
diff --git a/en/wineusr-glossary.sgml b/en/wineusr-glossary.sgml
index 9326eac..1d32aac 100644
--- a/en/wineusr-glossary.sgml
+++ b/en/wineusr-glossary.sgml
@@ -66,9 +66,9 @@ EXAMPLE:
<command>vi</command>.
In a <glossterm>terminal</glossterm>, simply run them via:
</para>
- <screen>
- <prompt>$ </prompt><userinput><replaceable>editorname</replaceable> <replaceable>filename</replaceable></userinput>
- </screen>
+<screen>
+<prompt>$ </prompt><userinput><replaceable>editorname</replaceable> <replaceable>filename</replaceable></userinput>
+</screen>
</glossdef>
</glossentry>
<glossentry>
@@ -79,21 +79,21 @@ EXAMPLE:
In a <command>bash</command> shell (the most commonly used one in Linux),
you can view all environment variables by executing:
</para>
- <screen>
- <userinput>set</userinput>
- </screen>
+<screen>
+<userinput>set</userinput>
+</screen>
<para>
If you want to change an environment variable, you could run:
</para>
- <screen>
- <userinput>export <replaceable>MYVARIABLE</replaceable>=<replaceable>mycontent</replaceable></userinput>
- </screen>
+<screen>
+<userinput>export <replaceable>MYVARIABLE</replaceable>=<replaceable>mycontent</replaceable></userinput>
+</screen>
<para>
For deleting an environment variable, use:
</para>
- <screen>
- <userinput>unset <replaceable>MYVARIABLE</replaceable></userinput>
- </screen>
+<screen>
+<userinput>unset <replaceable>MYVARIABLE</replaceable></userinput>
+</screen>
</glossdef>
</glossentry>
<glossentry>
@@ -126,17 +126,17 @@ EXAMPLE:
In order to run programs as root, simply open a
<glossterm>Terminal</glossterm> window, then run:
</para>
- <screen>
- <prompt>$ </prompt><userinput>su -</userinput>
- </screen>
+<screen>
+<prompt>$ </prompt><userinput>su -</userinput>
+</screen>
<para>
This will prompt you for the password of the <literal>root</literal> user of your system,
and after that you will be able to system administration tasks
that require special root privileges. The <literal>root</literal> account is indicated by the
</para>
- <screen>
- <prompt># </prompt>
- </screen>
+<screen>
+<prompt># </prompt>
+</screen>
<para>
prompt, whereas '$' indicates a normal user account.
</para>
diff --git a/en/wineusr-running.sgml b/en/wineusr-running.sgml
index 34674cf..090eb58 100644
--- a/en/wineusr-running.sgml
+++ b/en/wineusr-running.sgml
@@ -27,23 +27,21 @@
program (it is located in the
<filename class="directory">programs/uninstaller/</filename> directory in a Wine
source directory) in a <glossterm>terminal</glossterm>:
+<screen>
+<prompt>$</prompt> <userinput>wine uninstaller</userinput>
+</screen>
</para>
- <screen>
- <prompt>$</prompt> <userinput>wine uninstaller</userinput>
- </screen>
-
<para>
Some programs install associated control panel applets, examples
of this would be Internet Explorer and QuickTime. You can access
the Wine control panel by running in a
<glossterm>terminal</glossterm>:
+<screen>
+<prompt>$</prompt> <userinput>wine control</userinput>
+</screen>
</para>
- <screen>
- <prompt>$</prompt> <userinput>wine control</userinput>
- </screen>
-
<para>
which will open a window with the installed control panel
applets in it, as in Windows.
@@ -53,12 +51,11 @@
If the application doesn't install menu or desktop items, you'll
need to run the app from the command line. Remembering where you
installed to, something like:
+<screen>
+<prompt>$</prompt> <userinput>wine "C:\Program Files\<replaceable>appname</replaceable>\<replaceable>appname.exe</replaceable>"</userinput>
+</screen>
</para>
- <screen>
- <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
@@ -76,11 +73,11 @@
get a small help message:
</para>
<para>
- <programlisting>
+<programlisting>
Usage: wine PROGRAM [ARGUMENTS...] Run the specified program
wine --help Display this help and exit
wine --version Output version information and exit
- </programlisting>
+</programlisting>
</para>
<para>
@@ -92,30 +89,30 @@ Usage: wine PROGRAM [ARGUMENTS...] Run the specified program
the executable. For example, given a <envar>Path</envar>
of the following:
</para>
- <screen>
+<screen>
Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
- </screen>
+</screen>
<para>
You could run the file
<filename>c:\windows\system\foo.exe</filename> with:
</para>
- <screen>
+<screen>
<prompt>$</prompt> <userinput>wine foo.exe</userinput>
- </screen>
+</screen>
<para>
However, you would have to run the file
<filename>c:\myapps\foo.exe</filename> with this command:
</para>
- <screen>
+<screen>
<prompt>$</prompt> <userinput>wine c:\\myapps\\foo.exe</userinput>
- </screen>
+</screen>
<para>
(note the backslash-escaped '\')
or:
</para>
- <screen>
+<screen>
<prompt>$</prompt> <userinput>wine ~/.wine/drive_c/myapps/foo.exe</userinput>
- </screen>
+</screen>
<para>
For details on running text mode (CUI) executables, read the
<link linkend="CUI-programs">section</link> below.
@@ -210,23 +207,23 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
<literal>heap</literal> debug channel, you could invoke
<command>wine</command> like this:
</para>
- <screen>
+<screen>
<prompt>$</prompt> <userinput>WINEDEBUG=warn+heap wine <replaceable>program_name</replaceable></userinput>
- </screen>
+</screen>
<para>
If you leave off the message class, Wine
will display messages from all four classes for that channel:
</para>
- <screen>
+<screen>
<prompt>$</prompt> <userinput>WINEDEBUG=heap wine <replaceable>program_name</replaceable></userinput>
- </screen>
+</screen>
<para>
If you wanted to see log messages for everything except the
<literal>relay</literal> channel, you might do something like this:
</para>
- <screen>
+<screen>
<prompt>$</prompt> <userinput>WINEDEBUG=+all,-relay wine <replaceable>program_name</replaceable></userinput>
- </screen>
+</screen>
<para>
You can find a list of the debug channels and classes at
<ulink url="http://wiki.winehq.org/DebugChannels">DebugChannels</ulink>.
@@ -248,17 +245,17 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
<para>
Examples:
</para>
- <screen>
+<screen>
<prompt>$</prompt> <userinput>WINEDLLOVERRIDES="comdlg32,shell32=n,b" wine <replaceable>program_name</replaceable></userinput>
- </screen>
+</screen>
<para>
Try to load <filename class="libraryfile">comdlg32</filename> and <filename
class="libraryfile">shell32</filename> as native Windows DLLs first and try the builtin
version if the native load fails.
</para>
- <screen>
+<screen>
<prompt>$</prompt> <userinput>WINEDLLOVERRIDES="comdlg32,shell32=n;c:\\foo\\bar\\baz=b" wine <replaceable>program_name</replaceable></userinput>
- </screen>
+</screen>
<para>
Try to load the <filename class="libraryfile">comdlg32</filename> and <filename
class="libraryfile">shell32</filename> libraries
@@ -266,9 +263,9 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
<filename class="libraryfile">c:\foo\bar\baz.dll</filename> load
the builtin library <filename class="libraryfile">baz</filename>.
</para>
- <screen>
+<screen>
<prompt>$</prompt> <userinput>WINEDLLOVERRIDES="comdlg32=b,n;shell32=b;comctl32=n;oleaut32=" wine <replaceable>program_name</replaceable></userinput>
- </screen>
+</screen>
<para>
Try to load <filename class="libraryfile">comdlg32</filename> as builtin first and try the
native version if the builtin load fails; load <filename
@@ -322,9 +319,9 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
<para>
As an example:
</para>
- <screen>
+<screen>
<prompt>$</prompt> <userinput>AUDIODEV=/dev/dsp4 MIXERDEV=/dev/mixer1 MIDIDEV=/dev/midi3 wine <replaceable>program_name</replaceable></userinput>
- </screen>
+</screen>
</sect2>
</sect1>
@@ -400,9 +397,9 @@ Path="c:\windows;c:\windows\system;e:\;e:\test;f:\"
Linux shell, since Wine will pass on the entire shell environment
variable settings to the Windows environment variable space.
Example for the <command>bash</command> shell (other shells may have a different syntax!):
- <screen>
- export <envar>MYENVIRONMENTVAR</envar>=<replaceable>myenvironmentvarsetting</replaceable>
- </screen>
+<screen>
+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
--
1.8.4
More information about the wine-patches
mailing list