From 8cfcb387e91b1a5f77b8f9225edade61624554f8 Mon Sep 17 00:00:00 2001 From: "Daniel P. Berrange" Date: Tue, 24 Jul 2007 15:38:31 -0400 Subject: [PATCH] Added basic manual page --- Makefile.am | 2 +- configure.ac | 1 + man/Makefile.am | 9 +++++ man/virt-manager.pod | 82 ++++++++++++++++++++++++++++++++++++++++++++ virt-manager.spec.in | 2 ++ 5 files changed, 95 insertions(+), 1 deletion(-) create mode 100644 man/Makefile.am create mode 100644 man/virt-manager.pod diff --git a/Makefile.am b/Makefile.am index c5c2874d8..541bde0f0 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,6 +1,6 @@ ACLOCAL_AMFLAGS = -I m4/ -SUBDIRS = src pixmaps po help +SUBDIRS = src pixmaps man po help EXTRA_DIST = @PACKAGE@.spec COPYING-DOCS xmldocs.make omf.make \ intltool-extract.in intltool-merge.in intltool-update.in diff --git a/configure.ac b/configure.ac index b9a47ab80..83b0bde20 100644 --- a/configure.ac +++ b/configure.ac @@ -32,6 +32,7 @@ AC_OUTPUT(Makefile src/virtManager/Makefile src/vncViewer/Makefile src/graphWidgets/Makefile + man/Makefile virt-manager.spec help/Makefile help/virt-manager/Makefile diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 000000000..820a84af3 --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,9 @@ + +man_MANS = virt-manager.1 + +EXTRA_DIST = virt-manager.pod + +%.1: %.pod + pod2man $< > $@ + +CLEANFILES = virt-manager.1 diff --git a/man/virt-manager.pod b/man/virt-manager.pod new file mode 100644 index 000000000..80c97c05c --- /dev/null +++ b/man/virt-manager.pod @@ -0,0 +1,82 @@ + +=head1 NAME + +virt-manager - display the virtual machine desktop management tool + +=head1 SYNOPSIS + +B [OPTIONS] + +=head1 DESCRIPTION + +B is a desktop tool for managing virtual machines. It +provides the ability to control the lifecycle of existing machines +(bootup/shutdown,pause/resume,suspend/restore), provision new virtual +machines, manage virtual networks, access the graphical console of +virtual machines, and view performance statistics. + +=head1 OPTIONS + +The following options are accepted when running C: + +=over 4 + +=item -h, -help + +Display command line help summary + +=item -c URI, --connect=URI + +Specify the hypervisor connection URI + +=item --no-dbus + +Disable the DBus API used for remote control of the C UI + +=item --show-domain-creator + +Display the wizard for creating new virtual machines + +=item --show-domain-editor=UUID + +Display the dialog for editing properties of the virtual machine with +unique ID matching C + +=item --show-domain-performance=UUID + +Display the dialog for monitoring performance of the virtual machine with +unique ID matching C + +=item --show-domain-console=UUID + +Display the virtual console of the virtual machine with +unique ID matching C + +=item --show-host-summary + +Display the main window summarizing performance for all virtual machines +on the host. + +=back + +=head1 AUTHOR + +Writen by Daniel P. Berrange. + +=head1 BUGS + +Report bugs to the mailing list C + +=head1 COPYRIGHT + +Copright (C) 2006-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. There is NO WARRANTY, to the extent +permitted by law. + +=head1 SEE ALSO + +C, C, the project website C + +=cut + diff --git a/virt-manager.spec.in b/virt-manager.spec.in index 7120aa1ec..e383d9b4a 100644 --- a/virt-manager.spec.in +++ b/virt-manager.spec.in @@ -139,6 +139,8 @@ fi %{_datadir}/applications/%{name}.desktop %{_datadir}/dbus-1/services/%{name}.service +%{_datadir}/man/man1/%{name}.1* + %changelog * Mon Apr 16 2007 Daniel P. Berrange - 0.4.0-1 - Support for managing virtual networks