|
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 |
|
29 ## Building and installing |
|
30 Building clix is (by no accident) quite simple. It depends on Verse, |
|
31 an XMPP client library for Lua. Verse in turn depends on several |
|
32 libraries, all dependencies are listed here. |
|
33 |
|
34 Verse 2.0+: http://matthewwild.co.uk/projects/verse |
|
35 At the time of writing Verse 2.x has not been released yet and |
|
36 is available only from: http://code.matthewwild.co.uk/verse/ |
|
37 |
|
38 LuaExpat: http://www.keplerproject.org/luaexpat/ |
|
39 Lua XML parser. Available in Debian as liblua5.1-expat0 |
|
40 |
|
41 LuaSocket: http://www.tecgraf.puc-rio.br/~diego/professional/luasocket/ |
|
42 Lua networking library. Available in Debian as liblua5.1-socket2 |
|
43 |
|
44 Clix can be run directly from source if the above dependencies are |
|
45 installed. To make life easier it can be installed to standard directories, |
|
46 on most systems this means to copy clix.lua to /usr/bin/clix and the clix |
|
47 directory to /usr/lib/lua/5.1/clix (on some non-Debian systems the 5.1 |
|
48 directory isn't needed). |
|
49 |
|
50 Alternatively you can use Squish to compress all Clix's files into a single |
|
51 executable. If you have Squish installed then simply type 'squish' in |
|
52 clix's source directory to generate the compacted 'clix.bin' file. Squish |
|
53 can be found at http://matthewwild.co.uk/projects/squish . |
|
54 |