
                    Eksperymentalny Klient Gadu-gadu

        (C) Copyright 2001-2002 Wojtek Kaniewski <wojtekka@irc.pl>,
  	                        Robert J. Wony <speedy@ziew.org>
				Adam Osuchowski <adwol@polsl.gliwice.pl>

                Motto: ,,Bunkrw nie ma, ale te jest...''

LICENCJA

    Program jest udostpniony na zasadach licencji GPL, ktrej tre
    zaczono w pliku src/COPYING. Biblioteka libgadu obsugujca
    warstw sieciow udostpniono na zasadach licencji LGPL, ktrej
    tre znajduje si w pliku lib/COPYING.
    
    Program i biblioteka zostay napisane na podstawie informacji
    uzyskanych przez badanie pakietw wysyanych midzy klientem
    a serwerem oraz od osb trzecich. Autorzy nie disasemblowali,
    ani nie dekompilowali oryginalnego klienta. Projekt powsta przy
    uyciu darmowych i wolnodostpnych narzdzi.

    Gadu-gadu jest zastrzeonym znakiem towarowym sms-express sp. z o.o.

INSTALACJA

    Skompilowa i odpali. Proste? Proste. Po pierwszym uruchomieniu
    ekg powie, jak go skonfigurowa.

    ekg powinien dziaa na wikszoci systemw un*xowych, jak Linux,
    *BSD, SunOS, IRIX itp. lecz czasami przy dodawaniu nowych funkcji
    nie sposb sprawdzi ich zachowania na wszystkich popularnych
    systemach. W takim wypadku przydatne s informacje o bdach z
    dokadnym wskazaniem systemu i architektury.

    Program korzysta z biblioteki readline, wic odpowiednie pakiety
    zawierajce j, oraz pliki nagwkowe, powinny by zainstalowane.
    readline zwykle polega te na innych bibliotekach do obsugi
    terminala, jak np. libtermcap czy ncurses. Oczywicie niezbdny
    jest te zestaw narzdzi do kompilacji programw napisanych w
    jzyku C -- kompilator, preprocesor, linker, pliki nagwkowe,
    biblioteki systemowe itd.

UYCIE

    Jest na tyle intuicyjne, e nie powinno sprawi problemw (wszyscy
    betatesterzy poradzili sobie bez jakiejkolwiek dokumentacji).
    Interfejs jest podobny do ircii. Dopenianie tabem jest dostpne w
    wikszoci komend. Komendy mona wywoywa skrtami, o ile s one
    jednoznaczne. Wysyanie wiadomoci komend ,,msg'', rozmowa komend
    ,,chat''. Informacje o ludziach ,,find <numer/nick>''. Szukanie t
    sam komend, ale z rnymi parametrami. ,,help'' Twoim przyjacielem.
    jeli dana komenda ma rne opcje, pomaga ,,help <komenda>''. By
    wysa kilkulinijkow wiadomo, zamiast treci wpisz ,,\''
    (backslash). Koczy si lini z sam kropk, anuluje Ctrl-D. Nie
    mona przesya plikw, ani nawizywa bezporednich pocze.

    Jeli dana komenda przyjmuje ,,--parametr'' mona uy rwnie
    skrtu ,,-p'', jeli nie powoduje to niejednoznacznoci. Uwaga!
    brana pod uwag jest zwykle pierwsza litera, wic jeli wpiszesz
    ,,list --gone'', ekg potraktuje to jako ,,list --get''.

    Komendy mona wysya take przez potok. By go uaktywni, naley
    uruchomi ekg z parametrem ,,-c'' i cik potoku. Ze wzgldu na
    specyfik potokw, wyniki polece wysyane bd na terminal na ktrym
    jest uruchomione ekg (tak jak normalnie). Pisa do potoku mona tak
    jak do normalnego pliku (choby zwykym echem).

    Jeli w linii polece shella podasz po nazwie programu i parametrach
    zaczynajcych si od mylnika co jeszcze, to zostanie to zinterpretowane
    jako komenda wsadowa. ekg wykona tylko t komend, i od razu wyjdzie.
    Jeli na serwerze GG czekaj na Ciebie jakies wiadomoci to serwer je
    przyle zaraz po poczeniu i w trybie wsadowym ekg wypisze je na
    terminal. Jeli wic zamierzasz przekierowa wyjcie do /dev/null i nie
    masz loga z wiadomoci to licz si z tym, e mog one zgin bezpowrotnie.

    Dobra rada numer jeden: zanim zaczniesz narzeka, e czego nie ma,
    przeczytaj plik TODO.

    Dobra rada numer dwa: zanim zaczniesz narzeka, e czego nie ma,
    poszukaj w pliku ChangeLog. Nie ma adnej oficjalnej dokumentacji
    z list komend, skrtami klawiszowymi itp. Pki co, powsta opis
    wszystkich zmiennych.

WYSYANIE SMSW

    ekg korzysta z zewntrznego programu do wysyania smsw. Nie ma
    najmniejszego sensu dublowania tej funkcji, skoro i tak wikszo
    ma ju zainstalowane odpowiednie skrypty/programy/cokolwiek.
    Wystarczy poda ciek do takiego programu w zmiennej
    ,,sms_send_app''. Powinien przyjmowa numer telefonu za pierwszy
    parametr i wiadomo za drugi. Ten ze strony http://ceti.pl/~miki/
    spenia podane wymagania.

