Re: Comment on fait des pages man ?
On 2000-11-07 12:13 +0100, Martin Quinson wrote:
> Hello, je suis en train d'empaqueter un beau ptit prog, et lintian fait
> rien qu'a raler, sous prétexte que j'ai pas de man page. C'est pas de ma
> faute, y'en a pas upstream. J'ai essayé d'en faire comme les hommes, les
> vrais, en troff (ups, je suis meme pas sur que ca s'appelle comme ca),
> mais la conclusion, c'est que si quelqu'un pouvait m'indiquer un format
> civilisé que l'on puisse convertir automatiquement en page de manuel, ca
> serait bien.
Ça, je ne sais pas. Par contre, il y a un outil imparable pour
écrire des pages de man : vi (ou ce qui en tient lieu pour toi).
Sur la première ligne :
.TH MYPROG 1 2000-12-04
Ensuite la section NAME (essentielle pour que man -k marche) :
.SH NAME
myprog \- a program to do stuff
Ensuite la section SYNOPSIS :
.SH SYNOPSIS
.B myprog \-\-help <- .B pour "bold"
.br <- Comme <br> en HTML
.B myprog
.RB [ \-v ] <- .RB pour alterner roman/bold/roman/bold...
.RB [ \-l
.IR num ] " file" " ..." <- .IR pour alterner italic/roman/italic...
Ensuite la section DESCRIPTION :
.SH DESCRIPTION
This is a program to do stuff.
Puis la section OPTIONS :
.SH OPTIONS
.TP
.BI "\-l " num
Level of compliance with ISO 31415:9265. Default 1.
.TP
.B \-v
Verbose mode.
Cette construction est plus ou moins équivalente au code HTML
suivant :
<h2>OPTIONS</h2>
<dl>
<dt><b>-l </b><i>num</i>
<dd>Level of compliance...
<dt><b>-v</b>
<dd>Verbose mode.
</dl>
Comme l'a dit Stéphane, man 7 man explique ça très bien.
Généralement, on prend une page de man qu'on connaît (genre
ls(1)) et on regarde comment c'est fait. Pour "tester" ta page
de man :
nroff -man -Tlatin1 myprog.1 | less
Si tu as envie de tenter l'ascension par la face troff, je me
ferai un plaisir de te donner un coup de main.
--
André Majorel
Work: <aym@domicile.fr>
Home: <amajorel@teaser.fr> http://www.teaser.fr/~amajorel/
Reply to: