ekg2-jabber 1:0.3.1-4 / usr / share / ekg2 / plugins / jabber / commands-en.txt

// descripton for jabber-plugin proceedings
// (c) copyright 2001-2003 wojtek kaniewski <wojtekka@irc.pl>
// (c) copyright      2004 piotr kupisiewicz <deletek@ekg2.org>
// (c) copyright      2004 tomasz torcz <zdzichu@ekg2.org>

_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 ,,%T-%n'' 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 ,,%T-%n'' 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 ,,%T-%n'' will clear %Tall%n 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 ,,%T-%n'' 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 ,,%T-%n'' 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 ,,%T-%n'' 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 ,,%T-%n'' 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

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 ,,%T-%n'' 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 (< > &).

// $Id$