man(1)

ИМЕ
man - форматиране и извеждане на страници от онлайн ръководството
manpath - установяване на пътя за търсене на страници от ръководството за конкретния потребител

СИНТАКСИС
man [-acdfFhkKtwW] [--path] [-m система] [-p текст] [-C конфигурационен_файл] [-M път] [-P програма] [-S списък_от_секции] [секция] име ...

ОПИСАНИЕ
man форматира и извежда страници от онлайн ръководството. Ако е указана секция, man търси само в тази секция на ръководството. име обикновенно е име на страница от ръководството, т.е. по принцип име на команда, функция или файл. Ако обаче име съдържа наклонена черта (/), man го възприема като име на файл, така че можете да изпълните man ./foo.5 или дори man /cd/foo/bar.1.gz.

По-надолу е описано къде man търси страниците от ръководството.

ОПЦИИ

-C  конфигурационен_файл
    Указва кой конфигурационен файл да се използва. Подразбира се /etc/man.conf. (Вижте man.conf(5)).

-M  път
    Списък на директории, разделени с двоеточие, в които да се търсят страници от ръководството. Празен списък e същото като да не се укаже -M. Вижте ПЪТ ЗА ТЪРСЕНЕ НА СТРАНИЦИ ОТ РЪКОВОДСТВОТО.

-P  програма
    Програма която да се ползва за показване на страниците. Тази опция е с по-висок приоритет от променливата на обкръжението MANPAGER, която пък е с по-висок приоритет от PAGER. По подразбиране man използва /usr/bin/less -is.

-S  списък_от_секции
    Списък от секции, разделени с двоеточие, в които да се търсят страници от ръководството. Тази опция е с по-висок приоритет от променливата на обкръжението MANSECT.

-a  Извеждане на всички намерени страници. По подразбиране man извежда само първата намерена страница.

-c  Форматиране наново на оригиналната страница дори ако съществува актуална готова страница. Това има смисъл ако готовата страница е повредена или форматирана за екран с различен брой редове.

-d  Извеждане не на страници, а на диагностична информация за изпълнението на man.

-D  Извеждане и на страниците, и на диагностична информация.

-f  Еквивалент на whatis.

-F или --preformat
    Само форматиране, без извеждане.

-h  Извеждане само на помощно съобщение.

-k  Еквивалент на apropos.

-K  Търсене на указан текст във *всички* страници. Внимание: това най-вероятно ще е много бавно, така че е добре е да се укаже секция. (Само за да придобиете представа, на моята машина търсенето в 500 страници отнема около минута).

-m  система
    Търсене в алтернативен набор от страници, отговарящи на указаната система.

-p  текст
    Списък от команди за предварителна обработка, които да се стартират преди nroff или troff. Не всички системи разполагат с пълен набор от средства за предварителна обработка. Някои от командите и буквите, използвани за извикването им, са: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Тази опция е с по-висок приоритет от променливата на обкръжението MANROFFSEQ.

-t  Използване на /usr/bin/groff -Tps -mandoc за форматиране страницата и изпращане на резултата на стандартния изход. Възможно е да се наложи използването на допълнителен филтър преди страницата да се отпечата.

-w или --path
    Извеждане не на страниците, а на местонахождението на файловете, които биха били форматирани или изведени. Ако не е указан аргумент, извеждане (на стандартния изход) на директориите, в които man търси страници от ръководството. Ако командата manpath сочи към man, то "manpath" е еквивалент на "man --path".

-W  Като -w, но имената на файловете се извеждат по един на ред и без допълнителна информация. Използва се за команди като man -aW man | xargs ls -l.

ГОТОВИ СТРАНИЦИ
За да икономисва време при форматирането на страниците, man се опитва да съхранява форматираните страници и впоследствие да ги използва готови. По традиция готовите ("cat") версии на страниците от ДИРЕКТОРИЯ/manX се съхраняват в ДИРЕКТОРИЯ/catX, но в /etc/man.conf може да се укаже друго съответствие (съответствия). Готовите страници не се съхраняват ако необходимата за това директория липсва или man.conf съдържа директивата NOCACHE.

Възможно е man да се присвои на потребителя man. Тогава, ако cat директорията е с потребител man и права за достъп 0755 (достъпна за запис само от man), и ако cat файловете са с потребител man и права за достъп 0644 или 0444 (достъпни за запис само от man или забранени за запис), никой обикновен потребител не може да променя готови страници или да помества други файлове в cat директорията. Ако man не е присвоен на потребителя man и всички потребители трябва да могат да създават cat страници, то cat директориите трябва да са с права за достъп 0777.

Опцията -c задължително форматира наново оригиналната страница, дори ако съществува актуална готова страница.

ПЪТ ЗА ТЪРСЕНЕ НА СТРАНИЦИ ОТ РЪКОВОДСТВОТО
man използва сложен алгоритъм за търсене на страници от ръководството, базиран на подадените опции, конфигурационния файл /etc/man.conf и някои вградени конвенции и евристики.

Първо, ако аргумента име подаден на man съдържа наклонена черта (/), man го възприема като име на файл и не провежда никакво търсене.

