Come creare una manpage?

29

Sto impacchettando un programma per Ubuntu, e sto ricevendo un avviso di lintian che dice che il mio binario ha bisogno di una manpage.

Come si fa a creare una manpage per un programma?

manpage

— trampster
fonte

23

Con l'aiuto di Gmanedit sei in grado di creare manpage con una GUI grafica.

Gtk + Manpages Editor è un editor per le pagine man che gira su X con GTK +.

Gmanedit è un'applicazione che ti permette di modificare pagine di manuale (man) su sistemi Linux / Unix.

È come gli editor HTML più comuni ma più semplice. Devi conoscere il formato delle pagine man.

inserisci qui la descrizione dell'immagine

Secondo il programma utente Debian FHS, le manpage sono memorizzate in usr/share/man/man1o usr/local/share/man/man1.

Dopo aver modificato le manpage può essere saggio aggiornare il database delle manpage eseguendolo mandbin un terminale.

I dettagli sulla sintassi della manpage sono riassunti nella manpage per man .

— Takkat
fonte

Certo, hai ragione. Stavo per cambiarlo, ma non appena ho visto MarcoCeppi lì non volevo modificarlo. : D

— Lucio

@Lucio lol - che risale a un tempo fa, quando non c'erano ancora apps.ubuntu;)

— Takkat

3

Puoi scrivere manpage in docbook / refentry, un formato di documentazione 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>
    :

e quindi convertire i risultati nel formato man usando

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

HTML con

docbook2html docbook2html

e così via. Questo non è il modo più semplice per scrivere una manpage, ma se hai già scritto XML prima di conoscere già la sintassi, è solo una questione di apprendimento dei tag da usare.

— JJG
fonte

2

Fai un giro, l'ho appena caricato, scrivo un numero di app e ho avuto problemi con un editor di manpage decente

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

Questa è un'app gtk2 con una scheda separata per ogni sezione che importa l'anteprima e l'esportazione delle pagine man sono tutte supportate, nessun comando di formattazione esoterica, questo è ancora in fase di sviluppo ma è sicuramente abbastanza stabile da usare.

— Tony Duncun
fonte

1

Quell'applicazione sembra interessante. Potresti fornire un po 'più di dettagli, qui, di un semplice link?

— Kevin Bowen,

Questa è un'app gtk2 con una scheda separata per ogni sezione che importa l'anteprima e l'esportazione delle pagine man sono tutte supportate, nessun comando di formattazione esoterica, questo è ancora in fase di sviluppo ma è sicuramente abbastanza stabile da usare.

— Tony Duncun,

0

Puoi farlo con gli autotools. GNU ha pubblicato un esempio in cui un progetto C installa una manpage con autotools.

— Niklas Rosencrantz
fonte