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.

Opis	Ósemkowy	latin1	ascii
łącznik	255	‐	-
kula (kropka w środku)	267	•	o
akcent ostry	264	´	'
znak dzielenia	327	×	x

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.