Xvnc(1x)

NAME

Xvnc - a X server for Virtual Network Computing

SYNOPSIS

Xvnc [:display] [-a pixel] [-ac] [-audit int] [-auth file] [bc] [-bs] [-c] [c int] [-cc int] [-co file] [-core] [-dpi int] [-deferglyphs [none|all|16]] [-f int] [-fc string] [-fn string] [-fp string] [-help] [-I] [-ld int] [-lf int] [-ls int] [-nolock] [-logo] [nologo] [-nolisten string] [-p minutes] [-pn] [-nopn] [-r] [r] [-s min] [-su] [-t int] [-terminate] [-to int] [-tst] [ttyxx] [v] [-v] [-wm] [-x string] [-query hostname] [-broadcast] [-indirect hostname] [-port num] [-once] [-class display-class] [-displayID display-id] [-geometry WxH] [-depth int] [-pixelformat [bgrnnn|rgbnnn]] [-udpinputport num] [-rfbport num] [-rfbwait ms] [-nocursor] [-rfbauth file] [-httpd dir] [-httpport num] [-economictranslate] [-desktop name]

DESCRIPTION

Xvnc is a free X server for Virtual Network Computing (VNC). It provides all the capabilities of a X server, but does not connect to a display for itself. You need a vncviewer to view and control the applications that run on the server.

There are viewers for a variety of plattforms, e.g. X, svgalib and Windows. For Linux and Windows also a server exists. With the built-in Java classes, you can even use a Java capable Internet browser to connect to Xvnc.

EXAMPLES

Xvnc :1: Invoke Xvnc on display :1 at localhost.

Xvnc -geometry 640x480 -once -httpd /usr/X11R6/lib/vncserver: Invoke Xvnc for one session, with a framebuffer size of 640x480. Use the Java classes in /usr/X11R6/lib/vncserver.

OVERVIEW

Many options are available to Xvnc in order to give as much flexibility as possible to the user. Most of the options are standard options for X server, and Xvnc provides a few additional options dsigned for its special purpose.

Normally, you will not invoke Xvnc itself but vncserver(1x), which is a wrapper script to parse configuration files and calculate appropriate default values for lots of options of Xvnc.

DEFAULTS

Xvnc will use some built-in defaults for a variety of options. But it is better not to rely on them. Instead you should use vncserver(1x), to call Xvnc with the right options for your system. This has the advantage that you can use configuration files to adjust Xvnc to your system. Please see the manpage of vncserver(1x) for details.

OPTIONS

There are a lot of options for Xvnc. As this man page is provided by the Debian maintainer and not by the upstream author, this man page can't be very descriptive. Please check the man pages of the X windows system for a detailed explanation of the standard X server options.

-a pixel: This sets the mouse acceleration in pixel.

-ac: Use this option to disable access control restrictions.

-audit int: Set audit trail level.

-auth filename: Specifies the filename of the X authorization file.

bc: Enables bug compatibility.

-bs: Disable any backing store support.

-c: This option turns off key clicking.

c int: This option specifies the key clicking volume and maybe an integer value from 0 to 100.

-cc int: Specifies the default color visual class.

-co file: This should be the filename of a valid X color database file, as it is specified in the RgbPath field of the XF86Config file.

-core: If you specify this option, Xvnc will generate a core dump on fatal error.

-dpi int: Set the screen resolution in dots per inch.

-deferglyphs [none|all|16]: Defer loading of no, all or 16-bit glyphs.

-f int: Bell base. Mabye an integer value from 0 to 100.

-fc string: This sets the cursor font.

-fn string: This sets the default font name.

-fp string: This specifies the default font path.

-help: This will print a help message with all legal options on stderr.

-I: After this option, all remaining arguments will be ignored.

-ld int: With this option you can limit the data space to N KByte.

-lf int: With this option you can limit the number of open files to N.

-ls int: With this option you can limit the stack space to N KByte.

-nolock: Disables the locking mechanism.

-logo: Enables logo in screen saver.

nologo: Disables logo in screen saver.

-nolisten string: Don't listen on protocol.

-p minutes: Screen-saver pattern duration in minutes.

-pn: Accept failure to listen on all ports.

-nopn: Reject failure to listen on all ports.

-r: Turns auto-repeat off.

r: Turns on auto-repeat on.

-s minutes: Screen-saver timeout in minutes.

-su: Disable any save under support.

-t pixel: This option specifies the mouse threshold in pixels.

-terminate: Terminate at server reset.

-to int: Connection time out.

-tst: Disable testing extensions.

ttyxx: Server started from init on /dev/ttyxx.

v: Enablevideo blanking for screen-saver.

-v: Screen-saver without video blanking.

-wm: WhenMapped default backing-store.

-x string: Loads named extension at init time.

-query hostname: Contact named host for XDMCP.

-broadcast: Broadcast for XDMCP.

-indirect hostname: Contact named host for indirect XDMCP.

-port num: UDP port number to send messages to.

-once: Terminate server after one session. When the viewer disconnects, the server will terminate.

-class display-class: Specify display class to send in manage.

-displayID display-id: Manufacturer display ID for request.

-geometry WxH: Set framebuffer width & height.

-depth num: Set framebuffer depth. Must be a value between 8 and 32.

-pixelformat format: Set pixel format (BGRnnn or RGBnnn). The viewer can do the conversion to any other pixel format, but it is faster if the depth and pixelformat of the server is the same as the aequivalent values on the viewer display.

-udpinputport port: UDP port for keyboard/pointer data.

-rfbport port: TCP port for RFB protocol. The RFB protocol is the VNC server/client protocoll.

-rfbwait time: Maximum time in milli seconds to wait for RFB client. The RFB client is the VNC viewer.

-nocursor: Don't put up a cursor.

-rfbauth passwd-file: When using authentication on RFB protocol, compare the password with the password saved in passwd-file.

-httpd dir: Specify the directory in which the java classes are stored with this option.

-httpport port: With this option you can specify the port on which Xvnc should listen for incoming http connections (to be used by any Java capable browser).

-economictranslate: Less memory-hungry translation.

-desktop name: Name of the VNC desktop (default x11).

FILES

/usr/X11R6/bin/vncserver: Wrapper script for convenient invocation.

/usr/X11R6/bin/vncpasswd: Command to create and change password files to be used by the RFB protocol (can be specified with the -rfbauth option).

/usr/X11R6/lib/vncserver/: This directory contains the Java classes for incoming Http connections.

AUTHOR

VNC developed at Olivetti Research Labs, Cambridge (now AT&T Laboratories, Cambridge) by Tristan Richardson, Ken Wood, James Weatherall, Andy Harter, Charlie McLachlan, Paul Webster, Quentin Stafford-Fraser and others. This manpage written by Marcus Brinkmann for the Debian GNU/Linux distribution.