Информационное наполнение UNIX Выполнил: Котов Кирилл Гр. КСК-22
Общие сведения Информационное наполнение – Описание организации информационной подсистемы UNIX. Рассматривается структура руководств (manpages) и подсистемы info. Вводится алгоритм поиска информации. Оно играет важную роль в семействе UNIX. Руководства сильно облегчат вам настройку ядра.
Обзор утилиты man Данная утилита позволяет увидеть подробное описание какого либо файла или команды. Все страницы руководства отнесены к восьми разделам: 1. пользовательские утилиты и прочие инструменты; 2. системные вызовы; 3. библиотечные вызовы (функции); 4. внешние устройства (и их представление в системе); 5. форматы и таблицы (типы файлов, протоколы и пр. ); 6. игры и всевозможные "ненужные" утилиты (например, fortune ); 7. прочее, т. е. то, что не подходит под другие разделы ; 8. команды и инструменты системного администратора.
Краткое описание Семантическое Первое поле - NAME - содержит только имя объекта и его очень краткое, на одну строку, описание. Синтаксическое Поле SYNOPSIS описывает общий вид использования объекта. Например, в случае утилиты оно представляет собой командную строку со всеми возможными параметрами. Описание Поле DESCRIPTION содержит развернутое описание объекта. Сюда попадает любая разъяснительная информация: принципы работы данной утилиты или функции, назначение и общая структура данного системного файла, описание внешних устройств, соответствующих данному драйверу и т. п. Результат Функция или системный вызов, как правило, возвращают какое-нибудь значение. По окончании работы утилиты вырабатывается так называемый код возврата (или код ошибки, который не равен нулю в случае неудачного завершения работы Использование Иногда использование объекта невозможно или некоторый, на первый взгляд очевидный путь его применения приводит к неочевидным последствиям. Тогда стоит поместить примеры такого рода ситуаций в поле CAVEATS. Небольшие примеры успешного использования объекта с описанием решаемой в них задачи приводятся в поле EXAMPLES, а типичные ошибки при работе с объектом, равно как и недочеты в его реализации, - в поле BUGS.
Утилиты whatis и apropos Обе утилиты хорошо работают в совокупности. Отличие в данных утилитах от утилиты man, это их краткое однострочное название (name) и при поиск какого либо слова в файла, мы увидим только заголовки где они встречаются.
Система info Это гипертекстовая система info(1). Info - часть системы документирования texinfo, разработанной GNU. У texinfo есть масса преимуществ. Во-первых, из texinfo документации можно изготавливать не только info-файлы, но и документы в формате HTML и XML, и даже настоящие книжки в формате Te. X. Во-вторых, формат texinfo более новый, в нем существенно больше средств разметки, индексирования текста, организации таблиц и т. п. В третьих, в отличие от man , info система документирования, в которой на уровне просмотра реализован переход по гипертекстовым ссылкам. Структура: • Меню - это оглавление соответствующего узла, каждый элемент которого ссылается на нижележащий узел. Тексты всех нижележащих узлов меню и самого узла составят весь текст раздела. • Ссылка - один из двух видов гипертекстовых ссылок в info. • Индекс - сводное меню, содержащее ссылки на узлы, в описании которых помечено, что они этому меню принадлежат.
КОНЕЦ