tldr — хорошее дополнение к привычному для всех man’у. Очень выручает в ситуациях, когда для той или иной команды нужно получить конкретные примеры, без погружения в десятки опций и параметров.
Сами страницы пишутся и редактируются сообществом. Энтузиастами же представлено большое количество реализаций клиентов, для работы с базой страниц. Есть клиенты для go, node.js, python, ruby, haskel, perl, rust, есть возможность поставить программу на android и ios девайсы. В конце концов есть даже web клиент, который можно в том числе и развернуть у себя.
Разработчики, в первую очередь рекомендуют попробовать клиент для node.js, его можно оставить так:
npm install -g tldr
Однако, имеет смысл проверить репозитории установленной системы, скорее всего, там уже будет доступен нужный пакет, и останется только поставить его. Например, в моём случае, в Fedora (ставится python версия):
dnf install tldr
И пробуем получить информацию о команде ps, например. При первом запуске, утилита обновит свой локальный кеш и создаст индекс.
tldr ps
Page not found. Updating cache...
Creating index...
В будущем, с помощью опций -u и -c мы можем в любое время обновить кеш, либо очистить его.
Далее, при наличии информации о команде, мы получим справку по её применению.
В tldr доступен поиск по всем командам, что порой бывает очень удобным. Например, находим всё по запросу «kill process»:
tldr -s "kill process"
Searching for: kill process
$ kill
$ pkill
$ fkill
$ nohup
$ killall
$ tcpkill
$ ps
$ pstree
$ renice
$ odps-inst
Run tldr <command> to see specific pages.
С помощью дополнительных опций мы можем выбрать ОС, для которой будут отображаться команды, выбрать внешний вид, формат вывода, направить вывод в файл, отобразить список всех доступных страниц и т. д. Полный список доп возможностей можно получить по команде:
tldr -h
- Страница проекта;
- Веб-клиент проекта;
- Github проекта (посмотрите сколько там доступно клиентов для разных платформ).
Источник: https://sysadmin.pm/tldr/