Сообщество из более чем 500 разработчиков на GitHub выпустило инструмент для краткого представления справочных материалов — так называемых man-ов.
TL;DR
Разработка получила название tldr – сокращение от Too Long;Didn’t Read (слишком длинно;не читал). Она сокращает справку к популярным утилитам, делая её более дружелюбной. Очень легко забыть, за что отвечают lsof
или tar
. И вызов помощника через man tar
не очень-то упрощает жизнь:
TAR(1) BSD General Commands Manual TAR(1)
NAME
tar — The GNU version of the tar archiving utility
...
FUNCTION LETTERS
Main operation mode:
-A, --catenate, --concatenate
append tar files to an archive
-c, --create
...
Вместо этого tldr предлагает ознакомиться со следующими подсказками:
Репозиторий инструмента постоянно пополняется новыми коллекциями самых распространённых утилит UNIX, Linux, macOS и SunOS.
Клиенты
У tldr есть множество реализаций:
- Alfred Workflow;
- Клиенты для Android:
- tldr-viewer, доступный в Google Play;
- tldroid, доступный в Google Play;
- Клиенты для Bash:
- Клиент для C++:
brew install tldr
; - Клиент для Crystalt:
brew install porras/tap/tlcr
; - Клиент для Dart:
pub global activate tldr
; - Dash docset:
Preferences > Downloads > User Contributed
, пункт спискаtldr pages
; - Клиент для Elixir (бинарные файлы пока не доступны);
- Клиент для Emacs, доступен в MELPA;
- Клиенты для Go:
- github.com/pranavraja/tldr:
go get github.com/pranavraja/tldr
(или скомпилированные релизы); - 4d63.com/tldr:
go get 4d63.com/tldr
илиbrew install 4d63/tldr/tldr
(или скомпилированные релизы);
- github.com/pranavraja/tldr:
- Клиенты для iOS:
- tldr-man-page, доступен в App Store;
- tldr-pages, доступен в App Store;
- Клиент для Haskell:
stack install tldr
; - Клиент для Node.js:
npm install -g tldr
; - Клиент для Perl5:
cpanm App::tldr
; - Клиент для PHP:
composer global require brainmaestro/tldr
; - Клиенты для Python:
- tldr-python-client:
pip install tldr
; - tldr.py:
pip install tldr.py
;
- tldr-python-client:
- Клиент для R:
devtools::install_github('kirillseva/tldrrr')
; - Клиент для Ruby:
gem install tldrb
; - Клиенты для Rust:
- Веб-клиенты:
Источник: GitHub