Хорошие альтернативы man-страницам, которые должен знать каждый пользователь Linux

man-страница, аббревиатура от manual page, представляет собой документацию по программному обеспечению, обычно встречающуюся во всех Unix-подобных операционных системах. Некоторые справочные страницы короткие, а некоторые полные. Страница руководства разделена на несколько частей, организованных с заголовками для каждого раздела, такими как НАЗВАНИЕ, ОПИСАНИЕ, КОНФИГУРАЦИЯ, ОПИСАНИЕ, ОПЦИИ, СТАТУС ВЫХОДА, ВОЗВРАЩАЕМОЕ ЗНАЧЕНИЕ, ОШИБКИ, СРЕДА, ФАЙЛЫ, ВЕРСИИ, СООТВЕТСТВИЕ, ПРИМЕЧАНИЯ, ОШИБКИ, ПРИМЕР. , АВТОРЫ, а также СМОТРИТЕ ТАКЖЕ.

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

Хорошие альтернативы страницам руководства для изучения кратких примеров команд Linux

Я не включил "информационные страницы" в это руководство, потому что мне нужна была простая альтернатива справочным страницам, которая научит меня быстро изучать команды и их параметры с примерами и без необходимости долгого изучения. страницы руководства.

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

1. Бропажи

Девиз утилиты Bropages: просто доберитесь до сути. Это правда! bropages аналогичны справочным страницам, но на них отображаются только примеры. Как гласит его слоган, он пропускает всю текстовую часть и дает вам краткие примеры для программ командной строки.

Bropages можно легко установить с помощью gem. Итак, чтобы это работало, на вашем компьютере должен быть установлен Ruby 1.8.7+. Чтобы установить Ruby on Rails в CentOS и Ubuntu, обратитесь к следующему руководству:

• Установить Ruby on Rails в CentOS и Ubuntu

После установки драгоценного камня все, что вам нужно сделать для установки страниц Bro, это:

gem install bropages

1.1. Применение

Использование невероятно просто! Чтобы получить примеры использования любой команды Unix, например find, просто введите:

bro find

Это так просто. Вы увидите несколько примеров команды find, созданных сообществом.

Просмотрите шпаргалку по командам Linux на страницах Bro

Нажмите ENTER, чтобы просмотреть все примеры. Чтобы выйти, просто введите q.

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

Как вы видите на скриншоте выше, мы можем проголосовать за первую команду, введя следующую команду:

bro thanks

Вам будет предложено ввести свой адрес электронной почты. Введите действительный адрес электронной почты, чтобы получить код подтверждения. Скопируйте/вставьте проверочный код в командную строку и нажмите ВВОД, чтобы отправить свой голос. Примеры с наибольшим количеством голосов будут показаны вверху.

Bropages.org requires an email address verification to do this
What's your email address?
sk@senthilkumar.com
Great! We're sending an email to sk@senthilkumar.com
Please enter the verification code: apHelH13ocC7OxTyB7Mo9p
Great! You're verified! FYI, your email and code are stored locally in ~/.bro
You just gave thanks to an entry for find!
You rock!

Чтобы проголосовать за вторую команду, введите:

bro thanks 2

Аналогично, чтобы проголосовать против первой команды, выполните:

bro ...no

Чтобы понизить вторую команду:

bro ...no 2

Вы также можете отправить свой собственный пример для поиска команды, используя:

bro add find

Круто, не так ли? Просто установите bropages и облегчите свою жизнь в командной строке!

Для получения более подробной информации посетите домашнюю страницу проекта.

• сайт Bropages

2. Обман

Cheat — еще одна полезная альтернатива справочным страницам для изучения команд Unix. Он позволяет создавать и просматривать интерактивные шпаргалки по командам Linux/Unix в командной строке.

Рекомендуемый способ установки Cheat — использование менеджера пакетов Pip . Если вы не установили Pip в свой дистрибутив Linux, перейдите по следующей ссылке:

• Как управлять пакетами Python с помощью Pip

После установки pip установите Cheat с помощью pip с командой:

sudo pip install cheat

Чит-утилита также доступна в пакете snap. Если в вашей системе Linux установлен Snapd, выполните следующую команду, чтобы установить чит:

sudo snap install cheat

2.1. Применение

Использование читов тривиально. Чтобы просмотреть шпаргалку любой команды, скажем, find, выполните:

cheat find

Вам будет представлен список доступных примеров команды find:

Просмотр шпаргалок по командам Linux с помощью утилиты Cheat

Видеть? Чит отображает множество примеров команд поиска в удобочитаемом формате. Вам не нужно использовать man-страницы или Google, чтобы узнать, как использовать команду find.

Чтобы просмотреть список всех доступных шпаргалок: , запустите:

cheat list

Чтобы просмотреть раздел справки, запустите:

cheat -h

Более подробную информацию можно найти в репозитории проекта на GitHub:

• Репозиторий читов на GitHub

3. Страницы TLDR

TLDR — это набор упрощенных справочных страниц, созданных сообществом. В отличие от man-страниц, страницы TLDR фокусируются только на практических примерах.

TLDR можно установить с помощью npm. Итак, чтобы это работало, на вашем компьютере должен быть установлен NodeJS.

Чтобы установить NodeJS в Linux, обратитесь к следующему руководству.

• Как установить Node.js в Linux

После установки npm выполните следующую команду, чтобы установить tldr.

npm install -g tldr

