Rozdział 2. Konfiguracja programu

Program uruchamia się komendą:

/opt/szarp/bin/scc

Powinien być uruchamiany przy starcie menedżera okien. Można to osiągnąć bądź w sposób specyficzny dla danego menedżera okien (grupa Autostart itp.), bądź też w sposób ogólny. Obecnie najlepszym sposobem jest umieszczenie odpowiedniego pliku w katalogu /etc/xdg/autostart (zgodnie ze standardami FreeDesktop.org). Operacja ta jest robiona automatycznie przy instalacji programu z pakietu.

SCC pozwala na uruchomienie tylko jednej swojej kopii dla każdego użytkownika (ma to znaczenie dla serwerów, do których łączy się kilka X-terminali).

Uruchomienie programu z opcją -h lub --help spowoduje wypisanie krótkiej informacji o dostępnych opcjach.

SCC korzysta z biblioteki libparnt, a więc czyta opcje z pliku /etc/szarp/szarp.cfg, przy czym jest możliwość wpływania na te opcje z linii komend, za pomocą opcji typu '-Dprefix=byto'.

SCC wywołany z opcją -reload_menu powiadamia już działającą instancję aplikacji, by ponownie wczytała plik konfiguracyjny /etc/szarp/szarp.cfg. Spowoduje to zbudowanie od nowa głównego menu. Program SCC wywołany z powyższą opcją po przekazaniu komunikatu kończy działanie. Program SCC w trakcie normalnego działania domyślnie przeładowywuje konfigurację co pewien odstęp czasu, także zamiast wywoływania tej opcji można też po prostu poczekać.

Sekcja w pliku /etc/szarp/szarp.cfg dotycząca programu nazywa się scc i może zawierać następujące parametry (wielkość liter w nazwach elementów nie ma znaczenia):

• hide_aggregated - parametr określa, czy w menu tworzonym przez dyrektywę DRAWS nie powinny pojawić się składowe konfiguracji agregowanych, jeżeli konfiguracje agregowane są w menu obecne. Dopuszczalne wartości parametru to yes i no. Domyślnie yes.

• dont_aggregate - lista przedzielonych przecinkami prefiksów konfiguracji, które nie są traktowane jako zagregowane w kontekście opcji hide_aggregated, czyli konfiguracje wchodzące w ich skład nie będą ukrywane nawet przy ustawionej tej opcji.

• update_command - ścieżka do komendy służącej do aktualizacji danych, jeżeli plik istnieje, w menu programu SCC pojawi się opcja "Aktualizuj dane", po wybraniu której uruchomiona zostanie podana komenda.

• su_command - jeżeli program SCC nie działa z UID 0, przed uruchomieniem programu podanego w opcji update_command zostanie uruchomiony program, którego ścieżkę zawiera parametr su_command, w celu zdobycia uprawnień super-użytkownika.

• use_ekstraktor3 - jeżeli opcja ma wartość "yes", to w tworzonym menu dodawana jest opcja pozwalająca na uruchomienie programu Ekstraktor.

