Bagaimana cara membuat halaman manual?

Saya mengemas program untuk ubuntu, Dan saya mendapatkan peringatan lintian yang mengatakan bahwa biner saya memerlukan manual.

Bagaimana cara membuat halaman manual untuk suatu program?

Dengan bantuan Gmanedit Anda dapat membuat halaman manual dengan GUI grafis.

Gtk + Manpages Editor adalah editor untuk halaman manual yang berjalan pada X dengan GTK +.

Gmanedit adalah aplikasi yang memungkinkan Anda untuk mengedit halaman manual (man) di sistem Linux / Unix.

Ini seperti editor HTML paling umum tetapi lebih mudah. Anda perlu tahu format manual.

Menurut halaman program pengguna Debian FHS disimpan dalam usr/share/man/man1atau usr/local/share/man/man1.

Setelah mengubah halaman manual, mungkin bijaksana untuk memperbarui basis data halaman manual dengan menjalankan mandbdi terminal.

Detail tentang sintaks halaman manual dirangkum dalam halaman manual untuk man .

Anda dapat menulis halaman manual dalam dokumen / refentry, format dokumentasi 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>
    :

dan kemudian mengonversi hasilnya menjadi format man menggunakan

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

ke html dengan

docbook2html docbook2html

dan seterusnya. Ini bukan cara termudah untuk menulis manual, tetapi jika Anda telah menulis XML sebelumnya maka Anda sudah tahu sintaksnya, itu hanya masalah mempelajari tag untuk digunakan.

Berikan pusaran yang baru saja saya unggah, saya menulis sejumlah aplikasi dan mengalami masalah dengan editor halaman manual yang layak

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

Ini adalah aplikasi gtk2 dengan tab terpisah untuk setiap bagian yang mengimpor pratinjau dan ekspor halaman manual semuanya didukung, tidak ada perintah pemformatan esoterik, ini masih dalam pengembangan tetapi tentu cukup stabil untuk digunakan.

Anda dapat melakukannya dengan autotool. GNU telah menerbitkan contoh di mana proyek C menginstal halaman manual dengan autotool.