MAN(1)

ІМʼЯ
man - інтерфейс до довідкових матеріалів системи

СИНОПСИС
man [параметри man] [[розділ] сторінка ...] ...
man -k [параметри apropos] регулярний вираз ...
man -K [параметри man] [розділ] термін ...
man -f [whatis параметри] сторінка ...
man -l [параметри man] файл ...
man -w|-W [параметри man] сторінка ...

ОПИС
man - це гортач системних сторінок довідки. Кожний аргумент сторінка, наданий man, зазвичай є іменем програми, утиліти або функції. Потім знаходиться та показується сторінка довідки, повʼязана з кожним з цих аргументів. Якщо вказано розділ, man буде шукати тільки у цьому розділі довідки. За замовчуванням програма шукає у всіх доступних розділах за певним попередньо визначеним порядком (дивіться ЗА ЗАМОВЧУВАННЯМ) та показує лише першу знайдену сторінку, навіть якщо сторінка існує у декількох розділах.

У таблиці нижче наведено номери розділів довідника, за якими слідують типи сторінок, які вони містять.

1 | Виконувані програми або команди оболонки
2 | Системні виклики (функції, надані ядром)
3 | Виклики бібліотек (функції всередині програмних бібліотек)
4 | Спеціальні файли (зазвичай знаходяться в /dev/)
5 | Формати файлів та узгодження, напр. /etc/passwd
6 | Ігри
7 | Різне (включно з макропакетами та узгодженнями), напр. man(7), groff(7), man-pages(7)
8 | Команди системного адміністрування (зазвичай лише для root)
9 | Процедури ядра [Не стандартні]

Сторінка довідника складається з декількох розділів.

Типові назви розділів включають NAME, SYNOPSIS, CONFIGURATION, DESCRIPTION, OPTIONS, EXIT STATUS, RETURN VALUE, ERRORS, ENVIRONMENT, FILES, VERSIONS, STANDARDS, NOTES, BUGS, EXAMPLE, AUTHORS, і SEE ALSO.

Наступні правила застосовуються до розділу СИНОПСИС та можуть бути використані як посібник у інших розділах.

жирний текст | введіть точно так, як показано.
текст курсивом | замініть відповідним аргументом.
[-abc] | будь-які або всі аргументи всередині [ ] є необовʼязковими.
-a|-b | опції, розділені символом '|', не можуть використовуватися разом.
аргумент ... | аргумент можна повторювати.
[вираз] ... | весь вираз expression всередині [ ] може повторюватися.

Точність відображення може відрізнятися залежно від кінцевого пристрою. Наприклад, команда man зазвичай не зможе показати курсив у терміналі та часто використовує підкреслений або кольоровий текст замість цього.

Ілюстрація команди або функції є шаблоном, який повинен відповідати всім можливим викликам. У деяких випадках бажано ілюструвати кілька виключних викликів, як це показано у розділі СИНОПСИС цієї сторінки довідника.

ПРИКЛАДИ

man ls
    Показати сторінку довідки для елементу (програми) ls.

man man.7
    Показати сторінку довідки для макропакету man з розділу 7. (Це альтернативне написання «man 7 man».)

man 'man(7)'
    Показати сторінку довідки для макропакету man з розділу 7. (Це інший варіант написання "man 7 man". Це може бути зручніше при копіюванні та вставці посилань на сторінки довідки. Зверніть увагу, що дужки зазвичай повинні бути в лапках, щоб захистити їх від оболонки.)

man -a intro
    Послідовно показувати всі доступні сторінки керівництва intro. Можна вийти між показами або пропустити будь-який з них.

man -t bash | lpr -Pps
    Сформувати сторінку довідки для bash у форматі за замовчуванням troff або groff та передати її принтеру з назвою ps. За замовчуванням вихідні дані для groff - це зазвичай PostScript. man --help повинно порадити, який процесор повʼязаний з опцією -t.

man -l -Tdvi ./foo.1x.gz > ./foo.1x.dvi
    Ця команда розпакує та сформує джерело сторінки керівництва nroff ./foo.1x.gz у файл незалежний від пристрою (dvi) файл. Перенаправлення необхідне, оскільки прапорець -T призводить до виведення результату в stdout без використання гортача. Результат можна переглянути за допомогою програми, такої як xdvi, або далі обробити у PostScript за допомогою програми, такої як dvips.

