Tue, 12 Jan 2010 02:19:19 +0000
squishy: Add the new command modules
6 | 1 | # clix - Command-line XMPP tool |
2 | ||
3 | ## Description | |
4 | Clix is a small utility to interact with an XMPP server. It can be | |
5 | used to send messages, presence, and info queries to any XMPP address. | |
6 | ||
7 | ## Example | |
8 | clix message --to=user@example.com "The kettle has now boiled" | |
9 | ||
10 | ## Usage | |
11 | Syntax: clix COMMAND [OPTIONS] [...] | |
12 | ||
13 | Different commands accept different sets of options, but they all | |
14 | follow some general conventions. The command must be the first | |
15 | parameter, followed by a series of flags or options. Global options | |
16 | include: | |
17 | ||
18 | --account=default | |
19 | The account to use from the configuration file (default | |
20 | is 'default') | |
21 | ||
22 | -v | |
23 | --verbose | |
24 | Enables verbose logging of the XMPP connection | |
25 | ||
26 | When no command is specified, clix will print a list of the names | |
27 | and descriptions of all built-in commands. | |
28 | ||
10
49b83fa1f6fd
README: Add config file example
Matthew Wild <mwild1@gmail.com>
parents:
6
diff
changeset
|
29 | ## Configuration |
49b83fa1f6fd
README: Add config file example
Matthew Wild <mwild1@gmail.com>
parents:
6
diff
changeset
|
30 | Clix looks for its config file at $HOME/.clix - it is a simple 'ini' |
49b83fa1f6fd
README: Add config file example
Matthew Wild <mwild1@gmail.com>
parents:
6
diff
changeset
|
31 | format, which looks like this: |
49b83fa1f6fd
README: Add config file example
Matthew Wild <mwild1@gmail.com>
parents:
6
diff
changeset
|
32 | |
49b83fa1f6fd
README: Add config file example
Matthew Wild <mwild1@gmail.com>
parents:
6
diff
changeset
|
33 | [default] |
49b83fa1f6fd
README: Add config file example
Matthew Wild <mwild1@gmail.com>
parents:
6
diff
changeset
|
34 | jid=user@example.com |
49b83fa1f6fd
README: Add config file example
Matthew Wild <mwild1@gmail.com>
parents:
6
diff
changeset
|
35 | password=mypassword |
49b83fa1f6fd
README: Add config file example
Matthew Wild <mwild1@gmail.com>
parents:
6
diff
changeset
|
36 | |
49b83fa1f6fd
README: Add config file example
Matthew Wild <mwild1@gmail.com>
parents:
6
diff
changeset
|
37 | [otheraccount] |
49b83fa1f6fd
README: Add config file example
Matthew Wild <mwild1@gmail.com>
parents:
6
diff
changeset
|
38 | jid=otheruser@example.org |
49b83fa1f6fd
README: Add config file example
Matthew Wild <mwild1@gmail.com>
parents:
6
diff
changeset
|
39 | password=theirpassword |
49b83fa1f6fd
README: Add config file example
Matthew Wild <mwild1@gmail.com>
parents:
6
diff
changeset
|
40 | |
49b83fa1f6fd
README: Add config file example
Matthew Wild <mwild1@gmail.com>
parents:
6
diff
changeset
|
41 | and so on. You can define as many accounts as you want, if no account |
49b83fa1f6fd
README: Add config file example
Matthew Wild <mwild1@gmail.com>
parents:
6
diff
changeset
|
42 | is called 'default' then the first account is the default. If there is |
49b83fa1f6fd
README: Add config file example
Matthew Wild <mwild1@gmail.com>
parents:
6
diff
changeset
|
43 | no [] header at the start of the file it is assumed to be [default]. |
49b83fa1f6fd
README: Add config file example
Matthew Wild <mwild1@gmail.com>
parents:
6
diff
changeset
|
44 | |
6 | 45 | ## Building and installing |
46 | Building clix is (by no accident) quite simple. It depends on Verse, | |
47 | an XMPP client library for Lua. Verse in turn depends on several | |
48 | libraries, all dependencies are listed here. | |
49 | ||
50 | Verse 2.0+: http://matthewwild.co.uk/projects/verse | |
51 | At the time of writing Verse 2.x has not been released yet and | |
52 | is available only from: http://code.matthewwild.co.uk/verse/ | |
53 | ||
54 | LuaExpat: http://www.keplerproject.org/luaexpat/ | |
55 | Lua XML parser. Available in Debian as liblua5.1-expat0 | |
56 | ||
57 | LuaSocket: http://www.tecgraf.puc-rio.br/~diego/professional/luasocket/ | |
58 | Lua networking library. Available in Debian as liblua5.1-socket2 | |
59 | ||
60 | Clix can be run directly from source if the above dependencies are | |
61 | installed. To make life easier it can be installed to standard directories, | |
62 | on most systems this means to copy clix.lua to /usr/bin/clix and the clix | |
63 | directory to /usr/lib/lua/5.1/clix (on some non-Debian systems the 5.1 | |
64 | directory isn't needed). | |
65 | ||
66 | Alternatively you can use Squish to compress all Clix's files into a single | |
67 | executable. If you have Squish installed then simply type 'squish' in | |
68 | clix's source directory to generate the compacted 'clix.bin' file. Squish | |
69 | can be found at http://matthewwild.co.uk/projects/squish . | |
70 |