Операционная система Free BSD

         

Работа с man- страницами


Man-страницы в системах семейства UNIX - это аналог Help- систем в Microsoft Windows.

Man-страницы (их название говорит о том, что эти страницы предназначены для работы с командой man) содержат полное описание отдельных команд, форматов файлов и библиотечных подпрограмм. Обычно они доступны в диалоговом режиме (on-line).

Во всех UNIX-системах man-страницы делятся на разделы. Номера разделов man-страниц и описание их содержимого для ОС FreeBSD приведены ниже:

Команды и прикладные программы пользовательского уровня.

Системные вызовы и коды ошибок ядра.

Библиотечные вызовы.

Драйверы устройств и сетевые протоколы.

Стандартные форматы файлов.

Игры и демонстрационные программы.

Различные файлы и документы.

Команды системного администрирования.

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

Команда man <раздел> <заголовок> вызывает man-страницу из указанного раздела. Так, команда man tty читает man-страницу для команды tty, а команда man 4 tty - man-страницу для последовательного драйвера.

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

setenv MANPATH /home/user/myman:/usr/share/man

в файле .login, .cshrc, .shrc или .profile (эти файлы выполняются при регистрации пользователя в системе в зависимости от shell пользователя) Вашего каталога можно указать команде man провести поиск сначала в иерархии локальных man-страниц, а затем в /usr/share/man.
Версия этой команды в sh или bash будет иметь такой вид:

MANPATH = /home/user/myman:/usr/share/man export MANPATH

Команда man -k <ключевое_слово> печатает список man-страниц, в строке пояснений к которым имеется <ключевое_слово>.

Пример: man -k mail

aliases(5) - aliases file for sendmail biff(1) - be notified if mail arrives and who it is from ctm_smail(1), ctm_rmail(1) - send and receive ctm deltas via mail forward(5) - mail forwarding instructions from(1) - print names of those who have sent mail mail(1) - send and receive mail mail.local(8) - store mail in a mailbox mailaddr(7) - mail addressing description mailq(1) - print the mail queue mailstats(8) - display mail statistics makemap(8) - create database maps for sendmail msgs(1) - system messages and junk mail program newaliases(1) - rebuild the data base for the mail aliases file praliases(8) - display system mail aliases rmail(8) - handle remote mail received via uucp sendmail(8) - an electronic mail transport agent smrsh(8) - restricted shell for sendmail

База данных ключевых слов обычно хранится в файле whatis в корневом каталоге иерархии man-страниц (/usr/share/man). Если в систему вводятся дополнительные man-страницы, то, возможно, потребуется модифицировать этот фал с помощью catman -w.

Наберите man whatis, и Вы увидите:

APROPOS(1) FreeBSD General Commands Manual APROPOS(1) NAME apropos, whatis - search the whatis database SYNOPSIS apropos _k_e_y_w_o_r_d ... whatis _k_e_y_w_o_r_d ... DESCRIPTION apropos searches a set of database files containing short descriptions of system commands for keywords and displays the result on the standard output. whatis displays only complete word matches. RETURN VALUES The apropos utility exits 0 on success, and 1 if no keyword matched. SEE ALSO man(1), makewhatis(1) BSD Jan 15, 1991 1

Теперь посмотрим на вывод команды whatis man:

catman(1) - preformat man pages man(1) - format and display the on-line manual pages man(7) - quick reference guide for the -man macro package manpath(1) - determine user's search path for man pages pod2man(1) - translate embedded Perl pod directives into man pages

Теперь Вы вооружились хорошим средством изучения различной документации в системе. Почаще обращайтесь к man- страницам, и Вы поймете, насколько легче "вгрызаться" в дебри администрирования FreeBSD.


Содержание раздела