diff options
Diffstat (limited to 'doc/eclat-rmaddr.1')
-rw-r--r-- | doc/eclat-rmaddr.1 | 89 |
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 --- /dev/null +++ b/doc/eclat-rmaddr.1 | |||
@@ -0,0 +1,89 @@ | |||
1 | .\" This file is part of Eclat -*- nroff -*- | ||
2 | .\" Copyright (C) 2012, 2013 Sergey Poznyakoff | ||
3 | .\" | ||
4 | .\" Eclat is free software; you can redistribute it and/or modify | ||
5 | .\" it under the terms of the GNU General Public License as published by | ||
6 | .\" the Free Software Foundation; either version 3, or (at your option) | ||
7 | .\" any later version. | ||
8 | .\" | ||
9 | .\" Eclat is distributed in the hope that it will be useful, | ||
10 | .\" but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
11 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
12 | .\" GNU General Public License for more details. | ||
13 | .\" | ||
14 | .\" You should have received a copy of the GNU General Public License | ||
15 | .\" along with Eclat. If not, see <http://www.gnu.org/licenses/>. | ||
16 | .TH DISASSOCADDR 1 "April 20, 2013" "ECLAT" "Eclat User Reference" | ||
17 | .SH NAME | ||
18 | eclat rmaddr, release\-address \- release Elastic IP address. | ||
19 | .SH SYNOPSIS | ||
20 | \fBeclat rmaddr\fR [\fB\-\-vpc\fR] [\fB\-v\fR] \fIIP\-OR\-ALLOCID\fR | ||
21 | |||
22 | \fBeclat rmaddr\fR \fB\-\-help\fR | ||
23 | .SH DESCRIPTION | ||
24 | This command releases an Elastic IP address. The address must have been | ||
25 | previously allocated using the | ||
26 | .B allocaddr | ||
27 | command. | ||
28 | .SH OPTIONS | ||
29 | .TP | ||
30 | \fB\-v\fR, \fB\-\-vpc\fR | ||
31 | Release a VPC Elastic IP address. If this option is given, the | ||
32 | argument is treated as the allocation ID corresponding to the VPC | ||
33 | Elastic IP address. | ||
34 | .SH "OUTPUT AND RETURN VALUE" | ||
35 | The default output format does not display anything if the operation | ||
36 | succeeds. Otherwise it prints on the standard error the diagnostic | ||
37 | message returned by the Amazon, and returns code 1 to the shell. | ||
38 | .PP | ||
39 | The code 2 is returned if | ||
40 | .B eclat | ||
41 | is unable to recognize the response. | ||
42 | .PP | ||
43 | The code 16 is returned if the operation is not confirmed. | ||
44 | .SH EXAMPLES | ||
45 | .SS 1. | ||
46 | Release the Elastic IP: | ||
47 | .P | ||
48 | .nf | ||
49 | .B $ eclat rmaddr 192.0.2.1 | ||
50 | Really release IP 192.0.2.1 [Y/n] y | ||
51 | .fi | ||
52 | .SS 2. | ||
53 | Same, with confirmation disabled: | ||
54 | .P | ||
55 | .nf | ||
56 | .B $ eclat -Y rmaddr 192.0.2.1 | ||
57 | .fi | ||
58 | .SS 3. | ||
59 | Release the VPC Elastic IP: | ||
60 | .P | ||
61 | .nf | ||
62 | .B eclat rmaddr \-\-vpc eipalloc\-5723d13e | ||
63 | .fi | ||
64 | .SH "SEE ALSO" | ||
65 | .BR eclat (1), | ||
66 | .BR eclat\-allocaddr (1), | ||
67 | .BR eclat\-assocaddr (1), | ||
68 | .BR eclat\-disassaddr (1). | ||
69 | .SH AUTHORS | ||
70 | Sergey Poznyakoff | ||
71 | .SH "BUG REPORTS" | ||
72 | Report bugs to <bug\-eclat@gnu.org.ua>. | ||
73 | .SH COPYRIGHT | ||
74 | Copyright \(co 2012, 2013 Sergey Poznyakoff | ||
75 | .br | ||
76 | .na | ||
77 | License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> | ||
78 | .br | ||
79 | .ad | ||
80 | This is free software: you are free to change and redistribute it. | ||
81 | There is NO WARRANTY, to the extent permitted by law. | ||
82 | .\" Local variables: | ||
83 | .\" eval: (add-hook 'write-file-hooks 'time-stamp) | ||
84 | .\" time-stamp-start: ".TH [A-Z_][A-Z0-9_.\\-]* [0-9] \"" | ||
85 | .\" time-stamp-format: "%:B %:d, %:y" | ||
86 | .\" time-stamp-end: "\"" | ||
87 | .\" time-stamp-line-limit: 20 | ||
88 | .\" end: | ||
89 | |||