Рис. 9.2.
hoc(1
)
Упражнение 9.8.
Напишите справочник для
doctype
. Напишите версию команды man, которая отыскивает документацию по вашим личным программам в вашем собственном каталоге
man
.
9.5 Дополнительные средства для подготовки документации
Для подготовки документации существует несколько дополнительных программ. Команда
refer(1)
отыскивает ссылки на ключевые слова, вставляет эти ссылки в строки вашего документа и помещает раздел ссылок в его конце. Определив соответствующую макрокоманду, вы можете добиться, чтобы
refer
печатала ссылки в том виде, в каком они вам нужны. Имеются определения для многих журналов по вычислительным наукам. Команда
refer
является частью седьмой версии, но не включена в некоторые другие версии.
Программы
pic(1)
и
ideal(1)
предназначены для подготовки рисунков, так же как
eqn
для уравнений. Подготовить рисунки значительно сложнее, чем уравнения (по крайней мере для набора), а поскольку традиции здесь отсутствуют, оба языка отчасти облегчают знакомство с этой техникой и ее использование. В качестве иллюстрации приведем простой рисунок и его выражение на
pic
.
.PS
.ps -1
box invis "document"; arrow
box dashed "pie"; arrow
box dashed "tbl";
arrow box dashed "eqn"; arrow
box "troff"; arrow
box invis "typesetter"
[ box invis "macro" "package"
spline right then up -> ] with .ne at 2nd last box.s
.ps +1
.PE
+-----+ +-----+ +-----+ +-------+
| | | | | | | |
документ->| pic |->| tbl |->| eqn |->| troff |->наборн. устр-во
| | | | | | | |
+-----+ +-----+ +-----+ +-------+
^
|
пакет макрокоманд ------+
Все рисунки в книге сделаны с помощью
pic
. Программы
pic
и
ideal
не являются частью седьмой версии, но сейчас они в нее включены.
Программы
refer
,
pic
и
ideal
представляют собой препроцессоры
troff
. Кроме того, в вашей документации есть программы для просмотра и комментирования текста. Наилучшая из известных программ —
spell(1)
, которая выдает сообщения о возможных ошибках написания в файлах; мы ее здесь применяли. Программы
style(1)
и
diction(1)
анализируют пунктуацию, грамматику и использование языка. Со временем все они были превращены в "Рабочее место писателя" набор программ, помогающих улучшить стиль изложения. Эти программы полезны для обнаружения клише и слов, не являющихся необходимыми, а также некорректных фраз.
Программа
spell
считается стандартной. В вашей системе могут быть и другие программы, вы легко обнаружите их с помощью
man
:
$ man style diction wwb
или путем просмотра
/bin
и
/usr/bin
.
Историческая и библиографическая справка
Программа
troff
(ее автор — Дж. Осанна), предназначенная для графических систем CAT-4, имеет свою историю, восходя к
RUNOFF
, созданной Д. E. Зальтцером для CTSS в MIT в начале 60-х годов. Обе программы имеют общие цели и основной синтаксис команд, хотя
troff
, конечно, более сложная и мощная программа, а наличие
eqn
и других препроцессоров значительно повышает ее эффективность. Существует несколько новых программ для наборных устройств с более "цивилизованным" форматом входного текста; наиболее известны из них
ТЕХ
Д. Кнута ("ТЕХ and Metafont: New Direction in Typesetting", Digital Press, 1979) и
Scribe
Б. Рейда ("Scribe: a high level approach to computer document formatting". 7th Symposium on the Principles of Programming Languages, 1980).
Статья Фурута, Дж. Скофилда и А. Шоу "Document Formatting Systems: Survey, Concepts and Issues" (Computing Surveys, 1982) дает хороший обзор таких систем.
Представляет интерес оригинальная работа по
eqn
Б. Кернигана и Л. Черри "A system for typesetting mathematics" (CACM, March 1975). Пакеты макрокоманд
ms
,
tbl
и
refer
принадлежат M. Леску; они документированы только в справочном руководстве по UNIX (том 2А).
Препроцессор
pic
описан в статье Б. Кернигана "PIC a language for typesetting graphics" (Software Practice and Experience, January, 1982), препроцессор
ideal
в статье К Ван Вика "A high level language for describing pictures" (ACM Translation on Graphics, April, 1982).
Команда
spell
из файла
shell
, написанного С. Джонсоном, превратилась в Си-программу Д. МакИлроя. Программа
spell
из седьмого издания для быстрого поиска использует механизм хеширования и правила для автоматического отделения суффиксов и префиксов, чтобы уменьшить занимаемое словарем место. (См.: McIlroy. М. D. "Development of a spelling list". IEEE Transaction on Communications, January, 1982).
Программы
style
и
diction
описаны в работе Л. Черри "Computer aids for writers" (SYGPLAN Symposium on Text Manipulation, Portland, Oregon, June, 1981).
Глава 10
Эпилог
Операционной системе UNIX уже более десяти лет, а число использующих ее вычислительных машин растет сейчас быстрее, чем когда-либо. Для системы, сконструированной без коммерческих целей или даже намерений, это уникальный успех.
