Написание портативных справочных страниц
Если я хочу написать man-страницы, переносимые между различными Unix-подобными системами, какой стандарт исходного языка мне следует использовать? Или я могу просто предположить, что GNU troff (groff) доступен везде?
1 ответ
Если вы посмотрите на https://www.troff.org/macros.html, в man
, он перечисляет два руководства для написания man-страниц.
- LINUX MAN-PAGE-HOWTO от Йенса Швейкхардта
- Написание эффективных справочных страниц Ларри Коллар
В общем, они оба рекомендуют избегать использования дополнительных препроцессоров, таких как tbl
, pic
, или же eqn
особенно если вы хотите максимизировать мобильность.
Справочные страницы используют an
макропакет Это было сделано так, когда вы назвали это с -m
опция макроса это показывает как troff -man
, Чтобы найти макросы, определенные an
пакет макросов, вы должны искать файлы, соответствующие либо tmac.an*
(для систем UNIX/BSD) или an*.tmac
(для систем Linux). Например, на RHEL/CentOS это будет:
/usr/share/groff/1.18.1.4/tmac/an.tmac which refers to
/usr/share/groff/1.18.1.4/tmac/andoc.tmac which refers to
/usr/share/groff/1.18.1.4/tmac/an-old.tmac which defines most of the macros
Эти файлы являются частью пакета groff.