Plugin: gg
Poprzedni Rozdział 2. Pluginy  Następny

Plugin: gg

Commands

_autoaway

Parameters. 

Short Description.  automatically change status to away
_autoback

Parameters. 

Short Description.  automatically change status to available
_descr

Parameters.  [description/-]

Short Description.  change status description

If description won't be defined then ekg2 will use random description.
Giving ,,-'' instead of description will cause status without description.
away

Parameters.  [description/-]

Short Description.  change status to away.

If description won't be defined then ekg2 will use random description.
Giving ,,-'' instead of description will cause status without description.
back

Parameters.  [description/-]

Short Description.  change status to available.

If description won't be defined then ekg2 will use random description.
Giving ,,-'' instead of description will cause status without description.
block

Parameters.  [uid/alias]

Short Description.  add to blocked users list
change

Parameters.  <options>

Short Description.  change information in public catalogue

  -f, --first <first name>

  -l, --last <surname>

  -n, --nick <nickname>

  -b, --born <birth date>

  -c, --city <city>

  -N, --familyname <surname>  maiden name

  -C, --familycity <city>    home town

  -F, --female		 sex: female

  -M, --male		   sex: male


If some option won't be defined, that value will be erased
in the public catalogue. Using option ,,-''
will erase all values.
chat

Parameters.  <uin/alias/@group> <message>

Short Description.  send message

Command is similar to msg, but it send message like dialogue,
not separately.
check_conn

Parameters.  <alias>

Short Description.  check if person is connected

It checks if person is connected. That persons client must support images.
Tested on GG 6.0 for Windows. In case of using clients:
TLEN, kadu, ekg i ekg2 command don't work propertly (person
will get empty message). With that command we can check
if the 'non available' person is disconnected or only invisible.
connect

Parameters. 

Short Description.  connect with server
dcc

Parameters.  [options]

