Added basic manual page

This commit is contained in:
Daniel P. Berrange 2007-07-24 15:38:31 -04:00
parent 50a373c3bf
commit 8cfcb387e9
5 changed files with 95 additions and 1 deletions

View File

@ -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

View File

@ -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

9
man/Makefile.am Normal file
View File

@ -0,0 +1,9 @@
man_MANS = virt-manager.1
EXTRA_DIST = virt-manager.pod
%.1: %.pod
pod2man $< > $@
CLEANFILES = virt-manager.1

82
man/virt-manager.pod Normal file
View File

@ -0,0 +1,82 @@
=head1 NAME
virt-manager - display the virtual machine desktop management tool
=head1 SYNOPSIS
B<virt-viewer> [OPTIONS]
=head1 DESCRIPTION
B<virt-manager> 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<virt-manager>:
=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<virt-manager> 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<UUID>
=item --show-domain-performance=UUID
Display the dialog for monitoring performance of the virtual machine with
unique ID matching C<UUID>
=item --show-domain-console=UUID
Display the virtual console of the virtual machine with
unique ID matching C<UUID>
=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<http://www.redhat.com/mailman/listinfo/et-mgmt-tools>
=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<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-viewer(1)>, the project website C<http://virt-manager.org>
=cut

View File

@ -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 <berrange@redhat.com> - 0.4.0-1
- Support for managing virtual networks