Как создать справочную страницу?

29

Я упаковываю программу для Ubuntu, и я получаю предупреждение от Lintian о том, что моему бинарному файлу нужна man-страница.

Как можно создать справочную страницу для программы?

manpage

— trampster
источник

23

С помощью Gmanedit вы можете создавать страницы с графическим интерфейсом.

Gtk + Manpages Editor - это редактор для man-страниц, который работает на X с GTK +.

Gmanedit - это приложение, которое позволяет редактировать справочные страницы (man) в системах Linux / Unix.

Это похоже на большинство обычных HTML-редакторов, но более простое. Вам нужно знать формат manpages.

введите описание изображения здесь

Согласно пользовательской программе Debian FHS, страницы страниц хранятся в usr/share/man/man1или usr/local/share/man/man1.

После изменения man-страниц может быть целесообразно обновить базу данных man-страниц, запустив ее mandbв терминале.

Подробности о синтаксисе man-страницы приведены в man-странице для man .

— Takkat
источник

Конечно, ты прав. Я собирался изменить это, но как только я увидел MarcoCeppi там, я не хотел изменять это. : D

— Lucio

@Lucio lol - это было в далеком прошлом, когда еще не было apps.ubuntu;)

— Таккат

3

Вы можете написать man-страницы в docbook / refentry, формате документации XML,

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id='vfplot1'>
<refentryinfo><date>1 July 2008</date></refentryinfo>
<refmeta>
<refentrytitle>VFPLOT</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class='date'>1 July 2008</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>vfplot</refname>
<refpurpose>plot vector fields with curved arrows.</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
  <command>vfplot</command>    
  <arg choice='opt'>-a <replaceable>aspect</replaceable></arg>
  <arg choice='opt'>-d <replaceable>file</replaceable></arg>
  <arg choice='opt'>-D <replaceable>pen</replaceable></arg>
    :

а затем преобразовать результаты в формат man, используя

xsltproc /path/to/docbook.xsl vfplot.xml

оповестить

docbook2html docbook2html

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

— JJG
источник

2

Дайте этому повод, я только что загрузил его, я пишу несколько приложений, и у меня были проблемы с приличным редактором manpage

http://gtk-apps.org/content/show.php/Man+Page+Editor+?content=160219

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

— Тони Дункан
источник

1

Это приложение выглядит интересно. Не могли бы вы предоставить здесь немного больше подробностей, чем просто ссылку?

— Кевин Боуэн

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

— Тони Дункан,

0

Вы можете сделать это с помощью автоинструментов. GNU опубликовал пример, где проект C устанавливает man-страницу с автоинструментами.

— Никлас Розенкранц
источник