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).
L'option -E option facilite la production de messages d'erreurs à partir de scripts cgi.
La forme générale d'un hyperlien généré pour référencer une page de manuel est
qui est d'ailleurs la forme par défaut. Les éléments de cet hyperlien sont positionnés en utilisant diverses options.
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
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
si la variable SERVER_NAME est positionnée. Cela permettra à votre machine de fonctionner en tant que serveur et d'exporter les pages manuel.
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.