Книга: Программирование для Linux. Профессиональный подход
11.5. Вместо эпилога
11.5. Вместо эпилога
Планируя распространять программу в Internet, не забудьте написать для нее документацию. Многие люди не осознают, что создать качественную документацию так же трудно и долго, как и написать хорошую программу. Правда, вопрос подготовки документации — тема отдельной книги, поэтому мы лишь укажем, где можно получить информацию по данной теме.
Вероятнее всего, для программы потребуется создать man
-страницу. Это первое место, куда пользователи обращаются за информацией о программе. Страницы интерактивной документации форматируются с помощью классической программы troff
. Чтобы узнать формат troff
-файлов, введите такую команду:
% man troff
Чтобы узнать, как ОС Linux ищет man
-страницы, просмотрите справочную информацию о самой команде man
:
% man man
Можно также подготовить документацию в формате GNU-системы Info. Для получения информацию об этой системе выполните команду
% info info
Для многих Linux-лрограмм имеется также документация в формате простого текста и HTML.
Удачного программирования!
- Диалог вместо эпилога
- Диалог вместо предисловия
- Фокус-группы вместо пудры
- История развития компьютеров (вместо пролога)
- Текстовые форматы и кодировки, или Почему иногда вместо текста я вижу абракадабру?
- На сайтах вместо текста отображается непонятный набор символов
- Можно ли указать использование по умолчанию вместо C:Program Files другого каталога для установки программ?
- Что делать, если вместо русских букв в программах – непонятные символы?
- В полученных письмах вместо текста непонятный набор символов
- Совет 5. Используйте интервальные функции вместо одноэлементных
- Совет 43. Используйте алгоритмы вместо циклов
- 24 Вместо заключения