aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2013-04-24 21:22:34 +0300
committerSergey Poznyakoff <gray@gnu.org.ua>2013-04-24 21:22:34 +0300
commit02e09c1128a6e489a52390867c81fc886cb74273 (patch)
treef113128107056cbc9a22485f80b6c2a1677691e7 /doc
parent61522e20ca9c82620a123ee4da5fd8724bcafe6e (diff)
downloadeclat-02e09c1128a6e489a52390867c81fc886cb74273.tar.gz
eclat-02e09c1128a6e489a52390867c81fc886cb74273.tar.bz2
Document cpimg and cpsnap
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.inc2
-rw-r--r--doc/eclat-cpimg.174
-rw-r--r--doc/eclat-cpsnap.174
-rw-r--r--doc/eclat-tmpl.14
4 files changed, 152 insertions, 2 deletions
diff --git a/doc/Makefile.inc b/doc/Makefile.inc
index d73e732..72921d3 100644
--- a/doc/Makefile.inc
+++ b/doc/Makefile.inc
@@ -24,6 +24,8 @@ MANPAGES1=\
eclat-assocaddr.1\
eclat-atvol.1\
eclat-clrsattr.1\
+ eclat-cpimg.1\
+ eclat-cpsnap.1\
eclat-mkinst.1\
eclat-mkimg.1\
eclat-mksnap.1\
diff --git a/doc/eclat-cpimg.1 b/doc/eclat-cpimg.1
new file mode 100644
index 0000000..e887bf9
--- /dev/null
+++ b/doc/eclat-cpimg.1
@@ -0,0 +1,74 @@
+.\" 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 CPIMG 1 "April 24, 2013" "ECLAT" "Eclat User Reference"
+.SH NAME
+eclat cpimg \- create a copy of the Amazon image
+.SH SYNOPSIS
+\fBeclat cpimg\fR [\fB\-d\fR \fIDESCR\fR] [\fB\-n\fR \fINAME\fR] [\fB\-\-description\fR=\fIdescr\fR]
+ [\fB\-\-name\fR=\fINAME\fR] \fIREGION\fR \fIAMI\-ID\fR
+
+.B eclat cpimg \-\-help
+.SH DESCRIPTION
+The \fBcpimg\fR command copies an Amazon image identified by \fIAMI\-ID\fR
+from the given \fIREGION\fR to the current region. The current region is
+the one specified by the \fBdefault\-region\fR statement in your
+.BR eclat.conf (5),
+or by the
+.BR eclat (1)
+command line option
+.BR \-\-region .
+.PP
+Normally, \fIAMI\-ID\fR is treated as the ID of the source image. This
+changes if \fIID\fR mapping is in use (see the section \fBMAPS\fR
+in
+.BR eclat (1)),
+in which case it is treated as the image symbolic name and is translated to
+the corresponding ID using the \fBImageId\fR map.
+.SH OPTIONS
+.TP
+\fB\-d\fR, \fB\-\-description\fR=\fIDESCR\fR
+Set description for the new image.
+.TP
+\fB\-n\fR, \fB\-\-name\fR=\fINAME\fR
+Assign name to the new image.
+.SH OUTPUT
+The default output format lists the Amazon ID of the copy.
+.SH "SEE ALSO"
+.BR eclat (1),
+.BR eclat-mkimg (1),
+.BR eclat-deimg (1),
+.BR eclat-lsimg (1).
+.SH AUTHORS
+Sergey Poznyakoff
+.SH "BUG REPORTS"
+Report bugs to <bug\-eclat@gnu.org.ua>.
+.SH COPYRIGHT
+Copyright \(co 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:
+
diff --git a/doc/eclat-cpsnap.1 b/doc/eclat-cpsnap.1
new file mode 100644
index 0000000..b951e08
--- /dev/null
+++ b/doc/eclat-cpsnap.1
@@ -0,0 +1,74 @@
+.\" 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 CPSNAP 1 "April 24, 2013" "ECLAT" "Eclat User Reference"
+.SH NAME
+eclat cpsnap \- copy snapshot from another region
+.SH SYNOPSIS
+\fBeclat cpsnap\fR [\fB\-d\fR \fIDESCR\fR] [\fB\-\-description\fR=\fIdescr\fR]\
+ \fIREGION\fR \fISNAP\-ID\fR
+
+.B eclat cpsnap \-\-help
+.SH DESCRIPTION
+The \fBcpsnap\fR command copies an Amazon snapshot identified by \fISNAP\-ID\fR
+from the given \fIREGION\fR to the current region. The current region is
+the one specified by the \fBdefault\-region\fR statement in your
+.BR eclat.conf (5),
+or by the
+.BR eclat (1)
+command line option
+.BR \-\-region .
+.PP
+Normally, \fISNAP\-ID\fR is treated as the ID of the source snapshot. This
+changes if \fIID\fR mapping is in use (see the section \fBMAPS\fR
+in
+.BR eclat (1)),
+in which case it is treated as the snapshot symbolic name and is translated to
+the corresponding ID using the \fBSnapshotId\fR map.
+.SH OPTIONS
+.TP
+\fB\-d\fR, \fB\-\-description\fR=\fIDESCR\fR
+Set description for the new snapshot.
+.SH OUTPUT
+The default output format lists the Amazon ID of the copy.
+.SH "SEE ALSO"
+.BR eclat (1),
+.BR eclat-clrsattr (1),
+.BR eclat-lssattr (1),
+.BR eclat-lssnap (1).
+.BR eclat-mksnap (1),
+.BR eclat-rmsnap (1),
+.BR eclat-setsattr (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:
+
diff --git a/doc/eclat-tmpl.1 b/doc/eclat-tmpl.1
index 53b8309..94ea840 100644
--- a/doc/eclat-tmpl.1
+++ b/doc/eclat-tmpl.1
@@ -13,12 +13,12 @@
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with Eclat. If not, see <http://www.gnu.org/licenses/>.
-.TH COMMAND 1 "January 19, 2013" "ECLAT" "Eclat User Reference"
+.TH COMMAND 1 "April 24, 2013" "ECLAT" "Eclat User Reference"
.SH NAME
eclat command \-
.SH SYNOPSIS
-\fBeclat command\fB \fB\-\-help\fR
+\fBeclat command\fR \fB\-\-help\fR
.SH DESCRIPTION
.SH OPTIONS
.SH FILTERS

Return to:

Send suggestions and report system problems to the System administrator.