man -k printf
    Шукає короткі описи та назви сторінок довідки за ключовим словом printf, використовуючи його як регулярний вираз. Надрукує будь-які збіги. Еквівалентно apropos printf.

man -f smail
    Знайти сторінки довідника, на які посилається smail, і надрукувати короткі описи знайдених. Еквівалентно whatis smail.

ОГЛЯД
Доступно багато опцій для man, щоб надати користувачеві максимальну гнучкість. Можна змінювати шлях пошуку, порядок розділів, обробник виводу та інші операції та поведінки, про які детальніше описано нижче.

Якщо встановлено, перевіряються різні змінні середовища для визначення роботи %man. Можливо встановити "загальну" змінну $MANOPT до будь-якого рядка у форматі командного рядка, за винятком того, що пробіли, використовувані як частина аргументу опції, повинні бути екрановані (зворотньою похилою рискою). man розбере $MANOPT перед тим, як розбирати власний командний рядок. Опції, що вимагають аргументів, будуть перезаписані такими ж опціями, знайденими у командному рядку. Для скидання всіх опцій, встановлених у $MANOPT, -D можна вказати як першу опцію командного рядка. Це дозволить man «забути» про опції, зазначені у $MANOPT, хоча вони все ще повинні були бути дійсними.

Сторінки довідки зазвичай зберігаються у форматі nroff(1) в каталозі, такі як /usr/share/man. У деяких інсталяціях також можуть бути попередньо відформатовані сторінки cat, щоб покращити продуктивність. Дізнайтеся більше у manpath(5) про подробиці того, де зберігаються ці файли.

Цей пакет підтримує сторінки довідки на декількох мовах, керовані вашою локаллю. Якщо ваша система не встановила це для вас автоматично, тоді вам може знадобитися встановити змінну середовища $LC_MESSAGES, $LANG або іншу системно-залежну змінну середовища для позначення вашої бажаної локалі, зазвичай вказаної у форматі POSIX:

<мова>[_<територія>[.<кодування>[,<версія>]]]

Якщо бажана сторінка доступна вашою мовою у ваші локалі, вона буде показана замість стандартної сторінки (зазвичай англійської).

Якщо ви знайдете, що переклади, що постачаються з цим пакетом, недоступні вашою рідною мовою але ви хотіли б їх надати нам, будь ласка, звʼяжіться з відповідальним за таку діяльність.

Індивідуальні сторінки довідки зазвичай пишуть і підтримують ті, хто відповідає за програму, функцію або іншу тему, яку вони документують, і не включені до цього пакета. Якщо ви знайдете, що сторінка довідки відсутня або недостатньо повна, будь ласка, повідомте про це розробників відповідного пакета.

Для отримання інформації про інші функції та розширення, доступні з цим гортачем посібників, будь ласка, прочитайте документи, що постачаються з пакетом.

ЗА ЗАМОВЧУВАННЯМ
Порядок розділів для пошуку може бути перевизначений змінною середовища $MANSECT або директивою SECTION у файлі конфігурації /etc/manpath.config. За замовчуванням це виглядає так:

    1 n l 8 3 0 2 3type 3posix 3pm 3perl 3am 5 4 9 6 7

Форматована сторінка довідки показується за допомогою гортача (pager). Це можна вказати різними способами, або ж буде використовуватися значення за замовчуванням (дивіться подробиці для опції -P ).

Фільтри розшифровуються різними способами. По-перше, перевіряється опція командного рядка -p або змінна середовища $MANROFFSEQ. Якщо -p не використовувалася і змінна середовища не встановлена, перший рядок файлу nroff аналізується на наявність рядка препроцесора. Для того, щоб містити дійсний рядок препроцесора, перший рядок повинен бути схожим

'е" <рядок>

де рядок може бути будь-якою комбінацією літер, описаних опцією -p нижче.

Якщо жоден з вищезгаданих методів не надає інформації про фільтр, використовується набір за замовчуванням.

