From c548c8478014cb860f59766eacbfffd8bc925f15 Mon Sep 17 00:00:00 2001 From: Javi Fontan Date: Wed, 28 Sep 2011 00:27:00 +0200 Subject: [PATCH] Added man pages for econe/occi CLI 3.0.0 (cherry picked from commit 3df0c6dadc61f67c72c3ccc1539608cefcde5d79) --- share/man/econe-describe-images.1 | 39 +++++++++++++++ share/man/econe-describe-instances.1 | 39 +++++++++++++++ share/man/econe-register.1 | 43 +++++++++++++++++ share/man/econe-run-instances.1 | 51 ++++++++++++++++++++ share/man/econe-terminate-instances.1 | 38 +++++++++++++++ share/man/econe-upload.1 | 42 +++++++++++++++++ share/man/occi-compute.1 | 64 +++++++++++++++++++++++++ share/man/occi-network.1 | 68 +++++++++++++++++++++++++++ share/man/occi-storage.1 | 68 +++++++++++++++++++++++++++ 9 files changed, 452 insertions(+) diff --git a/share/man/econe-describe-images.1 b/share/man/econe-describe-images.1 index e69de29bb2..975ca7f8fd 100644 --- a/share/man/econe-describe-images.1 +++ b/share/man/econe-describe-images.1 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. +.TH OPENNEBULA "1" "September 2011" "OpenNebula 3.0.0" "User Commands" +.SH NAME +OpenNebula \- OpenNebula econe-describe-images +.SH SYNOPSIS +.B econe-describe-images +[\fIOPTIONS\fR] +.SH DESCRIPTION +econe\-describe\-images +.PP +List and describe previously uploaded images of a user to be +used with an OpenNebula Cloud. +.SH OPTIONS +.HP +\fB\-\-help\fR, \fB\-h\fR +.IP +Show help +.HP +\fB\-\-access\-key\fR , \fB\-K\fR +.IP +The username of the user +.HP +\fB\-\-secret\-key\fR , \fB\-S\fR +.IP +The password of the user +.HP +\fB\-\-url\fR , \fB\-U\fR +.IP +Set url as the web service url to use +.HP +\fB\-\-headers\fR, \fB\-H\fR +.IP +Display column headers +.SH COPYRIGHT +Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula.org) +.PP +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/econe-describe-instances.1 b/share/man/econe-describe-instances.1 index e69de29bb2..ec9e972991 100644 --- a/share/man/econe-describe-instances.1 +++ b/share/man/econe-describe-instances.1 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. +.TH OPENNEBULA "1" "September 2011" "OpenNebula 3.0.0" "User Commands" +.SH NAME +OpenNebula \- OpenNebula econe-describe-instances +.SH SYNOPSIS +.B econe-describe-instances +[\fIOPTIONS\fR] +.SH DESCRIPTION +econe\-describe\-instances +.PP +List and describe running instances +.SH OPTIONS + +.HP +\fB\-\-help\fR, \fB\-h\fR +.IP +Show help +.HP +\fB\-\-access\-key\fR , \fB\-K\fR +.IP +The username of the user +.HP +\fB\-\-secret\-key\fR , \fB\-S\fR +.IP +The password of the user +.HP +\fB\-\-url\fR , \fB\-U\fR +.IP +Set url as the web service url to use +.HP +\fB\-\-headers\fR, \fB\-H\fR +.IP +Display column headers +.SH COPYRIGHT +Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula.org) +.PP +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/econe-register.1 b/share/man/econe-register.1 index e69de29bb2..1db1a75d02 100644 --- a/share/man/econe-register.1 +++ b/share/man/econe-register.1 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. +.TH OPENNEBULA "1" "September 2011" "OpenNebula 3.0.0" "User Commands" +.SH NAME +OpenNebula \- OpenNebula econe-register +.SH SYNOPSIS +.B econe-register +[\fIOPTIONS\fR] \fIIMAGE-ID\fR +.SH DESCRIPTION +econe\-register +.PP +Register a previously uploaded image for use with an +OpenNebula Cloud. +.SH OPTIONS + +.HP +\fB\-\-help\fR, \fB\-h\fR +.IP +Show help +.HP +\fB\-\-access\-key\fR , \fB\-K\fR +.IP +The username of the user +.HP +\fB\-\-secret\-key\fR , \fB\-S\fR +.IP +The password of the user +.HP +\fB\-\-url\fR , \fB\-U\fR +.IP +Set url as the web service url to use +.HP +\fB\-\-headers\fR, \fB\-H\fR +.IP +Display column headers +.PP +IMAGE\-ID: The image identification as returned by +the econe\-upload command +.SH COPYRIGHT +Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula.org) +.PP +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/econe-run-instances.1 b/share/man/econe-run-instances.1 index e69de29bb2..92ab73a6d2 100644 --- a/share/man/econe-run-instances.1 +++ b/share/man/econe-run-instances.1 @@ -0,0 +1,51 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. +.TH OPENNEBULA "1" "September 2011" "OpenNebula 3.0.0" "User Commands" +.SH NAME +OpenNebula \- OpenNebula econe-run-instances +.SH SYNOPSIS +.B econe-run-instances +[\fIOPTIONS\fR] \fIIMAGE-ID\fR +.SH DESCRIPTION +econe\-run\-instances +.PP +Runs an instance of a particular image +.SH OPTIONS + +.HP +\fB\-\-help\fR, \fB\-h\fR +.IP +Show help +.HP +\fB\-\-access\-key\fR , \fB\-K\fR +.IP +The username of the user +.HP +\fB\-\-secret\-key\fR , \fB\-S\fR +.IP +The password of the user +.HP +\fB\-\-url\fR , \fB\-U\fR +.IP +Set url as the web service url to use +.HP +\fB\-\-type\fR , \fB\-t\fR +.IP +OpenNebula template in which is based this instance +.HP +\fB\-\-user\-data\fR, \fB\-d\fR +.IP +Specifies Base64\-encoded MIME user data to be made +available to the instance +.HP +\fB\-\-headers\fR, \fB\-H\fR +.IP +Display column headers +.PP +IMAGE\-ID: The image identification as returned by +the econe\-upload command +.SH COPYRIGHT +Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula.org) +.PP +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/econe-terminate-instances.1 b/share/man/econe-terminate-instances.1 index e69de29bb2..f39fb6b867 100644 --- a/share/man/econe-terminate-instances.1 +++ b/share/man/econe-terminate-instances.1 @@ -0,0 +1,38 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. +.TH OPENNEBULA "1" "September 2011" "OpenNebula 3.0.0" "User Commands" +.SH NAME +OpenNebula \- OpenNebula econe-terminate-instances +.SH SYNOPSIS +.B econe-register +[\fIOPTIONS\fR] \fIINSTANCE-ID\fR +.SH DESCRIPTION +econe\-terminate\-instances +.PP +Terminate the selected running instance +.SH OPTIONS + +.HP +\fB\-\-help\fR, \fB\-h\fR +.IP +Show help +.HP +\fB\-\-access\-key\fR , \fB\-K\fR +.IP +The username of the user +.HP +\fB\-\-secret\-key\fR , \fB\-S\fR +.IP +The password of the user +.HP +\fB\-\-url\fR , \fB\-U\fR +.IP +Set url as the web service url to use +.PP +INSTANCE\-ID: The instance identification as returned by +the econe\-run\-instances command +.SH COPYRIGHT +Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula.org) +.PP +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/econe-upload.1 b/share/man/econe-upload.1 index e69de29bb2..10239bc1d3 100644 --- a/share/man/econe-upload.1 +++ b/share/man/econe-upload.1 @@ -0,0 +1,42 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. +.TH OPENNEBULA "1" "September 2011" "OpenNebula 3.0.0" "User Commands" +.SH NAME +OpenNebula \- OpenNebula econe-upload +.SH SYNOPSIS +.B econe-upload +[\fIOPTIONS\fR] \fIIMAGE-PATH\fR +.SH DESCRIPTION +econe\-upload +.PP +Uploads an image for use with an OpenNebula Cloud. This image should +be later register with econe\-register using the returned ImageId +.SH OPTIONS + +.HP +\fB\-\-help\fR, \fB\-h\fR +.IP +Show help +.HP +\fB\-\-access\-key\fR , \fB\-K\fR +.IP +The username of the user +.HP +\fB\-\-secret\-key\fR , \fB\-S\fR +.IP +The password of the user +.HP +\fB\-\-url\fR , \fB\-U\fR +.IP +Set url as the web service url to use +.HP +\fB\-\-multipart\fR, \fB\-M\fR +.IP +Use 'multipart\-post' library instead of Curb/Curl +.PP +IMAGE\-PATH: Path to the image to upload +.SH COPYRIGHT +Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula.org) +.PP +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/occi-compute.1 b/share/man/occi-compute.1 index e69de29bb2..7e2276bb51 100644 --- a/share/man/occi-compute.1 +++ b/share/man/occi-compute.1 @@ -0,0 +1,64 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. +.TH OPENNEBULA "1" "September 2011" "OpenNebula 3.0.0" "User Commands" +.SH NAME +OpenNebula \- OpenNebula occi-compute +.SH SYNOPSIS +.B occi-compute +\fI \fR[\fIOPTIONS\fR] [\fIARGUMENTS\fR] +.SH DESCRIPTION +occi\-compute \- Manages compute resources +.SH OPTIONS + +\fB\-\-help\fR, \fB\-h\fR +.IP +Show help +.PP +\fB\-\-username\fR , \fB\-U\fR +.IP +The username of the user +.PP +\fB\-\-password\fR , \fB\-P\fR +.IP +The password of the user +.PP +\fB\-\-url\fR , \fB\-R\fR +.IP +Set url as the web service url to use +.PP +\fB\-\-timeout\fR , \fB\-T\fR +.IP +Sets a timeout for the http connection +.PP +\fB\-\-debug\fR, \fB\-D\fR +.IP +Enables verbosity +.SH COMMANDS +.TP +\fBcreate\fR +.IP +creates a new compute resource described by the provided + +.TP +\fBlist\fR +.IP +lists available compute resources +.TP +\fBshow\fR +.IP +retrieves the OCCI XML representation of the compute resource +identified by +.TP +\fBupdate\fR +.IP +updates the representation of the compute resource represented by the +provided +.TP +\fBdelete\fR +.IP +deletes the compute resource idenfitied by +.SH COPYRIGHT +Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula.org) +.PP +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/occi-network.1 b/share/man/occi-network.1 index e69de29bb2..21ae49696c 100644 --- a/share/man/occi-network.1 +++ b/share/man/occi-network.1 @@ -0,0 +1,68 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. +.TH OPENNEBULA "1" "September 2011" "OpenNebula 3.0.0" "User Commands" +.SH NAME +OpenNebula \- OpenNebula occi-network +.SH SYNOPSIS +.B occi-network +\fI \fR[\fIOPTIONS\fR] [\fIARGUMENTS\fR] +.SH DESCRIPTION +occi\-network \- Manages virtual networks +.SH OPTIONS + +\fB\-\-help\fR, \fB\-h\fR +.IP +Show help +.PP +\fB\-\-username\fR , \fB\-U\fR +.IP +The username of the user +.PP +\fB\-\-password\fR , \fB\-P\fR +.IP +The password of the user +.PP +\fB\-\-url\fR , \fB\-R\fR +.IP +Set url as the web service url to use +.PP +\fB\-\-timeout\fR , \fB\-T\fR +.IP +Sets a timeout for the http connection +.PP +\fB\-\-debug\fR, \fB\-D\fR +.IP +Enables verbosity +.PP +\fB\-\-multipart\fR, \fB\-M\fR +.IP +Use 'multipart\-post' library instead of Curb/Curl +.SH COMMANDS +.TP +\fBcreate\fR +.IP +creates a new virtual network described by the provided + +.TP +\fBlist\fR +.IP +lists available virtual networks +.TP +\fBshow\fR +.IP +retrieves the OCCI XML representation of the virtual network +identified by +.TP +\fBupdate\fR +.IP +updates the representation of the network resource represented by the +provided +.TP +\fBdelete\fR +.IP +deletes the virtual network idenfitied by +.SH COPYRIGHT +Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula.org) +.PP +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/occi-storage.1 b/share/man/occi-storage.1 index e69de29bb2..e63697e535 100644 --- a/share/man/occi-storage.1 +++ b/share/man/occi-storage.1 @@ -0,0 +1,68 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.37.1. +.TH OPENNEBULA "1" "September 2011" "OpenNebula 3.0.0" "User Commands" +.SH NAME +OpenNebula \- OpenNebula occi-storage +.SH SYNOPSIS +.B occi-storage +\fI \fR[\fIOPTIONS\fR] [\fIPARAMETERS\fR] +.SH DESCRIPTION +occi\-storage \- Manages OCCI storage resource +.SH OPTIONS + +\fB\-\-help\fR, \fB\-h\fR +.IP +Show help +.PP +\fB\-\-username\fR , \fB\-U\fR +.IP +The username of the user +.PP +\fB\-\-password\fR , \fB\-P\fR +.IP +The password of the user +.PP +\fB\-\-url\fR , \fB\-R\fR +.IP +Set url as the web service url to use +.PP +\fB\-\-timeout\fR , \fB\-T\fR +.IP +Sets a timeout for the http connection +.PP +\fB\-\-debug\fR, \fB\-D\fR +.IP +Enables verbosity +.PP +\fB\-\-multipart\fR, \fB\-M\fR +.IP +Use 'multipart\-post' library instead of Curb/Curl +.SH COMMANDS +.TP +\fBcreate\fR +.IP +creates a new storage resource described by the provided + +.TP +\fBlist\fR +.IP +lists available storage resources +.TP +\fBshow\fR +.IP +retrieves the OCCI XML representation of the storage resource +identified by +.TP +\fBupdate\fR +.IP +updates the representation of the storage resource represented by the +provided +.TP +\fBdelete\fR +.IP +deletes the storage resource idenfitied by +.SH COPYRIGHT +Copyright 2002\-2011, OpenNebula Project Leads (OpenNebula.org) +.PP +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