Plugin: xmsg

Zmienne

max_inotifycount

Typ.  liczba

Domyślna wartość.  25

Maksymalna ilość powiadomień inotify, jakie mogą być obsłużone podczas
jednego wywołania pętli. Po przekroczeniu tej ilości, pozostałe
powiadomienia (w serii) są ignorowane, a także tworzony jest timer
wznawiający skanowanie (patrz: zmienna sesyjna oneshot_resume_timer).


Zmienne sesyjne

alias

Typ.  tekst

Domyślna wartość.  brak

krótka nazwa sesji

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_away_descr

Typ.  tekst

Domyślna wartość.  brak

Opis ustawiany przy przejściu w auto-away. Jeśli nieustawione, zmiana
opisu nie nastąpi. Dozwolone są następujące sekwencje specjalne:

	%?	wypisz następne znaki, jeśli opis jest ustawiony

	%!	wypisz następne znaki, jeśli opis nie jest ustawiony

	%/	zawsze wypisz następne znaki (wyłącza powyższe)

	%$	wypisz aktualny opis

	%%	wypisz '%'

auto_xa

Typ.  liczba

Domyślna wartość.  0

wartość określająca, po jakim czasie stan użytkownika zostanie
zmieniony na ,,bardzo zajęty''. podaje się w sekundach. jeśli
równa 0, nie będzie automatycznej zmiany.

auto_xa_descr

Typ.  tekst

Domyślna wartość.  brak

Opis ustawiany przy przejściu w auto-xa. Jeśli nieustawione, zmiana
opisu nie nastąpi. Dozwolone są następujące sekwencje specjalne:

	%?	wypisz następne znaki, jeśli opis jest ustawiony

	%!	wypisz następne znaki, jeśli opis nie jest ustawiony

	%/	zawsze wypisz następne znaki (wyłącza powyższe)

	%$	wypisz aktualny opis

	%%	wypisz '%'

auto_back

Typ.  liczba

Domyślna wartość.  0

wartość określająca, czy stan ma być automatycznie zmieniany na
dostępny, jeśli obecny stan ,,zajęty'' został ustawiony automatycznie.
jeśli równa 1, stan jest zmieniany na dostępny przy wysłaniu
jakiejkolwiek wiadomości. jeśli równa 2, przy wciśnięciu klawisza.

auto_connect

Typ.  bool

Domyślna wartość.  0

wartość określająca, czy dana sesja ma się łączyć wraz z uruchomieniem
programu

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.


Zmienne sesyjne

auto_connect

Typ.  bool

Domyślna wartość.  1

Określa, czy sesja będzie łączona automagicznie przy starcie programu.

charset

Typ.  tekst

Domyślna wartość.  brak

Kodowanie używane w wiadomościach przychodzących i wychodzących. Jeśli
nieustalone, xmsg nie będzie dokonywał konwersji - tzn. wykorzystane
będzie aktualne kodowanie ekg2.

dotfile_suffix

Typ.  tekst

Domyślna wartość.  brak

Określa sufiks dodawany do ukrytych plików tworzonych po odebraniu
wiadomości. Opcja ta pozwala obsługiwać jeden katalog wiadomości przez
kilka niezależnych od siebie klientów.

max_filesize

Typ.  liczba

Domyślna wartość.  16384

Plik większe niż wartość tej zmiennej, będą ignorowane (lub usuwane)
przez wtyczkę.

max_oneshot_files

Typ.  liczba

Domyślna wartość.  25

Maksymalna liczba plików, jakie przetworzone zostają podczas jednego
wywołania funkcji skanującej. Po przekroczeniu tej liczby, funkcja jest
wstrzymywana i tworzony jest timer ponawiający, patrz:
oneshot_resume_timer. Wartość zerowa oznacza brak ograniczenia.

name_separator

Typ.  tekst

Domyślna wartość.  .

Separator oddzielający zasadniczą część nazwy (używaną w UID-ach)
od sufiksu. Nazwa pliku będzie łamana na ostatnim wystąpieniu tego
znaku. Wartość nieustalona wyłącza dzielenie. W przypadku podania
większej liczby znaków, brany będzie pod uwagę ten, występujący
najbliżej końca nazwy pliku.

oneshot_resume_timer

Typ.  liczba

Domyślna wartość.  3

Określa czas (w sekundach), po jakim operacja wstrzymana po
przekroczeniu max_oneshot_files, zostaje wznowiona (aż do ponownego
przetworzenia określonej liczby plików). Jeśli zmienna ta będzie miała
wartość 0, operacja zostanie ponowiona dopiero przy kolejnym
niezależnym wywołaniu funkcji (np. przy kolejnym łączeniu sesji).

rescan_timer

Typ.  liczba

Domyślna wartość.  0 or 300

Interwał ponownego wczytywania katalogu wiadomości przychodzących.
Zmienna ta nie powinna być używana w środowiskach, wspierających
inotify, tak więc domyślnie ma tam wartość 0.

send_cmd

Typ.  tekst

Domyślna wartość.  (brak)

Polecenie używane do wysyłania wiadomości przy użyciu wtyczki.
Uruchomione będzie z dwoma argumentami - UID-em (bez xmsg:) oraz
ścieżką do pliku z wiadomością. Proszę zwrócić uwagę, że xmsg
nie sprawdza kodu zakończenia aplikacji/skryptu, tak więc wszelakie
błędy zwracane być winny poprzez użycie katalogu wiadomości
przychodzących.

unlink_sent

Typ.  bool

Domyślna wartość.  1

Określa, czy pliki wiadomości przychodzących powinny być usuwane
po odczytaniu. W przeciwnym razie, dla plików tych tworzone będą tzw.
dotfiles (ukryte pliki, informujące xmsg, że wiadomość już została
odczytana).

unlink_toobig

Typ.  bool

Domyślna wartość.  0

Określa, czy po napotkaniu pliku przekraczającego max_filesize, należy
go pomijać (0) czy też usunąć (1). W przypadku pomijania pliku, celem
uniknięcia ponawiania się komunikatu, plik taki będzie oznaczany za
pomocą tzw. dotfile (ukrytego pliku).