tldr: краткие шпаргалки вместо man

Страница man для tar занимает несколько экранов, а нужен обычно один пример. tldr решает именно эту задачу: короткая справка из пяти-десяти типовых команд, без истории, философии и перечисления всех ключей. Разберём, как поставить клиент, настроить автообновление и встроить шпаргалки в ежедневную работу, не отказываясь от man там, где нужна точность.

Что такое tldr и чем он не является

tldr — это проект сообщества с открытыми страницами в Markdown. Каждая страница описывает одну команду и содержит несколько примеров с пояснениями. Клиент скачивает набор страниц, кэширует его и показывает нужную справку в терминале. Страницы существуют для Linux, macOS, Windows и общих команд.

Это не замена man и не полная документация. tldr не описывает все ключи, коды возврата, переменные окружения и тонкости дистрибутива. Его задача — напомнить синтаксис, когда вы уже знаете, что делает команда, но забыли порядок аргументов. Для разбора нестандартного поведения всё равно открывайте man или --help конкретной версии.

Установка клиента

Клиентов несколько, и они используют общую базу страниц. В Debian, Ubuntu и Linux Mint есть пакет tldr — клиент на Python. tealdeer написан на Rust, работает заметно быстрее и умеет сам обновлять кэш. Выбирайте любой: синтаксис основных команд совпадает.

sudo apt install tldr
tldr --update
tldr --version
tldr tar

Первая команда ставит клиент, вторая загружает актуальную базу страниц, третья проверяет версию. Четвёртая показывает примеры для tar: создание архива, распаковку, просмотр содержимого. Если пакета в репозитории нет, tealdeer ставят через cargo install tealdeer или берут готовый бинарник с сайта проекта.

Как устроена страница

Внутри — заголовок с именем команды, короткое описание и список примеров. Строки с > объясняют назначение, строки с обратными кавычками содержат команду. Места, куда нужно подставить своё значение, подсвечены; в исходной странице они заключены в фигурные скобки. В терминале подсветка может отличаться, но структура одна.

Примеры идут от простого к сложному. Если нужен конкретный сценарий, ищите его по описанию, а не по флагам: авторы страниц группируют команды по задачам. Для составных случаев полезно сразу проверить найденный вариант через --help.

Платформы и переводы

tldr --platform linux ss
tldr --platform windows ipconfig
tldr --language ru tar

Одна и та же команда может иметь разные страницы для Linux, macOS и Windows. Флаг платформы выбирает нужный вариант, если клиент его поддерживает. Переводы существуют, но покрытие неравномерное: русской страницы может не быть, и клиент сообщит об ошибке. Уберите флаг языка, чтобы получить английский вариант; примеры команд обычно понятны и без перевода.

Настройка tealdeer

У tealdeer есть файл конфигурации в ~/.config/tealdeer/config.toml. В нём включают автоматическое обновление и меняют оформление. Не копируйте чужие конфиги целиком: лучше начать с двух-трёх параметров и добавлять остальные по мере надобности.

mkdir -p ~/.config/tealdeer
nano ~/.config/tealdeer/config.toml

[updates]
auto_update = true
auto_update_interval_hours = 720

[display]
compact = false

Интервал в 720 часов — это примерно месяц. Компактный режим убирает пустые строки и делает вывод короче, но на узком терминале лучше оставить обычный. Если конфиг содержит ошибку, клиент сообщит о ней при запуске; проверяйте синтаксис TOML после правок.

Кэш, офлайн и обновление

du -sh ~/.cache/tealdeer
tldr --clear-cache
tldr --update
tldr --list | head -20

Страницы лежат в кэше, поэтому работают без сети. Это удобно на сервере без выхода в интернет и в поездке. Первая команда показывает размер кэша, вторая очищает его, третья загружает заново, четвёртая выводит список доступных страниц. Если база не обновлялась месяц, примеры могут отставать от новой версии утилиты — обновляйте кэш перед разбором незнакомого синтаксиса.

• tldr --platform linux mount — монтирование и таблица разделов.
• tldr --platform linux journalctl — фильтры журнала и загрузки.
• tldr --platform linux ip — адреса, маршруты и интерфейсы.

Вместе с man и поиском

apropos copy
man 1 cp
cp --help
tldr --list | fzf --preview 'tldr {}'

Рабочий порядок такой: tldr помогает вспомнить пример, man даёт полное описание, --help показывает флаги именно установленной версии. apropos ищет по описаниям страниц, когда не известно имя команды. Связка с fzf превращает список страниц в интерактивный поиск с предпросмотром: удобно, когда нужно быстро найти утилиту по задаче.

Три сценария из практики

Первый сценарий — распаковка архива. Вы помните, что нужен tar, но не помните порядок ключей и каталог назначения. tldr tar показывает готовую строку, остаётся подставить имена. Второй — проверка портов: tldr ss напоминает про -tulpn, а man объясняет разницу между слушающими сокетами и установленными соединениями. Третий — служба systemd: шпаргалка освежает daemon-reload, status и journalctl -u, но не рассказывает про зависимости и таймеры.

Для поиска файлов и текста tldr fd и tldr rg дают минимальный синтаксис. Дальше уточняйте поведение через —help: именно установленная версия решает, какие флаги существуют. Такой порядок — шпаргалка, затем точная документация — быстрее, чем читать man с начала, и безопаснее, чем копировать команду из форума.

tldr tar
tldr ss
tldr systemctl
tldr --platform linux find

Держите под рукой пять-семь страниц для своих частых задач: архивы, сеть, службы, поиск, права доступа. Этого набора хватает большинству администраторов, а остальное находится через список и fzf.

Ограничения и безопасность

• Примеры не учитывают особенности вашего дистрибутива и версии пакета.
• Сложные сценарии с несколькими шагами в tldr не описываются.
• Переводы отстают от английских страниц и покрывают не всё.
• Команды с sudo, удалением файлов или изменением прав нужно читать до запуска, а не после.
• tldr не показывает коды возврата и побочные эффекты — для скриптов это важно.

Относитесь к странице как к подсказке коллеги, а не как к нормативному документу. Перед выполнением команды, которая меняет диски, права или сетевые настройки, сверьтесь с man и проверьте путь. Это занимает полминуты и спасает от неприятностей.

Итог

tldr — быстрый способ вспомнить синтаксис команды, не пролистывая многоэкранный man. Поставьте клиент, включите автообновление, держите кэш свежим и комбинируйте шпаргалку с полной документацией. Начните с установки и обновления базы, а тонкую настройку отложите до первых неудобств.