1vncsession(8) Virtual Network Computing vncsession(8)
2
6 vncsession - start a VNC server
7
9 vncsession <username> <:display#>
10
12 vncsession is used to start a VNC (Virtual Network Computing) desktop.
13 vncsession performs all the necessary steps to create a new user ses‐
14 sion, run Xvnc with appropriate options and starts a window manager on
15 the VNC desktop.
16 vncsession is rarely called directly and is normally started by the
18 system service manager.
19
22 Several VNC-related files are found in the directory $HOME/.vnc:
23 /etc/tigervnc/vncserver-config-defaults
25 The optional system-wide equivalent of $HOME/.vnc/config. If
26 this file exists and defines options to be passed to Xvnc, they
27 will be used as defaults for users. The user's $HOME/.vnc/config
28 overrides settings configured in this file. The overall config‐
29 uration file load order is: this file, $HOME/.vnc/config, and
30 then /etc/tigervnc/vncserver-config-mandatory. None are required
31 to exist.
32 /etc/tigervnc/vncserver-config-mandatory
34 The optional system-wide equivalent of $HOME/.vnc/config. If
35 this file exists and defines options to be passed to Xvnc, they
36 will override any of the same options defined in a user's
37 $HOME/.vnc/config. This file offers a mechanism to establish
38 some basic form of system-wide policy. WARNING! There is nothing
39 stopping users from constructing their own vncsession-like
40 script that calls Xvnc directly to bypass any options defined in
41 /etc/tigervnc/vncserver-config-mandatory. The overall configura‐
42 tion file load order is: /etc/tigervnc/vncserver-config-
43 defaults, $HOME/.vnc/config, and then this file. None are
44 required to exist.
45 $HOME/.vnc/config
47 An optional server config file wherein options to be passed to
48 Xvnc are listed to avoid hard-coding them to the physical invo‐
49 cation. List options in this file one per line. For those
50 requiring an argument, simply separate the option from the argu‐
51 ment with an equal sign, for example: "geometry=2000x1200" or
52 "securitytypes=vncauth,tlsvnc". Options without an argument are
53 simply listed as a single word, for example: "localhost" or
54 "alwaysshared".
55 The special option session can be used to control which session
57 type will be started. This should match one of the files in
58 /usr/share/xsessions. E.g. if there is a file called
59 "gnome.desktop", then "session=gnome" would be set to use that
60 session type.
61 $HOME/.vnc/passwd
63 The VNC password file.
64 $HOME/.vnc/host:display#.log
66 The log file for Xvnc and the session.
67
70 vncviewer(1), vncpasswd(1), vncconfig(1), Xvnc(1)
71 https://www.tigervnc.org
72
75 Tristan Richardson, RealVNC Ltd., D. R. Commander and others.
76 VNC was originally developed by the RealVNC team while at Olivetti
78 Research Ltd / AT&T Laboratories Cambridge. TightVNC additions were
79 implemented by Constantin Kaplinsky. Many other people have since par‐
80 ticipated in development, testing and support. This manual is part of
81 the TigerVNC software suite.
82TigerVNC vncsession(8)