Страницы руководства слишком сложны? Попробуйте tldr, чтобы изучить команды Linux
Ключевые выводы
- tldr упрощает справку по командам Linux с помощью кратких, доступных страниц и ключевых примеров.
- Установите tldr с помощью npm или Homebrew, затем используйте такие команды, как «tldr grep», чтобы быстро получить доступ к справке по командам.
- Веб-сайт tldr предлагает те же подробные страницы, что и инструмент командной строки, с автозаполнением поиска и ссылками GitHub.
Страницы руководства являются основным источником помощи по командам Linux, но они очень насыщены и совсем не удобны для новичков. Введите tldr — команду, которая значительно упрощает использование командной строки.
Что такое tldr и почему он лучше человека?
Tldr работает как man — стандартный способ получения справки по командам Linux. Его название отсылает к распространенному в Интернете инициализму TL;DR, сокращенному от «Слишком долго; не читал». Вместо man-страниц команда tldr показывает страницы tldr, которые являются гораздо более доступной альтернативой.
Каждая страница tldr начинается с имени команды, описания ее действия в одном предложении и URL-адреса для более подробной информации, обычно версии соответствующей man-страницы.
Далее следует самая ценная функция tldr: список примеров. Хотя страницы руководства содержат примеры, они обычно находятся внизу или в формате использования, который не всегда легко понять. Tldr поднимает примеры и включает в себя ровно то количество, которое необходимо: достаточно, чтобы охватить наиболее важные случаи, но не так много, чтобы оно было громоздким.
Возьмем, к примеру, команду cd, которую вы, вероятно, используете чаще, чем любую другую. Вы можете подумать, что знаете все об этом чрезвычайно простом инструменте, но tldr может помочь раскрыть некоторые скрытые возможности его использования:
«Домашний каталог пользователя» и «ранее выбранный» — действительно полезные варианты, о которых вы, возможно, не знали.
Как установить и использовать tldr
Страницы tldr написаны на Markdown, и, как побочный эффект, для их просмотра можно использовать множество различных клиентских программ. Консольный клиент имеет наибольший смысл, поскольку вы, вероятно, уже находитесь в командной строке, когда ищете помощь.
Исходному консольному клиенту требуется npm, диспетчер пакетов узлов JavaScript. Если у вас есть npm, вы можете использовать его для установки tldr следующим образом:
npm install -g tldr
Установка npm — рекомендуемый маршрут. Если у вас нет npm и вы хотите установить другой способ, вы можете использовать Homebrew («brew install tldr») или обратиться к обширному списку клиентов на странице tldr на GitHub.
После установки используйте tldr и передайте ему имя команды, как и в случае с человеком, например:
tldr grep
Вы можете выполнить поиск на страницах tldr любого текста, который может встретиться в примере или описании команды. Просто используйте опцию «--search» следующим образом:
tldr --search "change permissions"
Если вы хотите узнать, сколько команд tldr охватывает для вашей платформы, вы можете использовать опцию «--list». По умолчанию все команды будут отображаться в одной огромной строке, разделенной запятыми. Добавьте «-1», чтобы просмотреть по одному в строке.
tldr --list
Вы даже можете (что неудивительно) использовать tldr для получения справки о самом себе:
tldr tldr
Вы увидите примеры, охватывающие все случаи, включая варианты помощи для конкретного языка и информацию для конкретных платформ.
Установив tldr, попробуйте добавить «tldr --random» в ваш .bashrc или его эквивалент. Опция --random отображает информацию о случайной команде; есть также «--random-example», чтобы показать только один пример использования. Теперь каждый раз, когда вы открываете новый терминал, он будет знакомить вас с новой командой.
Веб-сайт tldr почти так же хорош
Инструмент командной строки предоставляет страницы tldr именно там, где вы хотите: в командной строке. Но официальный сайт предоставляет собственный интерфейс со всеми теми же деталями, отформатированный под ваш браузер.
Возможно, это не всегда так удобно, как команда, но на сайте есть несколько приятных мелочей.
- Поиск имеет полное автозаполнение и выделяет команды, специфичные для Linux или Mac.
- Каждая страница ссылается на соответствующий источник на GitHub. Если у вас когда-нибудь возникнет желание внести свой вклад в проект, это отличное место для начала. Вы даже можете использовать встроенные инструменты GitHub для отправки изменений прямо на сайт, не изучая ничего о git.