• menu - parametr opisuje zawartość głównego menu programu. Opis ma postać listy wartości oddzielonych przecinkami, białe znaki są ignorowane. Każda z wartości może być postaci:

  • EXEC("tytuł", "komenda") - tytuł oznacza opis pozycji w menu, po jej wybraniu wykonywana jest podana komenda.

  • DRAW("nazwa", "prefix") - uruchomienie programu przeglądającego z podanym prefiksem konfiguracji.

  • DRAWS("wyrażenie_regularne") - generuje w miejscu wystąpienia listę elementów DRAW, dla konfiguracji, których prefixy pasują do zadanego wyrażenia regularnego. Nazwa tworzonych elementów DRAW to tytuł konfiguracji. Stworzone elementy DRAW są pogrupowane. Grupowanie odbywa się na podstawie tytułów konfiguracji, tj. konfiguracje, których tytuły dzielą ze sobą słowo nie pasujące do wyrażeń regularnych zawartych w dyrektywie DONTGROUPBY, są uznawane za należące do tej samej grupy i zostają umieszczone w osobnym podmenu. Jeżeli w menu istnieje już element DRAW odwołujący się do danej konfiguracji, nie zostanie on przez DRAWS dodany.

  • DONTGROUPBY("wyrażenie_regularne",...) - specyfikuje listę wyrażeń regularnych używanych przy grupowaniu elementów DRAW generowanych przez dyrektywę DRAWS. Podczas dopasowywania wyrażeń regularnych uwzględniana jest wielkość liter.

  • DOC - tworzy pozycję menu o nazwie "Dokumentacja SZARP", uruchamiającą program wxhelp wyświetlający dokumentację SZARP'a.

  • ICON("ikona") - dodanie do poprzedniej pozycji menu ikony (obrazka), ładowanego z pliku o podanej ścieżce. Ikona może być w dowolnym formacie obsługiwanym przez bibliotekę wxWindows, w praktyce powinien to być plik typu 'XPM', z ikoną o wielkości 16 na 16 punktów, z paletą 3 bajtową (opisy kolorów bez przezroczystości).

  • MENU("nazwa", ...) - wstawia menu podrzędne o podanej nazwie, zawierające elementy z podanej po nazwie listy elementów.

  • CONFIG("prefix") - jest równoważny liście elementów, zawierających wszystkie raporty oraz program przeglądający dla konfiguracji o danym prefiksie. Informacja o strukturze raportów jest wczytywana automatycznie pod warunkiem, że konfiguracja jest zgodna z formatem IPK. Jeżeli w katalogu config konfiguracji istnieje plik params.xml, to zostaną odczytane informacje z niego. Jeżeli nie, to podjęta będzie próba odczytania konfiguracji z plików w formacie SZARP 2.1.

  • SEPARATOR - pozioma linia oddzielająca pozycje menu.

Jak zaznaczono w powyższym opisie, wszystkie ciągi tekstowe podawane jako parametry muszą być w podwójnych cudzysłowach. Znak '\' jest znakiem specjalnym, kolejny znak po nim jest traktowany jak część napisu, wobec tego można użyć cudzysłowu przez '\"', zaś sam backslash wstawimy przez '\\'.

Dla ułatwienia wykrywania błędów program wypisuje na standardowe wyjście wykonywane komendy, wobec tego można uruchomić go w terminalu i obserwować, jakie komendy są wywoływane. Domyślną wartość parametru menu jest następująca:

menu = CONFIG("$prefix$"), SEPARATOR, DOC, \
	ICON("/opt/szarp/resources/wx/icons/szarp16.xpm")

Tak więc, o ile konfiguracja jest zgodna z IPK, nie podanie żadnej wartości powoduje stworzenie menu z wszystkimi raportami i programem przeglądającym dla konfiguracji (oraz dokumentacją SZARP). Przykładowa konfiguracja może wyglądać tak:

:scc
menu= 	CONFIG("kato"), \
	EXEC("Dyspozytor", "/opt/szarp/bin/dyspwx \
		-Dprefix=kato /opt/szarp/kato/config/t.dsc"), \
	ICON("/opt/szarp/resources/wx/icons/dysp16.xpm"), \
	SEPARATOR, \
	MENU("Inne ciepłownie", \
		DRAW("Bytów", "byto"), \
		ICON("/opt/szarp/resources/wx/icons/draw16.xpm"), \
		DRAW("Świdnik", "swid"), \
		ICON("/opt/szarp/resources/wx/icons/draw16.xpm"), \
		DRAWS(".*") \
	), \
	SEPARATOR, \
	DOC, \
	ICON("/opt/szarp/resources/wx/icons/szarp16.xpm"), \
	DONTGROUPBY("Ciepłownia", "Węzeł", ".*EC$")