diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2012-10-01 22:36:54 +0300 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2012-10-01 22:36:54 +0300 |
commit | 9591095bbf09b6a1cbe084801bde49336d626dbe (patch) | |
tree | a2416f151d6ee51863092374cd20b2c87a4941e9 /doc | |
parent | 179bf25f249a8ee7456e9f3e47f930014b0e5f90 (diff) | |
download | eclat-9591095bbf09b6a1cbe084801bde49336d626dbe.tar.gz eclat-9591095bbf09b6a1cbe084801bde49336d626dbe.tar.bz2 |
Fix disassociate-address to work with VPC addresses. Improve docs.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 6 | ||||
-rw-r--r-- | doc/eclat-associate-address.1 | 5 | ||||
-rw-r--r-- | doc/eclat-disassociate-address.1 | 73 | ||||
-rw-r--r-- | doc/eclat-reboot-instances.1 | 53 | ||||
-rw-r--r-- | doc/eclat-start-instances.1 | 53 | ||||
-rw-r--r-- | doc/eclat-stop-instances.1 | 53 | ||||
-rw-r--r-- | doc/eclat.1 | 2 | ||||
-rw-r--r-- | doc/tmpl.1 | 45 |
8 files changed, 286 insertions, 4 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 1a230e0..2cd40ab 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -16,4 +16,8 @@ dist_man_MANS=\ eclat.1\ - eclat-associate-address.1
\ No newline at end of file + eclat-associate-address.1\ + eclat-disassociate-address.1\ + eclat-start-instances.1\ + eclat-stop-instances.1\ + eclat-reboot-instances.1
\ No newline at end of file diff --git a/doc/eclat-associate-address.1 b/doc/eclat-associate-address.1 index 866e914..0ef82ae 100644 --- a/doc/eclat-associate-address.1 +++ b/doc/eclat-associate-address.1 @@ -1,4 +1,4 @@ -.\" This file is part of Eclat +.\" This file is part of Eclat -*- nroff -*- .\" Copyright (C) 2012 Sergey Poznyakoff .\" .\" Eclat is free software; you can redistribute it and/or modify @@ -71,7 +71,8 @@ Associate an IP address with an instance in the VPC: .B eclat associate-address --vpc i-4fd2431a eipalloc-5723d13e .fi .SH "SEE ALSO" -.BR eclat (1). +.BR eclat (1), +.BR eclat-associate-address (1). .SH AUTHORS Sergey Poznyakoff .SH "BUG REPORTS" diff --git a/doc/eclat-disassociate-address.1 b/doc/eclat-disassociate-address.1 new file mode 100644 index 0000000..92467f1 --- /dev/null +++ b/doc/eclat-disassociate-address.1 @@ -0,0 +1,73 @@ +.\" This file is part of Eclat -*- nroff -*- +.\" Copyright (C) 2012 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 ECLAT 1 "October 1, 2012" "ECLAT" "Eclat User Reference" +.SH NAME +eclat disassociate-address \- disassociate IP address from EC2 instance. +.SH SYNOPSIS +eclat disassociate-address [\fB\-\-vpc\fR] [\fB\-v\fR] IP +.SH DESCRIPTION +This command disassociates IP address from the EC2 instance. +.SH OPTIONS +.TP +\fB\-v\fR, \fB\-\-vpc\fR +Disassociate a VPC Elastic IP address. If this option is given, the +argument is treated as the association ID corresponding to the VPC +Elastic IP address. +.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. +Disassociate the Elastic IP: +.P +.nf +.B eclat disassociate-address 192.0.2.1 +.fi +.SS 2. +Disassociate the VPC Elastic IP: +.P +.nf +.B eclat associate-address --vpc eipalloc-5723d13e +.fi +.SH "SEE ALSO" +.BR eclat (1), +.BR eclat-associate-address (1). +.SH AUTHORS +Sergey Poznyakoff +.SH "BUG REPORTS" +Report bugs to <bug-eclat@gnu.org.ua>. +.SH COPYRIGHT +Copyright \(co 2012 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-reboot-instances.1 b/doc/eclat-reboot-instances.1 new file mode 100644 index 0000000..c657f35 --- /dev/null +++ b/doc/eclat-reboot-instances.1 @@ -0,0 +1,53 @@ +.\" This file is part of Eclat -*- nroff -*- +.\" Copyright (C) 2012 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 ECLAT 1 "October 1, 2012" "ECLAT" "Eclat User Reference" +.SH NAME +eclat reboot\-instances \- reboot EC2 instances +.SH SYNOPSIS +eclat reboot\-instances \fIID\fR [\fIID\fR...] +.SH DESCRIPTION +The command +.B reboot\-instances +reboots running Amazon EBS-backed instances. +.SH OUTPUT +The default output format lists o each line the instance ID, its +previous and current states, separated by single horizontal tab +characters. +.SH "SEE ALSO" +.BR eclat (1), +.BR eclat-start-instances (1), +.BR eclat-stop-instances (1). +.SH AUTHORS +Sergey Poznyakoff +.SH "BUG REPORTS" +Report bugs to <bug-eclat@gnu.org.ua>. +.SH COPYRIGHT +Copyright \(co 2012 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-start-instances.1 b/doc/eclat-start-instances.1 new file mode 100644 index 0000000..249cb5f --- /dev/null +++ b/doc/eclat-start-instances.1 @@ -0,0 +1,53 @@ +.\" This file is part of Eclat -*- nroff -*- +.\" Copyright (C) 2012 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 ECLAT 1 "October 1, 2012" "ECLAT" "Eclat User Reference" +.SH NAME +eclat start\-instances \- start EC2 instances +.SH SYNOPSIS +eclat start\-instances \fIID\fR [\fIID\fR...] +.SH DESCRIPTION +The command +.B start\-instances +starts Amazon EBS-backed instances you have stopped previously. +.SH OUTPUT +The default output format lists on each line the instance ID, its +previous and current states, separated by single horizontal tab +characters. +.SH "SEE ALSO" +.BR eclat (1), +.BR eclat-stop-instances (1), +.BR eclat-reboot-instances (1). +.SH AUTHORS +Sergey Poznyakoff +.SH "BUG REPORTS" +Report bugs to <bug-eclat@gnu.org.ua>. +.SH COPYRIGHT +Copyright \(co 2012 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-stop-instances.1 b/doc/eclat-stop-instances.1 new file mode 100644 index 0000000..0f18ee1 --- /dev/null +++ b/doc/eclat-stop-instances.1 @@ -0,0 +1,53 @@ +.\" This file is part of Eclat -*- nroff -*- +.\" Copyright (C) 2012 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 ECLAT 1 "October 1, 2012" "ECLAT" "Eclat User Reference" +.SH NAME +eclat stop\-instances \- stop EC2 instances +.SH SYNOPSIS +eclat stop\-instances \fIID\fR [\fIID\fR...] +.SH DESCRIPTION +The command +.B stop\-instances +stops running Amazon EBS-backed instances. +.SH OUTPUT +The default output format lists on each line the instance ID, its +previous and current states, separated by single horizontal tab +characters. +.SH "SEE ALSO" +.BR eclat (1), +.BR eclat-start-instances (1), +.BR eclat-reboot-instances (1). +.SH AUTHORS +Sergey Poznyakoff +.SH "BUG REPORTS" +Report bugs to <bug-eclat@gnu.org.ua>. +.SH COPYRIGHT +Copyright \(co 2012 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.1 b/doc/eclat.1 index ad17cb8..2c6ec8b 100644 --- a/doc/eclat.1 +++ b/doc/eclat.1 @@ -1,4 +1,4 @@ -.\" This file is part of Eclat +.\" This file is part of Eclat -* nroff -*- .\" Copyright (C) 2012 Sergey Poznyakoff .\" .\" Eclat is free software; you can redistribute it and/or modify diff --git a/doc/tmpl.1 b/doc/tmpl.1 new file mode 100644 index 0000000..b0481df --- /dev/null +++ b/doc/tmpl.1 @@ -0,0 +1,45 @@ +.\" This file is part of Eclat -*- nroff -*- +.\" Copyright (C) 2012 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 ECLAT 1 "October 1, 2012" "ECLAT" "Eclat User Reference" +.SH NAME +eclat \- EC2 Command Line Administrator Tool +.SH SYNOPSIS +.SH DESCRIPTION +.SH "RETURN VALUE" +.SH EXAMPLE +.SH "SEE ALSO" +.BR eclat (1). +.SH AUTHORS +Sergey Poznyakoff +.SH "BUG REPORTS" +Report bugs to <bug-eclat@gnu.org.ua>. +.SH COPYRIGHT +Copyright \(co 2012 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: + |