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


auth

Parameters.  <options> <JID>

Short Description.  authorization support

<action> <JID> 

  -a, --accept <JID>    authorize JID

  -d, --deny <JID>      deny JID authorization

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

  -c, --cancel <JID>    cancel authorization

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.

change

Parameters.  <options>

Short Description.  changes data in vcard

  -f, --fullname <full name>

  -n, --nick <nickname>

  -b, --born <birth year>

  -c, --city <city>

  -d, --description <description>

  -C, --country <country>

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

chat

Parameters. 

Short Description.  sends chat message


connect

Parameters. 

Short Description.  connects with server


del

Parameters.  [name]

Short Description.  removes user from roster


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.

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.

lastseen

Parameters. 

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


msg

Parameters. 

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

passwd

Parameters. 

Short Description.  changes password


reconnect

Parameters. 

Short Description.  disconnects and connects again


userinfo

Parameters. 

Short Description.  retrieves Jabber Directory info about given jid


ver

Parameters. 

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


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

allow_autoresponder

Type.  bool

Default value.  0

Whether autoresponder should handle incoming messages in this session.
Works only when 'autoresponder' plugin is loaded.

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.


Session Variables

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

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

password

Type.  string

Default value.  none

User password.

Necessary while connecting.

plaintext_passwd

Type.  bool

Default value.  0

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

port

Type.  integer

Default value.  5222

Server port.

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_ssl

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: session-en.txt,v 1.7 2007/03/01 19:34:01 peres Exp $