glfs/xsoft/other/tigervnc.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY tigervnc-download-http "https://github.com/TigerVNC/tigervnc/archive/v&tigervnc-version;/tigervnc-&tigervnc-version;.tar.gz">
  <!ENTITY tigervnc-download-ftp  " ">
  <!ENTITY tigervnc-md5sum        "07f5e217f288c515effb083896e65054">
  <!ENTITY tigervnc-size          "1.3 MB">
  <!ENTITY tigervnc-buildsize     "95 MB">
  <!ENTITY tigervnc-time          "0.5 SBU (Using parallelism=4)">
  <!ENTITY tigervnc-xorg-version  "1.20.7">
]>

<sect1 id="tigervnc" xreflabel="tigervnc-&tigervnc-version;">
  <?dbhtml filename="tigervnc.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Tigervnc-&tigervnc-version;</title>

  <indexterm zone="tigervnc">
    <primary sortas="a-tigervnc">tigervnc</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Tigervnc</title>

    <para>
      <application>Tigervnc</application> 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.
    </para>

    &lfs10_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&tigervnc-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&tigervnc-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &tigervnc-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &tigervnc-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &tigervnc-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &tigervnc-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required file:
          <ulink url="&xorg-download-http;/xserver/xorg-server-&tigervnc-xorg-version;.tar.bz2"/>
        </para>
      </listitem>
    </itemizedlist>

    <note>
      <para>
        The version of <application>Xorg</application> may eventually be a few
        versions out of date, but is required for the customizations needed
        for this package.
      </para>
    </note>

    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Optional files:
            <itemizedlist spacing="compact">
              <listitem>
                <para><ulink url="&sources-anduin-http;/tigervnc/vncserver"/></para>
              </listitem>
              <listitem>
                <para><ulink url="&sources-anduin-http;/tigervnc/vncserver.1"/></para>
              </listitem>
            </itemizedlist>
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Tigervnc Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cmake"/>,
      <xref linkend="fltk"/>,
      <xref linkend="gnutls"/>,
      <xref linkend="libgcrypt"/>,
      <xref linkend="libjpeg"/>,
      <xref linkend="pixman"/>, 
      <xref linkend="xorg7-app"/>, and  
      <xref linkend="xorg7-legacy"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="imagemagick"/> and
      <xref linkend="linux-pam"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/tigervnc"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Tigervnc</title>

    <para>
      Install <application>tigervnc</application> by running the following
      commands:
    </para>

<screen><userinput># Put code in place
mkdir -p unix/xserver &amp;&amp;
tar -xf ../xorg-server-&tigervnc-xorg-version;.tar.bz2 \
    --strip-components=1              \
    -C unix/xserver                   &amp;&amp;
( cd unix/xserver &amp;&amp;
  patch -Np1 -i ../xserver120.patch ) &amp;&amp;

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

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

  CFLAGS="$CFLAGS -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 &amp;&amp;
  make  &amp;&amp;
popd</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>#Install viewer
make install &amp;&amp;

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

[ -e /usr/bin/Xvnc ] || ln -svf $XORG_PREFIX/bin/Xvnc /usr/bin/Xvnc</userinput></screen>
<!-- These are installed as part of 'make install' for the client.
    <para>
      Finally, create a menu entry.  As the
      <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>cat &gt; /usr/share/applications/vncviewer.desktop &lt;&lt; "EOF"
<literal>[Desktop Entry]
Type=Application
Name=TigerVNC Viewer
Comment=VNC client
Exec=/usr/bin/vncviewer
Icon=tigervnc
Terminal=false
StartupNotify=false
Categories=Network;RemoteAccess;</literal>
EOF

