tldr

Что такое tldr-страницы?

Проект tldr-pages представляет собой коллекцию поддерживаемых сообществом справочных страниц для инструментов командной строки, призванных стать более простым и доступным дополнением к традиционным справочным страницам.

Возможно, вы новичок в мире командной строки. Возможно, вы просто немного заржавели или не всегда можете вспомнить аргументы таких команд, как lsof или tar ?

Конечно, не помогает то, что в прошлом первый вариант, описанный в man tar был:

$ man tar
...
-b blocksize
   Specify the block size, in 512-byte records, for tape drive I/O.
   As a rule, this argument is only needed when reading from or writing to tape drives,
   and usually not even then as the default block size of 20 records (10240 bytes) is very common.
...

Есть место для более простых справочных страниц, посвященных практическим примерам. Как насчет:

Этот репозиторий представляет собой постоянно растущую коллекцию примеров для наиболее распространенных инструментов командной строки UNIX, Linux, macOS, FreeBSD, NetBSD, OpenBSD, SunOS, Android и Windows.

Как мне его использовать?

Кончик

Для просмотра без установки клиента на свой компьютер см. веб-клиент по адресу https://tldr.inbrowser.app (с автономной поддержкой с использованием PWA).

Популярный и удобный способ получить доступ к этим страницам на вашем компьютере — установить официальный клиент Node.js:

npm install -g tldr

Альтернативно вы также можете использовать официальный клиент Python, который можно установить через pip3 (или другие менеджеры пакетов):

pip3 install tldr

Пользователи Linux и Mac также могут установить официальный клиент Rust с помощью Homebrew (или других менеджеров пакетов в других операционных системах):

brew install tlrc

Тогда у вас будет прямой доступ к упрощенной и удобной для чтения справке по командам, например tar , которую можно получить, набрав tldr tar вместо стандартного man tar .

Если вы не хотите устанавливать какое-либо программное обеспечение, воспользуйтесь версией PDF.

Примечание

PDF-файлы с переводами доступны для большинства языков. Вы можете найти их в ресурсах последней версии.

Сообществом также предоставляются различные другие клиенты , как для командной строки, так и для других платформ. Полный список клиентов можно найти на нашей Wiki.

Как мне внести свой вклад в развитие tldr-страниц?

Все вклады приветствуются!

Некоторые способы внести свой вклад включают в себя:

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

Все страницы tldr написаны в Markdown, поэтому их можно довольно легко редактировать, а изменения можно отправлять сюда в запросах на включение с помощью Git в командной строке или с помощью веб-интерфейса GitHub.

Мы стремимся поддерживать гостеприимство и сотрудничество в сообществе. Если вы впервые вносите свой вклад, ознакомьтесь с правилами внесения вклада и вперед!

Если вы хотите внести свой вклад в переводы, вы можете посетить https://lukwebsforge.github.io/tldri18n/, чтобы увидеть общий прогресс всех переводов, а также узнать, какие переводы отсутствуют или устарели.

Вы также можете присоединиться к нам в матричном чате!

Похожие проекты

• Страницы интерфейса командной строки позволяют писать стандартизированные страницы справки для CLI, каталогов и конфигураций.

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

• Cheet.sh Объединяет шпаргалки из нескольких источников (включая tldr-страницы) в один унифицированный интерфейс.

• Шпаргалки devhints Rico ориентированы не только на командную строку и включают в себя множество других шпаргалок, связанных с программированием.

• например, предоставляет подробные примеры с пояснениями в командной строке. Примеры взяты из репозитория, но eg поддерживается отображение пользовательских примеров и команд рядом со значениями по умолчанию.

• kb — минималистичный менеджер базы знаний с командной строкой. kb можно использовать для минималистской и чистой организации ваших заметок и шпаргалок. Он также поддерживает нетекстовые файлы.

• navi — это интерактивная шпаргалка, которая позволяет вам просматривать конкретные примеры или выполнять команды на лету.

• bropages (устарело) — это легко читаемое дополнение к man-страницам. В нем показаны краткие, типичные примеры команд Unix. Примеры представлены базой пользователей и могут быть проголосованы за или против; лучшие записи — это то, что люди видят первым, когда ищут команду.

Что означает «тлдр»?

TL;DR означает «Слишком долго; не читал». Оно возникло как интернет-сленг, где оно используется для обозначения того, что длинный текст (или его части) был пропущен как слишком длинный. Подробнее читайте в статье How-To Geek.