diff --git a/share/man/oneacl.1 b/share/man/oneacl.1 new file mode 100644 index 0000000000..5b5ecb7fe1 --- /dev/null +++ b/share/man/oneacl.1 @@ -0,0 +1,90 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "ONEACL" "1" "July 2011" "" "oneacl(1) -- manages OpenNebula ACLs" +. +.SH "NAME" +\fBoneacl\fR +. +.SH "SYNOPSIS" +\fBoneacl\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR] +. +.SH "OPTIONS" +. +.nf + + \-x, \-\-xml Show the resource in xml format + \-v, \-\-verbose Verbose mode + \-h, \-\-help Show this message + \-V, \-\-version Show version and copyright information +. +.fi +. +.SH "COMMANDS" +. +.IP "\(bu" 4 +list +. +.IP "" 4 +. +.nf + +Lists the ACL rule set +valid options: xml +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +delete \fIrange\fR +. +.IP "" 4 +. +.nf + +Deletes an existing ACL rule +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +create \fIuser|rulestr\fR [\fIresource\fR] [\fIrights\fR] +. +.IP "" 4 +. +.nf + +Adds a new ACL rule +. +.fi +. +.IP "" 0 + +. +.IP "" 0 +. +.SH "ARGUMENT FORMATS" +. +.IP "\(bu" 4 +text +. +.IP "\(bu" 4 +range +. +.IP "\(bu" 4 +file +. +.IP "\(bu" 4 +aclid_list +. +.IP "" 0 +. +.SH "LICENSE" +OpenNebula 2\.9\.80 Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula\.org) +. +.P +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 diff --git a/share/man/oneauth.1 b/share/man/oneauth.1 index e69de29bb2..b8bab48be2 100644 --- a/share/man/oneauth.1 +++ b/share/man/oneauth.1 @@ -0,0 +1,87 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "ONEAUTH" "1" "July 2011" "" "oneauth(1) -- OpenNebula authentication client" +. +.SH "NAME" +\fBoneauth\fR +. +.SH "SYNOPSIS" +oneauth COMMAND [args\.\.] +. +.P +This command contains a set of utilities to manage authorization module\. +. +.SH "OPTIONS" +. +.nf + + \-v, \-\-verbose Verbose mode + \-h, \-\-help Show this message + \-V, \-\-version Show version and copyright information +. +.fi +. +.SH "COMMANDS" +. +.IP "\(bu" 4 +quota\-set \fIuserid\fR \fIcpu\fR \fImemory\fR \fInum_vms\fR +. +.IP "" 4 +. +.nf + +Sets CPU, MEMORY and NUM_VMs quota for a given user +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +key +. +.IP "" 4 +. +.nf + +Gets public key +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +login \fIuserid\fR \fItext\fR +. +.IP "" 4 +. +.nf + +Generates authentication proxy\. The last argument specifies +the expiration time in seconds +. +.fi +. +.IP "" 0 + +. +.IP "" 0 +. +.SH "ARGUMENT FORMATS" +. +.IP "\(bu" 4 +userid +. +.IP "\(bu" 4 +text +. +.IP "\(bu" 4 +range +. +.IP "\(bu" 4 +file +. +.IP "" 0 + diff --git a/share/man/onedb.1 b/share/man/onedb.1 index 383a54437c..8b6a6232bf 100644 --- a/share/man/onedb.1 +++ b/share/man/onedb.1 @@ -1,97 +1,132 @@ -.\" 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 +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "ONEDB" "1" "July 2011" "" "onedb(1) -- OpenNebula database migration tool" +. +.SH "NAME" +\fBonedb\fR +. +.P 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. +. +.P +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) +. +.P +Description: +. +.P +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" +. +.nf + + \-f, \-\-force Forces the backup even if the DB exists + \-b, \-\-backup file Use this file to store SQL dump + \-v, \-\-verbose Verbose mode + \-h, \-\-help Show this message + \-V, \-\-version Show version and copyright information + \-s file, \-\-sqlite file SQLite DB file + \-S host, \-\-server host MySQL server hostname or IP\. Defaults to localhost + \-P port, \-\-port port MySQL server port\. Defaults to 3306 + \-u user, \-\-username user MySQL username + \-p pass, \-\-password pass MySQL password\. Leave unset to be prompted for it + \-d dbname, \-\-dbname dbname MySQL DB name for OpenNebula +. +.fi +. +.SH "COMMANDS" +. +.IP "\(bu" 4 +restore [\fIbackup_file\fR] +. +.IP "" 4 +. +.nf + +Restores the DB from a backup file\. Only restores backups generated +from the same backend (SQLite or MySQL) +valid options: force +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +version +. +.IP "" 4 +. +.nf + +Prints the current DB version\. +Use \-v flag to see also OpenNebula version +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +upgrade [\fIversion\fR] +. +.IP "" 4 +. +.nf + +Upgrades the DB to the latest version +where : DB version (e\.g\. 1, 3) to upgrade\. + By default the DB is upgraded to the latest version +valid options: force, backup +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +backup [\fIoutput_file\fR] +. +.IP "" 4 +. +.nf + +Dumps the DB to a file specified in the argument +valid options: force +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +history +. +.IP "" 4 +. +.nf + +Prints the upgrades history +. +.fi +. +.IP "" 0 + +. +.IP "" 0 +. +.SH "ARGUMENT FORMATS" +. +.IP "\(bu" 4 +text +. +.IP "\(bu" 4 +file +. +.IP "\(bu" 4 +range +. +.IP "" 0 + diff --git a/share/man/onegroup.1 b/share/man/onegroup.1 new file mode 100644 index 0000000000..444c0eac6a --- /dev/null +++ b/share/man/onegroup.1 @@ -0,0 +1,111 @@ +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "ONEGROUP" "1" "July 2011" "" "onegroup(1) -- manages OpenNebula groups" +. +.SH "NAME" +\fBonegroup\fR +. +.SH "SYNOPSIS" +\fBonegroup\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR] +. +.SH "OPTIONS" +. +.nf + + \-l, \-\-list x,y,z Selects columns to display with list command + \-d, \-\-delay x Sets the delay in seconds for top command + \-x, \-\-xml Show the resource in xml format + \-n, \-\-numeric Do not translate user and group IDs + \-v, \-\-verbose Verbose mode + \-h, \-\-help Show this message + \-V, \-\-version Show version and copyright information +. +.fi +. +.SH "COMMANDS" +. +.IP "\(bu" 4 +create \fIname\fR +. +.IP "" 4 +. +.nf + +Creates a new Group +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +list +. +.IP "" 4 +. +.nf + +Lists Groups in the pool +valid options: list, delay, xml, numeric +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +delete \fIrange|groupid_list\fR +. +.IP "" 4 +. +.nf + +Deletes the given Group +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +show \fIgroupid\fR +. +.IP "" 4 +. +.nf + +Shows information for the given Group +valid options: xml +. +.fi +. +.IP "" 0 + +. +.IP "" 0 +. +.SH "ARGUMENT FORMATS" +. +.IP "\(bu" 4 +groupid_list +. +.IP "\(bu" 4 +text +. +.IP "\(bu" 4 +groupid +. +.IP "\(bu" 4 +file +. +.IP "\(bu" 4 +range +. +.IP "" 0 +. +.SH "LICENSE" +OpenNebula 2\.9\.80 Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula\.org) +. +.P +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 diff --git a/share/man/onehost.1 b/share/man/onehost.1 index 6682e22eeb..1f0060b697 100644 --- a/share/man/onehost.1 +++ b/share/man/onehost.1 @@ -1,112 +1,185 @@ -.\" 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 +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "ONEHOST" "1" "July 2011" "" "onehost(1) -- manages OpenNebula hosts" +. +.SH "NAME" +\fBonehost\fR +. +.SH "SYNOPSIS" +\fBonehost\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR] +. +.SH "OPTIONS" +. +.nf -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. + \-l, \-\-list x,y,z Selects columns to display with list command + \-d, \-\-delay x Sets the delay in seconds for top command + \-x, \-\-xml Show the resource in xml format + \-n, \-\-numeric Do not translate user and group IDs + \-k, \-\-kilobytes Show units in kilobytes + \-v, \-\-verbose Verbose mode + \-h, \-\-help Show this message + \-V, \-\-version Show version and copyright information +. +.fi +. +.SH "COMMANDS" +. +.IP "\(bu" 4 +enable \fIrange|hostid_list\fR +. +.IP "" 4 +. +.nf + +Enables the given Host +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +update \fIhostid\fR +. +.IP "" 4 +. +.nf + +Launches the system editor to modify and update the template contents +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +disable \fIrange|hostid_list\fR +. +.IP "" 4 +. +.nf + +Disables the given Host +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +top +. +.IP "" 4 +. +.nf + +Lists Hosts continuously +valid options: list, delay, xml, numeric, kilobytes +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +create \fIhostname\fR \fIim_mad\fR \fIvmm_mad\fR \fItm_mad\fR +. +.IP "" 4 +. +.nf + +Creates a new Host +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +sync +. +.IP "" 4 +. +.nf + +Synchronizes probes in /var/lib/one/remotes ($ONE_LOCATION/var/remotes +in self\-contained installations) with Hosts\. +The copy is performed the next time the Host is monitored +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +show \fIhostid\fR +. +.IP "" 4 +. +.nf + +Shows information for the given Host +valid options: xml +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +list +. +.IP "" 4 +. +.nf + +Lists Hosts in the pool +valid options: list, delay, xml, numeric, kilobytes +. +.fi +. +.IP "" 0 + +. +.IP "\(bu" 4 +delete \fIrange|hostid_list\fR +. +.IP "" 4 +. +.nf + +Deletes the given Host +. +.fi +. +.IP "" 0 + +. +.IP "" 0 +. +.SH "ARGUMENT FORMATS" +. +.IP "\(bu" 4 +hostid_list +. +.IP "\(bu" 4 +file +. +.IP "\(bu" 4 +text +. +.IP "\(bu" 4 +hostid +. +.IP "\(bu" 4 +range +. +.IP "" 0 +. +.SH "LICENSE" +OpenNebula 2\.9\.80 Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula\.org) +. +.P +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 diff --git a/share/man/oneimage.1 b/share/man/oneimage.1 index 937381616b..3fc1241a4d 100644 --- a/share/man/oneimage.1 +++ b/share/man/oneimage.1 @@ -1,133 +1,266 @@ -.\" 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 +.\" generated with Ronn/v0.7.3 +.\" http://github.com/rtomayko/ronn/tree/0.7.3 +. +.TH "ONEIMAGE" "1" "July 2011" "" "oneimage(1) -- manages OpenNebula images" +. +.SH "NAME" +\fBoneimage\fR +. +.SH "SYNOPSIS" +\fBoneimage\fR \fIcommand\fR [\fIargs\fR] [\fIoptions\fR] +. +.SH "OPTIONS" +. +.nf -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