Skip to content

Commit 2b1bcff

Browse files
dcommanderdcommander
committed
Doc: Acknowledge Windows Subsystem for Linux
These days, WSL 2 is a better solution than Cygwin/X for users who want to run the VirtualGL Client on a Windows machine.
1 parent 9c2b193 commit 2b1bcff

File tree

5 files changed

+26
-18
lines changed

5 files changed

+26
-18
lines changed

‎doc/index.html‎

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
55
<meta name="language" content="en">
6-
<meta name="date" content="2026-01-08T10:53:04">
6+
<meta name="date" content="2026-01-08T11:36:47">
77
<meta name="generator" content="deplate.rb 0.8.5">
88
<title>User&rsquo;s Guide for VirtualGL 3.1.4</title>
99
<link rel="start" href="index.html" title="Frontpage">
@@ -13,7 +13,7 @@
1313
<link rel="chapter" href="index.html#hd004" title="4 System Requirements">
1414
<link rel="chapter" href="index.html#hd005" title="5 Obtaining and Installing VirtualGL">
1515
<link rel="chapter" href="index.html#hd006" title="6 Configuring a Linux or Unix Machine as a VirtualGL Server">
16-
<link rel="chapter" href="index.html#hd007" title="7 Configuring a Windows Machine as a VGL Transport Client">
16+
<link rel="chapter" href="index.html#hd007" title="7 Configuring a Windows/Cygwin Machine as a VGL Transport Client">
1717
<link rel="chapter" href="index.html#hd008" title="8 Using VirtualGL with the VGL Transport">
1818
<link rel="chapter" href="index.html#hd009" title="9 Using VirtualGL with X Proxies Such as VNC">
1919
<link rel="chapter" href="index.html#hd0010" title="10 Support for the X Video Extension">
@@ -77,7 +77,8 @@
7777
<a href="#hd005" class="hd">5 Obtaining and Installing VirtualGL</a>
7878
<ul class="hd">
7979
<li class="Itemize-3 hd">
80-
<a href="#hd005001" class="hd">5.1 Installing VirtualGL on Linux</a>
80+
<a href="#hd005001" class="hd">5.1 Installing VirtualGL on Linux
81+
(Including WSL)</a>
8182
</li>
8283
<li class="Itemize-3 hd">
8384
<a href="#hd005002" class="hd">5.2 Installing the VirtualGL Client on OS
@@ -128,8 +129,8 @@
128129
</ul>
129130
</li>
130131
<li class="Itemize-1 hd">
131-
<a href="#hd007" class="hd">7 Configuring a Windows Machine as a VGL
132-
Transport Client</a>
132+
<a href="#hd007" class="hd">7 Configuring a Windows/Cygwin Machine as a
133+
VGL Transport Client</a>
133134
</li>
134135
<li class="Itemize-1 hd">
135136
<a href="#hd008" class="hd">8 Using VirtualGL with the VGL Transport</a>
@@ -649,6 +650,7 @@ <h2 id="hd004003">4.3&nbsp;Windows</h2>
649650
<tr class="standard">
650651
<td class="high standard">Other Software</td>
651652
<td class="standard"><ul class="Itemize"><li class="Itemize-0">
653+
Windows Subsystem for Linux (WSL) 2 or
652654
<span class="remote"><a href="http://x.cygwin.com" class="remote">Cygwin/X</a></span><a name="idx0013"></a>
653655
</li>
654656
<li class="Itemize-0">
@@ -713,7 +715,7 @@ <h1 id="hd005"><a name="file005"></a>5&nbsp;Obtaining and Installing VirtualGL</
713715
</p></div>
714716

715717

716-
<h2 id="hd005001">5.1&nbsp;Installing VirtualGL on Linux</h2>
718+
<h2 id="hd005001">5.1&nbsp;Installing VirtualGL on Linux (Including WSL)</h2>
717719

718720
<div class="important"><p class="important">
719721
If you are installing VirtualGL onto a fresh server, and you also intend to install the nVidia proprietary drivers, install VirtualGL prior to the nVidia drivers. Otherwise, installing VirtualGL may trigger an installation of Mesa, which can modify the libGL symlinks that the nVidia drivers created.
@@ -730,7 +732,7 @@ <h2 id="hd005001">5.1&nbsp;Installing VirtualGL on Linux</h2>
730732
packages are provided for Linux distributions that contain GLIBC 2.17 or
731733
later. <br />
732734
<div class="important"><p class="important">
733-
If you want to run both 32-bit and 64-bit OpenGL applications with VirtualGL on 64-bit x86 Linux systems, then you will need to install both <strong class="filename">VirtualGL-3.1.4.x86_64.rpm</strong> and <strong class="filename">VirtualGL-3.1.4.i386.rpm</strong>, or both <strong class="filename">virtualgl_3.1.4_amd64.deb</strong> and <strong class="filename">virtualgl32_3.1.4_amd64.deb</strong>. (<strong class="filename">virtualgl32_3.1.4_amd64.deb</strong> is a supplementary package that contains only the 32-bit server components.)
735+
If you want to run both 32-bit and 64-bit OpenGL applications with VirtualGL on x86-64 Linux servers, then you will need to install both <strong class="filename">VirtualGL-3.1.4.x86_64.rpm</strong> and <strong class="filename">VirtualGL-3.1.4.i386.rpm</strong>, or both <strong class="filename">virtualgl_3.1.4_amd64.deb</strong> and <strong class="filename">virtualgl32_3.1.4_amd64.deb</strong>. (<strong class="filename">virtualgl32_3.1.4_amd64.deb</strong> is a supplementary package that contains only the 32-bit server components.)
734736
</p></div>
735737
</li>
736738
<li class="Ordered-1 Ordered" value="2">
@@ -821,7 +823,7 @@ <h2 id="hd005003">5.3&nbsp;Installing VirtualGL from Source</h2>
821823
<h2 id="hd005004">5.4&nbsp;Uninstalling VirtualGL</h2>
822824

