File: man2html.1

package info (click to toggle)
manpages-pl 20050320-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 12,200 kB
  • ctags: 16
  • sloc: makefile: 1,454; perl: 477; sh: 316
file content (149 lines) | stat: -rw-r--r-- 4,758 bytes parent folder | download | duplicates (3)
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
'\" t
.\" {PTM/WK/2000-IV}
.\" Man page for man2html
.\" aeb, 980101
.\"
.\" Translation update:  Robert Luberda <robert@debian.org>, Feb 2003, man-1.5k
.\" $Id: man2html.1,v 1.3 2003/03/10 11:08:40 robert Exp $
.TH man2html 1 "1 stycznia 1998"
.LO 1
.SH NAZWA
man2html \- formatuje stron man w html-u
.SH SKADNIA
.B man2html
.RI [ opcje ]
.RI [ plik ]
.SH OPIS
.B man2html
wykonuje konwersj strony podrcznika systemowego zapisanej w podanym
.I pliku
(lub pobieranej z stdin, w przypadku gdy nie podano nazwy pliku lub nazw "-")
z uywanego przez man formatu nroff na html i drukuje wynik na stdout.
Obsuguje tbl, ale nie zna eqn.
Kod zakoczenia wynosi 0. Jeli co si nie powiedzie, to na stdout
drukowana jest strona z komunikatem bdu.

Moe by wykorzystywane jako samodzielne narzdzie, ale zasadniczo
zaprojektowano je do zastosowa pomocniczych, by umoliwi
uytkownikom przegldanie stron podrcznika systemowego za pomoc
przegldarki html, takiej jak np.
.BR lynx (1),
.BR xmosaic (1)
czy
.BR netscape (1).
.\" (See
.\" .BR man (1)
.\" for info on how to browse man pages via
.\" .BR man2html .
.\" Usually it would suffice to put "MANHTMLPAGER=/usr/bin/lynx"
.\" in the environment.)

Gwn cz
.B man2html
stanowi konwerter troff-na-html napisany przez Richarda Verhoevena
(rcb5@win.tue.nl).
Dodaje on odnoniki hipertekstowe do nastpujcych konstrukcji:
.LP
.TS
l l.
foo(3x)	"http://localhost/cgi-bin/man/man2html?3x+foo"
metoda://acuch	"metoda://acuch"
www.nazwa.hosta	"http://www.nazwa.hosta"
ftp.nazwa.hosta	"ftp://ftp.nazwa.hosta"
nazwa@host	"mailto:nazwa@host"
<string.h>	"file:/usr/include/string.h"
.TE
.LP
(Pierwsza z nich moe by dopasowywana do potrzeb przez opcje - zobacz niej).
Nie jest wykonywane adne wyszukiwanie - obiekty wskazywane przez tworzone
odnoniki nie musz istnie.
Tworzony jest te indeks wewntrznych odnonikw hipertekstowych do rnych
sekcji strony, co uatwia orientacj w duych stronach jak
.BR bash (1).

.SH OPCJE
Przy odczycie z stdin nie zawsze jest jasne, jak wykona rozwinicie
dania .so. Opcja \-D pozwala skryptowi na zdefiniowanie katalogu roboczego.
.LP
.TP
.BI \-\^D " cieka"
Przed rozpoczciem konwersji obcina ostatnie dwie czci cieki
i w odniesieniu do pozostaej czci wykonuje \fIchdir\fP(\fIdir\fP).
.LP
Opcja \-E umoliwia skryptowi cgi atwe tworzenie komunikatw o bdach.
.LP
.TP
.BI \-\^E " acuch"
Tworzy w wyniku stron zawierajc zadany komunikat o bdzie.
.LP
Ogln postaci odnonika hipertekstowego generowanego dla odsyacza strony man
jest
.IP
<metoda:ciekacgi><ciekaman2html><separator><stronaman>
.LP
z wartoci domyln pokazan powyej. Skadowe tego odnonika ustawiane
s przy pomocy rnych opcji.
.TP
.B \-\^h
Ustawia metoda:ciekacgi na http://localhost. Jest to ustawienie domylne.
.TP
.BI \-\^HP " host[.domena][:port]"
Ustawia metoda:ciekacgi na
.RI http:// host.domena:port .
.TP
.B \-\^l
Ustawia metoda:ciekacgi na
.RI lynxcgi: /home/httpd .
.TP
.BI \-\^L " katalog"
Ustawia metoda:ciekacgi na
.RI lynxcgi: katalog .
.TP
.BI \-\^M " ciekaman2html"
Ustawia ciek man2html, jaka ma by uyta. Domylnie jest to
.IR /cgi-bin/man/man2html .
.TP
.B \-\^p
Ustawia separator na '/'.
.TP
.B \-\^q
Ustawia separator na '?'. Jest to separator domylny.
.TP
.B \-\^r
Uywa relatywnych cieek html, zamiast cieek typu cgi-bin.
.LP
Na maszynach, na ktrych nie jest uruchomiony
.BR httpd ,
mona do przegldania stron man uywa przegldarki
.BR lynx ,
wykorzystujc metod lynxcgi. Jeeli pracuje jaki demon http, do przegldania
mona uy lynx-a, czy jakiejkolwiek innej przegldarki, wykorzystujc metod
http. Opcja \-l (oznaczajca `lynxcgi') wybiera pierwsze z opisanych zachowa.
Przy jej zastosowaniu domyln ciek cgi jest \fI/home/httpd\fP.

Oglnie skrypt cgi wywouje si przez
.IP
<cieka_do_skryptu>/<dalej_cieka>?<zapytanie>
.LP
a zmiennym rodowiska PATH_INFO i QUERY_STRING zostan przypisane wartoci,
odpowiednio, <dalej_cieka> i <zapytanie>. Poniewa lynxcgi nie obsuguje
czci PATH_INFO, domylnie tworzymy odnoniki z '?' jako separatorem.
Opcja \-p (`path' - cieka) wybiera za separator znak ukonika '/', za
\-q (`query' - zapytanie) znak zapytania '?'.

Opcja \-H \fIhost\fP okrela nazw hosta, jaki ma by uywany (zamiast
\fIlocalhost\fP). Skrypt cgi moe wykorzysta konstrukcj
.IP
man2html -H $SERVER_NAME
.LP
jeli ustawiona jest zmienna SERVER_NAME. Dziki temu maszyna moe dziaa
jako serwer i eksportowa strony man.

.SH BDY
Wiele rzeczy jest zrobionych heurystycznie. Wynik nie zawsze bdzie doskonay.
Metoda lynxcgi nie zadziaa, jeeli lynx zosta skompilowany bez jej obsugi.
Mog by problemy z bezpieczestwem.

.SH "ZOBACZ TAKE"
.BR lynx (1),
.BR man (1)