TLDR — понятные страницы руководства для команд Linux

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

Однако справочные страницы имеют множество недостатков, один из которых заключается в том, что они слишком длинные, а некоторым людям просто не нравится читать слишком много текста на экране.

TLDR (расшифровывается как «Слишком долго; не читал») — это проект сообщества, который предоставляет краткую и упрощенную документацию для различных команд Linux.

TLDR стремится предложить быстрые и практические примеры использования команд, облегчая пользователям понимание и использование команд без необходимости углубляться в обширные руководства или длинные объяснения.

Доступ к TLDR обычно осуществляется через командную строку с помощью команды «tldr», за которой следует имя команды, о которой вы хотите узнать.

tldr ls

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

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

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

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

Чтобы установить Node.js, вы можете использовать менеджер пакетов, соответствующий вашему дистрибутиву.

sudo apt install nodejs npm         [On Debian, Ubuntu and Mint]
sudo yum install nodejs npm         [On RHEL/CentOS/Fedora and Rocky/AlmaLinux]
sudo emerge -a sys-apps/nodejs npm  [On Gentoo Linux]
sudo apk add nodejs npm             [On Alpine Linux]
sudo pacman -S nodejs npm           [On Arch Linux]
sudo zypper install nodejs npm      [On OpenSUSE]    

После установки Node.js и npm вы можете приступить к установке TLDR с помощью команды npm, как показано ниже. .

sudo npm install -g tldr

TLDR также доступен в виде пакета Snap для установки и запуска.

sudo snap install tldr

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

tldr tar

Вот еще один пример доступа к сводной странице руководства для команды ls.

tldr ls

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

tldr -l 

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

tldr -a

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

tldr -u	#update local cache 
OR
tldr -c 	#clear local cache 

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

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

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

tldr -t ocean

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

tldr -r   

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

tldr -h

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

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

Используйте форму обратной связи, чтобы поделиться своими мыслями о TLDR или поделиться с нами любыми похожими программами.