Feature #370: Manpages now uncompressed in the source and moved to section 1

SConstruct

@@ -205,6 +205,7 @@ build_scripts=[
     'src/um/SConstruct',
     'src/authm/SConstruct',
     'src/xml/SConstruct',
+    'share/man/SConstruct'
 ]
 
 # Testing

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"
 
 #-----------------------------------------------------------------------------
 #-----------------------------------------------------------------------------

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")

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<options>\fR] \fI<command> \fR[\fI<parameters>\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 <id>
+.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 <host_id> <cluster_id>
+.TP
+\fBremovehost\fR (Remove a host from the cluster)
+.IP
+onecluster removehost <host_id> <cluster_id>
+.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.

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<options>\fR] \fI<command> \fR[\fI<parameters>\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 [<version>]
+.IP
+where <version> : 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 [<output_file>]
+.IP
+where <output_file> : 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 [<backup_file>]
+.IP
+where <backup_file> : 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.

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<options>\fR] \fI<command> \fR[\fI<parameters>\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 <hostname> <im_mad> <vmm_mad> <tm_mad>
+.TP
+\fBshow\fR (Gets info from a host)
+.IP
+onehost show <host_id>
+.TP
+\fBdelete\fR (Removes a machine from the pool)
+.IP
+onehost delete <host_id>
+.TP
+\fBlist\fR (Lists machines in the pool)
+.IP
+onehost list
+.TP
+\fBenable\fR (Enables host)
+.IP
+onehost enable <host_id>
+.TP
+\fBdisable\fR (Disables host)
+.IP
+onehost disable <host_id>
+.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.

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<options>\fR] \fI<command> \fR[\fI<parameters>\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 <template>
+.IP
+template is a file name where the Image description is located
+.TP
+\fBaddattr\fR (Add a new image attribute)
+.IP
+oneimage addattr <image_id> <attribute_name> <attribute_value>
+.TP
+\fBupdate\fR (Modifies an image attribute)
+.IP
+oneimage update <image_id> <attribute_name> <attribute_value>
+.TP
+\fBrmattr\fR (Deletes an Image attribute)
+.IP
+oneimage rmattr <image_id> <attribute_name>
+.TP
+\fBenable\fR (Enabled an Image)
+.IP
+oneimage enable <image_id>
+.TP
+\fBdisable\fR (Disabled an Image)
+.IP
+oneimage disable <image_id>
+.TP
+\fBpublish\fR (Publish an Image)
+.IP
+oneimage publish <image_id>
+.TP
+\fBunpublish\fR (Unpublish an Image)
+.IP
+oneimage unpublish <image_id>
+.TP
+\fBpersistent\fR (Makes an Image persistent)
+.IP
+oneimage persistent <image_id>
+.TP
+\fBnonpersistent\fR (Makes an Image non persistent)
+.IP
+oneimage nonpersistent <image_id>
+.TP
+\fBlist\fR (Shows Images in the pool)
+.IP
+oneimage list <filter_flag>
+.IP
+where filter_flag can be
+.TP
+a, all
+\fB\-\-\fR> all the known Images
+.TP
+m, mine
+\fB\-\-\fR> the Images belonging to the user in ONE_AUTH
+.TP
+and all the
+Public Images
+.TP
+uid
+\fB\-\-\fR> Images of the user identified by this uid
+.TP
+user
+\fB\-\-\fR> Images of the user identified by the username
+.TP
+\fBtop\fR (Lists Images continuously)
+.IP
+oneimage top
+.TP
+\fBshow\fR (Gets information about an specific Image)
+.IP
+oneimage show <image_id>
+.TP
+\fBdelete\fR (Deletes an already deployed Image)
+.IP
+oneimage delete <image_id>
+.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.

share/man/onetemplate.1

@@ -0,0 +1,117 @@
+.\" 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 Template command
+.SH SYNOPSIS
+.B onetemplate
+[\fI<options>\fR] \fI<command> \fR[\fI<parameters>\fR]
+.SH DESCRIPTION
+
+This command enables the user to manage templates.
+.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 (Registers a Template from a template file)
+.IP
+onetemplate create <file>
+.IP
+file is a file name where the Template description is located
+.TP
+\fBaddattr\fR (Add a new Template attribute)
+.IP
+onetemplate addattr <template_id> <attribute_name> <attribute_value>
+.TP
+\fBupdate\fR (Modifies a Template attribute)
+.IP
+onetemplate update <template_id> <attribute_name> <attribute_value>
+.TP
+\fBrmattr\fR (Deletes a Template attribute)
+.IP
+onetemplate rmattr <template_id> <attribute_name>
+.TP
+\fBpublish\fR (Publish a Template)
+.IP
+onetemplate publish <template_id>
+.TP
+\fBunpublish\fR (Unpublish an Template)
+.IP
+onetemplate unpublish <template_id>
+.TP
+\fBlist\fR (Shows Templates in the pool)
+.IP
+onetemplate list <filter_flag>
+.IP
+where filter_flag can be
+.TP
+a, all
+\fB\-\-\fR> all the known Templates
+.TP
+m, mine
+\fB\-\-\fR> the Templates belonging to the user in ONE_AUTH
+.TP
+and all the
+Public Templates
+.TP
+uid
+\fB\-\-\fR> Templates of the user identified by this uid
+.TP
+user
+\fB\-\-\fR> Templates of the user identified by the username
+.TP
+\fBtop\fR (Lists Templates continuously)
+.IP
+onetemplate top
+.TP
+\fBshow\fR (Gets information about an specific Template)
+.IP
+onetemplate show <template_id>
+.TP
+\fBdelete\fR (Deletes a Template)
+.IP
+onetemplate delete <template_id>
+.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.

share/man/oneuser.1

@@ -0,0 +1,90 @@
+.\" 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 User command
+.SH SYNOPSIS
+.B oneuser
+[\fI<options>\fR] \fI<command> \fR[\fI<parameters>\fR]
+.SH DESCRIPTION
+
+This command enables the OpenNebula administrator to manage users, adding,
+listing and deleting them.
+.PP
+The create and passwd commands accept the [\-r, \fB\-\-read\-file]\fR option. Use this
+option to store the contents of a file (without hashing it) as the password.
+.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\-n\fR, \fB\-\-no\-hash\fR
+Store plain password into the database
+.TP
+\fB\-r\fR, \fB\-\-read\-file\fR
+Read password from file
+.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 user)
+.IP
+oneuser create username password
+.TP
+\fBdelete\fR (Removes a user)
+.IP
+oneuser delete <id>
+.TP
+\fBlist\fR (Lists all the users in the pool)
+.IP
+oneuser list
+.TP
+\fBpasswd\fR (Changes the given user's password)
+.IP
+oneuser passwd <id> password
+.PP
+Information Columns:
+.TP
+\fBUID\fR       User ID
+.TP
+\fBNAME\fR      Name of the user
+.TP
+\fBPASSWORD\fR  SHA1 encrypted password
+.TP
+\fBENABLE\fR    Whether the user is enabled or not
+.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.

share/man/onevm.1

@@ -0,0 +1,235 @@
+.\" 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 Virtual Machine command
+.SH SYNOPSIS
+.B onevm
+[\fI<options>\fR] \fI<command> \fR[\fI<parameters>\fR]
+.SH DESCRIPTION
+
+This command enables the user to manage virtual machines in OpenNebula.
+The user can allocate, deploy, migrate, suspend, resume and shutdown a virtual
+machine with the functionality present in onevm.
+.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\-t\fR, \fB\-\-type\fR type
+Image type
+.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 (Submits a new virtual machine, adding it to the ONE VM pool)
+.IP
+onevm create <template>
+.IP
+template is a file name where the VM description is located
+.TP
+\fBdeploy\fR (Starts an existing VM in an specific host)
+.IP
+onevm deploy <vm_id> <host_id>
+.IP
+States: PENDING
+.TP
+\fBshutdown\fR (Shuts down an already deployed VM)
+.IP
+onevm shutdown <vm_id>
+.IP
+States: RUNNING
+.TP
+\fBlivemigrate\fR (Migrates a running VM to another host without downtime)
+.IP
+onevm livemigrate <vm_id> <host_id>
+.IP
+States: RUNNING
+.TP
+\fBmigrate\fR (Saves a running VM and starts it again in the specified host)
+.IP
+onevm migrate <vm_id> <host_id>
+.IP
+States: RUNNING
+.TP
+\fBhold\fR (Sets a VM to hold state, scheduler will not deploy it)
+.IP
+onevm hold <vm_id>
+.IP
+States: PENDING
+.TP
+\fBrelease\fR (Releases a VM from hold state, setting it to pending)
+.IP
+onevm release <vm_id>
+.IP
+States: HOLD
+.TP
+\fBstop\fR (Stops a running VM)
+.IP
+onevm stop <vm_id>
+.IP
+States: RUNNING
+.TP
+\fBcancel\fR (Cancels a running VM)
+.IP
+onevm cancel <vm_id>
+.IP
+States: RUNNING
+.TP
+\fBsuspend\fR (Saves a running VM)
+.IP
+onevm suspend <vm_id>
+.IP
+States: RUNNING
+.TP
+\fBresume\fR (Resumes the execution of a saved VM)
+.IP
+onevm resume <vm_id>
+.IP
+States: STOPPED, SUSPENDED
+.TP
+\fBsaveas\fR (Set the specified vms disk to be saved in a new image (image_name)
+.IP
+when the vm shuts down)
+.IP
+onevm saveas <vm_id> <disk_id> <image_name>
+.IP
+(Set a different type for the new Image)
+.IP
+onevm saveas <vm_id> <disk_id> <image_name> \fB\-t\fR/\-\-type <type>
+.TP
+\fBdelete\fR (Deletes a VM from the pool)
+.IP
+onevm delete <vm_id>
+.IP
+States: ANY
+.TP
+\fBrestart\fR (Forces a re\-deployment of a VM in UNKNOWN or BOOT state)
+.IP
+onevm restart <vm_id>
+.IP
+States: UNKNOWN, BOOT
+.TP
+\fBresubmit\fR (Resubmits a VM to PENDING state)
+.IP
+onevm resubmit <vm_id>
+.IP
+States: ANY, except SUSPENDED or DONE
+.TP
+\fBlist\fR (Shows VMs in the pool)
+.IP
+onevm list <filter_flag>
+.IP
+where filter_flag can be
+.TP
+a, all
+\fB\-\-\fR> all the known VMs
+.TP
+m, mine
+\fB\-\-\fR> the VMs belonging to the user in ONE_AUTH
+.TP
+uid
+\fB\-\-\fR> VMs of the user identified by this uid
+.TP
+user
+\fB\-\-\fR> VMs of the user identified by the username
+.TP
+\fBshow\fR (Gets information about a specific VM)
+.IP
+onevm show <vm_id>
+.TP
+\fBtop\fR (Lists VMs continuously)
+.IP
+onevm top
+.TP
+\fBhistory\fR (Gets history from VMs)
+.IP
+onevm history [<vm_id> <vm_id> ...]
+.IP
+if no vm_id is provided it will list history for all known VMs
+.PP
+Information Columns:
+.TP
+\fBID\fR        ONE VM identifier
+.TP
+\fBUSER\fR      Username of the VM owner
+.TP
+\fBNAME\fR      Name of the VM
+.TP
+\fBSTAT\fR      Status of the VM
+.TP
+\fBCPU\fR       CPU percentage used by the VM
+.TP
+\fBMEM\fR       Memory used by the VM
+.TP
+\fBHOSTNAME\fR  Host where the VM is being or was run
+.TP
+\fBTIME\fR      Time since the submission of the VM (days hours:minutes:seconds)
+.PP
+VM States:
+.TP
+\fBpend\fR   pending
+.TP
+\fBhold\fR   VM on hold (not runnable)
+.TP
+\fBstop\fR   stopped
+.TP
+\fBsusp\fR   suspended
+.TP
+\fBdone\fR   finished
+.TP
+\fBprol\fR   prolog
+.TP
+\fBboot\fR   booting
+.TP
+\fBrunn\fR   running
+.TP
+\fBmigr\fR   migrating
+.TP
+\fBsave\fR   saving the VM to disk
+.TP
+\fBepil\fR   epilog
+.TP
+\fBshut\fR   shutting down
+.TP
+\fBfail\fR   failed
+.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.

share/man/onevnet.1

@@ -0,0 +1,117 @@
+.\" 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 Virtual Network command
+.SH SYNOPSIS
+.B onevnet
+[\fI<options>\fR] \fI<command> \fR[\fI<parameters>\fR]
+.SH DESCRIPTION
+
+This command enables the user to manage virtual networks in the OpenNebula
+server. It provides functionality to create, get information and delete a
+particular network or to list available and used IP's.
+.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 virtual network)
+.IP
+onevnet create <template>
+.IP
+template is a filename where the virtual network is described
+.TP
+\fBshow\fR (Gets info from a virtual network)
+.IP
+onevnet show <network_id>
+.TP
+\fBpublish\fR (Publish a virtual network)
+.IP
+onevnet publish <network_id>
+.TP
+\fBunpublish\fR (Unpublish a virtual network)
+.IP
+onevnet unpublish <network_id>
+.TP
+\fBdelete\fR (Removes a virtual network)
+.IP
+onevnet delete <network_id>
+.TP
+\fBaddleases\fR (Adds a lease to the virtual network)
+.IP
+onevnet addleases <network_id> <IP> [<MAC>]
+.TP
+\fBrmleases\fR (Removes a lease fom the virtual network)
+.IP
+onevnet rmleases <network_id> <IP>
+.TP
+\fBlist\fR (Lists virtual networks in the pool)
+.IP
+onevnet list <filter_flag>
+.IP
+where filter_flag can be
+.TP
+a, all
+: all the known VNs
+.IP
+m, mine : the VNs belonging to the user in ONE_AUTH
+.IP
+and all the Public VNs
+.TP
+uid
+: VNs of the user identified by this uid
+.TP
+user
+: VNs of the user identified by the username
+.PP
+Information columns:
+.TP
+\fBNID\fR       Network ID
+.TP
+\fBNAME\fR      Name of the virtual network
+.TP
+\fBTYPE\fR      Type of virtual network (0=ranged, 1=fixed)
+.TP
+\fBBRIDGE\fR    Bridge associated to the virtual network
+.TP
+\fBLEASES\fR    Number of leases used from this virtual network
+.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.

src/authm/SConstruct

@@ -1,4 +1,4 @@
-# SConstruct for src/vm
+# SConstruct for src/authm
 
 # -------------------------------------------------------------------------- #
 # Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org)             #