it-swarm.com.de

Wie erstelle ich eine Manpage?

Ich packe ein Programm für Ubuntu und bekomme eine Lintian-Warnung, die besagt, dass meine Binärdatei eine Manpage benötigt.

Wie erstellt man eine Manpage für ein Programm?

29
trampster

Mit Hilfe von Gmanedit Install gmanedit Sie können Hilfeseiten mit einer grafischen Benutzeroberfläche erstellen.

Der Gtk + Manpages Editor ist ein Editor für Manpages, die mit GTK + auf X ausgeführt werden.

Gmanedit ist eine Anwendung, mit der Sie Manualpages (man) auf Linux/Unix-Systemen bearbeiten können.

Es ist wie die meisten gängigen HTML-Editoren, jedoch einfacher. Sie müssen das Manpages-Format kennen.

enter image description here

Entsprechend dem Debian FHS Benutzerprogramm werden Hilfeseiten in usr/share/man/man1 oder usr/local/share/man/man1 gespeichert.

Nach dem Ändern der Hilfeseiten kann es sinnvoll sein, die Hilfeseitendatenbank durch Ausführen von mandb in einem Terminal zu aktualisieren.

Details zur Manpage-Syntax sind zusammengefasst in der Manpage für man .

23
Takkat

Sie können Hilfeseiten in docbook/refentry, einem XML-Dokumentationsformat, schreiben.

<?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>
    :

und konvertieren Sie dann die Ergebnisse in das MAN-Format mit

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

zu html mit

docbook2html docbook2html

und so weiter. Dies ist nicht der einfachste Weg, eine Manpage zu schreiben. Wenn Sie jedoch zuvor XML geschrieben haben, kennen Sie die Syntax bereits. Sie müssen lediglich die zu verwendenden Tags erlernen.

3
jjg

Probieren Sie es aus, ich habe es gerade hochgeladen. Ich habe eine Reihe von Apps geschrieben und Probleme mit einem anständigen Manpage-Editor

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

Dies ist eine GTK2-App mit einer separaten Registerkarte für jeden Abschnitt. Das Importieren von Hilfeseiten in der Vorschau und das Exportieren werden unterstützt. Es gibt keine esoterischen Formatierungsbefehle. Dies befindet sich noch in der Entwicklung, ist aber mit Sicherheit stabil genug, um es zu verwenden.

2
Tony Duncun

Sie können es mit Autotools tun. GNU hat ein Beispiel veröffentlicht, in dem ein C-Projekt eine Manpage mit Autotools installiert.

0