summaryrefslogtreecommitdiffabout
path: root/doc/eclat-rmaddr.1
Side-by-side diff
Diffstat (limited to 'doc/eclat-rmaddr.1') (more/less context) (ignore whitespace changes)
-rw-r--r--doc/eclat-rmaddr.189
1 files changed, 89 insertions, 0 deletions
diff --git a/doc/eclat-rmaddr.1 b/doc/eclat-rmaddr.1
new file mode 100644
index 0000000..8deb962
--- a/dev/null
+++ b/doc/eclat-rmaddr.1
@@ -0,0 +1,89 @@
+.\" 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 DISASSOCADDR 1 "April 20, 2013" "ECLAT" "Eclat User Reference"
+.SH NAME
+eclat rmaddr, release\-address \- release Elastic IP address.
+.SH SYNOPSIS
+\fBeclat rmaddr\fR [\fB\-\-vpc\fR] [\fB\-v\fR] \fIIP\-OR\-ALLOCID\fR
+
+\fBeclat rmaddr\fR \fB\-\-help\fR
+.SH DESCRIPTION
+This command releases an Elastic IP address. The address must have been
+previously allocated using the
+.B allocaddr
+command.
+.SH OPTIONS
+.TP
+\fB\-v\fR, \fB\-\-vpc\fR
+Release a VPC Elastic IP address. If this option is given, the
+argument is treated as the allocation 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.
+.PP
+The code 16 is returned if the operation is not confirmed.
+.SH EXAMPLES
+.SS 1.
+Release the Elastic IP:
+.P
+.nf
+.B $ eclat rmaddr 192.0.2.1
+Really release IP 192.0.2.1 [Y/n] y
+.fi
+.SS 2.
+Same, with confirmation disabled:
+.P
+.nf
+.B $ eclat -Y rmaddr 192.0.2.1
+.fi
+.SS 3.
+Release the VPC Elastic IP:
+.P
+.nf
+.B eclat rmaddr \-\-vpc eipalloc\-5723d13e
+.fi
+.SH "SEE ALSO"
+.BR eclat (1),
+.BR eclat\-allocaddr (1),
+.BR eclat\-assocaddr (1),
+.BR eclat\-disassaddr (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:
+

Return to:

Send suggestions and report system problems to the System administrator.