catman - tworzy lub aktualizuje preformatowane strony podręcznika
ekranowego
catman [
-d?V] [
-M ścieżka] [
-C
plik] [
sekcja] ...
catman służy do tworzenia i aktualizacji zestawu
preformatowanych stron podręcznika znanych jako strony cat (cat pages).
Wyświetlanie stron "cat" jest na ogół
dużo szybsze niż wyświetlenie pierwotnych stron man,
jednakże strony "cat" wymagają dodatkowego miejsca na
ich składowanie. Decyzja o obsłudze stron "cat"
należy do lokalnego administratora, który musi zapewnić
odpowiednie katalogi do ich przechowywania.
Opcje polecenia
catman opisują hierarchie stron podręcznika
man oraz sekcje, które mają podlegać preformatowaniu.
Domyślnymi hierarchiami (drzewami katalogów) są te,
które określono jako systemowe w pliku konfiguracyjnym man-db.
Domyślne sekcje określa albo podzielona dwukropkami
zawartość zmiennej środowiska $
MANSECT, albo
zestaw standardowy wkompilowany w
man, jeżeli $
MANSECT
jest niezdefiniowana. Wywołanie
catman z zestawem rozdzielonych
białymi znakami nazw sekcji nadpisuje powyższe ustawienia
domyślne.
catman do ustalenia, które z plików powinny zostać
sformatowane, korzysta z
indeksów baz danych (index database
cache) związanych z każdą z hierarchii.
-
-d, --debug
- Wyświetla informację diagnostyczną
(debug).
-
-M ścieżka, --manpath=ścieżka
- Określa alternatywną, rozdzieloną
dwukropkami, ścieżkę przeszukiwań hierarchii
stron podręcznika (manpath). Domyślnie są to
wszystkie ścieżki wskazane jako systemowe w pliku
konfiguracyjnym man-db.
-
-C plik, --config-file=plik
- Używa podanego pliku konfiguracyjnego
użytkownika zamiast domyślnego ~/.manpath.
-
-?, --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.
- MANSECT
- Jeżeli ustawiona jest $MANSECT, to jej
wartość jest listą oddzielonych dwukropkami sekcji i
służy do określania, które sekcje
podręcznika man i w jakiej kolejności będą
przeszukiwane. Domyślną wartością jest "1
n l 8 3 0 2 3type 3posix 3pm 3perl 3am 5 4 9 6 7", chyba że
zostanie to nadpisane w polu SECTION pliku
/etc/manpath.config.
- MANPATH
- Jeżeli ustawiona jest $MANPATH, to jej
wartość jest interpretowana jako wskazana do użycia
ścieżka przeszukiwań hierarchii stron man.
Ścieżka zawiera rozdzielone dwukropkami nazwy hierarchii
(katalogów).
See the SEARCH PATH section of manpath(5) for the default
behaviour and details of how this environment variable is handled.
- /etc/manpath.config
- Plik konfiguracyjny man-db.
- /usr/man/index.(bt|db|dir|pag)
- Tradycyjny globalny indeks bazy danych.
- /var/catman/index.(bt|db|dir|pag)
- Alternatywny lub zgodny z FSSTND globalny indeks
bazy danych.
man(1),
manpath(5),
mandb(8)
Wilf. ([email protected]).
Fabrizio Polacco ([email protected]).
Colin Watson ([email protected]).
https://gitlab.com/man-db/man-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db
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.