vnc.conf - configuration file for Virtual Network Computing
SYNOPSIS
$variable = someValue ;
$variable = someValue ;
$variable .= someValue ;
$variable = $var1 . $var2;
DESCRIPTION
/etc/vnc.conf
is the site wide configuration file for
vncserver(1),
the free X server for
Virtual Network Computing
(VNC). It can be used to change the behaviour of the server at startup time,
although for all values exist suitable default values.
vnc.conf
will be parsed by vncserver. Then vncserver will proceed and read
~/.vncrc,
a file that can be changed on a per-user base. It has the some syntax and
options as the file described in this document.
EXAMPLES
A sample examplae file should come with the Debian package, under
/usr/share/doc/vncserver/examples/vnc.conf.gz.Itisprettyself-descriptive,andthis
document will mainly repeat the information that already can be found there.
OVERVIEW
The file is in
perl(1)
syntax, although only variable assignment is allowed for your safety and
convenience. But there still a variety of possibilities to set the string
variables.
All variable names are prefixed by `$'. You can assign a string to a
variable using the `=' operator, and you can append a string to a variable
using the `.=' operator. You can concatenate two strings using the `.'
operator. You can substitute variables even inside quotes. You can access
the environment variables using the notation
$ENV{VARIABLE}.
You can unset a variable by assigning the empty string "" to it. Use this to
return the state of the variable from `set' to `use default'.
You may or may not end a line with a semicolon.
OPTIONS
The options are given with their default value if this is known.
$vncClasses = /usr/X11R6/lib/vncserver ;
Should be the path to the java classes of the server.
$XFConfigPath = /etc/X11/XF86Config ;
Can be set to the global
XF86Config
file. This will be
parsed to gain default values for
$fontPath
and
$colorPath.
If you want to disable this feature, point it to an
invalid file,
/foo
for example.
$fontPath
Should a comma seperated list of fonts to be added to the font
path. If not specified, and
$XFConfigPath
is valid, vncserver will read the $fontPath from there. If both are
not set, the default will apply.
$colorPath
should be the RGB file to be used by X. This can also be taken from the
XF86Config
file if specified by
$XFConfigPath.
$vncUserDir = $ENV{HOME}/.vnc ;
Contains the filename for the log files directory of Xvnc
(the server) and the viewers that are connected to it.
$vncPasswdFile = $vncUserDir . /passwd ;
Contains the filename of the password file for Xvnc.
$vncStartup = /etc/X11/XSession ;
Points to a script that will be started at the very beginning of the Xvnc
session.
$xauthorityFile = $ENV{HOME}/.Xauthority ;
Specifies the path to the X authority file that should be used
by your Xvnc server.
$defaultDesktopName = X ;
Should be set to the default name of the desktop.
This can be changed at the command line with
-name.
$geometry = 640x400 ;
This sets framebuffer width & height. Default will be calculated if
server is started from within a running X servers. Can be changed at
the commandline (
-geometry).
A fixed default will be used if vncserver is not invoked in
a running X session.
$depth = 16 ;
$pixelformat = rgb565 ;
$depth
sets the framebuffer color depth. Must be an integer value between 8 and 32.
$pixelformat
sets the default pixelformat.
The default values will be calculated if none of both are specified
and when vncserver is called from within a running X servers.
Can be changed at the command line with option
-depth.
A fixed default value will be used if vncserver is not
invoked in a running X session.
$getDefaultFrom
This option lets you set the display from which you can query the default of
the above three options, if you don't want to start vncserver
from within a running X server. It will be added to the call of xdpyinfo.
It is useful to get the default from the X server you will run xvncviewer
in, because the data has not to be recalculated then.
$getDefaultFrom = -display localhost:0 ;
is an example how to do this.
$rfbwait = 120000 ;
Sets the maximum time in msec to wait for vnc client viewer.
FILES
/usr/bin/vncserver
A wrapper script around
Xvnc
to start the server with appropriate defaults.
/usr/bin/vncpasswd
Command to create and change password files to be used by the RFB protocol
(can be specified in the
$vncPasswdFile
variable).
/usr/bin/Xvnc
The real server. Will be invoked by vncserver.
