Plugin: jabber

Commands

_autoaway

Parameters. 

Short Description.  changes status to away


_autoback

Parameters. 

Short Description.  changes status to available


add

Parameters.  <JID> [name]

Short Description.  adds user to our roster while asking for authorization


admin

Parameters.  [conference field value]

Short Description.  alter chatroom configuration

Alter MUC chatroom configuration: Set `field` to `value` for `conference`
chatroom.

Invoke it with no argmunets to see all fields and their values for the
current chatroom.

Example (make room persistent):
  /admin xmpp:test@conference.example.com --muc#roomconfig_persistentroom 1

auth

Parameters.  <options> <JID>

Short Description.  authorization support

<action> <JID>

  -a, --accept <JID>    authorize JID

  -d, --deny <JID>      deny JID authorization or revokes it

  -r, --request <JID>   send autorization request

  -c, --cancel <JID>    cancel authorization

  -j, --reject <JID>    reject authorization request

  -l, --list	    display pending requests

  -p, --probe	    request presence information

away

Parameters.  [description/-]

Short Description.  changes status to away

If description wasn't given, random description will be looked for.
Giving ,,-'' instead of description will clear description.

back

Parameters.  [description/-]

Short Description.  changes status to available

If description wasn't given, random description will be looked for.
Giving ,,-'' instead of description will clear description.

ban

Parameters.  <conference> <JID> [reason]

Short Description.  Bans the specified JID from the given conference

If no JID is specified, command lists all jids banned from given
conference. Otherwise it bans specified JID from the given conference.

bookmark

Parameters.  <action> <options> <JID/URL> -- <name>

Short Description.  edit bookmarks on server

<actions>

  --add		add bookmark

  --remove		remove bookmark

  --clear		remove all bookmarks

  --modify		modify selected bookmark

  --display		display all bookmarks


<options>

  --conf            <conf>

  --url             <url>

  --autojoin        <bool>

  --nick            <nick>

  --pass            <pass>


example:

  /bookmark --add --conf my@conference.server.domain --autojoin 1 --nick nick --pass pass -- #conference

change

Parameters.  <options>

Short Description.  changes data in vcard

  -f, --fullname <full name>

  -n, --nick <nickname>

  -b, --born <birth date>	(ISO 8601-formatted, e.g. yyyy-mm-dd)

  -c, --city <city>

  -d, --description <description>

  -C, --country <country>

  -p, --photo <photo path>

If any of these parameteres is not given, it's value will be cleared on
vCard. Giving ,,-%n'' will clear %Tall fields.

chat

Parameters.  <name>

Short Description.  sends chat message

using * instead of user's name will create queries with all your contacts

config

Parameters. 

Short Description. 


connect

Parameters. 

Short Description.  connects with server


del

Parameters.  [name]

Short Description.  removes user from roster


deop

Parameters.  <conference> <nick>

Short Description.  take all privileges off from the nick

Take voice and moderator privilages off from the given nick on the
given conference.

devoice

Parameters.  <conference> <nick> [reason]

Short Description.  take all privileges off from the nick

Take voice and moderator privilages off from the given nick on the
given conference.

disconnect

Parameters.  [description/-]

Short Description.  rozłącza się od serwera

If description wasn't given, random description will be looked for.
Giving ,,-'' instead of description will clear description.

dnd

Parameters.  [description/-]

Short Description.  changes status to ,,do not disturb''

If description wasn't given, random description will be looked for.
Giving ,,-'' instead of description will clear description.

ffc

Parameters.  [description/-]

Short Description.  changes status to ,,free for chat''

If description wasn't given, random description will be looked for.
Giving ,,-'' instead of description will clear description.

find

Parameters.  <alias/jid>

Short Description.  finds a buddy and shows his vcard


invisible

Parameters.  [description/-]

Short Description.  changes status to invisible

If description wasn't given, random description will be looked for.
Giving ,,-'' instead of description will clear description.

join

Parameters.  <conference> [nick]

Short Description.  join conference

Joins conference as nick. If conference does not exists, creates it.

kick

Parameters.  <conference> <nick> [reason]

Short Description.  kick nick off the conference


lastseen

Parameters.  <jid>

Short Description.  retrieves information on last logout time for given jid


