author | Myhailo Danylenko <isbear@ukrpost.net> |
Sat, 13 Oct 2012 20:57:03 +0300 | |
changeset 137 | 4fda19d05965 |
parent 129 | ea30cf6c5bea |
child 144 | 690b5524b895 |
permissions | -rw-r--r-- |
0 | 1 |
|
129
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
2 |
# Lua scripting for MCabber |
0 | 3 |
|
129
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
4 |
This module creates lua interpreter environment and puts some lua |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
5 |
functions in it to interact with mcabber. Module provides command 'lua' |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
6 |
to run lua expressions in that environment. |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
7 |
|
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
8 |
Lua interface is available in api reference, built with 'docgen' help. |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
9 |
It is also available online. |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
10 |
|
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
11 |
In 'examples' dir there are some example scripts, that may be used as |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
12 |
is or for reference. See also 'README' in 'examples' dir. |
87
36d94f12811b
Small update to README
Myhailo Danylenko <isbear@ukrpost.net>
parents:
3
diff
changeset
|
13 |
|
129
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
14 |
# Installation |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
15 |
|
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
16 |
To install it, you need: |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
17 |
|
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
18 |
* mcabber headers |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
19 |
* liblua |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
20 |
* glib |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
21 |
* gmodule |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
22 |
* docgen (optional, for documentation) |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
23 |
* cmake |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
24 |
* make |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
25 |
* c compiler (gcc) |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
26 |
* linker (binutils) |
3
a5f864d4207f
Fixes for build system
Myhailo Danylenko <isbear@ukrpost.net>
parents:
0
diff
changeset
|
27 |
|
129
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
28 |
Then do: |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
29 |
|
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
30 |
$ mkdir build |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
31 |
$ cd build |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
32 |
$ cmake .. |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
33 |
$ make edit_cache |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
34 |
$ make |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
35 |
# make install |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
36 |
|
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
37 |
Debian users can instead of make install do: |
0 | 38 |
|
129
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
39 |
$ make package |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
40 |
# dpkg -i libmcabber-lua_*.deb |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
41 |
|
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
42 |
Users of other distributions can select appropriate package generator, |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
43 |
using cache editor. |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
44 |
|
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
45 |
# License |
0 | 46 |
|
129
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
47 |
This code underlies terms of GNU GPL v2 or later. You can find it in |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
48 |
file COPYING from this distribution or on a GNU web-site |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
49 |
<http://www.gnu.org/licenses/>. |
0 | 50 |
|
129
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
51 |
# Contact |
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
52 |
|
ea30cf6c5bea
Rearrange documentation
Myhailo Danylenko <isbear@ukrpost.net>
parents:
93
diff
changeset
|
53 |
I will be happy to get feedback, patches, suggestions, etc. |
93
0a10228296c1
New module loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents:
88
diff
changeset
|
54 |
You can send me email or contact via jabber <isbear@unixzone.org.ua>. |
0 | 55 |
|
56 |
-- Myhailo Danylenko <isbear@ukrpost.net> |
|
57 |