man.1

НАЗВА

man - форматує та показує вбудовані сторінки допомоги
manpath - визначає шлях пошуку вбудованих сторінок допомоги

СТИСЛИЙ ОГЛЯД

man [-acdfFhkKtwW] [-m system] [-p string] [-C config_file] [-M path] [-P pager] [-S section_list] [section] name ...

ОПИС

man форматує та показує вбудовані сторінки допомоги. Ця версія знає про змінні оточення MANPATH та (MAN)PAGER отже, ви можете мати свій власний комплект сторінок допомоги та обирати на свій смак програму, що буде показувати сформовані сторінки. Коли визначено section man шукає лише в цій секції настанов. Ви можете також визначити засобами командного рядка або змінними оточення послідовність пошуку запису по секціях та яким допроцесором буде оброблено файли джерел. Коли в name присутнє /, воно, перш за все, вважається назвою файлу, отже ви можете виконати man ./foo.5 або навіть man /cd/foo/bar.1.gz.

ПАРАМЕТРИ

-C config_file	Визначає який файл man.conf використовувати; типово це /etc/man.config . (Дивись ?man.config(5).)
-M path	Визначає перелік каталогів в яких шукати сторінки допомоги. Коли цей параметр не задано, використовується значення змінної оточення MANPATH . Коли ця змінна оточення не встановлена, типовий перелік знаходиться з файлу /etc/man.config. Пустий рядок MANPATH відміняє типовий перелік.
-P pager	Визначає програму виводу сторінок. Цей параметр перекриває змінну оточення MANPAGER , яка перекриває змінну PAGER . Типово, man використовує /usr/bin/less -is .
-S section_list	Перелік - перелік розділених двокрапкою секцій настанов для пошуку. Цей параметр перекриває змінну оточення MANSECT .
-a	Типово, man припиняє роботу після показу першої знайденої сторінки. Використання цього параметру примусить man показати всі наявні сторінки, що вадповідають name, не тільки першу.
-c	Переформувати сторінки допомоги з файлів джерел, навіть коли існують свіжі сформовані сторінки. Це буває корисно коли вони були сформовані для екрану іншого розміру або існуюча копія ушкоджена.
-d	Не показує реально сторінки допомоги, але виконує друк звалища відлагоджувальних відомостей.
-D	І показує і друкує відомості відладки.
-f	Теж саме, що whatis .
-F або --preformat	Тільки формує, але не показує.
-h	Друкує вбудовану підказку та закінчує роботу.
-k	Теж саме, що apropos .
-K	Шукає зазначену послідовність по всіх сторінках допомоги. Увага: це може бути дуже довго! Це допомагає визначити секцію. (Треба використовувати обережно, пошук може зайняти більше хвилини на слабій машині з великою кількістю сторінок.)
-m system	Визначає інший набір сторінок допомоги для пошуку, що базується на означеній назві системи.
-p string	Визначає послідовність препроцесорів, що будуть виконані до nroff або troff . Не всі системи будуть мати повний набір препроцесорів. Деякі з препроцесорів та літери6 що використовуються для їх позначення: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Цей параметр перекриває змінну оточення MANROFFSEQ .
-t	Використати /usr/bin/groff -Tps -mandoc для формування сторінок допомоги, спрямовує вивід до stdout. Вивід з /usr/bin/groff -Tps -mandoc може потребувати використання якого-небудь фільтру або чогось іще до друкування.
-w або --path	Не показує сторінки допомоги, але друкує розташування файлів, що будуть відформатовані або показані. Коли аргумент відсутній, показує (на stdout) перелік каталогів в яких man буде шукати сторінки допомоги. Коли manpath - посилання на, manpath рівнозначно до man --path.
-W	Як -w, але друкує назви файлів по одному на рядок без додаткових відомостей. Це корисно в командах оболонки таких як man -aW man \| xargs ls -l

СФОРМОВАНІ СТОРІНКИ

Man буде намагатися зберегти сформовані сторінки допомоги, щоб уникнути втрат часу на форматування наступного разу коли знов буде викликана ця сторінка. Зазвичай, сформовані версії сторінок з DIR/manX зберігаються в DIR/catX, але інше відображення з man каталогу до cat каталогу може бути задане в /etc/man.config . Сторінки cat не зберігаються взагалі коли потрібний каталог cat не існує.

