[PATCH 3/3] Man pages update for BZ# 768509

Jason Guiditta jguiditt at redhat.com
Tue Dec 20 17:31:52 UTC 2011


aeolus-cli rename to aeolus

https://bugzilla.redhat.com/show_bug.cgi?id=768509
---
 man/aeolus-cli-build.1                             |   36 --------------------
 man/aeolus-cli.1                                   |   27 ---------------
 man/aeolus-image-build.1                           |   36 ++++++++++++++++++++
 man/{aeolus-cli-import.1 => aeolus-image-import.1} |   16 ++++----
 man/{aeolus-cli-list.1 => aeolus-image-list.1}     |   28 ++++++++--------
 man/{aeolus-cli-push.1 => aeolus-image-push.1}     |   18 +++++-----
 man/{aeolus-cli-status.1 => aeolus-image-status.1} |   14 ++++----
 man/aeolus.1                                       |   36 ++++++++++++++++++++
 8 files changed, 110 insertions(+), 101 deletions(-)
 delete mode 100644 man/aeolus-cli-build.1
 delete mode 100644 man/aeolus-cli.1
 create mode 100644 man/aeolus-image-build.1
 rename man/{aeolus-cli-import.1 => aeolus-image-import.1} (66%)
 rename man/{aeolus-cli-list.1 => aeolus-image-list.1} (72%)
 rename man/{aeolus-cli-push.1 => aeolus-image-push.1} (65%)
 rename man/{aeolus-cli-status.1 => aeolus-image-status.1} (53%)
 create mode 100644 man/aeolus.1

diff --git a/man/aeolus-cli-build.1 b/man/aeolus-cli-build.1
deleted file mode 100644
index faf0b74..0000000
--- a/man/aeolus-cli-build.1
+++ /dev/null
@@ -1,36 +0,0 @@
-.TH aeolus-cli 1  "July 07, 2011" "version 0.4" "USER COMMANDS"
-.SH NAME
-aeolus-cli build \- command for building aeolus images
-.SH SYNOPSIS
-.B aeolus-cli build [\-h|--help] [\-u|--username] [\-w|--password] [\-I|--image [image-id]] [\-e|--template [path-to-template]] [\-t|--targets [targets]] [\-d|--daemon]
-.SH DESCRIPTION
-aeolus-cli build command allows users to build new images based on a given TDL template file for a set of specified targets such e.g. EC2, RHEVM etc...  See list man list target-images for information on how to list the completed builds.
-.SH OPTIONS
-.TP
-\-u, --user <username>
-Conductor username
-.TP
-\-w, --password <password>
-Conductor password
-.TP
-\-T, --target
-Provide a list of targets for the build
-.TP
-\-e, --template
-Provide path to a TDL template file for building against
-.TP
-\-d, --daemon
-Run as a background process
-.TP
-Get usage information for this command and associated commmands
-\-h, --help
-.SH EXAMPLES
-.TP
-Build a new image for ec2 based on the specified template TDL file template.tdl
-.B aeolus-cli build
-\--targets ec2
-\--template ./template.tdl
-.TP
-Martyn Taylor (mtaylor at redhat.com), Jason Guiditta (jguiditta at redhat.com)
-.SH SEE ALSO
-aeolus-cli-list(1), aeolus-cli-push(1), aeolus-cli-import(1), aeolus-cli-status(1)
diff --git a/man/aeolus-cli.1 b/man/aeolus-cli.1
deleted file mode 100644
index d10017c..0000000
--- a/man/aeolus-cli.1
+++ /dev/null
@@ -1,27 +0,0 @@
-.TH aeolus-cli 1  "July 07, 2011" "version 0.4" "USER COMMANDS"
-.SH NAME
-aeolus-cli \- command line tool for managing aeolus images
-.SH SYNOPSIS
-.B aeolus-cli
-[\-h]
-.SH DESCRIPTION
-aeolus-cli is a tool that allows users to control their aeolus images through image builder and aeolus conductor. aeolus-cli offers five commands options; list, build, push, import, status. For more information on each command please run man aeolus-cli <command> or aeolus-cli --help
-.SH OPTIONS
-.TP
-\-h, --help
-Get usage information for this tool and subcommands
-.SH FILES
-.P
-aeolus-cli reads it's configuration from ~/.aeolus-cli
-.P
-.I ~/.aeolus-cli
-.RS
-There is URL with credentials to
-.B aeolus-conductor.
-If setup differs from default one, those should be changed accordingly. Conductor URL should be as follows
-.I https://<host_where_conductor_runs>/conductor/api
-.RE
-.SH AUTHOR
-Martyn Taylor (mtaylor at redhat.com), Jason Guiditta (jguiditta at redhat.com)
-.SH SEE ALSO
-aeolus-cli-build(1), aeolus-cli-push(1), aeolus-cli-list(1), aeolus-cli-import(1), aeolus-cli-status(1)
diff --git a/man/aeolus-image-build.1 b/man/aeolus-image-build.1
new file mode 100644
index 0000000..38cd210
--- /dev/null
+++ b/man/aeolus-image-build.1
@@ -0,0 +1,36 @@
+.TH aeolus-image 1  "December 19, 2011" "version 0.4" "USER COMMANDS"
+.SH NAME
+aeolus-image build \- command for building aeolus images
+.SH SYNOPSIS
+.B aeolus-image build [\-h|--help] [\-u|--username] [\-w|--password] [\-I|--image [image-id]] [\-e|--template [path-to-template]] [\-t|--targets [targets]] [\-d|--daemon]
+.SH DESCRIPTION
+aeolus-image build command allows users to build new images based on a given TDL template file for a set of specified targets such e.g. EC2, RHEVM etc...  See list man list target-images for information on how to list the completed builds.
+.SH OPTIONS
+.TP
+\-u, --user <username>
+Conductor username
+.TP
+\-w, --password <password>
+Conductor password
+.TP
+\-T, --target
+Provide a list of targets for the build
+.TP
+\-e, --template
+Provide path to a TDL template file for building against
+.TP
+\-d, --daemon
+Run as a background process
+.TP
+Get usage information for this command and associated commmands
+\-h, --help
+.SH EXAMPLES
+.TP
+Build a new image for ec2 based on the specified template TDL file template.tdl
+.B aeolus-image build
+\--targets ec2
+\--template ./template.tdl
+.TP
+Martyn Taylor (mtaylor at redhat.com), Jason Guiditta (jguiditta at redhat.com)
+.SH SEE ALSO
+aeolus-image-list(1), aeolus-image-push(1), aeolus-image-import(1), aeolus-image-status(1)
diff --git a/man/aeolus-cli-import.1 b/man/aeolus-image-import.1
similarity index 66%
rename from man/aeolus-cli-import.1
rename to man/aeolus-image-import.1
index 260d1a2..069f55d 100644
--- a/man/aeolus-cli-import.1
+++ b/man/aeolus-image-import.1
@@ -1,10 +1,10 @@
-.TH aeolus-cli 1  "July 07, 2011" "version 0.4" "USER COMMANDS"
+.TH aeolus-image 1  "December 19, 2011" "version 0.4" "USER COMMANDS"
 .SH NAME
