source: xsoft/other/tigervnc.xml@ a027bdde

11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since a027bdde was a027bdde, checked in by Pierre Labastie <pierre.labastie@…>, 2 years ago

tigervnc: tidy up additional downloads

  • the current layout with two sublists confuses jhalfs. Get back to a one subblist layout
  • this allows running the additional commands as root, instead of bypassing them
  • also fix an option tag that should be parameter
  • TOD0: systemd configuration section is confusing: it talks about "another method of configuration" but there is only one. Also "added benefit" is used twice in a way that seems redundant, but I am not sure what to do.
  • Property mode set to 100644
File size: 17.1 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY tigervnc-download-http "https://github.com/TigerVNC/tigervnc/archive/v&tigervnc-version;/tigervnc-&tigervnc-version;.tar.gz">
8 <!ENTITY tigervnc-download-ftp " ">
9 <!ENTITY tigervnc-md5sum "e92945f43654e2a120f2c9d8b3a9b869">
10 <!ENTITY tigervnc-size "1.5 MB">
11 <!ENTITY tigervnc-buildsize "101 MB">
12 <!ENTITY tigervnc-time "0.5 SBU (Using parallelism=4)">
13 <!ENTITY tigervnc-xorg-version "1.20.7">
14]>
15
16<sect1 id="tigervnc" xreflabel="tigervnc-&tigervnc-version;">
17 <?dbhtml filename="tigervnc.html"?>
18
19 <sect1info>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Tigervnc-&tigervnc-version;</title>
24
25 <indexterm zone="tigervnc">
26 <primary sortas="a-tigervnc">tigervnc</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Tigervnc</title>
31
32 <para>
33 <application>Tigervnc</application> is an advanced VNC (Virtual
34 Network Computing) implementation. It allows creation of an Xorg server
35 not tied to a physical console and also provides a client for
36 viewing of the remote graphical desktop.
37 </para>
38
39 &lfs110a_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&tigervnc-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&tigervnc-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &tigervnc-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &tigervnc-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &tigervnc-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &tigervnc-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
76 <itemizedlist spacing="compact">
77 <listitem>
78 <para>
79 Required file:
80 <ulink url="&xorg-download-http;/xserver/xorg-server-&tigervnc-xorg-version;.tar.bz2"/>
81 </para>
82 </listitem>
83 </itemizedlist>
84
85 <note>
86 <para>
87 The version of <application>Xorg</application> may eventually be a few
88 versions out of date, but is required for the customizations needed
89 for this package.
90 </para>
91 </note>
92
93 <itemizedlist spacing="compact">
94 <listitem>
95 <para>
96 Required patch:
97 <ulink url="&patch-root;/tigervnc-&tigervnc-version;-configuration_fixes-1.patch"/>
98 </para>
99 </listitem>
100 <listitem revision='sysv'>
101 <para>
102 Optional file to start the server without a display manager:
103 <ulink url="&sources-anduin-http;/tigervnc/vncserver"/>
104 </para>
105 </listitem>
106 <listitem revision='sysv'>
107 <para>
108 Optional manual page:
109 <ulink url="&sources-anduin-http;/tigervnc/vncserver.1"/>
110 </para>
111 </listitem>
112 <listitem revision='systemd'>
113 <para>
114 Optional file to start the server without a display manager:
115 <ulink url="&sources-anduin-http;/tigervnc/Xsession"/>
116 </para>
117 </listitem>
118 </itemizedlist>
119
120 <bridgehead renderas="sect3">Tigervnc Dependencies</bridgehead>
121
122 <bridgehead renderas="sect4">Required</bridgehead>
123 <para role="required">
124 <xref linkend="cmake"/>,
125 <xref linkend="fltk"/>,
126 <xref linkend="gnutls"/>,
127 <xref linkend="libgcrypt"/>,
128 <xref linkend="libjpeg"/>,
129 <xref linkend="pixman"/>,
130 <xref linkend="xorg7-app"/>, and
131 <xref linkend="xorg7-legacy"/>
132 </para>
133
134 <bridgehead renderas="sect4">Recommended</bridgehead>
135 <para role="recommended">
136 <xref linkend="imagemagick"/> and
137 <xref linkend="linux-pam"/>
138 </para>
139
140 <para condition="html" role="usernotes">User Notes:
141 <ulink url="&blfs-wiki;/tigervnc"/></para>
142
143 </sect2>
144
145 <sect2 role="installation">
146 <title>Installation of Tigervnc</title>
147
148 <para>
149 First, make adjustments to the configuration files to make them
150 compatible with LFS systems:
151 <!-- Replaces an incompatible PAM file and disables SELinux support
152 in systemd units. Also modifies the search path for
153 /usr/libexec/vncserver to include /etc/X11/tigervnc -->
154 </para>
155
156<screen><userinput remap="pre">patch -Np1 -i ../tigervnc-&tigervnc-version;-configuration_fixes-1.patch</userinput></screen>
157
158 <para>
159 Install <application>tigervnc</application> by running the following
160 commands:
161 </para>
162
163<screen revision="sysv"><userinput># Put code in place
164mkdir -p unix/xserver &amp;&amp;
165tar -xf ../xorg-server-&tigervnc-xorg-version;.tar.bz2 \
166 --strip-components=1 \
167 -C unix/xserver &amp;&amp;
168( cd unix/xserver &amp;&amp;
169 patch -Np1 -i ../xserver120.patch ) &amp;&amp;
170
171# Build viewer
172cmake -G "Unix Makefiles" \
173 -DCMAKE_INSTALL_PREFIX=/usr \
174 -DCMAKE_BUILD_TYPE=Release \
175 -DINSTALL_SYSTEMD_UNITS=OFF \
176 -Wno-dev . &amp;&amp;
177make &amp;&amp;
178
179# Build server
180pushd unix/xserver &amp;&amp;
181 autoreconf -fiv &amp;&amp;
182
183 CPPFLAGS="-I/usr/include/drm" \
184 ./configure $XORG_CONFIG \
185 --disable-xwayland --disable-dri --disable-dmx \
186 --disable-xorg --disable-xnest --disable-xvfb \
187 --disable-xwin --disable-xephyr --disable-kdrive \
188 --disable-devel-docs --disable-config-hal --disable-config-udev \
189 --disable-unit-tests --disable-selective-werror \
190 --disable-static --enable-dri3 \
191 --without-dtrace --enable-dri2 --enable-glx \
192 --with-pic &amp;&amp;
193 make &amp;&amp;
194popd</userinput></screen>
195
196<screen revision="systemd"><userinput># Put code in place
197mkdir -p unix/xserver &amp;&amp;
198tar -xf ../xorg-server-&tigervnc-xorg-version;.tar.bz2 \
199 --strip-components=1 \
200 -C unix/xserver &amp;&amp;
201( cd unix/xserver &amp;&amp;
202 patch -Np1 -i ../xserver120.patch ) &amp;&amp;
203
204# Build viewer
205cmake -G "Unix Makefiles" \
206 -DCMAKE_INSTALL_PREFIX=/usr \
207 -DCMAKE_BUILD_TYPE=Release \
208 -Wno-dev . &amp;&amp;
209make &amp;&amp;
210
211# Build server
212pushd unix/xserver &amp;&amp;
213 autoreconf -fiv &amp;&amp;
214
215 CPPFLAGS="-I/usr/include/drm" \
216 ./configure $XORG_CONFIG \
217 --disable-xwayland --disable-dri --disable-dmx \
218 --disable-xorg --disable-xnest --disable-xvfb \
219 --disable-xwin --disable-xephyr --disable-kdrive \
220 --disable-devel-docs --disable-config-hal --disable-config-udev \
221 --disable-unit-tests --disable-selective-werror \
222 --disable-static --enable-dri3 \
223 --without-dtrace --enable-dri2 --enable-glx \
224 --with-pic &amp;&amp;
225 make &amp;&amp;
226popd</userinput></screen>
227
228 <para>
229 This package does not come with a test suite.
230 </para>
231
232 <para>
233 Now, as the <systemitem class="username">root</systemitem> user:
234 </para>
235
236<screen role="root"><userinput>#Install viewer
237make install &amp;&amp;
238
239#Install server
240( cd unix/xserver/hw/vnc &amp;&amp; make install ) &amp;&amp;
241
242[ -e /usr/bin/Xvnc ] || ln -svf $XORG_PREFIX/bin/Xvnc /usr/bin/Xvnc</userinput></screen>
243
244 <para revision="sysv">
245 Finally, modify the PAM file to be compatible with elogind:
246 </para>
247
248<screen role="root" revision="sysv"><userinput>sed -i 's/pam_systemd.so/pam_elogind.so/' /etc/pam.d/tigervnc</userinput></screen>
249
250<!-- These are installed as part of 'make install' for the client.
251 <para>
252 Finally, create a menu entry. As the
253 <systemitem class="username">root</systemitem> user:
254 </para>
255
256<screen role="root"><userinput>cat &gt; /usr/share/applications/vncviewer.desktop &lt;&lt; "EOF"
257<literal>[Desktop Entry]
258Type=Application
259Name=TigerVNC Viewer
260Comment=VNC client
261Exec=/usr/bin/vncviewer
262Icon=tigervnc
263Terminal=false
264StartupNotify=false
265Categories=Network;RemoteAccess;</literal>
266EOF
267
268install -vm644 media/icons/tigervnc_24.png /usr/share/pixmaps &amp;&amp;
269ln -sfv tigervnc_24.png /usr/share/pixmaps/tigervnc.png</userinput></screen>
270-->
271 </sect2>
272
273 <sect2 role="commands">
274 <title>Command Explanations</title>
275
276 <para>
277 <command>tar -xf .. xorg-server...</command>: This command extracts the
278 standard Xorg package into the tree in a location needed for modification.
279 </para>
280
281 <para>
282 <parameter>--disable ...</parameter>: Most options that are usually
283 needed for the standard Xorg server are not needed for the Xvnc
284 instance being built.
285 </para>
286
287 <para>
288 <command>[ -e /usr/bin/Xvnc ] || ln ... Xvnc</command>: If the Xvnc server
289 is not installed in the <filename class='directory'>/usr/bin</filename>
290 directory, then create a link so the <command>vncserver</command> script
291 can find it.
292 </para>
293
294 </sect2>
295
296 <sect2 role="configuration">
297 <title>Configuring Tigervnc</title>
298
299 <para revision='sysv'>
300 The default installation of this package makes some changes in the way it
301 is used. The vncserver perl script is placed in /usr/libexec and the
302 server is designed to be run via a systemd style .service file or the
303 vncsession script as the root user. The man page for vncserver is placed
304 in section 8 of the man pages. The new procedures require a display
305 manager to be installed.
306 </para>
307
308 <para revision='sysv'>
309 To restore the previous behavior, install the additional downloaded
310 files as the <systemitem class="username">root</systemitem> user:</para>
311
312<screen role="root" revision='sysv'><userinput>install -m755 --owner=root ../vncserver /usr/bin &amp;&amp;
313cp ../vncserver.1 /usr/share/man/man1</userinput></screen>
314
315 <para revision='sysv'>
316 Using the previous procedures, the user specific configuration files of
317 vncserver reside in the <filename class='directory'>.vnc</filename>
318 directory in the user's home directory. The
319 <filename>xstartup</filename> file in that directory is a script
320 specifying what commands to run when a VNC desktop is started. If no
321 <filename>xstartup</filename> file exists, <command>vncserver</command>
322 will try to start an xterm in a twm session. An example
323 <filename>xstartup</filename> would be:
324 </para>
325
326<screen revision='sysv'>#!/bin/sh
327[ -x /etc/vnc/xstartup ] &amp;&amp; exec /etc/vnc/xstartup
328[ -r $HOME/.Xresources ] &amp;&amp; xrdb $HOME/.Xresources
329startlxde &amp;</screen>
330
331 <para revision='sysv'>
332 The <filename>xstartup</filename> file must be executable for the
333 commands in it to be executed, so run <command>chmod a+x
334 ~/.vnc/xstartup</command>.
335 </para>
336
337 <para revision='sysv'>
338 Set up the vnc passwd with <command>vncpasswd</command>. The
339 server can then be started with the <command>vncserver</command>
340 command.
341 See the man pages in section 1 for the vncserver for the server
342 system and vncviewer for the remote system.
343 </para>
344
345 <bridgehead renderas="sect3" revision="systemd">Server Configuration</bridgehead>
346
347 <!--
348 <note revision="systemd">
349 <para>
350 This section is optional and is only useful if you want to have VNC
351 sessions launch on system startup. Both configuration methods can
352 coexist on the same system.
353 </para>
354 </note>
355 -->
356 <para revision="systemd">
357 On systemd systems, another method of configuration is available.
358 This configuration provides the added benefit of making tigervnc
359 systemd aware for VNC sessions and allows desktop environments like
360 <application>GNOME</application> to autostart services once the VNC
361 session is started. This configuration also gives the added benefit
362 of starting VNC Sessions on system startup. To setup the VNC server
363 in this fashion, follow these instructions.
364 </para>
365
366 <para revision="systemd">
367 First, install a rudimentary Xsession file so that the VNC server
368 can initialize X sessions properly:
369 </para>
370
371<screen role="root" revision="systemd"><userinput>install -vdm755 /etc/X11/tigervnc &amp;&amp;
372install -v -m755 ../Xsession /etc/X11/tigervnc</userinput></screen>
373
374 <para revision="systemd">
375 Next, setup a user mapping in
376 <filename>/etc/tigervnc/vncserver.users</filename>. This tells the VNC
377 Server which session is allocated to a user.
378 <!-- For example: :1=renodr will assign 'renodr' to :1 -->
379 </para>
380
381<screen role="root" revision="systemd"><userinput>echo ":1=$(whoami)" >> /etc/tigervnc/vncserver.users</userinput></screen>
382
383 <para revision="systemd">
384 Next, setup a configuration file to tell
385 <application>vncserver</application> which desktop environment should be
386 used and what display geometry should be used. There are several other
387 options that can be defined in this file, but they are outside the scope
388 of BLFS.
389 </para>
390
391<screen revision="systemd"><userinput>cat &gt; ~/.vnc/config &lt;&lt; EOF
392<literal># Begin ~/.vnc/config
393
394session=LXDE # The session must match one listed in /usr/share/xsessions.
395geometry=1024x768
396
397# End ~/.vnc/config</literal>
398EOF</userinput></screen>
399
400 <para revision="systemd">
401 To start the VNC Server, run the following command:
402 </para>
403
404<screen role="root" revision="systemd"><userinput>systemctl start vncserver@:1</userinput></screen>
405
406 <para revision="systemd">
407 To start the VNC Server when the system boots, run the following command:
408 </para>
409
410<screen role="root" revision="systemd"><userinput>systemctl enable vncserver@:1</userinput></screen>
411
412 </sect2>
413
414 <sect2 role="content">
415 <title>Contents</title>
416
417 <segmentedlist>
418 <segtitle>Installed Programs</segtitle>
419 <segtitle>Installed Libraries</segtitle>
420 <segtitle>Installed Directories</segtitle>
421
422 <seglistitem>
423 <seg>Xvnc,
424 vncconfig,
425 vncpasswd,
426 vncserver,
427 vncviewer, and
428 x0vncserver</seg>
429
430 <seg>libvnc.so</seg>
431 <seg>/usr/share/doc/tigervnc-&tigervnc-version;</seg>
432 </seglistitem>
433 </segmentedlist>
434
435 <variablelist>
436 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
437 <?dbfo list-presentation="list"?>
438 <?dbhtml list-presentation="table"?>
439
440 <varlistentry id="xvnc">
441 <term><command>Xvnc</command></term>
442 <listitem>
443 <para>
444 is a X VNC (Virtual Network Computing) server.
445 It is based on a standard X server, but it has a
446 <quote>virtual</quote> screen rather than a physical one
447 </para>
448 <indexterm zone="tigervnc xvnc">
449 <primary sortas="b-xvnc">Xvnc</primary>
450 </indexterm>
451 </listitem>
452 </varlistentry>
453
454 <varlistentry id="vncconfig">
455 <term><command>vncconfig</command></term>
456 <listitem>
457 <para>
458 is a program to configure and control a VNC server
459 </para>
460 <indexterm zone="tigervnc vncconfig">
461 <primary sortas="b-vncconfig">vncconfig</primary>
462 </indexterm>
463 </listitem>
464 </varlistentry>
465
466 <varlistentry id="vncpasswd">
467 <term><command>vncpasswd</command></term>
468 <listitem>
469 <para>
470 allows you to set the password used to access VNC desktops
471 </para>
472 <indexterm zone="tigervnc vncpasswd">
473 <primary sortas="b-vncpasswd">vncpasswd</primary>
474 </indexterm>
475 </listitem>
476 </varlistentry>
477
478 <varlistentry id="vncserver">
479 <term><command>vncserver</command></term>
480 <listitem>
481 <para>
482 is a perl script used to start or stop a VNC server
483 </para>
484 <indexterm zone="tigervnc vncserver">
485 <primary sortas="b-vncserver">vncserver</primary>
486 </indexterm>
487 </listitem>
488 </varlistentry>
489
490 <varlistentry id="vncviewer">
491 <term><command>vncviewer</command></term>
492 <listitem>
493 <para>
494 is a client used to connect to VNC desktops
495 </para>
496 <indexterm zone="tigervnc vncviewer">
497 <primary sortas="b-vncviewer">vncviewer</primary>
498 </indexterm>
499 </listitem>
500 </varlistentry>
501
502 <varlistentry id="x0vncserver">
503 <term><command>x0vncserver</command></term>
504 <listitem>
505 <para>
506 is a program to make an X display on a physical
507 terminal accessible via TigerVNC or compatible viewers
508 </para>
509 <indexterm zone="tigervnc x0vncserver">
510 <primary sortas="b-x0vncserver">x0vncserver</primary>
511 </indexterm>
512 </listitem>
513 </varlistentry>
514
515 </variablelist>
516
517 </sect2>
518
519</sect1>
Note: See TracBrowser for help on using the repository browser.