Linux -- это интересно

tldr pages


Рубрика: Изучаем Linux -> Прочие -> Hужное/полезное
Метки: | | | |
Просмотров: 658

tldr pages — развиваемые сообществом упрощённые справочные страницы (simplified man pages).

Стандартный набор справочных страниц, часто называемых man-страницами, имеется у большинства приложений в GNU Linux системах. Справочные страницы обычно очень длинные и избыточно информативные, как правило содержат список всех доступных вариантов использования, иногда без пояснений и примеров использования.

Подробная информация нужна далеко не всегда, чаще всего необходимо несколько строк, но их приходится выискивать в большом тексте и оказалось что это устраивает далеко не всех. Поэтому в 2014 году появился проект tldr pages, название является отсылкой к англоязычному акрониму TL;DR (too long; didn't read / слишком длинно, не читал).

Авторы проекта tldr pages решили привнести в консоль лаконичную документацию, содержащую только основную информацию. В коллекции упрощённых справочных страниц представлены команды с кратким описанием их назначения и даны примеры наиболее частого использования запрошенной утилиты/команды.

tldr pages является альтернативой man, info и --help (-h), выводящей лишь краткую справку с наиболее полезной информацией, своего рода набор подсказок или шпаргалок, не являющихся полноценной заменой официальной документации к приложениям. Библиотеку справочных страниц выполнена в виде файлов формата Markdown (*.md), распределённых по категориям.

Для получения доступа к страницам tldr необходим клиент, авторами проекта рекомендуется использовать Node.js клиент, как имеющий наиболее полный функционал. Имеются и другие клиенты от сообщества, написанные на всех популярных языках (Bash, C++, Go, Haskell, Perl, Python, Rust, Ruby и пр), также можно использовать демонстрационный Web client или веб-клиент от DistroWatch.

tldr pages клиенты практически одинаково выводят описание назначения утилиты и компактный список самых частых команд. Некоторые клиенты загружают запрошенную информацию с веб-сайта, а есть те что используют загруженную и обновляемую библиотеку файлов (автоматически или вручную). Клиенты между собой несовместимы, можно использовать только один клиент.

Лицензия: MLT (The MIT License)

Домашняя страница

Оставьте комментарий!
Используйте нормальные имена.Войти через loginza
Если вы уже зарегистрированы как комментатор или хотите зарегистрироваться, укажите пароль и свой действующий email.
(При регистрации на указанный адрес придет письмо с кодом активации и ссылкой на ваш персональный аккаунт, где вы сможете изменить свои данные, включая адрес сайта, ник, описание, контакты и т.д.)



 
(обязательно)