summaryrefslogtreecommitdiffabout
path: root/README
blob: dfbaccf93afee32d18fa7ad2186757d3cc87d398 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
Eclat README
Copyright (C) 2012-2014 Sergey Poznyakoff
See the end of file for copying conditions.

* Introduction

Eclat stands for EC2 Command Line Administrator Tool.  It allows you to
manage Amazon EC2 services from the command line, fast and easy.  It does
not require resource-consuming libraries.  It is written in plain C,
depends only on libraries which are always installed on any decent system,
and has low resource requirements.

* Actions

So far about 27% of EC2 actions is implemented.  The set of actions is
somewhat arbitrary and reflects my needs.  See the file TODO for the
detailed list of actions and their status.  I will be adding new
actions as the need arises and my time permits.  Given that the Eclat
framework in now mature and well established, implementing a new
action is quite straightforward and simple.  If you are interested in
a particular action, drop me a note and I'll try to implement it out
of schedule (see the email at the end of this document).

* Documentation

Documentation in manpage format is available in the subdirectory doc.
It is installed as usual after make install.

Online copy of the documentation is available at

  http://www.gnu.org.ua/software/eclat/manual.html

* Building

The following libraries are needed for Eclat:

* Curl, available from <http://curl.haxx.se>.
* Expat, avaliable from <http://www.libexpat.org>.

To compile, run the usual encantation:

 ./configure
 make
 make install

For information about the configure script and its generic options, refer to
the file INSTALL included in the distribution.

The following options are specific to this package:

 --enable-split-format
   
   Create a separate format file for each particular command.  By default
   the installation procedure builds a single file, which contains
   instructions for each command supported by eclat.  Use this option if
   you wish to use separate files instead.

 --with-gdbm
 --without-gdbm

   Build (don't build) GDBM translation map.  By default it is built
   if GNU DBM library and header file are present on the system.
   Specifying --without-gdbm instructs configure not to build GDBM
   translation map.  The --with-gdbm option forces configure to abort
   if GDBM is not present.
   
** Shell completion

To facilitate the use of the tool, the package includes a Bash script
that implements completion for Eclat commands.  The script is named
compl.sh and is installed in pkgdatadir.  To use it, source compl.sh
from your profile or bash startup file (either per-user or system-wide one,
at your option).  For example, if the package is configured with /usr
as its prefix, add the following line

  . /usr/share/eclat/compl.sh

Once done, you can use TAB to complete a partially typed command name.

* Bug reporting.		

Send bug reports, propositions and action requests to
<bug-eclat@gnu.org.ua>.


* Copyright information:

Copyright (C) 2012, 2013 Sergey Poznyakoff

   Permission is granted to anyone to make or distribute verbatim copies
   of this document as received, in any medium, provided that the
   copyright notice and this permission notice are preserved,
   thus giving the recipient permission to redistribute in turn.

   Permission is granted to distribute modified versions
   of this document, or of portions of it,
   under the above conditions, provided also that they
   carry prominent notices stating who last changed them.


Local Variables:
mode: outline
paragraph-separate: "[ 	]*$"
version-control: never
End:

Return to:

Send suggestions and report system problems to the System administrator.