msg

Parameters.  <alias>

Short Description.  sends message

All receivers are marked by *. Preceding multiline message with string
set in subject_prefix variable will make this line subject of this
message.

modify

Parameters.  <alias> <options>

Short Description.  changes roster entries

Possible options:

-n, --nickname <nickname>     contact nickname

nick

Parameters.  [conference] <nick>

Short Description.  change nick

Change nick on a given conference. If no conference provided, use
conference in current window.

op

Parameters.  <conference> <nick>

Short Description.  Gives moderator privileges to the specified nick


passwd

Parameters. 

Short Description.  changes password


part

Parameters.  <conference>

Short Description.  leaves conference


reconnect

Parameters. 

Short Description.  disconnects and connects again


register

Parameters.  <jid> <options>

Short Description.  registers on server\transport

<options>

  --username		<nickname>

  --password		<password>

reply

Parameters.  #id ...

Short Description.  replies on given conversation

Replies with given message to conversation connected with given
Reply-ID. Message can contain subject like in msg, but if not
specified, old one (prefixed by subject_reply_prefix) will be used.

tmsg

Parameters.  uid/nickname thread-id ...

Short Description.  sends message with thread

Like msg, but additional, second arg specifies thread-ID to use.

topic

Parameters.  [uid] <new topic>

Short Description.  set MUC topic


transpinfo

Parameters.  <jid>

Short Description.  shows you information about given server\transport


transports

Parameters.  <jid>

Short Description.  shows list of transports at given server


unban

Parameters.  <conference> <JID>

Short Description.  unban given JID from the muc conference


unregister

Parameters. 

Short Description.  deletes your account from server


userinfo

Parameters. 

Short Description.  retrieves Jabber Directory info about given jid


userlist

Parameters.  <arg>

Short Description.  userlist import/export (JRU-like)

Depending on arg:

-c, --clear				clears current userlist (equal to 'del *')

-g, --get [filename]		imports userlist from file

-p, --put [filename]		exports userlist to file

-G, --replace [filename]		clear userlist & import new from file