Створюється конвеєр форматування з фільтрів та основного форматувальника (nroff або [tg]roff з -t) і виконується. Або, якщо в корені дерева man існує виконуваний програмний файл mandb_nfmt (або mandb_tfmt з -t), то замість цього виконується він. Він отримує файл джерела документації, рядок препроцесора та необовʼязково пристрій, вказаний з -T або -E, як аргументи.

ПАРАМЕТРИ
Опції без аргумента, які дублюються або в командному рядку, або в $MANOPT, не завдають шкоди. Для опцій, що вимагають аргумента, кожне повторення перезаписує попереднє значення аргумента.

  Загальні параметри

-C файл, --config-file=файл
    Використовуйте цей користувацький файл конфігурації замість типового у ~/.manpath).

-d, --debug
    Вивести інформацію для налагодження.

-D, --default
    Ця опція зазвичай видається як перша і скидає поведінку man до її стандартних налаштувань. Її використання полягає в тому, щоб скинути ті опції, які могли бути встановлені в $MANOPT. Будь-які опції, які йдуть після -D, збережуть свою звичайну дію.

--warnings[=попередження]
    Увімкнути попередження від groff. Це може використовуватися для перевірки коректності тексту джерела сторінок довідки. попередження - це список імен попереджень, розділених комами; якщо він не вказаний, за замовчуванням використовується "mac". Щоб вимкнути попередження groff, попереду його назви потрібно поставити "!": наприклад, --warnings=mac,!break увімкне попередження в категорії "mac" і вимкне попередження в категорії "break". Для перегляду списку доступних імен попереджень див. розділ «Попередження» у info groff.

  Основні режими роботи

-f, --whatis
    Приблизно еквівалентно whatis. Виводить короткий опис з сторінки довідки, якщо він доступний. Подробиці у whatis(1).

-k, --apropos
    Приблизно еквівалентно команді apropos. Пошук коротких описів сторінок довідки за ключовими словами та показ будь-яких збігів. Дивіться подробиці у apropos(1).

-K, --global-apropos
    Пошук тексту у всіх сторінках довідки. Це метод грубої сили, і це може зайняти деякий час; якщо можливо, ви повинні вказати розділ, щоб зменшити кількість сторінок, які необхідно переглядати. Пошукові терміни можуть бути простими рядками (за замовчуванням), або регулярними виразами, якщо використовується опція --regex.

    Зверніть увагу, що цей пошук виконується в джерелах сторінок довідки, а не у відформатованому тексті, тому може включати хибні позитивні результати через такі речі, як коментарі в файлах джерел, або хибні негативні результати через такі речі, як тире, записані як "\-" у файлах джерел. Пошук відформатованого тексту був би набагато повільнішим.

-l, --local-file
    Активувати «локальний» режим. Форматувати та показувати локальні файли довідки замість пошуку у колекції системної довідки. Кожен аргумент сторінки довідки буде інтерпретований як джерело nroff у правильному форматі. Не створюється файл cat. Якщо '-' вказано одним з аргументів, вхідні дані будуть братися зі stdin.

    Якщо цей параметр не використовується, тоді man також буде вважати аргументи сторінок довідки локальними іменами файлів, якщо аргумент містить символ "/", оскільки це є хорошим індикатором того, що аргумент посилається на шлях у файловій системі.

-w, --where, --path, --location
    Не показувати сторінку довідки, а лише надрукувати розташування вихідного файлу nroff, який би був сформований. Якщо також використовується опція -a, тоді надрукувати розташування всіх вихідних файлів, які відповідають критеріям пошуку.

-W, --where-cat, --location-cat
    Не показувати сторінку довідки, а лише надрукувати розташування файлу категорії, який би був показаний. Якщо також використовується опція -a, тоді надрукувати розташування всіх відформатованих файлів категорій, які відповідають критеріям пошуку.

    Якщо використовуються обидва параметри -w та -W, то друкувати як джерело файлу, так і файл каталогу, розділені пробілом. Якщо використовуються всі три параметри -w, -W, та -a, то робити це для кожного можливого збігу.

-c, --catman
    Ця опція не призначена для загального використання і повинна використовуватися лише програмою catman.

