Manual entry for xvpviewer:
xvpviewer (1) xvpviewer (1)
NAME
xvpviewer - A Viewer for xvp
SYNOPSIS
xvpviewer [ -vm vm ] host:display
xvpviewer [ -vm vm ] host::port
DESCRIPTION
xvpviewer Is a Java-based VNC Viewer, designed for use with xvp(1).
xvp (standing for Xen VNC Proxy) is a proxy server providing password-
protected VNC-based access to the consoles of virtual machines hosted
on Citrix XenServer. As well as being supplied in standalone form,
xvpviewer is also supplied in Java applet form as part of the xvpweb(7)
web based front end for XenServer.
xvpviewer is based on the TightVNC Java Viewer, but with added support
for mouse-wheel scrolling. It can be used to connect to any VNC server
compatible with the TightVNC Viewer. However, when used with xvp(8),
xvpviewer has additional buttons to allow virtual machine shutdown,
reboot and reset to be initiated, and can be used to access different
virtual machines served by xvp(8) from a single multiplexed TCP port.
OPTIONS
-vm vm This option is required when connecting to a multiplexed port
served by xvp(8). It tells xvp(8) which virtual machine's con-
sole is required. If the configuration file xvp.conf(5) has
been set to specify virtual machines by UUID, then the UUID must
be given, otherwise the virtual machine's name label must be
used. In cases where xvp.conf(5) lists more than one XenServer
pool, the UUID or name label can be prefixed by the name of the
pool and a colon to avoid ambiguity. This option is optional if
not connecting to a multiplexed port, but must match the rele-
vant virtual machine if specified.
host:display
Connects to the VNC server on the specified host, using the
specified VNC display number. If omitted, the display defaults
to 0.
host::port
Connects to the VNC server on the specified host, using the
specified port number. If omitted, the port defaults to 5900.
XVP-SPECIFIC BUTTONS
Shutdown
Requests a clean shutdown of the virtual machine. This may not
have any effect if the virtual machine is generally unresponsive
or does not have any necessary guest agent installed. After
shutdown, the viewer will be disconnected (a delay can be con-
figured via xvp(8)). Note that if the virtual machine is pro-
tected by HA, this will automatically be disabled prior to shut-
down.
Reboot Requests a clean reboot of the virtual machine. This may not
have any effect if the virtual machine is generally unresponsive
or does not have any necessary guest agent installed. After
reboot, the viewer will only remain connected if xvp(8) has been
configured appropriately.
Reset Requests a hard reboot of the virtual machine. The virtual
machine will stop executing without a clean shutdown, and then
be restarted. This may result in data corruption, and should
therefore only be used if there is no way of cleanly rebooting
the virtual machine. After restart, the viewer will only remain
connected if xvp(8) has been configured appropriately.
FILES
The /usr/bin/xvpviewer program is a bash script which runs Java using
the associated JAR file, /usr/share/xvp/VncViewer.jar. Both have been
tested on Linux, MacOS X and Solaris.
Also supplied is a batch file, /usr/share/xvp/xvpviewer.bat, which can
be used to run the JAR file on Microsoft(R) Windows(R) operating sys-
tems. It supports the same command line options.
JAVA RUNTIME COMPATIBILITY
xvpviewer is compatible with the Java(TM) runtime library from Sun
Microsystems, Inc. It is not compatible with the GNU gcj runtime. The
JAR file can be served as an applet by a web server running on the same
host as xvp(8), and can be viewed in most popular web browsers. Applet
configuration is the same as for TightVNC, as documented in the file
README.tightvnc.
SEE ALSO
xvp(8), xvpweb(7), vncviewer(1), README.tightvnc
AUTHOR
Colin Dean gro.ecruospvx@niloc
COPYRIGHT
Copyright (C) 1999 AT&T Laboratories Cambridge.
Copyright (C) 2000 Tridia Corp.
Copyright (C) 2002-2003 RealVNC Ltd.
Copyright (C) 2001-2004 HorizonLive.com, Inc.
Copyright (C) 2000-2007 Constantin Kaplinsky
Copyright (C) 2000-2009 TightVNC Group
Copyright (C) 2009 Colin Dean
All rights reserved.
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MER-
CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details.
Citrix is a registered trademark of Citrix Systems, Inc.
The VNC protocol was originally developed by the RealVNC team while at
Olivetti Research Ltd / AT&T Laboratories Cambridge.
For additional TightVNC copyright information and acknowledgments,
refer to the installed file README.tightvnc.
xvpviewer (1) xvpviewer (1)