Userlist export file format is same as with JRU
(http://jru.jabberstudio.org).

vacation

Parameters. 

Short Description.  function is not implemented yet


ver

Parameters. 

Short Description.  retrieves information about OS and client of given jid


voice

Parameters.  <conference> <nick>

Short Description.  give the voice to the nick

Voice allows to speak on moderated conference. Note that if you give
voice to operator, you will take off moderator privileges from him.

xa

Parameters.  [description/-]

Short Description.  changes to status ,,extended away''

If description wasn't given, random description will be looked for.
Giving ,,-'' instead of description will clear description.

xml

Parameters. 

Short Description.  sends xml stream

Command must be UTF-8 encoded, all XML special characters have to be
changed to XML entities (< > &).


Session Variables

alias

Type.  string

Default value.  none

short session name

auto_away

Type.  integer

Default value.  600

Idle time in seconds, after which status will be set to 'away'.
If 0, auto_away will be disabled.

auto_away_descr

Type.  string

Default value.  none

Description to be set while entering auto-away. If null, the current
description will be kept. Can contain following escape sequences:

	%?	output following chars only if description is set

	%!	output following chars only if description is not set

	%/	output following chars always (disable above)

	%$	output current description here

	%%	output '%'

auto_xa

Type.  integer

Default value.  0

Idle time in seconds, after which status will be set to 'xa'.
If 0, auto_xa will be disabled.

auto_xa_descr

Type.  string

Default value.  none

Description to be set while entering auto-xa. If null, the current
description will be kept. Can contain following escape sequences:

	%?	output following chars only if description is set

	%!	output following chars only if description is not set

	%/	output following chars always (disable above)

	%$	output current description here

	%%	output '%'

auto_back

Type.  integer

Default value.  0

Variable determines that status will be change to 'available', if current
away status was set automatically.
If 1, status is changed whenever user send any message.
If 2, status is changed after keypressed.

auto_connect

Type.  bool

Default value.  0

Variable determines session should be connected after program startup.

auto_reconnect

Type.  integer

Default value.  10

Variable determines, that how long program need to wait to reconnect, 
after disconnect or invalid connection.
If 0, program won't try.

connect_timeout

Type.  integer

Default value.  30

Number of seconds after which connecting will timeout. Set to 0
to disable timeouting (not recommended).


Session Variables

allow_add_reply_id

Type.  integer

Default value.  1

Whether ekg2 should add Reply-IDs for incoming messages:

	0 - disabled

	1 - add Reply-IDs for messages with threads

	2 - add Reply-IDs for any message (excl. chats and likes)

allow_remote_control

Type.  integer

Default value.  0

Allow remote control. Possible values:

	0 - disabled

	1 - enabled for same jid(allow from different resources)

	2 - enabled for allow_remote_control_jid

	666 - enabled for all(DO NOT USE IT!!!)	

auto_auth

Type.  integer

Default value.  0

Whether ekg2 should handle authorization request automagically.
Variable bitmapped (i.e. you should sum up following values):

	1 - accept subscribe requests

	2 - accept unsubscribe requests

	4 - deny subscribe requests

	8 - deny unsubscribe requests

	5 - ignore subscribe requests

	10 - ignore unsubscribe requests

	16 - when adding contacts, don't request auth

auto_bookmark_sync

Type.  bool

Default value.  0

Possible values:

	0 - bookmarks will not sync

	1 - bookmarks will sync every time, ekg2 connects to server

auto_reconnect

Type.  integer

Default value.  0

Possible values: 

	0 - no reconnect at all

   >0 - amount of seconds, how long ekg2 will wait to reconnect

auto_find

Type.  integer

Default value.  0

Possible values:

	0 - auto_find disables

   >0 - finds out every vcard of every person, who sends us a message

display_ctcp

Type.  bool

Default value.  0

Possible values:

	0 - if anyone sends a request(for example, to determine your version) it won't be displayed

	1 - any requests will be displayed to you

disable_sasl

Type.  integer

Default value.  0

Possible values:

	0 - sasl enabled

	1 - use XEP-0078(Non-SASL Authentication)

	2 - disable sasl at all 

display_notify

Type.  integer

Default value.  -1

-1 - use global display_notify variable.

 0 - ignore status changes

 1 - show all changes

 2 - show only changes from unavailable to available and vice versa

Setting ,,contacts'' variable to 2 takes precendence (status changes
are hidden). 

display_server_features

Type.  integer

Default value.  1

Set when server's features should be shown:

	0 - never

	1 - only when first connected

	2 - always

log_formats

Type.  string

Default value.  xml,simple

Defines file formats to use when logging to file.

See also: log_path variable

msg_gen_thread

Type.  bool

Default value.  0

Whether to automagically generate thread-IDs for outgoing messages
without given thread.

password

Type.  string

Default value.  none

User password.

Necessary while connecting.

photo_hash

Type.  string

Default value.  none

Sha-1 hash of your avatar.

plaintext_passwd

Type.  bool

Default value.  0

Determines whether password can be sent using plaintext (1) or digest (0)
method.

ping_server

Type.  integer

Default value.  0

Possible values:

	0  -  ekg2 will not ping server

   >0  -  amount of seconds between pings

port

Type.  integer

Default value.  5222

Server port.

prefer_family

Type.  integer

Default value.  0

Prefered address family(ipv4 of ipv6)


Possible values:

	   0     -  default(ipv4)

	AF_INET  -  ipv4

	AF_INET6 -  ipv6

priority

Type.  integer

Default value.  5

Jabber server connection priority.

resource

Type.  string

Default value.  ekg2

Jabber resource.

server

Type.  string

Default value.  none

Server address. Set only if it's other than server part of JID.

ssl_port

Type.  integer

Default value.  5223

Ciphered connection port.

use_compression

Type.  integer

Default value.  0

Possible values:

	0 - data compression disabled

	1 - data compression enabled

use_ssl

Type.  bool

Default value.  1

If set to 1 ekg2 will use ciphered connection.

use_tls

Type.  bool

Default value.  1

If set to 1 ekg2 will use ciphered connection.

ver_client_name

Type.  string

Default value.  none

Client name returned when being queried.

ver_client_version

Type.  string

Default value.  none

Client version returned when being queried.

ver_os

Type.  string

Default value.  none

OS information returned when being queried.

$Id$