-R кодування,  --recode=кодування
    Замість того, щоб форматувати сторінку довідки за звичайним способом, виведе її джерело, перекодоване у вказане кодування. Якщо ви вже знаєте кодування файлу джерела, ви також можете використовувати manconv(1) безпосередньо. Однак ця опція дозволяє перекодувати кілька сторінок довідки у одне кодування без необхідності явно вказати кодування кожного, при умові, що вони були вже встановлені в структурі, схожій на ієрархію сторінок довідки.

    Розгляньте використання man-recode(1) для перекодування декількох сторінок довідки, оскільки воно має інтерфейс, розрахований на масове перекодування, і тому може бути значно швидшим.

  Пошук сторінок довідки

-L локаль, --locale=локаль
    Зазвичай програма man визначатиме вашу поточний локаль шляхом виклику функції Сі setlocale(3), яка досліджує різні змінні середовища, можливо, включаючи $LC_MESSAGES та $LANG. Щоб тимчасово перекрити визначене значення, скористайтеся цією опцією для безпосереднього надання рядка локалі програмі man. Зверніть увагу, що вона не почне діяти до тих пір, поки фактично не почнеться пошук сторінок. Виводи такого типу, як повідомлення про допомогу, завжди будуть показуватися у попередньо визначеній локалі.

-m система[,...], --systems=система[,...]
    Якщо ця система має доступ до сторінок довідки інших операційних систем, вони можуть бути доступні за допомогою цієї опції. Для пошуку сторінки довідки з колекції сторінок довідки NewOS використовуйте опцію -m NewOS.

    Вказана система може бути комбінацією операційних систем, перелічених через кому. Для включення пошуку в керівництвах власної операційної системи, включіть імʼя системної команди man у рядок аргументів. Ця опція перевизначить змінну середовища $SYSTEM.

-M шлях, --manpath=шлях
    Вкажіть альтернативний manpath для використання. За замовчуванням, man використовує код, похідний від manpath, щоб визначити шлях для пошуку. Ця опція перевизначає змінну середовища $MANPATH і призводить до того, що опція -m буде проігнорована.

    Шлях, вказаний як manpath, повинен бути коренем ієрархії сторінок довідки, структурованої у розділи, як описано в керівництві man-db (під розділом «Система сторінок довідки»). Щоб переглянути сторінки довідки поза такими ієрархіями, дивіться опцію -l.

-S список, -s список, --sections=список
    Заданий список є списком розділених комами або двокрапками секцій, який використовується для визначення порядку пошуку та в яких саме розділах довідки. Ця опція перевизначає змінну середовища $MANSECT. (Варіант -s забезпечує сумісність з System V.)

-e під-розширення, --extension=під-розширення
    Деякі системи включають великі пакети сторінок довідки, такі як ті, що супроводжують пакет Tcl, у головну ієрархію сторінок довідки. Щоб обійти проблему наявності двох сторінок довідки з однаковою назвою, такою як exit(3), сторінки Tcl зазвичай були призначені для розділу l. Оскільки це небажано, тепер можливо розмістити сторінки у правильному розділі та присвоїти їм конкретне "розширення", наприклад, exit(3tcl). За звичайних умов man показує exit(3) замість exit(3tcl). Щоб уникнути необхідності знати, в якому розділі знаходиться потрібна сторінка довідки, тепер можливо надати man рядок під-розширень, який вказує, до якого пакету повинна належати сторінка. Використовуючи вищезазначений приклад, надання опції -e tcl до man обмежить пошук сторінок з розширенням *tcl.

-i, --ignore-case
    Ігнорувати регістр при пошуку сторінок довідки. Це значення за замовчуванням.

-I, --match-case
    Шукати сторінки довідки з урахуванням регістру.

--regex
    Показати всі сторінки, у яких будь-яка частина їхніх імен або описів відповідає кожному аргументу сторінка як регулярному виразу, як це робиться з apropos(1). Оскільки зазвичай немає розумного способу вибрати «кращу» сторінку при пошуку за регулярним виразом, ця опція передбачає -a.

--wildcard
    Показати всі сторінки, у яких будь-яка частина їхніх назв або описів відповідає кожному аргументу сторінка, використовуючи шаблони командного рядка, як у apropos(1) з опцією --wildcard. Аргумент сторінка повинен повністю відповідати назві або опису, або відповідати у межах слів у описі. Оскільки зазвичай немає розумного способу вибрати "кращу" сторінку при пошуку за шаблоном, ця опція передбачає -a.

