shaba/one
1
0
Fork 0
mirror of https://github.com/OpenNebula/one.git synced 2025-02-03 13:47:01 +03:00
Code Releases Wiki Activity

Make cloud CLI help compatible with help2man

Browse Source
This commit is contained in:
Javi Fontan 2010-10-19 17:00:29 +02:00
parent 244a408bec
commit 3d6d9562fe
9 changed files with 111 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
src/cloud/ec2/bin/econe-describe-images
View File

@ -28,30 +28,28 @@ $: << RUBY_LIB_LOCATION
$: << RUBY_LIB_LOCATION+"/cloud"
COMMANDS_HELP=<<-EOT
** Synopsis
-----------
econe-describe-images
econe-describe-images
List and describe previously uploaded images of a user to be
used with an OpenNebula Cloud.
List and describe previously uploaded images of a user to be
used with an OpenNebula Cloud.
** Usage
--------
Usage:
econe-describe-images [OPTIONS]
--help, -h:
Options:
--help, -h
Show help
--access-key <id>, -K <id>:
--access-key <id>, -K <id>
The username of the user
--secret-key <key>, -S <key>:
--secret-key <key>, -S <key>
The password of the user
--url <url>, -U <url>:
--url <url>, -U <url>
Set url as the web service url to use
--headers, -H:
--headers, -H
Display column headers
EOT

23
src/cloud/ec2/bin/econe-describe-instances
View File

@ -27,29 +27,28 @@ $: << RUBY_LIB_LOCATION
$: << RUBY_LIB_LOCATION+"/cloud"
COMMANDS_HELP=<<-EOT
** Synopsis
-----------
econe-describe-instances
List and describe running instances
econe-describe-instances
** Usage
--------
List and describe running instances
Usage:
econe-describe-instances [OPTIONS]
Options:
--help, -h:
--help, -h
Show help
--access-key <id>, -K <id>:
--access-key <id>, -K <id>
The username of the user
--secret-key <key>, -S <key>:
--secret-key <key>, -S <key>
The password of the user
--url <url>, -U <url>:
--url <url>, -U <url>
Set url as the web service url to use
--headers, -H:
--headers, -H
Display column headers
EOT

29
src/cloud/ec2/bin/econe-register
View File

@ -27,34 +27,33 @@ $: << RUBY_LIB_LOCATION
$: << RUBY_LIB_LOCATION+"/cloud"
COMMANDS_HELP=<<-EOT
** Synopsis
-----------
econe-register
Register a previously uploaded image for use with an
OpenNebula Cloud.
econe-register
** Usage
--------
Register a previously uploaded image for use with an
OpenNebula Cloud.
Usage:
econe-register [OPTIONS] IMAGE-ID
--help, -h:
Options:
--help, -h
Show help
--access-key <id>, -K <id>:
--access-key <id>, -K <id>
The username of the user
--secret-key <key>, -S <key>:
--secret-key <key>, -S <key>
The password of the user
--url <url>, -U <url>:
--url <url>, -U <url>
Set url as the web service url to use
--headers, -H:
--headers, -H
Display column headers
IMAGE-ID: The image identification as returned by
the econe-upload command
IMAGE-ID: The image identification as returned by
the econe-upload command
EOT

31
src/cloud/ec2/bin/econe-run-instances
View File

@ -28,40 +28,39 @@ $: << RUBY_LIB_LOCATION
$: << RUBY_LIB_LOCATION+"/cloud"
COMMANDS_HELP=<<-EOT
** Synopsis
-----------
econe-run-instances
Runs an instance of a particular image
econe-run-instances
** Usage
--------
Runs an instance of a particular image
Usage:
econe-run-instances [OPTIONS] IMAGE-ID
--help, -h:
Options:
--help, -h
Show help
--access-key <id>, -K <id>:
--access-key <id>, -K <id>
The username of the user
--secret-key <key>, -S <key>:
--secret-key <key>, -S <key>
The password of the user
--url <url>, -U <url>:
--url <url>, -U <url>
Set url as the web service url to use
--type <type>, -t <type>:
--type <type>, -t <type>
OpenNebula template in which is based this instance
-–user-data, -d:
--user-data, -d
Specifies Base64-encoded MIME user data to be made
available to the instance
--headers, -H:
--headers, -H
Display column headers
IMAGE-ID: The image identification as returned by
the econe-upload command
IMAGE-ID: The image identification as returned by
the econe-upload command
EOT

25
src/cloud/ec2/bin/econe-terminate-instances
View File

@ -28,30 +28,29 @@ $: << RUBY_LIB_LOCATION
$: << RUBY_LIB_LOCATION+"/cloud"
COMMANDS_HELP=<<-EOT
** Synopsis
-----------
econe-terminate-instances
Terminate the selected running instance
econe-terminate-instances
** Usage
--------
Terminate the selected running instance
Usage:
econe-register [OPTIONS] INSTANCE-ID
--help, -h:
Options:
--help, -h
Show help
--access-key <id>, -K <id>:
--access-key <id>, -K <id>
The username of the user
--secret-key <key>, -S <key>:
--secret-key <key>, -S <key>
The password of the user
--url <url>, -U <url>:
--url <url>, -U <url>
Set url as the web service url to use
INSTANCE-ID: The instance identification as returned by
the econe-run-instances command
INSTANCE-ID: The instance identification as returned by
the econe-run-instances command
EOT

