Software /
code /
clix
Changeset
6:0ec2fd06a962
README: Added
author | Matthew Wild <mwild1@gmail.com> |
---|---|
date | Wed, 06 Jan 2010 18:25:42 +0000 (2010-01-06) |
parents | 5:7209e1f8e66b |
children | 7:6078e8d2b59d |
files | README |
diffstat | 1 files changed, 54 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README Wed Jan 06 18:25:42 2010 +0000 @@ -0,0 +1,54 @@ +# clix - Command-line XMPP tool + +## Description +Clix is a small utility to interact with an XMPP server. It can be +used to send messages, presence, and info queries to any XMPP address. + +## Example +clix message --to=user@example.com "The kettle has now boiled" + +## Usage +Syntax: clix COMMAND [OPTIONS] [...] + +Different commands accept different sets of options, but they all +follow some general conventions. The command must be the first +parameter, followed by a series of flags or options. Global options +include: + + --account=default + The account to use from the configuration file (default + is 'default') + + -v + --verbose + Enables verbose logging of the XMPP connection + +When no command is specified, clix will print a list of the names +and descriptions of all built-in commands. + +## Building and installing +Building clix is (by no accident) quite simple. It depends on Verse, +an XMPP client library for Lua. Verse in turn depends on several +libraries, all dependencies are listed here. + + Verse 2.0+: http://matthewwild.co.uk/projects/verse + At the time of writing Verse 2.x has not been released yet and + is available only from: http://code.matthewwild.co.uk/verse/ + + LuaExpat: http://www.keplerproject.org/luaexpat/ + Lua XML parser. Available in Debian as liblua5.1-expat0 + + LuaSocket: http://www.tecgraf.puc-rio.br/~diego/professional/luasocket/ + Lua networking library. Available in Debian as liblua5.1-socket2 + +Clix can be run directly from source if the above dependencies are +installed. To make life easier it can be installed to standard directories, +on most systems this means to copy clix.lua to /usr/bin/clix and the clix +directory to /usr/lib/lua/5.1/clix (on some non-Debian systems the 5.1 +directory isn't needed). + +Alternatively you can use Squish to compress all Clix's files into a single +executable. If you have Squish installed then simply type 'squish' in +clix's source directory to generate the compacted 'clix.bin' file. Squish +can be found at http://matthewwild.co.uk/projects/squish . +