ZNANE PROBLEMY

    Jeli nie moesz wpisywa polskich liter, dopisz do pliku /etc/inputrc
    lub ~/.inputrc nastpujce linie:

	set meta-flag on
	set convert-meta off
	set output-meta on
    
ZGASZANIE BDW

    Prosz, nie przysyajcie informacji, e mona by doda co, co jest
    ju wymienione w TODO. Nie przysyajcie informacji, e jest jaki
    bd, jeli poprawka jest wymieniona w TODO. Nie przysyajcie
    informacji o warningach podczas kompilacji -- dopiero jeli nie chce
    si w ogle skompilowa, dajcie zna. Zaznacznie, co to za system,
    jaka dystrybucja, jaka wersja. Jeli bd jest powtarzalny i zwizany
    z sieci, prosibym o to, co wyrzuca ekg uruchomione z opcj ,,-d''.
    Jeli segfaultuje i zrzuca core, prosibym o podesanie tego, co
    pokae ,,gdb ekg core'' (gwnie chodzi o lini, w ktrej wystpi
    bd), a nastpnie ,,bt''. Informacj o bdzie prosz przesya
    na list ekg-users (szczegy niej), poniewa w ten sposb dostan
    j inni developerowie. Dziki temu jest szansa, e zostanie poprawione
    wczeniej.

RDA

    Cz jest adnie udokumentowana, cz nie. Komentarze czasami s
    bardzo gupie, ale jeli si do trzeciej rano siedzi nad dziwnym
    segfaultem, ciko si pohamowa. Cay program objty jest licencj
    GPL, wic pamitaj o tym, korzystajc z jego rde. Jeli napiszesz
    jakiegokolwiek klienta, frontend czy co takiego, bybym wdziczny
    za informacje o nim. Chtnie umieszcz odnoniki do innych tego typu
    projektw na stronie.

    Snapshoty kodu s dostpne pod adresem http://dev.null.pl/ekg/.
    Jeli nie wystpi adne trzsienie ziemi, brak prdu ani barykady na
    drogach, powinny by robione co 24 godziny, wieczorem.

LISTA DYSKUSYJNA

    Istnieje lista dyskusyjna dla uytkownikw EKG o adresie 
    ekg-users@list.ziew.org. Aby si zapisa, naley na adres
    sympa@list.ziew.org wysa wiadomo o treci:

	subscribe ekg-users

PODZIKOWANIA

    Wymienieni ludzie mieli mniejszy lub wikszy wpyw na rozwj biblioteki
    i klienta. Niektrzy pomagali analizowa protok, niektry testowali
    na rnych systemach, inni podsyali patche i bugreporty. Jeli kogo
    pominem, przepraszam, niech da zna. W kadym razie wielkie dziki
    nale si poniszym osobom:

	Robert J. Wony (speedy@atman.pl)
	Darek Jackowski (ascent@linux.pl)
	Arkadiusz Mikiewicz (misiek@pld.org.pl)
	Tomasz Jarzynka (tomee@cpi.pl)
	Leszek Urbaski (tygrys@moo.pl)
	Asia Kaniewska (kj_asia@wp.pl)
	Kuba Jermak (kooba@irc.pl)
	Tomasz Torcz (zdzichu@irc.pl)
	Adam Kruszewski (phantom@linux.bydg.org)
	Piotr Wysocki (wysek@tower.braxis.co.uk)
	Marcin Chojnowski (martii@obgyn.edu.pl)
	Jarosaw Kamper (jack@jack.eu.org)
	Pawe Kot (pkot@linuxnews.pl)
	Piotr Stolc (socrtp@sedez.iq.pl)
	Artur Pietruk (arturp@plukwa.net)
	Adam Ludwikowski (adam.ludwikowski@wp.pl)
	Pawe Maziarz (drg@go2.pl)
	Piotr Figiel (feeg@psychodelic.org)
	Rafa Florek (raf@regionet.regionet.pl)
	Krzysztof Skadzie (coxoc@coxoc.org)
	Marek Antoniak (kfazi@kfazi.polnet.trzepak.pl)
	Maurycy Pawowski (maurycy@kocham.cie.gov.pl)
	Jakub Martyski (jakub@ceto.pl)
	Marcin Mikua (meecash@meecash.prv.pl)
	Krzysztof Wjtowicz (misiolek@misiolki.prv.pl)
	Tomasz Dudzisz (eileen@ds1.agh.edu.pl)
	Wojciech Bojdo (wojboj@htcon.pl)
	Jacek Pospychaa (tri10o@bsod.org)
	Marek Kozina (klith@irc.pl)
	Dawid Jarosz (D.Jarosz@elka.pw.edu.pl)
	Artur Gawryszczak (gawrysz@camk.edu.pl)
	Walerian Sokoowski (ws171913@yahoo.com)
	Robert Osowiecki (magic.robson@rassun.art.pl)
	Stanisaw Gurgacz (fig@pd21.tarnobrzeg.sdi.tpnet.pl)
	Maciej Korze (maciekk@linux.sky.pl)
        Adam Osuchowski (adwol@polsl.gliwice.pl)

$Id: README,v 1.41 2002/05/23 10:53:10 wojtekka Exp $
