Получение справки в терминале

Q: man: команда есть, страницы нет

Возможно встроенная команда bash — help cmd. Или пакет без man — пробуй --help, tldr, info, /usr/share/doc/.

Q: apropos/man -k: «nothing appropriate»

Не построен индекс. sudo mandb, затем повтори.

Q: Слишком длинный man, нужен один флаг

man cmd, затем /-X (поиск флага, n — следующее). Или cmd --help | grep -- -X.

Q: Не помню имя команды, помню задачу

apropos <тема> / man -k <тема> — поиск по описаниям всех страниц.

Q: Хочу справку по синтаксису bash (if/for/test)

Это встроенные конструкции оболочки: help if, help test, man bash (длинный, но полный).

3 мин Linux

Как быстро узнать ключи команды: man, --help, apropos и tldr; как читать страницу man.

Шпаргалка

7 команд Версия для печати

cmd --help быстрая справка
man cmd полное руководство
man 5 cmd конкретный раздел руководства
man -k тема поиск команды по теме (mandb, если пусто)
tldr cmd примеры (если есть)
type cmd что это: alias, функция, builtin, файл
help builtin справка по встроенным bash

Обзор

Не надо помнить все флаги — надо уметь быстро их находить.

bash

command --help                    # краткая справка (быстро, почти у всех команд)
man command                       # полное руководство (листать как less: /поиск, q выход)
tldr command                      # примеры из жизни (если установлен) — часто полезнее man

Рецепты

man

bash

man ls                            # руководство
man 5 crontab                     # раздел 5 (форматы файлов) — у имени бывает несколько разделов
man -f crontab                    # = whatis: какие разделы есть у имени
man -k password                   # поиск по описаниям (= apropos)
apropos network                   # команды, связанные с темой
whatis ls                         # однострочное описание
sudo mandb                        # пересобрать индекс man (после установки пакетов, если apropos пуст)

Разделы man: 1 команды, 2 syscalls, 3 библиотеки, 5 форматы файлов/ конфиги, 8 админские. man crontab (раздел 1, команда) ≠ man 5 crontab (формат файла).

Навигация внутри man (это less): /слово поиск, n/N след./пред., g/G в начало/конец, q выход.

Где ещё искать

bash

command -h                        # иногда вместо --help
cmd --help | less                 # длинную справку — листать
info command                      # GNU info (подробнее у coreutils)
type command                      # это alias, функция, builtin или файл? (см. which)
help if                           # справка по ВСТРОЕННЫМ bash (if, for, while, …)
tldr cmd ; cheat cmd              # примеры (отдельные пакеты)
zcat /usr/share/doc/PKG/*         # документация пакета (часто README/changelog)

Неполадки

man: команда есть, страницы нет

Возможно встроенная команда bash — help cmd. Или пакет без man — пробуй --help, tldr, info, /usr/share/doc/.

apropos/man -k: «nothing appropriate»

Не построен индекс. sudo mandb, затем повтори.

Слишком длинный man, нужен один флаг

man cmd, затем /-X (поиск флага, n — следующее). Или cmd --help | grep -- -X.

Не помню имя команды, помню задачу

apropos <тема> / man -k <тема> — поиск по описаниям всех страниц.

Хочу справку по синтаксису bash (if/for/test)

Это встроенные конструкции оболочки: help if, help test, man bash (длинный, но полный).

См. также

files-basics — Навигация и файлы — ls, cd, cp, mv, rm, cat, less, head, tail, копипаст в терминале.
grep — Поиск строк по шаблону; регулярки, рекурсия, контекст.

Есть неточность? Сообщить об ошибке в статье

Получение справки в терминале

Шпаргалка Наверх