-aeolus-cli import \- command for importing existing provider images into aeolus
+aeolus-image import \- command for importing existing provider images into aeolus
 .SH SYNOPSIS
-.B aeolus-cli import [\-h|--help] [\-u|--username] [\-w|--password] [\-a|--provider_account [account-name]] [\--id [provider-image-id]] [--description [path-to-file|xml string]] [\-d|--daemon]
+.B aeolus-image import [\-h|--help] [\-u|--username] [\-w|--password] [\-a|--provider_account [account-name]] [\--id [provider-image-id]] [--description [path-to-file|xml string]] [\-d|--daemon]
 .SH DESCRIPTION
-aeolus-cli import allows users to import pre-existing images that exist in cloud provders for example AMI from EC2, into aeolus.
+aeolus-image import allows users to import pre-existing images that exist in cloud provders for example AMI from EC2, into aeolus.
 .SH OPTIONS
 .TP
 \-u, --user <username>
@@ -30,22 +30,22 @@ Get usage information for this command and associated commmands
 .SH EXAMPLES
 .TP
 Import the AMI ami-1234567 from the provider account my-ec2 into aeolus
-.B aeolus-cli import
+.B aeolus-image import
 \--provider_account my-ec2
 \--id ami-1234567
 .TP
 Import the AMI ami-1234567 from the provider account my-ec2 into aeolus with a given xml description
-.B aeolus-cli import
+.B aeolus-image import
 \--provider_account my-ec2
 \--id ami-1234567
 \--description '<image><name>myAMI</name></image>'
 .TP
 Import the AMI ami-1234567 from the provider account my-ec2 into aeolus providing a path to the description XML file
-.B aeolus-cli import
+.B aeolus-image import
 \--provider_account my-ec2
 \--id ami-1234567
 \--description /foo/bar/description.xml
 .SH AUTHOR
 Martyn Taylor (mtaylor at redhat.com), Jason Guiditta (jguiditta at redhat.com)
 .SH SEE ALSO
-aeolus-cli-list(1), aeolus-cli-push(1), aeolus-cli-build(1)
+aeolus-image-list(1), aeolus-image-push(1), aeolus-image-build(1)
diff --git a/man/aeolus-cli-list.1 b/man/aeolus-image-list.1
similarity index 72%
rename from man/aeolus-cli-list.1
rename to man/aeolus-image-list.1
index 40c20ec..e53da95 100644
--- a/man/aeolus-cli-list.1
+++ b/man/aeolus-image-list.1
@@ -1,10 +1,10 @@
-.TH aeolus-cli 1  "July 07, 2011" "version 0.4" "USER COMMANDS"
+.TH aeolus-image 1  "December 19, 2011" "version 0.4" "USER COMMANDS"
 .SH NAME
