linux-labs

Вики / Базовые команды

Справка (man, --help, tldr)

Концепция Linux Базовое

Как быстро узнать опции команды — man, --help, apropos, tldr.

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

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

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 (длинный, но полный).

cmd --help                        # быстрая справка
man cmd ; man 5 cmd               # руководство (раздел)
man -k тема ; apropos тема         # поиск команды по теме (mandb если пусто)
tldr cmd                          # примеры (если есть)
type cmd ; help builtin           # что это / справка по встроенным bash

См. также