Comment créer une page de manuel?

29

Je compile 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?

manpage

— vagabond
source

23

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 qui s'exécute sur X avec GTK +.

Gmanedit est une application qui vous permet d'éditer des pages de manuel (man) sur les 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.

entrez la description de l'image ici

Selon le programme utilisateur Debian FHS, les pages de manuel sont stockées dans usr/share/man/man1ou 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 de pages de manuel en exécutant mandbdans un terminal.

Les détails de la syntaxe de la page de manuel sont résumés dans la page de manuel de man .

— Takkat
source

Bien sûr, vous avez raison. J'allais le changer, mais dès que j'y ai vu MarcoCeppi , je n'ai pas voulu le modifier. : D

— Lucio

@Lucio lol - c'était à une époque lointaine, quand il n'y avait pas encore d'apps.ubuntu;)

— Takkat

3

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 convertir 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 le moyen le plus simple d'écrire une page de manuel, mais si vous avez déjà écrit du XML auparavant, vous connaissez déjà la syntaxe, il s'agit simplement d'apprendre les balises à utiliser.

— jjg
source

2

Donnez-lui un tourbillon Je viens de le télécharger, j'écris un certain nombre d'applications et j'ai eu des problèmes avec un éditeur de page de manuel décent

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 et la prévisualisation des pages de manuel sont toutes prises en charge, aucune commande de formatage ésotérique, elle est toujours en cours de développement mais est certainement suffisamment stable pour être utilisée.

— Tony Duncun
source

1

Cette application semble intéressante. Pourriez-vous fournir un peu plus de détails, ici, qu'un simple lien?

— Kevin Bowen

Il s'agit d'une application gtk2 avec un onglet distinct pour chaque section. L'importation et la prévisualisation des pages de manuel sont toutes prises en charge, aucune commande de formatage ésotérique, elle est toujours en cours de développement mais est certainement suffisamment stable pour être utilisée.

— Tony Duncun,

0

Vous pouvez le faire avec les outils automatiques. GNU a publié un exemple où un projet C installe une page de manuel avec des outils automatiques.

— Niklas Rosencrantz
source