install -vm644 media/icons/tigervnc_24.png /usr/share/pixmaps &amp;&amp;
ln -sfv tigervnc_24.png /usr/share/pixmaps/tigervnc.png</userinput></screen>
-->
  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

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

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

    <para>
      <command>[ -e /usr/bin/Xvnc ] || ln ... Xvnc</command>: If the Xvnc server
      is not installed in the <filename class='directory'>/usr/bin</filename>
      directory, then create a link so the <command>vncserver</command> script
      can find it.
    </para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Tigervnc</title>

    <para>
      The default installation of this package makes some changes in the way it
      is used.  The vncserver perl script is placed in /usr/libexec and the
      server is designed to be run via a systemd style .service file or the
      vncsession script as the root user.  The man page for vncserver is placed 
      in section 8 of the man pages.  The new procedures require a display 
      manager to be installed.
    </para>

    <para>

      To restore the previous behavior, as the <systemitem
      class="username">root</systemitem> user:</para>

<screen role="nodump"><userinput>install -m755 --owner=root ../vncserver /usr/bin &amp;&amp;
cp ../vncserver.1 /usr/share/man/man1</userinput></screen>

    <para>
      Using the previous procedures, the user specific configuration files of
      vncserver reside in the <filename class='directory'>.vnc</filename>
      directory in the user's home directory.  The
      <filename>xstartup</filename> file in that directory is a script
      specifying what commands to run when a VNC desktop is started.  If no
      <filename>xstartup</filename> file exists, <command>vncserver</command>
      will try to start an xterm in a twm session.  An example
      <filename>xstartup</filename> would be:
    </para>

<screen>#!/bin/sh
[ -x /etc/vnc/xstartup ] &amp;&amp; exec /etc/vnc/xstartup
[ -r $HOME/.Xresources ] &amp;&amp; xrdb $HOME/.Xresources
startlxde &amp;</screen>

    <para>
      The <filename>xstartup</filename> file must be executable for the
      commands in it to be executed, so run <command>chmod a+x
      ~/.vnc/xstartup</command>.
    </para>

    <para>
      Set up the vnc passwd with <command>vncpasswd</command>. The
      server can then be started with the <command>vncserver</command>
      command.
      See the man pages in section 1 for the vncserver for the server
      system and vncviewer for the remote system.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>Xvnc,
             vncconfig,
             vncpasswd,
             vncserver,
             vncviewer, and
             x0vncserver</seg>

        <seg>libvnc.so</seg>
        <seg>/usr/share/doc/tigervnc-&tigervnc-version;</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="xvnc">
        <term><command>Xvnc</command></term>
        <listitem>
          <para>
            is a X VNC (Virtual Network Computing) server.
             It is based on a standard X server, but it has a
             <quote>virtual</quote> screen rather than a physical one.
          </para>
          <indexterm zone="tigervnc xvnc">
            <primary sortas="b-xvnc">Xvnc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="vncconfig">
        <term><command>vncconfig</command></term>
        <listitem>
          <para>
            is a program to configure and control a VNC server.
          </para>
          <indexterm zone="tigervnc vncconfig">
            <primary sortas="b-vncconfig">vncconfig</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="vncpasswd">
        <term><command>vncpasswd</command></term>
        <listitem>
          <para>
            allows you to set the password used to access VNC desktops.
          </para>
          <indexterm zone="tigervnc vncpasswd">
            <primary sortas="b-vncpasswd">vncpasswd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="vncserver">
        <term><command>vncserver</command></term>
        <listitem>
          <para>
            is a perl script used to start or stop a VNC server.
          </para>
          <indexterm zone="tigervnc vncserver">
            <primary sortas="b-vncserver">vncserver</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="vncviewer">
        <term><command>vncviewer</command></term>
        <listitem>
          <para>
            is a client used to connect to VNC desktops.
          </para>
          <indexterm zone="tigervnc vncviewer">
            <primary sortas="b-vncviewer">vncviewer</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="x0vncserver">
        <term><command>x0vncserver</command></term>
        <listitem>
          <para>
            is a program to make an X display on a physical
            terminal accessible via TigerVNC or compatible viewers.
          </para>
          <indexterm zone="tigervnc x0vncserver">
            <primary sortas="b-x0vncserver">x0vncserver</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>