[virt-tools-list] [PATCH] Improve docs for --attach flag in virt-viewer
Daniel P. Berrange
berrange at redhat.com
Wed Jan 29 16:24:10 UTC 2014
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 at redhat.com>
---
man/virt-viewer.pod | 11 +++++++----
1 file 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
--
1.8.4.2
More information about the virt-tools-list
mailing list