NAME

vncserver-x11 - VNC® Server in User Mode  

SYNOPSIS

vncserver-x11 [OPTION...]
vncserver-x11 [MODE] [OPTION...] COMMAND  

DESCRIPTION

vncserver-x11 starts VNC Server in User Mode in order to remote the desktop of the currently-logged on user to connected VNC Viewers. When this user logs out, VNC Server automatically stops; all VNC Viewers are disconnected, and cannot reconnect.

Run vncserver-x11 to start VNC Server and wait for connections on port 5900, if it is available. A user interface consisting of a status dialog and, if supported by the window manager, a status icon is displayed, providing connectivity information and convenient access to features such as file transfer and chat.

By default, a VNC Viewer can connect if VNC Server has:

o
An Enterprise or a Personal license by supplying the system credentials of the user starting VNC Server. Specify the Permissions VNC parameter to widen access to other users or groups.
o
A Free license by supplying a password specific to VNC; see vncpasswd(1).

Note that an instance of vncserver-x11 is automatically started (as the root user) by VNC Server in Service Mode; see vncserver-x11-serviced(1).

vncserver-x11 consumes one desktop from your license, as the user starting it.  

COMMANDS

Applying a command to vncserver-x11 performs an auxiliary operation instead of starting VNC Server.

To see a list of valid commands, run vncserver-x11 -help.  

MODE

If applying a COMMAND to interact with the instance of vncserver-x11 started by VNC Server in Service Mode, specify -service.

Otherwise, commands apply automatically to VNC Server in User Mode.  

OPTIONS

Options are VNC parameters, used to configure VNC Server, and also the following:
-iconnect HOST[::PORT]
Establishes a reverse connection to a Listening VNC Viewer on HOST at PORT (5500 by default). See vncviewer(1).
-newinstance
Starts a new instance of VNC Server, providing you have sufficient available desktops; see vnclicense(1). By default, running vncserver-x11 a second time interacts with the first instance.
-showstatus
Displays the status dialog and status icon. This may be useful to force display in some desktop environments.
-vncconfigfile FILE
For convenience, if you have many VNC parameters to specify at the command line, populate a text file (one parameter per line; omit the dash) and reference it using this flag.

To see a list of valid VNC parameters, run vncserver-x11 -help.  

VNC CONFIGURATION FILES

VNC parameters can be specified as command line OPTIONS, but preferably in VNC configuration files. VNC configuration files are available for:
o
All VNC applications, or just VNC Server
o
All users of the computer, or just the user starting VNC Server
o
Policy, in order to lock down VNC Server (Enterprise license required)

When VNC Server starts, VNC parameters are applied in the following order:

1
System-wide VNC configuration files
2
Per-user VNC configuration files
3
Command line OPTIONS
4
Policy VNC configuration files

This means that a particular VNC parameter specified at the command line overrides the same parameter specified in a per-user or in a system-wide VNC configuration file, but is itself overridden by the same parameter specified in a policy VNC configuration file. Policy cannot be changed by users.

Note there is a disadvantage to specifying VNC parameters at the command line: parameters cannot be reloaded while VNC Server is running. VNC configuration files can be reloaded, however, which means that VNC Server can be reconfigured without downtime.

For a list of the VNC configuration files available for VNC Server, and for detailed explanations of individual VNC parameters, start with
http://www.realvnc.com/products/vnc/documentation/latest/guides/user/am1082101.html#Ram86607  

LOGGING

By default, vncserver-x11 logs basic activity to file at $HOME/.vnc/vncserver-x11.log.

To change the log quality, quantity, or destination, specify the Log, LogDir, and LogFile VNC parameters.  

SEE ALSO

vncserver-x11-serviced(1), vnclicense(1), vncinitconfig(1), vncpasswd(1), vncviewer(1)  

AUTHOR

Copyright © 2002-2014 RealVNC Ltd.

VNC is a registered trademark of RealVNC Ltd. in the U.S. and in other countries. Protected by UK patent 2481870.

http://www.realvnc.com