Man page - whatis(1)

Packages contains this manual

Available languages:

en fr pt_BR es it pl pt ko nl da tr sv ja uk id ru ro sr zh_CN de

Manual

WHATIS

ІМʼЯ
СИНОПСИС
ОПИС
ПАРАМЕТРИ
СТАТУС ВИХОДУ
СЕРЕДОВИЩЕ
ФАЙЛИ
ДИВ. ТАКОЖ
АВТОР
ПОМИЛКИ

ІМʼЯ

whatis - показати короткі описи сторінок довідки

СИНОПСИС

whatis [ -dlv?V ] [ -r | -w ] [ -s список ] [ -m система [,...]] [ -M шлях ] [ -L локаль ] [ -C файл ] імʼя ...

ОПИС

Кожна сторінка довідки має короткий опис, який доступний всередині неї. Команда whatis шукає назви сторінок довідки та показує описи тих сторінок довідки, які відповідають імені .

Імʼя може містити шаблони ( -w ) або бути регулярним виразом ( -r ). Використовуючи ці опції, можливо, потрібно буде процитувати імʼя або екранувати (\) спеціальні символи, щоб зупинити їх інтерпретацію оболонкою.

Індексні бази даних використовуються під час пошуку та оновлюються програмою mandb . Залежно від вашої інсталяції, це може бути запущено періодичною задачею cron або, можливо, потрібно вручну запустити її після встановлення нових сторінок довідки. Щоб створити старомодну текстову базу даних whatis з відносної індексної бази даних, виконайте команду:

whatis -M шляхи_до_man -w ’*’ | sort > manpath/whatis

де шляхи_до_man є ієрархією сторінок довідки, наприклад /usr/man .

ПАРАМЕТРИ

-d , --debug

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

-v , --verbose

Вивести деталізовані попереджувальні повідомлення.

-r , --regex

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

-w , --wildcard

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

-l , --long

Не обрізати вивід до ширини терміналу. Зазвичай, вивід буде обрізано до ширини терміналу для уникнення неприємних результатів від погано написаних розділів NAME .

-s список , --розділи= список , --розділ= список

Шукати тільки вказані розділи довідника. список - це список розділів, розділених комами або двокрапками. Якщо запис у списку є простим розділом, наприклад "3", то виведений список описів буде включати сторінки в розділах "3", "3perl", "3x" і т.д.; якщо ж запис у списку має розширення, наприклад "3perl", то список буде включати лише сторінки з точної частини розділу довідника.

-m система [,...], --systems= система [,...]

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

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

-M шлях , --manpath= шлях

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

-L локаль , --locale= локаль

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

-C файл , --config-file= файл

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

-? , --help

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

--usage

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

-V , --version

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

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

0

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

1

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

2

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

16

Нічого не знайдено, що б відповідало зазначеним критеріям.

СЕРЕДОВИЩЕ

SYSTEM

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

MANPATH

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

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

MANWIDTH

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

ФАЙЛИ

/usr/share/man/index.(bt|db|dir|pag)

Традиційний глобальний кеш індексу бази даних.

/var/cache/man/index.(bt|db|dir|pag)

Сумісний з FHS глобальний кеш індексу бази даних.

/usr/share/man/.../whatis

Традиційна текстова база даних whatis .

ДИВ. ТАКОЖ

apropos (1), man (1), mandb (8)

АВТОР

Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).

ПОМИЛКИ

https://gitlab.com/man-db/man-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db