summaryrefslogtreecommitdiffabout
authorSergey Poznyakoff <gray@gnu.org.ua>2013-08-13 11:54:54 (GMT)
committer Sergey Poznyakoff <gray@gnu.org.ua>2013-08-13 11:54:54 (GMT)
commit493d76712aac4708e904c1a96926ca6a737a6d0b (patch) (side-by-side diff)
treec3d393f06ba743bd4fc03c24cec64b4e9b3220e6
parentceaa9f9d20f5db8b36d275fe65de43b95b090fc1 (diff)
downloadeclat-493d76712aac4708e904c1a96926ca6a737a6d0b.tar.gz
eclat-493d76712aac4708e904c1a96926ca6a737a6d0b.tar.bz2
Documentation: use .EX/.EE for examples.
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--doc/eclat-assocaddr.116
-rw-r--r--doc/eclat-atvol.18
-rw-r--r--doc/eclat-devol.18
-rw-r--r--doc/eclat-disasaddr.113
-rw-r--r--doc/eclat-lsaddr.18
-rw-r--r--doc/eclat-lsimg.16
-rw-r--r--doc/eclat-lsinst.18
-rw-r--r--doc/eclat-lsistat.18
-rw-r--r--doc/eclat-lsreg.18
-rw-r--r--doc/eclat-lssg.18
-rw-r--r--doc/eclat-lssnap.114
-rw-r--r--doc/eclat-lstag.123
-rw-r--r--doc/eclat-lsvol.120
-rw-r--r--doc/eclat-lszon.18
-rw-r--r--doc/eclat-mksnap.117
-rw-r--r--doc/eclat-mktag.112
-rw-r--r--doc/eclat-mkvol.18
-rw-r--r--doc/eclat-rmaddr.118
-rw-r--r--doc/eclat-rmtag.110
-rw-r--r--doc/eclat-setsattr.122
-rw-r--r--doc/eclat.1man46
-rw-r--r--doc/eclat.conf.5165
-rw-r--r--doc/lszon.18
23 files changed, 197 insertions, 265 deletions
diff --git a/doc/eclat-assocaddr.1 b/doc/eclat-assocaddr.1
index 0e2aee0..76a506f 100644
--- a/doc/eclat-assocaddr.1
+++ b/doc/eclat-assocaddr.1
@@ -60,16 +60,16 @@ is unable to recognize the response.
.SH EXAMPLES
.SS 1.
Assign an Elastic IP to the instance:
-.P
-.nf
-.B eclat assocaddr i\-2ea64347 192.0.2.1
-.fi
+.PP
+.EX
+eclat assocaddr i\-2ea64347 192.0.2.1
+.EE
.SS 2.
Associate an IP address with an instance in the VPC:
-.P
-.nf
-.B eclat assocaddr \-\-vpc i\-4fd2431a eipalloc\-5723d13e
-.fi
+.PP
+.EX
+eclat assocaddr \-\-vpc i\-4fd2431a eipalloc\-5723d13e
+.EE
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat\-mkaddr (1),
diff --git a/doc/eclat-atvol.1 b/doc/eclat-atvol.1
index 5d060c4..e6d364b 100644
--- a/doc/eclat-atvol.1
+++ b/doc/eclat-atvol.1
@@ -38,11 +38,11 @@ map. Finally, the
.I DEV\-NAME
argument specifies the name of the device to use for this volume.
.SH EXAMPLE
-.nf
-.sp 2
-$ \fBeclat atvol vol-12340156 i-40ed7ef3 /dev/xvdf\fR
+.PP
+.EX
+$ eclat atvol vol-12340156 i-40ed7ef3 /dev/xvdf
vol-12340156 attaching i-40ed7ef3 /dev/xvdf
-.fi
+.EE
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat-mkvol (1),
diff --git a/doc/eclat-devol.1 b/doc/eclat-devol.1
index e5356e6..2a2ac5e 100644
--- a/doc/eclat-devol.1
+++ b/doc/eclat-devol.1
@@ -39,11 +39,11 @@ map. Finally, the optional argument
.I DEV\-NAME
specifies the name of the device that refers to this volume.
.SH EXAMPLE
-.nf
-.sp 2
-$ \fBeclat devol vol-12340156 i-40ed7ef3 /dev/xvdf\fR
+.PP
+.EX
+$ eclat devol vol-12340156 i-40ed7ef3 /dev/xvdf
vol-12340156 detaching i-40ed7ef3 /dev/xvdf
-.fi
+.EE
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat-atvol (1),
diff --git a/doc/eclat-disasaddr.1 b/doc/eclat-disasaddr.1
index 8b465ee..f9c3e0f 100644
--- a/doc/eclat-disasaddr.1
+++ b/doc/eclat-disasaddr.1
@@ -40,15 +40,14 @@ is unable to recognize the response.
.SS 1.
Disassociate the Elastic IP:
.P
-.nf
-.B eclat disasaddr 192.0.2.1
-.fi
+.EX
+eclat disasaddr 192.0.2.1
+.EE
.SS 2.
-Disassociate the VPC Elastic IP:
.P
-.nf
-.B eclat disasaddr \-\-vpc eipalloc\-5723d13e
-.fi
+.EX
+eclat disasaddr \-\-vpc eipalloc\-5723d13e
+.EE
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat\-assocaddr (1).
diff --git a/doc/eclat-lsaddr.1 b/doc/eclat-lsaddr.1
index 2b43959..19fb8d8 100644
--- a/doc/eclat-lsaddr.1
+++ b/doc/eclat-lsaddr.1
@@ -64,14 +64,12 @@ associated with. For VPC addresses, additional five columns are
output: interface ID, interface owner ID, private IP address,
allocation ID and association ID.
.SH EXAMPLE
-.sp
-.nf
-.in +2
+.PP
+.EX
$ eclat lsaddr
standard 192.0.2.1 i-f15ebb98
standard 198.51.100.2
-.in
-.fi
+.EE
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat\-mkaddr (1),
diff --git a/doc/eclat-lsimg.1 b/doc/eclat-lsimg.1
index d4774a3..4d77bbf 100644
--- a/doc/eclat-lsimg.1
+++ b/doc/eclat-lsimg.1
@@ -168,11 +168,9 @@ See the comment above.
Selects images having the specified tag \fIKEY\fR set to the value
\fIVAL\fR. For example:
.sp
-.nf
-.in +2
+.EX
tag:Name="db server"
-.in
-.fi
+.EE
.TP
\fBvirtualization\-type\fR=\fBparavirtual\fR | \fBhvm\fR
.TP
diff --git a/doc/eclat-lsinst.1 b/doc/eclat-lsinst.1
index 8367c83..4461f39 100644
--- a/doc/eclat-lsinst.1
+++ b/doc/eclat-lsinst.1
@@ -297,9 +297,8 @@ stop to improve readablility.
.PP
Each instance description is prefaced by its reservation and owner IDs
and a list of groups it pertains to. For example:
-.sp
-.nf
-.in +2
+.PP
+.EX
Reservation ID: r\-0ece705a
Owner ID: 053230519467
Groups:
@@ -331,8 +330,7 @@ Instance: i\-7a00642e
Hypervisor: xen
EBS Optimized:
End of instance
-.in
-.fi
+.EE
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat\-lsiattr (1),
diff --git a/doc/eclat-lsistat.1 b/doc/eclat-lsistat.1
index 07ee9cb..324f38e 100644
--- a/doc/eclat-lsistat.1
+++ b/doc/eclat-lsistat.1
@@ -144,17 +144,15 @@ instance is running, system and instance status are also displayed.
If any events are reported, they are output on the standard error.
.SH EXAMPLE
In the example below the long lines are split for readability:
-.sp
-.nf
-.in +2
+.PP
+.EX
$ eclat lsistat \-a
i\-283f9f47 us\-east\-1d running impaired\
Sys.reachability=failed Inst.reachability=failed
i\-283f9f47 Event: "The instance is running on degraded hardware"
i\-d2e36dbd us\-east\-1d running ok\
Sys.reachability=passed Inst.reachability=passed
-.in
-.fi
+.EE
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat\-lsinst (1),
diff --git a/doc/eclat-lsreg.1 b/doc/eclat-lsreg.1
index d532031..c0880dc 100644
--- a/doc/eclat-lsreg.1
+++ b/doc/eclat-lsreg.1
@@ -39,9 +39,9 @@ The default output shows one region per line. Each line of output
contains region name and corresponding endpoint, separated by a single
horizontal tab character.
.SH EXAMPLE
-.nf
-.sp 2
-$ \fBeclat lsreg\fR
+.PP
+.EX
+$ eclat lsreg
eu-west-1 ec2.eu-west-1.amazonaws.com
sa-east-1 ec2.sa-east-1.amazonaws.com
us-east-1 ec2.us-east-1.amazonaws.com
@@ -50,7 +50,7 @@ us-west-2 ec2.us-west-2.amazonaws.com
us-west-1 ec2.us-west-1.amazonaws.com
ap-southeast-1 ec2.ap-southeast-1.amazonaws.com
ap-southeast-2 ec2.ap-southeast-2.amazonaws.com
-.fi
+.EE
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat\-describe\-availability\-zones (1).
diff --git a/doc/eclat-lssg.1 b/doc/eclat-lssg.1
index 92f6f53..1f1cfb1 100644
--- a/doc/eclat-lssg.1
+++ b/doc/eclat-lssg.1
@@ -94,9 +94,8 @@ describe the VPC ID and tags (if any). Tags are listed in as
\fBkey\fB=\fBvalue\fR pairs, each on a separate line and indented by
one tabstop. The lines that follow list the rules for incoming and
outgoing traffic. E.g.:
-.sp
-.nf
-.in +2
+.PP
+.EX
Group sg\-443d0a12 WebServers "Web Servers"
VPC ID:
Incoming:
@@ -107,8 +106,7 @@ VPC ID:
Incoming:
user 111122223333, group sg\-99gh4012 ("Group B") 6000\-7000
Outgoing:
-.in
-.fi
+.EE
.SH "SEE ALSO"
.BR eclat (1).
.SH AUTHORS
diff --git a/doc/eclat-lssnap.1 b/doc/eclat-lssnap.1
index 37b4673..0c1cc71 100644
--- a/doc/eclat-lssnap.1
+++ b/doc/eclat-lssnap.1
@@ -105,11 +105,9 @@ See the comment above.
Selects the snapshots having the specified tag \fIKEY\fR set to the value
\fIVAL\fR. For example:
.sp
-.nf
-.in +2
+.EX
tag:Name="root snapshot"
-.in
-.fi
+.EE
.TP
\fBvolume\-id\fR=\fIstring\fR
The ID of the volume the snapshot is for.
@@ -127,16 +125,14 @@ If the snapshot has associated tags, these are listed below that line,
each tag on a separate line, prefixed by a single \fBTAB\fR character.
.PP
For example (long lines split for readability):
-.sp
-.nf
-.in +2
+.PP
+.EX
snap\-78a54011 vol\-4d826724 10 pending 80% 2012\-05\-07T12:51:50.000Z \
"Daily Backup"
snap\-12345678 vol\-4d826724 10 completed 100% 2012\-04\-07T00:00:00.000Z
comment="Taken before switching to new kernel"
rand=E34AF890
-.in
-.fi
+.EE
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat\-rmsnap (1),
diff --git a/doc/eclat-lstag.1 b/doc/eclat-lstag.1
index 8a6667c..2b5c9eb 100644
--- a/doc/eclat-lstag.1
+++ b/doc/eclat-lstag.1
@@ -67,12 +67,9 @@ section in
each ID can be prefixed with the map name and a colon in order to
request its translation using this map. For example:
.sp
-.nf
-.in +2
+.EX
eclat \-x lstag resource\-id=InstanceId:webserver
-.in
-.fi
-.sp
+.EE
.TP
\fBresource\-type\fR=\fItype\fR
List only tags pertaining to resources of the given \fItype\fR. Valid
@@ -87,23 +84,19 @@ Lists tags with the given value.
.SH OUTPUT
The default output format lists on each line the resource ID, its
type, the tag name and its value. For example:
-.sp
-.nf
-.in +2
+.PP
+.EX
ami-1a2b3c4d image webserver
ami-1a2b3c4d image stack Production
i-5f4e3d2a instance webserver
i-5f4e3d2a instance stack Production
i-12345678 instance database_server
-.in
-.fi
+.EE
.SH EXAMPLE
-.sp
-.nf
-.in +2
+.PP
+.EX
eclat lstag resource-id=i-5f4e3d2a key=Name
-.in
-.fi
+.EE
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat\-mktag (1),
diff --git a/doc/eclat-lsvol.1 b/doc/eclat-lsvol.1
index 4f044da..0125f27 100644
--- a/doc/eclat-lsvol.1
+++ b/doc/eclat-lsvol.1
@@ -88,11 +88,9 @@ See the comment above.
Selects the snapshots having the specified tag \fIKEY\fR set to the value
\fIVAL\fR. For example:
.sp
-.nf
-.in +2
+.EX
tag:Name="root partition"
-.in
-.fi
+.EE
.TP
\fBvolume\-id\fR=\fIID\fR
The volume ID. This filter has the same effect as specifying \fIID\fR
@@ -100,11 +98,9 @@ as the command line argument. It is needed mostly when you use ID
mapping but wish to identify some modules by their IDs and another by
their symbolic name, e.g.:
.sp
-.nf
-.in +2
+.EX
eclat \-x lsvol root volume\-id=vol\-1aeb5008 srv
-.in
-.fi
+.EE
.TP
\fBvolume\-type\fR=\fIvalue\fR
The Amazon EBS volume type. Valid values are
@@ -118,12 +114,10 @@ in GiB, and status. Following this, volume attachments are
described. Each attachment consists of four fields: the volume ID,
the ID of the instance it is attached to, the device name it is known
as, and the attachment status. For example:
-.sp
-.nf
-.in +2
+.PP
+.EX
vol\-4282672b 80 in\-use vol\-4282672b i\-6058a509 /dev/sdh attached
-.in
-.fi
+.EE
.SH "SEE ALSO"
.BR eclat (1).
.SH AUTHORS
diff --git a/doc/eclat-lszon.1 b/doc/eclat-lszon.1
index b7e7141..f2dbfd1 100644
--- a/doc/eclat-lszon.1
+++ b/doc/eclat-lszon.1
@@ -58,13 +58,13 @@ character.
If there are any messages associated with the zone, these are printed
in subsequent lines. Each message is indented one tab stop.
.SH EXAMPLE
-.nf
-.sp 2
-$ \fBeclat lszon\fR
+.PP
+.EX
+$ eclat lszon
eu-west-1a available
eu-west-1b available
eu-west-1c available
-.fi
+.EE
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat\-lsreg (1).
diff --git a/doc/eclat-mksnap.1 b/doc/eclat-mksnap.1
index cffa398..47199a5 100644
--- a/doc/eclat-mksnap.1
+++ b/doc/eclat-mksnap.1
@@ -34,20 +34,15 @@ the corresponding identifier.
The default output shows the ID of the snapshot and the volume, the size
of the volume in gigabytes, the state of the snapshot, its completion
percentage and creation time, e.g.:
-.sp
-.nf
-.in +2
+.PP
+.EX
snap\-78a54011 vol\-4d826724 10 pending 60% 2008\-05\-07T12:51:50.000Z
-.in
-.fi
+.EE
.SH EXAMPLE
-.sp
-.nf
-.in +2
+.EX
eclat mksnap vol\-4d826724 Full backup
-.in
-.fi
-.sp
+.EE
+.PP
Note that it is not necessary to quote the description.
.SH "SEE ALSO"
.BR eclat (1),
diff --git a/doc/eclat-mktag.1 b/doc/eclat-mktag.1
index 919fa79..99d0842 100644
--- a/doc/eclat-mktag.1
+++ b/doc/eclat-mktag.1
@@ -85,11 +85,9 @@ error.
.IP \n[step].
Create two tags for an instance:
.sp
-.nf
-.in +2
+.EX
eclat mktag \-i i\-12345678 Name=Webserver test
-.in
-.fi
+.EE
.sp
This command creates two tags for instance \fBi\-12345678\fR: the tag
\fBName\fR with the value \fBWebserver\fR and tag \fBtest\fR with
@@ -97,15 +95,13 @@ empty value.
.IP \n+[step].
Copy tags between instances:
.sp
-.nf
-.in +2
+.EX
eclat -e 'if (.DescribeTagsResponse)
for (var in .DescribeTagsResponse.tagSet.item)
print(var.key,"=",var.value,"\\n");' \\
lstag resource\-id=i\-12345678 |
eclat mktag \-i i\-fe2345ed \-T \-
-.in
-.fi
+.EE
.sp
This example uses the
.B lstag
diff --git a/doc/eclat-mkvol.1 b/doc/eclat-mkvol.1
index 6bb91b6..7db4733 100644
--- a/doc/eclat-mkvol.1
+++ b/doc/eclat-mkvol.1
@@ -36,11 +36,11 @@ The snapshot ID from which to create the new volume.
On success, the default format prints the ID of the created volume and
its status.
.SH EXAMPLE
-.nf
-.sp 2
-$ \fBeclat mkvol 80 eu-west-1b\fR
+.PP
+.EX
+$ eclat mkvol 80 eu-west-1b
vol-de1203fa creating
-.fi
+.EE
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat\-rmvol (1),
diff --git a/doc/eclat-rmaddr.1 b/doc/eclat-rmaddr.1
index 16aeb4f..065f4a1 100644
--- a/doc/eclat-rmaddr.1
+++ b/doc/eclat-rmaddr.1
@@ -45,22 +45,22 @@ The code 16 is returned if the operation is not confirmed.
.SS 1.
Release the Elastic IP:
.P
-.nf
-.B $ eclat rmaddr 192.0.2.1
+.EX
+$ eclat rmaddr 192.0.2.1
Really release IP 192.0.2.1 [Y/n] y
-.fi
+.EE
.SS 2.
Same, with confirmation disabled:
.P
-.nf
-.B $ eclat -Y rmaddr 192.0.2.1
-.fi
+.EX
+$ eclat -Y rmaddr 192.0.2.1
+.EE
.SS 3.
Release the VPC Elastic IP:
.P
-.nf
-.B eclat rmaddr \-\-vpc eipalloc\-5723d13e
-.fi
+.EX
+eclat rmaddr \-\-vpc eipalloc\-5723d13e
+.EE
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat\-mkaddr (1),
diff --git a/doc/eclat-rmtag.1 b/doc/eclat-rmtag.1
index 94ffd11..90a3f4f 100644
--- a/doc/eclat-rmtag.1
+++ b/doc/eclat-rmtag.1
@@ -79,13 +79,11 @@ 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
+.PP
+.EX
eclat rmtag \-i i\-12345678 Name=Webserver test
-.in
-.fi
-.sp
+.EE
+.PP
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.
diff --git a/doc/eclat-setsattr.1 b/doc/eclat-setsattr.1
index 5a0260e..9416718 100644
--- a/doc/eclat-setsattr.1
+++ b/doc/eclat-setsattr.1
@@ -37,23 +37,19 @@ consists of a letter indicating the identity (\fBu\fR for user or
\fBg\fR for group), followed by a plus sign to grant permission or a
minus sign to revoke it, and an ID of the identity. For example, the
command
-.sp
-.nf
-.in +2
-.B eclat setsattr u+111122223333 snap-1a2b3c4d
-.in
-.fi
-.sp
+.PP
+.EX
+eclat setsattr u+111122223333 snap-1a2b3c4d
+.EE
+.PP
gives the account with ID \fB111122223333\fR permission to create volumes
from the snapshot.
.PP
Several operations can be requested in a single invocation, e.g.:
-.sp
-.nf
-.in +2
-.B eclat setsattr g+all u-111122223333 snap-1a2b3c4d
-.in
-.fi
+.PP
+.EX
+eclat setsattr g+all u-111122223333 snap-1a2b3c4d
+.EE
.PP
The above example makes the snapshot public (\fBg+all\fR) and revokes
the permission to create volumes from it from the account
diff --git a/doc/eclat.1man b/doc/eclat.1man
index e63df2b..ebcc122 100644
--- a/doc/eclat.1man
+++ b/doc/eclat.1man
@@ -144,13 +144,11 @@ its
.BR identifier .
Identifiers provide a means for indicating the resource to operate
upon. For example, the command
-.sp
-.nf
-.in +2
-.B eclat start i\-1234beef
-.in
-.fi
-.sp
+.PP
+.EX
+eclat start i\-1234beef
+.EE
+.PP
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
@@ -185,13 +183,11 @@ be used.
For commands that support the \fBresource\-id\fR 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
-.B eclat \-x lstag resource\-id=InstanceId:webserver
-.in
-.fi
-.sp
+.PP
+.EX
+eclat \-x lstag resource\-id=InstanceId:webserver
+.EE
+.PP
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
@@ -217,9 +213,9 @@ commands are preferred instead, e.g. in shell scripts. Nevertheless,
any non\-ambiguous abbreviation can be used in place of a full EC2
command name. Moreover, each segment (i.e. the sequence of characters
delimited by dashes), can be abbreviated independently. For example,
-\fBd\-t\fR matches \fBdescribe-tags\fR, whereas \fBd\-i\fR matches three command names:
-\fBdescribe-instance-attribute\fR, \fBdescribe-instance-status\fR and
-\fBdescribe-instances\fR.
+\fBd\-t\fR matches \fBdescribe\-tags\fR, whereas \fBd\-i\fR matches three command names:
+\fBdescribe\-instance\-attribute\fR, \fBdescribe\-instance\-status\fR and
+\fBdescribe\-instances\fR.
If an ambiguous abbreviation is supplied,
.B eclat
will print a list of matching command names on the standard error and
@@ -237,13 +233,11 @@ files) in
For example, if your package is installed to the
.B /usr
prefix, include this line in your bash startup:
-.sp
-.nf
-.in +2
+.PP
+.EX
\. /usr/share/eclat/compl.sh
-.in
-.fi
-.sp
+.EE
+.PP
With the completion facility enabled, hitting
.B TAB
after a partial command name will show you the list of possible
@@ -323,10 +317,10 @@ This option is intended to help in generating documentation listings.
For example, the command listing above was produced using the
following command:
.sp
-.nf
.in +4
-.B eclat \-l '\\\\t\\\\\\\\fB%n\\\\\\\\fR\\\\t\\\\\\\\fB%i\\\\\\\\fR\\\\n' | sed 's/\-/\\\\\-/g'
-.fi
+.EX
+eclat \-l '\\\\t\\\\\\\\fB%n\\\\\\\\fR\\\\t\\\\\\\\fB%i\\\\\\\\fR\\\\n' | sed 's/\-/\\\\\-/g'
+.EE
.TP
\fB\-\-match\-commands\fR, \fB\-m\fR
Print matching command names and exit. This option is intended for
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).
diff --git a/doc/lszon.1 b/doc/lszon.1
index d0900b6..9605c4c 100644
--- a/doc/lszon.1
+++ b/doc/lszon.1
@@ -58,13 +58,13 @@ character.
If there are any messages associated with the zone, these are printed
in subsequent lines. Each message is indented one tab stop.
.SH EXAMPLE
-.nf
-.sp 2
-$ \fBeclat describe\-availability\-zones\fR
+.PP
+.EX
+$ eclat describe\-availability\-zones
eu-west-1a available
eu-west-1b available
eu-west-1c available
-.fi
+.EE
.SH "SEE ALSO"
.BR eclat (1),
.BR eclat\-lsreg (1).

Return to:

Send suggestions and report system problems to the System administrator.