LEXGROG

NAZWA
SKÅADNIA
OPIS
OPCJE
KOD ZAKOÅCZENIA
PRZYKÅADY
PRZETWARZANIE WHATIS
ZOBACZ TAKŻE
UWAGI
AUTOR
BÅÄDY
TÅUMACZENIE

---

NAZWA

lexgrog − przetwarza nagÅówki stron podrÄcznika ekranowego

SKÅADNIA

lexgrog [−m|−c] [−dfw?V] [−E kodowanie_znaków] plik …

OPIS

lexgrog jest implementacjÄ w lexie tradycyjnych narzÄdzi “zgadywanki groffa”. Ze swojej linii poleceÅ czyta listÄ plików, które mogÄ byÄ albo źródÅami stron podrÄcznika albo preformatowanymi stronami “cat”, i wyÅwietla ich nazwy i opisy, tak jak sÄ używane przez apropos i whatis, albo listÄ filtrów preprocesora wymaganych przez stronÄ podrÄcznika zanim zostanie przekazana do nroff lub troff, albo obie te listy.

Jeżeli wejÅcie lexgrog jest w zÅym formacie, to wypisze on komunikat “parse failed”; może to byÄ użyteczne dla zewnÄtrznych programów sprawdzajÄcych poprawnoÅÄ stron podrÄcznika. Jeżeli jednym z plików wejÅciowych lexgroga jest “−”, to bÄdzie czytaÅ ze swojego standardowego wejÅcia; jeÅli plik wejÅciowy jest skompresowany, to go automatycznie zdekompresuje.

OPCJE

−d, −−debug

WyÅwietla informacjÄ diagnostycznÄ (debug).

−m, −−man

Przetwarza wejÅcie jako pliki źródÅowe stron podrÄcznika ekranowego. Jest to zachowanie domyÅlne, jeÅli nie podano ani −−man, ani −−cat.

−c, −−cat

Przetwarza wejÅcie jako sformatowane wczeÅniej strony podrÄcznika ekranowego (“strony cat”). −−man i −−cat nie mogÄ byÄ użyte jednoczeÅnie.

−w, −−whatis

WyÅwietla nazwÄ i opis z nagÅówka strony podrÄcznika ekranowego, używanego przez apropos i whatis. Jest to domyÅlne zachowanie, jeżeli nie podano ani −−whatis, ani −−filters.

−f, −−filters

WyÅwietla listÄ filtrów potrzebnych do wstÄpnego przetworzenia strony podrÄcznika zanim zostanie sformatowana przez program nroff lub troff.

−E kodowanie_znaków, −−encoding kodowanie_znaków

Nadpisuje odgadniÄte kodowanie znaków strony podrÄcznika, ustawiajÄc je na kodowanie_znaków.

−?, −−help

WyÅwietla komunikat pomocy i koÅczy pracÄ.

−−usage

WyÅwietla krótki opis użycia programu i koÅczy pracÄ.

−V, −−version

WyÅwietla informacjÄ o wersji.

KOD ZAKOÅCZENIA

	0		Program zakoÅczony bez żadnych bÅÄdów.
	1		BÅÄd użycia.
	2		lexgrog nie umiaÅ przetworzyÄ jednego lub wiÄcej spoÅród plików wejÅciowych.

PRZYKÅADY

$ lexgrog man.1
man.1: “man − an interface to the system reference manuals”
$ lexgrog −fw man.1
man.1 (t): “man − an interface to the system reference manuals”
$ lexgrog −c whatis.cat1
whatis.cat1: “whatis − display manual page descriptions”
$ lexgrog broken.1
broken.1: parse failed

PRZETWARZANIE WHATIS

mandb (oparty na tym samym kodzie, co lexgrog) przetwarza sekcjÄ NAZWA (NAME) znajdujÄcÄ siÄ samej górze strony podrÄcznika ekranowego, szukajÄc w niej nazw i opisów. Mimo że parser jest caÅkiem tolerancyjny, ponieważ musi sobie radziÄ z rożnymi formatami, które byÅy używane na przestrzeni lat, to jednak czasem nie potrafi wyciÄgnÄÄ potrzebnych informacji.

Jeżeli używany jest tradycyjny zbiór makr man, to poprawna sekcja NAZWA wyglÄda tak jak poniżej:

.SH NAZWA
foo − program, który coÅ robi

Niektóre programy do obsÅugi stron podrÄcznika wymagajÄ, aby separator ‘−’ byÅ dokÅadnie taki, jak to pokazano; mandb jest bardziej tolerancyjny, jednakże w celu zachowania kompatybilnoÅci z innymi systemami dobrym pomysÅem jest pozostawienie znaku odwrotnego ukoÅnika.

Po lewej stronie może wystÄpowaÄ kilka nazw, rozdzielonych od siebie przecinkami. Nazwy zawierajÄce biaÅe znaki sÄ ignorowane, aby uniknÄÄ nieprawidÅowego zachowania przy niektórych źle sformatowanych sekcjach NAZWA. Tekst po prawej stronie ma dowolnÄ postaÄ i może zajmowaÄ wiele linii. Jeżeli w tej samej stronie podrÄcznika udokumentowanych jest kilka programów z różnymi opisami, powinna byÄ użyta poniższa forma:

.SH NAZWA
foo, bar − programy, które coÅ robiÄ
.br
baz − program, który nic nie robi

(Zamiast makra .br można użyÄ makra, które zaczyna nowy akapit, na przykÅad .PP.)

Podczas używania pochodzÄcego z systemów BSD zbioru makr mdoc poprawna sekcja NAZWA powinna wyglÄdaÄ tak jak poniżej:

.Sh NAZWA
.Nm foo
.Nd program, który coŠrobi

Jest kilka powszechnych przyczyn, dla których przetwarzanie whatis koÅczy siÄ fiaskiem. Czasami autorzy stron podrÄcznika zastÄpujÄ ‘.SH NAZWA’ przez ‘.SH MÃJPROGRAM’, co powoduje, że mandb nie potrafi odnaleÅºÄ potrzebnych informacji. Czasami autorzy umieszczajÄ wprawdzie sekcjÄ NAZWA, ale zawierajÄ w niej dowolny tekst zamiast używaÄ ‘nazwa − opis’. Jednakże każda skÅadania przypominajÄca powyższÄ powinna byÄ akceptowana.

ZOBACZ TAKŻE

apropos(1), man(1), whatis(1), mandb(8)

UWAGI

lexgrog próbuje przetwarzaÄ pliki zawierajÄce żÄdania .so, jednakże bÄdzie zdolny to zrobiÄ tylko wtedy, gdy pliki te sÄ poprawnie zainstalowane w hierarchii stron podrÄcznika ekranowego.

AUTOR

Autorami kodu używanego przez program lexgrog do przetwarzania stron podrÄcznika sÄ:

Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).

Colin Watson napisaÅ obecne wcielnie interfejsu linii poleceÅ i tÄ stronÄ podrÄcznika ekranowego.

BÅÄDY

https://savannah.nongnu.org/bugs/?group=man-db

TÅUMACZENIE

Wojciech Kotwica w 1999 roku przetÅumaczyÅ czÄÅÄ stron podrÄcznika pakietu man-db i udostÄpniÅ je w ramach Projektu TÅumaczenia Manuali.
Robert Luberda tÅumaczenie zaktualizowaÅ i uzupeÅniÅ w roku 2008.

---