Какая команда предназначена для чтения страниц руководств

Интерактивные руководства в Linux – команда man

Каждая уважающая себя система (или дистрибутив) на базе Linux содержит в своём составе так называемые man-страницы — «мануалы», т. е. справочные руководства. Ведь черпать информацию о том как пользоваться системой, в частности, о назначении команд, их опций, системной конфигурации и составляющих её (конфигурацию) файлов в итоге откуда-то нужно. Конечно, существуют большое количество технической литературы в виде изданий (как из открытых источников, так и коммерческих) по системному администрированию UNIX/Linux, однако всё это лишь дополняет (порой с качественным переводом) первоисточники, доступные локально «из коробки» в справочных системах Linux-дистрибутивов.

Конечно, man-руководства не содержат такой информации, к примеру, как сгенерировать и установить SSL-сертификат — они (man-руководства) и не предназначены для этого. Но любому системному администратору Linux получать информацию и исчерпывающее описание команд, библиотек функций, системной конфигурации и т. д. для обслуживаемого дистрибутива следует, в первую очередь, из справочной системы используемого дистрибутива.

Справочная система Linux

Для удобства организации и хранения справочной документации все страницы справочных руководств в Linux сгруппированы по тематическим разделам. В зависимости от дистрибутива одни и те же разделы могут содержать разный набор руководств. Допускается также деление разделов на подразделы. Следующая таблица демонстрирует состав основных разделов справочных руководств для некоторых систем:

По-умолчанию, без указания раздела команда man практически всегда находит требуемую информацию, поэтому на первый взгляд может показаться, что структура разделов не имеет особого значения. Но часты случаи, когда одна и та же искомая фраза содержится в разных контекстах и вот тут и полезно разбиение системной справки на разделы. К примеру, запрашиваемая фраза «passwd» подразумевает как команду, так и конфигурационных файл. Таким образом справочную информацию содержат (согласно вышеприведённой таблице) разделы 1, 4 и 5.

Стоит отметить, что в настоящее время разделы 8 всё чаще освобождаются и используются как резервные для последующего наполнения, а ранее содержащаяся в данных разделах информация (команды системного администрирования) перемещена (в большинстве дистрибутивов) в раздел 1. Также освобождаются и разделы 6.

Чтение интерактивной справки

Для того, чтобы вывести в терминал содержимое страниц по требуемому поисковому запросу, нужно выполнить команду man, которая имеет следующий синтаксис:

Команда man использует для вывода руководства утилиты less или more (а также и другие инструменты для постраничного вывода текста), при этом аккуратно форматирует текст для удобства его восприятия. Используемая утилита постраничной разбивки задаётся в переменной среды PAGER. Аргумент заголовок — это чаще всего имя команды, файла или даже устройства, о котором необходимо вывести разделы справки. Как правило, в первую очередь просматриваются разделы, содержащие информацию о командах, т. е. разделы 1, 6 и 8, а далее поиск производится по возрастанию номеров разделов.

Для указания конкретного раздела справки следует передавать параметр раздел, например:

выведет описание для команды sync, а команда:

отобразит страницы с описанием системного вызова sync.

Если нужно получить представление о том, в каких разделах доступна информация по интересующему запросу, нужно дать команду man -k запрос:

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

Хранение интерактивных руководств

Для определения, где в конкретной Linux-системе хранятся страницы справочных руководств (они же являются входными данными для обработки командой nroff, используемой man), достаточно выполнить команду manpath:

В данном выводе представлены каталоги, в подкаталогах которых хранится справочная информация для систем Ubuntu. Пункты представленного списка разделены двоеточиями. Расположение для хранения man-страниц можно изменить. Поскольку данная опция хранится в переменной окружения MANPATH, то для этого нужно изменить значение этой переменной:

По-умолчанию для Linux-систем справочные руководства хранятся в /usr/share/man. Команда man также поддерживает работу с кэшем страниц, но только тогда, когда соответствующие каталоги /var/cache/man и /usr/share/man доступны для записи, что критично в плане безопасности. В целях экономии дискового пространства справочные руководства хранятся в сжатом виде и для сжатия используется, как правило, утилита gzip. Сжатие страниц практически не сказывается на производительности во время работы со справочной системой, поскольку команда man способна очень быстро производить разархивацию.

Если вы нашли ошибку, пожалуйста, выделите фрагмент текста и нажмите Ctrl+Enter.

Источник

