TLDR как лаконичный man.

Всем привет.

Все мы любим читать --help и man. Несмотря на появление многочисленных форумов, Stack Exchange и прочих ресурсов, хорошим тоном в начале решения своих проблем по-прежнему остаётся самостоятельный поиск ответа в официальной документации. На этих ресурсах вам скорее всего об этом сразу напомнят, ну есть такие гуру которые любят посылать новичков в гугл. Однако профессиональная лень продолжает двигать прогресс даже там, где не всегда того ожидаешь. Впрочем, это не только лень, бывают случаи когда вы банально ограничены во времени на поиск ответа.

И так оказалось, что классический man устраивает не всех. Меня, например, тоже его многостраничные просторы не радуют. Поэтому то и появился проект tldr, который, следуя своей расшифровке «Too Long; Didn't Read», решил принести в консоль лаконичный вид, и дать ищущему  самое главное. 

Авторы tldr описывают своё детище как «коллекцию упрощённых и создаваемых сообществом man-страниц». Главным продуктом их деятельности является собственно библиотека из markdown-файлов, являющихся альтернативными справочными страницами для популярных консольных утилит. Основная их часть относится к категориям «общие» и «Linux», однако есть также отдельные страницы для macOS и даже Windows.

Что хранится в этих страницах? В качестве примера в GitHub проекта демонстрируется tldr-справка по tar:

Как видно, это минимальное описание назначения утилиты и компактный список из самых частых команд. Для tar приводится 7 готовых команд, для ls - 6, для top - 5.

Ставится он весьма просто:

sudo snap install tldr

Этой командой в систему устанавливается тот самый Node.js-клиент tldr. Посмотрим список доступных страниц:

$ tldr -l                                                                                                                                                            Local cache is empty

Please run tldr --update

Их локально ещё нет, но дело поправимое:

$ tldr --update

Прямо в README проекта tldr приводятся и альтернативные варианты, решающие ту же задачу - «упрощения» man-страниц:

Cheat - написанная на Python утилита (имеет и реализации на Bash, а также web-сервис), поддерживает более 180 страниц;

eg - ещё один аналог на Python, который обладает гораздо меньшей библиотекой и реже обновляется;

bropages - web-проект, где сообщество пополняет в онлайне базу лаконичных примеров использования консольных команд.

Глядя на имеющиеся альтернативы, очевидно, что tldr удалось далеко уйти вперёд своих конкурентов. Разве что в случае с Cheat мне он понравился как web-сервис. Так что если потребность в подобном сервисе есть - однозначно стоит обратить на это свое внимание.

Успехов.