summaryrefslogtreecommitdiffstats
path: root/man
diff options
context:
space:
mode:
authorDaniel P. Berrange <berrange@redhat.com>2014-01-29 16:22:09 +0000
committerDaniel P. Berrange <berrange@redhat.com>2014-02-24 10:19:58 +0000
commit7d7d3243870904c1ca9154b61063c35b7c79b640 (patch)
tree4e8fc7bcfc1cdf7056931fc09aeb881bda809314 /man
parent74b532f1ecf5affecc13e322723881ba42d2dd29 (diff)
downloadvirt-viewer-7d7d3243870904c1ca9154b61063c35b7c79b640.tar.gz
virt-viewer-7d7d3243870904c1ca9154b61063c35b7c79b640.tar.xz
virt-viewer-7d7d3243870904c1ca9154b61063c35b7c79b640.zip
Improve docs for --attach flag in virt-viewer
People seem to have a hard time understanding the --attach flag. Rewrite the docs in the hope that people figure it out this time. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
Diffstat (limited to 'man')
-rw-r--r--man/virt-viewer.pod11
1 files changed, 7 insertions, 4 deletions
diff --git a/man/virt-viewer.pod b/man/virt-viewer.pod
index 963d7bc..2d4ab2c 100644
--- a/man/virt-viewer.pod
+++ b/man/virt-viewer.pod
@@ -59,10 +59,13 @@ used SSH.
=item -a, --attach
-Use libvirt to directly attach to a local display, instead of making a
-TCP/UNIX socket connection. This avoids the need to authentication with
-the remote display, if authentication with libvirt is already allowed.
-This option does not work with remote displays.
+Instead of making a direct TCP/UNIX socket connection to the remote display,
+ask libvirt to provide a pre-connected socket for the display. This avoids
+the need to authenticate with the remote display server directly. This option
+will only work when connecting to a guest that is running on the same host
+as the virt-viewer program. If attaching to the guest via libvirt fails,
+virt-viewer will automatically fallback to trying a regular direct TCP/UNIX
+socket connection.
=item -f, --full-screen