// (c) copyright 2001-2003 by Wojtek Kaniewski <wojtekka@irc.pl>
// 		      2003 Adam Osuchowski <adwol@polsl.gliwice.pl>
// 		      2004 by Piotr Kupisiewicz <deletek@ekg2.org>

Spis treci:

1. Format listy kontaktw ekg2
2. Format konfiguracji ekg2
3. Format emotikon (Adam Osuchowski <adwol@polsl.gliwice.pl>)
4. Format kolejki wiadomoci
5. Format pliku konfiguracji sesji ekg2

* * *

1. Format listy kontaktw ekg2

Lista kontaktw z pliku ,,userlist'' jest tego samego formatu co eksportowana
z windowsowego klienta:

    imi;nazwisko;pseudonim;wywietlana_nazwa;telefon;grupy;opis;numer

ekg moe dopisa uytkownika do kilku metagrup:

    __blocked - uytkownik blokowany
    __offline - jestemy niedostpni dla uytkownika
    __ignored_<poziom> - uytkownik jest ignorowany z danym poziomem
    __ignored - wszystkie zdarzenia zwizane z uytkownikiem s ignorowane

* * *

2. Format konfiguracji ekg2

Plik konfiguracyjny ,,config'' zawiera kolejne wpisy postaci:

	set <zmienna> <warto>
	bind <klawisz> <komenda>
	bind-set <klawisz> <sekwencja>
	alias <nazwa> <komenda>
	plugin <nazwa>
	on <zdarzenie> <priorytet> <zaoenia> <komenda>
	at [nazwa] <czas>/<czstotliwo> <komenda>
	timer [nazwa] [*/]<czas> <komenda>

Jeli pierwszy wyraz nie jest jednym ze znanych, jest traktowany jako
nazwa zmiennej, po ktrej wystpuje jej warto -- chodzi o zachowanie
kompatybilnoci z innymi klientami.

Jeli warto zmiennej zaczyna si od znaku o kodzie 1, to nastpujca
po nim warto zmiennej jest zakodowana uywajc base64.

* * *

3. Format emotikon (Adam Osuchowski <adwol@polsl.gliwice.pl>)

Za pomoc oryginalnego klienta GG mona wysa sekwencje znakowe, ktre bd
si zamienia na odpowiednie ikony. Z oczywistych wzgldw w ekg wykona si
tego nie da (moe kto kiedy zrobi wsparcie dla aaliba ;))). Sekwencje te,
zamieniane s wic na inne sekwencje. Np. sekwencja:

<cmok>

moe by zamieniona na:

:-*

lub podobn, wedle uznania uytkownika.

Aby skorzysta z moliwoci rozwijania tego typu makr w otrzymywanych
wiadomociach, naley je sobie wczeniej zdefiniowa. Robi si to w pliku
~/.gg/emoticons. Kada linia tego pliku definiuje jedno makro, a jej format
jest nastpujcy:

<makro><tabulatory><rozwiniecie>

Naley zwrci uwag na to, e do oddzielenia emoticonu od jego rozwinicia
su tylko i wycznie tabulatory (jeden lub wicej). Spowodowane jest to
wystpowaniem spacji w oryginalnych GG-owych emoticonach.

Przykadowy zestaw definicji mona znale w docs/emoticons.sample. Nie
zawiera on wszystkich definicji, bo nie miaem na tyle inwencji, eby je
powymyla. :))

* * *

4. Format kolejki wiadomoci

Wiadomoci s zapisywane w osobnych plikach w katalogu ~/.gg/queue. Nazwa
pliku jest poczeniem czasu wysania wiadomoci, kropki i kolejnej liczby,
ale nie ma ona wikszego znaczenia. Chodzi o zachowanie kolejnoci przy
sortowaniu plikw. Pierwsza linia pliku zawiera wersj pliku. Aktualnie
jest to cig znakw ,,v1''. Druga linia zawiera uid sesji, z ktrej wiadomo
bya wysyana. Trzecia linia zawiera list odbiorcw. Czwarta linia zawiera
czas wysania jako liczb sekund od 1 stycznia 1970r. Pita linia zawiera
numer sekwencyjny lub dowolny cig znakw pozwalajcy jednoznacznie okreli
wiadomo. Kolejne linie s treci wiadomoci.

* * *

5. Format pliku konfiguracji sesji ekg2 

Plik konfiguracyjny sessions moe zawiera nastpujce definicje:

	[uid sesji] - wszystkie zmienne bdce poniej s podrzdne dla 
		      tej sesji

	zmienna=warto 


$Id: files.txt,v 1.2 2004/10/04 18:55:15 deletek Exp $