--names-only
    Якщо використовуються опції --regex або --wildcard, то шукається збіг тільки за назвами сторінок, а не їх описами, як це робиться в whatis(1). В іншому випадку, ефекту немає.

-a, --all
    За замовчуванням, man завершиться після показу найпридатнішої сторінки довідника. Використання цієї опції змусить man показати всі сторінки довідників, імена яких відповідають критеріям пошуку.

-u, --update
    Ця опція призводить до оновлення кешів бази даних man, які містять встановлені сторінки довідки. Це потрібно лише у рідкісних ситуаціях, і зазвичай краще запускати mandb(8) натомість.

--no-subpages
    За замовчуванням, man намагається інтерпретувати пари імен сторінок довідки, вказаних у командному рядку, як еквівалент однієї сторінки довідки з дефісом або підкресленням. Це підтримує поширений шаблон програм, які реалізують кілька підкоманд, дозволяючи їм надавати сторінки довідки для кожної з них, доступ до яких можна отримати за допомогою синтаксису, схожого на використання при виклику самих підкоманд. Наприклад:

      $ man -aw git diff
      /usr/share/man/man1/git-diff.1.gz

    Щоб вимкнути цю поведінку, використовуйте опцію --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

  Керування форматованим виведенням

-P гортач, --pager=гортач
    Вкажіть програму, гортача виводу. За замовчуванням, man використовує pager, якщо pager не знайдено або не є виконуваним файлом, тоді використовується cat. Ця опція перевизначає змінну середовища $MANPAGER, яка в свою чергу перевизначає змінну середовища $PAGER. Вона не використовується разом з -f або -k.

    Значенням може бути просте імʼя команди або команда з аргументами, які можуть використовувати цитування для оболонки (зворотні похилі риски, одинарні або подвійні лапки). Вона не може використовувати канали для підключення декількох команд; якщо вам потрібно це, використовуйте обгортковий скрипт, який може приймати файл для показу або на стандартному вводі.

-r запрошення, --prompt=запрошення
    Якщо недавня версію less використовується як гортач сторінок, man намагатиметься встановити його рядок запрошення і декілька розумних опцій. За замовчуванням запрошення виглядає так

    Сторінки довідника назва(розділ) рядок x

    де імʼя позначає назву сторінки довідника, розділ - розділ, де вона була знайдена, а x - поточний номер рядка. Це досягається за допомогою змінної середовища $LESS.

    При вказанні -r з рядком, буде перевизначено це значення за замовчуванням. Рядок може містити текст $MAN_PN, який буде розширений до імені поточної сторінки керівництва та її назви розділу, оточених «(» і «)». Рядок, який використовується для створення замовчування, може бути виражений як

    \ Сторінка\ довідки\ $MAN_PN\ ?ltрядок\ %lt?L/%L.:
    байт\ %bB?s/%s..?\ (КІНЕЦЬ):?pB\ %pB\\%..
    (натисніть h для довідки або q, щоб вийти)

    Це розбито на три рядки для зручності читання. Для значення дивіться сторінку довідки less(1). Рядок запрошення спочатку оцінюється оболонкою. Усі подвійні лапки, зворотні апострофи та зворотні похилі риски у запрошенні повинні бути екрановані зворотною похилою рискою. Рядок запрошення може закінчуватися екранованим знаком $, який може бути продовжений іншими опціями для less. За замовчуванням man встановлює опції -ix8.

    Змінна середовища $MANLESS, описана нижче, може бути використана для встановлення рядка запрошення за умовчанням, якщо в командному рядку не вказано жодного.