Какая команда предназначена для чтения страниц руководств linux

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

3.6.1. Источники справочной информации

Если вы окажетесь в ситуации, когда не знаете, что предпринять или сделать для достижения желаемой цели, лучше всего начать искать подсказку в самой системе. Дистрибутив Red Hat Linux содержит тысячи страниц документации, представленной в электронном виде, так что ответы на все возникающие вопросы у вас, что называется, «на кончиках пальцев». Существует несколько независимых источников, которые содержат информацию почти по любому аспекту работы в системе Linux:

• страницы интерактивного руководства man ;
• гипертекстовое руководство info ;
• документация, прилагаемая к пакетам ПО;
• текстовые файлы HOWTO и FAQ проекта Linux Documentation Project;
• команда locate .

Необходимо сразу сказать, что большую часть информации из этих источников вы будете получать на английском языке. Только для русифицированных дистрибутивов часть страниц интерактивного руководства man выдается на русском языке. Можно дополнительно скачать из Интернета имеющиеся там страницы руководства man , переведенные на русский язык [П5.1], и разместить их в соответствующих каталогах. Но все равно, на русский переведено далеко не все. Учитывая это замечание, рассмотрим каждый из перечисленных выше источников информации подробнее.

3.6.2. Страницы интерактивного руководства man

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

Таблица 3.4. Основные секции интерактивного руководства man

Библиотечные вызовы (подпрограммы)

Ядро (kernel internals)

Порядок перечисления секций в этой таблице не случаен. Дело в том, что файлы с информацией расположены в подкаталогах каталога /usr/man и команда man ищет нужную информацию, просматривая эти подкаталоги именно в том порядке, который приведен табл. 3.4. Если вы, например, дадите команду

[user]$ man swapon

то получите справку о команде swapon из секции 8. Поэтому если вы хотите получить справку по системному вызову swapon , надо дать команду

[user]$ man 2 swapon

указывая номер секции, в которой надо искать информацию.

Страницы man просматриваются с помощью команды less (что дает возможность просматривать информацию поэкранно и перемещаться по этим экранам вперед и назад), так что для управления процессом вывода информации можно использовать клавиши, используемые в программе less . Наиболее употребительные:

Таблица 3. 5 . Клавиатурные команды, используемые при просмотре man- страниц

Выход из программы

Просмотр строка за строкой

Вывод следующего экрана информации

Вернуться к предыдущему экрану

за которой следует строка символов и

Поиск введенной строки символов

Повторение предыдущего поиска.

Если вы предпочитаете читать текст не с экрана, а с отпечатанной копии, то можете отпечатать соответствующую страницу, воспользовавшись командой

[user]$ man имя_команды | lpr

или, если у вас postscript-принтер,

[user]$ man -t имя_команды | lpr

Но для того, чтобы получить нужную информацию, нужно еще знать, что искать. В таком случае могут помочь команды whatis и apropos . Команда whatis производит контекстный поиск заданного ключевого слова (шаблона) в базе данных, содержащей перечень системных команд с кратким описанием команды. Выводятся только точные совпадения с ключевым словом. Команда apropos производит поиск по фрагментам слов. Аналогично команде apropos работает команда man с параметром — k . Попробуйте, например,

Необходимо, однако, предупредить, что для того, чтобы команды man -k , whatis и apropos работали, необходимо вначале создать базу данных о системных командах, для чего надо запустить команду makewhatis . В противном случае вы можете на любой запрос получить сообщение «nothing appropriate». Правом запустить команду makewhatis обладает только пользователь root . Если вы не выключаете компьютер на ночь, то лучше всего запускать эту команду как задание для процесса cron .

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

3.6.3. Команда info

Команда info является некоторой альтернативой команде man . Для получения информации по отдельной команде надо задать в командной строке info с параметром, являющимся именем интересующей вас команды, например,

Информация, которую вы увидите, в большинстве случаев несколько отличается от той, которую дает команда man , причем, по моему мнению, в лучшую сторону. Но самое существенное отличие заключается в том, что выдаваемая info информация представлена в гипертекстовом формате. В силу этого вы получаете возможность просматривать различные разделы помощи, не выходя из оболочки, предоставляемой командой info . Работая в тестовом режиме, вы можете запустить info в одной из альтернативных консолей (помните: >+ Alt >+ F2>, >+ Alt >+ F3> и т. д.), и переключаться за помощью в случае необходимости. В тех случаях, когда вы не знаете, где именно найти нужную информацию, может оказаться полезным побродить по разным разделам текста с помощью гипертекстовых ссылок, предоставляемых командой info . Эти ссылки обозначены символом звездочки ( * ), что несколько отличается от способа обозначения гипертекстовых ссылок в широко распространенных браузерах типа Internet Explorer или Netscape Navigator, но от этого не становится менее удобным. Перемещаться по ссылкам можно также с помощью клавиши . Достигнув названия нужной темы, нажмите клавишу . Нажатие клавиши

