aboutsummaryrefslogtreecommitdiff
path: root/doc/eclat-rmtag.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/eclat-rmtag.1')
-rw-r--r--doc/eclat-rmtag.1116
1 files changed, 116 insertions, 0 deletions
diff --git a/doc/eclat-rmtag.1 b/doc/eclat-rmtag.1
new file mode 100644
index 0000000..8e205c2
--- /dev/null
+++ b/doc/eclat-rmtag.1
@@ -0,0 +1,116 @@
+.\" 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 RMTAG 1 "January 24, 2013" "ECLAT" "Eclat User Reference"
+.SH NAME
+eclat rmtag \- delete or replace tags for a resource
+.SH SYNOPSIS
+\fBeclat rmtag\fR [\fB\-a\fR \fIID\fR] [\fB\-i\fR \fIID\fR]\
+ [\fB\-r\fR [\fIMAP\fR:]\fIID\fR] [\fB\-s \fIID\fR] [\fB\-v\fR \fIID\fR]
+ [\fB\-T\fR \fIFILE\fR]
+ [\fB\-\-ami\fR \fIID\fR] [\fB\-\-instance\fR \fIID\fR] [\fB\-\-resource\-id\fR [\fIMAP\fR:]\fIID\fR]
+ [\fB\-\-volume\fR \fIID\fR] [\fB\-\-snapshot\fR \fIID\fR]
+ [\fB\-\-from\-file\fR \fIFILE\fR] [\fITAG\fR[=\fIVAL\fR]...]
+
+\fBeclat rmtag\fR \fB\-\-help\fR
+.SH DESCRIPTION
+This command deletes tags from a given resource. The names of tags to
+delete are supplied in the command line. If a tag name is followed by
+an equals sign and a value, it will be deleted only if both its name and value
+are the same as the supplied ones. Otherwise, the tag will be deleted
+regardless of its value.
+.PP
+If no tag names are given, all tags are deleted.
+.PP
+The resource to delete tags from is supplied with one of the
+options. The resource designation must be present.
+.PP
+If ID mapping is enabled (see the section \fBMAPS\fR
+in
+.BR eclat (1)),
+all options except \fB\-r\fR (\fB\-\-resource\-id\fR) translate their
+arguments using corresponding maps (see
+.B OPTIONS
+below). The \fB\-r\fR (\fB\-\-resource\-id\fR) option uses no map by
+default, unless the map name is specified explicitly before the ID.
+.SH OPTIONS
+.TP
+\fB\-a\fR, \fB\-\-ami\fR \fIID\fR
+Deletes tags from the given image. In resource translation mode, uses
+the map \fBImageId\fR.
+.TP
+\fB\-i\fR, \fB\-\-instance\fR \fIID\fR
+Deletes tags from the given instance. In resource translation mode, uses
+the map \fBInstanceId\fR.
+.TP
+\fB\-r\fR, \fB\-\-resource\-id\fR [\fIMAP\fR:]\fIID\fR
+Deletes tags from the EC2 resource identified by \fIID\fR. If optional
+\fIMAP\fR prefix is supplied and resource translation mode is enabled,
+this option will use the \fIMAP\fR to translate \fIID\fR into AWS
+resource identifier.
+.TP
+\fB\-T\fR, \fB\-\-from\-file\fR \fIFILE\fR
+Reads tags from \fIFILE\fR or from the standard input, if \fIFILE\fR
+is \fB\-\fR. Empty lines and lines beginning with \fB#\fR are
+ignored. Non-empty lines must contain either a tag name alone, or a
+tag name and the corresponding value, separated by an equals sign. If
+the value is enclosed in double quotes, these will be removed and any
+escaped characters within the value translated to their corresponding
+equivalents using shell rules (e.g. \fB\\\(dq\fR becomes \fB\(dq\fR,
+etc).
+.TP
+\fB\-v\fR, \fB\-\-volume\fR \fIID\fR
+Deletes tags from the given volume. In resource translation mode, uses
+the map \fBVolumeId\fR.
+.SH OUTPUT
+By default the command does not output anything, unless an error
+occurs in which case the error diagnostics is printed on the standard
+error.
+.SH EXAMPLE
+.sp
+.nf
+.in +2
+eclat rmtag \-i i\-12345678 Name=Webserver test
+.in
+.fi
+.sp
+This command deletes two tags from the instance \fBi\-12345678\fR: the tag
+\fBName\fR, if it has the value \fBWebserver\fR and tag \fBtest\fR,
+no matter what its value is.
+.SH "SEE ALSO"
+.BR eclat (1),
+.BR eclat\-mktag (1),
+.BR eclat\-lstag (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.