Хорошая документация абсолютно необходима для любого программного обеспечения, и этот принцип распространяется на Команды Linux также.

Многочисленные дистрибутивы Linux и сообщества с открытым исходным кодом предлагают исчерпывающую документацию, которая легко доступна в Интернете.

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

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

“мужчина” – это сокращенная форма “руководство” и служит интерфейсом для доступа к справочным руководствам по системе. Эти руководства, также известные как «справочные страницы» содержат подробную документацию по отдельным командам.

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

$ man mkdir
$ man rmdir
$ man dd

Нужно знать команду «man», чтобы эффективно использовать Linux из терминала.

Синтаксис команды man

Синтаксис мужчина команда проста:

$ man [OPTIONS] ...   ...

Как и любая другая команда Linux, пара квадратных скобок ([]) представляет необязательный аргумент, тогда как пара угловых скобок (<>) представляет обязательный аргумент.

Разделы команды человека

Помимо команд оболочки, линукс также поддерживает другие конструкции программирования, такие как системные вызовы, библиотечные вызовы, специальные файлы, и так далее. Для лучшей организации каждая программная конструкция объединена в специальную группу, называемую разделами.

Итак, давайте кратко обсудим каждый раздел человека:

• Секция 1 – Этот раздел содержит справочные страницы исполняемых программ или команд оболочки. Например, резать, gzip, уникальныйи т. д.
• Раздел 2 – Этот раздел содержит справочные страницы системных вызовов. Системный вызов используется ядром Linux для раскрытия своей функциональности. Общие системные вызовы: open(), read(), write(), close(), lseek()и т. д.
• Раздел 3 – Этот раздел содержит справочные страницы библиотечных вызовов. Вызовы библиотек — это функции, предоставляемые библиотеками пользовательского пространства. Например, strlen() функция из библиотеки строк, fopen() функцию от стандартный ввод/вывод библиотека и др.
• Раздел 4 – Этот раздел содержит справочные страницы специальных файлов. Обычно эти файлы находятся под /dev каталог. Например, /dev/null, /dev/fullи т. д.
• Раздел 5 – Этот раздел содержит справочные страницы форматов файлов и соглашений. Например, /и т.д./хосты, /и т.д./теньи так далее.
• Раздел 6 – Этот раздел содержит справочные страницы, связанные с играми.
• Раздел 7 – Этот раздел содержит справочные страницы различных команд. Например, мужчина и Грофф.

В этом руководстве для начинающих мы углубимся в тонкости команды «man», получая глубокие знания на практических примерах.

1. Просмотрите справочную страницу команды Linux.

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

Чтобы понять это, давайте воспользуемся следующей командой для просмотра справочной страницы команда сна.

$ man sleep

В приведенном выше выводе мы видим, что мужчина Команда показывает подробную информацию о спать команда. Мы можем нажать на 'q' чтобы выйти из окна справочной страницы и вернуться к терминалу.

Если вы внимательно посмотрите, то мы увидим, что в верхнем левом и правом углах есть число, заключенное в круглые скобки после имени команды. Это число представляет раздел страницы руководства.

Например, в приведенном выше выводе СОН(1) используется для представления раздела 1 страницы руководства.

2. Навигация по справочной странице

Каждая справочная страница содержит исчерпывающую информацию. Например, описание команды со всеми поддерживаемыми параметрами, кодами выхода, автором команды, известными проблемами/ошибками и т. д.

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

Мы можем использовать следующие команды пейджера для эффективной навигации по справочной странице:

• Стрелка вверх – перейти вперед по справочной странице на одну строку.
• Кнопка «Стрелка вниз – для перемещения назад по справочной странице на одну строку.
• ф или космос – перейти вперед по справочной странице на одно окно терминала.
• б – для перемещения назад по справочной странице на одно окно терминала.
• /шаблон – для поиска шаблона на странице руководства в прямом направлении.
• ?шаблон – для поиска шаблона на странице руководства в обратном направлении.