Short Description.  support for p2p connections

  [r]send <uin/alias> <path>  	   sends specified file

  get [uin/alias/#id]	      get file.

  resume [uin/alias/#id]	   resume getting file

  [r]voice <uin/alias/#id>	 start voice dialogue

  close <uin/alias/#id>	    close connection

  list			     display connection list


P2P connections need dcc option.
Commands rsend%n and %Trvoice sends request to connect other client
with our and it is usefull, when we can't connect on our own.
disconnect

Parameters.  [description/-]

Short Description.  disconnect from server

If option auto_reconnect is on, after using 
this command, program will try to connect automatically
after some time.
dnd

Parameters.  [description/-]

Short Description.  change status to do not disturb.

If description won't be defined then ekg2 will use random description.
Giving ,,-'' instead of description will cause status without description.
ffc

Parameters.  [description/-]

Short Description.  change status to free for chat.

If description won't be defined then ekg2 will use random description.
Giving ,,-'' instead of description will cause status without description.
find

Parameters.  [uin|options]

Short Description.  search users in public catalogue

  -u, --uin <uin>

  -f, --first <name>

  -l, --last <surname>

  -n, --nick <nickname>

  -c, --city <city>

  -b, --born <min:max>    birth date range

  -a, --active	    only with available status.

  -F, --female	    sex: female

  -M, --male	      sex: male

  -s, --start <n>	 display from n-number

  -A, --all	       display all

  -S, --stop	      stop all.
image

Parameters.  <alias> <image>

Short Description.  send image to person

Picture will be send as a separate message. Recipients' client 
must support images.
invisible

Parameters.  [description/-]

Short Description.  change status to invisible

If description won't be defined then ekg2 will use random description.
Giving ,,-'' instead of description will cause status without description.
modify

Parameters.  <alias> <options>

Short Description.  change information in contact list

You can use options like:

  -f, --first <name>

  -l, --last <surname>

  -n, --nick <nickname>     nickname

  -u, --uin <uin>

  -g, --group [+/-]<@group>  add or remove from group

  -p, --phone <number>       mobile number

  -o, --offline	      be offline for that person

  -O, --online	       be online for that person


Two last options are working when 'only for friends' mode is on.
msg

Parameters.  <uin/alias/@roup/*> <message>

Short Description.  send message
passwd

Parameters.  <password> <token>

Short Description.  change user password
reconnect

Parameters. 

Short Description.  disconnect and connect to server.
register

Parameters.  <email> <password> <token>

Short Description.  register new account

Before registration use command 'token'.
remind

Parameters.  [uin] <token>

Short Description.  send password on email
token

Parameters. 

Short Description.  download token from server
unblock

Parameters.  <uin/alias>|*

Short Description.  remove from blocked users list
unregister

Parameters.  <uin/alias> <password> <token>

Short Description.  remove account from server
userlist

Parameters.  [option]

Short Description.  contact list on server

Contact list on server "list [-p|-g|-c]":

  -c, --clear  remove list from server

  -g, --get    get list from server

  -p, --put    put list on server

Variables

dcc

Type.  bool

Default value.  0

Turn on or off p2p connections between clients.
You need to reconnect after changing that option to send new 
IP adress.
dcc_ip

Type.  text

Default value.  none.

set IP adress that is send to server. You can set
this variable as ,,auto'', IP then will be set
automatically.
dcc_limit

Type.  text

Default value.  30/30

Set p2p connections limit in specified time.
number before / set maximum, and number
after / number of seconds. after going beyond this number 
p2p connections will be cuted down, to prevent client run-down.
dcc_port

Type.  number

Default value.  1550

port, which ekg uses for p2p conections.
display_token

Type.  bool

Default value.  1

variable which is available only when we've got special liblary that wi'll let 
us to decode JPEG. Turning it off will cause that 
ekg will save tokens to file.
get_images

Type.  bool

Default value.  0

if value = 1 , images from chat will be downloaded
  and saved in catalogue defined by images_dir
images_dir

Type.  text

Default value.  none

set catalogue, in which images will be saved, when get_images is set.
images_size

Type.  liczba

Default value.  20

varible which define size of images in kB
skip_default_format

Type.  bool

Default value.  0

if set, skip default (for windows client) format (black on white)
split_messages

Type.  bool

Default value.  0

variable which define what to do if message is longer that it is set.
If value = 1 then message will be splited , if value =  0
then message will be send incomplete.

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

auto_find

Type.  bool

Default value.  0

Variable determines if people we haven't got on userlist, but send us 
a message, should be checked in users catalog.
concat_multiline_status

Type.  integer

Default value.  3

concatenates nasty-multiline status if number of lines is bigger, than
value set. if equals 0 no concatenation will be performed. to
distinguish multiline status will be prefixed with '[m]' (multiline)
if there is enough place for that.
connection_save

Type.  integer

Default value.  0

Variable determines that server adres should be saved.
default

Type.  bool

Default value.  0

Variable determines that session should be default (first at program
startup)
display_notify

Type.  integer

Default value.  -1

Value -1 determines using global variables.
Value 0 determines ignoring friends status change.
Value 1 determines displaying all the changes.
Value 2 determines displaying changes from inavailable to available
and reversed.
Higher priority have variable 'contacts', which hides status change if
set 2.
local_ip

Type.  string

Default value.  (none)

Variable determines IP address, from where any connections are made
(example: with GG server). If value is incorect, will be deleted.
log_formats

Type.  string

Default value.  xml,simple

Variable determines logging format (?!).
password

Type.  string

Default value.  (none)

Variable keeps users password. It's needed to connect to server.
Automatically set after sucsesful registration, if where blank.
port

Type.  integer

Default value.  8074

Variable keeps port number, which program uses to connect to GaduGadu
server.
proxy

Type.  string

Default value.  (none) 

Variable available only when libjpeg is compiled, turning variable off
causes program like the library doesn't exists, that means tokens are
save to file.
proxy_forwarding

Type.  string

Default value.  (none)

Variable keeps address and port (with : beetween them) of forwarding server
(router, proxy or sth :-)) which forwards on port 1550 on our
computer.
private

Type.  bool

Default value.  0

Variable set 'only for friends' mode.
scroll_long_desc

Type.  integer

Default value.  0

Variable determines scrolling of too long descriptions in
seconds.
If 0, no scrolling.
WARNING: using scrolling my cause removing gg user account.
ATTENTION: when description is scrolling in information is only
	   displayed 'cuted' description. Information about 
	   description change are NOT displayed.
scroll_mode

Type.  string [bounce|simple]

Default value.  bounce

Variable determines type of scrolling.
bounce - bouncing from 'ends'.
simple - scrolling to left, until ends displayed, after reaching end
	 return to beginning
server

Type.  string

Default value.  (none)

Variable keeps IP addresses of servers, which program tries to
connect, avoiding normal connection procedure. Can be useful when
main server crashes. Addresses should be seperated by commas,
semicolons or spaces. After colon we can write server port. If server
and port are prefixed by 'tls:' string, program will try to negotiate
secure TLS connection to server. If variable is set to 'tls', program
asks main server about server address which provide TLS connections
and will try to connect with that server.
Poprzedni Początek rozdziału Następny
Rozdział 2. Pluginy  Spis treści  Plugin: gpg