Added manual page

5 files changed, 92 insertions, 1 deletions

diff --git a/Makefile.am b/Makefile.am
index 0632465..41072de 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,5 +1,5 @@
 
-SUBDIRS = src
+SUBDIRS = src man
 
 EXTRA_DIST = @PACKAGE@.spec
 
diff --git a/configure.ac b/configure.ac
index 882747c..ecca0c1 100644
--- a/configure.ac
+++ b/configure.ac
@@ -12,4 +12,5 @@ PKG_CHECK_MODULES(GTKVNC, gtk-vnc-1.0 >= 0.0.1)
 
 AC_OUTPUT(Makefile
           src/Makefile
+          man/Makefile
           virt-viewer.spec)
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..0ff50be
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,7 @@
+
+man_MANS = virt-viewer.1
+
+EXTRA_DIST = virt-viewer.pod
+
+%.1: %.pod
+	pod2man $< > $@
diff --git a/man/virt-viewer.pod b/man/virt-viewer.pod
new file mode 100644
index 0000000..e5de846
--- /dev/null
+++ b/man/virt-viewer.pod
@@ -0,0 +1,81 @@
+
+=head1 NAME
+
+virt-viewer - display the graphical console for a virtual machine
+
+=head1 SYNOPSIS
+
+B<virt-viewer> [OPTIONS] DOMAIN-NAME|ID|UUID
+
+=head1 DESCRIPTION
+
+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
+
+=head1 OPTIONS
+
+The following options are accepted when running C<virt-viewer>:
+
+=over 4
+
+=item -h, -help
+
+Display command line help summary
+
+=item -V, --version
+
+Display program version number
+
+=item -v, --verbose
+
+Display information about the connection
+
+=item -c URI, --connect=URI
+
+Specify the hypervisor connection URI
+
+=item -w, --wait
+
+Wait for the domain to start up before attempting to connect to the console
+
+=back
+
+=head1 EXAMPLES
+
+To connect to the guest called 'demo' running under Xen
+
+   virt-viewer demo
+
+To connect to the guest with ID 7 running under QEMU
+
+   virt-viewer --connect qemu:///system 7
+
+To wait for the guest with UUID 66ab33c0-6919-a3f7-e659-16c82d248521 to
+startup and then connect
+
+   virt-viewer --wait 66ab33c0-6919-a3f7-e659-16c82d248521
+
+=head1 AUTHOR
+
+Writen by Daniel P. Berrange, based on the GTK-VNC example program gvncviewer.
+
+=head1 BUGS
+
+Report bugs to the mailing list C<http://www.redhat.com/mailman/listinfo/et-mgmt-tools>
+
+=head1 COPYRIGHT
+
+Copright (C) 2007 Red Hat, Inc, and various contributors.
+This is free software. You may redistribute copies of it under the terms of the GNU General
+Public License C<http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent
+permitted by law.
+
+=head1 SEE ALSO
+
+C<virsh(1)>, C<virt-manager(1)>, the project website C<http://virt-manager.org>
+
+=cut
+
diff --git a/virt-viewer.spec.in b/virt-viewer.spec.in
index 45414c4..b9aaf4b 100644
--- a/virt-viewer.spec.in
+++ b/virt-viewer.spec.in
@@ -21,6 +21,7 @@ ExclusiveArch: %{ix86} x86_64 ia64
 
 BuildRequires: gtk2-devel
 BuildRequires: gtk-vnc-devel
+BuildRequires: /usr/bin/pod2man
 
 %description
 Virtual Machine Viewer provides a graphical console client for connecting
@@ -46,6 +47,7 @@ rm -rf $RPM_BUILD_ROOT
 %defattr(-,root,root,-)
 %doc README COPYING AUTHORS ChangeLog NEWS
 %{_bindir}/%{name}
+%{_mandir}/man1/%{name}*
 
 %changelog
 * Fri Jul 20 2007 Daniel P. Berrange <berrange@redhat.com> - 0.0.1-1