summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorDaniel P. Berrange <berrange@redhat.com>2007-08-28 20:24:04 -0400
committerDaniel P. Berrange <berrange@redhat.com>2007-08-28 20:24:04 -0400
commit6ed4e21acfed9389b7f3632795253a239c79d283 (patch)
tree099632c97503ad6b6aaeee4f962a25eec2be5c09 /man
parent278b124a821010dee8166f209a62e29c4f588547 (diff)
Document the '--direct' option
Diffstat (limited to 'man')
-rw-r--r--man/virt-viewer.pod18
1 files changed, 17 insertions, 1 deletions
diff --git a/man/virt-viewer.pod b/man/virt-viewer.pod
index e5de846..1cac901 100644
--- a/man/virt-viewer.pod
+++ b/man/virt-viewer.pod
@@ -13,7 +13,9 @@ B<virt-viewer> is a minimal tool for displaying the graphical console
of a virtual machine. The console is accessed using the VNC protocol.
The guest can be referred to based on its name, ID, or UUID. If the
guest is not already running, then the viewer can be told to wait
-until is starts before attempting to connect to the console
+until is starts before attempting to connect to the console The viewer
+can connect to remote hosts to lookup the console information and then
+also connect to the remote console using the same network transport.
=head1 OPTIONS
@@ -41,6 +43,11 @@ Specify the hypervisor connection URI
Wait for the domain to start up before attempting to connect to the console
+=item -d, --direct
+
+Do not attempt to tunnel the console over SSH, even if the main connection URI
+used SSH.
+
=back
=head1 EXAMPLES
@@ -58,6 +65,15 @@ startup and then connect
virt-viewer --wait 66ab33c0-6919-a3f7-e659-16c82d248521
+To connect to a remote console using TLS
+
+ virt-viewer --connect xen://example.org/ demo
+
+To connect to a remote host using SSH, lookup the guest config and
+then make a direct non-tunnelled connection of the console
+
+ virt-viewer --connect xen+ssh://root@example.org/ demo
+
=head1 AUTHOR
Writen by Daniel P. Berrange, based on the GTK-VNC example program gvncviewer.