aboutsummaryrefslogtreecommitdiff
path: root/doc/eclat.conf.5
diff options
context:
space:
mode:
Diffstat (limited to 'doc/eclat.conf.5')
-rw-r--r--doc/eclat.conf.5165
1 files changed, 73 insertions, 92 deletions
diff --git a/doc/eclat.conf.5 b/doc/eclat.conf.5
index 8905450..35d0967 100644
--- a/doc/eclat.conf.5
+++ b/doc/eclat.conf.5
@@ -38,10 +38,10 @@ or
and continue to the end of the line:
.sp
.RS 4
-.nf
+.EX
# This is a comment
// This too is a comment
-.fi
+.EE
.RE
.PP
\fIMulti-line\fB or \fIC-style\fR comments start with the two
@@ -121,9 +121,10 @@ with a semicolon (\fB;\fR).
The following is a simple statement:
.sp
.RS 4
-.nf
+.EX
standalone yes;
pidfile /var/run/slb.pid;
+.EE
.RE
.fi
.PP
@@ -132,11 +133,10 @@ decimal digits, underscores (\fB_\fR) and dashes (\fB\-\fR).
Examples of keywords are:
.sp
.RS 4
-.nf
+.EX
region
format\-file
-.RE
-.fi
+.EE
.PP
A \fIvalue\fR can be one of the following:
.TP
@@ -175,10 +175,10 @@ In addition, the sequence \fB\\\fInewline\fR is removed from
the string. This allows to split long strings over several
physical lines, e.g.:
.sp
-.nf
+.EX
"a long string may be\\
split over several lines"
-.fi
+.EE
.sp
If the character following a backslash is not one of those specified
above, the backslash is ignored and a warning is issued.
@@ -188,10 +188,10 @@ another way to split long strings over several lines to improve
readability. The following fragment produces the same result as the
example above:
.sp
-.nf
+.EX
"a long string may be"
" split over several lines"
-.fi
+.EE
.TP
.I Here-document
A \fIhere-document\fR is a special construct that allows to introduce
@@ -204,12 +204,12 @@ the line containing only \fIword\fR, with possible trailing blanks.
Any lines thus read are concatenated together into a single string.
For example:
.sp
-.nf
+.EX
<<EOT
A multiline
string
EOT
-.fi
+.EE
.sp
The body of a here-document is interpreted the same way as a
double\-quoted string, unless \fIword\fR is preceded by a backslash
@@ -222,12 +222,12 @@ tab characters are stripped from input lines and the line containing
all leading whitespace is stripped from them. This allows to indent
here-documents in a natural fashion. For example:
.sp
-.nf
+.EX
<<\- TEXT
The leading whitespace will be
ignored when reading these lines.
TEXT
-.fi
+.EE
.sp
It is important that the terminating delimiter be the only token on
its line. The only exception to this rule is allowed if a
@@ -235,33 +235,33 @@ here-document appears as the last element of a statement. In this
case a semicolon can be placed on the same line with its terminating
delimiter, as in:
.sp
-.nf
+.EX
help\-text <<\-EOT
A sample help text.
EOT;
-.fi
+.EE
.TP
.I list
A comma-separated list of values, enclosed in parentheses. The
following example shows a statement whose value is a list of strings:
.sp
-.nf
+.EX
alias (test, null);
-.fi
+.EE
.sp
In any context where a list is appropriate, a single value is allowed
without being a member of a list: it is equivalent to a list with a
single member. This means that, e.g.
.sp
-.nf
+.EX
alias test;
-.fi
+.EE
.sp
is equivalent to
.sp
-.nf
+.EX
alias (test);
-.fi
+.EE
.sp
provided that the \fBalias\fR statement is defined as taking a list as
its argument.
@@ -272,12 +272,12 @@ statements. It consists of a keyword, followed by an optional value,
called a \fBtag\fR, and a sequence of statements enclosed in curly
braces, as shown in the example below:
.sp
-.nf
+.EX
map InstanceId {
type gdbm;
file "instances.txt";
}
-.fi
+.EE
.sp
The closing curly brace may be followed by a semicolon, although
this is not required.
@@ -365,9 +365,8 @@ option and \fBdefault\-region\fR statement.
Declares a region and the corresponding endpoint.
.PP
An example of the EC2 endpoint configuration follows:
-.sp
-.nf
-.in +2
+.PP
+.EX
# Use this endpoint by default.
default\-endpoint "ec2.amazonaws.com";
# Declare what endpoints to use for each availability region:
@@ -375,8 +374,7 @@ default\-endpoint "ec2.amazonaws.com";
region us\-east\-1 ec2.us\-east\-1.amazonaws.com;
# US West (Oregon) Region
region us\-west\-2 ec2.us\-west\-2.amazonaws.com;
-.in
-.fi
+.EE
.SS ACCESS CREDENTIALS
Access credentials for Amazon accounts are stored in a so-called
\fBaccess-file\fR. See the section
@@ -404,17 +402,15 @@ Enables SSL.
.PP
The block form allows for more detailed control over the SSL
configuration:
-.sp
-.nf
-.in +2
+.PP
+.EX
ssl {
enable \fIbool\fR;
verify \fIboolean\fR;
ca\-file \fIfile\fR;
ca\-path \fIdirectory\fR;
}
-.in
-.fi
+.EE
.PP
Its statements are:
.TP
@@ -458,8 +454,7 @@ for a detailed description of the forlan syntax.
It is common practice to use the "here-document" syntax with this
statement, as shown in the example below:
.sp
-.nf
-.in +2
+.EX
format "DescribeTags" <<EOT
if (.DescribeTagsResponse) {
for (var in .DescribeTagsResponse.tagSet.item) {
@@ -470,8 +465,7 @@ format "DescribeTags" <<EOT
}
}
EOT;
-.in
-.fi
+.EE
.TP
\fBdefine\-format\fR \fIname\fR \fItext\fR;
Defines a new format and assigns \fIname\fR to it. This format can
@@ -496,11 +490,9 @@ Replaced with the corresponding Amazon action name.
These macros allow you to have separate format files for each EC2
request. For example:
.sp
-.nf
-.in +2
+.EX
format\-file "/usr/share/eclat/$command.forlan";
-.in
-.fi
+.EE
.sp
Given this statement, the command \fBeclat lstag\fR, for
instance, will read configuration from file
@@ -547,7 +539,6 @@ command is requested. This is configured by the
statement:
.PP
.nf
-.in +2
\fBconfirm\fR \fImode\fR \fBcommand\fR;
\fBconfirm\fR \fImode\fR (\fBcommand\fR[, \fBcommand\fR...]);
\fBconfirm\fR \fImode\fR \fIclass\fR;
@@ -584,11 +575,10 @@ Commands that destructively modify resources.
.PP
Consider the following example:
.PP
-.nf
-.in +2
+.EX
confirm tty destructive;
confirm tty (StopInstance, StartInstance);
-.fi
+.EE
.PP
It instructs
.B eclat
@@ -599,11 +589,10 @@ Here is an example of how this modifies the behavior of
.B rmaddr
command:
.PP
-.nf
-.if +2
-$ \fBeclat rmaddr 192.168.0.1\fR
+.EX
+$ eclat rmaddr 192.168.0.1
Proceed with release-address [Y/n] _
-.fi
+.EE
.PP
If the response begins with \fBY\fR (case-insensitive), it is taken
for a positive answer, and the command will be executed. Otherwise,
@@ -615,10 +604,9 @@ The current confirmation setting can be overridden using the \fB\-Y\fR
former forces \fBpositive\fN and the latter \fBnegative\fR
confirmation mode for the requested command, e.g.:
.PP
-.nf
-.in +2
-$ \fBeclat -Y rmvol vol-d1234aef\fR
-.fi
+.EX
+$ eclat -Y rmvol vol-d1234aef
+.EE
.SH MAPS
Maps provide a way to translate arbitrary symbolic names to the Amazon
resource identifiers. See the section
@@ -633,15 +621,14 @@ Depending on its argument, enables or disables ID translation by
default.
.PP
A map is declared using the following statement:
-.sp
-.nf
-.in +4
+.PP
+.EX
\fBmap\fR \fIname\fR {
\fBtype\fR \fIbackend\-type\fR;
\fBkey\fR \fItrans\fR;
/* \fIType-specific statements.\fR */
}
-.fi
+.EE
.PP
The \fIname\fR argument is used to identify the map. A map can be
used from the command line using the \fB\--map=\fIname\fR option. The
@@ -689,11 +676,9 @@ The name of this map.
The null map always returns the key value (eventually modified using
the \fBkey\fR statement). It is configured by setting
.sp
-.nf
-.in +2
+.EX
type null;
-.in
-.fi
+.EE
.sp
in the corresponding \fBmap\fR section.
.SS FILE MAP
@@ -704,24 +689,22 @@ separated by a colon. Both key and value are taken verbatim,
including any whitespace characters, if such are present. Following
is an example of the file map, which defines two instance names:
.sp
-.nf
-.in +2
+.EX
# Database server
dbserver:i\-3456aefd
# Access server
access:i\-deadbeef
-.in
-.fi
+.EE
.PP
The file map is declared using the following syntax:
-.sp
-.nf
+.PP
+.EX
map \fIname\fR {
type file;
key \fItrans\fR;
file \fIfilename\fR;
}
-.fi
+.EE
.PP
The only type-specific statement is:
.TP
@@ -731,15 +714,15 @@ Defines the name of the file to read the map from.
GDBM map, as its name implies, looks up the data in a
.BR gdbm (3)
database. It is defined using the following statement:
-.sp
-.nf
+.PP
+.EX
map \fIname\fR {
type gdbm;
key \fItrans\fR;
file \fIfilename\fR;
null \fIbool\fR;
}
-.fi
+.EE
.TP
\fBfile\fR \fIfilename\fR
Defines the name of the database file to use.
@@ -754,15 +737,14 @@ Maps of this type consult several other
maps in sequence, using return value from the previous map as a
key to the subsequent one. The map returns the value produced by the
last map in sequence.
-.sp
-.nf
+.PP
+.EX
map \fIname\fR {
type sequence;
key \fItrans\fR;
sequence \fImaps\fR;
}
-.fi
-.sp
+.EE
.TP
\fBsequence\fR \fImaps\fR
This statement defines the sequence of maps to query. Its argument is
@@ -771,29 +753,29 @@ elsewhere in the configuration file (not necessarily before the
sequence map that references them.
.PP
For example:
-.sp
-.nf
+.PP
+.EX
map InstanceId {
type sequence;
sequence (keytab, instancetab);
}
-.fi
-.sp
+.EE
+.PP
If the sequence consists of a single element, such a map is
effectively an alias to the map named by that element:
-.sp
-.nf
+.PP
+.EX
map i {
type sequence;
sequence InstanceId;
}
-.fi
+.EE
.sp
.SS LDAP MAP
This map uses LDAP database to translate names. It is defined using
the following syntax:
.sp
-.nf
+.EX
map <name: string> {
type ldap;
key \fItrans\fR;
@@ -809,7 +791,7 @@ the following syntax:
attr \fIstring\fR;
debug \fInumber\fR;
}
-.fi
+.EE
.sp
.TP
\fBldap\-version\fR \fIn\fR
@@ -873,8 +855,8 @@ This map makes it possible to use \fBEC2\fR services to translate
identifiers. The idea is to query \fBEC2\fR using the symbolic ID and
obtain the real resource ID from the request. The map is defined as
follows:
-.sp
-.nf
+.PP
+.EX
map <name: string> {
type ec2;
key \fItrans\fR;
@@ -882,7 +864,7 @@ follows:
arguments \fIarg-list\fR;
return \fIreturn-path\fR;
}
-.fi
+.EE
.sp
.TP
\fBaction\fR \fIaction-name\fR
@@ -899,9 +881,8 @@ Defines the return value, using a path notation.
.PP
The example below illustrates the use of the \fBDescribeImages\fR
action to implement the \fBImageId\fR map:
-.sp
-.nf
- map "ImageId" {
+.PP
+.EX
type ec2;
action DescribeImages;
arguments ("Owner.1=self",
@@ -909,7 +890,7 @@ action to implement the \fBImageId\fR map:
"Filter.1.Value.1=${key}");
return ".DescribeImagesResponse.imagesSet.item.imageId";
}
-.fi
+.EE
.SH "SEE ALSO"
.BR eclat (1),
.BR m4 (1).

Return to:

Send suggestions and report system problems to the System administrator.