Comment créer une page de manuel?

28

Je prépare un programme pour Ubuntu, et je reçois un avertissement de Lintian disant que mon fichier binaire a besoin d’une page de manuel.

Comment peut-on créer une page de manuel pour un programme?

    
posée trampster 15.05.2011 - 12:31
la source

4 réponses

22

À 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 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 les pages d’accueil des programmes utilisateurs Debian FHS sont stockées dans usr/share/man/man1 ou usr/local/share/man/man1 .

Après avoir changé les pages de manuel, il peut être judicieux de mettre à jour la base de données de pages de manuel 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 de man .

    
réponse donnée Takkat 15.05.2011 - 12:40
la source
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 convertissez les résultats au format man en utilisant

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

vers HTML avec

docbook2html docbook2html

et ainsi de suite. Ce n’est pas la manière la plus simple d’écrire une page de manuel, mais si vous avez écrit XML avant que vous connaissiez déjà la syntaxe, il est juste une question de apprendre les balises à utiliser.

    
réponse donnée jjg 15.05.2011 - 20:19
la source
2

Donnez-moi un tourbillon que je viens de télécharger Je rédige un certain nombre d'applications et j'ai eu des problèmes avec un éditeur de pages de manuel décent

lien

Il s’agit d’une application gtk2 avec un onglet distinct pour chaque section importation de pages de manuel en prévisualisation et en exportation. Toutes ces fonctions sont prises en charge, aucune commande de formatage ésotérique n’est encore en développement, mais suffisamment stable pour être utilisée.

    
réponse donnée Tony Duncun 29.08.2013 - 21:57
la source
0

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

    
réponse donnée Niklas Rosencrantz 13.08.2017 - 00:50
la source

Lire d'autres questions sur les étiquettes