27
src/cloud/ec2/bin/econe-upload
View File

@ -27,33 +27,32 @@ $: << RUBY_LIB_LOCATION
$: << RUBY_LIB_LOCATION+"/cloud"
COMMANDS_HELP=<<-EOT
** Synopsis
-----------
econe-upload
Uploads an image for use with an OpenNebula Cloud. This image should
be later register with econe-register using the returned ImageId
econe-upload
** Usage
--------
Uploads an image for use with an OpenNebula Cloud. This image should
be later register with econe-register using the returned ImageId
Usage:
econe-upload [OPTIONS] IMAGE-PATH
--help, -h:
Options:
--help, -h
Show help
--access-key <id>, -K <id>:
--access-key <id>, -K <id>
The username of the user
--secret-key <key>, -S <key>:
--secret-key <key>, -S <key>
The password of the user
--url <url>, -U <url>:
--url <url>, -U <url>
Set url as the web service url to use
--multipart, -M:
--multipart, -M
Use 'multipart-post' library instead of Curb/Curl
IMAGE-PATH: Path to the image to upload
IMAGE-PATH: Path to the image to upload
EOT

33
src/cloud/occi/bin/occi-compute
View File

@ -29,51 +29,48 @@ $: << RUBY_LIB_LOCATION
$: << RUBY_LIB_LOCATION+"/cloud"
COMMANDS_HELP=<<-EOT
** Synopsis
occi-compute
occi-compute - Manages compute resources
Manages compute resources
Usage:
occi-compute <COMMAND> [OPTIONS] [ARGUMENTS]
** Usage
occi-compute <COMMAND> [OPTIONS] [ARGUMENTS]
Commands:
COMMANDS
create <occi xml file>
* create <occi xml file>
creates a new compute resource described by the provided
<occi xml file>
list
* list
lists available compute resources
show <compute id>
* show <compute id>
retrieves the OCCI XML representation of the compute resource
identified by <compute id>
update <occi xml file>
* update <occi xml file>
updates the representation of the compute resource represented by the
provided <occi xml file>
delete <compute id>
* delete <compute id>
deletes the compute resource idenfitied by <compute id>
OPTIONS
Options:
--help, -h:
--help, -h
Show help
--username <id>, -U <id>:
--username <id>, -U <id>
The username of the user
--password <key>, -P <key>:
--password <key>, -P <key>
The password of the user
--url <url>, -R <url>:
--url <url>, -R <url>
Set url as the web service url to use
--timeout <seconds>, -T <seconds>
Sets a timeout for the http connection
Sets a timeout for the http connection
--debug, -D
Enables verbosity

23
src/cloud/occi/bin/occi-network
View File

@ -29,15 +29,12 @@ $: << RUBY_LIB_LOCATION
$: << RUBY_LIB_LOCATION+"/cloud"
COMMANDS_HELP=<<-EOT
** Synopsis
occi-network
occi-network - Manages virtual networks
Manages virtual networks
Usage:
occi-network <COMMAND> [OPTIONS] [ARGUMENTS]
** Usage
occi-network <COMMAND> [OPTIONS] [ARGUMENTS]
COMMANDS
Commands:
create <occi xml file>
creates a new virtual network described by the provided
@ -55,18 +52,18 @@ delete <network id>
OPTIONS
Options:
--help, -h:
--help, -h
Show help
--username <id>, -U <id>:
--username <id>, -U <id>
The username of the user
--password <key>, -P <key>:
--password <key>, -P <key>
The password of the user
--url <url>, -R <url>:
--url <url>, -R <url>
Set url as the web service url to use
--timeout <seconds>, -T <seconds>
@ -75,7 +72,7 @@ OPTIONS
--debug, -D
Enables verbosity
--multipart, -M:
--multipart, -M
Use 'multipart-post' library instead of Curb/Curl
EOT

24
src/cloud/occi/bin/occi-storage
View File

@ -29,15 +29,12 @@ $: << RUBY_LIB_LOCATION
$: << RUBY_LIB_LOCATION+"/cloud"
COMMANDS_HELP=<<-EOT
** Synopsis
occi-storage
occi-storage - Manages OCCI storage resource
Manages OCCI storage resource
Usage:
occi-storage <COMMAND> [OPTIONS] [PARAMETERS]
** Usage
occi-storage <COMMAND> [OPTIONS] [PARAMETERS]
COMMANDS
Commands:
create <occi xml file>
creates a new storage resource described by the provided
@ -54,17 +51,18 @@ delete <storage id>
deletes the storage resource idenfitied by <storage id>
OPTIONS
--help, -h:
Options:
--help, -h
Show help
--username <id>, -U <id>:
--username <id>, -U <id>
The username of the user
--password <key>, -P <key>:
--password <key>, -P <key>
The password of the user
--url <url>, -R <url>:
--url <url>, -R <url>
Set url as the web service url to use
--timeout <seconds>, -T <seconds>
@ -73,7 +71,7 @@ OPTIONS
--debug, -D
Enables verbosity
--multipart, -M:
--multipart, -M
Use 'multipart-post' library instead of Curb/Curl
EOT