-7, --ascii
    При перегляді чистого сторінки довідки ascii(7) на 7-бітовому терміналі або емуляторі терміналу, деякі символи можуть показуватися неправильно при використанні опису пристрою latin1(7) з GNU nroff. Ця опція дозволяє показувати чисто ascii сторінки довідки в ascii з використанням пристрою latin1. Вона не перекодує будь-який текст latin1. Наступна таблиця показує виконувані перекодування: деякі частини можуть показуватися правильно тільки при використанні пристрою latin1(7) GNU nroff.

    Опис | Вісімкове | latin1 | ascii
    продовжувальне тире | 255 |  | -
    точка (середня точка) | 267 | • | o
    гострий акцент | 264 | ´ | '
    знак множення | 327 | × | x

    Якщо стовпець latin1 показується коректно, ваш термінал може бути налаштований для символів latin1, і ця опція не потрібна. Якщо стовпці latin1 та ascii ідентичні, ви читаєте цю сторінку з використанням цієї опції або man не сформував цю сторінку за допомогою опису пристрою latin1. Якщо стовпець latin1 відсутній або пошкоджений, можливо, вам потрібно переглядати сторінки довідника з цією опцією.

    Ця опція ігнорується при використанні опцій -t, -H, -T, або -Z і може бути непридатною для інших nroff, крім GNU.

-E кодування, --encoding=кодування
    Створити вивід для кодування символів, яке не є за замовчуванням. Для забезпечення сумісності з попередніми версіями, кодування може бути пристроєм nroff, таким як ascii, latin1, або utf8, а також справжнім кодуванням символів, таким як UTF-8.

--no-hyphenation, --nh
    Зазвичай nroff автоматично переносить текст на нові рядки навіть у словах, які не містять дефісів, якщо це необхідно для розміщення слів у рядку без надмірного простору. Ця опція вимикає автоматичні переноси слів, тому слова будуть переноситися тільки коли вони вже містять дефіси.

    Якщо ви пишете сторінку довідки та просто хочете запобігти переносу слова в небажаному місці у nroff, не використовуйте цю опцію, а зверніться до документації nroff; наприклад, ви можете поставити «\%» всередині слова, щоб вказати, що воно може бути розбито в тому місці, або поставити «\%» на початку слова, щоб запобігти його переносу.

--no-justification, --nj
    Зазвичай, nroff автоматично вирівнює текст до обох країв. Ця опція вимикає повне вирівнювання, залишаючи вирівнювання тільки до лівого краю, що іноді називається «вирівнюванням вліво».

    Якщо ви пишете сторінку довідки та просто хочете запобігти вирівнюванню певних абзаців у nroff, не використовуйте цю опцію, а зверніться до документації nroff; наприклад, ви можете використовувати запити ".na", ".nf", ".fi" та ".ad", щоб тимчасово вимкнути вирівнювання та заповнення.

-p рядок, --preprocessor=рядок
    Вкажіть послідовність препроцесорів, які потрібно запустити перед nroff або troff/groff. Не всі інсталяції мають повний набір препроцесорів. Деякі з препроцесорів та літери, що використовуються для їх позначення: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Ця опція перевизначає змінну середовища $MANROFFSEQ. zsoelim завжди запускається як перший препроцесор.

-t, --troff
    Використовуйте groff -mandoc, щоб сформатувати сторінку довідки і вивести до stdout. Ця опція не потрібна разом з -H, -T або -Z.

-T[пристрій], --troff-device[=пристрій]
    Ця опція використовується для зміни виводу groff (або, можливо, troff) так, щоб він був підходив для пристрою, відмінного від пристрою за замовчуванням. Вона передбачає -t. Приклади включають dvi, latin1, pdf, ps, utf8, X75 та X100.

-H[переглядач], --html[=переглядач]
    Ця опція призведе до того, що groff вироблятиме HTML-вивід, і показуватиме цей вивід у веб-переглядачі. Вибір переглядача визначається необовʼязковим аргументом переглядач, якщо він наданий, змінною середовища $BROWSER, або зі значення за замовчуванням під час компіляції, якщо воно не встановлене (зазвичай це lynx). Ця опція передбачає -t, і працюватиме тільки з GNU troff.

-X[dpi], --gxditview[=dpi]
    Ця опція показує вивід програми groff у графічному вікні за допомогою програми gxditview. Кількість точок на дюйм (dpi) може бути 75, 75-12, 100 або 100-12, за замовчуванням встановлюється значення 75; варіанти з -12 використовують базовий шрифт розміром 12 пунктів. Ця опція передбачає -T з відповідним пристроєм X75, X75-12, X100 або X100-12.