-aeolus-cli \- command for listing aeolus image associated objects.
+aeolus-image \- command for listing aeolus image associated objects.
 .SH SYNOPSIS
-.B aeolus-cli list [\-h|--help] [\-u|--username] [\-w|--password] [\-i|--images] [\-b|--builds [image id]] [\-t|--targetimages [build id]] [\-P|--providerimages [target image id]] [\-g|--targets] [\-a|--accounts] [\-p|--providers]
+.B aeolus-image list [\-h|--help] [\-u|--username] [\-w|--password] [\-i|--images] [\-b|--builds [image id]] [\-t|--targetimages [build id]] [\-P|--providerimages [target image id]] [\-g|--targets] [\-a|--accounts] [\-p|--providers]
 .SH DESCRIPTION
-aeolus-cli list commands allows users to list information on the contents of particular objects in image warehouse including:
+aeolus-image list commands allows users to list information on the contents of particular objects in image warehouse including:
 .P
 images: high level image representation associated with underlying provider and target images
 .br
@@ -52,37 +52,37 @@ Run as a background process
 .SH EXAMPLES
 .TP
 List all images
-.B aeolus-cli list
+.B aeolus-image list
 \--images
 .TP
 List all builds for an image with id: 12345678-aaaa-1234--1234567890ab
-.B aeolus-cli list
+.B aeolus-image list
 \--builds 12345678-aaaa-1234--1234567890ab
 .TP
 List all target images for a given build with id: 12345678-bbbb-1234--1234567890ab
-.B aeolus-cli list
+.B aeolus-image list
 \--targetimages 12345678-bbbb-1234--1234567890ab
 .TP
 List all provider images for a given target image with id: 12345678-tttt-1234--1234567890ab
-.B aeolus-cli list
+.B aeolus-image list
 \--providerimages 12345678-tttt-1234--1234567890ab
 .TP
 List all provider images
-.B aeolus-cli list
+.B aeolus-image list
 \--providerimages all
 .TP
 List all available targets
-.B aeolus-cli list
+.B aeolus-image list
 \--targets
 .TP
 List all available providers
-.B aeolus-cli list
+.B aeolus-image list
 \--providers
 .TP
 List all available accounts
-.B aeolus-cli list
+.B aeolus-image list
 \--account
-.SH AUTHOR
+.SH AUTHORS
 Martyn Taylor (mtaylor at redhat.com), Jason Guiditta (jguiditta at redhat.com)
 .SH SEE ALSO
-aeolus-cli-build(1), aeolus-cli-push(1), aeolus-cli-import(1), aeolus-cli-delete(1), aeolus-cli-status(1)
+aeolus-image-build(1), aeolus-image-push(1), aeolus-image-import(1), aeolus-image-delete(1), aeolus-image-status(1)
diff --git a/man/aeolus-cli-push.1 b/man/aeolus-image-push.1
similarity index 65%
rename from man/aeolus-cli-push.1
rename to man/aeolus-image-push.1
index 3f86d40..1372c14 100644
--- a/man/aeolus-cli-push.1
+++ b/man/aeolus-image-push.1
@@ -1,10 +1,10 @@
-.TH aeolus-cli 1  "July 07, 2011" "version 0.4" "USER COMMANDS"
+.TH aeolus-image 1  "December 19, 2011" "version 0.4" "USER COMMANDS"
 .SH NAME
-aeolus-cli push \- command for pushing aeolus images to back end providers
+aeolus-image push \- command for pushing aeolus images to back end providers
 .SH SYNOPSIS
-.B aeolus-cli push [\-h|--help] [\-I|--image [image-id]] [\-B|--build [build-id]] [-m|--targetimage]] [-A|--account[account-name]]
+.B aeolus-image push [\-h|--help] [\-I|--image [image-id]] [\-B|--build [build-id]] [-m|--targetimage]] [-A|--account[account-name]]
 .SH DESCRIPTION
-aeolus-cli push allows users to push target images to particular backend providers.
+aeolus-image push allows users to push target images to particular backend providers.
 .SH OPTIONS
 .TP
 \-I|--image <id>
@@ -24,20 +24,20 @@ Get usage information for this command and associated commmands
 .SH EXAMPLES
 .TP
 Push target images associated with an image to each of specified accounts
-.B aeolus-cli push
+.B aeolus-image push
 \--image 12345678-bbbb-1234--1234567890ab
 \--account ec2-account,rhevm-account
 .TP
 Push target images associated with a build to each of the specified accounts
