Linux Certif

Toute la documentation sur la certification Linux LPI

man

NAZWA

man - formatowanie i wy¶wietlanie dostêpnych stron podrêcznika man
manpath - wyznaczanie ¶cie¿ki poszukiwania stron podrêcznika odpowiedniej dla danego u¿ytkownika

SK£ADNIA

man

[-adfhkKtwW] [-m system] [-p ³añcuch_znaków] [-C plik_konfiguracyjny] [-M ¶cie¿ka] [-P pager] [-S lista_rozdzia³ów] [rozdzia³] nazwa...

OPIS

man formatuje i wy¶wietla dostêpne w systemie strony podrêcznika man. Je¿eli zostanie podany rozdzia³, man sprawdza tylko ten rozdzia³ podrêcznika. Je¿eli nazwa zawiera znak /, to man próbuje najpierw znale¼æ podany plik, wiêc mo¿na np. wydaæ polecenie man ./foo.5 a nawet man /cd/foo/bar.1.gz.

Ni¿ej znajdziesz informacje, gdzie man szuka plików stron podrêcznika.

OPCJE

-C plik_konfiguracyjny

Okre¶la plik konfiguracyjny, którego nale¿y u¿yæ. Domy¶lnym jest /etc/man.config. (Zobacz man.conf(5).)

-M ¶cie¿ka

Okre¶la listê katalogów, w których bêd± szukane strony podrêcznika man. Katalogi nale¿y rozdzielaæ dwukropkami. Pusta lista jest równoznaczna z nie podaniem tej opcji. Zobacz ¦CIE¯KA PRZESZUKIWANIA DLA STRON PODRÊCZNIKA.

-P pager

Okre¶la, który pager ma zostaæ u¿yty. Je¿eli podana jest ta opcja, ignorowana jest zmienna ¶rodowiskowa MANPAGER, której u¿ycie z kolei powoduje zignorowanie zmiennej ¶rodowiskowej PAGER. Domy¶lnie man u¿ywa /usr/bin/less.

-S lista_rozdzia³ów

Rozdzielona dwukropkami lista rozdzia³ów podrêcznika, które maj± byæ przeszukane. Je¿eli podana jest ta opcja, zmienna ¶rodowiskowa MANSECT jest ignorowana.

-a

Domy¶lnie man koñczy dzia³anie po wy¶wietleniu pierwszej znalezionej strony. Podanie tej opcji powoduje wy¶wietlenie wszystkich stron podrêcznika, które pasuj± do nazwa, a nie tylko pierwszej.

-c

Przeformatowuje ¼ród³ow± stronê podrêcznika, nawet je¿eli istnieje aktualna strona cat. Mo¿e to byæ istotne, je¿eli strona cat jest sformatowana dla ekranu z inn± liczb± kolumn.

-d

Zamiast stron podrêcznika wy¶wietla mnóstwo informacji diagnostycznych.

-D

Wy¶wietla zarówno stronê podrêcznika jak i informacje diagnostyczne.

-f

Równowa¿ne whatis.

-h

Wy¶wietla krótk± informacjê pomocy i koñczy pracê.

-k

Równowa¿ne apropos.

-K

Szuka podanego ³añcucha znaków we *wszystkich* stronach podrêcznika. Uwaga: bêdzie to prawdopodobnie bardzo powolne! Podanie rozdzia³ów pomaga przyspieszyæ szukanie. (Dla ogólnej orientacji: na mojej maszynie zajmuje to ok. minuty na ka¿de 500 stron podrêcznika.)

-m system

Podanie alternatywnego zestawu stron podrêcznika, odpowiedniego dla systemu o podanej nazwie.

-p ³añcuch_znaków

Podanie listy nazw preprocesorów, ktore zostan± uruchomione przed nroff i troff. Nie wszystkie intalacje maj± pe³ny zestaw preprocesorów. Niektóre z nich oraz oznaczaj±ce je litery to: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Podanie tej opcji powoduje zignorowanie zmiennej ¶rodowiskowej MANROFFSEQ.

-t

Sformatuj stronê podrêcznika za pomoc± /usr/bin/groff -S -Tps -mandoc, a wynik wy¶lij na stdout (standardowe wyj¶cie). Mo¿e byæ konieczne przepuszczenie wyniku z /usr/bin/groff -S -Tps -mandoc przez jaki¶ filtr przed wydrukowaniem.

-w lub --path

Nie wy¶wietlaj stron podrêcznika, podaj tylko gdzie znajduj± siê pliki, które by³yby sformatowane i wy¶wietlone. Je¿eli nie podano ¿adnych argumentów: wy¶wietla (na stdout) listê katalogów, w których man poszukuje stron podrêcznika. Je¿eli manpath jest dowi±zaniem man to "manpath" jest równowa¿ne "man --path".

-W

