Sandro Bonazzola has uploaded a new change for review. Change subject: doc: adding man pages ......................................................................
doc: adding man pages Adding minimal man pages. Change-Id: I58f3e0420cbb9cc93821f65c0935b83a6c12f8bf Signed-off-by: Sandro Bonazzola <[email protected]> --- M Makefile.am M README M configure.ac A man/Makefile.am A man/hosted-engine.8 A man/ovirt-hosted-engine-setup.8 M ovirt-hosted-engine-setup.spec.in 7 files changed, 109 insertions(+), 14 deletions(-) git pull ssh://gerrit.ovirt.org:29418/ovirt-hosted-engine-setup refs/changes/15/18215/1 diff --git a/Makefile.am b/Makefile.am index fd851c8..a362806 100644 --- a/Makefile.am +++ b/Makefile.am @@ -43,6 +43,7 @@ SUBDIRS = \ build \ + man \ po \ src \ templates \ diff --git a/README b/README index d1be936..e802dee 100644 --- a/README +++ b/README @@ -1,16 +1,2 @@ ovirt-hosted-engine-setup -- oVirt Hosted Engine Setup ====================================================== - -USAGE ------ -hosted-engine [OPTIONS] - -OPTIONS: ---config-append=file - Load extra configuration files. ---generate-answer=file - Generate answer file. - -An answer file example is available in tests subdirectory. -You can use it with the following command: - hosted-engine --config-append=tests/answers diff --git a/configure.ac b/configure.ac index 159890d..6620458 100644 --- a/configure.ac +++ b/configure.ac @@ -86,6 +86,7 @@ Makefile ovirt-hosted-engine-setup.spec build/Makefile + man/Makefile po/Makefile.in src/Makefile src/bin/Makefile diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..8085580 --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,27 @@ +# +# ovirt-hosted-engine-setup -- ovirt hosted engine setup +# Copyright (C) 2013 Red Hat, Inc. +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +# + +MAINTAINERCLEANFILES = \ + $(srcdir)/Makefile.in \ + $(NULL) + +dist_man_MANS = \ + hosted-engine.8 \ + ovirt-hosted-engine-setup.8 \ + $(NULL) diff --git a/man/hosted-engine.8 b/man/hosted-engine.8 new file mode 100644 index 0000000..65b2cfe --- /dev/null +++ b/man/hosted-engine.8 @@ -0,0 +1,48 @@ +.\" hosted-engine - Tool for handling hosted engine +.TH "hosted-engine" "8" "" "Sandro Bonazzola" "" +.SH "NAME" +hosted\-engine \- Tools for handling hosted engine +.SH "SYNOPSIS" +\fBhosted\-engine\fP [options] +.PP +.SH "DESCRIPTION" +.PP +The \fBhosted\-engine\fP command can be used for deploying a VM that will host +an Enterprise Virtualization Manager that will be able to manage the same host +running the VM. The command can also be used for starting, stopping and +accessing the VM. +\& + +.SH "GENERAL OPTIONS" +The following are general options you can use with this command:\& +.IP "\fB\-\-help\fP" +Show the help message and exit.\& +.IP "\fB\-\-deploy\fP" +Run ovirt-hosted-engine-setup for deploying the VM.\& +.IP "\fB\-\-vm-start\fP" +Start VM on this host.\& +.IP "\fB\-\-vm-shutdown\fP" +Gracefully shutdown the VM on this host.\& +.IP "\fB\-\-vm-poweroff\fP" +Forcefully poweroff the VM on this host.\& +.IP "\fB\-\-vm-status\fP" +Show the VM status.\& +.IP "\fB\-\-add-console-password=<password>\fP" +Create a temporary password for vnc/spice connection.\& +.IP "\fB\-\-console\fP" +Open the configured console using remote-viewer on localhost.\& +.IP "\fB\-\-check-liveliness\fP" +Checks liveliness page of engine.\& +.IP "\fB\-\-connect-storage\fP" +Connect the storage domain manually.\& +.IP "\fB\-\-start-pool\fP" +Start the storage pool manually.\& + +.SH "SEE ALSO" +.BR ovirt\-hosted\-engine\-setup (8) + +.SH "AUTHORS" +.nf +Alex Lourie\& +Sandro Bonazzola\& +Yedidyah Bar David\& diff --git a/man/ovirt-hosted-engine-setup.8 b/man/ovirt-hosted-engine-setup.8 new file mode 100644 index 0000000..8b084a1 --- /dev/null +++ b/man/ovirt-hosted-engine-setup.8 @@ -0,0 +1,31 @@ +.\" ovirt-hosted-engine-setup - Tool for deploying hosted engine VM +.TH "ovirt-hosted-engine-setup" "8" "" "Sandro Bonazzola" "" +.SH "NAME" +ovirt\-hosted\-engine\-setup \- Tool for deploying hosted engine VM +.SH "SYNOPSIS" +\fBovirt\-hosted\-engine\-setup\fP [options] +.PP +.SH "DESCRIPTION" +.PP +The \fBovirt\-hosted\-engine\-setup\fP command can be used for deploying a VM +that will host an Enterprise Virtualization Manager that will be able to +manage the same host running the VM. +\& + +.SH "GENERAL OPTIONS" +The following are general options you can use with this command:\& +.IP "\fB\-\-help\fP" +Show the help message and exit.\& +.IP "\fB\-\-config-append=file\fP" +Load extra configuration files.\& +.IP "\fB\-\-generate-answer=file\fP" +Generate answer file.\& + +.SH "SEE ALSO" +.BR hosted\-engine (8) + +.SH "AUTHORS" +.nf +Alex Lourie\& +Sandro Bonazzola\& +Yedidyah Bar David\& diff --git a/ovirt-hosted-engine-setup.spec.in b/ovirt-hosted-engine-setup.spec.in index d2128e8..5cb5bc4 100644 --- a/ovirt-hosted-engine-setup.spec.in +++ b/ovirt-hosted-engine-setup.spec.in @@ -86,6 +86,7 @@ %{_sbindir}/%{name} %{python_sitelib}/ovirt_hosted_engine_setup/ %{_datadir}/%{name}/ +%{_mandir}/man8/* #move to a separate package? %{vdsmhooksdir}/before_vm_start/ -- To view, visit http://gerrit.ovirt.org/18215 To unsubscribe, visit http://gerrit.ovirt.org/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I58f3e0420cbb9cc93821f65c0935b83a6c12f8bf Gerrit-PatchSet: 1 Gerrit-Project: ovirt-hosted-engine-setup Gerrit-Branch: master Gerrit-Owner: Sandro Bonazzola <[email protected]> _______________________________________________ Engine-patches mailing list [email protected] http://lists.ovirt.org/mailman/listinfo/engine-patches
