1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
man2html(1) Commandes utilisateur man2html(1)
NOM
man2html - formate une page de manuel en html
SYNOPSIS
man2html [options] [fichier]
DESCRIPTION
man2html convertit une page de manuel telle que trouv'ee dans fichier (ou l'entr'ee standard
stdin si aucun argument fichier n'est donn'e ou si l'argument << - >> est donn'e) `a partir
du format nroff (celui des pages de manuels) vers un format html et affiche le r'esultat
sur la sortie standard (stdout). man2html supporte tbl(1) mais ne conna^it rien `a propos
de eqn(1). Le code de sortie est 0. Si quelque chose va mal, une page d'erreur est af-
fich'ee sur la sortie standard stdout.
Cette commande peut ^etre utilis'ee seule mais a 'et'e principalement con,cue pour ^etre un aux-
iliaire afin que les utilisateurs puissent naviguer dans les pages de manuel avec un navi-
gateur html comme lynx(1), xmosaic(1) ou netscape(1).
La plus grande partie de man2html est l'engin << troff-vers-html >> 'ecrit par Richard Ver-
hoeven (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`ere de celles-ci peut ^etre ajust'ee par des options - voir plus loin.) Aucune
consultation n'est effectu'ee - les liens g'en'er'es n'ont pas besoin d'exister. Un index avec
des hyperliens internes vers les diverses sections est 'egalement cr'e'e rendant plus facile
la navigation dans les grandes pages comme bash(1).
OPTIONS
Lorsqu'on lit `a partir de stdin, il n'est pas toujours 'evident de savoir comment se fait
l'expansion .so. L'option -D permet `a un script de d'efinir le r'epertoire de travail.
-D chemin
Retire les deux derniers 'el'ements du chemin et effectue un changement de r'epertoire
courant chdir(dir) avant de d'ebuter la conversion.
L'option -E option facilite la production de messages d'erreurs `a partir de scripts cgi.
-E cha^ine
Produire en sortie une page d'erreur contenant le message d'erreur donn'e.
La forme g'en'erale d'un hyperlien g'en'er'e pour r'ef'erencer une page de manuel est
<method:cgipath><man2htmlpath><separator><manpage>
qui est d'ailleurs la forme par d'efaut. Les 'el'ements de cet hyperlien sont positionn'es en
utilisant diverses options.
-h Positionner method:cgipath `a http://localhost. C'est le comportement par d'efaut.
-H h^ote[.domaine][:port]
Positionner method:cgipath `a http://h^ote.domaine:port.
-l Positionner method:cgipath `a lynxcgi:/home/httpd.
-L dir Positionner method:cgipath `a lynxcgi:dir.
-M man2htmlpath
Positionner le chemin vers man2html `a utiliser. La valeur par d'efaut est /cgi-
bin/man/man2html.
-p Positionner le s'eparateur `a << / >>.
-q Positionner le s'eparateur `a << ? >>. C'est la valeur par d'efaut.
-r Utiliser des chemins html relatifs plut^ot 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'ethode lynxcgi. Lorsqu'un d'emon http est en
service, vous pouvez utiliser lynx ou n'importe quel autre navigateur pour parcourir les
pages de manuel en utilisant la m'ethode http. L'option -l (pour << lynxcgi >>) s'elec-
tionne ce fonctionnement. Avec elle, le chemin cgi par d'efaut est /home/httpd.
En g'en'eral, un script cgi peut ^etre appel'e de la fa,con suivante
<path_to_script>/<more_path>?<query>
et les variables d'environnement PATH_INFO et QUERY_STRING seront positionn'ees respective-
ment `a <more_path> et <query>. Puisque lynxcgi ne g`ere pas l''el'ement PATH_INFO, nous al-
lons g'en'erer des hyperliens avec << ? >> comme s'eparateur par d'efaut. L'option -p (pour
<< path >>) s'electionne << / >> comme s'eparateur, alors que l'option -q (for << query >>)
s'electionne << ? >>.
L'option -H host sp'ecifiera l'h^ote `a utiliser (`a la place localhost). Un script cgi pourra
utiliser
man2html -H $SERVER_NAME
si la variable SERVER_NAME est positionn'ee. Cela permettra `a 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'eth-
ode lynxcgi ne fonctionnera pas si lynx a 'et'e compil'e sans le support de celle-ci. Il peut
y avoir des probl`emes de s'ecurit'e.
VOIR AUSSI
lynx(1), man(1)
TRADUCTION
Ce document est une traduction r'ealis'ee par Alain Portal <aportal AT univ-montp2 DOT fr>
le 1er juin 2005 et mise `a jour le 7 novembre 2005.
L''equipe de traduction a fait le maximum pour r'ealiser une adaptation fran,caise de
qualit'e. La version anglaise la plus `a jour de ce document est toujours consultable via la
commande : << LANG=en man 1 man2html >>. N'h'esitez pas `a signaler `a l'auteur ou au tra-
ducteur, selon le cas, toute erreur dans cette page de manuel.
Manuel Linux 1er janvier 1998 man2html(1)
|
