Comment créer une page de manuel?
Je prépare un programme pour Ubuntu, et je reçois un avertissement lintian disant que mon binaire a besoin d’une page de manuel.
Comment créer une page de manuel pour un programme?
Avec l'aide de Gmanedit vous pouvez créer des pages de manuel avec une interface graphique.
Gtk + Manpages Editor est un éditeur de pages de manuel fonctionnant sous X avec GTK +.
Gmanedit est une application qui vous permet d’éditer des pages de manuel (man) sur des systèmes Linux/Unix.
C'est comme la plupart des éditeurs HTML courants mais plus facile. Vous devez connaître le format des pages de manuel.
Selon le Debian FHS , les pages de manuel du programme utilisateur sont stockées dans usr/share/man/man1 ou usr/local/share/man/man1.
Après avoir modifié les pages de manuel, il peut être judicieux de mettre à jour la base de données en exécutant mandb dans un terminal.
Les détails sur la syntaxe de la page de manuel sont résumés dans la page de manuel pour man .
Vous pouvez écrire des pages de manuel dans docbook/refentry, un format de documentation 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>
:
puis convertissez les résultats au format man en utilisant
xsltproc /path/to/docbook.xsl vfplot.xml
en HTML avec
docbook2html docbook2html
etc. Ce n’est pas la façon la plus simple d’écrire une page de manuel, mais si vous avez déjà écrit XML, vous en connaissez déjà la syntaxe, il vous suffit d’apprendre les balises à utiliser.
Donnez-moi un tourbillon. Je viens de le télécharger. J'écris un certain nombre d'applications et des problèmes avec un bon éditeur de pages de manuel.
http://gtk-apps.org/content/show.php/Man+Page+Editor+?content=160219
Il s’agit d’une application gtk2 avec un onglet distinct pour chaque section. L’importation des pages de manuel; la prévisualisation et l’exportation sont toutes prises en charge, aucune commande de formatage ésotérique n’est en cours de développement, mais elle est suffisamment stable pour être utilisée.
Vous pouvez le faire avec autotools. GNU a publié un exemple dans lequel un projet C installe une page de manuel avec autotools.