extsay-ng/README
author Mikael Berthe <mikael@lilotux.net>
Sat, 13 Oct 2012 14:34:18 +0200
changeset 44 3f94f3522960
parent 36 3d1c22d311bb
permissions -rw-r--r--
[killpresence] Add a command /probe to send a presence probe
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
21
9798e3aaa851 Add module extsayng, rename previous one to extsay_old
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     1
36
3d1c22d311bb [extsay] Update module name in the README file
Mikael Berthe <mikael@lilotux.net>
parents: 24
diff changeset
     2
    ** Module extsay **
21
9798e3aaa851 Add module extsayng, rename previous one to extsay_old
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     3
9798e3aaa851 Add module extsayng, rename previous one to extsay_old
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     4
To use this module, you have to be running the screen utility.
23
cf95a475825c [extsay] Multiple improvements
Mikael Berthe <mikael@lilotux.net>
parents: 21
diff changeset
     5
MCabber's FIFO system must be enabled.
21
9798e3aaa851 Add module extsayng, rename previous one to extsay_old
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     6
9798e3aaa851 Add module extsayng, rename previous one to extsay_old
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     7
Copy the script extsay.sh to some place on your system and set the mcabber
9798e3aaa851 Add module extsayng, rename previous one to extsay_old
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     8
option 'extsay_script_path' to the file path.  You can set it in your mcabber
9798e3aaa851 Add module extsayng, rename previous one to extsay_old
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     9
configuration file.
9798e3aaa851 Add module extsayng, rename previous one to extsay_old
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    10
24
81cbb47f1aa6 [extsay] Add options to split the screen window
Mikael Berthe <mikael@lilotux.net>
parents: 23
diff changeset
    11
Set the option 'extsay_split_win' to 1 if you want the helper script to
81cbb47f1aa6 [extsay] Add options to split the screen window
Mikael Berthe <mikael@lilotux.net>
parents: 23
diff changeset
    12
split the screen window and open the editor below the mcabber screen window.
81cbb47f1aa6 [extsay] Add options to split the screen window
Mikael Berthe <mikael@lilotux.net>
parents: 23
diff changeset
    13
This may not work for you, according to your screen configuration.
81cbb47f1aa6 [extsay] Add options to split the screen window
Mikael Berthe <mikael@lilotux.net>
parents: 23
diff changeset
    14
The option 'extsay_win_height' can be used to specify the height of the newly
81cbb47f1aa6 [extsay] Add options to split the screen window
Mikael Berthe <mikael@lilotux.net>
parents: 23
diff changeset
    15
created window, if you have enabled splitting.
81cbb47f1aa6 [extsay] Add options to split the screen window
Mikael Berthe <mikael@lilotux.net>
parents: 23
diff changeset
    16
21
9798e3aaa851 Add module extsayng, rename previous one to extsay_old
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    17
 /EXTSAY [jid]
9798e3aaa851 Add module extsayng, rename previous one to extsay_old
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    18
9798e3aaa851 Add module extsayng, rename previous one to extsay_old
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    19
When you type /extsay, the module will send a command to screen to open a
9798e3aaa851 Add module extsayng, rename previous one to extsay_old
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    20
new window and run the helper script in it.
23
cf95a475825c [extsay] Multiple improvements
Mikael Berthe <mikael@lilotux.net>
parents: 21
diff changeset
    21
This helper scripts launches an editor ($EDITOR), and sends the message using
cf95a475825c [extsay] Multiple improvements
Mikael Berthe <mikael@lilotux.net>
parents: 21
diff changeset
    22
the FIFO mechanism.
21
9798e3aaa851 Add module extsayng, rename previous one to extsay_old
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    23
23
cf95a475825c [extsay] Multiple improvements
Mikael Berthe <mikael@lilotux.net>
parents: 21
diff changeset
    24
Please note that this script will not work if the editor does detach from
cf95a475825c [extsay] Multiple improvements
Mikael Berthe <mikael@lilotux.net>
parents: 21
diff changeset
    25
the terminal.
21
9798e3aaa851 Add module extsayng, rename previous one to extsay_old
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    26
9798e3aaa851 Add module extsayng, rename previous one to extsay_old
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    27
Hope you find this module useful, do not hesitate to send patches for
9798e3aaa851 Add module extsayng, rename previous one to extsay_old
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    28
improvements!
9798e3aaa851 Add module extsayng, rename previous one to extsay_old
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    29
9798e3aaa851 Add module extsayng, rename previous one to extsay_old
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    30
Mikael