This is an old revision of the document!
This howto explains how to build the MS Windows version of X2Go Client. This howto explains how to build the 32-bit version of X2Go Client on MS Windows. If someone successfully attempts a 64-bit (which should work, but needs to be tested), please contribute to this wiki page.
X2Go Cltient for Windows needs several 3rd-party programmes for being able to run on MS Windows:
All these programmes, as well as many of the libraries, can now be downloaded from x2goclient-contrib.git. Older versions are available from our server
They now also be built from source, or downloaded from their project sites.
You can also copy the 3rd-party components from X2Go Client installation (on MS Windows) directory.
For building X2Go Client, we highly recommend to install MSysGit and Notepad2.
MSysGit provides a Unix-like shell (bash) environment, so that you can use Git easily from the command line.
Notepad2 is a freeware alternative to Notepad shipped with Microsoft Windows. Notepad2 understands UTF-8 text formats (and others) and can handle Unix-style line endings. In case you want to introspect a code file, this tool is very handy.
MinGW is a gcc compiler for Windows. You need it to build X2Go Client.
Since X2Go Client 4.0.3.0, X2Go Client uses Qt 4.8.6 specifically. Qt 4.8.6 uses MinGW 4.8.x. Qt 4.8.6 for Windows recommends this specific build of MinGW, so it is this specific build that you should use.
Extract it to your disk (D:\i686-4.8.2-release-posix-dwarf-rt_v3-rev3\mingw32
in this example).
Finally, you have to add these MinGW executable directories to your PATH environment variable: D:\i686-4.8.2-release-posix-dwarf-rt_v3-rev3\mingw32\bin
, D:\i686-4.8.2-release-posix-dwarf-rt_v3-rev3\mingw32\libexec\gcc\i686-w64-mingw32\4.8.2
.
Using Qt 4.8.5 + MinGW 4.4 is still an option for building X2Go Client 4.0.3.0 and later. It was how X2Go Client 4.0.2.1 and many prior versions were built. Unfortunately, you can not download binaries for this version from MinGW project site any more. You can build it from source or download it from X2Go Site
Extract it to your disk (D:\mingw
in this example).
Finally, you have to add these MinGW executable directories to your PATH environment variable: D:\mingw\bin
, D:\mingw\libexec\gcc\mingw32\4.4.0
.
You need Qt to build X2Go Client from source.
Qt-4.8.6 is tested and recommended for X2Go Client 4.0.3.0 and later.
Download and install the MinGW version of Qt-4.8.6 for Windows from here
In this example D:\Qt\4.8.6 will be chosen as installation directory
Qt-4.8.5 was tested and recommended for X2Go Client 4.0.2.1 and earlier. It is still an option for X2Go Client 4.0.3.0 and later.
Download and install the MinGW version of Qt-4.8.5 for Windows from here
In this example D:\Qt\4.8.5 will be chosen as installation directory
As X2Go Client needs a Qt with SSL support you must install OpenSSL for MS Windows. OpenSSL depends on the Microsoft Visual C++ 2008 Redistributables. Get that (32-bit version, x86) from the Microsoft site and install it prior to installing OpenSSL.
Download the OpenSSL installer for Windows by browsing here and selecting “Win32 OpenSSL v1.0.1*” where “1.0.1*” s the current version. You can also download it from our site, but only do so if we have the current version. Install it on your build system (for example to directory d:\OpenSSL-Win32
).
After installation, copy OpenSSL header files into MinGW's include directory:
For MinGW 4.8:
d:\OpenSSL-Win32\include\openssl -> d:\i686-4.8.2-release-posix-dwarf-rt_v3-rev3\mingw32\i686-w64-mingw32\include\openssl
For MinGW 4.4:
d:\OpenSSL-Win32\include\openssl -> d:\mingw\include\openssl
It is recommended to configure Qt to build statically linked applications.
This is how official X2Go Client builds are done
It will take some time to reconfigure Qt for static builds. You surely can skip this step, but in this case you must provide Qt libraries with your X2Go Client binary.
Open Qt Command Prompt and start configuration script.
For Qt 4.8.6, the command needs extra args due to QTBUG-38706:
$ configure -release -static -openssl -qt-style-windowsxp -qt-style-windowsvista
For Qt 4.8.5:
$ configure -release -static -openssl
For either version of Qt, rebuild Qt:
$ make sub-src
If you choose to build dynamically linked applications with Qt, you still have to rebuild Qt in order to get OpenSSL support into Qt.
Open Qt Command Prompt and start configuration script.
For Qt 4.8.6, the command needs extra args due to QTBUG-38706:
$ configure -release -openssl -qt-style-windowsxp -qt-style-windowsvista
For Qt 4.8.5:
$ configure -release -openssl
For either version of Qt, rebuild Qt:
$ make sub-src
You need libssh to build X2Go Client.
X2Go Client 4.0.3.0 and later use libssh 0.6.3 with pageant support.
Get the library package built with MinGW 4.8.x (currently 4.8.2) from x2goclient-contrib.git
Or for MingW 4.4.0, here on our site. And then extract files from archive.
Copy headers files in “include” directory of MinGW.
For MinGW 4.8:
x2goclient-contrib\libssh\0.6.3-762055b-pageant-support-mingw482_bin\include\libssh -> d:\i686-4.8.2-release-posix-dwarf-rt_v3-rev3\mingw32\i686-w64-mingw32\include\libssh
For MinGW 4.4:
libssh\include\libssh -> d:\mingw\include\libssh
Copy library files in “lib” directory of MinGW
For MinGW 4.8:
x2goclient-contrib\libssh\0.6.3-762055b-pageant-support-mingw482_bin\lib\*.* -> d:\i686-4.8.2-release-posix-dwarf-rt_v3-rev3\mingw32\i686-w64-mingw32\lib\
For MinGW 4.4:
libssh\lib\*.* -> d:\mingw\lib\
Open Qt Command Prompt, change to your build directory and get X2Go Client sources from git
$ git clone git://code.x2go.org/x2goclient.git $ cd x2goclient
Generate the changelog, which x2goclient.exe –changelog will show:
$ copy debian\changelog txt\ git --no-pager log --since "2 years ago" --format="%ai %aN (%h) %n%n%x09*%w(68,0,10) %s%d%n" > ChangeLog.gitlog $ copy ChangeLog.gitlog txt\git-info
Build X2Go Client:
$ cd x2goclient $ PATH=%PATH%;D:\i686-4.8.2-release-posix-dwarf-rt_v3-rev3\mingw32\bin\ $ config_win.bat $ mingw32-make $ cd x2gohelper $ mingw32-make $ cd ..
X2Go Client binaries (x2goclient.exe & x2gohelper.exe) are in d:\build\x2goclient\release\ directory.
Repeat the instructions for “Build X2Go Client from source”, except
Are replaced with the following:
You may want to pack X2Go Client to reduce it size. You can do it with upx, which is available for Windows, Linux and Cygwin.
To make X2Go Client usable on Windows, you must put X2Go Client binary and all libraries and components in one directory.
All of the files referenced below (apart from x2goclient.exe) can be obtained from x2goclient-contrib.git on http://git.x2go.org
In the base directory of your X2Go Client source tree create a folder named dist/
. To this folder you have to add the following components:
release/
folder) to the dist/
folder.D:\MinGW\bin
)libgcc_s_dw2-1.dll
mingwm10.dll
D:\i686-4.8.2-release-posix-dwarf-rt_v3-rev3\mingw32\bin
). (Note that the inclusion of '\' character before the '+' character is to work around a horrible issue in dokuwiki; the actual filenames do not have the '\“ character.)libeay32.dll
ssleay32.dll
libssh.dll
libzip.dll
libz.dll
zlib1.dll
Microsoft.VC90.CRT.manifest
msvcm90.dll
msvcp90.dll
msvcr90.dll
You can download nxproxy, and its libraries here or obtain them from x2goclient-contrib.git directly.
dist/
folder (built from nx-libs.git on http://git.x2go.org):cygXcomp.dll
cygjpeg-8.dll
cygstdc\+\+-6.dll
cygz.dll
cyggcc_s-1.dll
cygpng-3.dll
cygwin1.dll
nxproxy.exe
If you want to build nxproxy from source, you need install and configure Cygwin first.
Download and start the Cygwin installer
Choose your cygwin directory. For example c:\cygwin. Follow installer instructions.
on installer page “Select Packages” you can select programs and libraries that should be installed in your cygwin environment. For building of nxproxy you will need:
autoconf
automake
gcc-core
gcc-g\+\+
git
libX11-devel
libjpeg-devel
libpng-devel
libmpfr4
make
mc
zlib-devel
wget
libjpeg-devel
package, you are now installing libjpeg-turbo instead of the legacy libjpeg . The same applies for the dependency libjpeg8
package, which provides the cygjpeg-8.dll file that you will copy later.
If you are updating the X2Go Windows build VM, X2Go-WinBuilder, install these packages too:
bashdb
bash-completion
chere
colorgcc
colordiff
diffutils
dos2unix
cygcheck-dep
cygutils-extra
indent
renameutils
vim
git-completion
patch
patchutils
openssh
xz
unzip
nano
bzip2
time
$ cd /cygdrive/d/Build
$ wget http://code.x2go.org/releases/source/nx-libs/nx-libs-3.5.0.27-lite.tar.gz $ tar -xvzf nx-libs-3.5.0.27-lite.tar.gz $ cd nx-libs-3.5.0.27
$ cd nxcomp $ autoconf $ ./configure $ make $ cd ..
$ cd nxproxy $ autoconf $ ./configure $ make $ strip nxproxy.exe $ cd ..
Now the nxproxy binary (nxproxy.exe) is ready. You can copy it into the programme packaging folder (dist/
) of X2Go Client. To be able to run nxproxy you must also copy required libraries into the dist/
folder:
nxproxy.exe
cygXcomp.dll
cyggcc_s-1.dll
cygjpeg-8.dll
cygpng15-15.dll
cygstdc\+\+-6.dll
cygwin1.dll
cygz.dll
$ cd /usr/bin $ cp --preserve=time -t /cygdrive/d/Build/cygwin-2014-09-16/ cyggcc_s-1.dll cygjpeg-8.dll cygpng15-15.dll cygstdc++-6.dll cygwin1.dll cygz.dll
X2Go Client for Windows using modified Cygwin Open SSH Server for file sharing. You can download it here
If you want to build it from source, you should install Cygwin first.
After that run Cygwin installer (setup.exe), navigate to “Select Packages” page and install additional packages, you need to build Open SSH Server:
For openssh you should install both, binary and source packages (toggle “Src” checkbox beside of package name). Source package will be installed in /usr/src directory in your Cygwin installation.
Copy the source folder (downloaded and extracted from a tarball by cygwin) to your build directory. In this example d:\Build will be used
$cp -pr /usr/src/openssh-6.1.1p1-3-src /cygdrive/d/Build/
cd to the openssh source directory, extract the upstream (openssh.com) tarball within, and cd to the lower-level source directory
$cd /cygdrive/d/Build/openssh-6.6.1p1-3 $tar -xzvf openssh-6.6p1.tar.gz $cd openssh-6.6p1
Apply any patches that cygwin provides. For example, with 6.6p1-3:
$patch < ../curve25519-sha256.patch
Get and apply the X2Go patch, which enables use of the Open SSH Server with X2Go Client
$wget http://code.x2go.org/releases/source/openssh-cygwin/openssh-6.6p1-1.x2go.patch ../ $patch.exe < ../openssh-6.6p1-1.x2go.patch
Build Open SSH Server
$./configure --libexecdir=/usr/sbin --with-libedit --with-xauth=/usr/bin/xauth --build=mingw32w32 $make $strip *.exe
Open SSH Server binaries are ready. Now you can copy them in to the installation directory of x2goclient:
To be able to run Open SSH Server you should also copy needed programs and libraries from cygwin directory (c:\cygwin\bin).
1st, copy these files over without changing their filenames.
2nd, copy the Dash executable over and rename it:
ash.exe -> sh.exe
Some of these libraries are also used by nxproxy. Open SSH Server and nxproxy should be built using same version of Cygwin.
You can download PulseAudio 5.0 for Windows here.
Prior versions of PulseAudio are available from project site and the above link.
You can download the X2Go project's modified version of VcXsrv (VcXsrv - XP Compatible) http://code.x2go.org/releases/binary-win32/3rd-party/vcxsrv-modified-by-x2go-project/.
Building VcXsrv from source is not the part of this Howto. However, it is documented under the source repo
All official X2Go Project builds use the 32-bit builds of VcXsrv. 64-bit builds are probably compatible with the 32-bit X2Go Client, but have not been tested. Furthermore, the XP compatible builds are only offered in 32-bit.
If you are doing an official X2Go Project build of X2Go Client 4.0.3.0, use the version: 1.15.2.1+xp-vc2013+x2go1 The ”+x2go1“ in the version string implies that an X2Go-specific patch, winmultiwindow.patch has been applied. It is believed that this patch cannot be upstreamed.
If you do install VcXsrv the setup installer, and you are building X2Go Client 4.0.2.1, deselect to install the fonts. They would more than double the size of the X2Go NSIS installer. Some legacy apps do need them, and users can install them if they'd like.
If you do install VcXsrv the setup installer, and you are building X2Go Client 4.0.3.0, select to install the fonts. They will be an optional component of X2Go Client for Windows in its installer.
Also, if you are doing an official X2Go Project build, remove these files that X2Go Client does not need and would take up extra space:
Also, if you are doing an official X2Go Project build, create this file in the VcXsrv folder:
And specify the version string of VcXsrv in it. The version string should be the only contents of the file. For example:
1.15.2.1+xp-vc2013+x2go1
you can download PuTTY for Windows from project site. Building PuTTY from source is not the part of this Howto
These are the only binaries you need from PuTTY. Copy them directly into the dist/
folder.