Como criar uma página de manual?

29

Estou empacotando um programa para o ubuntu e estou recebendo um aviso do lintian dizendo que meu binário precisa de uma página de manual.

Como alguém cria uma página de manual para um programa?

manpage vagabundo
fonte

Respostas:

23

Com a ajuda do Gmanedit, Instale o gmanedit você pode criar páginas de manual com uma GUI gráfica.

O Editor de páginas de manual do Gtk + é um editor para páginas de manual executadas no X com GTK +.

Gmanedit é uma aplicação que permite editar páginas de manual (man) em sistemas Linux / Unix.

É como os editores de HTML mais comuns, mas mais fácil. Você precisa conhecer o formato das páginas de manual.

insira a descrição da imagem aqui

De acordo com o programa do usuário Debian FHS, as páginas de manual são armazenadas em usr/share/man/man1ou usr/local/share/man/man1.

Após alterar as páginas de manual, pode ser aconselhável atualizar o banco de dados de páginas de manual executando mandbem um terminal.

Detalhes sobre a sintaxe da página de manual estão resumidos na página de manual do homem .

Takkat
fonte
Claro, você está certo. Eu ia mudar isso, mas assim que vi o MarcoCeppi lá, não queria modificá-lo. : D
Lucio
@Lucio lol - que foi a partir de um caminho de volta tempo, quando não havia apps.ubuntu ainda;)
Takkat
3

Você pode escrever páginas de manual em docbook / refentry, um formato de documentação 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 depois converta os resultados para o formato man usando 

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

para html com

docbook2html docbook2html

e assim por diante. Essa não é a maneira mais fácil de escrever uma página de manual, mas se você já escreveu XML antes, já conhece a sintaxe, é apenas uma questão de aprender as tags a serem usadas.

jjg
fonte
2

Dê um giro a isso Acabei de fazer o upload Eu escrevo vários aplicativos e estou tendo problemas com um editor de páginas de manual decente

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

Este é um aplicativo gtk2 com uma guia separada para cada seção. A importação e visualização de páginas de manual são suportadas, sem comandos de formatação esotérica, isso ainda está em desenvolvimento, mas certamente é estável o suficiente para uso.

Tony Duncun
fonte
11
Essa aplicação parece interessante. Você poderia fornecer um pouco mais de detalhes, aqui, do que apenas um link?
Kevin Bowen
Este é um aplicativo gtk2 com uma guia separada para cada seção. A importação e visualização de páginas de manual são suportadas, sem comandos de formatação esotérica, isso ainda está em desenvolvimento, mas é estável o suficiente para ser usado.
Tony Duncun
0

Você pode fazer isso com ferramentas automáticas. O GNU publicou um exemplo em que um projeto C instala uma página de manual com ferramentas automáticas.

Niklas Rosencrantz
fonte