Основы программирования в Linux
вернуться

Мэтью Нейл
Шрифт:

Вы сможете сгенерировать собственное интерактивное руководство, изменив приведенную страницу и изучив исходный код других страниц. Можно также посмотреть в архиве на Web-странице http://www.tldp.org/ часть Linux Documentation Project (Проект документирования Linux) "Linux Man Page mini-HowTo" ("Краткое руководство по написанию страниц интерактивного руководства в Linux"), написанную Дженс Швейкхардт (Jens Schweikhardt).

Имея исходный текст страницы справочного руководства, можно обработать его утилитой

groff
. Команда
groff
обычно формирует текст ASCII (
– Tascii
) или выходной файл PostScript (
– Tps
). С помощью опции
– man
сообщите
groff
, что это страница интерактивного справочного руководства, и будут загружены специальные макроопределения, относящиеся к страницам интерактивного руководства.

$ groff -Tascii -man myapp.1

У этой команды следующий вывод.

MYAPP(1) MYAPP(1)

NAME

Myapp — A simple demonstration application that does very

little.

SYNOPSIS

myapp [-option ...]

DESCRIPTION

myapp is a complete application that does nothing useful.

It was written for demonstration purposes.

OPTIONS

It doesn't have any, but let's pretend, to make this temp-

late complete:

– option

If there was an option, it would not be -option.

RESOURCES

myapp uses almost no resources.

DIAGNOSTICS

The program shouldn't output anything, so if you find it

doing so there's probably something wrong. The return

value is zero.

SEE ALSO

The only other program we know with this little func-

tionality is the ubiquitous Hello World application.

COPYRIGHT

myapp is Copyright (c) 2007 Wiley Publishing, Inc.

This program is free software; you can redistribute it

and/or modify it under the terms of the GNU General Public

License as published by the Free Software Foundation;

either version 2 of the License, or (at your option) any

later version.

This program is distributed in the hope that it will be

useful, but WITHOUT ANY WARRANTY; without even the implied

warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR

PURPOSE. See the GNU General Public License for more

details.

1

MYAPP(1) MYAPP(1)

You should have received a copy of the GNU General Public

License along with this program; if not, write to the Free

Software Foundation, Inc., 59 Temple Place — Suite 330

Boston, MA 02111-1307, USA

BUGS

There probably are some, but we don't know what they are yet.

AUTHORS

Neil Matthew and Rick Stones

Теперь, когда интерактивное руководство протестировано, необходимо указать для него исходный файл. Команда

man
, показывающая страницы руководства, использует переменную окружения
MANPATH
для поиска нужных страниц. Вы можете поместить новую страницу в каталог локальных страниц интерактивного руководства или прямо в системный каталог /usr/man/man1.

Когда кто-нибудь в первый раз запросит эту страницу интерактивного справочного руководства, команда

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