Podobne do -w, lecz podaje nazwy plików, ka¿d± w osobnej linii, bez dodatkowych informacji. Przydaje siê w poleceniach pow³oki, np. man -aW man | xargs ls -l

STRONY CAT

Man bêdzie próbowa³ zachowaæ sformatowane strony podrêcznika aby skróciæ czas potrzebny na sformatowanie ich po raz kolejny, kiedy te strony bêd± znowu potrzebne. Tradycyjnie, sformatowane wersje stron podrêcznika z katalogu DIR/manX s± zachowywane w DIR/catX, ale mo¿na te¿ w pliku /etc/man.config okre¶liæ inne zasady. Strony cat nie s± tworzone, je¿eli wymagany katalog nie istnieje.

Mo¿liwe jest uczynienie programu man suidowym na u¿ytkownika man. Wtedy, je¶li katalogi cat maj± w³a¶ciciela man i prawa dostêpu 0755 (zapisywalne tylko przez u¿ytkownika man), a pliki cat maj± w³a¶ciciela man i prawa dostêpu 0644 lub 0444 (zapisywalne przez u¿ytkownika man lub przez nikogo), to ¿aden zwyk³y u¿ytkownik nie mo¿e zmieniaæ stron cat lub umieszczaæ w katalogach cat innych plików. Je¿eli man nie jest suidowy to katalog cat powinien mieæ prawa dostêpu 0777, o ile wszyscy u¿ytkownicy powinni mieæ mo¿liwo¶æ pozostawiania tam stron cat.

Opcja -c wymusza przeformatowanie strony nawet je¿eli istnieje ju¿ odpowiednia strona cat.

¦CIE¯KA PRZESZUKIWANIA DLA STRON PODRÊCZNIKA

man stosuje wymy¶ln± metodê poszukiwania plików stron podrêcznika, opart± na opcjach wywo³ania, zmiennych ¶rodowiskowych, pliku konfiguracyjnym /etc/man.config oraz na pewnych wbudowanych konwencjach i heurystyce.

Najpierw, gdy argument nazwa polecenia man zawiera uko¶nik (/), man zak³ada, ¿e jest on nazw± w³a¶ciwego pliku i nie prowadzi poszukiwania.

Ale zazwyczaj, gdy nazwa nie zawiera uko¶nika, man poszukuje pliku, który móg³by stanowiæ stronê podrêcznika o zadanym temacie, w ró¿nych katalogach.

Je¶li zostanie podana opcja -M ¶cie¿ka, to ¶cie¿ka jest rozdzielon± dwukropkami list± przeszukiwanych przez program man katalogów.

Gdy opcja -M nie zostanie podana, ale zostanie zdefiniowana zmienna ¶rodowiskowa MANPATH, warto¶æ tej zmiennej stanowi listê przeszukiwanych przez program man katalogów.

Je¶li ¶cie¿ka nie zostanie podana w sposób jawny ani za pomoc± -M ani poprzez MANPATH, man rozwija swoj± w³asn± ¶cie¿kê w oparciu o zawarto¶æ pliku konfiguracyjnego /etc/man.config. Instrukcje MANPATH w pliku konfiguracyjnym okre¶laj± poszczególne katalogi w³±czane do ¶cie¿ki przeszukiwania.

Ponadto, instrukcje MANPATH_MAP dodaj± do ¶cie¿ki przeszukiwania katalogi zale¿ne od ¶cie¿ki przeszukiwania dla poleceñ (tzn. zawartej w zmiennej ¶rodowiskowej PATH ). Instrukcja MANPATH_MAP dodaje do ¶cie¿ki przeszukiwania dla stron podrêcznika po jednym katalogu dla ka¿dego katalogu zawartego w ¶cie¿ce przeszukiwania dla poleceñ. man przegl±da zmienn± PATH i dodaje odpowiednie katalogi do ¶cie¿ki przeszukiwania dla stron podrêcznika. Zatem przy w³a¶ciwym u¿yciu MANPATH_MAP, po wydaniu polecenia man xyz, otrzyma siê stronê podrêcznika dla programu, który zosta³by uruchomiony poprzez wydanie polecenia xyz.

Dodatkowo, dla ka¿dego katalogu w ¶cie¿ce przeszukiwania dla poleceñ (bêdziemy go nazywaæ "katalogiem poleceñ"), dla którego nie ma instrukcji MANPATH_MAP, man automatycznie poszukuje "bliskiego" katalogu stron podrêcznika jako podkatalogu w³a¶ciwego katalogu poleceñ lub w katalogu nadrzêdnym dla katalogu poleceñ.

Mo¿na wy³±czyæ automatyczne "bliskie" przeszukiwania do³±czaj±c instrukcjê NOAUTOPATH do /etc/man.config.

