aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2013-04-11 15:23:13 +0300
committerSergey Poznyakoff <gray@gnu.org.ua>2013-04-11 15:23:13 +0300
commitdf64ed48764e5083eb6b1d02459b54112e6a1c8f (patch)
tree0f18355f71f8f577b372a60a7d8d477162cda92c /doc
parentd19bab14d9f3e8093ea8288c08f4df5249f2801c (diff)
downloadeclat-df64ed48764e5083eb6b1d02459b54112e6a1c8f.tar.gz
eclat-df64ed48764e5083eb6b1d02459b54112e6a1c8f.tar.bz2
Document create-image and deregister-image
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am2
-rw-r--r--doc/eclat-allocate-address.14
-rw-r--r--doc/eclat-associate-address.16
-rw-r--r--doc/eclat-attach-volume.14
-rw-r--r--doc/eclat-create-image.1108
-rw-r--r--doc/eclat-create-snapshot.14
-rw-r--r--doc/eclat-create-tags.14
-rw-r--r--doc/eclat-create-volume.14
-rw-r--r--doc/eclat-delete-snapshot.14
-rw-r--r--doc/eclat-delete-tags.14
-rw-r--r--doc/eclat-delete-volume.14
-rw-r--r--doc/eclat-deregister-image.165
-rw-r--r--doc/eclat-describe-addresses.14
-rw-r--r--doc/eclat-describe-availability-zones.14
-rw-r--r--doc/eclat-describe-instance-attribute.14
-rw-r--r--doc/eclat-describe-instance-status.14
-rw-r--r--doc/eclat-describe-instances.14
-rw-r--r--doc/eclat-describe-regions.14
-rw-r--r--doc/eclat-describe-security-groups.14
-rw-r--r--doc/eclat-describe-snapshots.14
-rw-r--r--doc/eclat-describe-tags.14
-rw-r--r--doc/eclat-describe-volumes.14
-rw-r--r--doc/eclat-detach-volume.14
-rw-r--r--doc/eclat-disassociate-address.14
-rw-r--r--doc/eclat-get-console-output.14
-rw-r--r--doc/eclat-modify-instance-attribute.14
-rw-r--r--doc/eclat-reboot-instances.14
-rw-r--r--doc/eclat-release-address.14
-rw-r--r--doc/eclat-start-instances.14
-rw-r--r--doc/eclat-stop-instances.16
-rw-r--r--doc/eclat-tmpl.12
31 files changed, 232 insertions, 57 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index bb788c1..0eadcbe 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -19,11 +19,13 @@ MANPAGES1=\
eclat-allocate-address.1\
eclat-associate-address.1\
eclat-attach-volume.1\
+ eclat-create-image.1\
eclat-create-snapshot.1\
eclat-create-tags.1\
eclat-create-volume.1\
eclat-delete-snapshot.1\
eclat-delete-tags.1\
+ eclat-deregister-image.1\
eclat-describe-addresses.1\
eclat-describe-availability-zones.1\
eclat-describe-instance-attribute.1\
diff --git a/doc/eclat-allocate-address.1 b/doc/eclat-allocate-address.1
index 65e2213..75f4241 100644
--- a/doc/eclat-allocate-address.1
+++ b/doc/eclat-allocate-address.1
@@ -17,9 +17,9 @@
.SH NAME
eclat allocate\-address \- allocate an Elastic IP address
.SH SYNOPSIS
-eclat allocate\-address [\fB\-v\fR] [\f\--vpc\fR]
+\fBeclat allocate\-address\fR [\fB\-v\fR] [\f\--vpc\fR]
-eclat allocate\-address \fB\-\-help\fR
+\fBeclat allocate\-address\fR \fB\-\-help\fR
.SH DESCRIPTION
The
.B allocate\-address
diff --git a/doc/eclat-associate-address.1 b/doc/eclat-associate-address.1
index 7fef4dd..cc45341 100644
--- a/doc/eclat-associate-address.1
+++ b/doc/eclat-associate-address.1
@@ -17,11 +17,11 @@
.SH NAME
eclat associate\-address \- associate an IP address with an instance
.SH SYNOPSIS
-eclat associate\-address [\fIOPTIONS\fR] \fIINSTANCE\fR \fIIP\fR
+\fBeclat associate\-address\fR [\fIOPTIONS\fR] \fIINSTANCE\fR \fIIP\fR
-eclat associate\-address [\fIOPTIONS\fR] \fIINSTANCE\fR \fIALLOC\-ID\fR
+\fBeclat associate\-address\fR [\fIOPTIONS\fR] \fIINSTANCE\fR \fIALLOC\-ID\fR
-eclat associate\-address \fB\-\-help\fR
+\fBeclat associate\-address\fR \fB\-\-help\fR
.SH DESCRIPTION
The
.B associate\-address
diff --git a/doc/eclat-attach-volume.1 b/doc/eclat-attach-volume.1
index 2349622..7566eca 100644
--- a/doc/eclat-attach-volume.1
+++ b/doc/eclat-attach-volume.1
@@ -17,9 +17,9 @@
.SH NAME
eclat attach\-volume \- attach a volume to an instance
.SH SYNOPSIS
-eclat attach\-volume \fBVOL\-ID\fR \fBINST\-ID\fR \fBDEV\-NAME\fR
+\fBeclat attach\-volume\fR \fBVOL\-ID\fR \fBINST\-ID\fR \fBDEV\-NAME\fR
-eclat attach\-volume \fB\-\-help\fR
+\fBeclat attach\-volume\fR \fB\-\-help\fR
.SH DESCRIPTION
The \fBattach\-volume\fR command attaches an existing volume to an EC2
instance. The
diff --git a/doc/eclat-create-image.1 b/doc/eclat-create-image.1
new file mode 100644
index 0000000..1889f9b
--- /dev/null
+++ b/doc/eclat-create-image.1
@@ -0,0 +1,108 @@
+.\" This file is part of Eclat -*- nroff -*-
+.\" Copyright (C) 2012, 2013 Sergey Poznyakoff
+.\"
+.\" Eclat is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 3, or (at your option)
+.\" any later version.
+.\"
+.\" Eclat is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with Eclat. If not, see <http://www.gnu.org/licenses/>.
+.TH CREATE\-IMAGE 1 "April 11, 2013" "ECLAT" "Eclat User Reference"
+.SH NAME
+eclat create\-image \- create an AMI image
+.SH SYNOPSIS
+\fBeclat create\-image\fR\
+ [\fB\-N\fR]\
+ [\fB\-d\fR \fIDESCR\fR]\
+ [\fB\-m\fR \fIDEV\fR=\fISPEC\fR]\
+ [\fB\-\-noreboot\fR]
+ [\fB\-\-no\-reboot\fR]\
+ [\fB\-\-description\fR=\fISTRING\fR]
+ [\fB\-\-devmap\fR=\fIDEV\fR=\fISPEC\fR]
+ [\fB\-\-block\-device\-mapping\fR=\fIDEV\fR=\fISPEC\fR]
+ \fBNAME\fR \fBINSTANCE\-ID\fR
+
+\fBeclat create\-image\fR \fB\-\-help\fR
+.SH DESCRIPTION
+This command creates an Amazon EBS-backed AMI from an existing
+instance \fBINSTANCE\-ID\fR. If the instance is running it will be
+rebooted, unless the \fB\-N\fR (\fB\-\-noreboot\fR) option is used.
+.PP
+The \fBNAME\fR argument sets the name of the new AMI.
+.PP
+Upon successful completion the ID of the newly created AMI is printed
+on the stdandard output.
+.SH OPTIONS
+.TP
+\fB\-N\fB, \fB\-\-noreboot\fR, \fB\-\-no\-reboot\fR
+Don't shut down the instance before creating the image.
+.TP
+\fB\-d\fR, \fB\-\-description\fR=\fISTRING\fR
+Set a description for the new image.
+.TP
+\fB\-m\fR, \fB\-\-devmap\fR, \fB\-\-block\-device\-mapping\fR=\fIDEV\fR=\fISPEC\fR
+Set block device mapping for the instances to be created from that
+AMI. The \fIDEV\fR part is the device name of the physical device on
+the instance to map. The \fISPEC\fR sets the mapping specification
+and can be one of:
+.RS 4
+.TP
+.B none
+Disable the existing mapping. E.g. \fB\-m /dev/xvdb=none\fR disables
+the mapping for the device \fB/dev/xvdb\fR.
+.TP
+.BR ephemeral [0-3]
+Map an instance store volume to the device. E.g. \fB\-m
+/dev/xvdb=ephemeral1\fR.
+.TP
+[\fIsnapshot\-id\fR]:\
+[\fIvolume\-size\fR]:\
+[\fIDOT\fR]:\
+[\fIstandard\fR|\fIio1\fR[:\fIiops\fR]]
+Specifies an EBS volume to be mapped to the device. The
+\fIsnapshot\-id\fR specifies the ID of the snapshot to create the
+volume from, \fIvolume\-size\fR gives the desired size of the volume
+in gigabytes. The \fIDOT\fR parameter (\fBdelete on termination\fR)
+specifies whether the device should be deleted after the instance is
+terminated. Possible values are \fBtrue\fR and \fBfalse\fR. The last
+parameter defines the volume type. The value \fBstandard\fR instructs
+Amazon to create a standard volume. This is the default. To create a
+provisioned IOPS volume, specify \fBio1\fR. In that case you can also
+supply the number of IOPS that the volume supports in the
+\fIiops\fR argument. For example, \fB\-m
+/dev/xvdf=snap-12345abc::false:io1:500\fR.
+.RE
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Display a short usage summary.
+.SH "SEE ALSO"
+.BR eclat (1),
+.BR eclat\-describe\-images (1),
+.BR eclat\-deregister\-image (1).
+.SH AUTHORS
+Sergey Poznyakoff
+.SH "BUG REPORTS"
+Report bugs to <bug\-eclat@gnu.org.ua>.
+.SH COPYRIGHT
+Copyright \(co 2012, 2013 Sergey Poznyakoff
+.br
+.na
+License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+.br
+.ad
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+.\" Local variables:
+.\" eval: (add-hook 'write-file-hooks 'time-stamp)
+.\" time-stamp-start: ".TH [A-Z_][A-Z0-9_.\\-]* [0-9] \""
+.\" time-stamp-format: "%:B %:d, %:y"
+.\" time-stamp-end: "\""
+.\" time-stamp-line-limit: 20
+.\" end:
+
diff --git a/doc/eclat-create-snapshot.1 b/doc/eclat-create-snapshot.1
index cf22130..f13d5f4 100644
--- a/doc/eclat-create-snapshot.1
+++ b/doc/eclat-create-snapshot.1
@@ -17,9 +17,9 @@
.SH NAME
eclat create\-snapshot \- creates a snapshot of an Amazon EBS volume
.SH SYNOPSIS
-eclat create\-snapshot \fIVOLUME\-ID\fR [\fIDESCR\fR]
+\fBeclat create\-snapshot\fR \fIVOLUME\-ID\fR [\fIDESCR\fR]
-eclat create\-snapshot \fB\-\-help\fR
+\fBeclat create\-snapshot\fR \fB\-\-help\fR
.SH DESCRIPTION
This command creates a snapshot of an Amazon EBS volume \fIVOLUME\-ID\fR
and stores it in Amazon S3. Any surplus arguments are taken as a
diff --git a/doc/eclat-create-tags.1 b/doc/eclat-create-tags.1
index 6480a17..7ed40f4 100644
--- a/doc/eclat-create-tags.1
+++ b/doc/eclat-create-tags.1
@@ -17,14 +17,14 @@
.SH NAME
eclat create\-tags \- create or replace tags for a resource
.SH SYNOPSIS
-eclat create\-tags [\fB\-a\fR \fIID\fR] [\fB\-i\fR \fIID\fR]\
+\fBeclat create\-tags\fR [\fB\-a\fR \fIID\fR] [\fB\-i\fR \fIID\fR]\
[\fB\-r\fR [\fIMAP\fR:]\fIID\fR] [\fB\-s \fIID\fR] [\fB\-v\fR \fIID\fR]
[\fB\-T\fR \fIFILE\fR]
[\fB\-\-ami\fR \fIID\fR] [\fB\-\-instance\fR \fIID\fR] [\fB\-\-resource\-id\fR [\fIMAP\fR:]\fIID\fR]
[\fB\-\-volume\fR \fIID\fR] [\fB\-\-snapshot\fR \fIID\fR]
[\fB\-\-from\-file\fR \fIFILE\fR] \fITAG\fR[=\fIVAL\fR]...
-eclat create\-tags \fB\-\-help\fR
+\fBeclat create\-tags\fR \fB\-\-help\fR
.SH DESCRIPTION
This command creates or replaces one or more tags for a given
resource. Tags are specified by their names. If a tag name is
diff --git a/doc/eclat-create-volume.1 b/doc/eclat-create-volume.1
index deebe13..7bd83e5 100644
--- a/doc/eclat-create-volume.1
+++ b/doc/eclat-create-volume.1
@@ -17,10 +17,10 @@
.SH NAME
eclat create\-volume \- create an Amazon EBS volume
.SH SYNOPSIS
-eclat create\-volume [\fB\-i\fR \fIN\fR] [\fB\-s\fR]\
+\fBeclat create\-volume\fR [\fB\-i\fR \fIN\fR] [\fB\-s\fR]\
[\fB\-\-iops\fR=\fIN\fR] [\fB\-\-snapshot\fR=\fIID\fR] \fBSIZE\fR \fBZONE\fR
-eclat create\-volume \fB\-\-help\fR
+\fBeclat create\-volume\fR \fB\-\-help\fR
.SH DESCRIPTION
This command creates a new Amazon EBS volume of size \fBSIZE\fR in the
availability zone \fBZONE\fR. The created volume can then be attached
diff --git a/doc/eclat-delete-snapshot.1 b/doc/eclat-delete-snapshot.1
index 5250a83..0dd1017 100644
--- a/doc/eclat-delete-snapshot.1
+++ b/doc/eclat-delete-snapshot.1
@@ -17,9 +17,9 @@
.SH NAME
eclat delete\-snapshot \- delete a snapshot of an Amazon EBS volume
.SH SYNOPSIS
-eclat delete\-snapshot \fISNAPSHOT\-ID\fR
+\fBeclat delete\-snapshot\fR \fISNAPSHOT\-ID\fR
-eclat delete\-snapshot \fB\-\-help\fR
+\fBeclat delete\-snapshot\fR \fB\-\-help\fR
.SH DESCRIPTION
This command deletes the snapshot of an Amazon EBS volume identified by
its resource ID. If ID translation is enabled (see the section \fBMAPS\fR
diff --git a/doc/eclat-delete-tags.1 b/doc/eclat-delete-tags.1
index 057d784..ba733eb 100644
--- a/doc/eclat-delete-tags.1
+++ b/doc/eclat-delete-tags.1
@@ -17,14 +17,14 @@
.SH NAME
eclat delete\-tags \- delete or replace tags for a resource
.SH SYNOPSIS
-eclat delete\-tags [\fB\-a\fR \fIID\fR] [\fB\-i\fR \fIID\fR]\
+\fBeclat delete\-tags\fR [\fB\-a\fR \fIID\fR] [\fB\-i\fR \fIID\fR]\
[\fB\-r\fR [\fIMAP\fR:]\fIID\fR] [\fB\-s \fIID\fR] [\fB\-v\fR \fIID\fR]
[\fB\-T\fR \fIFILE\fR]
[\fB\-\-ami\fR \fIID\fR] [\fB\-\-instance\fR \fIID\fR] [\fB\-\-resource\-id\fR [\fIMAP\fR:]\fIID\fR]
[\fB\-\-volume\fR \fIID\fR] [\fB\-\-snapshot\fR \fIID\fR]
[\fB\-\-from\-file\fR \fIFILE\fR] [\fITAG\fR[=\fIVAL\fR]...]
-eclat delete\-tags \fB\-\-help\fR
+\fBeclat delete\-tags\fR \fB\-\-help\fR
.SH DESCRIPTION
This command deletes tags from a given resource. The names of tags to
delete are supplied in the command line. If a tag name is followed by
diff --git a/doc/eclat-delete-volume.1 b/doc/eclat-delete-volume.1
index a56cf83..e709a4e 100644
--- a/doc/eclat-delete-volume.1
+++ b/doc/eclat-delete-volume.1
@@ -17,9 +17,9 @@
.SH NAME
eclat delete\-volume \- delete an EC2 volume
.SH SYNOPSIS
-eclat delete\-volume \fBVOL\-ID\fR
+\fBeclat delete\-volume\fR \fBVOL\-ID\fR
-eclat delete\-volume \fB\-\-help\fR
+\fBeclat delete\-volume\fR \fB\-\-help\fR
.SH DESCRIPTION
This command deletes an Amazon EBS volume. The volume must be in the
available state, i.e. it must not be attached to an instance.
diff --git a/doc/eclat-deregister-image.1 b/doc/eclat-deregister-image.1
new file mode 100644
index 0000000..95030d5
--- /dev/null
+++ b/doc/eclat-deregister-image.1
@@ -0,0 +1,65 @@
+.\" This file is part of Eclat -*- nroff -*-
+.\" Copyright (C) 2012, 2013 Sergey Poznyakoff
+.\"
+.\" Eclat is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 3, or (at your option)
+.\" any later version.
+.\"
+.\" Eclat is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with Eclat. If not, see <http://www.gnu.org/licenses/>.
+.TH DEREGISTER\-IMAGE 1 "April 11, 2013" "ECLAT" "Eclat User Reference"
+.SH NAME
+eclat deregister\-image \- deregister an EC2 image
+.SH SYNOPSIS
+\fBeclat deregister\-image\fR \fBID\fR
+
+\fBeclat deregister\-image\fR \fB\-\-help\fR
+.SH DESCRIPTION
+This command deregisters an existing Amazon image (AMI) identified by
+\fBID\fR.
+.PP
+If ID mapping is in use (see the section \fBMAPS\fR
+in
+.BR eclat (1)),
+the command treat the ID as a symbolic name and uses the \fBImageId\fR
+map to translate it.
+.PP
+Note that this command does not destroy other resources associated with the
+image, such as snapshots. Use the \fBeclat delete\-snapshot\fR
+command for that.
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Display a short usage summary.
+.SH "SEE ALSO"
+.BR eclat (1),
+.BR eclat\-delete\-snapshot (1),
+.BR eclat\-create\-image (1),
+.BR eclat\-describe\-images (1).
+.SH AUTHORS
+Sergey Poznyakoff
+.SH "BUG REPORTS"
+Report bugs to <bug\-eclat@gnu.org.ua>.
+.SH COPYRIGHT
+Copyright \(co 2012, 2013 Sergey Poznyakoff
+.br
+.na
+License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+.br
+.ad
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+.\" Local variables:
+.\" eval: (add-hook 'write-file-hooks 'time-stamp)
+.\" time-stamp-start: ".TH [A-Z_][A-Z0-9_.\\-]* [0-9] \""
+.\" time-stamp-format: "%:B %:d, %:y"
+.\" time-stamp-end: "\""
+.\" time-stamp-line-limit: 20
+.\" end:
+
diff --git a/doc/eclat-describe-addresses.1 b/doc/eclat-describe-addresses.1
index b77d717..bbfd4ca 100644
--- a/doc/eclat-describe-addresses.1
+++ b/doc/eclat-describe-addresses.1
@@ -18,9 +18,9 @@
eclat describe\-addresses \- return information about IP addresses in
your account
.SH SYNOPSIS
-eclat describe\-addresses [\fB\-v\fR] [\fB\-\-vpc\fR] [\fBFILTER\fR...]
+\fBeclat describe\-addresses\fR [\fB\-v\fR] [\fB\-\-vpc\fR] [\fBFILTER\fR...]
-eclat describe\-addresses \fB\-\-help\fR
+\fBeclat describe\-addresses\fR \fB\-\-help\fR
.SH DESCRIPTION
This command returns information about Elastic IP addresses allocated
for your account. By default all allocated addresses are described.
diff --git a/doc/eclat-describe-availability-zones.1 b/doc/eclat-describe-availability-zones.1
index 4741235..90626bc 100644
--- a/doc/eclat-describe-availability-zones.1
+++ b/doc/eclat-describe-availability-zones.1
@@ -17,9 +17,9 @@
.SH NAME
eclat describe\-availability\-zones \- describe availability zones
.SH SYNOPSIS
-eclat describe\-availability\-zones [\fBFILTER\fR...] [\fBZONE\fR...]
+\fBeclat describe\-availability\-zones\fR [\fBFILTER\fR...] [\fBZONE\fR...]
-eclat describe\-availability\-zones \fB\-\-help\fR
+\fBeclat describe\-availability\-zones\fR \fB\-\-help\fR
.SH DESCRIPTION
This command lists availability zones accessible to your account. The
results include zones only for the region you're currently using, as
diff --git a/doc/eclat-describe-instance-attribute.1 b/doc/eclat-describe-instance-attribute.1
index 3148135..d4ce503 100644
--- a/doc/eclat-describe-instance-attribute.1
+++ b/doc/eclat-describe-instance-attribute.1
@@ -17,9 +17,9 @@
.SH NAME
eclat describe\-instance\-attribute \- describes attribute of an instance
.SH SYNOPSIS
-eclat describe\-instance\-attribute \fIINSTANCE-ID\fR \fIATTR\fR
+\fBeclat describe\-instance\-attribute\fR \fIINSTANCE-ID\fR \fIATTR\fR
-eclat describe\-instance\-attribute \fB\-\-help\fR
+\fBeclat describe\-instance\-attribute\fR \fB\-\-help\fR
.SH DESCRIPTION
Describes the specified attribute of an instance. Only one attribute
can be described at a time.
diff --git a/doc/eclat-describe-instance-status.1 b/doc/eclat-describe-instance-status.1
index 282c709..f1a47bf 100644
--- a/doc/eclat-describe-instance-status.1
+++ b/doc/eclat-describe-instance-status.1
@@ -17,9 +17,9 @@
.SH NAME
eclat describe\-instance\-status \- describe status of EC2 instances
.SH SYNOPSIS
-eclat describe\-instance\-status [\fB\-a\fR] [\fB\-\-all\fR] [\fBFILTER\fR...]
+\fBeclat describe\-instance\-status\fR [\fB\-a\fR] [\fB\-\-all\fR] [\fBFILTER\fR...]
-eclat describe\-instance\-status \fB\-\-help\fR
+\fBeclat describe\-instance\-status\fR \fB\-\-help\fR
.SH DESCRIPTION
Describes the status of selected EC2 instances including any scheduled
events. This information includes:
diff --git a/doc/eclat-describe-instances.1 b/doc/eclat-describe-instances.1
index ea26851..e0126cc 100644
--- a/doc/eclat-describe-instances.1
+++ b/doc/eclat-describe-instances.1
@@ -17,9 +17,9 @@
.SH NAME
eclat describe\-instances \- describe available EC2 instances
.SH SYNOPSIS
-eclat describe\-instances [\fIFILTER\fR...]
+\fBeclat describe\-instances\fR [\fIFILTER\fR...]
-eclat describe\-instances \fB\-\-help\fR
+\fBeclat describe\-instances\fR \fB\-\-help\fR
.SH DESCRIPTION
This command lists your EC2 instances.
.SH FILTERS
diff --git a/doc/eclat-describe-regions.1 b/doc/eclat-describe-regions.1
index 545afd9..f0e5f65 100644
--- a/doc/eclat-describe-regions.1
+++ b/doc/eclat-describe-regions.1
@@ -17,9 +17,9 @@
.SH NAME
eclat describe\-regions \- describe EC2 regions
.SH SYNOPSIS
-eclat describe\-regions [\fBFILTER\fR...] [\fBREGION\fR...]
+\fBeclat describe\-regions\fR [\fBFILTER\fR...] [\fBREGION\fR...]
-eclat describe\-regions \fB\-\-help\fR
+\fBeclat describe\-regions\fR \fB\-\-help\fR
.SH DESCRIPTION
This command lists the EC2 regions. If no arguments are provided, it
lists all regions available to the account. Otherwise, each argument
diff --git a/doc/eclat-describe-security-groups.1 b/doc/eclat-describe-security-groups.1
index b92ce58..fa8e44b 100644
--- a/doc/eclat-describe-security-groups.1
+++ b/doc/eclat-describe-security-groups.1
@@ -17,10 +17,10 @@
.SH NAME
eclat describe\-security\-groups \- return information about security groups
.SH SYNOPSIS
-eclat describe\-security\-groups [\fB\-n\fR] [\fB\-\-name\fR]\
+\fBeclat describe\-security\-groups\fR [\fB\-n\fR] [\fB\-\-name\fR]\
[\fBFILTER\fR...] [\fBID\fR]
-eclat describe\-security\-groups \fB\-\-help\fR
+\fBeclat describe\-security\-groups\fR \fB\-\-help\fR
.SH DESCRIPTION
This command returns information about security groups. By default,
all security groups pertaining to your account will be described.
diff --git a/doc/eclat-describe-snapshots.1 b/doc/eclat-describe-snapshots.1
index 08f096d..223d59b 100644
--- a/doc/eclat-describe-snapshots.1
+++ b/doc/eclat-describe-snapshots.1
@@ -17,12 +17,12 @@
.SH NAME
eclat describe\-snapshots \- describes available Amazon EBS snapshots
.SH SYNOPSIS
-eclat describe\-snapshots [\fB\-r\fR \fIID\fR] [\fB\-u \fIID\fR]\
+\fBeclat describe\-snapshots\fR [\fB\-r\fR \fIID\fR] [\fB\-u \fIID\fR]\
[\fI\-\-restorable\-by \fIID\fR]
[\fB\-\-owner \fINAME\fR]\
[\fISNAPSHOT\-ID\fR...] [\fBFILTER\fI...]
-eclat describe\-snapshots \fB\-\-help\fR
+\fBeclat describe\-snapshots\fR \fB\-\-help\fR
.SH DESCRIPTION
This command lists the Amazon EBS snapshots available to you. These include
public snapshots available to any AWS account, your private snapshots and
diff --git a/doc/eclat-describe-tags.1 b/doc/eclat-describe-tags.1
index 8d43461..a63c90c 100644
--- a/doc/eclat-describe-tags.1
+++ b/doc/eclat-describe-tags.1
@@ -17,14 +17,14 @@
.SH NAME
eclat describe\-tags \- list the EC2 tags
.SH SYNOPSIS
-eclat describe\-tags [\fB\-a\fR \fIID\fR] [\fB\-i\fR \fIID\fR]\
+\fBeclat describe\-tags\fR [\fB\-a\fR \fIID\fR] [\fB\-i\fR \fIID\fR]\
[\fB\-r\fR [\fIMAP\fR:]\fIID\fR] [\fB\-s \fIID\fR] [\fB\-v\fR \fIID\fR]
[\fB\-T\fR \fIFILE\fR]
[\fB\-\-ami\fR \fIID\fR] [\fB\-\-instance\fR \fIID\fR] [\fB\-\-resource\-id\fR [\fIMAP\fR:]\fIID\fR]
[\fB\-\-volume\fR \fIID\fR] [\fB\-\-snapshot\fR \fIID\fR]
[\fBFILTER\fR...]
-eclat describe\-tags \fB\-\-help\fR
+\fBeclat describe\-tags\fR \fB\-\-help\fR
.SH DESCRIPTION
This command lists the EC2 tags. If no filter has been supplied, all
tags are listed.
diff --git a/doc/eclat-describe-volumes.1 b/doc/eclat-describe-volumes.1
index 9337d04..3407131 100644
--- a/doc/eclat-describe-volumes.1
+++ b/doc/eclat-describe-volumes.1
@@ -17,9 +17,9 @@
.SH NAME
eclat describe\-volumes \- list EBS volumes
.SH SYNOPSIS
-eclat describe\-volumes [\fBFILTER\fR...] [\fBID\fR...]
+\fBeclat describe\-volumes\fR [\fBFILTER\fR...] [\fBID\fR...]
-eclat describe\-volumes \fB\-\-help\fR
+\fBeclat describe\-volumes\fR \fB\-\-help\fR
.SH DESCRIPTION
This command displays the EBS volumes in your account. By default,
all volumes are shown. To select particular volumes, give their IDs
diff --git a/doc/eclat-detach-volume.1 b/doc/eclat-detach-volume.1
index 27b44a4..00b2246 100644
--- a/doc/eclat-detach-volume.1
+++ b/doc/eclat-detach-volume.1
@@ -17,10 +17,10 @@
.SH NAME
eclat detach\-volume \- detach a volume from an instance
.SH SYNOPSIS
-eclat detach\-volume [\fB\-f\fR] [\fB\-\-force\fR] \fBVOL\-ID\fR\
+\fBeclat detach\-volume\fR [\fB\-f\fR] [\fB\-\-force\fR] \fBVOL\-ID\fR\
[\fBINST\-ID\fR [\fBDEV\-NAME\fR]]
-eclat detach\-volume \fB\-\-help\fR
+\fBeclat detach\-volume\fR \fB\-\-help\fR
.SH DESCRIPTION
The \fBdetach\-volume\fR command detaches a volume from an EC2
instance. The volume is identified by the
diff --git a/doc/eclat-disassociate-address.1 b/doc/eclat-disassociate-address.1
index 738570f..81529f1 100644
--- a/doc/eclat-disassociate-address.1
+++ b/doc/eclat-disassociate-address.1
@@ -17,9 +17,9 @@
.SH NAME
eclat disassociate\-address \- disassociate IP address from EC2 instance.
.SH SYNOPSIS
-eclat disassociate\-address [\fB\-\-vpc\fR] [\fB\-v\fR] IP
+\fBeclat disassociate\-address\fR [\fB\-\-vpc\fR] [\fB\-v\fR] IP
-eclat disassociate\-address \fB\-\-help\fR
+\fBeclat disassociate\-address\fR \fB\-\-help\fR
.SH DESCRIPTION
This command disassociates IP address from the EC2 instance.
.SH OPTIONS
diff --git a/doc/eclat-get-console-output.1 b/doc/eclat-get-console-output.1
index e0e75be..bb30637 100644
--- a/doc/eclat-get-console-output.1
+++ b/doc/eclat-get-console-output.1
@@ -17,9 +17,9 @@
.SH NAME
eclat get\-console\-output \- get console output from the instance
.SH SYNOPSIS
-eclat get\-console\-output \fIINSTANCE\-ID\fR
+\fBeclat get\-console\-output\fR \fIINSTANCE\-ID\fR
-eclat get\-console\-output \fB\-\-help\fR
+\fBeclat get\-console\-output\fR \fB\-\-help\fR
.SH DESCRIPTION
The command
.B get\-console\-output
diff --git a/doc/eclat-modify-instance-attribute.1 b/doc/eclat-modify-instance-attribute.1
index 1a259c8..b0e8261 100644
--- a/doc/eclat-modify-instance-attribute.1
+++ b/doc/eclat-modify-instance-attribute.1
@@ -17,10 +17,10 @@
.SH NAME
eclat modify\-instance\-attribute \- modifies attribute of an instance
.SH SYNOPSIS
-eclat modify\-instance\-attribute \fIINSTANCE-ID\fR \fIATTR\fR\
+\fBeclat modify\-instance\-attribute\fR \fIINSTANCE-ID\fR \fIATTR\fR\
\fIVALUE\fR [\fIVALUE\fR...]
-eclat modify\-instance\-attribute \fB\-\-help\fR
+\fBeclat modify\-instance\-attribute\fR \fB\-\-help\fR
.SH DESCRIPTION
Modifies the specified attribute of an instance. Only one attribute
can be modified at a time.
diff --git a/doc/eclat-reboot-instances.1 b/doc/eclat-reboot-instances.1
index fb904da..faa6908 100644
--- a/doc/eclat-reboot-instances.1
+++ b/doc/eclat-reboot-instances.1
@@ -17,9 +17,9 @@
.SH NAME
eclat reboot\-instances \- reboot EC2 instances
.SH SYNOPSIS
-eclat reboot\-instances \fIID\fR [\fIID\fR...]
+\fBeclat reboot\-instances\fR \fIID\fR [\fIID\fR...]
-eclat reboot\-instances \fB\-\-help\fR
+\fBeclat reboot\-instances\fR \fB\-\-help\fR
.SH DESCRIPTION
The command
.B reboot\-instances
diff --git a/doc/eclat-release-address.1 b/doc/eclat-release-address.1
index dc5a7f0..f1b0224 100644
--- a/doc/eclat-release-address.1
+++ b/doc/eclat-release-address.1
@@ -17,9 +17,9 @@
.SH NAME
eclat release\-address \- release Elastic IP address.
.SH SYNOPSIS
-eclat release\-address [\fB\-\-vpc\fR] [\fB\-v\fR] IP\-OR\-ALLOCID
+\fBeclat release\-address\fR [\fB\-\-vpc\fR] [\fB\-v\fR] \fIIP\-OR\-ALLOCID\fR
-eclat release\-address \fB\-\-help\fR
+\fBeclat release\-address\fR \fB\-\-help\fR
.SH DESCRIPTION
This command releases an Elastic IP address. The address must have been
previously allocated using the
diff --git a/doc/eclat-start-instances.1 b/doc/eclat-start-instances.1
index 3fbfbf7..87a28e8 100644
--- a/doc/eclat-start-instances.1
+++ b/doc/eclat-start-instances.1
@@ -17,9 +17,9 @@
.SH NAME
eclat start\-instances \- start EC2 instances
.SH SYNOPSIS
-eclat start\-instances \fIID\fR [\fIID\fR...]
+\fBeclat start\-instances\fR \fIID\fR [\fIID\fR...]
-eclat start\-instances \fB\-\-help\fR
+\fBeclat start\-instances\fR \fB\-\-help\fR
.SH DESCRIPTION
The command
.B start\-instances
diff --git a/doc/eclat-stop-instances.1 b/doc/eclat-stop-instances.1
index ad3309c..dc4a5d1 100644
--- a/doc/eclat-stop-instances.1
+++ b/doc/eclat-stop-instances.1
@@ -16,10 +16,10 @@
.TH STOP\-INSTANCES 1 "January 19, 2013" "ECLAT" "Eclat User Reference"
.SH NAME
eclat stop\-instances \- stop EC2 instances
-
-eclat stop\-instances \fB\-\-help\fR
.SH SYNOPSIS
-eclat stop\-instances \fIID\fR [\fIID\fR...]
+\fBeclat stop\-instances\fR \fIID\fR [\fIID\fR...]
+
+\fBeclat stop\-instances\fR \fB\-\-help\fR
.SH DESCRIPTION
The command
.B stop\-instances
diff --git a/doc/eclat-tmpl.1 b/doc/eclat-tmpl.1
index 356c0bc..53b8309 100644
--- a/doc/eclat-tmpl.1
+++ b/doc/eclat-tmpl.1
@@ -18,7 +18,7 @@
eclat command \-
.SH SYNOPSIS
-eclat command \fB\-\-help\fR
+\fBeclat command\fB \fB\-\-help\fR
.SH DESCRIPTION
.SH OPTIONS
.SH FILTERS

Return to:

Send suggestions and report system problems to the System administrator.