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

-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 використовує less, якщо less не знайдено або не є виконуваним файлом, тоді використовується 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

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