[Ovirt-devel] [PATCH viewer] Added ovirt-viewer man page

[Mohammed Morsi]

---
 Makefile.am          |    2 +-
 configure.ac         |    2 +-
 man/Makefile.am      |    7 ++++
 man/ovirt-viewer.pod |   92 ++++++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 101 insertions(+), 2 deletions(-)
 create mode 100644 man/Makefile.am
 create mode 100644 man/ovirt-viewer.pod

diff --git a/Makefile.am b/Makefile.am
index 50d85c2..6b0c2ed 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -18,7 +18,7 @@
 
 AUTOMAKE_OPTIONS = foreign
 
-SUBDIRS = src
+SUBDIRS = src man
 
 EXTRA_DIST = $(PACKAGE).spec
 
diff --git a/configure.ac b/configure.ac
index 1cd0447..32d4006 100644
--- a/configure.ac
+++ b/configure.ac
@@ -57,5 +57,5 @@ fi
 
 dnl Output.
 AC_CONFIG_HEADERS([config.h])
-AC_CONFIG_FILES([Makefile src/Makefile])
+AC_CONFIG_FILES([Makefile src/Makefile man/Makefile])
 AC_OUTPUT
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..9649df6
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,7 @@
+
+man_MANS = ovirt-viewer.1
+
+EXTRA_DIST = ovirt-viewer.pod
+
+ovirt-viewer.1: ovirt-viewer.pod
+	pod2man $< > $@
diff --git a/man/ovirt-viewer.pod b/man/ovirt-viewer.pod
new file mode 100644
index 0000000..3f3f027
--- /dev/null
+++ b/man/ovirt-viewer.pod
@@ -0,0 +1,92 @@
+
+=head1 NAME
+
+ovirt-viewer - display the graphical console for an oVirt managed virtual machine
+
+=head1 SYNOPSIS
+
+B<ovirt-viewer> [OPTIONS]
+
+=head1 DESCRIPTION
+
+B<ovirt-viewer> is a tool that allows a user to login to an
+oVirt server and gain VNC access to the VMs under their
+control. Users specify the hostname or ip of the server which to
+connect to and login credentials, and then select the vms they
+want to view. oVirt viewer then pops up the specified vnc window,
+allowing users to switch vms at will.
+
+=head1 OPTIONS
+
+The following options are accepted when running C<ovirt-viewer>:
+
+=over 4
+
+=item -?, --help
+
+Display command line help summary
+
+=item -V, --version
+
+Display program version number
+
+=item -v, --verbose
+
+Display information about the connection
+
+=item -d, --debug
+
+Display debugging information
+
+=item -H HOSTNAME, --hostname=HOSTNAME
+
+Specify the hostname (or ip) of the oVirt server to connect to
+
+=item -p PORT, --port=PORT
+
+Specify the port to use for vnc access when connecting to the ovirt server
+
+=item --cainfo=PATH
+
+set the path of the CA certificate bundle
+
+=item --check-certificate
+
+Check and verify the server's certificate
+
+=item -u USERNAME --username=USERNAME
+
+Username to use when logging into the server
+
+=item -p PASSWORD --password=PASSWORD
+
+Password to use when logging into the server
+
+=item -m VMNAME --vm VMNAME
+
+Set the name of the vm to automatically connect to when we're
+logged into the server
+
+=item --display=DISPLAY
+
+Set the X display to use
+
+=back
+
+=head1 AUTHOR
+
+Written by Mohammed Morsi, based on virt-viewer
+
+=head1 BUGS
+
+Report bugs to the mailing list C<https://www.redhat.com/mailman/listinfo/ovirt-devel>
+
+=head1 COPYRIGHT
+
+Copyright (C) 2007-2008 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.
+
+=cut
+
-- 
1.6.0.6