3. Просмотр справочной страницы из определенного раздела

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

По умолчанию мужчина Команда ищет документацию во всех разделах и показывает страницу из первого совпавшего раздела.

Например, в предыдущем примере команда – мужчина спит показывает справочную страницу только из раздела 1, даже если справочная страница присутствует и в разделе 3. В таких случаях мы можем использовать указание номера раздела в качестве аргумента командной строки для мужчина команда.

Теперь давайте просмотрим справочную страницу sleep() библиотечной функции с помощью следующей команды:

$ man 3 sleep

В приведенной выше команде цифра 3 после команды man представляет раздел 3.

4. Просмотр справочной страницы из всех разделов

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

В таких случаях мы можем использовать -a опция с командой для просмотра справочных страниц из всех разделов.

$ man -a sleep

С этой опцией команда man показывает все справочные страницы одну за другой. Следовательно, чтобы просмотреть следующую справочную страницу, мы должны закрыть текущую справочную страницу, нажав кнопку ‘q’ ключ.

Например, следующие экранные инструкции отображаются после нажатия кнопки 'q' ключ.

5. Поиск в разделах справочной страницы

В предыдущем примере мы видели, как просматривать справочные страницы всех разделов. Однако иногда мы просто хотим знать разделы, в которых доступна конкретная справочная страница.

В таких случаях мы можем использовать -f возможность показать раздел справочной страницы вместе с кратким описанием.

$ man -f sleep

В приведенном выше выводе мы можем увидеть краткую информацию о спать из разделов 3 и 1 соответственно.

6. Поиск справочных страниц по ключевому слову

Иногда нам нужно найти определенное ключевое слово в описании страницы руководства. В таких случаях мы можем использовать -k опция, которая перечисляет справочные страницы по ключевым словам.

Теперь давайте перечислим все справочные страницы, на которых встречается слово спать настоящее:

$ man -k sleep

7. Найти исходное местоположение страницы руководства

Справочная страница представляет собой простой текстовый файл, сжатый с помощью gzip-командаиспользуя -w Опция напечатает расположение файла справочной страницы.

$ man -a -w sleep

/usr/share/man/man1/sleep.1.gz
/usr/share/man/man3/sleep.3.gz

В приведенном выше выводе мы видим, что файл справочной страницы из раздела 1 присутствует в /USR/доля/человек/человек1 каталог. Точно так же файл справочной страницы из раздела 3 находится в /USR/доля/человек/человек3 каталог.

8. Просмотрите справочную страницу в браузере справки GNOME.

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

$ yelp man:sleep

Важно отметить, что этот метод полезен только в том случае, если Графический интерфейс рабочего стола GNOME доступен.

9. Просмотр справочной страницы в веб-браузере

В дополнение к этому, мы также можем использовать -H возможность просмотра справочной страницы в веб-браузер такой как Fire Fox браузер.

$ man -Hfirefox sleep

В некоторых системах мы можем получить ошибку:

man: command exited with status 3: (cd /tmp/hmanQf1PgM && /usr/lib/man-db/zsoelim) | (cd /tmp/hmanQf1PgM && /usr/lib/man-db/manconv -f UTF-8:ISO-8859-1 -t UTF-8//IGNORE) | (cd /tmp/hmanQf1PgM && preconv -e UTF-8) | (cd /tmp/hmanQf1PgM && tbl) | (cd /tmp/hmanQf1PgM && groff -mandoc -Thtml)

Чтобы исправить эту ошибку, мы должны установить Грофф утилита, представляющая собой систему набора текста, которая обычно используется для форматирования и обработки текстовых документов.

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

Заключение

В этом руководстве мы обсудили, как просматривать системную документацию Linux. Мы рассмотрели использование «мужчина” для отображения системной документации как на терминале, так и в инструментах пользовательского интерфейса.

Знаете ли вы какой-либо другой способ получить доступ к системной документации Linux? Сообщите нам свое мнение в комментариях ниже.