¿Cómo crear una página de manual?

29

Estoy empaquetando un programa para ubuntu, y recibo una advertencia lintian que dice que mi binario necesita una página de manual.

¿Cómo se puede crear una página de manual para un programa?

manpage

— vagabundo
fuente

23

Con la ayuda de Gmanedit , puede crear páginas de manual con una GUI gráfica.

Gtk + Manpages Editor es un editor para páginas man que se ejecuta en X con GTK +.

Gmanedit es una aplicación que le permite editar páginas de manual (man) en sistemas Linux / Unix.

Es como los editores HTML más comunes pero más fácil. Necesita saber el formato de las páginas de manual.

ingrese la descripción de la imagen aquí

Según el programa de usuario de Debian FHS, las páginas de manual se almacenan en usr/share/man/man1o usr/local/share/man/man1.

Después de cambiar las páginas de manual, puede ser conveniente actualizar la base de datos de la página de manual ejecutándose mandben un terminal.

Los detalles sobre la sintaxis de la página de manual se resumen en la página de manual de man .

— Takkat
fuente

Claro, tienes razón. Iba a cambiarlo, pero tan pronto como vi a MarcoCeppi allí, no quise modificarlo. : D

— Lucio

@Lucio lol: eso fue desde hace mucho tiempo, cuando aún no había apps.ubuntu;)

— Takkat

3

Puede escribir páginas de manual en docbook / refentry, un formato de documentación 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>
    :

y luego convertir los resultados al formato man usando

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

html con

docbook2html docbook2html

y así. Esta no es la forma más fácil de escribir una página de manual, pero si ya has escrito XML antes de eso, ya conoces la sintaxis, solo es cuestión de aprender a usar las etiquetas.

— jjg
fuente

2

Dale un giro a esto. Lo acabo de subir. Escribo varias aplicaciones y he tenido problemas con un editor de páginas de manual decente.

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

Esta es una aplicación gtk2 con una pestaña separada para cada sección, la importación de páginas de manual, la vista previa y la exportación son compatibles, no hay comandos de formato esotérico, esto todavía está en desarrollo, pero ciertamente es lo suficientemente estable como para usar.

— Tony Duncun
fuente

1

Esa aplicación se ve interesante. ¿Podría proporcionar un poco más de detalle, aquí, que solo un enlace?

— Kevin Bowen

Esta es una aplicación gtk2 con una pestaña separada para cada sección, la importación de páginas de manual, la vista previa y la exportación son compatibles, no hay comandos de formato esotérico, esto todavía está en desarrollo, pero ciertamente es lo suficientemente estable como para usar.

— Tony Duncun

0

Puedes hacerlo con autotools. GNU ha publicado un ejemplo en el que un proyecto en C instala una página de manual con autotools.

— Niklas Rosencrantz
fuente