Linux Certif

Toute la documentation sur la certification Linux LPI

man2html

NOM

man2html - formate une page de manuel en html

SYNOPSIS

man2html [options] [fichier]

DESCRIPTION

man2html convertit une page de manuel telle que trouv�e dans fichier (ou l'entr�e standard stdin si aucun argument fichier n'est donn� ou si l'argument � - � est donn�) � partir du format nroff (celui des pages de manuels) vers un format html et affiche le r�sultat sur la sortie standard (stdout). man2html supporte tbl(1) mais ne conna�t rien � propos de eqn(1). Le code de sortie est 0. Si quelque chose va mal, une page d'erreur est affich�e sur la sortie standard stdout.

Cette commande peut �tre utilis�e seule mais a �t� principalement con�ue pour �tre un auxiliaire afin que les utilisateurs puissent naviguer dans les pages de manuel avec un navigateur html comme lynx(1), xmosaic(1) ou netscape(1).

La plus grande partie de man2html est l'engin � troff-vers-html � �crit par Richard Verhoeven (rcb5@win.tue.nl). Il ajoute des hyperliens aux constructions suivantes :

foo(3x)	"http://localhost/cgi-bin/man/man2html?3x+foo"
method://string	"method://string"
www.host.name	"http://www.host.name"
ftp.host.name	"ftp://ftp.host.name"
name@host	"mailto:name@host"
<string.h>	"file:/usr/include/string.h"

(La premi�re de celles-ci peut �tre ajust�e par des options - voir plus loin.) Aucune consultation n'est effectu�e - les liens g�n�r�s n'ont pas besoin d'exister. Un index avec des hyperliens internes vers les diverses sections est �galement cr�� rendant plus facile la navigation dans les grandes pages comme bash(1).

OPTIONS

Lorsqu'on lit � partir de stdin, il n'est pas toujours �vident de savoir comment se fait l'expansion .so. L'option -D permet � un script de d�finir le r�pertoire de travail.

-D chemin

Retire les deux derniers �l�ments du chemin et effectue un changement de r�pertoire courant chdir(dir) avant de d�buter la conversion.

L'option -E option facilite la production de messages d'erreurs � partir de scripts cgi.

-E cha�ne

Produire en sortie une page d'erreur contenant le message d'erreur donn�.

La forme g�n�rale d'un hyperlien g�n�r� pour r�f�rencer une page de manuel est

<method:cgipath><man2htmlpath><separator><manpage>

qui est d'ailleurs la forme par d�faut. Les �l�ments de cet hyperlien sont positionn�s en utilisant diverses options.

-h

Positionner method:cgipath � http://localhost. C'est le comportement par d�faut.

-H h�te[.domaine][:port]

Positionner method:cgipath � http://h�te.domaine:port.

-l

Positionner method:cgipath � lynxcgi:/home/httpd.

-L dir

Positionner method:cgipath � lynxcgi:dir.

-M man2htmlpath

Positionner le chemin vers man2html � utiliser. La valeur par d�faut est /cgi-bin/man/man2html.

-p

Positionner le s�parateur � � / �.

-q

Positionner le s�parateur � � ? �. C'est la valeur par d�faut.

-r

Utiliser des chemins html relatifs plut�t que les chemins cgi-bin.

Sur une machine sur laquelle httpd ne tourne pas, vous pouvez utiliser lynx pour naviguer dans les pages de manuel en utilisant la m�thode lynxcgi. Lorsqu'un d�mon http est en service, vous pouvez utiliser lynx ou n'importe quel autre navigateur pour parcourir les pages de manuel en utilisant la m�thode http. L'option -l (pour � lynxcgi �) s�lectionne ce fonctionnement. Avec elle, le chemin cgi par d�faut est /home/httpd.

En g�n�ral, un script cgi peut �tre appel� de la fa�on suivante

<path_to_script>/<more_path>?<query>

et les variables d'environnement PATH_INFO et QUERY_STRING seront positionn�es respectivement � <more_path> et <query>. Puisque lynxcgi ne g�re pas l'�l�ment PATH_INFO, nous allons g�n�rer des hyperliens avec � ? � comme s�parateur par d�faut. L'option -p (pour � path �) s�lectionne � / � comme s�parateur, alors que l'option -q (for � query �) s�lectionne � ? �.

L'option -H host sp�cifiera l'h�te � utiliser (� la place localhost). Un script cgi pourra utiliser

man2html -H $SERVER_NAME

si la variable SERVER_NAME est positionn�e. Cela permettra � votre machine de fonctionner en tant que serveur et d'exporter les pages manuel.

BOGUES

Il y a beaucoup d'heuristiques. La sortie produite ne sera pas toujours parfaite. La m�thode lynxcgi ne fonctionnera pas si lynx a �t� compil� sans le support de celle-ci. Il peut y avoir des probl�mes de s�curit�.

VOIR AUSSI

lynx(1), man(1)

TRADUCTION

Ce document est une traduction r�alis�e par Alain Portal <aportal AT univ-montp2 DOT fr> le 1er juin 2005 et mise � jour le 2 novembre 2005.

L'�quipe de traduction a fait le maximum pour r�aliser une adaptation fran�aise de qualit�. La version anglaise la plus � jour de ce document est toujours consultable via la commande : � LANG=en man 1 man2html �. N'h�sitez pas � signaler � l'auteur ou au traducteur, selon le cas, toute erreur dans cette page de manuel.