Linux Fundamentals Part 3 / Основы Linux от основателя Gentoo. Часть 3: System and network documentation

Типы системной документации в Linux

VBart 13.11.10 в 20:00

Существует три основных источника документации в Linux системах: страницы руководств (маны), info-страницы и поставляемая с приложениями документация в /usr/share/doc. В этом разделе мы рассмотрим каждый из этих источников, перед тем, как обращаться во внешний мир за дополнительной информацией.

VBart 13.11.10 в 20:07

Страницы руководств

Страницы руководств, или “man (от англ. manual — руководство) страницы”, ман-страницы, далее просто маны — это классическая форма справочной документации UNIX и Linux. В идеале, вы можете найти ман для любой команды, конфигурационного файла или библиотеки. Однако, на практике, Linux это бесплатное программное обеспечение и некоторые страницы руководств не были написаны или устарели. Тем не менее, маны остаются первым местом, куда следует обращаться за помощью.

Rich 13.11.10 в 20:31

Для доступа к ману просто введите man, а затем ваш запрос. Запустится программа-пейджер (просмотрщик, обычно less или more) со справочной информацией. Для того, чтобы закрыть её, нажмите клавишу q. Например, чтобы посмотреть информацию о команде ls, введите:

Rich 13.11.10 в 20:36

$ man ls

Rich 13.11.10 в 20:36

Знание схемы мана поможет быстро перемещаться к необходимой вам информации. Обычно, вы сможете найти следующие разделы в мане:
ИМЯ Имя и однострочное описание команды
СИНОПСИС Как использовать команду
ОПИСАНИЕ Углублённое описание функционала команды
ПРИМЕРЫ Советы как использовать команду
СМ. ТАКЖЕ Связаные темы (обычно также ман-страницы)

Rich 13.11.10 в 20:43

Файлы, содержащие информацию манов хранятся в /usr/share/man (или в /usr/man на некоторых старых системах). В этой директории вы найдёте страницы руководств, упорядоченные по следующим секциям:

man1 Пользовательские программы
man2 Системные вызовы
man3 Библиотечные функции
man4 Специальные файлы
man5 Форматы файлов
man6 Игры
man7 Другое

Множественные ман-страницы

Rich 13.11.10 в 21:24

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

Rich 13.11.10 в 21:26

$ whatis printf
printf (1) - format and print data
printf (3) - formatted output conversion

Rich 13.11.10 в 20:49

В данном случае, man printf сначала обратиться к странице в секции 1 («Пользовательские программы»). Если мы пишем программу на языке C, нас может заинтересовать страница из секции 3 («Библиотечные функции»). Вы можете вызывать ман необходимой секции указав это в командной строке, т.н. для вызова printf(3) мы введём:

Rich 13.11.10 в 21:29

$ man 3 printf

Rich 13.11.10 в 20:49

Поиск нужного мана

VBart 13.11.10 в 20:10

Иногда сложно найти правильную ман-страницу по заданной теме. В этом случае вы можете использовать man -k для поиска в разделе ИМЯ ман-страницы. Будьте осторожны: man -k осуществляет поиск по подстроке, так что выведется много информации! Вот пример использования уточняющего запроса:

Rich 13.11.10 в 21:35

$ man -k whatis
apropos (1) - search the whatis database for strings
makewhatis (8) - Create the whatis database
whatis (1) - search the whatis database for complete words

Rich 13.11.10 в 21:36

Всё об "apropos"

VBart 13.11.10 в 20:13

Предыдущий пример переносит на на несколько моментов вперёд. Во-первых, команда apropos полностью соответствует команде man -k (Вообще-то, я посвящу вас в небольшой секрет. Когда вы запускаете man -k, в самом деле «за кулисами» стартует apropos). Во-вторых, существует команда makewhatis, которая сканирует все страницы в вашей Linux системе и составляет базу данных команду для whatis и apropos. Она запускается периодически планировщиком из-под рута, чтобы поддерживать базу данных свежей:

Rich 13.11.10 в 21:49

# makewhatis

Rich 13.11.10 в 20:49

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

Rich 13.11.10 в 21:50

$ man man

Rich 13.11.10 в 20:49

MANPATH

REx07 13.11.10 в 21:41

По умолчанию, программа man будет искать man-страницы в /usr/share/man, /usr/local/man, /usr/X11R6/man, и быть может в /opt/man. Возможно, вы захотите добавить новый пункт в этом пути поиска. Для этого, просто откройте /etc/man.conf в текстовом редакторе и добавьте нужный путь. Например:

REx07 13.11.10 в 22:16

MANPATH /opt/man

Rich 13.11.10 в 20:48

С этого момента, страницы руководств /opt/man/man* также будут в пути поиска команды man. Помните, что вам необходимо запустить makewhatis, чтобы добавить новые маны в базу whatis.

REx07 13.11.10 в 22:22

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