-Z, --ditroff
    groff запустить troff і потім використає відповідний пост-процесор для створення вихідного файлу, придатного для обраного пристрою. Якщо groff -mandoc є groff, то цей параметр передається до groff і пригнічує використання пост-процесора. Він підтверджує -t.

  Отримання допомоги

-?, --help
    Надрукувати повідомлення довідки та вийти.

--usage
    Надрукувати коротке повідомлення про використання та вийти.

-V, --version
    Показати інформацію про версію.

СТАТУС ВИХОДУ

0   Успішне виконання програми.

1   Помилка використання, синтаксису або файлу конфігурації.

2   Операційна помилка.

3   Дочірній процес повернув статус виходу, відмінний від нуля.

16  Принаймні одна з сторінок/файлів/ключових слів не існувала або не була знайдена.

СЕРЕДОВИЩЕ

MANPATH
    Якщо встановлено змінну $MANPATH, її значення використовується як шлях для пошуку сторінок довідки.

    Дивіться розділ ШЛЯХ ПОШУКУ у manpath(5) щодо поведінки за замовчуванням і подробиць того, як обробляється ця змінна середовища.

MANROFFOPT
    Кожного разу, коли man викликає форматувальник (nroff, troff, або groff), він додає вміст $MANROFFOPT до командного рядка форматувальника.

    Наприклад, MANROFFOPT=-P-i вказує форматувальнику використовувати курсивний текст (який підтримується лише деякими терміналами) замість підкресленого.

MANROFFSEQ
    Якщо встановлено змінну $MANROFFSEQ, її значення використовується для визначення набору препроцесорів, через які проходить кожна сторінка довідки. Список препроцесорів за замовчуванням залежить від системи.

MANSECT
    Якщо встановлено $MANSECT, його значення є списком розділів, розділених двокрапками, і використовується для визначення, які розділи довідки потрібно шукати та в якому порядку. За замовчуванням це «1 n l 8 3 0 2 3type 3posix 3pm 3perl 3am 5 4 9 6 7», якщо не перевизначено директивою SECTION у файлі /etc/manpath.config.

MANPAGER, PAGER
    Якщо встановлено $MANPAGER або $PAGER (переважно використовується $MANPAGER), його значення використовується як назва програми для показу сторінки довідника (гортач). За замовчуванням використовується pager, а якщо pager не знайдено або він не є виконуваним, то використовується cat.

    Значенням може бути просте імʼя команди або команда з аргументами, які можуть використовувати цитування для оболонки (зворотні похилі риски, одинарні або подвійні лапки). Вона не може використовувати канали для підключення декількох команд; якщо вам потрібно це, використовуйте обгортковий скрипт, який може приймати файл для показу або на стандартному вводі.

MANLESS
    Якщо встановлено змінну середовища $MANLESS, її значення буде використовуватися як рядок запрошення за замовчуванням для переглядача less, так само, ніби вона була передана з допомогою опції -r (тому будь-які входження тексту $MAN_PN буде розширено таким же чином). Наприклад, якщо ви хочете однозначно встановити рядок запиту на «my prompt string», встановіть змінну середовища $MANLESS у значення ‘-Psmy prompt string’. Використання опції -r перевизначає цю змінну середовища.

BROWSER
    Якщо встановлено змінну $BROWSER, її значення є списком команд, розділених двокрапками. Кожна з цих команд використовується для спроби запустити веб-переглядач для man --html. У кожній команді %s замінюється на імʼя файлу, що містить HTML вивід з groff, %% замінюється на одинарний знак відсотка (%), а %c - на двокрапку (:).

SYSTEM
    Якщо встановлено $SYSTEM, це матиме такий же ефект, як і якби вона була зазначена як аргумент для опції -m.

MANOPT
    Якщо встановлено змінну середовища $MANOPT, вона буде оброблена перед командним рядком man і очікується, що матиме схожий формат. Оскільки всі інші специфічні для man змінні середовища можуть бути виражені як параметри командного рядка, і тому є кандидатами на включення до $MANOPT, очікується, що вони стануть застарілими. Зверніть увагу, що всі пробіли, які повинні бути інтерпретовані як частина аргументу параметра, повинні бути екрановані.

