Написать пост

Краткий man: обзор инструмента tldr

Аватар Светлана Хачатурян

Инструмент tldr коротко и ёмко знакомит новичков и всех разработчиков с возможностями основных команд терминала. Постоянно пополняемая коллекция описаний реализована во множестве клиентов для популярных ОС и языков программирования.

Обложка поста Краткий man: обзор инструмента tldr

Сообщество из более чем 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:tldr;tldr-bash-client;
  • Клиент для C++brew install tldr;
  • Клиент для Crystaltbrew install porras/tap/tlcr;
  • Клиент для Dartpub global activate tldr;
  • Dash docsetPreferences > 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(или скомпилированные релизы);
  • Клиенты для iOS:tldr-man-page, доступен в App Store;tldr-pages, доступен в App Store;
  • Клиент для Haskellstack install tldr;
  • Клиент для Node.jsnpm install -g tldr;
  • Клиент для Perl5cpanm App::tldr;
  • Клиент для PHPcomposer global require brainmaestro/tldr;
  • Клиенты для Python:tldr-python-client: pip install tldr;tldr.py: pip install tldr.py;
  • Клиент для Rdevtools::install_github('kirillseva/tldrrr');
  • Клиент для Rubygem install tldrb;
  • Клиенты для Rust:rust-tldr (тонкий клиент с поиском онлайн): cargo install tldr;tealdeer (полноценный клиент с оффлайн кэшем): cargo install tealdeer;
  • Веб-клиенты:tldr.jsx: http://tldr.ostera.io/;DistroWatch.
Следите за новыми постами
Следите за новыми постами по любимым темам
6К открытий6К показов