возвращает вас к предыдущей странице, N > вызывает переход на следующую страницу, а U > переводит на один уровень вверх по иерархической структуре страниц документации.

Кроме того, можно вызвать переход по ссылке другим способом, аналогичным системе меню. Для этого надо нажать клавишу и набрать в появившейся внизу экрана строке ввода некоторое число начальных символов названия нужного вам раздела помощи (из числа названий, представленных на отображаемой в данный момент на экране странице, причем даже если не вся страница помещается на экране). Число символов должно быть достаточным для однозначного определения раздела помощи (если недостаточно, то программа попросит дополнить название). Выход из программы — по клавише Q >.

3.6.4. Команда help

Выше уже упоминалась система помощи по встроенным командам оболочки bash — команда help . Если ввести в командной строке help без параметров, вы получите список всех встроенных команд оболочки. Если ввести команду help name , где name — имя одной из этих команд, то вы получите очень краткую справку о применении этой команды.

3.6.5. Документация, поставляемая с дистрибутивом и пакетами ПО

Если в процессе установки системы вы не отказались от установки документации, то после завершения процедур инсталляции в каталоге /usr/doc/ (или /usr/share/doc) вы найдете подкаталоги HOWTO, FAQ, HTML и LDP, содержащие обширнейшую документацию по системе Linux в целом и отдельных аспектах ее применения. Большая часть этой документации представляет собой обычные текстовые ASCII-файлы, которые можно просматривать по командам more filename или less filename , а также с помощью встроенной программы просмотра, включенной в оболочку Midnight Commander. Просмотр этих файлов был для меня основным источником получения информации при освоении Linux (а, значит, и при подготовке данной книги). Начните с Red Hat Reference Guide (/doc/ref-guide на компакт-диске). Особенно стоит обратить внимание на главы Package Management with RPM и System Administration. Также полезно прочесть cодержимое /usr/doc/initscripts-x.xx. К сожалению, большая часть этой документации написана на английском языке, но я надеюсь, что со временем с русифицированными дистрибутивами эта документация будет поставляться на русском.

Большинство пакетов программного обеспечения поставляются разработчиками с обширной документацией по установке и использованию этих пакетов. Если пакет представлен в формате rpm (а дистрибутивы Red Hat Linux и его клонов типа Black Cat поставляются в этом формате), то эта документация будет развернута в соответствующих подкаталогах каталога /usr/doc. Имена этих подкаталогов соответствуют названию пакета и версии ПО. Например, для графической оболочки KDE версии 1.1.1 создается подкаталог KDE-1.1.1.

Иногда в поиске нужного файла документации может помочь команда locate . Команда locate в некотором смысле аналогична командам whatis и apropos . По этой команде производится поиск всех файлов, имена которых содержат заданный шаблон. Например, по команде locate net будет найдена масса имен файлов, в названиях которых встречается подстрока «net». В шаблоне могут применяться метасимволы *, ? , [] . Однако команда locate производит поиск не по каталогам файловой системы, а в специально созданной базе имен файлов, которую надо вначале создать (и иногда обновлять) командой updatedb .

В некоторых дистрибутивах (например, в ALTLinux) вместо locate имеется команда slocate , которая сама создает для себя базу имен файлов (после запуска с соответствующим параметром) .

3.6.6. Команда Xman

В 6-ой версии дистрибутива Red Hat Linux была включена программа, которая позволяет просмотреть страницы руководства man при работе в графическом режиме. Поиск и вывод на экран страниц руководства вызывается посредством щелчков по кнопкам и меню. В остальном (по выдаваемой информации) Xman аналогична команде man .

3.6.7. Команда helptool

