// mały opis dostępnych zmiennych // (c) copyright 2001-2002 by wojtek kaniewski uin typ: liczba domyślna wartość: brak określa numer GG, z którego ma korzystać klient. niezbędna do połączenia z serwerem. automatycznie ustawiana po udanej rejestracji, gdy wcześniej była pusta. password typ: tekst domyślna wartość: brak hasło użytkownika. niezbędne do połączenia z serwerem. automatycznie ustawiane po udanej rejestracji, gdy wcześniej było puste. audio_device typ: tekst domyślna wartość: /dev/dsp urządzenie dźwiękowe, którego należy używać przy rozmowach głosowych. auto_away typ: liczba domyślna wartość: 600 wartość określająca, po jakim czasie stan użytkownika zostanie zmieniony na ,,zajęty''. podaje się w sekundach. jeśli równa 0, nie będzie automatycznej zmiany. auto_reconnect typ: liczba domyślna wartość: 10 w przypadku nieudanego połączenia, określa po ilu sekundach program ma ponowić próbę. jeśli równa 0, nie próbuje więcej. auto_save typ: liczba domyślna wartość: 0 po jakim czasie automatycznie zapisać ustawienia, w sekundach. jeśli 0, nie zapisuje automatycznie. away_reason typ: tekst domyślna wartość: brak domyślny opis stanu zajętego, ustawiany przy zmianie bez podania parametru. back_reason typ: tekst domyślna wartość: brak domyślny opis stanu dostępnego, ustawiany przy zmianie bez podania parametru. beep typ: bool domyślna wartość: 1 określa, czy klient ma beepać w różnych sytuacjach. wyłączenie tej opcji spowoduje, że w przypadku żadnych zdarzeń związanych z GG nie będzie podnosić alarmu. niestety nie obejmuje to zdarzeń związanych z wprowadzanym tekstem i przy tab-completion może się to przytrafić. beep_msg typ: bool domyślna wartość: 1 czy beepać przy nadchodzących wiadomościach. wyłączenie ,,beep'' wyłącza również tą opcję. beep_chat typ: bool domyślna wartość: 1 czy beepać przy rozmowach. wyłączenie ,,beep'' wyłącza również tą opcję. beep_notify typ: bool domyślna wartość: 1 czy beepać przy zmianie stanu któregoś ze znajomych. wyłączenie ,,beep'' wyłącza również tą opcję. completion_notify typ: liczba domyślna wartość: 1 określa, czy po pojawieniu się któregoś ze znajomych jego nick ma być dopisywany do listy dopełniania klawiszem Tab. jeśli jest równa 2, jest również usuwany po przejściu w stan niedostępny. ctrld_quits typ: bool domyślna wartość: 1 określa, czy wciśnięcie Ctrl-D w ostatnim okienku, nie będąc w trybie rozmowy klient na zakończyć działanie. dcc typ: bool domyślna wartość: 0 włącza lub wyłącza bezpośrednie połączenia między klientami. zmiana tej opcji wymaga ponownego połączenia z serwerem, by przesłać nowy adres IP, lub jego brak. dcc_ip typ: tekst domyślna wartość: brak określa adres IP, który jest wysyłany serwerowi. póki co, jest wymagana do bezpośredniego połączenia, ponieważ ekg nie potrafi wykryć domyślnego adresu IP. dcc_dir typ: tekst domyślna wartość: brak określa katalog, do którego będą zapisywane pobierane pliki. display_ack typ: liczba domyślna wartość: 1 określa, czy i które powiadomienia o wysłaniu wiadomości mają być wyświetlane. 0 - żadne, 1 - wszystkie, 2 - tylko kiedy wiadomość dotarła do adresata, 3 - tylko kiedy adresat jest niedostępny i wiadomość została zachowania na serwerze. display_color typ: bool domyślna wartość: 1 wartość 0 wyłącza wyświetlanie kolorów, wartość 1 włącza. display_notify typ: liczba domyślna wartość: 1 wartość 0 powoduje ignorowanie zmian stanu znajomych, wartość 1 powoduje wyświetlanie wszystkich zmian, wartość 2 wyświetla tylko zmiany z niedostępnego na dostępny i na odwrót. display_sent typ: bool domyślna wartość: 0 jeśli włączone, wyświetlane są również wysyłane wiadomości. należy zwrócić uwagę, że przy make_window = 2, wysłanie wiadomości utworzy automatycznie okienko rozmowy. emoticons typ: bool domyślna wartość: 1 uruchamia rozwijanie emotikonów w zdefiniowane teksty. więcej szczegółów w pliku docs/emoticons.txt encryption typ: liczba domyślna wartość: 0 wybiera rodzaj szyfrowania wiadomości. jeśli w systemie jest zainstalowana biblioteka OpenSSL możliwe jest używanie SIM (wartość 1). opis tego szyfrowania znajduje się na stronie http://gg.wha.la/ggcrypt/. enter_scrolls typ: bool domyślna wartość: 0 jeśli włączone, wciśnięcie klawisza Enter w pustej linii spowoduje przesunięcie ekranu o jedną linię. keep_reason typ: bool domyślna wartość: 0 jeśli włączona, komendy ,,away'', ,,back'', ,,invisible'' i ,,quit'' bez podanego powodu przejmą aktualny opis. last typ: liczba domyślna wartość: 0 wskazuje czy zapisywać ostatnie wiadomości do podręcznego bufora (last_size musi być większe od 0). dla 1, będzie zapisywać tylko last_size wszystkich wiadomości przychodzących, dla 2, last_size wiadomości od każdego usera. dostępna jest jeszcze logiczna wartość 4, która pozwala logować wiadomości wysłane. dostępne są w takim razie wartości 0, 1, 2, 5 i 6. last_size typ: liczba domyślna wartość: 0 wskazuje ile ma być zapisywanych wiadomości dla komendy ,,last''. log typ: liczba domyślna wartość: 0 określa czy i w jaki sposób będą logowane wysyłane i otrzymywane wiadomości. dla 0, nie będą. dla 1, będą logowane w pliku, który określa zmienna ,,log_path'' lub ,,~/.gg/history'' w przypadku jej braku. dla 2, będą logowane w katalogu wskazanym przez zmienną ,,log_path'', a nazwa pliku będzie numerem rozmówcy. jeśli mamy wkompilowaną obsługę skompresowanych logów, dodanie wartości 4 wymusi kompresję logów. nie będzie ona działała, jeśli istnieje już nieskompresowany log. należy go wcześniej skompresować poleceniem gzip. log_ignored typ: liczba domyślna wartość: 0 określa czy logujemy ignorowane wiadomości. log_status typ: bool domyślna wartość: 0 określa czy będą logowane zmiany statusu ludzi z listy (zmienne ,,log'' oraz ,,display_notify'' muszą być różne od 0) log_path typ: tekst domyślna wartość: brak ścieżka, gdzie będą zachowywane wysyłane i otrzymane wiadomości. log_timestamp typ: tekst domyślna wartość: brak określa format czasu zapisywanego w historii. w przypadku braku, zmiennej, zapisuje w postaci ilości sekund od 1 stycznia 1970r. UTC. dokładny opis formatu zawiera strona manuala strftime(3). make_window typ: int domyślna wartość: 0 określa czy będą tworzone nowe okienka dla przychodzących wiadomości od nowych rozmówców. dla 1 będzie wykorzystane do nowego query pierwsze wolne okno (na którym z nikim jeszcze się nie rozmawia), lub tworzone nowe w przypadku braku wolnych. dla 2 bezwarunkowo utworzone zostanie nowe okienko. proxy typ: tekst domyślna wartość: brak adres i port serwera proxy, oddzielone przecinkiem. jeśli nie podano portu, domyślnie jest przyjmowany 8080. query_commands typ: bool domyślna wartość: 1 możliwość wydawania długich poleceń podczas rozmowy z użytkownikiem bez poprzedzania ich znakiem '/'. quit_reason typ: tekst domyślna wartość: brak domyślny opis stanu niedostępnego, ustawiany przy wychodzeniu. random_reason typ: liczba domyślna wartość: 0 określa czy przy zmianie stanu ma być losowany opis (z ~/.gg/quit.reasons dla komend quit, disconnect, invisible, ~/.gg/away.reasons dla away i ~/.gg/back.reasons dla back). dla 0 nie jest losowany, dla 1 losowany jest opis dotyczący stanu zajęty, dla 2 niedostępny, dla 4 dostępny, dla 8 niewidoczny. wartości te można ze sobą dodawać, np. 11 będzie dotyczyć stanów niedostępny, zajęty oraz niewidoczny. jeżeli z jakichś przyczyn nie powiedzie się odczyt, opis będzie pobierany ze zmiennych ,,away_reason'' lub ,,quit_reason'', o ile nie są puste. save_password typ: bool domyslna wartość: 1 określa czy hasło ma być zapisywane w pliku konfiguracyjnym. opcja ta może przydać się, gdy boimy się administratora przeglądającego pliki użytkowników. server typ: tekst domyślna wartość: brak adresy IP serwerów, z którym klient powinien próbować się połączyć, pomijając właściwą procedurę łączenia się. przydane podczas awarii głównego serwera. adresy należy oddzielać przecinkami, średnikami lub spacjami. po dwukropku można podać port serwera. sms_away typ: bool domyślna wartość: 0 włączenie tej opcji powoduje wysyłanie otrzymanych wiadomości na telefon komórkowy podczas nieobecności (stan ,,zajęty''). wymaga zdefiniowania zmiennych ,,sms_number'' i ,,sms_send_app''. sms_max_length typ: liczba domyślna wartość: 100 maksymalna długość przekazywanych wiadomości. powyżej tego limitu wiadomość zostanie ucięta. sms_number typ: tekst domyślna wartość: brak numer telefonu komórkowego, na który mają być wysyłane wiadomości podczas nieobecności. sms_send_app typ: tekst domyślna wartość: brak pełna ścieżka do programu wysyłającego SMSy. program musi za pierwszy parametr przyjmować numer odbiorcy, za drugi parametr treść wiadomości. do tego celu nadaje się program Mikołaja Rydzewskiego ze strony http://ceti.pl/~miki/ sort_windows typ: bool domyślna wartość: 0 włączenie tej opcji spowoduje przesuwanie okien przy usunięciu któregoś ze środka i likwidowanie luk w numeracji. na przykład, gdy mamy okna 1,2,3, to po usunięciu drugiego otrzymamy 1,2 zamiast 1,3. sound_app typ: tekst domyślna wartość: brak pełna ścieżka do programu odtwarzającego pliki zdefiniowane w zmiennych ,,sound_{msg,chat,sysmsg}_file''. program musi brać za pierwszy (i jedyny) parametr nazwę pliku. wavplay i mpg123 doskonale się nadają. sound_msg_file typ: tekst domyślna wartość: brak plik dźwiękowy odtwarzany po otrzymaniu wiadomości. sound_chat_file typ: tekst domyślna wartość: brak plik dźwiękowy odtwarzany w czasie rozmowy. sound_sysmsg_file typ: tekst domyślna wartość: brak plik dźwiękowy odtwarzany po otrzymaniu wiadomości systemowej. speech_app typ: tekst domyślna wartość: brak aplikacja używana do odczytywania tekstów wyświetlanych na ekranie. jej ustawienie powoduje również zmianę wyglądu programu na taki, który jest łatwiejszy do wymówienia. tab_command typ: tekst domyślna wartość: "chat" komenda, która będzie wstawiana w linii poleceń z kolejną osobą z listy kontaktów po wciśnięciu klawisza Tab. theme typ: tekst domyślna wartość: brak zawiera nazwę pliku określającego wygląd klienta (ang. theme) timestamp typ: tekst domyślna wartość: brak w interfejsie ncurses określa format czasu wyświetlanego na początku każdej linii. dokładny opis formatu zawiera strona manuala strftime(3). status typ: liczba, zmienna wewnętrzna, ukryta określa stan klienta (zajęty/niewidoczny/tylko dla przyjaciół) po uruchomieniu i pierwszym połączeniu. zachowywana przy poleceniu ,,save''. reason typ: tekst, zmienna wewnętrzna, ukryta określa opis stanu klienta po uruchomieniu i pierwszym połączeniu. zachowywana przy poleceniu ,,save''. debug typ: bool, zmienna wewnętrzna, ukryta określa czy klient i biblioteka mają wyświetlać dodatkowe informacje na temat tego, co się dzieje. dla zwykłych użytkowników nieprzydatna. może co najwyżej pomóc w przypadku dziwnych błędów. protocol typ: liczba, zmienna wewnętrzna, ukryta określa wersję klienta, którą przedstawia się ekg. może być używana do udawania nowszego klienta, gdy biblioteka jeszcze jej nie zna. zmienna ta nie powinna być używana przez zwykłych użytkowników. $Id: vars.txt,v 1.38 2002/10/29 12:47:04 wojtekka Exp $