diff options
author | Sergey Poznyakoff <gray@gnu.org.ua> | 2012-12-11 16:39:44 +0200 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org.ua> | 2012-12-11 16:40:13 +0200 |
commit | 9837ae97337b28dffe9fb30d864f5e5b5c274899 (patch) | |
tree | fd1a23b4327bd331bcf2a1127a24ff5af12e2079 /doc | |
parent | 8bc5ddbfb6d5d91287af6da059bea245d09fcb4f (diff) | |
download | eclat-9837ae97337b28dffe9fb30d864f5e5b5c274899.tar.gz eclat-9837ae97337b28dffe9fb30d864f5e5b5c274899.tar.bz2 |
Document attach-volume and detach-volume
* TODO: Update.
* doc/Makefile.am: Add new files.
* doc/eclat-attach-volume.1: New file.
* doc/eclat-detach-volume.1: New file.
* doc/eclat.1: Mention attach-volume and detach-volume.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 2 | ||||
-rw-r--r-- | doc/eclat-attach-volume.1 | 72 | ||||
-rw-r--r-- | doc/eclat-detach-volume.1 | 73 | ||||
-rw-r--r-- | doc/eclat.1 | 4 |
4 files changed, 150 insertions, 1 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 271b4b6..9b0186c 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -18,6 +18,7 @@ MANPAGES1=\ eclat.1\ eclat-allocate-address.1\ eclat-associate-address.1\ + eclat-attach-volume.1\ eclat-create-snapshot.1\ eclat-create-tags.1\ eclat-create-volume.1\ @@ -33,6 +34,7 @@ MANPAGES1=\ eclat-describe-snapshots.1\ eclat-describe-tags.1\ eclat-describe-volumes.1\ + eclat-detach-volume.1\ eclat-disassociate-address.1\ eclat-get-console-output.1\ eclat-start-instances.1\ diff --git a/doc/eclat-attach-volume.1 b/doc/eclat-attach-volume.1 new file mode 100644 index 0000000..17e7b81 --- /dev/null +++ b/doc/eclat-attach-volume.1 @@ -0,0 +1,72 @@ +.\" 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\-ATTACH\-VOLUME 1 "December 11, 2012" "ECLAT" "Eclat User Reference" +.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 + +eclat attach\-volume \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 <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-detach-volume.1 b/doc/eclat-detach-volume.1 new file mode 100644 index 0000000..bd77024 --- /dev/null +++ b/doc/eclat-detach-volume.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\-DETACH\-VOLUME 1 "December 11, 2012" "ECLAT" "Eclat User Reference" +.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\ + [\fBINST\-ID\fR [\fBDEV\-NAME\fR]] + +eclat detach\-volume \fB\-\-help\fR +.SH DESCRIPTION +The \fBdetach\-volume\fR command detaches a volume from an EC2 +instance. The volume is identified by the +.B VOL\-ID +argument, which specifies its identifier or symbolic name (if +ID +mapping is enabled). In the latter case, the name is translated to ID +using the \fBVolumeId\fR map. +.PP +The optional argument +.B INST\-ID +specifies the ID of the instance to attach the volume to. If +ID mapping is enabled, it is translated using the +.B InstanceId +map. Finally, the optional argument +.B DEV\-NAME +specifies the name of the device that refers to this volume. +.SH EXAMPLE +.nf +.sp 2 +$ \fBeclat detach\-volume vol-12340156 i-40ed7ef3 /dev/xvdf\fR +vol-12340156 detaching i-40ed7ef3 /dev/xvdf +.fi +.SH "SEE ALSO" +.BR eclat (1), +.BR eclat-attach-volume (1), +.BR eclat-create-volume (1), +.BR eclat-delete-volume (1), +.BR eclat-describe-volumes (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 9fdabd0..5933b0f 100644 --- a/doc/eclat.1 +++ b/doc/eclat.1 @@ -13,7 +13,7 @@ .\" .\" 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 "December 7, 2012" "ECLAT" "Eclat User Reference" +.TH ECLAT 1 "December 11, 2012" "ECLAT" "Eclat User Reference" .SH NAME eclat \- EC2 Command Line Administrator Tool .SH SYNOPSIS @@ -210,6 +210,7 @@ To get a help on a particular command, refer to \fBeclat\-\fIcommand\fR commands are implemented: .BR allocate\-address , .BR associate\-address , +.BR attach\-volume , .BR create\-tags , .BR create\-snapshot , .BR create\-volume , @@ -434,6 +435,7 @@ from the format file. .BR eclat.conf (5), .BR eclat\-allocate\-address (1), .BR eclat\-associate\-address (1), +.BT eclat\-attach\-volume (1), .BR eclat\-create\-tags (1), .BR eclat\-create\-snapshot (1), .BR eclat\-create\-volume (1), |