From 67dce06bb26798e2b11ee0883bdc7e08d7edb663 Mon Sep 17 00:00:00 2001 From: Sergey Poznyakoff Date: Sat, 20 Apr 2013 10:39:19 +0300 Subject: Major rewrite. Provide short names for each command. --- doc/Makefile.am | 58 ++--- doc/eclat-allocaddr.1 | 62 ++++++ doc/eclat-allocate-address.1 | 62 ------ doc/eclat-assocaddr.1 | 98 +++++++++ doc/eclat-associate-address.1 | 98 --------- doc/eclat-attach-volume.1 | 72 ------- doc/eclat-atvol.1 | 72 +++++++ doc/eclat-conmesg.1 | 50 +++++ doc/eclat-create-image.1 | 108 ---------- doc/eclat-create-snapshot.1 | 76 ------- doc/eclat-create-tags.1 | 145 ------------- doc/eclat-create-volume.1 | 71 ------- doc/eclat-deimg.1 | 65 ++++++ doc/eclat-delete-snapshot.1 | 57 ----- doc/eclat-delete-tags.1 | 116 ---------- doc/eclat-delete-volume.1 | 59 ------ doc/eclat-deregister-image.1 | 65 ------ doc/eclat-describe-addresses.1 | 101 --------- doc/eclat-describe-availability-zones.1 | 91 -------- doc/eclat-describe-images.1 | 206 ------------------ doc/eclat-describe-instance-attribute.1 | 71 ------- doc/eclat-describe-instance-status.1 | 182 ---------------- doc/eclat-describe-instances.1 | 362 -------------------------------- doc/eclat-describe-regions.1 | 77 ------- doc/eclat-describe-security-groups.1 | 134 ------------ doc/eclat-describe-snapshot-attribute.1 | 66 ------ doc/eclat-describe-snapshots.1 | 164 --------------- doc/eclat-describe-tags.1 | 131 ------------ doc/eclat-describe-volumes.1 | 149 ------------- doc/eclat-detach-volume.1 | 73 ------- doc/eclat-devol.1 | 73 +++++++ doc/eclat-disasaddr.1 | 75 +++++++ doc/eclat-disassociate-address.1 | 75 ------- doc/eclat-freeaddr.1 | 89 ++++++++ doc/eclat-get-console-output.1 | 50 ----- doc/eclat-lsaddr.1 | 101 +++++++++ doc/eclat-lsiattr.1 | 71 +++++++ doc/eclat-lsimg.1 | 206 ++++++++++++++++++ doc/eclat-lsinst.1 | 362 ++++++++++++++++++++++++++++++++ doc/eclat-lsistat.1 | 182 ++++++++++++++++ doc/eclat-lsreg.1 | 77 +++++++ doc/eclat-lssattr.1 | 66 ++++++ doc/eclat-lssg.1 | 134 ++++++++++++ doc/eclat-lssnap.1 | 164 +++++++++++++++ doc/eclat-lstag.1 | 131 ++++++++++++ doc/eclat-lsvol.1 | 149 +++++++++++++ doc/eclat-mkimg.1 | 108 ++++++++++ doc/eclat-mksnap.1 | 76 +++++++ doc/eclat-mktag.1 | 145 +++++++++++++ doc/eclat-mkvol.1 | 71 +++++++ doc/eclat-modify-instance-attribute.1 | 106 ---------- doc/eclat-reboot-instances.1 | 55 ----- doc/eclat-reboot.1 | 55 +++++ doc/eclat-release-address.1 | 89 -------- doc/eclat-rmsnap.1 | 57 +++++ doc/eclat-rmtag.1 | 116 ++++++++++ doc/eclat-rmvol.1 | 59 ++++++ doc/eclat-setiattr.1 | 106 ++++++++++ doc/eclat-start-instances.1 | 55 ----- doc/eclat-start.1 | 55 +++++ doc/eclat-stop-instances.1 | 55 ----- doc/eclat-stop.1 | 55 +++++ doc/eclat.1 | 164 +++++++++------ doc/eclat.conf.5 | 12 +- doc/lszon.1 | 91 ++++++++ src/Makefile.am | 76 +++---- src/attvol.c | 43 ---- src/atvol.c | 43 ++++ src/cmdline.opt | 7 + src/creimg-cl.opt | 52 ----- src/creimg.c | 49 ----- src/cresnap.c | 58 ----- src/cretags-cl.opt | 97 --------- src/cretags.c | 127 ----------- src/crevol-cl.opt | 45 ---- src/crevol.c | 47 ----- src/deimg.c | 38 ++++ src/delsnap.c | 38 ---- src/delvol.c | 39 ---- src/detvol.c | 46 ---- src/devol.c | 46 ++++ src/disasaddr-cl.opt | 36 ++++ src/disasaddr.c | 37 ++++ src/disassaddr-cl.opt | 36 ---- src/disassaddr.c | 37 ---- src/drgimg.c | 38 ---- src/dscraddrs-cl.opt | 52 ----- src/dscraddrs.c | 33 --- src/dscrazs.c | 54 ----- src/dscrimgs-cl.opt | 104 --------- src/dscrimgs.c | 34 --- src/dscrinstattr.c | 59 ------ src/dscrinsts.c | 151 ------------- src/dscrinststat-cl.opt | 107 ---------- src/dscrinststat.c | 36 ---- src/dscrregs.c | 48 ----- src/dscrsecgrps-cl.opt | 59 ------ src/dscrsecgrps.c | 35 --- src/dscrsnap-cl.opt | 61 ------ src/dscrsnap.c | 73 ------- src/dscrsnapattr.c | 171 --------------- src/dscrtags-cl.opt | 121 ----------- src/dscrtags.c | 50 ----- src/dscrvols.c | 63 ------ src/eclat.c | 235 +++++++++++++++------ src/eclat.h | 12 ++ src/freeaddr-cl.opt | 37 ++++ src/freeaddr.c | 37 ++++ src/lsaddr-cl.opt | 52 +++++ src/lsaddr.c | 33 +++ src/lsiattr.c | 59 ++++++ src/lsimg-cl.opt | 104 +++++++++ src/lsimg.c | 34 +++ src/lsinst.c | 151 +++++++++++++ src/lsistat-cl.opt | 107 ++++++++++ src/lsistat.c | 36 ++++ src/lsreg.c | 48 +++++ src/lssattr.c | 171 +++++++++++++++ src/lssg-cl.opt | 59 ++++++ src/lssg.c | 35 +++ src/lssnap-cl.opt | 61 ++++++ src/lssnap.c | 73 +++++++ src/lstag-cl.opt | 121 +++++++++++ src/lstag.c | 50 +++++ src/lsvol.c | 63 ++++++ src/lszon.c | 54 +++++ src/mkimg-cl.opt | 52 +++++ src/mkimg.c | 49 +++++ src/mkinst-cl.opt | 231 ++++++++++++++++++++ src/mkinst.c | 245 +++++++++++++++++++++ src/mksnap.c | 58 +++++ src/mktags-cl.opt | 97 +++++++++ src/mktags.c | 127 +++++++++++ src/mkvol-cl.opt | 45 ++++ src/mkvol.c | 47 +++++ src/modinstattr.c | 137 ------------ src/reladdr-cl.opt | 37 ---- src/reladdr.c | 37 ---- src/rmsnap.c | 38 ++++ src/rmvol.c | 39 ++++ src/runinsts-cl.opt | 231 -------------------- src/runinsts.c | 245 --------------------- src/setiattr.c | 137 ++++++++++++ src/startinst.c | 87 -------- 144 files changed, 6329 insertions(+), 6264 deletions(-) create mode 100644 doc/eclat-allocaddr.1 delete mode 100644 doc/eclat-allocate-address.1 create mode 100644 doc/eclat-assocaddr.1 delete mode 100644 doc/eclat-associate-address.1 delete mode 100644 doc/eclat-attach-volume.1 create mode 100644 doc/eclat-atvol.1 create mode 100644 doc/eclat-conmesg.1 delete mode 100644 doc/eclat-create-image.1 delete mode 100644 doc/eclat-create-snapshot.1 delete mode 100644 doc/eclat-create-tags.1 delete mode 100644 doc/eclat-create-volume.1 create mode 100644 doc/eclat-deimg.1 delete mode 100644 doc/eclat-delete-snapshot.1 delete mode 100644 doc/eclat-delete-tags.1 delete mode 100644 doc/eclat-delete-volume.1 delete mode 100644 doc/eclat-deregister-image.1 delete mode 100644 doc/eclat-describe-addresses.1 delete mode 100644 doc/eclat-describe-availability-zones.1 delete mode 100644 doc/eclat-describe-images.1 delete mode 100644 doc/eclat-describe-instance-attribute.1 delete mode 100644 doc/eclat-describe-instance-status.1 delete mode 100644 doc/eclat-describe-instances.1 delete mode 100644 doc/eclat-describe-regions.1 delete mode 100644 doc/eclat-describe-security-groups.1 delete mode 100644 doc/eclat-describe-snapshot-attribute.1 delete mode 100644 doc/eclat-describe-snapshots.1 delete mode 100644 doc/eclat-describe-tags.1 delete mode 100644 doc/eclat-describe-volumes.1 delete mode 100644 doc/eclat-detach-volume.1 create mode 100644 doc/eclat-devol.1 create mode 100644 doc/eclat-disasaddr.1 delete mode 100644 doc/eclat-disassociate-address.1 create mode 100644 doc/eclat-freeaddr.1 delete mode 100644 doc/eclat-get-console-output.1 create mode 100644 doc/eclat-lsaddr.1 create mode 100644 doc/eclat-lsiattr.1 create mode 100644 doc/eclat-lsimg.1 create mode 100644 doc/eclat-lsinst.1 create mode 100644 doc/eclat-lsistat.1 create mode 100644 doc/eclat-lsreg.1 create mode 100644 doc/eclat-lssattr.1 create mode 100644 doc/eclat-lssg.1 create mode 100644 doc/eclat-lssnap.1 create mode 100644 doc/eclat-lstag.1 create mode 100644 doc/eclat-lsvol.1 create mode 100644 doc/eclat-mkimg.1 create mode 100644 doc/eclat-mksnap.1 create mode 100644 doc/eclat-mktag.1 create mode 100644 doc/eclat-mkvol.1 delete mode 100644 doc/eclat-modify-instance-attribute.1 delete mode 100644 doc/eclat-reboot-instances.1 create mode 100644 doc/eclat-reboot.1 delete mode 100644 doc/eclat-release-address.1 create mode 100644 doc/eclat-rmsnap.1 create mode 100644 doc/eclat-rmtag.1 create mode 100644 doc/eclat-rmvol.1 create mode 100644 doc/eclat-setiattr.1 delete mode 100644 doc/eclat-start-instances.1 create mode 100644 doc/eclat-start.1 delete mode 100644 doc/eclat-stop-instances.1 create mode 100644 doc/eclat-stop.1 create mode 100644 doc/lszon.1 delete mode 100644 src/attvol.c create mode 100644 src/atvol.c delete mode 100644 src/creimg-cl.opt delete mode 100644 src/creimg.c delete mode 100644 src/cresnap.c delete mode 100644 src/cretags-cl.opt delete mode 100644 src/cretags.c delete mode 100644 src/crevol-cl.opt delete mode 100644 src/crevol.c create mode 100644 src/deimg.c delete mode 100644 src/delsnap.c delete mode 100644 src/delvol.c delete mode 100644 src/detvol.c create mode 100644 src/devol.c create mode 100644 src/disasaddr-cl.opt create mode 100644 src/disasaddr.c delete mode 100644 src/disassaddr-cl.opt delete mode 100644 src/disassaddr.c delete mode 100644 src/drgimg.c delete mode 100644 src/dscraddrs-cl.opt delete mode 100644 src/dscraddrs.c delete mode 100644 src/dscrazs.c delete mode 100644 src/dscrimgs-cl.opt delete mode 100644 src/dscrimgs.c delete mode 100644 src/dscrinstattr.c delete mode 100644 src/dscrinsts.c delete mode 100644 src/dscrinststat-cl.opt delete mode 100644 src/dscrinststat.c delete mode 100644 src/dscrregs.c delete mode 100644 src/dscrsecgrps-cl.opt delete mode 100644 src/dscrsecgrps.c delete mode 100644 src/dscrsnap-cl.opt delete mode 100644 src/dscrsnap.c delete mode 100644 src/dscrsnapattr.c delete mode 100644 src/dscrtags-cl.opt delete mode 100644 src/dscrtags.c delete mode 100644 src/dscrvols.c create mode 100644 src/freeaddr-cl.opt create mode 100644 src/freeaddr.c create mode 100644 src/lsaddr-cl.opt create mode 100644 src/lsaddr.c create mode 100644 src/lsiattr.c create mode 100644 src/lsimg-cl.opt create mode 100644 src/lsimg.c create mode 100644 src/lsinst.c create mode 100644 src/lsistat-cl.opt create mode 100644 src/lsistat.c create mode 100644 src/lsreg.c create mode 100644 src/lssattr.c create mode 100644 src/lssg-cl.opt create mode 100644 src/lssg.c create mode 100644 src/lssnap-cl.opt create mode 100644 src/lssnap.c create mode 100644 src/lstag-cl.opt create mode 100644 src/lstag.c create mode 100644 src/lsvol.c create mode 100644 src/lszon.c create mode 100644 src/mkimg-cl.opt create mode 100644 src/mkimg.c create mode 100644 src/mkinst-cl.opt create mode 100644 src/mkinst.c create mode 100644 src/mksnap.c create mode 100644 src/mktags-cl.opt create mode 100644 src/mktags.c create mode 100644 src/mkvol-cl.opt create mode 100644 src/mkvol.c delete mode 100644 src/modinstattr.c delete mode 100644 src/reladdr-cl.opt delete mode 100644 src/reladdr.c create mode 100644 src/rmsnap.c create mode 100644 src/rmvol.c delete mode 100644 src/runinsts-cl.opt delete mode 100644 src/runinsts.c create mode 100644 src/setiattr.c delete mode 100644 src/startinst.c diff --git a/doc/Makefile.am b/doc/Makefile.am index a736b48..523cac1 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -16,36 +16,36 @@ MANPAGES1=\ eclat.1\ - 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-allocaddr.1\ + eclat-assocaddr.1\ + eclat-atvol.1\ + eclat-mkimg.1\ + eclat-mksnap.1\ + eclat-mktag.1\ + eclat-mkvol.1\ + eclat-rmsnap.1\ + eclat-rmtag.1\ + eclat-deimg.1\ + eclat-lsaddr.1\ eclat-describe-availability-zones.1\ - eclat-describe-images.1\ - eclat-describe-instance-attribute.1\ - eclat-describe-instance-status.1\ - eclat-describe-instances.1\ - eclat-describe-regions.1\ - eclat-describe-security-groups.1\ - eclat-describe-snapshot-attribute.1\ - eclat-describe-snapshots.1\ - eclat-describe-tags.1\ - eclat-describe-volumes.1\ - eclat-detach-volume.1\ - eclat-disassociate-address.1\ - eclat-modify-instance-attribute.1\ - eclat-get-console-output.1\ - eclat-start-instances.1\ - eclat-stop-instances.1\ - eclat-reboot-instances.1\ - eclat-release-address.1 + eclat-lsimg.1\ + eclat-lsiattr.1\ + eclat-lsistat.1\ + eclat-lsinst.1\ + eclat-lsreg.1\ + eclat-lssg.1\ + eclat-lssattr.1\ + eclat-lssnap.1\ + eclat-lstag.1\ + eclat-lsvol.1\ + eclat-devol.1\ + eclat-disasaddr.1\ + eclat-setiattr.1\ + eclat-conmesg.1\ + eclat-start.1\ + eclat-stop.1\ + eclat-reboot.1\ + eclat-freeaddr.1 MANPAGES5=\ eclat.conf.5 diff --git a/doc/eclat-allocaddr.1 b/doc/eclat-allocaddr.1 new file mode 100644 index 0000000..2c97280 --- /dev/null +++ b/doc/eclat-allocaddr.1 @@ -0,0 +1,62 @@ +.\" 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 . +.TH ALLOCADDR 1 "January 19, 2013" "ECLAT" "Eclat User Reference" +.SH NAME +eclat allocaddr \- allocate an Elastic IP address +.SH SYNOPSIS +\fBeclat allocaddr\fR [\fB\-v\fR] [\f\--vpc\fR] + +\fBeclat allocaddr\fR \fB\-\-help\fR +.SH DESCRIPTION +The +.B allocaddr +command allocates an Elastic IP address. It does not take arguments. +.PP +.SH OPTIONS +.TP +\fB\-v\fR, \fB\-\-vpc\fR +Allocate address for use with instances in a VPC. +.SH "OUTPUT AND RETURN VALUE" +The default output format displays the allocated IP address on +success. +.PP +On success, the code 0 is returned to the shell. Non-zero status code +is returned on error. +.SH "SEE ALSO" +.BR eclat (1), +.BR eclat\-assocaddr (1), +.BR eclat\-freeaddr (1). +.SH AUTHORS +Sergey Poznyakoff +.SH "BUG REPORTS" +Report bugs to . +.SH COPYRIGHT +Copyright \(co 2012, 2013 Sergey Poznyakoff +.br +.na +License GPLv3+: GNU GPL version 3 or later +.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-allocate-address.1 b/doc/eclat-allocate-address.1 deleted file mode 100644 index 75f4241..0000000 --- a/doc/eclat-allocate-address.1 +++ /dev/null @@ -1,62 +0,0 @@ -.\" 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 . -.TH ALLOCATE\-ADDRESS 1 "January 19, 2013" "ECLAT" "Eclat User Reference" -.SH NAME -eclat allocate\-address \- allocate an Elastic IP address -.SH SYNOPSIS -\fBeclat allocate\-address\fR [\fB\-v\fR] [\f\--vpc\fR] - -\fBeclat allocate\-address\fR \fB\-\-help\fR -.SH DESCRIPTION -The -.B allocate\-address -command allocates an Elastic IP address. It does not take arguments. -.PP -.SH OPTIONS -.TP -\fB\-v\fR, \fB\-\-vpc\fR -Allocate address for use with instances in a VPC. -.SH "OUTPUT AND RETURN VALUE" -The default output format displays the allocated IP address on -success. -.PP -On success, the code 0 is returned to the shell. Non-zero status code -is returned on error. -.SH "SEE ALSO" -.BR eclat (1), -.BR eclat\-associate\-address (1), -.BR eclat\-release\-address (1). -.SH AUTHORS -Sergey Poznyakoff -.SH "BUG REPORTS" -Report bugs to . -.SH COPYRIGHT -Copyright \(co 2012, 2013 Sergey Poznyakoff -.br -.na -License GPLv3+: GNU GPL version 3 or later -.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-assocaddr.1 b/doc/eclat-assocaddr.1 new file mode 100644 index 0000000..5c84232 --- /dev/null +++ b/doc/eclat-assocaddr.1 @@ -0,0 +1,98 @@ +.\" 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 . +.TH ASSOCADDR 1 "January 19, 2013" "ECLAT" "Eclat User Reference" +.SH NAME +eclat assocaddr \- associate an IP address with an instance +.SH SYNOPSIS +\fBeclat assocaddr\fR [\fIOPTIONS\fR] \fIINSTANCE\fR \fIIP\fR + +\fBeclat assocaddr\fR [\fIOPTIONS\fR] \fIINSTANCE\fR \fIALLOC\-ID\fR + +\fBeclat assocaddr\fR \fB\-\-help\fR +.SH DESCRIPTION +The +.B assocaddr +command associates an Elastic IP address with an non-VPC instance or +associates a VPC Elastic IP address with an instance in your VPC. +.PP +The first argument is always the ID of the instance to operate upon. +The meaning of the second argument depends on the \fB\-\-vpc\fR command +line option. If that option is given, the second argument supplies the +allocation ID that AWS returned when you allocated the Elastic IP +address for use with Amazon VPC. Otherwise, it is the Elastic IP to +assign to the non-VPC instance. +.SH OPTIONS +.TP +\fB\-A\fR, \fB\-\-allow\-reassociation\fR +Allows an already associated address to be re-associated with the +specified instance (VPC only). +.TP +\fB\-i\fR, \fB\-\-interface\fR=\fIIFACE\fR +A network interface ID to associate with the instance (vpc only). +.TP +\fB\-p\fR, \fB\-\-private\-address\fR=\fIADDRESS\fR +Private IP address to associate with the Elastic IP address (vpc +only). +.TP +\fB\-v\fR, \fB\-\-vpc\fR +Assign VPC addresses. +.SH "OUTPUT AND RETURN VALUE" +The default output format does not display anything if the operation +succeeds. Otherwise it prints on the standard error the diagnostic +message returned by the Amazon, and returns code 1 to the shell. +.PP +The code 2 is returned if +.B eclat +is unable to recognize the response. +.SH EXAMPLES +.SS 1. +Assign an Elastic IP to the instance: +.P +.nf +.B eclat assocaddr i\-2ea64347 192.0.2.1 +.fi +.SS 2. +Associate an IP address with an instance in the VPC: +.P +.nf +.B eclat assocaddr \-\-vpc i\-4fd2431a eipalloc\-5723d13e +.fi +.SH "SEE ALSO" +.BR eclat (1), +.BR eclat\-allocaddr (1), +.BR eclat\-freeaddr (1), +.BR eclat\-disassaddr (1). +.SH AUTHORS +Sergey Poznyakoff +.SH "BUG REPORTS" +Report bugs to . +.SH COPYRIGHT +Copyright \(co 2012, 2013 Sergey Poznyakoff +.br +.na +License GPLv3+: GNU GPL version 3 or later +.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-associate-address.1 b/doc/eclat-associate-address.1 deleted file mode 100644 index cc45341..0000000 --- a/doc/eclat-associate-address.1 +++ /dev/null @@ -1,98 +0,0 @@ -.\" 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 . -.TH ASSOCIATE\-ADDRESS 1 "January 19, 2013" "ECLAT" "Eclat User Reference" -.SH NAME -eclat associate\-address \- associate an IP address with an instance -.SH SYNOPSIS -\fBeclat associate\-address\fR [\fIOPTIONS\fR] \fIINSTANCE\fR \fIIP\fR - -\fBeclat associate\-address\fR [\fIOPTIONS\fR] \fIINSTANCE\fR \fIALLOC\-ID\fR - -\fBeclat associate\-address\fR \fB\-\-help\fR -.SH DESCRIPTION -The -.B associate\-address -command associates an Elastic IP address with an non-VPC instance or -associates a VPC Elastic IP address with an instance in your VPC. -.PP -The first argument is always the ID of the instance to operate upon. -The meaning of the second argument depends on the \fB\-\-vpc\fR command -line option. If that option is given, the second argument supplies the -allocation ID that AWS returned when you allocated the Elastic IP -address for use with Amazon VPC. Otherwise, it is the Elastic IP to -assign to the non-VPC instance. -.SH OPTIONS -.TP -\fB\-A\fR, \fB\-\-allow\-reassociation\fR -Allows an already associated address to be re-associated with the -specified instance (VPC only). -.TP -\fB\-i\fR, \fB\-\-interface\fR=\fIIFACE\fR -A network interface ID to associate with the instance (vpc only). -.TP -\fB\-p\fR, \fB\-\-private\-address\fR=\fIADDRESS\fR -Private IP address to associate with the Elastic IP address (vpc -only). -.TP -\fB\-v\fR, \fB\-\-vpc\fR -Assign VPC addresses. -.SH "OUTPUT AND RETURN VALUE" -The default output format does not display anything if the operation -succeeds. Otherwise it prints on the standard error the diagnostic -message returned by the Amazon, and returns code 1 to the shell. -.PP -The code 2 is returned if -.B eclat -is unable to recognize the response. -.SH EXAMPLES -.SS 1. -Assign an Elastic IP to the instance: -.P -.nf -.B eclat associate\-address i\-2ea64347 192.0.2.1 -.fi -.SS 2. -Associate an IP address with an instance in the VPC: -.P -.nf -.B eclat associate\-address \-\-vpc i\-4fd2431a eipalloc\-5723d13e -.fi -.SH "SEE ALSO" -.BR eclat (1), -.BR eclat\-allocate\-address (1), -.BR eclat\-release\-address (1), -.BR eclat\-disassociate\-address (1). -.SH AUTHORS -Sergey Poznyakoff -.SH "BUG REPORTS" -Report bugs to . -.SH COPYRIGHT -Copyright \(co 2012, 2013 Sergey Poznyakoff -.br -.na -License GPLv3+: GNU GPL version 3 or later -.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-attach-volume.1 b/doc/eclat-attach-volume.1 deleted file mode 100644 index 7566eca..0000000 --- a/doc/eclat-attach-volume.1 +++ /dev/null @@ -1,72 +0,0 @@ -.\" 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 . -.TH ECLAT\-ATTACH\-VOLUME 1 "January 19, 2013" "ECLAT" "Eclat User Reference" -.SH NAME -eclat attach\-volume \- attach a volume to an instance -.SH SYNOPSIS -\fBeclat attach\-volume\fR \fBVOL\-ID\fR \fBINST\-ID\fR \fBDEV\-NAME\fR - -\fBeclat attach\-volume\fR \fB\-\-help\fR -.SH DESCRIPTION -The \fBattach\-volume\fR command attaches an existing volume to an EC2 -instance. The -.B VOL\-ID -argument specifies the identifier of the volume to attach. If ID -mapping is enabled (see the section \fBMAPS\fR -in -.BR eclat (1)), -\fBVOL\-ID\fR is treated as a volume name and is translated -it to the AWS ID using the \fBVolumeId\fR map. The -.B INST\-ID -argument specifies the ID of the instance to attach the volume to. If -ID mapping is enabled, this argument is translated using the -.B InstanceId -map. Finally, the -.B DEV\-NAME -argument specifies the name of the device to use for this volume. -.SH EXAMPLE -.nf -.sp 2 -$ \fBeclat attach\-volume vol-12340156 i-40ed7ef3 /dev/xvdf\fR -vol-12340156 attaching i-40ed7ef3 /dev/xvdf -.fi -.SH "SEE ALSO" -.BR eclat (1), -.BR eclat-create-volume (1), -.BR eclat-delete-volume (1), -.BR eclat-describe-volumes (1), -.BR eclat-detach-volume (1). -.SH AUTHORS -Sergey Poznyakoff -.SH "BUG REPORTS" -Report bugs to . -.SH COPYRIGHT -Copyright \(co 2012, 2013 Sergey Poznyakoff -.br -.na -License GPLv3+: GNU GPL version 3 or later -.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-atvol.1 b/doc/eclat-atvol.1 new file mode 100644 index 0000000..87c85bf --- /dev/null +++ b/doc/eclat-atvol.1 @@ -0,0 +1,72 @@ +.\" 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 . +.TH ECLAT\-ATVOL 1 "January 19, 2013" "ECLAT" "Eclat User Reference" +.SH NAME +eclat atvol \- attach a volume to an instance +.SH SYNOPSIS +\fBeclat atvol\fR \fBVOL\-ID\fR \fBINST\-ID\fR \fBDEV\-NAME\fR + +\fBeclat atvol\fR \fB\-\-help\fR +.SH DESCRIPTION +The \fBatvol\fR command attaches an existing volume to an EC2 +instance. The +.B VOL\-ID +argument specifies the identifier of the volume to attach. If ID +mapping is enabled (see the section \fBMAPS\fR +in +.BR eclat (1)), +\fBVOL\-ID\fR is treated as a volume name and is translated +it to the AWS ID using the \fBVolumeId\fR map. The +.B INST\-ID +argument specifies the ID of the instance to attach the volume to. If +ID mapping is enabled, this argument is translated using the +.B InstanceId +map. Finally, the +.B DEV\-NAME +argument specifies the name of the device to use for this volume. +.SH EXAMPLE +.nf +.sp 2 +$ \fBeclat atvol vol-12340156 i-40ed7ef3 /dev/xvdf\fR +vol-12340156 attaching i-40ed7ef3 /dev/xvdf +.fi +.SH "SEE ALSO" +.BR eclat (1), +.BR eclat-mkvol (1), +.BR eclat-rmvol (1), +.BR eclat-lsvol (1), +.BR eclat-devol (1). +.SH AUTHORS +Sergey Poznyakoff +.SH "BUG REPORTS" +Report bugs to . +.SH COPYRIGHT +Copyright \(co 2012, 2013 Sergey Poznyakoff +.br +.na +License GPLv3+: GNU GPL version 3 or later +.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-conmesg.1 b/doc/eclat-conmesg.1 new file mode 100644 index 0000000..60c2011 --- /dev/null +++ b/doc/eclat-conmesg.1 @@ -0,0 +1,50 @@ +.\" 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 . +.TH MESG 1 "January 19, 2013" "ECLAT" "Eclat User Reference" +.SH NAME +eclat conmesg \- get console output from the instance +.SH SYNOPSIS +\fBeclat conmesg\fR \fIINSTANCE\-ID\fR + +\fBeclat conmesg\fR \fB\-\-help\fR +.SH DESCRIPTION +The command +.B conmesg +retrieves and prints on the standard output the console output for the +specified instance. +.SH "SEE ALSO" +.BR eclat (1). +.SH AUTHORS +Sergey Poznyakoff +.SH "BUG REPORTS" +Report bugs to . +.SH COPYRIGHT +Copyright \(co 2012, 2013 Sergey Poznyakoff +.br +.na +License GPLv3+: GNU GPL version 3 or later +.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-image.1 b/doc/eclat-create-image.1 deleted file mode 100644 index 1889f9b..0000000 --- a/doc/eclat-create-image.1 +++ /dev/null @@ -1,108 +0,0 @@ -.\" 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 . -.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 . -.SH COPYRIGHT -Copyright \(co 2012, 2013 Sergey Poznyakoff -.br -.na -License GPLv3+: GNU GPL version 3 or later -.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 deleted file mode 100644 index f13d5f4..0000000 --- a/doc/eclat-create-snapshot.1 +++ /dev/null @@ -1,76 +0,0 @@ -.\" 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 . -.TH CREATE\-SNAPSHOT 1 "January 19, 2013" "ECLAT" "Eclat User Reference" -.SH NAME -eclat create\-snapshot \- creates a snapshot of an Amazon EBS volume -.SH SYNOPSIS -\fBeclat create\-snapshot\fR \fIVOLUME\-ID\fR [\fIDESCR\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 -description of that snapshot. -.PP -If ID translation is enabled (see the section \fBMAPS\fR -in -.BR eclat (1)), -this command uses the \fBVolumeId\fR map to translate volume name to -the corresponding identifier. -.SH OUTPUT -The default output shows the ID of the snapshot and the volume, the size -of the volume in gigabytes, the state of the snapshot, its completion -percentage and creation time, e.g.: -.sp -.nf -.in +2 -snap\-78a54011 vol\-4d826724 10 pending 60% 2008\-05\-07T12:51:50.000Z -.in -.fi -.SH EXAMPLE -.sp -.nf -.in +2 -eclat create\-snapshot vol\-4d826724 Full backup -.in -.fi -.sp -Note that it is not necessary to quote the description. -.SH "SEE ALSO" -.BR eclat (1), -.BR eclat\-describe\-snapshots (1), -.BR eclat\-delete\-snapshot (1). -.SH AUTHORS -Sergey Poznyakoff -.SH "BUG REPORTS" -Report bugs to . -.SH COPYRIGHT -Copyright \(co 2012, 2013 Sergey Poznyakoff -.br -.na -License GPLv3+: GNU GPL version 3 or later -.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-tags.1 b/doc/eclat-create-tags.1 deleted file mode 100644 index 7ed40f4..0000000 --- a/doc/eclat-create-tags.1 +++ /dev/null @@ -1,145 +0,0 @@ -.\" 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 . -.TH CREATE\-TAGS 1 "January 22, 2013" "ECLAT" "Eclat User Reference" -.SH NAME -eclat create\-tags \- create or replace tags for a resource -.SH SYNOPSIS -\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]... - -\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 -followed by an equals sign, the characters following that sign are -stored in this tag's value. Otherwise an empty value is assigned to -it. -.PP -The resource to create the tags for is supplied with one of the -options. The resource designation must be present. -.PP -If ID mapping is enabled (see the section \fBMAPS\fR -in -.BR eclat (1)), -all options except \fB\-r\fR (\fB\-\-resource\-id\fR) translate their -arguments using corresponding maps (see -.B OPTIONS -below). The \fB\-r\fR (\fB\-\-resource\-id\fR) option uses no map by -default, unless the map name is specified explicitly before the ID. -.SH OPTIONS -.TP -\fB\-a\fR, \fB\-\-ami\fR \fIID\fR -Creates tags for the given image. In resource translation mode, uses -the map \fBImageId\fR. -.TP -\fB\-i\fR, \fB\-\-instance\fR \fIID\fR -Creates tags for the given instance. In resource translation mode, uses -the map \fBInstanceId\fR. -.TP -\fB\-r\fR, \fB\-\-resource\-id\fR [\fIMAP\fR:]\fIID\fR -Creates tags for the EC2 resource identified by \fIID\fR. If optional -\fIMAP\fR prefix is supplied and resource translation mode is enabled, -this option will use the \fIMAP\fR to translate \fIID\fR into AWS -resource identifier. -.TP -\fB\-s\fR, \fB\-\-snapshot\fR \fIID\fR -Creates tags for the given snapshot. In resource translation mode, uses -the map \fBSnapshotId\fR. -.TP -\fB\-T\fR, \fB\-\-from\-file\fR \fIFILE\fR -Reads tags from \fIFILE\fR or from the standard input, if \fIFILE\fR -is \fB\-\fR. Empty lines and lines beginning with \fB#\fR are -ignored. Non-empty lines must contain either a tag name alone, or a -tag name and the corresponding value, separated by an equals sign. If -the value is enclosed in double quotes, these will be removed and any -escaped characters within the value translated to their corresponding -equivalents using shell rules (e.g. \fB\\\(dq\fR becomes \fB\(dq\fR, -etc). See example 2 below. -.TP -\fB\-v\fR, \fB\-\-volume\fR \fIID\fR -Creates tags for the given volume. In resource translation mode, uses -the map \fBVolumeId\fR. -.SH OUTPUT -By default the command does not output anything, unless an error -occurs in which case the error diagnostics is printed on the standard -error. -.SH EXAMPLE -.nr step 1 1 -.IP \n[step]. -Create two tags for an instance: -.sp -.nf -.in +2 -eclat create\-tags \-i i\-12345678 Name=Webserver test -.in -.fi -.sp -This command creates two tags for instance \fBi\-12345678\fR: the tag -\fBName\fR with the value \fBWebserver\fR and tag \fBtest\fR with -empty value. -.IP \n+[step]. -Copy tags between instances: -.sp -.nf -.in +2 -eclat -e 'if (.DescribeTagsResponse) - for (var in .DescribeTagsResponse.tagSet.item) - print(var.key,"=",var.value,"\\n");' \\ - describe\-tags resource\-id=i\-12345678 | - eclat create\-tags \-i i\-fe2345ed \-T \- -.in -.fi -.sp -This example uses the -.B describe-tags -command to obtain tags from the instance -.B i-12345678 -and a custom format to represent them in a form suitable as input -to -.BR create-tags . -The obtained data are piped to the -.B create-tags -command which is instructed to read them from the standard input using -.BR "\-T \-" . -.SH "SEE ALSO" -.BR eclat (1), -.BR eclat\-delete\-tags (1), -.BR eclat\-describe\-tags (1). -.SH AUTHORS -Sergey Poznyakoff -.SH "BUG REPORTS" -Report bugs to . -.SH COPYRIGHT -Copyright \(co 2012, 2013 Sergey Poznyakoff -.br -.na -License GPLv3+: GNU GPL version 3 or later -.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-volume.1 b/doc/eclat-create-volume.1 deleted file mode 100644 index 7bd83e5..0000000 --- a/doc/eclat-create-volume.1 +++ /dev/null @@ -1,71 +0,0 @@ -.\" 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 . -.TH ECLAT\-CREATE\-VOLUME 1 "January 19, 2013" "ECLAT" "Eclat User Reference" -.SH NAME -eclat create\-volume \- create an Amazon EBS volume -.SH SYNOPSIS -\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 - -\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 -to any EC2 instance in the same Availability Zone. -.SH OPTIONS -.TP -\fB\-i\fR, \fB\-\-iops\fR \fIN\fR -Sets the supported number of I/O operations per second (IOPS). -.TP -\fB\-s\fR, \fB\-\-snapshot\fR \fIID\fR -The snapshot ID from which to create the new volume. -.SH OUTPUT -On success, the default format prints the ID of the created volume and -its status. -.SH EXAMPLE -.nf -.sp 2 -$ \fBeclat create-volume 80 eu-west-1b\fR -vol-de1203fa creating -.fi -.SH "SEE ALSO" -.BR eclat (1), -.BR eclat\-delete\-volume (1), -.BR eclat\-describe\-volumes (1), -.BR eclat\-attach\-volume (1), -.BR eclat\-detach\-volume (1), -.BR eclat\-describe\-availability\-zones (1). -.SH AUTHORS -Sergey Poznyakoff -.SH "BUG REPORTS" -Report bugs to . -.SH COPYRIGHT -Copyright \(co 2012, 2013 Sergey Poznyakoff -.br -.na -License GPLv3+: GNU GPL version 3 or later -.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-deimg.1 b/doc/eclat-deimg.1 new file mode 100644 index 0000000..8da014c --- /dev/null +++ b/doc/eclat-deimg.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 . +.TH DEIMG 1 "April 11, 2013" "ECLAT" "Eclat User Reference" +.SH NAME +eclat deimg \- deregister an EC2 image +.SH SYNOPSIS +\fBeclat deimg\fR \fBID\fR + +\fBeclat deimg\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 rmsnap\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\-rmsnap (1), +.BR eclat\-mkimg (1), +.BR eclat\-lsimg (1). +.SH AUTHORS +Sergey Poznyakoff +.SH "BUG REPORTS" +Report bugs to . +.SH COPYRIGHT +Copyright \(co 2012, 2013 Sergey Poznyakoff +.br +.na +License GPLv3+: GNU GPL version 3 or later +.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-delete-snapshot.1 b/doc/eclat-delete-snapshot.1 deleted file mode 100644 index 0dd1017..0000000 --- a/doc/eclat-delete-snapshot.1 +++ /dev/null @@ -1,57 +0,0 @@ -.\" 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 . -.TH DELETE\-SNAPSHOT 1 "January 19, 2013" "ECLAT" "Eclat User Reference" -.SH NAME -eclat delete\-snapshot \- delete a snapshot of an Amazon EBS volume -.SH SYNOPSIS -\fBeclat delete\-snapshot\fR \fISNAPSHOT\-ID\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 -in -.BR eclat (1)), -this command uses the \fBSnapshotId\fR map to translate snapshot name to -the corresponding identifier. -.SH OUTPUT -On success, the command is silent. On error, it prints on the standard -error the error message received from Amazon. -.SH "SEE ALSO" -.BR eclat (1), -.BR eclat\-describe\-snapshots (1), -.BR eclat\-create\-snapshot (1). -.SH AUTHORS -Sergey Poznyakoff -.SH "BUG REPORTS" -Report bugs to . -.SH COPYRIGHT -Copyright \(co 2012, 2013 Sergey Poznyakoff -.br -.na -License GPLv3+: GNU GPL version 3 or later -.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-delete-tags.1 b/doc/eclat-delete-tags.1 deleted file mode 100644 index ba733eb..0000000 --- a/doc/eclat-delete-tags.1 +++ /dev/null @@ -1,116 +0,0 @@ -.\" 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 . -.TH DELETE\-TAGS 1 "January 24, 2013" "ECLAT" "Eclat User Reference" -.SH NAME -eclat delete\-tags \- delete or replace tags for a resource -.SH SYNOPSIS -\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]...] - -\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 -an equals sign and a value, it will be deleted only if both its name and value -are the same as the supplied ones. Otherwise, the tag will be deleted -regardless of its value. -.PP -If no tag names are given, all tags are deleted. -.PP -The resource to delete tags from is supplied with one of the -options. The resource designation must be present. -.PP -If ID mapping is enabled (see the section \fBMAPS\fR -in -.BR eclat (1)), -all options except \fB\-r\fR (\fB\-\-resource\-id\fR) translate their -arguments using corresponding maps (see -.B OPTIONS -below). The \fB\-r\fR (\fB\-\-resource\-id\fR) option uses no map by -default, unless the map name is specified explicitly before the ID. -.SH OPTIONS -.TP -\fB\-a\fR, \fB\-\-ami\fR \fIID\fR -Deletes tags from the given image. In resource translation mode, uses -the map \fBImageId\fR. -.TP -\fB\-i\fR, \fB\-\-instance\fR \fIID\fR -Deletes tags from the given instance. In resource translation mode, uses -the map \fBInstanceId\fR. -.TP -\fB\-r\fR, \fB\-\-resource\-id\fR [\fIMAP\fR:]\fIID\fR -Deletes tags from the EC2 resource identified by \fIID\fR. If optional -\fIMAP\fR prefix is supplied and resource translation mode is enabled, -this option will use the \fIMAP\fR to translate \fIID\fR into AWS -resource identifier. -.TP -\fB\-T\fR, \fB\-\-from\-file\fR \fIFILE\fR -Reads tags from \fIFILE\fR or from the standard input, if \fIFILE\fR -is \fB\-\fR. Empty lines and lines beginning with \fB#\fR are -ignored. Non-empty lines must contain either a tag name alone, or a -tag name and the corresponding value, separated by an equals sign. If -the value is enclosed in double quotes, these will be removed and any -escaped characters within the value translated to their corresponding -equivalents using shell rules (e.g. \fB\\\(dq\fR becomes \fB\(dq\fR, -etc). -.TP -\fB\-v\fR, \fB\-\-volume\fR \fIID\fR -Deletes tags from the given volume. In resource translation mode, uses -the map \fBVolumeId\fR. -.SH OUTPUT -By default the command does not output anything, unless an error -occurs in which case the error diagnostics is printed on the standard -error. -.SH EXAMPLE -.sp -.nf -.in +2 -eclat delete\-tags \-i i\-12345678 Name=Webserver test -.in -.fi -.sp -This command deletes two tags from the instance \fBi\-12345678\fR: the tag -\fBName\fR, if it has the value \fBWebserver\fR and tag \fBtest\fR, -no matter what its value is. -.SH "SEE ALSO" -.BR eclat (1), -.BR eclat\-create\-tags (1), -.BR eclat\-describe\-tags (1). -.SH AUTHORS -Sergey Poznyakoff -.SH "BUG REPORTS" -Report bugs to . -.SH COPYRIGHT -Copyright \(co 2012, 2013 Sergey Poznyakoff -.br -.na -License GPLv3+: GNU GPL version 3 or later -.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-delete-volume.1 b/doc/eclat-delete-volume.1 deleted file mode 100644 index e709a4e..0000000 --- a/doc/eclat-delete-volume.1 +++ /dev/null @@ -1,59 +0,0 @@ -.\" 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 . -.TH ECLAT\-DELETE\-VOLUME 1 "January 19, 2013" "ECLAT" "Eclat User Reference" -.SH NAME -eclat delete\-volume \- delete an EC2 volume -.SH SYNOPSIS -\fBeclat delete\-volume\fR \fBVOL\-ID\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. -.PP -If ID mapping is enabled (see the section \fBMAPS\fR -in -.BR eclat (1)), -this command treats the \fBVOL\-ID\fR as volume names and translates -it to the AWS IDs using the \fBVolumeId\fR map. -.SH "SEE ALSO" -.BR eclat (1), -.BR eclat\-create\-volume (1), -.BR eclat\-describe\-volumes (1), -.BR eclat\-attach\-volume (1), -.BR eclat\-detach\-volume (1), -.BR eclat\-describe\-availability\-zones (1). -.SH AUTHORS -Sergey Poznyakoff -.SH "BUG REPORTS" -Report bugs to . -.SH COPYRIGHT -Copyright \(co 2012, 2013 Sergey Poznyakoff -.br -.na -License GPLv3+: GNU GPL version 3 or later -.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-deregister-image.1 b/doc/eclat-deregister-image.1 deleted file mode 100644 index 95030d5..0000000 --- a/doc/eclat-deregister-image.1 +++ /dev/null @@ -1,65 +0,0 @@ -.\" 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 . -.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 . -.SH COPYRIGHT -Copyright \(co 2012, 2013 Sergey Poznyakoff -.br -.na -License GPLv3+: GNU GPL version 3 or later -.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 deleted file mode 100644 index bbfd4ca..0000000 --- a/doc/eclat-describe-addresses.1 +++ /dev/null @@ -1,101 +0,0 @@ -.\" 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 . -.TH DESCRIBE\-ADDRESSES 1 "January 19, 2013" "ECLAT" "Eclat User Reference" -.SH NAME -eclat describe\-addresses \- return information about IP addresses in -your account -.SH SYNOPSIS -\fBeclat describe\-addresses\fR [\fB\-v\fR] [\fB\-\-vpc\fR] [\fBFILTER\fR...] - -\fBeclat describe\-addresses\fR \fB\-\-help\fR -.SH DESCRIPTION -This command returns information about Elas