По команде helptool появляется графическое окно, имеющее строку ввода, в которой вы сможете задать интересующий вас термин. Команда просматривает все файлы документов (вы можете сконфигурировать, какие документы следует просматривать при поиске). По завершению поиска вам будет выдан список файлов, где встречается данный термин. Если кликнуть мышкой на элементе списка, то появится дополнительное окно, в котором будет отображаться выбранный вами файл. При этом файл будет отображаться в том формате, в котором он хранится на вашей машине: страницы info , страницы man и др.

3.6.8. Книги и Интернет

Естественно, что осваивать Linux проще и легче, если под рукой имеется хорошая книга. Прежде всего почитайте руководство к своему дистрибутиву (если таковое есть). Несколько наиболее полезных, на мой взгляд, книг указаны в Приложении «Источники и ссылки на дополнительные материалы». И, конечно, если у вас есть выход в Интернет, то вы можете найти ответ на любой из возникающих вопросов. Просмотрите Приложение [П2] для того, чтобы выбрать начальные точки путешествия по этому безбрежному океану информации. А дальше . остается пожелать вам удачи в ваших поисках.

Если проблемы возникают еще при установке, можно обратиться в службу поддержки производителя дистрибутива (если дистрибутив не пиратский, на нем как правило указываются координаты этой службы), на которую можно выйти через Web -сайт производителя. Учтите, что в случае, если у вас пиратский дистрибутив, причина проблем может быть в том, что он «криво» записан на компакт-диск.

Используйте возможности электронной почты. Полезно подписаться на некоторые списки рассылки (эхо-конференции). Например, чтобы подписаться на список рассылки по дистрибутиву Black Cat Linux надо отправить письмо, содержащее «subscribe blackcat-list», по адресу majordomo@geon.donetsk.ua. Правда, чтение всех писем требует очень большого времени, так как придется читать множество вопросов начинающих пользователей (например, «Что такое консоль?»), а также многочисленные ответы на них от тех, кто хоть кто-то знает. Поэтому можно просто просматривать с помощью браузера архив списка рассылки: может быть, кто-то уже задавал тот вопрос, ответ на который вы ищете. Весьма вероятно, что ваша проблема уже обсуждалась — если это так, то вы получите более быстрый и полный ответ, вовсе не написав письмо в конференцию.

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

Если вы задаете вопрос, связанный с вашей конкретной системой, всегда включайте как можно больше деталей — какой дистрибутив, какая версия дистрибутива, какая версия ядра, с какими именно железками у вас проблемы (опять же версии, надписи на микросхемах), какие сообщения выдает система или запускаемая программа, и т. д.. Только старайтесь не требовать, чтобы ответ на вопрос был прислан непосредственно на ваш электронный адрес. Как заметил Виктор Вагнер, «написание писем в эху есть самовыражение, написание писем нетмейлом есть техническая поддержка. Первое бесплатно, второе платно.» Подумайте об этом !

Источник

Фундаментальные основы Linux. Часть II: Первые шаги в изучении интерфейса командной строки

Оригинал:

Linux Fundamentals

Автор: Paul Cobbaut

Дата публикации: 16 октября 2014 г.

Перевод: А.Панин

Дата перевода: 11 декабря 2014 г.

В данной главе описывается методика использования man-страниц (также называемых страницами руководств) при работе с вашим компьютером под управлением Unix или Linux.

Вы узнаете о том, как использовать команду man, а также такие связанные с ней команды, как whereis, whatis и mandb.

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

Команда man $команда

paul@laika:~$ man whois
Форматирование страницы whois(1), подождите...

Команда man $имя_файла_конфигурации

paul@laika:~$ man syslog.conf
Форматирование страницы syslog.conf(5), подождите...

Команда man $демон

paul@laika:~$ man syslogd
Форматирование страницы syslogd(8), подождите...

Команда man -k (apropos)

paul@laika:~$ man -k syslog
lm-syslog-setup (8)  - configure laptop mode to switch syslog.conf ...
logger (1)           - a shell command interface to the syslog(3) ...
syslog-facility (8)  - Setup and remove LOCALx facility for sysklogd
syslog.conf (5)      - syslogd(8) configuration file
syslogd (8)          - Linux system logging utilities.
syslogd-listfiles (8) - list system logfiles

Команда whatis

paul@u810:~$ whatis route
route (8)            - show / manipulate the IP routing table

Команда whereis

paul@laika:~$ whereis -m whois
whois: /usr/share/man/man1/whois.1.gz

paul@laika:~$ man /usr/share/man/man1/whois.1.gz

Номера справочных разделов