823825

824-
<h3 id="hd005004001">Linux</h3>
826+
<h3 id="hd005004001">Linux (Including WSL)</h3>
825827

826828
<p>As root, issue one of the following commands:</p>
827829

@@ -1325,7 +1327,7 @@ <h2 id="hd006006">6.6&nbsp;Un-Configuring the Server</h2>
13251327

13261328

13271329

1328-
<h1 id="hd007"><a name="file007"></a>7&nbsp;Configuring a Windows Machine as a VGL Transport Client</h1>
1330+
<h1 id="hd007"><a name="file007"></a>7&nbsp;Configuring a Windows/Cygwin Machine as a VGL Transport Client</h1>
13291331

13301332
<p>The VirtualGL Client can take advantage of the <code>MIT-SHM</code>
13311333
extension in Cygwin/X to accelerate the compositing of rendered frames
@@ -1424,6 +1426,9 @@ <h3 id="hd008001001">8.1.1&nbsp;Procedure</h3>
14241426
<ol class="Ordered numeric">
14251427
<li class="Ordered-1 Ordered">
14261428
Start the 2D X server if it isn&rsquo;t started already.
1429+
<div class="important"><p class="important">
1430+
This is not necessary with WSL.
1431+
</p></div>
14271432
<dl class="Description">
14281433
<dt class="Description-3 Description">Mac clients</dt>
14291434
<dd class="Description-3 Description">
@@ -1491,9 +1496,9 @@ <h3 id="hd008002001">Procedure</h3>
14911496
<p><code>vglconnect</code> will make two SSH connections into the server,
14921497
the first to find an open port on the server and the second to create
14931498
the SSH tunnel for the VGL Transport and open the secure shell. Because
1494-
of Cygwin limitations, when connecting from a Windows client, it will be
1495-
necessary to enter your SSH password twice unless you are using an SSH
1496-
agent to enable password-less logins.</p>
1499+
of Cygwin limitations, when connecting from a Windows/Cygwin client, it
1500+
will be necessary to enter your SSH password twice unless you are using
1501+
an SSH agent to enable password-less logins.</p>
14971502

14981503
<p><code>vglconnect&nbsp;-s</code> can be used to create multi-layered SSH
14991504
tunnels. For instance, if the VirtualGL server is not directly

‎doc/install.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
It is not necessary to install VirtualGL on the client if using VNC or
66
another type of X proxy.
77

8-
** Installing VirtualGL on Linux
8+
** Installing VirtualGL on Linux (Including WSL)
99

1010
!!! If you are installing VirtualGL onto a fresh server, and you also intend
1111
to install the nVidia proprietary drivers, install VirtualGL prior to the
@@ -19,7 +19,7 @@
1919
GLIBC 2.17 or later.
2020
{nl}
2121
!!! If you want to run both 32-bit and 64-bit OpenGL applications with
22-
VirtualGL on 64-bit x86 Linux systems, then you will need to install both
22+
VirtualGL on x86-64 Linux servers, then you will need to install both
2323
{file: VirtualGL-{val: _VERSION}.x86_64.rpm} and
2424
{file: VirtualGL-{val: _VERSION}.i386.rpm}, or both
2525
{file: virtualgl_{val: _VERSION}_amd64.deb} and
@@ -84,7 +84,7 @@ VirtualGL from source.
8484

8585
** Uninstalling VirtualGL
8686

87-
*** Linux
87+
*** Linux (Including WSL)
8888
#OPT: noList! plain!
8989

9090
As root, issue one of the following commands:

‎doc/sysreq.txt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,8 @@
7373
|
7474
| Other Software \
7575
| {list type=ul: \
76-
{item:[[http://x.cygwin.com][Cygwin/X]]} \
76+
{item:Windows Subsystem for Linux (WSL) 2 or \
77+
[[http://x.cygwin.com][Cygwin/X]]} \
7778
{item:Client display must have a 24-bit or 32-bit color depth \
7879
(True Color.)}} \
7980
|

‎doc/vgltransportusage.txt‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ traffic is encrypted, but the VGL Transport is left unencrypted.
3434

3535
#. Start the 2D X server if it isn't started already.
3636

37+
!!! This is not necessary with WSL.
38+
3739
Mac clients :: Start XQuartz.
3840

3941
Cygwin clients :: Start Cygwin/X.
@@ -88,7 +90,7 @@ pass a ''-s'' argument to ''vglconnect'' when connecting to the server:
8890
''vglconnect'' will make two SSH connections into the server, the first to find
8991
an open port on the server and the second to create the SSH tunnel for the VGL
9092
Transport and open the secure shell. Because of Cygwin limitations, when
91-
connecting from a Windows client, it will be necessary to enter your SSH
93+
connecting from a Windows/Cygwin client, it will be necessary to enter your SSH
9294
password twice unless you are using an SSH agent to enable password-less
9395
logins.
9496

‎doc/windowsconfig.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
* Configuring a Windows Machine as a VGL Transport Client
1+
* Configuring a Windows/Cygwin Machine as a VGL Transport Client
22

33
The VirtualGL Client can take advantage of the ''MIT-SHM'' extension in
44
Cygwin/X to accelerate the compositing of rendered frames into the 3D

0 commit comments

Comments
 (0)