Как сделать man-страницу для своей программы

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

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

Давайте посмотрим, как быстро создать свою man-страничку, которую потом можно разместить в системе и посмотреть информацию при помощи команды man.

Файл man-странички имеет свой определенный формат.

Первая строка имеет такой вид:

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

e — eqn
g — grap
p — pic
t — tbl
v — vgrind
r — refer

Выберем в качестве препроцессора tbl, тогда первая строчка у нас должна выглядеть так:

Затем нам надо создать заголовок со следующими полями:

— Названием программы и номером раздела, в котором находится страница (будут показаны в первой строке слева и справа и в последней строке справа),
— Датой создания документации (будет показана в самой последней строке посередине)
— Полным названием программы включая версию (будет показано в самой последней строке слева)
— Название, которое будет показано в первой строке man-страницы посередине

Теперь можно указать имена необходимых разделов из этого списка: НАЗВАНИЕ (NAME), СИНТАКСИС (SYNOPSIS), НАСТРОЙКИ (CONFIGURATION), ОПИСАНИЕ (DESCRIPTION), ПАРАМЕТРЫ (OPTIONS), КОД ВЫХОДА (EXIT STATUS), ВОЗВРАЩАЕМОЕ ЗНАЧЕНИЕ (RETURN VALUE), ОШИБКИ (ERRORS), ОКРУЖЕНИЕ (ENVIRONMENT), ФАЙЛЫ (FILES), ВЕРСИИ (VERSIONS), СОГЛАСУЕТСЯ С (CONFORMING TO), ЗАМЕЧАНИЯ (NOTES), ОШИБКИ (BUGS), ПРИМЕР (EXAMPLE), АВТОРЫ (AUTHORS) и СМОТРИТЕ ТАКЖЕ (SEE ALSO).

Названия разделов указываться следующим образом:

Следующее, что нужно сделать — это выделение жирным. Вот как это делается:

\fB — font bold, \fR — font regular

Еще одна команда нам понадобится для пропуска строчки

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

А для возврата обратно на ту же позицию другая команда

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

Теперь переименуем файл в «myprogram.8», поскольку страница будет размещаться в 8 разделе, и сожмем ее программой gzip

И поместим в директорию /usr/share/man/man8. Размещение в нужной директории можно реализовать либо при установке пакета, либо при установке из исходных кодов во время выполнения скрипта make.

И последнее, что нужно сделать — это дать команду

Вы увидите вот такую страничку:

Вот, собственно, и всё. Как видите, получилось очень быстро.

Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *