aboutsummaryrefslogtreecommitdiff
path: root/doc/eclat.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/eclat.1')
-rw-r--r--doc/eclat.122
1 files changed, 19 insertions, 3 deletions
diff --git a/doc/eclat.1 b/doc/eclat.1
index cba7b2d..d2af06f 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 "October 1, 2012" "ECLAT" "Eclat User Reference"
+.TH ECLAT 1 "October 11, 2012" "ECLAT" "Eclat User Reference"
.SH NAME
eclat \- EC2 Command Line Administrator Tool
.SH SYNOPSIS
@@ -155,8 +155,9 @@ would start the instance \fIi-1234beef\fR. It can be noted, that
identifiers are rather machine- than human-oriented. If you
have a number of resources, it is not easy to remember which
identifier corresponds to which resource. In the example above, one
-would rather prefer to identify the instance to be started by its DNS
-name, than by its ID. To make this possible,
+would rather prefer to identify the instance to be started by its
+functional name (say, "dbserver") or its DNS name, than by its ID. To
+make this possible,
.B eclat
provides a mapping feature.
.PP
@@ -181,6 +182,21 @@ will by default select a map named by the resource in question. For
example, when operating on an instance, the \fIInstanceId\fR map will
be used.
.PP
+For commands that support the \fRresource-id\fB filter, identifiers
+listed in that filter can be prefixed with the map name in order to
+request their translation. For example,
+.sp
+.nf
+.in +2
+eclat -x describe-tags resource-id=InstanceId:webserver
+.in
+.fi
+.sp
+will first translate the name "webserver" using the "InstanceId" map,
+and then will replace the entier "InstanceId:webserver" construct with
+the obtained identifier. See also
+.BR eclat-describe-tags (1).
+.PP
The name of the map to use can also be supplied explicitly, using the
\fI\-\-map\fR (\fI\-M\fR) option.
.PP

Return to:

Send suggestions and report system problems to the System administrator.