1 Исполняемые программы или команды оболочки (shell) 
2 Системные вызовы (функции, предоставляемые ядром) 
3 Библиотечные вызовы (функции, предоставляемые программными библиотеками) 
4 Специальные файлы (обычно находящиеся в каталоге /dev) 
5 Форматы файлов и соглашения, например о /etc/passwd 
6 Игры 
7 Разное (включает пакеты макросов и соглашения), например man(7), groff(7) 
8 Команды администрирования системы (обычно, запускаемые только суперпользователем) 
9 Процедуры ядра [нестандартный раздел]

Команда man $раздел $файл

[paul@RHEL52 ~]$ man passwd      # открывает первую найденную страницу руководства
[paul@RHEL52 ~]$ man 5 passwd    # открывает страницу руководства из раздела 5

Команда man man

Если вы желаете узнать больше о команде man, прочитайте это замечательное руководство (Read The Fantastic Manual — RTFM).

paul@laika:~$ man woman
Нет справочной страницы для woman

Утилита mandb

root@laika:~# mandb
В 0 man-подкаталогах содержатся более новые справочные страницы. 
Добавлено 0 справочных страниц. 
Добавлено 0 побочных cat-страниц. 
Вычищено 0 старых записей базы данных.

[root@centos65 ~]# apropos scsi
scsi: ничего подходящего не найдено.
[root@centos65 ~]# makewhatis 
[root@centos65 ~]# apropos scsi
hpsa                 (4)  - HP Smart Array SCSI driver
lsscsi               (8)  - list SCSI devices (or hosts) and their attributes
sd                   (4)  - Driver for SCSI Disk Drives
st                   (4)  - SCSI tape device

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

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

Используйте параметры команды -h или —help

Если вы не знаете, как использовать команду, т.е. не знаете ее параметров, типа возврата и т.д., вы можете воспользоваться командой -h или -help.

Как использовать -h или -help?

Запустите терминал, нажав Ctrl+Alt+T или просто щелкните на значке терминала на панели задач. Просто введите в терминале команду, использование которой вам нужно узнать, с -h или -help после пробела и нажмите Enter. И вы получите полную информацию об использовании этой команды, как показано ниже.

Использование завершения табуляции в оболочке Shell

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

Запустите терминал, нажав Ctrl+Alt+T или просто щелкните по значку терминала на панели задач. Просто введите известное вам имя команды в терминале, а затем дважды нажмите tab, как показано ниже.

Неизвестные команды

Если вы хотите использовать команду, но не знаете, установлена ли она в Ubuntu или нет, или, если она существует, вы не знаете пакет, содержащий ее, даже тогда вы можете использовать эту команду.

Запустите терминал, нажав Ctrl+ Alt+ T или просто щелкните по значку терминала на панели задач. В любом случае просто введите команду в терминале и нажмите Enter. Терминал сообщит вам, установлена она или нет, а если установлена, то в каком пакете она находится. Это показано ниже.

Команда help

Это команда, которая используется для перечисления всех возможных команд, предустановленных в Ubuntu.

Запустите терминал, нажав Ctrl+Alt+T или просто щелкните по значку терминала на панели задач. Просто введите help в терминале и нажмите клавишу Enter. Это показано ниже.

Команда man или страницы man

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

Запустите терминал, нажав Ctrl+ Alt+ T или просто щелкните по значку терминала на панели задач. В терминале напишите man и через пробел напишите имя команды, руководство по которой вы хотите получить, и нажмите Enter. Эта команда работает, как показано ниже.

Пример: Выполните команду

чтобы получить подробную справку по оболочке Linux bash.

Команда info

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

Запустите терминал, нажав Ctrl+Alt+T или просто щелкните по значку терминала на панели задач. В терминале наберите info и через пробел введите название команды, руководство по которой не существует, и нажмите Enter. Это показано ниже.

Пример:

Команда apropos

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

Запустите терминал, нажав Ctrl+ Alt+ T или просто щелкните по значку терминала на панели задач. Наберите в терминале apropos и после пробела введите имя команды, соответствующие man-страницы которой вы хотите найти, и нажмите Enter. Это показано ниже.

Команда whatis

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

Запустите терминал, нажав Ctrl+Alt+T или просто щелкните по значку терминала на панели задач. Просто введите whatis в терминале и после пробела введите имя команды, однострочное описание которой вам нужно, а затем нажмите enter.

Это показано ниже.

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