Клиенты TLDR также доступны для Android. Установите любое из перечисленных ниже приложений из Google Play Sore и получите доступ к страницам TLDR со своих устройств Android.

• tldroid

Доступно множество клиентов TLDR. Вы можете просмотреть их все здесь.

3.1. Применение

Чтобы отобразить документацию по любой команде, например find, выполните:

tldr find

Вы увидите список доступных примеров команды find.

Просмотр шпаргалок по командам Linux с помощью утилиты tldr

Как вы видите на скриншоте выше, TLDR отображает только краткие примеры. Никакого длинного описания, никаких подробностей об авторе, никаких объяснений переключателей и аргументов. Он отображает только описание команды find и примеры использования. Если бы вы видели справочные страницы команды find, вы были бы засыпаны множеством подробных подробностей.

Чтобы просмотреть список всех команд в кеше, запустите:

tldr --list-all

Рекомендуется к прочтению:

• Как создавать и поддерживать собственные справочные страницы
• Научитесь эффективно использовать справочные страницы
• Как установить отсутствующие страницы команд команд в Ubuntu
• Pinfo — программа CLI для чтения информации и справочных страниц в цвете

Хотите добавить больше примеров к определенной команде или хотите отправить примеры для команды, которая еще не доступна на страницах TLDR, — нет проблем. Вы также можете внести свой вклад и отправить их. Более подробную информацию можно найти в рекомендациях по участию в TLDR .

Чтобы обновить локальный кеш, запустите:

tldr -u

Или,

tldr --update

Чтобы отобразить раздел справки, запустите:

tldr -h

Более подробную информацию можно найти на странице TLDR на github.

• Репозиторий TLDR на GitHub

4. TLDR++

Tldr++ — еще один клиент для доступа к страницам TLDR. В отличие от других клиентов Tldr, он полностью интерактивен. Это означает, что вы можете выбрать команду, прочитать все примеры и немедленно запустить любую команду без необходимости перепечатывать или копировать/вставлять каждую команду в терминал. Все еще не поняли? Без проблем. Перейдите по следующей ссылке, чтобы узнать больше о клиенте Tldr++.

• Ищите, изучайте и практикуйте команды Linux на лету!

5. Тилдир

Tealdeer — это быстрый неофициальный клиент tldr, который позволяет вам получать доступ к шпаргалкам команд Linux и отображать их в вашем терминале. Разработчик Tealdeer утверждает, что он очень быстр по сравнению с официальным клиентом tldr и другими клиентами tldr, поддерживаемыми сообществом. Чтобы узнать об использовании Tealdeer, перейдите по следующей ссылке:

• Отображение шпаргалок по командам Linux с помощью инструмента Tealdeer

6. веб-клиент tldr.jsx

tldr.jsx — это реактивный веб-клиент для tldr-страниц. Если вы не хотите ничего устанавливать в своей системе, вы можете попробовать этот клиент онлайн с любого устройства с доступом в Интернет, например настольного компьютера, ноутбука, планшета и смартфона. Все, что вам нужно сделать, это просто веб-браузер.

Откройте веб-браузер и перейдите на страницу https://tldr.ostera.io/. Введите команду команды Linux в поле поиска и нажмите клавишу ВВОД, чтобы просмотреть примеры команд в веб-браузере.

Просмотрите шпаргалку по командам Linux с помощью веб-клиента tldr.jsx

tldr.jsx — это страница, удобная для мобильных устройств, поэтому вы можете получить к ней доступ из любого места и использовать ее где угодно!

7. Интерактивная шпаргалка для командной строки Navi

Navi — это интерактивная шпаргалка для командной строки, написанная на Rust. Как и страницы Bro, инструменты Cheat и Tldr, Navi также предоставляет список примеров для данной команды, пропуская все остальные подробные текстовые части. Для получения более подробной информации проверьте следующую ссылку.

• Navi - интерактивная шпаргалка по командной строке

8. Мужественный

Недавно я наткнулся на эту утилиту и подумал, что ее стоит добавить в этот список. Передайте привет Manly, комплименту справочным страницам.

Manly написан на Python, поэтому его можно установить с помощью менеджера пакетов Pip. Если вы еще не установили Pip, перейдите по ссылке, приведенной в разделе 2 (утилита Cheat).

После установки Pip выполните следующую команду, чтобы установить Manly:

pip install --user manly

8.1. Применение

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

manly dpkg

Но если вы упомянете какой-либо флаг/опцию команды, вы получите небольшое описание данной команды и ее параметров.

manly dpkg -i -R

Просмотрите шпаргалку по командам Linux с помощью утилиты Manly

Более подробную информацию можно найти в разделе помощи:

manly --help

А также загляните на страницу проекта на GitHub.

• Репозиторий Manly на GitHub

Рекомендуется прочитать:

• ExplainShell: узнайте, что делает каждая часть команды Linux
• Dwww - просмотр полной документации Debian в автономном режиме через веб-браузер

Заключение

Теперь вы знаете, что существует восемь реальных альтернатив справочным страницам. Эти альтернативы отображают примеры команд Linux вместе с кратким описанием.

Если вы хотите узнать больше обо всех параметрах команд Unix/Linux, лучше использовать справочные страницы и/или информационные страницы, поскольку они содержат подробную информацию.

Как я уже сказал, может быть много других альтернатив. Но этого достаточно, по крайней мере для меня, чтобы легко и быстро научиться использовать команды Linux и Unix.