MAN
NAZWA
SKÅADNIA
OPIS
PRZYKÅADY
WPROWADZENIE
ZACHOWANIA DOMYÅLNE
OPCJE
KOD ZAKOÅCZENIA
ÅRODOWISKO
PLIKI
ZOBACZ TAKŻE
HISTORIA
BÅÄDY
TÅUMACZENIE
NAZWA
man − an interface to the system reference manuals
SKÅADNIA
man [man options] [[section] page …] …
man −k [apropos options] regexp …
man −K [man options] [section] term …
man −f [opcje whatis] strona …
man −l [man options] file …
man −w|−W [man options] page …
OPIS
man is the system’s manual pager. Each page argument given to man is normally the name of a program, utility or function. The manual page associated with each of these arguments is then found and displayed. A section, if provided, will direct man to look only in that section of the manual. The default action is to search in all of the available sections following a pre−defined order (see DEFAULTS), and to show only the first page found, even if page exists in several sections.
Poniższa tabela pokazuje numery sekcji wraz z opisem odpowiadajÄcych im typów stron, które zawierajÄ.
Strona podrÄcznika skÅada siÄ z kilku sekcji.
Zgodnie z tradycjÄ nazwy sekcji zawierajÄ NAZWA (NAME), SKÅADNIA (SYNOPSIS), KONFIGURACJA (CONFIGURATION), OPIS (DESCRIPTION), OPCJE (OPTIONS), KOD ZAKOÅCZENIA (EXIT STATUS), WARTOÅÄ ZWRACANA (RETURN VALUE), BÅÄDY (ERRORS), ÅRODOWISKO (ENVIRONMENT), PLIKI (FILES), WERSJE (VERSIONS), ZGODNE Z (CONFORMING TO), UWAGI (NOTES), BÅÄDY (BUGS), PRZYKÅAD (EXAMPLE), AUTORZY (AUTHORS) oraz ZOBACZ TAKÅ»E (SEE ALSO).
Poniższe konwencje majÄ zastosowanie do sekcji SKÅADNIA, ale mogÄ byÄ traktowane jako przewodnik po innych sekcjach.
Sposób, w jaki bÄdzie wyÅwietlona strona podrÄcznika, zależy od urzÄdzenia wyjÅciowego. Na przykÅad man zazwyczaj nie bÄdzie mógÅ wyÅwietliÄ czcionki kursywej, jeÅli jest uruchomiony na terminalu, wiÄc zamiast niej użyje podkreÅleÅ lub zmieni kolor czcionki.
PrzykÅady użycia polecenia lub funkcji powinny zawieraÄ wszystkie możliwe wywoÅania. W pewnych przypadkach doradza siÄ obrazowaÄ wykluczajÄce siÄ wywoÅania w taki sposób, jak to zrobiono w sekcji SKÅADNIA tej strony podrÄcznika ekranowego.
PRZYKÅADY
man ls
WyÅwietla stronÄ podrÄcznika ekranowego dla danej pozycji (programu) ls.
man man.7
Display the manual page for macro package man from section 7. (This is an alternative spelling of “man 7 man“.)
man ’man(7)’
Display the manual page for macro package man from section 7. (This is another alternative spelling of “man 7 man“. It may be more convenient when copying and pasting cross−references to manual pages. Note that the parentheses must normally be quoted to protect them from the shell.)
man −a intro
WyÅwietla kolejno wszystkie dostÄpne strony podrÄcznika intro. Można przerwaÄ wyÅwietlanie pomiÄdzy kolejnymi stronami lub pominÄÄ którÄkolwiek z nich.
man −t bash | lpr −Pps
Format the manual page for bash into the default troff or groff format and pipe it to the printer named ps. The default output for groff is usually PostScript. man −−help should advise as to which processor is bound to the −t option.
man −l −Tdvi ./foo.1x.gz > ./foo.1x.dvi
This command will decompress and format the nroff source manual page ./foo.1x.gz into a device independent (dvi) file. The redirection is necessary as the −T flag causes output to be directed to stdout with no pager. The output could be viewed with a program such as xdvi or further processed into PostScript using a program such as dvips.
man −k printf
Szuka sÅowa kluczowego printf jako wyrażenia regularnego w krótkich opisach i nazwach stron podrÄcznika. WyÅwietla wszystkie dopasowania. Odpowiednik apropos printf.
man −f smail
Wyszukuje strony podrÄcznika opisane przez smail i wyÅwietla krótki opis każdej ze znalezionych stron. Odpowiednik whatis smail.
WPROWADZENIE
man udostÄpnia wiele opcji, aby dostosowaÄ siÄ do wymagaÅ użytkownika najlepiej, jak to jest tylko możliwe. Pozwala zmieniÄ ÅcieżkÄ wyszukiwania, kolejnoÅÄ sekcji, program do przetwarzania stron i inne zachowania oraz operacje, jak to opisano poniżej
If set, various environment variables are interrogated to determine the operation of man. It is possible to set the “catch−all” variable $MANOPT to any string in command line format, with the exception that any spaces used as part of an option’s argument must be escaped (preceded by a backslash). man will parse $MANOPT prior to parsing its own command line. Those options requiring an argument will be overridden by the same options found on the command line. To reset all of the options set in $MANOPT, −D can be specified as the initial command line option. This will allow man to “forget” about the options specified in $MANOPT, although they must still have been valid.
Manual pages are normally stored in nroff(1) format under a directory such as /usr/share/man. In some installations, there may also be preformatted cat pages to improve performance. See manpath(5) for details of where these files are stored.
This package supports manual pages in multiple languages, controlled by your locale. If your system did not set this up for you automatically, then you may need to set $LC_MESSAGES, $LANG, or another system−dependent environment variable to indicate your preferred locale, usually specified in the POSIX format:
<jÄzyk>[_<terytorium>[.<zestaw_znaków>[,<wersja>]]]
Jeżeli odpowiednia strona jest dostÄpna w Twoich ustawieniach_jÄzykowych, to bÄdzie wyÅwietlona zamiast wersji standardowej (czyli zazwyczaj amerykaÅskiej).
If you find that the translations supplied with this package are not available in your native language and you would like to supply them, please contact the maintainer who will be coordinating such activity.
Individual manual pages are normally written and maintained by the maintainers of the program, function, or other topic that they document, and are not included with this package. If you find that a manual page is missing or inadequate, please report that to the maintainers of the package in question.
Informacje o innych zaletach pakietu i rozszerzeniach w nim dostÄpnych znajdujÄ siÄ w dokumentacji do niego doÅÄczanej.
ZACHOWANIA DOMYÅLNE
The order of sections to search may be overridden by the environment variable $MANSECT or by the SECTION directive in /etc/man_db.conf. By default it is as follows:
1 1p 8 2 3 3p 3pm 4 5 6 7 9 0p n l p o 1x 2x 3x 4x 5x 6x 7x 8x
The formatted manual page is displayed using a pager. This can be specified in a number of ways, or else will fall back to a default (see option −P for details).
Filtry sÄ rozszyfrowywane na wiele sposób. Najpierw brana jest pod uwagÄ opcja linii poleceÅ −p lub wartoÅÄ zmiennej Årodowiskowej $MANROFFSEQ. Jeżeli nie podano −p, ani nie ustawiono zmiennej Årodowiska, to przetwarzana jest poczÄtkowa linia źródÅowej strony nroff w poszukiwaniu poprawnego oznaczenia preprocesora. Aby poprawne oznaczenie preprocesora mogÅo zostaÄ znalezione, pierwsza linia musi skÅadaÄ siÄ z
’” <ÅaÅcuch_znaków>
gdzie ÅaÅcuch_znaków może byÄ dowolnÄ kombinacjÄ liter opisanych poniżej w opcji −p.
Jeżeli żadna z powyższych metod nie dostarczy żadnych informacji o filtrowaniu, to bÄdzie użyty zbiór domyÅlny.
Z filtrów i podstawowego programu formatujÄcego (nroff lub [tg]roff z −t)tworzony jest potok formatujÄcy, który nastÄpnie jest wykonywany. Alternatywnie, jeżeli 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 wejÅcie źródÅo strony podrÄcznika, ÅaÅcuch znaków preprocesora i opcjonalnie nazwÄ urzÄdzenia podanÄ w argumentach opcji −T lub −E.
OPCJE
Non−argument options that are duplicated either on the command line, in $MANOPT, or both, are not harmful. For options that require an argument, each duplication will override the previous argument value.
Opcje ogólne
−C plik, −−config−file=plik
Używa podanego pliku konfiguracyjnego użytkownika zamiast domyÅlnego ~/.manpath.
−d, −−debug
WyÅwietla informacjÄ diagnostycznÄ (debug).
−D, −−default
Ta opcja powinna byÄ zazwyczaj podana jako pierwsza, gdyż przywraca domyÅlne zachowanie programu man. Jej zastosowaniem jest wyÅÄczenie tych opcji ustawionych w $MANOPT. Wszystkie opcje nastÄpujÄce po −D bÄdÄ miaÅy swoje normalne znaczenie.
−−warnings[=ostrzeżenia]
WÅÄcza ostrzeżenia programu groff. Można użyÄ tej opcji, aby sprawdziÄ poprawnoÅÄ tekstu źródÅowego stron podrÄcznika ekranowego. ostrzeżenia to rozdzielona przecinkami lista nazw ostrzeżeÅ; jeÅli nie jest podana, to przyjmowana jest wartoÅÄ domyÅlna − “mac”. ListÄ dostÄpnych ostrzeżeÅ można znaleÅºÄ w info groff, sekcja “Ostrzeżenia”.
GÅówne tryby dziaÅania
−f, −−whatis
Odpowiednik whatis. WyÅwietla krótki opis strony podrÄcznika, jeÅli jest dostÄpna. SzczegóÅy można znaleÅºÄ w whatis(1).
−k, −−apropos
Odpowiednik apropos. Wyszukuje krótki opis stron podrÄcznika pasujÄcych dla zadanych sÅów kluczowych i wyÅwietla wszystkie dopasowania. SzczegóÅy można znaleÅºÄ w apropos(1).
−K, −−global−apropos
Szuka tekstu we wszystkich stronach podrÄcznika ekranowego. Jest to przeszukiwanie siÅowe (brute−force), wiÄc czasochÅonne. JeÅli jest to możliwe, prosimy o podanie numeru sekcji, aby zmniejszyÄ liczbÄ przeszukiwanych stron podrÄcznika. Klucze wyszukiwania mogÄ byÄ zwykÅymi ÅaÅcuchami znaków (domyÅlnie) lub wyrażeniami regularnymi (jeÅli podano opcjÄ −−regex).
Należy zauważyÄ, że przeszukiwane sÄ ÅºródÅa stron podrÄcznika ekranowego, a nie sformatowane strony, tak wiÄc mogÄ pojawiÄ siÄ niepoprawne wyniki z powodu na przykÅad komentarzy w plikach źródÅowych. Przeszukiwanie sformatowanych stron byÅoby jeszcze wolniejsze.
−l, −−local−file
Activate “local” mode. Format and display local manual files instead of searching through the system’s manual collection. Each manual page argument will be interpreted as an nroff source file in the correct format. No cat file is produced. If ’−’ is listed as one of the arguments, input will be taken from stdin. When this option is not used, and man fails to find the page required, before displaying the error message, it attempts to act as if this option was supplied, using the name as a filename and looking for an exact match.
−w, −−where, −−path, −−location
Don’t actually display the manual page, but do print the location of the source nroff file that would be formatted. If the −a option is also used, then print the locations of all source files that match the search criteria.
−W, −−where−cat, −−location−cat
Don’t actually display the manual page, but do print the location of the preformatted cat file that would be displayed. If the −a option is also used, then print the locations of all preformatted cat files that match the search criteria.
If −w and −W are both used, then print both source file and cat file separated by a space. If all of −w, −W, and −a are used, then do this for each possible match.
−c, −−catman
Ta opcja nie jest przeznaczona dla ogóÅu i powinna byÄ używana tylko przez program catman.
−R kodowanie_znaków, −−recode=kodowanie_znaków
Zamiast w normalny sposób wyÅwietliÄ stronÄ podrÄcznika, wypisze źródÅo strony przeksztaÅcone na podane kodowanie_znaków. JeÅli znane jest kodowanie znaków pliku źródÅowego, to można użyÄ bezpoÅrednio polecenia manconv(1). Jednakże, opcja ta pozwala przeksztaÅciÄ kilka stron podrÄcznika do jednego kodowania, bez dokÅadnego podawania kodowania źródeÅ każdej z nich, pod warunkiem że strony te sÄ umieszczone w strukturze katalogów podobnej do hierarchii stron podrÄcznika.
Consider using man-recode(1) instead for converting multiple manual pages, since it has an interface designed for bulk conversion and so can be much faster.
Wyszukiwanie stron podrÄcznika ekranowego
−L ustawienia_jÄzykowe, −−locale=ustawienia_jÄzykowe
man zazwyczaj okreÅla bieżÄce ustawienia jÄzykowa przez wywoÅanie systemowej funkcji C setlocale(3), która okreÅla je na podstawie różnych zmiennych Årodowiska, takich jak $LC_MESSAGES i $LANG. Aby tymczasowo nadpisaÄ wartoÅci ustalone przez tÄ funkcjÄ, można użyÄ tej opcji do bezpoÅredniego przekazania ustawieÅ_jÄzykowych do programu man. Uwaga: bÄdzie to miaÅo wpÅyw tylko na wyszukiwanie stron podrÄcznika, komunikaty takie jak informacje o pomocy, zawsze bÄdÄ wyÅwietlane w jÄzyku okreÅlonym na poczÄtku dziaÅania.
−m system[,…], −−systems=system[,…]
JeÅli ten system ma dostÄp do hierarchii stron man innego systemu operacyjnego, to za pomocÄ tej opcji można uzyskaÄ do nich dostÄp. Aby wyszukaÄ stronÄ podrÄcznika z systemu NewOS, należy podaÄ −m NewOS.
Podany system może byÄ kombinacjÄ oddzielonych przecinkami nazw systemów operacyjnych. Aby wÅÄczyÄ hierarchiÄ stron podrÄcznika macierzystego systemu operacyjnego, trzeba użyÄ man jako nazwy systemu w ÅaÅcuchu argumentów. Niniejsza opcja nadpisuje ewentualne użycie zmiennej Årodowiska $SYSTEM.
−M Åcieżka, −−manpath=Åcieżka
Podaje alternatywnÄ ÅcieżkÄ manpath. DomyÅlnie w celu znalezienia Åcieżki przeszukiwaÅ man używa kodu programu manpath. Opcja ta nadpisuje wartoÅÄ zmiennej Årodowiskowej $MANPATH i powoduje, że opcja −m jest ignorowana.
Åcieżka podana jako Åcieżka manpath musi byÄ korzeniem hierarchii stron podrÄcznika, której struktura odpowiada strukturze sekcji opisanej w podrÄczniku man−db (w dokumencie “System stron podrÄcznika ekranowego”, ang. “The manual page system”). Aby zobaczyÄ strony podrÄcznika poza tÄ hierarchiÄ, patrz opcja −l.
−S list, −s list, −−sections=list
The given list is a colon− or comma−separated list of sections, used to determine which manual sections to search and in what order. This option overrides the $MANSECT environment variable. (The −s spelling is for compatibility with System V.)
−e pod−rozszerzenie, −−extension=pod−rozszerzenie
Some systems incorporate large packages of manual pages, such as those that accompany the Tcl package, into the main manual page hierarchy. To get around the problem of having two manual pages with the same name such as exit(3), the Tcl pages were usually all assigned to section l. As this is unfortunate, it is now possible to put the pages in the correct section, and to assign a specific “extension” to them, in this case, exit(3tcl). Under normal operation, man will display exit(3) in preference to exit(3tcl). To negotiate this situation and to avoid having to know which section the page you require resides in, it is now possible to give man a sub−extension string indicating which package the page must belong to. Using the above example, supplying the option −e tcl to man will restrict the search to pages having an extension of *tcl.
−i, −−ignore−case
Ignoruje wielkoÅÄ liter podczas wyszukiwania stron podrÄcznika. Jest to zachowanie domyÅlne.
−I, −−match−case
Wyszukuje strony podrÄcznika zwracajÄc uwagÄ na wielkoÅÄ liter.
−−regex
WyÅwietla wszystkie strony, których jakakolwiek czÄÅÄ nazwy lub opisu pasuje − jako wyrażenie regularne − do każdego podanego argumentu strona, tak jak to robi apropos(1). Ponieważ podczas wyszukiwania za pomocÄ wyrażeÅ regularnych zazwyczaj nie ma rozsÄdnego sposobu wydobycia”najlepszej” strony, opcja ta wÅÄcza −a.
−−wildcard
WyÅwietla wszystkie strony, których jakakolwiek czÄÅÄ nazwy lub opisu pasuje − jako wyrażenie zawierajÄce znaki dopasowania w stylu powÅoki − do każdego podanego argumentu strona, tak jak to robi apropos(1) −−wildcard. Argument strona musi pasowaÄ albo do caÅej nazwy lub caÅego opisu, albo do poszczególnych sÅów opisu. Ponieważ podczas wyszukiwania zazwyczaj nie ma rozsÄdnego sposobu wydobycia”najlepszej” strony, opcja ta wÅÄcza −a.
−−names−only
Jeżeli użyto opcji −−regex lub −−wildcard, dopasowywane bÄdÄ tylko nazwy stron, bez opisów stron, tak jak to robi whatis(1). W przeciwnym razie opcja ta nic nie robi.
−a, −−all
DomyÅlnie man zakoÅczy dziaÅanie po wyÅwietleniu najbardziej odpowiedniej strony podrÄcznika, jakÄ znajdzie. Użycie tej opcji spowoduje, że man pokaże wszystkie dostÄpne strony podrÄcznika, których nazwy odpowiadajÄ kryteriom wyszukiwania.
−u, −−update
This option causes man to update its database caches of installed manual pages. This is only needed in rare situations, and it is normally better to run mandb(8) instead.
−−no−subpages
DomyÅlnie, man próbuje interpretowaÄ pary nazw stron podrÄcznika podane w linii poleceÅ jako odpowiedniki nazw pojedynczych stron podrÄcznika zawierajÄcych znaki myÅlnika lub podkreÅlenia. Wspiera to zwyczajowy wzorzec programów implementujÄcych podprogramy, pozwalajÄc im na dostarczanie stron podrÄcznika dla każdego podprogramu przy użyciu skÅadni podobnej do tej, która by byÅa użyta do uruchomienia tego podprogramu. PrzykÅad:
$ man −aw git diff
/usr/share/man/man1/git−diff.1.gz
Aby wyÅÄczyÄ to zachowanie, proszÄ użyÄ 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 wyjÅcia
−P pager, −−pager=pager
Specify which output pager to use. By default, man uses less, falling back to cat if less is not found or is not executable. This option overrides the $MANPAGER environment variable, which in turn overrides the $PAGER environment variable. It is not used in conjunction with −f or −k.
WartoÅciÄ może byÄ nazwa zwykÅego polecenia lub polecenie z argumentami. W wartoÅci można używaÄ znaków cytowania powÅoki (odwrotne ukoÅniki, pojedyncze lub podwójne cudzysÅowy), jednakże nie można ÅÄczyÄ wielu poleceÅ w potoki; jeÅli jest to potrzebne należy użyÄ skryptu otaczajÄcego potok. Skrypt ten powinien móc przyjmowaÄ plik do wyÅwietlenia albo jako argument linii poleceÅ, albo odczytaÄ go ze standardowego wejÅcia.
−r linia_zachÄty, −−prompt=linia_zachÄty
Jeżeli jako przeglÄdarka tekstu jest używana w miarÄ nowa wersja programu less, to man spróbuje ustawiÄ jej ÅaÅcuch zachÄty oraz parÄ sensownych opcji. DomyÅlny ÅaÅcuch zachÄty wyglÄda tak
Strona podrÄcznika nazwa(sek) linia x
gdzie nazwa oznacza nazwÄ strony podrÄcznika, sek oznacza sekcjÄ, w której znaleziono tÄ stronÄ, a x jest numerem bieżÄcego wiersza. OsiÄga siÄ to przez użycie zmiennej Årodowiska $LESS.
Supplying −r with a string will override this default. The string may contain the text $MAN_PN which will be expanded to the name of the current manual page and its section name surrounded by “(” and “)”. The string used to produce the default could be expressed as
Strona podrÄcznika $MAN_PN ?ltlinia %lt?L/%L.:
bajt %bB?s/%s..? (KONIEC):?pB %pB\%..
(naciÅnij h, aby otrzymaÄ pomoc, lub q, aby zakoÅczyÄ)
PodziaÅ na trzy linie zastosowano tylko dla zwiÄkszenia czytelnoÅci. Znaczenie można znaleÅºÄ w podrÄczniku less(1). Linia zachÄty jest najpierw rozwijana przez powÅokÄ. Wszystkie podwójne cudzysÅowy, odwrotne apostrofy i odwrotne ukoÅniki w linii zachÄty muszÄ byÄ poprzedzone znakiem odwrotnego ukoÅnika. Linia zachÄty może koÅczyÄ siÄ poprzedzonym przez odwrotny ukoÅnik znakiem $, po którym mogÄ nastÄpowaÄ kolejne opcje przekazywane do programu less. DomyÅlnie man ustawia opcje −ix8.
Opisanej poniżej zmiennej Årodowiskowej $MANLESS można użyÄ do ustawienia domyÅlnego ÅaÅcucha zachÄty, jeżeli nie podano go w parametrach linii poleceÅ.
−7, −−ascii
Podczas przeglÄdanie strony podrÄcznika zawierajÄcej tylko czyste znaki ascii(7) w 7−bitowym terminalu lub emulatorze terminala, niektóre znaki mogÄ nie byÄ wyÅwietlone poprawnie, jeżeli z programem używane jest urzÄdzenie latin1(7) programu GNU nroff. Ta opcja pozwala, aby strony zawierajÄce tylko znaki ascii byÅy wyÅwietlane w trybie ascii z urzÄdzeniem latin1. Opcja ta nie zmieni kodowania żadnego tekstu latin1. Poniższa tabela pokazuje przeprowadzane zmiany kodowaÅ: niektóre z nich mogÄ byÄ wyÅwietlone poprawnie, tylko gdy używa siÄ urzÄdzenia latin1(7) GNU nroffa.
Jeżeli kolumna latin1 wyÅwietla siÄ poprawnie, Twój terminal może byÄ już ustawiony na znaki latin1, wiÄc podanie tej opcji nie jest potrzebne. JeÅli kolumny latin1 i ascii sÄ identyczne, to czytasz tÄ stronÄ używajÄc omawianej opcji lub man nie sformatowaÅ tej strony za pomocÄ urzÄdzenia latin1. JeÅli brakuje kolumny latin1 lub jest ona uszkodzona, to najprawdopodobniej trzeba używaÄ omawianej opcji podczas przeglÄdania stron podrÄcznika ekranowego.
Ta opcja jest ignorowana, jeżeli podano również −t, −H, −T albo −Z i może byÄ caÅkowicie nieprzydatna podczas używania wersji nroffa innej niż GNU.
−E kodowanie_znaków, −−encoding=kodowanie_znaków
Generuje wyjÅcie w innym niż domyÅlne kodowaniu znaków. W celu zachowania wstecznej kompatybilnoÅci kodowanie_znaków może byÄ urzÄdzeniem nroff, takim jak ascii, latin1 lub utf8 jak również prawdziwym kodowaniem znaków, takim jak UTF−8.
−−no−hyphenation, −−nh
Zazwyczaj nroff automatycznie dzieli wyrazy przy przenoszeniu, jeÅli jest to konieczne, aby wyrównaÄ liniÄ, tak żeby nie zawieraÅa za dużo spacji, i robi to nawet wtedy, gdy wyrazy te nie zawierajÄ znaków ÅÄcznika. Ta opcja wyÅÄcza automatyczne dzielenie wyrazów, tak że sÅowa bÄdÄ dzielone tylko, gdy zawierajÄ ÅÄczniki.
JeÅli piszesz stronÄ podrÄcznika ekranowego, to aby powstrzymaÄ nroff przed przenoszeniem wyrazów do nowej linii w nieodpowiednim miejscu, należy zapoznaÄ siÄ z dokumentacjÄ programu nroff, zamiast używaÄ tej opcji; na przykÅad można w sÅowie umieÅciÄ sekwencjÄ “%” wskazujÄcÄ miejsce, w którym sÅowo może byÄ podzielone przy przenoszeniu, albo umieÅciÄ “%” na poczÄtku sÅowa, co zabroni jego dzielenia.
−−no−justification, −−nj
Zazwyczaj nroff automatycznie wyrówna tekst w linii do obu marginesów. Opcja ta wyÅÄcza takie wyrównywanie, zostawiajÄc wyrównywanie tylko do lewego marginesu, co powoduje, że tekst z prawej strony jest “postrzÄpiony”.
Podczas pisania strony podrÄcznika ekranowego, nie należy używaÄ tej opcji do powstrzymywania nroffa od wyrównywania linii w akapicie do obu marginesów. Zamiast tego proszÄ zapoznaÄ siÄ z dokumentacjÄ programu nroff. Na przykÅad można użyÄ Å¼ÄdaÅ “.na”, “.nf”, “.fi”, and “.ad”, aby tymczasowo wyÅÄczyÄ wyrównywanie linii i wypeÅnianie spacjami.
−p ÅaÅcuch_znaków, −−preprocessor=ÅaÅcuch_znaków
OkreÅla sekwencjÄ preprocesorów do uruchomienia przez uruchomieniem programu nroff lub troff/groff. Nie w każdym systemie bÄdzie zainstalowany peÅen zbiór preprocesorów. Niektóre preprocesory i litery je oznaczajÄce 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
Używa programu groff −mandoc, aby sformatowaÄ stronÄ podrÄcznika na standardowe wyjÅcie. Opcja nie jest wymagana w poÅÄczeniu z −H, −T lub −Z.
−T[urzÄdzenie], −−troff−device[=urzÄdzenie]
Za pomocÄ tej opcji można zmieniÄ wyjÅcie programu groff (lub byÄ może troff), tak aby byÅo odpowiednie dla innego urzÄdzenia niż domyÅlne. WÅÄcza opcjÄ −t. PrzykÅady (dostarczane przez groff−1.17) zawierajÄ dvi, latin1, ps, utf8, X75 oraz X100.
−H[przeglÄdarka], −−html[=przeglÄdarka]
Opcja ta spowoduje, że groff utworzy wyjÅcie w formacie HTML i je wyÅwietli w przeglÄdarce stron www. Wybór przeglÄdarki dokonywany jest przy pomocy opcjonalnego argumentu przeglÄdarka. JeÅli go nie podano, to brana jest pod uwagÄ wartoÅÄ zmiennej Årodowiska $BROWSER, a nastÄpnie domyÅlna przeglÄdarka ustawiona podczas kompilowania pakietu (zazwyczaj lynx). Opcja ta wÅÄcza również −t i bÄdzie dziaÅaÄ tylko z wersjÄ GNU troffa.
−X[dpi], −−gxditview[=dpi]
Opcja ta wyÅwietla wyjÅcie groffa w okienku graficznym za pomocÄ programu gxditview Argumentem dpi (dots per inch) może byÄ 75, 75−12, 100 lub 100−12, domyÅlnie jest 75; warianty −12 używajÄ 12−punktowej czcionki jako bazowej. Opcja wÅÄcza −T z urzÄdzeniem X75, X75−12, X100 lub X100−12.
−Z, −−ditroff
groff uruchomi program troff i użyje odpowiedniego postprocesora do utworzenia wyjÅcia odpowiedniego dla wybranego urzÄdzenia. Gdy groff −mandoc jest groffem, to ta opcja jest przekazywana do groffa i wstrzyma użycie postprocesora. Automatycznie wÅÄcza opcjÄ −t.
Otrzymywanie pomocy
−?, −−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, skÅadni lub pliku konfiguracyjnego. |
||
|
2 |
BÅÄd dziaÅania. |
||
|
3 |
Proces potomny zwróciÅ niezerowy kod zakoÅczenia. |
||
|
16 |
Co najmniej jedna z stron/plików/sÅów kluczowych nie istnieje lub nie zostaÅo dopasowane. |
ÅRODOWISKO
MANPATH
Jeżeli ustawiona jest $MANPATH, to jej wartoÅÄ jest używana jako Åcieżka przeszukiwaÅ hierarchii stron man.
MANROFFOPT
Every time man invokes the formatter (nroff, troff, or groff), it adds the contents of $MANROFFOPT to the formatter’s command line.
MANROFFSEQ
Jeżeli ustawiono $MANROFFSEQ, to jej wartoÅÄ jest używana do okreÅlenia zbioru preprocesorów przez które jest przepuszczana strona podrÄcznika. DomyÅlna lista preprocesorów zależy od systemu.
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 1p 8 2 3 3p 3pm 4 5 6 7 9 0p n l p o 1x 2x 3x 4x 5x 6x 7x 8x”, chyba że zostanie to nadpisane w polu SECTION pliku /etc/man_db.conf.
MANPAGER, PAGER
If $MANPAGER or $PAGER is set ($MANPAGER is used in preference), its value is used as the name of the program used to display the manual page. By default, less is used, falling back to cat if less is not found or is not executable.
WartoÅciÄ może byÄ nazwa zwykÅego polecenia lub polecenie z argumentami. W wartoÅci można używaÄ znaków cytowania powÅoki (odwrotne ukoÅniki, pojedyncze lub podwójne cudzysÅowy), jednakże nie można ÅÄczyÄ wielu poleceÅ w potoki; jeÅli jest to potrzebne należy użyÄ skryptu otaczajÄcego potok. Skrypt ten powinien móc przyjmowaÄ plik do wyÅwietlenia albo jako argument linii poleceÅ, albo odczytaÄ go ze standardowego wejÅcia.
MANLESS
JeÅli $MANLESS jest ustawiona, to jej wartoÅÄ zostanie użyta jako domyÅlna linia zachÄty programu less, dokÅadnie tak jakby przekazano jÄ w opcji −r (i każde wystÄpienie tekstu $MAN_PN zostanie rozwiniÄte w taki sam sposób). Na przykÅad aby bezwarunkowo ustawiÄ liniÄ zachÄty na “moja linia zachÄty”, należy ustawiÄ $MANLESS na ‘−Psmoja linia zachÄty’. Użycie opcji −r nadpisuje tÄ zmiennÄ Årodowiska.
BROWSER
Jeżeli jest ustawiona zmienna $BROWSER, to jej wartoÅciÄ jest rozdzielona dwukropkami lista poleceÅ, które man bÄdzie − w kolejnoÅci − próbowaÅ uruchomiÄ, aby wyÅwietliÄ wyjÅcie man −−html w przeglÄdarce www. W każdym poleceniu %s jest zastÄpowane nazwÄ pliku zawierajÄcego wyjÅcie HTML programu groff, %% jest zastÄpowane znakiem procentu (%), a %c − dwukropkiem (:).
|
SYSTEM |
Jeżeli ustawiona jest zmienna $SYSTEM, to ma to taki sam skutek, jak przekazanie jej wartoÅci jako argumentu opcji −m. |
||
|
MANOPT |
Jeżeli ustawiono $MANOPT, to wartoÅÄ tej zmiennej, która powinna byÄ w formacie podobnym do formatu linii opcji poleceÅ programu man, bÄdzie przetwarzana przed opcjami linii poleceÅ. Ponieważ wszystkie pozostaÅe zmienne Årodowiska specyficzne dla programu man mogÄ byÄ wyrażone jako opcje linii poleceÅ i jako takie mogÄ byÄ podane w zmiennej $MANOPT, należy oczekiwaÄ, że zostanÄ one uznane za przestarzaÅe. Uwaga: wszystkie spacje, które majÄ byÄ zinterpretowane jako czÄÅÄ argumentu opcji, muszÄ zostaÄ poprzedzone znakiem odwrotnego ukoÅnika. |
MANWIDTH
If $MANWIDTH is set, its value is used as the line length for which manual pages should be formatted. If it is not set, manual pages will be formatted with a line length appropriate to the current terminal (using the value of $COLUMNS, and ioctl(2) if available, or falling back to 80 characters if neither is available). Cat pages will only be saved when the default formatting can be used, that is when the terminal line length is between 66 and 80 characters.
MAN_KEEP_FORMATTING
Zazwyczaj, jeżeli wyjÅcie nie jest przekazywane do terminala (tylko np. do pliku lub potoku), to kontrolne znaki formatujÄce sÄ usuwane, aby uÅatwiÄ czytanie pliku wynikowego bez użycia żadnych dodatkowych narzÄdzi. Jednakże jeżeli MAN_KEEP_FORMATTING ma niepustÄ wartoÅÄ, znaki te sÄ zachowywane. Może byÄ to użyteczne dla programów, które wewnÄtrznie wywoÅujÄ man i potrafiÄ zinterpretowaÄ znaki kontrolne.
MAN_KEEP_STDERR
Zazwyczaj, jeÅli wyjÅcie jest skierowane na terminal (zazwyczaj do programu do stronicowania), to ignorowane sÄ wszystkie komunikaty bÅÄdów generowane przez programy używane to sformatowania strony podrÄcznika, tak aby nie zakÅóciÄ wyjÅcia programu do stronicowania. Programy, takie jak groff czÄsto tworzÄ komunikaty o relatywnie maÅo istotnych bÅÄdach typograficznych (dotyczÄcych na przykÅad zÅego wyrównania) − wyÅwietlanie ich razem ze stronÄ podrÄcznika byÅoby szpecÄce i mylÄce. JednakÅ¼Ä niektórzy użytkownicy chcieliby zobaczyÄ te bÅÄdy, wiÄc jeżeli ustawi siÄ zmiennÄ $MAN_KEEP_STDERR na dowolnÄ niepustÄ wartoÅÄ, to wyjÅcie bÅÄdów bÄdzie normalnie wyÅwietlane.
LANG, LC_MESSAGES
W zależnoÅci od systemu i implementacji bieżÄce ustawienia jÄzykowe bÄdÄ pobierane z jednej lub obu spoÅród zmiennych $LANG i $LC_MESSAGES. man wyÅwietli swoje komunikaty w tym jÄzyku (jeÅli sÄ dostÄpne). SzczegóÅy można znaleÅºÄ w setlocale(3).
PLIKI
/etc/man_db.conf
Plik konfiguracyjny man−db.
/usr/share/man
Globalna hierarchia stron podrÄcznika ekranowego.
ZOBACZ TAKŻE
apropos(1), groff(1), less(1), manpath(1), nroff(1), troff(1), whatis(1), zsoelim(1), manpath(5), man(7), catman(8), mandb(8)
Documentation for some packages may be available in other formats, such as info(1) or HTML.
HISTORIA
1990, 1991 – Program napisany przez Johna W. Eatona (jwe@che.utexas.edu).
23 grudnia 1992: Rik Faith (faith@cs.unc.edu) zaaplikowaÅ poprawki bÅÄdów nadesÅane przez Willema Kasdorpa (wkasdo@nikhefk.nikef.nl).
30th April 1994 – 23rd February 2000: Wilf. (G.Wilford@ee.surrey.ac.uk) has been developing and maintaining this package with the help of a few dedicated people.
30 października 1996 – 30 marca 2001: Fabrizio Polacco
31 marca 2001 – obecnie: Colin Watson
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.