ОРГАНИЗАЦИЯ СПРАВОЧНОГО РУКОВОДСТВА ПРОГРАММИСТА

Пять секций:

1   команды

2   системные вызовы

3   функции и библиотеки

    3C      библиотеки C и ассемблера

    3S      стандартная библиотека ввода/вывода

    3E      библиотека для работы с форматом ELF

    3G      библиотека общего назначения

    3M      математическая библиотека

    3X      специализированная библиотека

4   форматы файлов

5   остальные средства
                     Формат страницы Руководства

.    ЗАГОЛОВОК (TITLE) - обычно имя библиотечной функции или
системного вызова
.    СЕКЦИЯ (SECTION) - раздел Руководства
.    БИБЛИОТЕКА (LIBRARY) - для секции 3, библиотечных функций, одно
из C, S, M, E, X или G.
.    ИМЯ (NAME) - имя и краткое описание системного вызова или
библиотечной функции (в одной строке)
.    ИСПОЛЬЗОВАНИЕ (SYNOPSIS) - как вызвать системный
вызов/библиотечную функцию.
.    ОПИСАНИЕ (DESCRIPTION) - описывает работу системного вызова или
функции.
.    ВОЗВРАЩАЕМОЕ ЗНАЧЕНИЕ (RETURN VALUE) - как интерпретировать
возвращаемый код.
.    СМ. ТАКЖЕ (SEE ALSO) - страницы Руководства, имеющие отношение к
этой странице.
Кроме того, страница Руководства может содержать разделы:
.    ПРИМЕРЫ (EXAMPLES)
.    ФАЙЛЫ (FILES)
.    СООБЩЕНИЯ (DIAGNOSTICS)
.    ЗАМЕЧАНИЯ (NOTES)
.    (ПРЕДУПРЕЖДЕНИЯ) WARNINGS
.    (ОШИБКИ) BUGS
.    (ПРОБЛЕМЫ) CAVEATS
                     ФОРМАТ СТРАНИЦЫ РУКОВОДСТВА

ЗАГОЛОВОК (СЕКЦИЯ[БИБЛИОТЕКА ДЛЯ 3])

ИМЯ

ИСПОЛЬЗОВАНИЕ

ОПИСАНИЕ

ВОЗВРАЩАЕМОЕ ЗНАЧЕНИЕ

СМ. ТАКЖЕ

ПРИМЕРЫ

ФАЙЛЫ

СООБЩЕНИЯ

ЗАМЕЧАНИЯ

ПРЕДУПРЕЖДЕНИЯ

ОШИБКИ

ПРОБЛЕМЫ
Разделы страницы Руководства
Большая часть информации, необходимой для правильной записи вызова
функции или системного вызова, может быть получена из раздела
ИСПОЛЬЗОВАНИЕ.  В нем перечислены требуемые include-файлы и объявления
функций/системных вызовов. Объявление задает тип возвращаемого
значения и количество и типы параметров. Например, функция имеет
следующее объявление:
          float samplefunc (char * par1, int par2);

где:
.    samplefunc - имя функции.
.    float - тип возвращаемого значения. Это означает, что функция
возвращает действительное число с плавающей точкой.
.    если функция требует параметры, то в описании между скобками
перечисляются типы и имена формальных аргументов. samplefunc требует
два аргумента. Первый должен быть указателем на символ, второй - целым
числом. Имена фактических параметров могут быть любыми.
Замечание: Параметр, объявленный как char *par1 означает, что par1
должен быть инициализированным указателем на строку или адресом
массива символов. Системный вызов или библиотечная функция обычно
помещает по этому адресу какую-либо информацию.
Если функция или системный вызов возвращает указатель и этот указатель
не равен нулю, то по этому указателю может быть получена информация.
Значение указателя обычно является адресом статической переменной или
динамически выделенного буфера в сегменте данных процесса.
Раздел ОПИСАНИЕ описывает, что делает системный вызов или функция, как
используются аргументы и возможные возвращаемые значения.