MANWIDTH
    Якщо встановлено $MANWIDTH, його значення використовується як довжина рядка для форматування сторінок довідки. Якщо воно не встановлено, сторінки довідки будуть відформатовані з довжиною рядка, що відповідає поточному терміналу (використовуючи значення $COLUMNS, і ioctl(2), якщо вони доступні, або за умовчанням використовується 80 символів, якщо жоден з них недоступний). Сторінки cat будуть збережені лише тоді, коли можливе використання форматування за умовчанням, тобто коли довжина рядка терміналу знаходиться між 66 і 80 символами.

MAN_KEEP_FORMATTING
    Зазвичай, коли вивід не спрямовується на термінал (наприклад, у файл або трубу), символи форматування відкидаються для зручнішого читання результату без спеціальних інструментів. Однак, якщо $MAN_KEEP_FORMATTING встановлено в будь-яке непорожнє значення, ці символи форматування зберігаються. Це може бути корисним для обгортки навколо man, яка вміє інтерпретувати символи форматування.

MAN_KEEP_STDERR
    Зазвичай, коли вивід спрямовується до терміналу (зазвичай до гортача), будь-який помилковий вивід з команди, яка використовується для створення форматованих версій сторінок довідки, відкидається, щоб уникнути втручання в показ гортача . Програми, такі як groff, часто виробляють незначні повідомлення про помилки стосовно типографічних проблем, таких як погане вирівнювання, які виглядають непривабливо і зазвичай плутають, коли вони показуються разом зі сторінкою довідки. Однак деяким користувачам все одно хочеться їх побачити, тому якщо $MAN_KEEP_STDERR встановлено на будь-яке непорожнє значення, вивід помилок буде показуватися звичайним чином.

MAN_DISABLE_SECCOMP
    На Linux, man зазвичай обмежує підпроцеси, які обробляють ненадійні дані, використовуючи пісочницю seccomp(2). Це робить безпечнішим запуск складного коду аналізу довільних сторінок довідки. Якщо це станеться через якусь причину, не повʼязану з вмістом показаної сторінки, ви можете встановити $MAN_DISABLE_SECCOMP у будь-яке непорожнє значення, щоб вимкнути пісочницю.

PIPELINE_DEBUG
    Якщо змінна середовища $PIPELINE_DEBUG встановлена у "1", тоді man виведе повідомлення про налагодження до стандартного виводу для помилок, описуючи кожен підпроцес, який він запускає.

LANG, LC_MESSAGES
    Залежно від системи та реалізації, буде перевірено як $LANG, так і $LC_MESSAGES для поточної мови повідомлень. man показуватиме свої повідомлення в цій мові (якщо доступна). Див. setlocale(3).

ФАЙЛИ

/etc/manpath.config
    конфігураційний файл man-db.

/usr/share/man
    Глобальна ієрархія сторінок довідки.

СТАНДАРТИ
POSIX.1-2001, POSIX.1-2008, POSIX.1-2017.

ДИВ. ТАКОЖ
apropos(1), groff(1), less(1), manpath(1), nroff(1), troff(1), whatis(1), zsoelim(1), manpath(5), man(7), catman(8), mandb(8)

Документація для деяких пакетів може бути доступна в інших форматах, таких як info(1) або HTML.

ІСТОРІЯ
1990, 1991 – Оригінально написано Джоном В. Ейтоном (jwe@che.utexas.edu).

23 грудня 1992 року: Рік Фейт (faith@cs.unc.edu) застосував виправлення помилок, надані Willem Kasdorp (wkasdo@nikhefk.nikef.nl).

30-го квітня 1994 – 23-го Лютого 2000: Wilf. (G.Wilford@ee.surrey.ac.uk) розвивав і підтримував цей пакет з допомогою декількох присвячених цьому людей.

30го жовтня 1996 – 30го березня 2001: Fabrizio Polacco <fpolacco@debian.org> підтримував і покращував цей пакет для проекту Debian, з допомогою всієї спільноти.

31го березня 2001 – сьогодення: Colin Watson <cjwatson@debian.org> тепер розробляє і підтримує man-db.

ПОМИЛКИ
https://gitlab.com/man-db/man-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db