Beyond Linux® From Scratch (systemd Edition) - Version 11.2

Chapter 41. Other X-based Programs

Tigervnc-1.12.0

Introduction to Tigervnc

Tigervnc is an advanced VNC (Virtual Network Computing) implementation. It allows creation of an Xorg server not tied to a physical console and also provides a client for viewing of the remote graphical desktop.

This package is known to build and work properly using an LFS-11.2 platform.

Package Information

Additional Downloads

[Note]

Note

The version of Xorg may eventually be a few versions out of date, but is required for the customizations needed for this package.

Tigervnc Dependencies

Required

CMake-3.24.1, FLTK-1.3.8, GnuTLS-3.7.7, libgcrypt-1.10.1, libjpeg-turbo-2.1.4, Pixman-0.40.0, Xorg Applications, and Xorg Legacy Fonts

Recommended

ImageMagick-7.1.0-46 and Linux-PAM-1.5.2

User Notes: https://wiki.linuxfromscratch.org/blfs/wiki/tigervnc

Installation of Tigervnc

First, make adjustments to the configuration files to make them compatible with LFS systems: 

patch -Np1 -i ../tigervnc-1.12.0-configuration_fixes-1.patch

Install tigervnc by running the following commands: 

# Put code in place
mkdir -p unix/xserver &&
tar -xf ../xorg-server-1.20.7.tar.bz2 \
    --strip-components=1              \
    -C unix/xserver                   &&
( cd unix/xserver &&
  patch -Np1 -i ../xserver120.patch ) &&

# Build viewer
cmake -G "Unix Makefiles"         \
      -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -Wno-dev . &&
make &&

# Build server
pushd unix/xserver &&
  autoreconf -fiv  &&

  CPPFLAGS="-I/usr/include/drm"       \
  ./configure $XORG_CONFIG            \
      --disable-xwayland    --disable-dri        --disable-dmx         \
      --disable-xorg        --disable-xnest      --disable-xvfb        \
      --disable-xwin        --disable-xephyr     --disable-kdrive      \
      --disable-devel-docs  --disable-config-hal --disable-config-udev \
      --disable-unit-tests  --disable-selective-werror                 \
      --disable-static      --enable-dri3                              \
      --without-dtrace      --enable-dri2        --enable-glx          \
      --with-pic &&
  make  &&
popd

This package does not come with a test suite.

Now, as the root user: 

#Install viewer
make install &&

#Install server
( cd unix/xserver/hw/vnc && make install ) &&

[ -e /usr/bin/Xvnc ] || ln -svf $XORG_PREFIX/bin/Xvnc /usr/bin/Xvnc

Command Explanations

tar -xf .. xorg-server...: This command extracts the standard Xorg package into the tree in a location needed for modification.

--disable ...: Most options that are usually needed for the standard Xorg server are not needed for the Xvnc instance being built.

[ -e /usr/bin/Xvnc ] || ln ... Xvnc: If the Xvnc server is not installed in the /usr/bin directory, then create a link so the vncserver script can find it.

Configuring Tigervnc

Server Configuration

On systemd systems, another method of configuration is available. This configuration provides the added benefit of making tigervnc systemd aware for VNC sessions and allows desktop environments like GNOME to autostart services once the VNC session is started. This configuration also gives the added benefit of starting VNC Sessions on system startup. To setup the VNC server in this fashion, follow these instructions.

First, install a rudimentary Xsession file so that the VNC server can initialize X sessions properly: 

install -vdm755 /etc/X11/tigervnc &&
install -v -m755 ../Xsession /etc/X11/tigervnc

Next, setup a user mapping in /etc/tigervnc/vncserver.users. This tells the VNC Server which session is allocated to a user. 

echo ":1=$(whoami)" >> /etc/tigervnc/vncserver.users

Next, setup a configuration file to tell vncserver which desktop environment should be used and what display geometry should be used. There are several other options that can be defined in this file, but they are outside the scope of BLFS. 

install -vdm 755 ~/.vnc &&
cat > ~/.vnc/config << EOF
# Begin ~/.vnc/config

session=LXDE      # The session must match one listed in /usr/share/xsessions.
geometry=1024x768

# End ~/.vnc/config
EOF

To start the VNC Server, run the following command: 

systemctl start vncserver@:1

To start the VNC Server when the system boots, run the following command: 

systemctl enable vncserver@:1

Contents

Installed Programs: Xvnc, vncconfig, vncpasswd, vncserver, vncviewer, and x0vncserver
Installed Libraries: libvnc.so
Installed Directories: /usr/share/doc/tigervnc-1.12.0

Short Descriptions

Xvnc

is a X VNC (Virtual Network Computing) server. It is based on a standard X server, but it has a “virtual” screen rather than a physical one

vncconfig

is a program to configure and control a VNC server

vncpasswd

allows you to set the password used to access VNC desktops

vncserver

is a perl script used to start or stop a VNC server

vncviewer

is a client used to connect to VNC desktops

x0vncserver

is a program to make an X display on a physical terminal accessible via TigerVNC or compatible viewers