Provided by:
man-db_2.6.0.2-2_i386 
NAZWA
man - interfejs stron podrcznika ekranowego
SK/LADNIA
man [-C file] [-d] [-D] [--warnings[=ostrzeenia]] [-R kodowanie_znak'ow]
[-L ustawienia_jzykowe] [-m system[,...]] [-M path] [-S list] [-e
rozszerzenie] [-i|-I] [--regex|--wildcard] [--names-only] [-a] [-u]
[--no-subpages] [-P pager] [-r linia_zachty] [-7] [-E kodowanie_znak'ow]
[--no-hyphenation] [--no-justification] [-p /lacuch_znak'ow] [-t]
[-T[urzdzenie]] [-H[przegldarka]] [-X[dpi]] [-Z] [[sekcja]
strona ...] ...
man -k [opcje_apropos] wyra_regularne ...
man -K [-w|-W] [-S lista] [-i|-I] [--regex] [strona] termin ...
man -f [opcje_whatis] strona ...
man -l [-C plik] [-d] [-D] [--warnings[=ostrzeenia]] [-R
kodowanie_znak'ow] [-L ustawienia_jzykowe] [-P pager] [-r linia_zachty]
[-7] [-E kodowanie_znak'ow] [-p /lacuch_znak'ow] [-t] [-T[urzdzenie]]
[-H[przegldarka]] [-X[dpi]] [-Z] plik ...
man -w|-W [-C plik] [-d] [-D] strona ...
man -c [-C plik] [-d] [-D] strona ...
man [-hV]
OPIS
Program man jest systemow przegldark stron podrcznika ekranowego. Kady
argument strona przekazany programowi man jest zazwyczaj nazw programu,
narzdzia uytkowego lub funkcji. man wyszukuje i wywietla strony
podrcznika skojarzone z tym argumentem. Sekcja, jeli j podano,
spowoduje, e man bdzie przeszukiwal tylko t sekcj podrcznika. Domylnie
wyszukuje we wszystkich dostpnych sekcjach, uywajc predefiniowanego
porzdku i pokazuje tylko pierwsz znalezion stron, nawet jeli podana
strona jest dostpna w kilku sekcjach.
Ponisza tabela pokazuje numery sekcji wraz z opisem odpowiadajcych im
typow stron, ktore zawieraj.
1 Programy wykonywalne lub polecenia powloki
2 Wywolania systemowe (funkcje dostarczane przez jdro systemu)
3 Wywolania biblioteczne (funkcje w bibliotekach programow)
4 Pliki specjalne (ktore zazwyczaj mona znale w /dev)
5 Formaty plikow i konwencje, np. /etc/passwd
6 Gry
7 Ronorodne (lcznie z pakietami makr i konwencjami), np. man(7),
groff(7)
8 Polecenia do administracji systemem (zazwyczaj tylko dla
administratora)
9 Wywolania jdra [Niestandardowa]
Strona podrcznika sklada si z kilku sekcji.
Zgodnie z tradycj nazwy sekcji zawieraj NAZWA (NAME), SK/LADNIA
(SYNOPSIS), KONFIGURACJA (CONFIGURATION), OPIS (DESCRIPTION), OPCJE
(OPTIONS), KOD ZAKOCZENIA (EXIT STATUS), WARTO ZWRACANA (RETURN VALUE),
B/LDY (ERRORS), RODOWISKO (ENVIRONMENT), PLIKI (FILES), WERSJE
(VERSIONS), ZGODNE Z (CONFORMING TO), UWAGI (NOTES), B/LDY (BUGS),
PRZYK/LAD (EXAMPLE), AUTORZY (AUTHORS) oraz ZOBACZ TAKE (SEE ALSO).
Ponisze konwencje maj zastosowanie do sekcji SK/LADNIA, ale mog by
traktowane jako przewodnik po innych sekcjach.
tekst pogrubiony wprowad dokladnie tak, jak pokazano.
kursywa zastp odpowiednim argumentem.
[-abc] wszystkie argumenty w [ ] s opcjonalne.
-a|-b opcji rozdzielonych znakiem | nie mona lczy.
argument ... argument mona powtarza.
[wyraenie] ... cale wyraenie w [ ] mona powtarza.
Sposob, w jaki bdzie wywietlona strona podrcznika, zaley od urzdzenia
wyjciowego. Na przyklad man zazwyczaj nie bdzie mogl wywietli czcionki
kursywej, jeli jest uruchomiony na terminalu, wic zamiast niej uyje
podkrele lub zmieni kolor czcionki.
Przyklady uycia polecenia lub funkcji powinny zawiera wszystkie moliwe
wywolania. W pewnych przypadkach doradza si obrazowa wykluczajce si
wywolania w taki sposob, jak to zrobiono w sekcji SK/LADNIA tej strony
podrcznika ekranowego.
PRZYK/LADY
man ls
Wywietla stron podrcznika ekranowego dla danej pozycji (programu)
ls.
man -a intro
Wywietla kolejno wszystkie dostpne strony podrcznika intro. Mona
przerwa wywietlanie pomidzy kolejnymi stronami lub pomin
ktorkolwiek z nich.
man -t alias | lpr -Pps
Formatuje stron podrcznika opisan przez "alias", czyli zazwyczaj
stron podrcznika powloki, przy pomocy domylnego formatu troff lub
groff i wysyla j do drukarki nazwanej ps. Domylnym wyjciem groffa
jest zazwyczaj PostScript. man --help poda, ktory procesor jest
przypisany do opcji -t.
man -l -Tdvi ./foo.1x.gz > ./foo.1x.dvi
To polecenie rozpakuje i sformatuje rodla nroff strony podrcznika
./foo.1x.gz do pliku niezalenego od urzdzenia (dvi). Przekierowanie
jest konieczne, poniewa opcja -T powoduje, e wyjcie bdzie wyslane
bezporednio do stdout, bez uycia programu pager. Wyjcie mona
przeglda programem takim jak xdvi albo przetworzy do PostScriptu,
uywajc na przyklad dvips.
man -k printf
Szuka slowa kluczowego printf jako wyraenia regularnego w krotkich
opisach i nazwach stron podrcznika. Wywietla wszystkie dopasowania.
Odpowiednik apropos -r printf.
man -f smail
Wyszukuje strony podrcznika opisane przez smail i wywietla krotki
opis kadej ze znalezionych stron. Odpowiednik whatis -r smail.
WPROWADZENIE
man udostpnia wiele opcji, aby dostosowa si do wymaga uytkownika
najlepiej, jak to jest tylko moliwe. Pozwala zmieni ciek wyszukiwania,
kolejno sekcji, program do przetwarzania stron i inne zachowania oraz
operacje, jak to opisano poniej
Na dzialanie programu man maj wplyw rone zmienne rodowiskowe, jeli
tylko zostan ustawione. Moliwe jest nadanie "wylapujcej wszystko"
zmiennej $MANOPT wartoci bdcej lacuchem znakow w formacie argumentow
linii polece, z tym wyjtkiem e wszystkie spacje uyte jako argumenty
opcji musz zosta poprzedzone znakiem odwrotnego ukonika. man przetworzy
$MANOPT przed odczytaniem linii polece, tak e opcje wymagajce argumentu
bd nadpisane przez takie same opcje podane w linii polece. Aby
przywroci domylne wartoci wszystkich opcji ustawionych w $MANOPT, mona
uy opcji -D, podanej jako pierwsza opcja linii polece. Opcja ta pozwala
programowi man "zapomnie" o opcjach podanych w $MANOPT, ktore jednake
wci musz by poprawne.
Programy uytkowe podrcznika ekranowego, znajdujce si w pakiecie man-db
w znacznym stopniu wykorzystuj indeksowane bufory baz danych, ktore
zawieraj midzy innymi informacje o lokalizacji kadej ze stron
podrcznika w systemie plikow czy o zawartoci whatis (krotkiego
jednoliniowego opisu strony podrcznika) i pozwalaj programowi man
dziala szybciej, ni gdyby musial za kadym razem wyszukiwa odpowiednie
strony podrcznika w systemie plikow. Jeeli tego zadano, podajc opcj -u,
to man zapewni cigl spojno buforow, co eliminuje potrzeb rcznego
uruchamiania oprogramowania aktualizujcego tradycyjne tekstowe bazy
danych whatis.
Jeeli man nie bdzie mogl znale zainicjowanej przez mandb indeksowanej
bazy danych dla pewnej hierarchii stron podrcznika, to wci bdzie
przeszukiwal t hierarchi, chocia w takim wypadku bdzie potrzebne uycie
przeszukiwania sytemu plikow. Jeli whatis lub apropos nie znajd
indeksu, bd probowaly znale potrzebne informacje w tradycyjnej bazie
danych whatis.
Narzdzia pakietu obsluguj spakowane pliki rodlowe nroff, majce
rozszerzenia .Z, .z i .gz. Podczas kompilacji pakietu moliwe jest
dodanie obslugi dowolnego rozszerzenia plikow skompresowanych. Take,
domylnie, wszystkie preformatowane strony "cat" bd kompresowane
programem gzip. Kada "globalna" hierarchia stron podrcznika, taka jak
/usr/share/man lub /usr/X11R6/man, moe mie dowolny katalog jako katalog
jej stron preformatowanych. Zgodnie z tradycj, strony "cat" s
przechowywane w tej samej hierarchii co strony podrcznika, ale z
powodow okrelonych w Standardzie hierarchii plik'ow (FHS), lepiej jest
je przechowywa w innym miejscu. Szczegoly, jak to zrobi mona znale w
manpath(5). Informacji, po co to robi, dostarcza wymieniony wyej
standard.
Pakiet obsluguje rownie strony w innych jzykach ni angielski. Strony
takie s dostpne (jeli znajduj si w systemie) przez uycie funkcji
ustawie jzykowych (locale). Aby wlczy t obslug naley zmienne
$LC_MESSAGES, $LANG albo inne, zalene od systemu, ustawi na kod jzyka w
poniszym formacie opisanym w standardzie POSIX 1003.1:
<jzyk>[_<terytorium>[.<zestaw_znak'ow>[,<wersja>]]]
Jeeli odpowiednia strona jest dostpna w Twoich ustawieniach_jzykowych,
to bdzie wywietlona zamiast wersji standardowej (czyli zazwyczaj
amerykaskiej).
Obsluga midzynarodowych katalogow wiadomoci, ktora jest rownie jedn z
zalet pakietu, moe by aktywowana w dokladnie ten sam sposob, oczywicie
jeeli katalogi wiadomoci s dostpne. Jeli strony podrcznika i komunikaty
nie s dostpne w Twoim jzyku, a chcialby je doda, prosimy o kontakt z
opiekunem pakietu, ktory bdzie koordynowal tlumaczenia.
Informacje o innych zaletach pakietu i rozszerzeniach w nim dostpnych
znajduj si w dokumentacji do niego dolczanej.
ZACHOWANIA DOMYLNE
man poszukuje danych stron podrcznika w indeksie bufora bazy danych.
Jeeli podano opcj -u, to przeprowadzane jest sprawdzanie spojnoci
bufora, aby zapewni, e baza danych odzwierciedla system plikow. Jeeli
zawsze uywa si tej opcji, to nie ma potrzeby powtornego uruchamiania
polecenia mandb po tym, jak bazy zostaly utworzone, chyba e zostala
uszkodzona. Jednake sprawdzanie spojnoci moe dziala powoli w systemach,
w ktorych zainstalowano wiele stron podrcznika ekranowego, dlatego te
opcja ta jest domylnie wylczona; administratorzy systemu mog uruchamia
mandb na przyklad co tydzie, aby utrzyma spojno baz danych. Aby
zapobiec problemom powodowanym przez przestarzaly indeks bazy danych, w
razie gdy man nie znajdzie danej strony w buforze, podejmie prob
wyszukania strony w rzeczywistym systemie plikow, tak jakby bufor bazy
danych nie byl obecny.
Po znalezieniu strony podrcznika, sprawdzane jest, czy istnieje
odpowiedni poprzednio sformatowany plik "cat", nowszy ni plik rodlowy
nroff. Jeeli istnieje i jest nowszy, to ten preformatowany plik jest
(zazwyczaj) rozpakowywany i wywietlany w przegldarce tekstu (ang.
pager). Program ten mona poda na kilka ronych sposobow, a jeli si go
nie poda, to zostanie uyta warto domylna (szczegoly mona znale w opisie
opcji -P). Jeeli nie znaleziono strony preformatowanej lub jest starsza
ni plik rodlowy nroff, to ten plik nroff jest filtrowany za pomoc
ronych programow, a nastpnie pokazywany.
Jeeli moe zosta utworzony plik "cat" (istnieje odpowiedni katalog majcy
odpowiednie prawa dostpu), to man skompresuje i zachowa plik "cat",
dzialajc w tle.
Filtry s rozszyfrowywane na wiele sposob. Najpierw brana jest pod uwag
opcja linii polece -p lub warto zmiennej rodowiskowej $MANROFFSEQ.
Jeeli nie podano -p, ani nie ustawiono zmiennej rodowiska, to
przetwarzana jest pocztkowa linia rodlowej strony nroff w poszukiwaniu
poprawnego oznaczenia preprocesora. Aby man znalazl poprawne oznaczenie
preprocesora, pierwsza linia musi sklada si z
'\" </lacuch_znak'ow>
gdzie /lacuch_znak'ow moe by dowoln kombinacj liter opisanych poniej w
opcji -p.
Jeeli adna z powyszych metod nie dostarczy adnych informacji o
filtrowaniu, to bdzie uyty zbior domylny.
Z filtrow i podstawowego programu formatujcego (nroff lub [tg]roff z
-t)tworzony jest potok formatujcy, ktory nastpnie jest wykonywany.
Alternatywnie, jeeli w korzeniu drzewa hierarchii man znajduje si
program wykonywalny mandb_nfmt (lub mandb_tfmt, gdy -t), to jest on
wykonywany zamiast potoku. Dostaje on na wejcie rodlo strony
podrcznika, lacuch znakow preprocesora i opcjonalnie nazw urzdzenia
podan w argumentach opcji -T lub -E.
OPCJE
Opcje, ktore nie wymagaj argumentu, a s zduplikowane albo w linii
polece, albo w $MANOPT, albo w obu, nie czyni adnej szkody. W przypadku
opcji, ktore wymagaj argumentu, kade powtorne ich uycie nadpisze
poprzedni warto tego argumentu.
Opcje og'olne
-C plik, --config-file=plik
Uywa podanego pliku konfiguracyjnego uytkownika zamiast
domylnego ~/.manpath.
-d, --debug
Wywietla informacj diagnostyczn (debug).
-D, --default
Ta opcja powinna by zazwyczaj podana jako pierwsza, gdy
przywraca domylne zachowanie programu man. Jej zastosowaniem
jest wylczenie tych opcji ustawionych w $MANOPT. Wszystkie opcje
nastpujce po -D bd mialy swoje normalne znaczenie.
--warnings[=ostrzeenia]
Wlcza ostrzeenia programu groff. Mona uy tej opcji, aby sprawdzi
poprawno tekstu rodlowego stron podrcznika ekranowego.
ostrzeenia to rozdzielona przecinkami lista nazw ostrzee; jeli
nie jest podana, to przyjmowana jest warto domylna - "mac". List
dostpnych ostrzee mona znale w info groff, sekcja "Ostrzeenia".
G/l'owne tryby dzia/lania
-f, --whatis
Odpowiednik whatis. Wywietla krotki opis strony podrcznika, jeli
jest dostpna. Szczegoly mona znale w whatis(1).
-k, --apropos
Odpowiednik apropos. Wyszukuje krotki opis stron podrcznika
pasujcych dla zadanych slow kluczowych i wywietla wszystkie
dopasowania. Szczegoly mona znale w apropos(1).
-K, --global-apropos
Szuka tekstu we wszystkich stronach podrcznika ekranowego. Jest
to przeszukiwanie silowe (brute-force), wic czasochlonne. Jeli
jest to moliwe, prosimy o podanie numeru sekcji, aby zmniejszy
liczb przeszukiwanych stron podrcznika. Klucze wyszukiwania mog
by zwyklymi lacuchami znakow (domylnie) lub wyraeniami
regularnymi (jeli podano opcj --regex).
-l, --local-file
Aktywuje tryb stron "lokalnych". Zamiast wyszukiwa strony w
hierarchii systemowej, formatuje i wywietla lokalne pliki
podrcznika. Kady argument bdzie interpretowany jako poprawny
plik rodlowy nroff. Nie bdzie generowany preformatowany plik
"cat". Podanie "-" jako jednego z argumentow spowoduje, e bdzie
przetwarzane standardowe wejcie (stdin). Jeli nie podano tej
opcji, a man nie znajdzie danej strony, to przed wywietleniem
komunikatu o bldzie zachowa si tak, jakby ta opcja byla podana i
uyje podanego argumentu jako nazwy pliku do wywietlenia.
-w, --where, --location
Zamiast wywietla strony podrcznika ekranowego, wypisuje
lokalizacje rodlowych plikow nroff, ktore zostalyby
sformatowane.
-W, --where-cat, --location-cat
Zamiast wywietla strony podrcznika ekranowego, wypisuje
lokalizacje plikow cat, ktore zostalyby wywietlone. Jeli podano
jednoczenie -w i -W, wywietla obie wartoci rozdzielone spacj.
-c, --catman
Ta opcja nie jest przeznaczona dla ogolu i powinna by uywana
tylko przez program catman.
-R kodowanie_znak'ow, --recode=kodowanie_znak'ow
Zamiast w normalny sposob wywietli stron podrcznika, wypisze
rodlo strony przeksztalcone na podane kodowanie_znak'ow. Jeli
znane jest kodowanie znakow pliku rodlowego, to mona uy
bezporednio polecenia manconv(1). Jednake, opcja ta pozwala
przeksztalci kilka stron podrcznika do jednego kodowania, bez
dokladnego podawania kodowania rodel kadej z nich, pod warunkiem
e strony te s umieszczone w strukturze katalogow podobnej do
hierarchii stron podrcznika.
Wyszukiwanie stron podrcznika ekranowego
-L ustawienia_jzykowe, --locale=ustawienia_jzykowe
man zazwyczaj okrela biece ustawienia jzykowa przez wywolanie
systemowej funkcji C setlocale(3), ktora okrela je na podstawie
ronych zmiennych rodowiska, takich jak $LC_MESSAGES i $LANG. Aby
tymczasowo nadpisa wartoci ustalone przez t funkcj, mona uy tej
opcji do bezporedniego przekazania ustawie_jzykowych do programu
man. Uwaga: bdzie to mialo wplyw tylko na wyszukiwanie stron
podrcznika, komunikaty takie jak informacje o pomocy, zawsze bd
wywietlane w jzyku okrelonym na pocztku dzialania.
-m system[,...], --systems=system[,...]
Jeli ten system ma dostp do hierarchii stron man innego systemu
operacyjnego, to za pomoc tej opcji mona uzyska do nich dostp.
Aby wyszuka stron podrcznika z systemu NewOS, naley poda -m
NewOS.
Podany system moe by kombinacj oddzielonych przecinkami nazw
systemow operacyjnych. Aby wlczy hierarchi stron podrcznika
macierzystego systemu operacyjnego, trzeba uy man jako nazwy
systemu w lacuchu argumentow. Niniejsza opcja nadpisuje
ewentualne uycie zmiennej rodowiska $SYSTEM.
-M cieka, --manpath=cieka
Podaje alternatywn ciek manpath. Domylnie w celu znalezienia
cieki przeszukiwa man uywa kodu programu manpath. Opcja ta
nadpisuje warto zmiennej rodowiskowej $MANPATH i powoduje, e
opcja -m jest ignorowana.
cieka podana jako cieka manpath musi by korzeniem hierarchii
stron podrcznika, ktorej struktura odpowiada strukturze sekcji
opisanej w podrczniku man-db (w dokumencie "System stron
podrcznika ekranowego", ang. "The manual page system"). Aby
zobaczy strony podrcznika poza t hierarchi, patrz opcja -l.
-S lista, -s lista, --sections=lista
Rozdzielona dwukropkami lub przecinkami lista okrela kolejno
przeszukiwania sekcji stron podrcznika. Opcja ta nadpisuje
zmienn systemow $MANSECT. (Alternatywna pisownia w postaci -s
jest dostarczona w celu zachowania kompatybilnoci z Systemem V).
-e pod-rozszerzenie, --extension=pod-rozszerzenie
Niektore systemu zawieraj w glownej sekcji hierarchii stron due
pakiety stron podrcznika, takich jak te, ktore towarzysz
pakietowi Tcl. Aby rozwiza problem istnienia dwoch stron
podrcznika o tej samej nazwie, takiej jak exit(3), strony Tcl
mialy tradycyjnie przypisan sekcj l. Jako e nie jest to zbyt
szczliwe rozwizanie, jest obecnie moliwe umieszczenie takich
stron w poprawnej sekcji i przypisanie im okrelonego
"rozszerzenia", w naszym przykladzie byloby to exit(3tcl).
Podczas normalnego dzialania man wywietli exit(3) przed
exit(3tcl). Aby to zmieni i unikn koniecznoci podawania
dokladnej sekcji, w ktorej dana strona jest umieszczona, moliwe
jest podanie programowi man pod-rozszerzenia, bdcego lacuchem
znakow okrelajcym, do ktorego pakietu ma nalee strona
podrcznika. Uywajc powyszego przykladu, przekazanie programowi
man opcji -e tcl zawzi wyszukiwanie do stron majcych
rozszerzenie *tcl.
-i, --ignore-case
Ignoruje wielko liter podczas wyszukiwania stron podrcznika.
Jest to zachowanie domylne.
-I, --match-case
Wyszukuje strony podrcznika zwracajc uwag na wielko liter.
--regex
Wywietla wszystkie strony, ktorych jakakolwiek cz nazwy lub
opisu pasuje - jako wyraenie regularne - do kadego podanego
argumentu strona, tak jak to robi apropos(1). Poniewa podczas
wyszukiwania za pomoc wyrae regularnych zazwyczaj nie ma
rozsdnego sposobu wydobycia"najlepszej" strony, opcja ta wlcza
-a.
--wildcard
Wywietla wszystkie strony, ktorych jakakolwiek cz nazwy lub
opisu pasuje - jako wyraenie zawierajce znaki dopasowania w
stylu powloki - do kadego podanego argumentu strona, tak jak to
robi apropos(1) --wildcard. Argument strona musi pasowa albo do
calej nazwy lub calego opisu, albo do poszczegolnych slow opisu.
Poniewa podczas wyszukiwania zazwyczaj nie ma rozsdnego sposobu
wydobycia"najlepszej" strony, opcja ta wlcza -a.
--names-only
Jeeli uyto opcji --regex lub --wildcard, dopasowywane bd tylko
nazwy stron, bez opisow stron, tak jak to robi whatis(1). W
przeciwnym razie opcja ta nic nie robi.
-a, --all
Domylnie man zakoczy dzialanie po wywietleniu najbardziej
odpowiedniej strony podrcznika, jak znajdzie. Uycie tej opcji
spowoduje, e man pokae wszystkie dostpne strony podrcznika,
ktorych nazwy odpowiadaj kryteriom wyszukiwania.
-u, --update
Ta opcja powoduje, e man przeprowadzi sprawdzenie spojnoci
swoich baz danych na poziomie i-wzlow, tak aby mie pewno, e
dokladnie odzwierciedlaj system plikow. Opcja ta ma efekt tylko
wtedy, gdy man jest zainstalowany z ustawionym bitem
set-user-id.
--no-subpages
Domylnie, man probuje interpretowa pary nazw stron podrcznika
podane w linii polece jako odpowiedniki nazw pojedynczych stron
podrcznika zawierajcych znaki mylnika lub podkrelenia. Wspiera
to zwyczajowy wzorzec programow implementujcych podprogramy,
pozwalajc im na dostarczanie stron podrcznika dla kadego
podprogramu przy uyciu skladni podobnej do tej, ktora by byla
uyta do uruchomienia tego podprogramu. Przyklad:
$ man -aw git diff
/usr/share/man/man1/git-diff.1.gz
Aby wylczy to zachowanie, prosz uy opcji --no-subpages.
$ man -aw --no-subpages git diff
/usr/share/man/man1/git.1.gz
/usr/share/man/man3/Git.3pm.gz
/usr/share/man/man1/diff.1.gz
Kontrolowanie sformatowanego wyjcia
-P pager, --pager=pager
Okrela, ktorego uy programu do przegldania tekstu (ang. pager).
Domylnie man uywa programu pager -s. Ta opcja nadpisuje zmienn
rodowiska MANPAGER, ktora z kolei nadpisuje zmienn rodowiska
$PAGER. Nie jest uywana w polczeniu z -f lub -k.
Wartoci moe by nazwa zwyklego polecenia lub polecenie z
argumentami. W wartoci mona uywa znakow cytowania powloki
(odwrotne ukoniki, pojedyncze lub podwojne cudzyslowy), jednake
nie mona lczy wielu polece w potoki; jeli jest to potrzebne
naley uy skryptu otaczajcego potok. Skrypt ten powinien moc
przyjmowa plik do wywietlenia albo jako argument linii polece,
albo odczyta go ze standardowego wejcia.
-r linia_zachty, --prompt=linia_zachty
Jeeli jako przegldarka tekstu jest uywana w miar nowa wersja
programu less, to man sprobuje ustawi jej lacuch zachty oraz par
sensownych opcji. Domylny lacuch zachty wyglda tak
Strona podrcznika nazwa(sek) linia x
gdzie nazwa oznacza nazw strony podrcznika, sek oznacza sekcj, w
ktorej znaleziono t stron, a x jest numerem biecego wiersza.
Osiga si to przez uycie zmiennej rodowiska $LESS.
Podanie -r z lacuchem znakow nadpisze t warto domyln. Lacuch
znakow moe zawiera tekst $MAN_PN, ktory zostanie zamieniony
przez nazw biecej strony podrcznika oraz jej sekcj otoczon
nawiasami "(" i ")". Lacuch znakow rownowany wartoci domylnej
to:
\ Strona\ podrcznika\ \$MAN_PN\ ?ltlinia\ %lt?L/%L.:
bajt\ %bB?s/%s..?\ (KONIEC):?pB\ %pB\\%..
(nacinij h, aby otrzyma pomoc, lub q, aby zakoczy)
Podzial na trzy linie zastosowano tylko dla zwikszenia
czytelnoci. Znaczenie mona znale w podrczniku less(1). Linia
zachty jest najpierw rozwijana przez powlok. Wszystkie podwojne
cudzyslowy, odwrotne apostrofy i odwrotne ukoniki w linii zachty
musz by poprzedzone znakiem odwrotnego ukonika. Linia zachty moe
koczy si poprzedzonym przez odwrotny ukonik znakiem $, po ktorym
mog nastpowa kolejne opcje przekazywane do programu less.
Domylnie man ustawia opcje -ix8.
Aby calkowicie nadpisa lacuch zachty mana, naley uy zmiennej
rodowiskowej $MANLESS, jak to opisano poniej.
-7, --ascii
Podczas przegldanie strony podrcznika zawierajcej tylko czyste
znaki ascii(7) w 7-bitowym terminalu lub emulatorze terminala,
niektore znaki mog nie by wywietlone poprawnie, jeeli z
programem uywane jest urzdzenie latin1(7) programu GNU nroff. Ta
opcja pozwala, aby strony zawierajce tylko znaki ascii byly
wywietlane w trybie ascii z urzdzeniem latin1. Opcja ta nie
zmieni kodowania adnego tekstu latin1. Ponisza tabela pokazuje
przeprowadzane zmiany kodowa: niektore z nich mog by wywietlone
poprawnie, tylko gdy uywa si urzdzenia latin1(7) GNU nroffa.
Opis Osemkowy latin1 ascii
---------------------------------------------
lcznik 255 - -
kula (kropka w 267 o o
rodku)
akcent ostry 264 ' '
znak dzielenia 327 x x
Jeeli kolumna latin1 wywietla si poprawnie, Twoj terminal moe by
ju ustawiony na znaki latin1, wic podanie tej opcji nie jest
potrzebne. Jeli kolumny latin1 i ascii s identyczne, to czytasz
t stron uywajc omawianej opcji lub man nie sformatowal tej
strony za pomoc urzdzenia latin1. Jeli brakuje kolumny latin1
lub jest ona uszkodzona, to najprawdopodobniej trzeba uywa
omawianej opcji podczas przegldania stron podrcznika ekranowego.
Ta opcja jest ignorowana, jeeli podano rownie -t, -H, -T albo -Z
i moe by calkowicie nieprzydatna podczas uywania wersji nroffa
innej ni GNU.
-E kodowanie_znak'ow, --encoding=kodowanie_znak'ow
Generuje wyjcie w innym ni domylne kodowaniu znakow. W celu
zachowania wstecznej kompatybilnoci kodowanie_znak'ow moe by
urzdzeniem nroff, takim jak ascii, latin1 lub utf8 jak rownie
prawdziwym kodowaniem znakow, takim jak UTF-8.
--no-hyphenation, --nh
Zazwyczaj nroff automatycznie dzieli wyrazy przy przenoszeniu,
jeli jest to konieczne, aby wyrowna lini, tak eby nie zawierala
za duo spacji, i robi to nawet wtedy, gdy wyrazy te nie zawieraj
znakow lcznika. Ta opcja wylcza automatyczne dzielenie wyrazow,
tak e slowa bd dzielone tylko, gdy zawieraj lczniki.
Jeli piszesz stron podrcznika ekranowego, to aby powstrzyma
nroff przed przenoszeniem wyrazow do nowej linii w
nieodpowiednim miejscu, naley zapozna si z dokumentacj programu
nroff, zamiast uywa tej opcji; na przyklad mona w slowie umieci
sekwencj "\%" wskazujc miejsce, w ktorym slowo moe by podzielone
przy przenoszeniu, albo umieci "\%" na pocztku slowa, co zabroni
jego dzielenia.
--no-justification, --nj
Zazwyczaj nroff automatycznie wyrowna tekst w linii do obu
marginesow. Opcja ta wylcza takie wyrownywanie, zostawiajc
wyrownywanie tylko do lewego marginesu, co powoduje, e tekst z
prawej strony jest "postrzpiony".
Podczas pisania strony podrcznika ekranowego, nie naley uywa tej
opcji do powstrzymywania nroffa od wyrownywania linii w akapicie
do obu marginesow. Zamiast tego prosz zapozna si z dokumentacj
programu nroff. Na przyklad mona uy da ".na", ".nf", ".fi", and
".ad", aby tymczasowo wylczy wyrownywanie linii i wypelnianie
spacjami.
-p /lacuch_znak'ow, --preprocessor=/lacuch_znak'ow
Okrela sekwencj preprocesorow do uruchomienia przez
uruchomieniem programu nroff lub troff/groff. Nie w kadym
systemie bdzie zainstalowany pelen zbior preprocesorow. Niektore
preprocesory i litery je oznaczajce to: eqn (e), grap (g), pic
(p), tbl (t), vgrind (v), refer (r). Ta opcja nadpisuje zmienn
rodowiska $MANROFFSEQ. zsoelim jest zawsze uruchamiany jako
pierwszy preprocesor.
-t, --troff
Uywa programu groff -mandoc, aby sformatowa stron podrcznika na
standardowe wyjcie. Opcja nie jest wymagana w polczeniu z -H,
-T lub -Z.
-T[urzdzenie], --troff-device[=urzdzenie]
Za pomoc tej opcji mona zmieni wyjcie programu groff (lub by moe
troff), tak aby bylo odpowiednie dla innego urzdzenia ni
domylne. Wlcza opcj -t. Przyklady (dostarczane przez groff-1.17)
zawieraj dvi, latin1, ps, utf8, X75 oraz X100.
-H[przegldarka], --html[=przegldarka]
Opcja ta spowoduje, e groff utworzy wyjcie w formacie HTML i je
wywietli w przegldarce stron www. Wybor przegldarki dokonywany
jest przy pomocy opcjonalnego argumentu przegldarka. Jeli go nie
podano, to brana jest pod uwag warto zmiennej rodowiska
$BROWSER, a nastpnie domylna przegldarka ustawiona podczas
kompilowania pakietu (zazwyczaj lynx). Opcja ta wlcza rownie -t
i bdzie dziala tylko z wersj GNU troffa.
-X[dpi], --gxditview[=dpi]
Opcja ta wywietla wyjcie groffa w okienku graficznym za pomoc
programu gxditview Argumentem dpi (dots per inch) moe by 75,
75-12, 100 lub 100-12, domylnie jest 75; warianty -12 uywaj
12-punktowej czcionki jako bazowej. Opcja wlcza -T z urzdzeniem
X75, X75-12, X100 lub X100-12.
-Z, --ditroff
groff uruchomi program troff i uyje odpowiedniego postprocesora
do utworzenia wyjcia odpowiedniego dla wybranego urzdzenia. Gdy
groff -mandoc jest groffem, to ta opcja jest przekazywana do
groffa i wstrzyma uycie postprocesora. Automatycznie wlcza opcj
-t.
Otrzymywanie pomocy
-h, --help
Wywietla komunikat pomocy i koczy prac.
-V, --version
Wywietla informacj o wersji.
KOD ZAKOCZENIA
0 Program zakoczony bez adnych bldow.
1 Bld uycia, skladni lub pliku konfiguracyjnego.
2 Bld dzialania.
3 Proces potomny zwrocil niezerowy kod zakoczenia.
16 Co najmniej jedna z stron/plikow/slow kluczowych nie istnieje
lub nie zostalo dopasowane.
RODOWISKO
MANPATH
Jeeli ustawiona jest $MANPATH, to jej warto jest uywana jako
cieka przeszukiwa hierarchii stron man.
MANROFFOPT
Zawarto zmiennej $MANROFFOPT jest dodawana do linii polece za
kadym razem, gdy man uruchamia program formatujcy (nroff, troff
lub groff).
MANROFFSEQ
Jeeli ustawiono $MANROFFSEQ, to jej warto jest uywana do
okrelenia zbioru preprocesorow przez ktore jest przepuszczana
strona podrcznika. Domylna lista preprocesorow zaley od systemu.
MANSECT
Jeeli ustawiona jest $MANSECT, to jej warto jest list
oddzielonych dwukropkami sekcji i sluy do okrelania, ktore
sekcje podrcznika man i w jakiej kolejnoci bd przeszukiwane.
MANPAGER, PAGER
Jeli ustawiono zmienn $MANPAGER lub $PAGER ($MANPAGER ma wyszy
priorytet), to jej warto jest uywana jako nazwa programu, w
ktorym bdzie wywietlona strona podrcznika ekranowego. Domylnie
uywany jest program pager -s.
Wartoci moe by nazwa zwyklego polecenia lub polecenie z
argumentami. W wartoci mona uywa znakow cytowania powloki
(odwrotne ukoniki, pojedyncze lub podwojne cudzyslowy), jednake
nie mona lczy wielu polece w potoki; jeli jest to potrzebne
naley uy skryptu otaczajcego potok. Skrypt ten powinien moc
przyjmowa plik do wywietlenia albo jako argument linii polece,
albo odczyta go ze standardowego wejcia.
MANLESS
Jeli $MANLESS jest ustawiona, to man nie podejmie adnych swoich
zwyczajowych dziala ustawiajcych lini zachty programu less.
Zamiast tego warto $MANLESS bdzie skopiowana bez zmian do
zmiennej $LESS. Na przyklad aby bezwarunkowo ustawi lini zachty
na "moja linia zachty", naley ustawi $MANLESS na
'-Psmoja linia zachty'.
BROWSER
Jeeli jest ustawiona zmienna $BROWSER, to jej wartoci jest
rozdzielona dwukropkami lista polece, ktore man bdzie - w
kolejnoci - probowal uruchomi, aby wywietli wyjcie man --html w
przegldarce www. W kadym poleceniu %s jest zastpowane nazw pliku
zawierajcego wyjcie HTML programu groff, %% jest zastpowane
znakiem procentu (%), a %c - dwukropkiem (:).
SYSTEM Jeeli ustawiona jest zmienna $SYSTEM, to ma to taki sam skutek,
jak przekazanie jej wartoci jako argumentu opcji -m.
MANOPT Jeeli ustawiono $MANOPT, to warto tej zmiennej, ktora powinna by
w formacie podobnym do formatu linii opcji polece programu man,
bdzie przetwarzana przed opcjami linii polece. Poniewa wszystkie
pozostale zmienne rodowiska specyficzne dla programu man mog by
wyraone jako opcje linii polece i jako takie mog by podane w
zmiennej $MANOPT, naley oczekiwa, e zostan one uznane za
przestarzale. Uwaga: wszystkie spacje, ktore maj by
zinterpretowane jako cz argumentu opcji, musz zosta poprzedzone
znakiem odwrotnego ukonika.
MANWIDTH
Jeeli ustawiono zmienn $MANWIDTH, to jej warto jest uywana do
okrelenia dlugoci wiersza, dla ktorej bd formatowane strony
podrcznika. Jeeli nie jest ustawiona, to strony podrcznika bd
formatowane dla dlugoci wiersza odpowiedniej dla biecego
terminalu (uywajc ioctl(2), jeli jest dostpne, lub wartoci
zmiennej $COLUMNS, lub jeli adne z nich nie jest dostpne,
ustawiajc domyln warto 80 znakow). Preformatowane strony "cat"
bd zachowywane tylko wtedy, gdy jest uywane domylne
formatowanie, to jest gdy dlugo wiersza terminala zawiera si
midzy 66 a 80 znakami.
MAN_KEEP_FORMATTING
Zazwyczaj, jeeli wyjcie nie jest przekazywane do terminala
(tylko np. do pliku lub potoku), to kontrolne znaki formatujce s
usuwane, aby ulatwi czytanie pliku wynikowego bez uycia adnych
dodatkowych narzdzi. Jednake jeeli MAN_KEEP_FORMATTING ma
niepust warto, znaki te s zachowywane. Moe by to uyteczne dla
programow, ktore wewntrznie wywoluj man i potrafi zinterpretowa
znaki kontrolne.
MAN_KEEP_STDERR
Zazwyczaj, jeli wyjcie jest skierowane na terminal (zazwyczaj do
programu do stronicowania), to ignorowane s wszystkie komunikaty
bldow generowane przez programy uywane to sformatowania strony
podrcznika, tak aby nie zakloci wyjcia programu do
stronicowania. Programy, takie jak groff czsto tworz komunikaty
o relatywnie malo istotnych bldach typograficznych (dotyczcych
na przyklad zlego wyrownania) - wywietlanie ich razem ze stron
podrcznika byloby szpecce i mylce. Jednak niektorzy uytkownicy
chcieliby zobaczy te bldy, wic jeeli ustawi si zmienn
$MAN_KEEP_STDERR na dowoln niepust warto, to wyjcie bldow bdzie
normalnie wywietlane.
LANG, LC_MESSAGES
W zalenoci od systemu i implementacji biece ustawienia jzykowe
bd pobierane z jednej lub obu sporod zmiennych $LANG i
$LC_MESSAGES. man wywietli swoje komunikaty w tym jzyku (jeli s
dostpne). Szczegoly mona znale w setlocale(3).
PLIKI
/etc/manpath.config
Plik konfiguracyjny man-db.
/usr/share/man
Globalna hierarchia stron podrcznika ekranowego.
/usr/share/man/index.(bt|db|dir|pag)
Tradycyjny globalny indeks bazy danych.
/var/cache/man/index.(bt|db|dir|pag)
Zgodny z FHS globalny indeks bazy danych.
ZOBACZ TAKE
mandb(8), manpath(1), manpath(5), apropos(1), whatis(1), catman(8),
less(1), nroff(1), troff(1), groff(1), zsoelim(1), setlocale(3),
man(7), ascii(7), latin1(7), podrcznik pakietu man-db, FSSTND.
HISTORIA
1990, 1991 - Program napisany przez Johna W. Eatona
(jwe@che.utexas.edu).
23 grudnia 1992: Rik Faith (faith@cs.unc.edu) zaaplikowal poprawki
bldow nadeslane przez Willema Kasdorpa (wkasdo@nikhefk.nikef.nl).
30 kwietnia 1994 - 23 lutego 2000: Wilf. (G.Wilford@ee.surrey.ac.uk) z
pomoc paru osob rozwijal ten pakiet i nim zarzdzal.
30 padziernika 1996 - 30 marca 2001: Fabrizio Polacco
<fpolacco@debian.org>rozwijal i udoskonalal ten pakiet dla projektu
Debiana z pomoc calej spolecznoci.
31 marca 2001 - obecnie: Colin Watson <cjwatson@debian.org> rozwija
man-db i nim zarzdza.
T/LUMACZENIE
Wojciech Kotwica w 1999 roku przetlumaczyl cz stron podrcznika pakietu
man-db i udostpnil je w ramach Projektu Tlumaczenia Manuali.
Robert Luberda tlumaczenie zaktualizowal i uzupelnil w roku 2008.