aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGerd Hoffmann <kraxel@redhat.com>2012-09-04 09:44:21 +0200
committerGerd Hoffmann <kraxel@redhat.com>2012-09-04 09:44:21 +0200
commit98f612e324b8a95be2a5459b5b1158e4a502aab4 (patch)
tree14a751ff43e84b8387cf45869b9ed5c5d490326c
parentd9f277afda12b26c880d3210b7e93b7788345987 (diff)
downloadvconsole-98f612e324b8a95be2a5459b5b1158e4a502aab4.tar.gz
create man-page, move over text from README
-rw-r--r--README38
-rw-r--r--vconsole.man39
2 files changed, 43 insertions, 34 deletions
diff --git a/README b/README
index 6538f21..36d1963 100644
--- a/README
+++ b/README
@@ -1,38 +1,8 @@
-What is vconsole
-================
-
-This is a virtual machine console, with a strong focus on guests using
-a serial console. Features a tabbed GUI, one tab for the VM list,
-then one per guest console. It build on top of libvirt.
-
-
-Using vconsole
+About vconsole
==============
-Just start it. It comes up with a GUI which should be mostly
-self-explanatory. If you have VIRSH_DEFAULT_CONNECT_URI set it should
-pick it up automatically. If it comes up empty try passing the
-libvirt uri using the '-c' switch.
-
-Hit 'Enter' on a host line to expland/collapse the guest list.
-Hit 'Enter' on a guest line to open a guest (text) console tab for it.
-
-Guest console tabs stay open until you explicitly close them using the
-'close tab' file menu entry. When a guest starts the console will be
-(re-)connected automatically.
-
-Typing into a guest console for a guest not running will start it
-(this is probably temporary until we have more fancy gui controls for
-that).
-
-
-Known issues / TODO list
-========================
-
-vconsole doesn't handle connection drops (caused by libvirtd restart
-for example) yet.
-
-vconsole lacks a .desktop file and manual page.
+This is a virtual machine console, with a strong focus on guests using
+a serial console.
-Most likely there are bugs not listed here.
+Check the manual page for more information.
diff --git a/vconsole.man b/vconsole.man
new file mode 100644
index 0000000..1d08e18
--- /dev/null
+++ b/vconsole.man
@@ -0,0 +1,39 @@
+.TH vconsole 1 "(c) Gerd Hoffmann"
+.SH NAME
+vconsole - virtual machine console
+.SH SYNOPSIS
+.B vconsole [ options ]
+.SH DESCRIPTION
+.B vconsole
+is a virtual machine console, with a strong focus on guests using
+a serial console. Features a tabbed GUI, one tab for the VM list,
+then one per guest console.
+.SH OPTIONS
+.TP
+.B -c <uri>
+Specify libvirt URI to use.
+.TP
+.B -h
+Display help text.
+.TP
+.B -d
+Enable debug logging on stderr.
+.SH GETTING STARTED
+Just start vconsole. It comes up with a GUI which should be mostly
+self-explanatory. If you have LIBVIRT_DEFAULT_URI or
+VIRSH_DEFAULT_CONNECT_URI set it should pick it up automatically. If
+it comes up empty try passing the libvirt uri using the '-c' switch or
+use the "File / Connect ..." menu entry to connect.
+.P
+Hit 'Enter' on a host line to expland/collapse the guest list.
+Hit 'Enter' on a guest line to open a guest (text) console tab for it.
+.P
+Guest console tabs stay open until you explicitly close them using the
+'close tab' file menu entry. When a guest starts the console will be
+(re-)connected automatically.
+.P
+Typing into a guest console for a guest not running will start it
+(this is probably temporary until we have more fancy gui controls for
+that).
+.SH AUTHOR
+Gerd Hoffmann <kraxel@redhat.com>