Можливо встановити man suid на користувача man. Тоді, якщо каталог cat має власником man та mode 0755 (запис тільки man-ом), та cat файли мають власником man та mode 0644 або 0444 (запис тільки man-ом або ніким взагалі), ніякий звичайний користувач не зможе змінити сформовані сторінки або поміститиінші файли в каталог з ними. Коли на man не встановлено suid, то каталог cat повинен мати mode 0777 коли всі користувачі повинні мати можливість зберігати тут сформовані сторінки.

Параметр -c змушує формувати сторінку знов, навіть коли існує свіжа сторінка cat.

ОТОЧЕННЯ

MANPATH	Коли встановлено значення MANPATH , воно використовується як шлях для пошуку сторінок посібника.
MANPL	Коли встановлено MANPL , воно використовується як значення розміру зображуваної сторінки. Коли ні, то вся сторінка виводиться як одне ціле.
MANROFFSEQ	Коли встановлено MANROFFSEQ , його значення використовується для визначення допроцесора, що запускається перед nroff або troff . Типово, сторінки пропускають через табличний допроцесор перед nroff .
MANSECT	Коли встановлено MANSECT , воно використовується для визначення в яких розділах посібника вести пошук.
MANWIDTH	Коли встановлено MANWIDTH , воно використовується як ширина сторінки, що буде виведена на екран. В іншому випадку, сторінку буде показано на всю ширину вашого екрану.
MANPAGER	Коли встановлено MANPAGER , воно використовується як назва програми, що буде використана для показу сторінок посібника. В іншому випадку, буде використано PAGER . Коли ця змінна також не встановлена, використовується /usr/bin/less -is .
LANG	Коли встановлена LANG , її значення визначає назву підкаталогу, де man перш за все шукає сторінки посібника. Отже, команда 'LANG=dk man 1 foo' змусить man шукати сторінку пояснень до foo в .../dk/man1/foo.1, та, коли не зможе знайти там, буде шукати в .../man1/foo.1, де ... каталог? що вказаний в шляху пошуку.
NLSPATH, LC_MESSAGES, LANG	Змінні оточення NLSPATH та LC_MESSAGES (або LANG коли не встановлено останню) впливають на визначення розташування каталогу з повідомленнями. (Але, англійські повідомлення вкомпільовані і для них каталогу не потрібно.) Зауважимо, що програми подібні до col(1), що їх викликає man, також використовують LC_CTYPE.
PATH	PATH is використовується для побудови стандартного шляху пошуку сторінок посібника.
SYSTEM	SYSTEM використовується для одержання типової дублюючої назви системи (для використання з параметром -m ).

ДИВИСЬ ТАКОЖ

apropos(1), whatis(1), less(1), ?groff(1).

ПОМИЛКИ

Параметр -t працює тільки коли встановлено програму типу troff.
Коли ви спостерігаєте блимаючий \255 або замість переносу, виставте 'LESSCHARSET=latin1' у вашому оточенні.

ПОРАДИ

Коли додаєте рядок (global-set-key [(f1)] (lambda () (interactive) (manual-entry (current-word)))) до вашого файлу .emacs , то натискання F1 буде давати вам сторінку посібника для бібліотечного виклику в поточній позиції вказівника.

Для одержання сторінки посібника у вигляді текстового файлу, без зайвих позначок , спробуйте # man foo | col -b > foo.mantxt

ПЕРЕКЛАД

Перекладено Андрієм М. Добровольським dobr@altlinux.ru

