TLDR — легкий способ понять справочные страницы man для каждого пользователя Linux

Одним из наиболее часто используемых и надежных способов получения помощи в Unix-подобных системах является использование man-страниц. Страницы руководства (man) — это стандартная документация для каждой Unix-подобной системы, и они соответствуют онлайн-руководствам для программ, функций, библиотек, форматов файлов и так далее. Тем не менее, справочные страницы страдают от многих проблем, одной из которых является то, что они слишком длинные, а некоторые люди просто не хотят читать слишком много текста на экране.

Страницы TLDR (расшифровывается как «Too Long;Didn’t Read») представляют собой примеры практического использования команд в различных операционных системах, включая Linux. Они упрощают справочные страницы, предлагая практические примеры.

TLDR — это интернет-сленг, означающий, что пост, статья, комментарий или что-либо, например страница руководства, были слишком длинными, и тот, кто использовал фразу, не читал её по этой причине.

В этой короткой статье мы покажем, как устанавливать и использовать страницы TLDR в Linux.

Требования

Установите последнюю версию Nodejs и NPM в системах Linux.

Перед установкой вы можете попробовать демо-версию TLDR.

Как установить TLDR в системах Linux?

Для удобного доступа к TLDR вам необходимо установить один из поддерживаемых клиентов с Node.js, который является исходным клиентом для проекта tldr-pages. Мы можем установить его из NPM, запустив:

$ sudo npm install -g tldr

TLDR также доступен в виде пакета Snap, чтобы установить его, запустите:

$ sudo snap install tldr

После установки клиента TLDR вы можете просмотреть страницы руководства любой команды, например, команды tar:

$ tldr tar

Вот еще один пример доступа к сводной man-странице, но уже для команды ls:

$ tldr ls

Чтобы вывести все команды для выбранной платформы, используйте флаг -l:

$ tldr -l

Чтобы вывести список всех поддерживаемых команд, используйте флаг -a:

$ tldr -a

Вы можете обновить или очистить локальный кеш, запустив:

$ tldr -u #update local cache

Или же:

$ tldr -c #clear local cache

Для поиска справки по ключевым словам используйте, опции -s:

$ tldr -s "list of all files, sorted by modification date"

Чтобы изменить цветовую тему (simple, base16, ocean), используйте флаг -t:

$ tldr -t ocean

Вы также можете показать случайную команду с флагом -r:

$ tldr -r

Вы можете увидеть полный список поддерживаемых опций, запустив:

$ tldr -h

Примечание. Список всех поддерживаемых и выделенных клиентских приложений для разных платформ можно найти на вики-странице клиентов TLDR.

Домашняя страница проекта TLDR: https://tldr.sh/

На этом пока все! TLDR представляет собой краткие практические примеры команд, предоставленных сообществом. В этой короткой статье мы показали, как устанавливать и использовать страницы TLDR в Linux.

Спасибо за уделенное время на прочтение статьи!

Если возникли вопросы, задавайте их в комментариях.

Подписывайтесь на обновления нашего блога и оставайтесь в курсе новостей мира инфокоммуникаций!

Чтобы знать больше и выделяться знаниями среди толпы IT-шников, записывайтесь на курсы Cisco, курсы по кибербезопасности,  полный курс по кибербезопасности от Академии Cisco, курсы Linux от Linux Professional Institute на платформе SEDICOMM University (Университет СЭДИКОММ).