MAN page from openSUSE Leap 42 xorg-x11-Xvnc-1.9.0-196.1.x86_64.rpm
Section: Virtual Network Computing (1)
vncserver - start or stop a VNC server
]vncserver -kill :display#vncserver -list
is used to start a VNC (Virtual Network Computing) desktop.vncserver
is a Perl script which simplifies the process of starting an Xvnc server. Itruns Xvnc with appropriate options and starts a window manager on the VNCdesktop.
vncservercan be run with no options at all. In this case it will choose the firstavailable display number (usually :1), start Xvnc with that display number,and start the default window manager in the Xvnc session. You can alsospecify the display number, in which case vncserver will attempt to startXvnc with that display number and exit if the display number is notavailable. For example:
- vncserver :13
Editing the file $HOME/.vnc/xstartup allows you to change the applications runat startup (but note that this will not affect an existing VNC session.)
You can get a list of options by passing -h
as an option to vncserver.In addition to the options listed below, any unrecognised options will bepassed to Xvnc - see the Xvnc man page, or "Xvnc -help", for details.
- -name desktop-name
- Each VNC desktop has a name which may be displayed by the viewer. The desktopname defaults to "host:display# (username)", but you canchange it with this option. The desktop name option is passed to the xstartupscript via the $VNCDESKTOP environment variable, which allows you to run adifferent set of applications depending on the name of the desktop.
- -geometry widthxheight
- Specify the size of the VNC desktop to be created. Default is 1024x768.
- -depth depth
- Specify the pixel depth (in bits) of the VNC desktop to be created. Default is24. Other possible values are 8, 15 and 16 - anything else is likely to causestrange behaviour by applications.
- -pixelformat format
- Specify pixel format for Xvnc to use (BGRnnn or RGBnnn). The default fordepth 8 is BGR233 (meaning the most significant two bits represent blue, thenext three green, and the least significant three represent red), the defaultfor depth 16 is RGB565, and the default for depth 24 is RGB888.
- -cc 3
- As an alternative to the default TrueColor visual, this allows you to run anXvnc server with a PseudoColor visual (i.e. one which uses a color map orpalette), which can be useful for running some old X applications which onlywork on such a display. Values other than 3 (PseudoColor) and 4 (TrueColor)for the -cc option may result in strange behaviour, and PseudoColor desktopsmust have an 8-bit depth.
- -kill :display#
- This kills a VNC desktop previously started with vncserver. It does this bykilling the Xvnc process, whose process ID is stored in the file"$HOME/.vnc/host:display#.pid". The-killoption ignores anything preceding the first colon (":") in the displayargument. Thus, you can invoke "vncserver -kill $DISPLAY", for example at theend of your xstartup file after a particular application exits.
- -fp font-path
- If the vncserver script detects that the X Font Server (XFS) is running, itwill attempt to start Xvnc and configure Xvnc to use XFS for font handling.Otherwise, if XFS is not running, the vncserver script will attempt to startXvnc and allow Xvnc to use its own preferred method of font handling (which maybe a hard-coded font path or, on more recent systems, a font catalog.) Inany case, if Xvnc fails to start, the vncserver script will then attempt todetermine an appropriate X font path for this system and start Xvnc usingthat font path.
The-fpargument allows you to override the above fallback logic and specify a fontpath for Xvnc to use.
- Runs Xvnc as a foreground process. This has two effects: (1) The VNC servercan be aborted with CTRL-C, and (2) the VNC server will exit as soon as theuser logs out of the window manager in the VNC session. This may be necessarywhen launching TigerVNC from within certain grid computing environments.
- Automatically kill Xvnc whenever the xstartup script exits. In most cases,this has the effect of terminating Xvnc when the user logs out of the windowmanager.
- Do not run the %HOME/.vnc/xstartup script after launching Xvnc. Thisoption allows you to manually start a window manager in your TigerVNC session.
- -xstartup script
- Run a custom startup script, instead of %HOME/.vnc/xstartup, after launchingXvnc. This is useful to run full-screen applications.
- Lists all VNC desktops started by vncserver.
Several VNC-related files are found in the directory $HOME/.vnc:
- A shell script specifying X applications to be run when a VNC desktop isstarted. If this file does not exist, then vncserver will create a defaultxstartup script which attempts to launch your chosen window manager.
- The optional system-wide equivalent of $HOME/.vnc/config. If this file existsand defines options to be passed to Xvnc, they will be used as defaults forusers. The user's $HOME/.vnc/config overrides settings configured in this file.The overall configuration file load order is: this file, $HOME/.vnc/config,and then /etc/tigervnc/vncserver-config-mandatory. None are required to exist.
- The optional system-wide equivalent of $HOME/.vnc/config. If this file existsand defines options to be passed to Xvnc, they will override any of the sameoptions defined in a user's $HOME/.vnc/config. This file offers a mechanismto establish some basic form of system-wide policy. WARNING! There isnothing stopping users from constructing their own vncserver-like scriptthat calls Xvnc directly to bypass any options defined in/etc/tigervnc/vncserver-config-mandatory. Likewise, any CLI arguments passedto vncserver will override ANY config file setting of the same name. Theoverall configuration file load order is:/etc/tigervnc/vncserver-config-defaults, $HOME/.vnc/config, and then this file.None are required to exist.
- An optional server config file wherein options to be passed to Xvnc are listedto avoid hard-coding them to the physical invocation. List options in this fileone per line. For those requiring an argument, simply separate the option fromthe argument with an equal sign, for example: "geometry=2000x1200" or"securitytypes=vncauth,tlsvnc". Options without an argument are simply listedas a single word, for example: "localhost" or "alwaysshared".
- The VNC password file.
- The log file for Xvnc and applications started in xstartup.
- Identifies the Xvnc process ID, used by the-killoption.
Tristan Richardson, RealVNC Ltd., D. R. Commander and others.
VNC was originally developed by the RealVNC team while at OlivettiResearch Ltd / AT&T Laboratories Cambridge. TightVNC additions wereimplemented by Constantin Kaplinsky. Many other people have sinceparticipated in development, testing and support. This manual is partof the TigerVNC software suite.
- SEE ALSO
This document was created byman2html,using the manual pages.