source: xsoft/other/tigervnc.xml@ f37b5a3

10.1 11.0 ken/refactor-virt lazarus qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since f37b5a3 was f37b5a3, checked in by Bruce Dubbs <bdubbs@…>, 17 months ago

Reformat tigervnc configuration instructions

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@23716 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 12.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 "07f5e217f288c515effb083896e65054">
10 <!ENTITY tigervnc-size "1.3 MB">
11 <!ENTITY tigervnc-buildsize "95 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 <othername>$LastChangedBy$</othername>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>Tigervnc-&tigervnc-version;</title>
25
26 <indexterm zone="tigervnc">
27 <primary sortas="a-tigervnc">tigervnc</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to Tigervnc</title>
32
33 <para>
34 <application>Tigervnc</application> is an advanced VNC (Virtual
35 Network Computing) implementation. It allows creation of an Xorg server
36 not tied to a physical console and also provides a client for
37 viewing of the remote graphical desktop.
38 </para>
39
40 &lfs10_checked;
41
42 <bridgehead renderas="sect3">Package Information</bridgehead>
43 <itemizedlist spacing="compact">
44 <listitem>
45 <para>
46 Download (HTTP): <ulink url="&tigervnc-download-http;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download (FTP): <ulink url="&tigervnc-download-ftp;"/>
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download MD5 sum: &tigervnc-md5sum;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Download size: &tigervnc-size;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated disk space required: &tigervnc-buildsize;
67 </para>
68 </listitem>
69 <listitem>
70 <para>
71 Estimated build time: &tigervnc-time;
72 </para>
73 </listitem>
74 </itemizedlist>
75
76 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
77 <itemizedlist spacing="compact">
78 <listitem>
79 <para>
80 Required file:
81 <ulink url="&xorg-download-http;/xserver/xorg-server-&tigervnc-xorg-version;.tar.bz2"/>
82 </para>
83 </listitem>
84 </itemizedlist>
85
86 <note>
87 <para>
88 The version of <application>Xorg</application> may eventually be a few
89 versions out of date, but is required for the customizations needed
90 for this package.
91 </para>
92 </note>
93
94 <itemizedlist spacing="compact">
95 <listitem>
96 <para>
97 Optional files:
98 <itemizedlist spacing="compact">
99 <listitem>
100 <para><ulink url="&sources-anduin-http;/tigervnc/vncserver"/></para>
101 </listitem>
102 <listitem>
103 <para><ulink url="&sources-anduin-http;/tigervnc/vncserver.1"/></para>
104 </listitem>
105 </itemizedlist>
106 </para>
107 </listitem>
108 </itemizedlist>
109
110 <bridgehead renderas="sect3">Tigervnc Dependencies</bridgehead>
111
112 <bridgehead renderas="sect4">Required</bridgehead>
113 <para role="required">
114 <xref linkend="cmake"/>,
115 <xref linkend="fltk"/>,
116 <xref linkend="gnutls"/>,
117 <xref linkend="libgcrypt"/>,
118 <xref linkend="libjpeg"/>,
119 <xref linkend="pixman"/>,
120 <xref linkend="xorg7-app"/>, and
121 <xref linkend="xorg7-legacy"/>
122 </para>
123
124 <bridgehead renderas="sect4">Recommended</bridgehead>
125 <para role="recommended">
126 <xref linkend="imagemagick"/> and
127 <xref linkend="linux-pam"/>
128 </para>
129
130 <para condition="html" role="usernotes">User Notes:
131 <ulink url="&blfs-wiki;/tigervnc"/></para>
132
133 </sect2>
134
135 <sect2 role="installation">
136 <title>Installation of Tigervnc</title>
137
138 <para>
139 Install <application>tigervnc</application> by running the following
140 commands:
141 </para>
142
143<screen><userinput># Put code in place
144mkdir -p unix/xserver &amp;&amp;
145tar -xf ../xorg-server-&tigervnc-xorg-version;.tar.bz2 \
146 --strip-components=1 \
147 -C unix/xserver &amp;&amp;
148( cd unix/xserver &amp;&amp;
149 patch -Np1 -i ../xserver120.patch ) &amp;&amp;
150
151# Build viewer
152cmake -G "Unix Makefiles" \
153 -DCMAKE_INSTALL_PREFIX=/usr \
154 -DCMAKE_BUILD_TYPE=Release \
155 -Wno-dev . &amp;&amp;
156make &amp;&amp;
157
158# Build server
159pushd unix/xserver &amp;&amp;
160 autoreconf -fiv &amp;&amp;
161
162 CFLAGS="$CFLAGS -I/usr/include/drm" \
163 ./configure $XORG_CONFIG \
164 --disable-xwayland --disable-dri --disable-dmx \
165 --disable-xorg --disable-xnest --disable-xvfb \
166 --disable-xwin --disable-xephyr --disable-kdrive \
167 --disable-devel-docs --disable-config-hal --disable-config-udev \
168 --disable-unit-tests --disable-selective-werror \
169 --disable-static --enable-dri3 \
170 --without-dtrace --enable-dri2 --enable-glx \
171 --with-pic &amp;&amp;
172 make &amp;&amp;
173popd</userinput></screen>
174
175 <para>
176 This package does not come with a test suite.
177 </para>
178
179 <para>
180 Now, as the <systemitem class="username">root</systemitem> user:
181 </para>
182
183<screen role="root"><userinput>#Install viewer
184make install &amp;&amp;
185
186#Install server
187( cd unix/xserver/hw/vnc &amp;&amp; make install ) &amp;&amp;
188
189[ -e /usr/bin/Xvnc ] || ln -svf $XORG_PREFIX/bin/Xvnc /usr/bin/Xvnc</userinput></screen>
190<!-- These are installed as part of 'make install' for the client.
191 <para>
192 Finally, create a menu entry. As the
193 <systemitem class="username">root</systemitem> user:
194 </para>
195
196<screen role="root"><userinput>cat &gt; /usr/share/applications/vncviewer.desktop &lt;&lt; "EOF"
197<literal>[Desktop Entry]
198Type=Application
199Name=TigerVNC Viewer
200Comment=VNC client
201Exec=/usr/bin/vncviewer
202Icon=tigervnc
203Terminal=false
204StartupNotify=false
205Categories=Network;RemoteAccess;</literal>
206EOF
207
208install -vm644 media/icons/tigervnc_24.png /usr/share/pixmaps &amp;&amp;
209ln -sfv tigervnc_24.png /usr/share/pixmaps/tigervnc.png</userinput></screen>
210-->
211 </sect2>
212
213 <sect2 role="commands">
214 <title>Command Explanations</title>
215
216 <para>
217 <command>tar -xf .. xorg-server...</command>: This command extracts the
218 standard Xorg package into the tree in a location needed for modification.
219 </para>
220
221 <para>
222 <option>--disable ...</option>: Most options that are usually needed for
223 the standard Xorg server are not needed for the Xvnc instance being built.
224 </para>
225
226 <para>
227 <command>[ -e /usr/bin/Xvnc ] || ln ... Xvnc</command>: If the Xvnc server
228 is not installed in the <filename class='directory'>/usr/bin</filename>
229 directory, then create a link so the <command>vncserver</command> script
230 can find it.
231 </para>
232
233 </sect2>
234
235 <sect2 role="configuration">
236 <title>Configuring Tigervnc</title>
237
238 <para>
239 The default installation of this package makes some changes in the way it
240 is used. The vncserver perl script is placed in /usr/libexec and the
241 server is designed to be run via a systemd style .service file or the
242 vncsession script as the root user. The man page for vncserver is placed
243 in section 8 of the man pages. The new procedures require a display
244 manager to be installed.
245 </para>
246
247 <para>
248
249 To restore the previous behavior, as the <systemitem
250 class="username">root</systemitem> user:</para>
251
252<screen role="nodump"><userinput>install -m755 --owner=root ../vncserver /usr/bin &amp;&amp;
253cp ../vncserver.1 /usr/share/man/man1</userinput></screen>
254
255 <para>
256 Using the previous procedures, the user specific configuration files of
257 vncserver reside in the <filename class='directory'>.vnc</filename>
258 directory in the user's home directory. The
259 <filename>xstartup</filename> file in that directory is a script
260 specifying what commands to run when a VNC desktop is started. If no
261 <filename>xstartup</filename> file exists, <command>vncserver</command>
262 will try to start an xterm in a twm session. An example
263 <filename>xstartup</filename> would be:
264 </para>
265
266<screen>#!/bin/sh
267[ -x /etc/vnc/xstartup ] &amp;&amp; exec /etc/vnc/xstartup
268[ -r $HOME/.Xresources ] &amp;&amp; xrdb $HOME/.Xresources
269startlxde &amp;</screen>
270
271 <para>
272 The <filename>xstartup</filename> file must be executable for the
273 commands in it to be executed, so run <command>chmod a+x
274 ~/.vnc/xstartup</command>.
275 </para>
276
277 <para>
278 Set up the vnc passwd with <command>vncpasswd</command>. The
279 server can then be started with the <command>vncserver</command>
280 command.
281 See the man pages in section 1 for the vncserver for the server
282 system and vncviewer for the remote system.
283 </para>
284
285 </sect2>
286
287 <sect2 role="content">
288 <title>Contents</title>
289
290 <segmentedlist>
291 <segtitle>Installed Programs</segtitle>
292 <segtitle>Installed Libraries</segtitle>
293 <segtitle>Installed Directories</segtitle>
294
295 <seglistitem>
296 <seg>Xvnc,
297 vncconfig,
298 vncpasswd,
299 vncserver,
300 vncviewer, and
301 x0vncserver</seg>
302
303 <seg>libvnc.so</seg>
304 <seg>/usr/share/doc/tigervnc-&tigervnc-version;</seg>
305 </seglistitem>
306 </segmentedlist>
307
308 <variablelist>
309 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
310 <?dbfo list-presentation="list"?>
311 <?dbhtml list-presentation="table"?>
312
313 <varlistentry id="xvnc">
314 <term><command>Xvnc</command></term>
315 <listitem>
316 <para>
317 is a X VNC (Virtual Network Computing) server.
318 It is based on a standard X server, but it has a
319 <quote>virtual</quote> screen rather than a physical one.
320 </para>
321 <indexterm zone="tigervnc xvnc">
322 <primary sortas="b-xvnc">Xvnc</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 <varlistentry id="vncconfig">
328 <term><command>vncconfig</command></term>
329 <listitem>
330 <para>
331 is a program to configure and control a VNC server.
332 </para>
333 <indexterm zone="tigervnc vncconfig">
334 <primary sortas="b-vncconfig">vncconfig</primary>
335 </indexterm>
336 </listitem>
337 </varlistentry>
338
339 <varlistentry id="vncpasswd">
340 <term><command>vncpasswd</command></term>
341 <listitem>
342 <para>
343 allows you to set the password used to access VNC desktops.
344 </para>
345 <indexterm zone="tigervnc vncpasswd">
346 <primary sortas="b-vncpasswd">vncpasswd</primary>
347 </indexterm>
348 </listitem>
349 </varlistentry>
350
351 <varlistentry id="vncserver">
352 <term><command>vncserver</command></term>
353 <listitem>
354 <para>
355 is a perl script used to start or stop a VNC server.
356 </para>
357 <indexterm zone="tigervnc vncserver">
358 <primary sortas="b-vncserver">vncserver</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="vncviewer">
364 <term><command>vncviewer</command></term>
365 <listitem>
366 <para>
367 is a client used to connect to VNC desktops.
368 </para>
369 <indexterm zone="tigervnc vncviewer">
370 <primary sortas="b-vncviewer">vncviewer</primary>
371 </indexterm>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry id="x0vncserver">
376 <term><command>x0vncserver</command></term>
377 <listitem>
378 <para>
379 is a program to make an X display on a physical
380 terminal accessible via TigerVNC or compatible viewers.
381 </para>
382 <indexterm zone="tigervnc x0vncserver">
383 <primary sortas="b-x0vncserver">x0vncserver</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 </variablelist>
389
390 </sect2>
391
392</sect1>
Note: See TracBrowser for help on using the repository browser.