-C config_file	Визначає який файл man.conf використовувати; типово це /etc/man.config . (Дивись ?man.config(5).)
-M path	Визначає перелік каталогів в яких шукати сторінки допомоги. Коли цей параметр не задано, використовується значення змінної оточення MANPATH . Коли ця змінна оточення не встановлена, типовий перелік знаходиться з файлу /etc/man.config. Пустий рядок MANPATH відміняє типовий перелік.
-P pager	Визначає програму виводу сторінок. Цей параметр перекриває змінну оточення MANPAGER , яка перекриває змінну PAGER . Типово, man використовує /usr/bin/less -is .
-S section_list	Перелік - перелік розділених двокрапкою секцій настанов для пошуку. Цей параметр перекриває змінну оточення MANSECT .
-a	Типово, man припиняє роботу після показу першої знайденої сторінки. Використання цього параметру примусить man показати всі наявні сторінки, що вадповідають name, не тільки першу.
-c	Переформувати сторінки допомоги з файлів джерел, навіть коли існують свіжі сформовані сторінки. Це буває корисно коли вони були сформовані для екрану іншого розміру або існуюча копія ушкоджена.
-d	Не показує реально сторінки допомоги, але виконує друк звалища відлагоджувальних відомостей.
-D	І показує і друкує відомості відладки.
-f	Теж саме, що whatis .
-F або --preformat	Тільки формує, але не показує.
-h	Друкує вбудовану підказку та закінчує роботу.
-k	Теж саме, що apropos .
-K	Шукає зазначену послідовність по всіх сторінках допомоги. Увага: це може бути дуже довго! Це допомагає визначити секцію. (Треба використовувати обережно, пошук може зайняти більше хвилини на слабій машині з великою кількістю сторінок.)
-m system	Визначає інший набір сторінок допомоги для пошуку, що базується на означеній назві системи.
-p string	Визначає послідовність препроцесорів, що будуть виконані до nroff або troff . Не всі системи будуть мати повний набір препроцесорів. Деякі з препроцесорів та літери6 що використовуються для їх позначення: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Цей параметр перекриває змінну оточення MANROFFSEQ .
-t	Використати /usr/bin/groff -Tps -mandoc для формування сторінок допомоги, спрямовує вивід до stdout. Вивід з /usr/bin/groff -Tps -mandoc може потребувати використання якого-небудь фільтру або чогось іще до друкування.
-w або --path	Не показує сторінки допомоги, але друкує розташування файлів, що будуть відформатовані або показані. Коли аргумент відсутній, показує (на stdout) перелік каталогів в яких man буде шукати сторінки допомоги. Коли manpath - посилання на, manpath рівнозначно до man --path.
-W	Як -w, але друкує назви файлів по одному на рядок без додаткових відомостей. Це корисно в командах оболонки таких як man -aW man \| xargs ls -l

MANPATH	Коли встановлено значення MANPATH , воно використовується як шлях для пошуку сторінок посібника.
MANPL	Коли встановлено MANPL , воно використовується як значення розміру зображуваної сторінки. Коли ні, то вся сторінка виводиться як одне ціле.
MANROFFSEQ	Коли встановлено MANROFFSEQ , його значення використовується для визначення допроцесора, що запускається перед nroff або troff . Типово, сторінки пропускають через табличний допроцесор перед nroff .
MANSECT	Коли встановлено MANSECT , воно використовується для визначення в яких розділах посібника вести пошук.
MANWIDTH	Коли встановлено MANWIDTH , воно використовується як ширина сторінки, що буде виведена на екран. В іншому випадку, сторінку буде показано на всю ширину вашого екрану.
MANPAGER	Коли встановлено MANPAGER , воно використовується як назва програми, що буде використана для показу сторінок посібника. В іншому випадку, буде використано PAGER . Коли ця змінна також не встановлена, використовується /usr/bin/less -is .
LANG	Коли встановлена LANG , її значення визначає назву підкаталогу, де man перш за все шукає сторінки посібника. Отже, команда 'LANG=dk man 1 foo' змусить man шукати сторінку пояснень до foo в .../dk/man1/foo.1, та, коли не зможе знайти там, буде шукати в .../man1/foo.1, де ... каталог? що вказаний в шляху пошуку.
NLSPATH, LC_MESSAGES, LANG	Змінні оточення NLSPATH та LC_MESSAGES (або LANG коли не встановлено останню) впливають на визначення розташування каталогу з повідомленнями. (Але, англійські повідомлення вкомпільовані і для них каталогу не потрібно.) Зауважимо, що програми подібні до col(1), що їх викликає man, також використовують LC_CTYPE.
PATH	PATH is використовується для побудови стандартного шляху пошуку сторінок посібника.
SYSTEM	SYSTEM використовується для одержання типової дублюючої назви системи (для використання з параметром -m ).