В нормалния случай обаче, когато име не съдържа наклонена черта, man претърсва разнообразни директории за файл, който би могъл да е страница от ръководството за указаното име.

Ако зададете опцията -M път, то път е списъка от директории, които man претърсва.

Ако не зададете -M, но дадете стойност на променливата от обкръжението MANPATH, тази стойност е списъка от директории, които man претърсва.

Ако не укажете явен път за търсене чрез -M или MANPATH, man съставя свой собствен списък от директории за търсене, базиран на съдържанието на конфигурационния файл /etc/man.conf. Директивите MANPATH в конфигурационния файл указват отделните директории, които да се включат в пътя за търсене.

Освен това MANPATH_MAP директивите добавят директории към пътя за търсене на страници в зависимост от пътя за търсене на команди, т.е. на променливата от обкръжението PATH. За всяка директория, която е в пътя за търсене на команди, MANPATH_MAP директивата указва директория, която да бъде добавена към пътя за търсене на страници. man взема стойността на променливата PATH и добавя съответните директории към пътя за търсене на страници. По този начин, при правилно използване на MANPATH_MAP, когато изпълните командата man xyz, ще получите страницата от ръководството за програмата, която би била стартирана, ако се изпълни командата xyz.

В допълнение, за всяка директория от пътя за търсене на команди ("командна директория"), за която липсва MANPATH_MAP директива, man автоматично търси директория за страници "наблизо", по-точно поддиректория на командната директория или на нейната родителска директория.

Търсенето на директории "наблизо" може да се изключи с директивата NOAUTOPATH в /etc/man.conf.

Във всяка от директориите, описани по-горе, man търси файл наречен име.секция, с незадължителен суфикс номера на секцията, и евентуално със суфикс за компресия. Ако не намери факъв файл, man търси във всички поддиректории, ако има такива, с имена manN или catN, където N е номера на секцията. Ако файла е в поддиректория catN, man приема, че това е файл с готова форматирана страница. В противен случай man приема че файла е неформатиран. И в двата случая, ако името на файла завършва с известен на man суфикс за компресия, например .gz, man приема, че файла е компресиран.

Ако искате да видите дали (или къде) man би намерил дадена страница от ръководството, използвайте опцията --path (-w).

ОБКРЪЖЕНИЕ

MANPATH
    Път за търсене на страници от ръководството. Тази променлива е с по-висок приоритет от конфигурационноя файл и автоматичния път за търсене, но с по-нисък от опцията -M. Вижте ПЪТ ЗА ТЪРСЕНЕ НА СТРАНИЦИ ОТ РЪКОВОДСТВОТО.

MANPL
    Дължина на страницата. По подразбиране цялата страница от ръководството заема една единствена (дълга) форматирана страница.

MANROFFSEQ
    Набор от команди за предварителна обработка, които да се стартират преди nroff или troff. По подразбиране, преди nroff страниците се обработват с tbl.

MANSECT
    Набор от секции на ръководството, в които да се търси.

MANWIDTH
    Ширина на страницата. По подразбиране се използва ширината на екрана.

MANPAGER
    Ако MANPAGER има стойност, тя се ползва като име на програма, с която страниците да се извеждат. В противен случай се ползва PAGER. Ако и тя няма стойност, ползва се /usr/bin/less-is.

LANG
    Поддиректория, в която man най-напред да търси страниците от ръководството. Така командата `LANG=bg man 1 foo' ще накара man да търси страницата за foo първо в .../bg/man1/foo.1, и ако не я намери там, в .../man1/foo.1 (... е директория от пътя за търсене).

NLSPATH, LC_MESSAGES, LANG
    Променливите от обкръжението NLSPATH и LC_MESSAGES (или LANG, ако LC_MESSAGES няма стойност) играят роля при търсенето на каталога със съобщения на man (английските съобщения са компилирани в самия man и не изискват каталог). Забележка: програми, викани служебно от man, например col(1), също използват LC_CTYPE.

PATH
    Помага да се състави пътя за търсене на страници от ръководството. Вижте ПЪТ ЗА ТЪРСЕНЕ НА СТРАНИЦИ ОТ РЪКОВОДСТВОТО.

SYSTEM
    Подразбиращо се имe на алтернативна система за опцията -m.

ВИЖТЕ СЪЩО
apropos(1), whatis(1), less(1), groff(1), man.conf(5).

ГРЕШКИ
Опцията -t работи само ако е инсталирана програмата troff или подобна.
Ако вместо знак за пренасяне на нов ред виждате (мигащо) \255 или <AD>, задайте в обкръжението `LESSCHARSET=latin1'.

ПОЛЕЗНИ СЪВЕТИ
Ако добавите реда
  (global-set-key [(f1)] (lambda () (interactive) (manual-entry (current-word)))) към вашия .emacs файл, натискането на F1 ще ви дава страница с помощ за библиотечната функция, на която е позициониран курсора.

За да получите чисто текстова версия на страница от ръководството, без обратни наклонени черти и подчертавания, пробвайте:
  # man foo | col -b > foo.mantxt