kindacute 13.11.10 в 23:06

$ info

VBart 13.11.10 в 21:05

Простой вызов команды info даст список доступных info-страниц в вашей системе. Вы можете перемещаться по нему используя стрелки, переходить по ссылкам (которые обозначены звездочкой) с помощью Enter и выйти по клавише q. Навигация основана на таковой в Emacs, так что если вы знакомы с этим редактором, вам будет легко освоиться. Чтобы познакомиться с Emacs, посмотрите руководства на developerWorks, "Living in Emacs".

REx07 13.11.10 в 23:26

Вы также можете указать название инфо страницы в командной строке:

kindacute 13.11.10 в 23:17

$ info diff

Rich 13.11.10 в 20:48

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

kindacute 13.11.10 в 23:20

$ info info

Rich 13.11.10 в 20:48

/usr/share/doc

Rich 13.11.10 в 20:48

Есть последний источник помощи в вашей системе Linux. Большинство программ поставляются с дополнительной документацией в других форматах, таких как: текст, PDF, PostScript, HTML. Посмотрите в каталог usr/share/doc (или /usr/doc на более старых системах). Вы найдете длинный список директорий, каждая из которых идет с определенным приложением на вашей системе. Поиск в этой документации может привести вас к очень ценной информации которая не доступна в страницах руководств или инфо страницах, такой как учебники или дополнительной технической документации. Беглый взгляд указывает на то что здесь очень много материала для чтения:

kindacute 13.11.10 в 23:41

$ cd /usr/share/doc
$ find . -type f | wc -l
7582

Rich 13.11.10 в 20:48

Фьюу! Вашим домашним заданием на этот вечер будет прочитать половину (3791) этих документов. Завтра будет викторина. ;-)
Linux Documentation Project

kindacute 13.11.10 в 23:23

В дополнение к системной документации, в интернете существует ряд отличных ресурсов посвященных Linux. "Linux Documentation Project" (LDP) - это группа добровольцев, которые занимаются составлением полного набора свободной документации по Linux. Данный проект существует чтобы собрать различные части документации по Linux в определенным месте, где её будет легко искать и использовать.

Обзор LDP

VBart 13.11.10 в 22:47

LDP применяется в следующих областях:

kindacute 13.11.10 в 23:09

* Guides - большие, очень серьезные тексты, как например The Linux Programmer's Guide
* HOWTOs - руководства по конкретной теме, такие как DSL HOWTO
* FAQs - Часто задаваемые вопросы с ответами. Пример - Brief Linux FAQ
* Man страницы - помощь по конкретной команде (это те же самые маны, что вы видите на вашей системе, когда используете команду man).

REx07 13.11.10 в 23:42

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

kindacute 13.11.10 в 23:08

LDP дополнительно предоставляет доступ к списку ссылок и ресурсов, таких как Linux Gazette (смотрите ссылки в Ресурсах) и Linux Weekly News, к списку почтовых рассылок и архивов новостей.
Почтовые рассылки

kindacute 13.11.10 в 23:34

Списки рассылки являются, вероятно, самым важным средством взаимодействия разработчиков Linux. Зачастую проекты разрабатываются участниками живущими на большом расстоянии друг от друга, возможно даже на противоположных сторонах земного шара. Списки рассылки представляют метод взаимодействия, в котором каждый разработчик проекта может связаться со всеми остальными и вместе дискутировать посредством электронной почты. Один из самых известных списков рассылки разработчиков, это Linux Kernel Mailing List (список рассылки ядра Linux).

Еще о списках рассылки

VBart 14.11.10 в 00:22

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

VBart 14.11.10 в 00:34

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

kindacute 13.11.10 в 23:30

Ньюсгруппы, похожи на списки рассылки, но основаны на другом протоколе, который называется NNTP (Сетевой протокол передачи новостей), а не на использовании e-mail'a. Чтобы иметь возможность общаться, вам придется установить NTTP клиент, например slrn или pan. Основным преимуществом является тот факт, что вы можете принять участие в дискуссии, когда вам это нужно, а не постоянно смотреть как она ломится в ваш почтовый ящик :-)

REx07 13.11.10 в 23:55

Ньюсгруппа которая представляет наибольший интерес это comp.os.linux. Вы можете просмотреть весь список групп на сайте LDP.

Сайты поставщиков и сторонние сайты.

REx07 13.11.10 в 23:49

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

VBart 13.11.10 в 23:45

* Redhat Linux
* Debian Linux
* Gentoo Linux
* SuSE Linux
* Caldera
* Turbolinux

Rich 13.11.10 в 20:48

Поставщики аппаратного и программного обеспечения

VBart 13.11.10 в 20:12

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

kindacute 13.11.10 в 23:14

* IBM и Linux
* HP и Linux
* Sun и Linux
* Oracle и Linux.

Rich 13.11.10 в 20:48