Jak opisano powy¿ej, w ka¿dym z katalogów ¶cie¿ki przeszukiwania man poszukuje pliku o nazwie tytu³.rozdzia³, z opcjonalnym przyrostkiem dla numeru rozdzia³u i mo¿liwym przyrostkiem kompresji. Je¶li nie znajdzie takiego pliku, bêdzie szuka³ w podkatalogach o nazwach manN i catN, gdzie N jest numerem rozdzia³u podrêcznika. Je¶li plik znajduje siê w podkatalogu catN, man zak³ada, ¿e jest to sformatowany plik strony podrêcznika (cat page). W przeciwnym przypadku, man zak³ada, ¿e jest ona niesformatowana. W obu przypadkach, je¶li nazwa pliku zawiera znany przyrostek kompresji (jak .gz), man zak³ada, ¿e jest ona spakowania gzipem.

Aby zobaczyæ, gdzie (lub czy) man znajdzie stronê podrêcznika o okre¶lonym tytule, nale¿y pos³u¿yc siê opcj± --path (-w).

¦RODOWISKO

MANPL

Je¶li zmienna MANPL jest zdefinowana, to jej warto¶æ jest u¿ywana do okre¶lenia d³ugo¶ci strony. W przeciwnym przypadku, ca³a strona podrêcznika bêdzie stanowiæ jedn± (d³ug±) stronê.

MANROFFSEQ

Je¶li zmienna MANROFFSEQ jest zdefinowana, to jej warto¶æ jest u¿ywana do zdefinowania zestawu preprocesorów uruchamianych przed nroff i troff. Domy¶lnie strony s± przepuszczane przez preprocesor tbl przed u¿yciem nroff.

MANSECT

Je¶li zmienna MANSECT jest zdefiniowana, to jej warto¶æ jest u¿ywana do okre¶lenia jakie rozdzia³y podrêcznika powinny zostaæ przeszukane.

MANWIDTH

Je¶li zmienna MANWIDTH jest zdefiniowana, to jej warto¶æ jest u¿ywana jako szeroko¶æ wy¶wietlanych stron podrêcznika man. W przeciwnym wypadku, strony bêd± wy¶wietlane na ca³ej szeroko¶ci ekranu.

MANPAGER

Je¶li zmienna MANPAGER jest zdefiniowana, to jej warto¶æ jest u¿ywana jako nazwa programu do wy¶wietlania strony podrêcznika man. Je¶li nie jest zdefiniowana, to u¿ywana jest zmienna PAGER. Je¿eli ta równie¿ nie ma nadanej warto¶ci, to u¿ywany jest /usr/bin/less.

LANG

Je¶li zmienna LANG jest zdefiniowana, to jej warto¶æ okre¶la nazwê podkatalogu, w którym man najpierw bêdzie szukaæ stron podrêcznika. Zatem polecenie `LANG=pl man 1 co¶' (w sh lub bash) spowoduje, ¿e man bêdzie szukaæ strony "co¶" w .../pl/man1/co¶.1, a nastêpnie, je¿eli takiego pliku nie znajdzie, w .../man1/co¶.1, gdzie ... jest katalogiem ze ¶cie¿ki przeszukiwania.

NLSPATH, LC_MESSAGES, LANG

Zmienne ¶rodowiskowe NLSPATH i LC_MESSAGES (lub LANG, je¿eli ta druga nie istnieje) steruj± przeszukiwaniem katalogów z komunikatami. (Komunikaty angielskie s± wkompilowane, wiêc dla angielskiego taki katalog nie jest potrzebny.) Zauwa¿, ¿e programy takie jak col(1), wo³ane przez man, równie¿ u¿ywaj± np. LC_TYPE.

PATH

PATH pomaga okre¶liæ ¶cie¿kê przeszukiwania dla plików stron podrêcznika. Zobacz ¦CIE¯KA PRZESZUKIWANIA DLA STRON PODRÊCZNIKA.

SYSTEM

SYSTEM jest u¿ywana do pobierania domy¶lnej alternatywnej nazwy systemu (do u¿ywania razem z opcj± -m).

ZOBACZ TAK¯E

apropos(1), whatis(1), less(1), groff(1), man.conf(5).

B£ÊDY

Opcja -t dzia³a tylko je¿eli jest zainstalowany jaki¶ program dzia³aj±cy jak troff.
Je¿eli zamiast my¶lników pojawi± siê migaj±ce \255 lub <AD>, to nale¿y ustawiæ w ¶rodowisku u¿ytkownika `LESSCHARSET=latin1'.

ZAKOÑCZENIE

Je¶li do pliku .emacs u¿ytkownika dodana zostanie linia

  (global-set-key [(f1)] (lambda () (interactive) (manual-entry (current-word))))

to naci¶niêcie F1 spowoduje wy¶wietlenie strony podrêcznika dla funkcji bibliotecznej, na której ustawiony jest kursor.

Aby uzyskaæ czysto tekstow± wersjê strony podrêcznika, bez cofniêæ i podkre¶leñ, nale¿y wydaæ polecenie

  # man co¶ | col -b > co¶.mantxt