-.B aeolus-cli push
+.B aeolus-image push
 \--build 12345678-bbbb-1234--1234567890ab
 \--account ec2-account,rhevm-account
 .TP
 Push a target image to each of the specified accounts
-.B aeolus-cli push
+.B aeolus-image push
 \--targetimage 12345678-bbbb-1234--1234567890ab
 \--account ec2-account,ec2-account2
-.SH AUTHOR
+.SH AUTHORS
 Martyn Taylor (mtaylor at redhat.com), Jason Guiditta (jguiditta at redhat.com)
 .SH SEE ALSO
-aeolus-cli-list(1), aeolus-cli-build(1), aeolus-cli-import(1), aeolus-cli-status(1)
+aeolus-image-list(1), aeolus-image-build(1), aeolus-image-import(1), aeolus-image-status(1)
diff --git a/man/aeolus-cli-status.1 b/man/aeolus-image-status.1
similarity index 53%
rename from man/aeolus-cli-status.1
rename to man/aeolus-image-status.1
index e283071..804ff54 100644
--- a/man/aeolus-cli-status.1
+++ b/man/aeolus-image-status.1
@@ -1,10 +1,10 @@
-.TH aeolus-cli 1  "November 23, 2011" "version 0.1" "USER COMMANDS"
+.TH aeolus-image 1  "November 23, 2011" "version 0.1" "USER COMMANDS"
 .SH NAME
-aeolus-cli status \- command for querying build and push status
+aeolus-image status \- command for querying build and push status
 .SH SYNOPSIS
-.B aeolus-cli status [\-h|--help] [\-u|--username] [\-w|--password] [\-t|--targetimage [target-image-id]] [\-P|--providerimage [provider-image-id]]
+.B aeolus-image status [\-h|--help] [\-u|--username] [\-w|--password] [\-t|--targetimage [target-image-id]] [\-P|--providerimage [provider-image-id]]
 .SH DESCRIPTION
-aeolus-cli status command allows users to query for the status of builds and pushes.
+aeolus-image status command allows users to query for the status of builds and pushes.
 .SH OPTIONS
 .TP
 \-u, --user <username>
@@ -24,13 +24,13 @@ Get usage information for this command and associated commmands
 .SH EXAMPLES
 .TP
 Retrieve build status for target image A
-.B aeolus-cli status
+.B aeolus-image status
 \--targetimage A
 .TP
 Retrieve push status for provider image B
-.B aeolus-cli status
+.B aeolus-image status
 \--providerimage B
 .TP
 Martyn Taylor (mtaylor at redhat.com), Jason Guiditta (jguiditta at redhat.com)
 .SH SEE ALSO
-aeolus-cli-list(1), aeolus-cli-build(1), aeolus-cli-push(1), aeolus-cli-import(1)
+aeolus-image-list(1), aeolus-image-build(1), aeolus-image-push(1), aeolus-image-import(1)
diff --git a/man/aeolus.1 b/man/aeolus.1
new file mode 100644
index 0000000..d785a19
--- /dev/null
+++ b/man/aeolus.1
@@ -0,0 +1,36 @@
+.TH aeolus 1  "December 20, 2011" "version 0.4" "USER COMMANDS"
+.SH NAME
+aeolus \- command line tool for managing the aeolus suite of tools
+.SH SYNOPSIS
+.B aeolus
+image [list|build|push|import|status] [\-h]
+.SH DESCRIPTION
+aeolus is a tool that allows users to control their aeolus installation.  Each command can also be called directly via 'aeolus-{command}'.
+Currently implemented commands:
+  image - Manage images. aeolus-image offers five subcommands; list, build, push, import, status.
+
+For more information on each subcommand for a given command, you may run any of the following:
+    man aeolus-{command}-{subcommand}
+    aeolus {command} {subcommand} --help
+    aeolus-{command} {subcommand} --help
+    aeolus --help
+
+.SH OPTIONS
+.TP
+\-h, --help
+Get usage information for this tool and subcommands
+.SH FILES
+.P
+aeolus reads its configuration from ~/.aeolus-cli
+.P
+.I ~/.aeolus-cli
+.RS
+This contains the URL and credentials for you amdin user in
+.B aeolus-conductor.
+If setup differs from default one, those should be changed accordingly. Conductor URL should be as follows
+.I https://<host_where_conductor_runs>/conductor/api
+.RE
+.SH AUTHORS
+Martyn Taylor (mtaylor at redhat.com), Jason Guiditta (jguiditta at redhat.com)
+.SH SEE ALSO
+aeolus-image-build(1), aeolus-image-push(1), aeolus-image-list(1), aeolus-image-import(1), aeolus-image-status(1)
-- 
1.7.7.4




More information about the aeolus-devel mailing list