diff --git a/SConstruct b/SConstruct index 3bf25cec2b..818ee83cfa 100644 --- a/SConstruct +++ b/SConstruct @@ -205,6 +205,7 @@ build_scripts=[ 'src/um/SConstruct', 'src/authm/SConstruct', 'src/xml/SConstruct', + 'share/man/SConstruct' ] # Testing diff --git a/install.sh b/install.sh index 96fdeb4baa..7e48aaa9d7 100755 --- a/install.sh +++ b/install.sh @@ -98,7 +98,7 @@ if [ -z "$ROOT" ] ; then LOCK_LOCATION="/var/lock/one" INCLUDE_LOCATION="/usr/include" SHARE_LOCATION="/usr/share/one" - MAN_LOCATION="/usr/share/man/man8" + MAN_LOCATION="/usr/share/man/man1" if [ "$CLIENT" = "yes" ]; then MAKE_DIRS="$BIN_LOCATION $LIB_LOCATION" @@ -133,7 +133,7 @@ else IMAGES_LOCATION="$VAR_LOCATION/images" INCLUDE_LOCATION="$ROOT/include" SHARE_LOCATION="$ROOT/share" - MAN_LOCATION="$ROOT/share/man/man8" + MAN_LOCATION="$ROOT/share/man/man1" if [ "$CLIENT" = "yes" ]; then MAKE_DIRS="$BIN_LOCATION $LIB_LOCATION" @@ -835,24 +835,24 @@ SUNSTONE_RUBY_LIB_FILES="src/mad/ruby/CommandManager.rb \ # MAN files #----------------------------------------------------------------------------- -MAN_FILES="share/man/oneauth.8.gz \ - share/man/onecluster.8.gz \ - share/man/onehost.8.gz \ - share/man/oneimage.8.gz \ - share/man/oneuser.8.gz \ - share/man/onevm.8.gz \ - share/man/onevnet.8.gz \ - share/man/onetemplate.8.gz \ - share/man/onedb.8.gz \ - share/man/econe-describe-images.8.gz \ - share/man/econe-describe-instances.8.gz \ - share/man/econe-register.8.gz \ - share/man/econe-run-instances.8.gz \ - share/man/econe-terminate-instances.8.gz \ - share/man/econe-upload.8.gz \ - share/man/occi-compute.8.gz \ - share/man/occi-network.8.gz \ - share/man/occi-storage.8.gz" +MAN_FILES="share/man/oneauth.1.gz \ + share/man/onecluster.1.gz \ + share/man/onehost.1.gz \ + share/man/oneimage.1.gz \ + share/man/oneuser.1.gz \ + share/man/onevm.1.gz \ + share/man/onevnet.1.gz \ + share/man/onetemplate.1.gz \ + share/man/onedb.1.gz \ + share/man/econe-describe-images.1.gz \ + share/man/econe-describe-instances.1.gz \ + share/man/econe-register.1.gz \ + share/man/econe-run-instances.1.gz \ + share/man/econe-terminate-instances.1.gz \ + share/man/econe-upload.1.gz \ + share/man/occi-compute.1.gz \ + share/man/occi-network.1.gz \ + share/man/occi-storage.1.gz" #----------------------------------------------------------------------------- #----------------------------------------------------------------------------- diff --git a/share/man/SConstruct b/share/man/SConstruct new file mode 100644 index 0000000000..6b56e3b815 --- /dev/null +++ b/share/man/SConstruct @@ -0,0 +1,21 @@ +# SConstruct for share/man + +# -------------------------------------------------------------------------- # +# Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org) # +# # +# Licensed under the Apache License, Version 2.0 (the "License"); you may # +# not use this file except in compliance with the License. You may obtain # +# a copy of the License at # +# # +# http://www.apache.org/licenses/LICENSE-2.0 # +# # +# Unless required by applicable law or agreed to in writing, software # +# distributed under the License is distributed on an "AS IS" BASIS, # +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # +# See the License for the specific language governing permissions and # +# limitations under the License. # +#--------------------------------------------------------------------------- # + +import os + +os.system("gzip *.1 &>/dev/null") diff --git a/share/man/econe-describe-images.1 b/share/man/econe-describe-images.1 new file mode 100644 index 0000000000..e69de29bb2 diff --git a/share/man/econe-describe-images.8.gz b/share/man/econe-describe-images.8.gz deleted file mode 100644 index c0aa5db454..0000000000 Binary files a/share/man/econe-describe-images.8.gz and /dev/null differ diff --git a/share/man/econe-describe-instances.1 b/share/man/econe-describe-instances.1 new file mode 100644 index 0000000000..e69de29bb2 diff --git a/share/man/econe-describe-instances.8.gz b/share/man/econe-describe-instances.8.gz deleted file mode 100644 index 143bb28a5f..0000000000 Binary files a/share/man/econe-describe-instances.8.gz and /dev/null differ diff --git a/share/man/econe-register.1 b/share/man/econe-register.1 new file mode 100644 index 0000000000..e69de29bb2 diff --git a/share/man/econe-register.8.gz b/share/man/econe-register.8.gz deleted file mode 100644 index bc5e8b13f3..0000000000 Binary files a/share/man/econe-register.8.gz and /dev/null differ diff --git a/share/man/econe-run-instances.1 b/share/man/econe-run-instances.1 new file mode 100644 index 0000000000..e69de29bb2 diff --git a/share/man/econe-run-instances.8.gz b/share/man/econe-run-instances.8.gz deleted file mode 100644 index 22e1d8d65b..0000000000 Binary files a/share/man/econe-run-instances.8.gz and /dev/null differ diff --git a/share/man/econe-terminate-instances.1 b/share/man/econe-terminate-instances.1 new file mode 100644 index 0000000000..e69de29bb2 diff --git a/share/man/econe-terminate-instances.8.gz b/share/man/econe-terminate-instances.8.gz deleted file mode 100644 index ba19ff45c7..0000000000 Binary files a/share/man/econe-terminate-instances.8.gz and /dev/null differ diff --git a/share/man/econe-upload.1 b/share/man/econe-upload.1 new file mode 100644 index 0000000000..e69de29bb2 diff --git a/share/man/econe-upload.8.gz b/share/man/econe-upload.8.gz deleted file mode 100644 index fb0704f662..0000000000 Binary files a/share/man/econe-upload.8.gz and /dev/null differ diff --git a/share/man/occi-compute.1 b/share/man/occi-compute.1 new file mode 100644 index 0000000000..e69de29bb2 diff --git a/share/man/occi-compute.8.gz b/share/man/occi-compute.8.gz deleted file mode 100644 index 11842ea221..0000000000 Binary files a/share/man/occi-compute.8.gz and /dev/null differ diff --git a/share/man/occi-network.1 b/share/man/occi-network.1 new file mode 100644 index 0000000000..e69de29bb2 diff --git a/share/man/occi-network.8.gz b/share/man/occi-network.8.gz deleted file mode 100644 index 35e512a6fd..0000000000 Binary files a/share/man/occi-network.8.gz and /dev/null differ diff --git a/share/man/occi-storage.1 b/share/man/occi-storage.1 new file mode 100644 index 0000000000..e69de29bb2 diff --git a/share/man/occi-storage.8.gz b/share/man/occi-storage.8.gz deleted file mode 100644 index 2cdb242469..0000000000 Binary files a/share/man/occi-storage.8.gz and /dev/null differ diff --git a/share/man/oneauth.1 b/share/man/oneauth.1 new file mode 100644 index 0000000000..e69de29bb2 diff --git a/share/man/oneauth.8.gz b/share/man/oneauth.8.gz deleted file mode 100644 index 95554bb729..0000000000 Binary files a/share/man/oneauth.8.gz and /dev/null differ diff --git a/share/man/onecluster.1 b/share/man/onecluster.1 new file mode 100644 index 0000000000..6b8ee43ec0 --- /dev/null +++ b/share/man/onecluster.1 @@ -0,0 +1,76 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. +.TH OPENNEBULAPRO "1" "May 2011" "OpenNebulaPro 2.2.0" "User Commands" +.SH NAME +OpenNebulaPro \- OpenNebula Cluster command +.SH SYNOPSIS +.B onecluster +[\fI\fR] \fI \fR[\fI\fR] +.SH DESCRIPTION + +This command enables the OpenNebula administrator to manage clusters. The +administrator can create, delete, as well as add and remove hosts from them. +Any user can list available clusters. +.SH OPTIONS +.TP +\fB\-l\fR, \fB\-\-list\fR x,y,z +Selects columns to display with list +command +.TP +\fB\-\-list\-columns\fR +Information about the columns available +to display, order or filter +.TP +\fB\-o\fR, \fB\-\-order\fR x,y,z +Order by these columns, column starting +with \- means decreasing order +.TP +\fB\-f\fR, \fB\-\-filter\fR x,y,z +Filter data. An array is specified +with column=value pairs. +.TP +\fB\-x\fR, \fB\-\-xml\fR +Returns xml instead of human readable text +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Tells more information if the command +is successful +.TP +\fB\-h\fR, \fB\-\-help\fR +Shows this help message +.TP +\fB\-\-version\fR +Shows version and copyright information +.SH COMMANDS +.TP +\fBcreate\fR (Creates a new cluster) +.IP +onecluster create clustername +.TP +\fBdelete\fR (Removes a cluster) +.IP +onecluster delete +.TP +\fBlist\fR (Lists all the clusters in the pool) +.IP +onecluster list +.TP +\fBaddhost\fR (Add a host to the cluster) +.IP +onecluster addhost +.TP +\fBremovehost\fR (Remove a host from the cluster) +.IP +onecluster removehost +.SH COPYRIGHT +Copyright 2010\-2011, C12G Labs S.L. +.PP +Licensed under the C12G Commercial Open\-source License (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License as part +of the software distribution. +.PP +Unless agreed to in writing, software distributed under the +License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES +OR CONDITIONS OF ANY KIND, either express or implied. See the +License for the specific language governing permissions and +limitations under the License. diff --git a/share/man/onecluster.8.gz b/share/man/onecluster.8.gz deleted file mode 100644 index 69544f59c9..0000000000 Binary files a/share/man/onecluster.8.gz and /dev/null differ diff --git a/share/man/onedb.1 b/share/man/onedb.1 new file mode 100644 index 0000000000..383a54437c --- /dev/null +++ b/share/man/onedb.1 @@ -0,0 +1,97 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. +.TH OPENNEBULAPRO "1" "May 2011" "OpenNebulaPro 2.2.0" "User Commands" +.SH NAME +OpenNebulaPro \- OpenNebula Database command +.SH SYNOPSIS +.B onedb +[\fI\fR] \fI \fR[\fI\fR] +.SH DESCRIPTION + +This command enables the user to manage the OpenNebula database. It provides +information about the DB version, means to upgrade it to the latest version, and +backup tools. +.SH OPTIONS +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Tells more information if the command +is successful +.TP +\fB\-f\fR, \fB\-\-force\fR +Forces the backup even if the DB exists +.TP +\fB\-\-backup\fR file +Use this file to store/read SQL dump +.TP +\fB\-s\fR, \fB\-\-sqlite\fR file +SQLite DB file +.TP +\fB\-\-server\fR host +MySQL server hostname or IP. Defaults to localhost +.TP +\fB\-\-port\fR port +MySQL server port. Defaults to 3306 +.TP +\fB\-\-user\fR username +MySQL username +.TP +\fB\-\-passwd\fR password +MySQL password. Leave unset to be prompted for it +.TP +\fB\-\-dbname\fR name +MySQL DB name for OpenNebula +.TP +\fB\-h\fR, \fB\-\-help\fR +Shows this help message +.TP +\fB\-\-version\fR +Shows version and copyright information +.PP +DB Connection options: +.PP +By default, onedb reads the connection data from oned.conf +If any of these options is set, oned.conf is ignored (i.e. if you set MySQL's +port onedb won't look for the rest of the options in oned.conf) +.SH COMMANDS +.TP +\fBupgrade\fR (Upgrades the DB to the latest version) +.IP +onedb upgrade [] +.IP +where : DB version (e.g. 1, 3) to upgrade. By default the DB is +.IP +upgraded to the latest version +.TP +\fBversion\fR (Prints the current DB version. Use \fB\-v\fR flag to see also OpenNebula version) +.IP +onedb version +.TP +\fBhistory\fR (Prints the upgrades history) +.IP +onedb history +.TP +\fBbackup\fR (Dumps the DB to a file) +.IP +onedb backup [] +.IP +where : Same as \fB\-\-backup\fR +.TP +\fBrestore\fR (Restores the DB from a backup file. Only restores backups generated +.IP +from the same backend (SQLite or MySQL)) +.IP +onedb restore [] +.IP +where : Same as \fB\-\-backup\fR +.SH COPYRIGHT +Copyright 2010\-2011, C12G Labs S.L. +.PP +Licensed under the C12G Commercial Open\-source License (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License as part +of the software distribution. +.PP +Unless agreed to in writing, software distributed under the +License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES +OR CONDITIONS OF ANY KIND, either express or implied. See the +License for the specific language governing permissions and +limitations under the License. diff --git a/share/man/onehost.1 b/share/man/onehost.1 new file mode 100644 index 0000000000..6682e22eeb --- /dev/null +++ b/share/man/onehost.1 @@ -0,0 +1,112 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. +.TH OPENNEBULAPRO "1" "May 2011" "OpenNebulaPro 2.2.0" "User Commands" +.SH NAME +OpenNebulaPro \- OpenNebula Host command +.SH SYNOPSIS +.B onehost +[\fI\fR] \fI \fR[\fI\fR] +.SH DESCRIPTION + +This command enables the user to manage hosts in the Open Nebula server. It +provides functionality to allocate, get information and delete a particular +host or to list all the available hosts. +.SH OPTIONS +.TP +\fB\-l\fR, \fB\-\-list\fR x,y,z +Selects columns to display with list +command +.TP +\fB\-\-list\-columns\fR +Information about the columns available +to display, order or filter +.TP +\fB\-o\fR, \fB\-\-order\fR x,y,z +Order by these columns, column starting +with \- means decreasing order +.TP +\fB\-f\fR, \fB\-\-filter\fR x,y,z +Filter data. An array is specified +with column=value pairs. +.TP +\fB\-d\fR, \fB\-\-delay\fR seconds +Sets the delay in seconds for top +command +.TP +\fB\-x\fR, \fB\-\-xml\fR +Returns xml instead of human readable text +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Tells more information if the command +is successful +.TP +\fB\-h\fR, \fB\-\-help\fR +Shows this help message +.TP +\fB\-\-version\fR +Shows version and copyright information +.SH COMMANDS +.TP +\fBcreate\fR (Adds a new machine to the pool) +.IP +onehost create +.TP +\fBshow\fR (Gets info from a host) +.IP +onehost show +.TP +\fBdelete\fR (Removes a machine from the pool) +.IP +onehost delete +.TP +\fBlist\fR (Lists machines in the pool) +.IP +onehost list +.TP +\fBenable\fR (Enables host) +.IP +onehost enable +.TP +\fBdisable\fR (Disables host) +.IP +onehost disable +.TP +\fBtop\fR (Lists hosts continuously) +.IP +onehost top +.TP +\fBsync\fR (synchronizes probes with remote hosts) +.IP +onehost sync +.PP +Information Columns: +.TP +\fBHID\fR Host ID +.TP +\fBNAME\fR Host name +.TP +\fBRVM\fR Number of running VMs +.TP +\fBTCPU\fR Total CPU (percentage) +.TP +\fBFCPU\fR Free CPU (percentage) +.TP +\fBACPU\fR Available CPU (not allocated by VMs) +.TP +\fBTMEM\fR Total memory +.TP +\fBFMEM\fR Free memory +.TP +\fBSTAT\fR Host status +.SH COPYRIGHT +Copyright 2010\-2011, C12G Labs S.L. +.PP +Licensed under the C12G Commercial Open\-source License (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License as part +of the software distribution. +.PP +Unless agreed to in writing, software distributed under the +License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES +OR CONDITIONS OF ANY KIND, either express or implied. See the +License for the specific language governing permissions and +limitations under the License. diff --git a/share/man/onehost.8.gz b/share/man/onehost.8.gz deleted file mode 100644 index fcecb4540e..0000000000 Binary files a/share/man/onehost.8.gz and /dev/null differ diff --git a/share/man/oneimage.1 b/share/man/oneimage.1 new file mode 100644 index 0000000000..937381616b --- /dev/null +++ b/share/man/oneimage.1 @@ -0,0 +1,133 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. +.TH OPENNEBULAPRO "1" "May 2011" "OpenNebulaPro 2.2.0" "User Commands" +.SH NAME +OpenNebulaPro \- OpenNebula Image command +.SH SYNOPSIS +.B oneimage +[\fI\fR] \fI \fR[\fI\fR] +.SH DESCRIPTION + +This command enables the user to manage images. +.SH OPTIONS +.TP +\fB\-l\fR, \fB\-\-list\fR x,y,z +Selects columns to display with list +command +.TP +\fB\-\-list\-columns\fR +Information about the columns available +to display, order or filter +.TP +\fB\-o\fR, \fB\-\-order\fR x,y,z +Order by these columns, column starting +with \- means decreasing order +.TP +\fB\-f\fR, \fB\-\-filter\fR x,y,z +Filter data. An array is specified +with column=value pairs. +.TP +\fB\-d\fR, \fB\-\-delay\fR seconds +Sets the delay in seconds for top +command +.TP +\fB\-x\fR, \fB\-\-xml\fR +Returns xml instead of human readable text +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Tells more information if the command +is successful +.TP +\fB\-h\fR, \fB\-\-help\fR +Shows this help message +.TP +\fB\-\-version\fR +Shows version and copyright information +.SH COMMANDS +.TP +\fBregister\fR (Registers an image, copying it to the repository if it applies) +.IP +oneimage register