projects / OpenSPARC-T2-DV / blame
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / HTML::HeadParser.3
CommitLineData
86530b38
AT		 1.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
77.\}
78.if t \{\
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
84.\}
85. \" simple accents for nroff and troff
86.if n \{\
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
93.\}
94.if t \{\
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101.\}
102. \" troff and (daisy-wheel) nroff accents
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
112. \" corrections for vroff
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115. \" for low resolution devices (crt and lpr)
116.if \n(.H>23 .if \n(.V>19 \
117\{\
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "HTML::HeadParser 3"
132.TH HTML::HeadParser 3 "2002-03-11" "perl v5.8.0" "User Contributed Perl Documentation"
133.SH "NAME"
134HTML::HeadParser \- Parse <HEAD> section of a HTML document
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 3
138\& require HTML::HeadParser;
139\& $p = HTML::HeadParser->new;
140\& $p->parse($text) and print "not finished";
141.Ve
142.PP
143.Vb 3
144\& $p->header('Title') # to access <title>....</title>
145\& $p->header('Content-Base') # to access <base href="http://...">
146\& $p->header('Foo') # to access <meta http-equiv="Foo" content="...">
147.Ve
148.SH "DESCRIPTION"
149.IX Header "DESCRIPTION"
150The \fIHTML::HeadParser\fR is a specialized (and lightweight)
151\&\fIHTML::Parser\fR that will only parse the <\s-1HEAD\s0>...</HEAD>
152section of an \s-1HTML\s0 document. The \fIparse()\fR method
153will return a \s-1FALSE\s0 value as soon as some <\s-1BODY\s0> element or body
154text are found, and should not be called again after this.
155.PP
156The \fIHTML::HeadParser\fR keeps a reference to a header object, and the
157parser will update this header object as the various elements of the
158<\s-1HEAD\s0> section of the \s-1HTML\s0 document are recognized. The following
159header fields are affected:
160.IP "Content\-Base:" 4
161.IX Item "Content-Base:"
162The \fIContent-Base\fR header is initialized from the <base
163href=\*(L"...\*(R"> element.
164.IP "Title:" 4
165.IX Item "Title:"
166The \fITitle\fR header is initialized from the <title>...</title>
167element.
168.IP "Isindex:" 4
169.IX Item "Isindex:"
170The \fIIsindex\fR header will be added if there is a <isindex>
171element in the <head>. The header value is initialized from the
172\&\fIprompt\fR attribute if it is present. If no \fIprompt\fR attribute is
173given it will have '?' as the value.
174.IP "X\-Meta\-Foo:" 4
175.IX Item "X-Meta-Foo:"
176All <meta> elements will initialize headers with the prefix
177"\f(CW\*(C`X\-Meta\-\*(C'\fR" on the name. If the <meta> element contains a
178\&\f(CW\*(C`http\-equiv\*(C'\fR attribute, then it will be honored as the header name.
179.SH "METHODS"
180.IX Header "METHODS"
181The following methods (in addition to those provided by the
182superclass) are available:
183.IP "$hp = HTML::HeadParser\->new( [$header] )" 4
184.IX Item "$hp = HTML::HeadParser->new( [$header] )"
185The object constructor. The optional \f(CW$header\fR argument should be a
186reference to an object that implement the \fIheader()\fR and \fIpush_header()\fR
187methods as defined by the \fIHTTP::Headers\fR class. Normally it will be
188of some class that isa or delegates to the \fIHTTP::Headers\fR class.
189.Sp
190If no \f(CW$header\fR is given \fIHTML::HeadParser\fR will create an
191\&\fIHTTP::Header\fR object by itself (initially empty).
192.IP "$hp\->header;" 4
193.IX Item "$hp->header;"
194Returns a reference to the header object.
195.ie n .IP "$hp\->header( $key )" 4
196.el .IP "$hp\->header( \f(CW$key\fR )" 4
197.IX Item "$hp->header( $key )"
198Returns a header value. It is just a shorter way to write
199\&\f(CW\*(C`$hp\->header\->header($key)\*(C'\fR.
200.SH "EXAMPLE"
201.IX Header "EXAMPLE"
202.Vb 9
203\& $h = HTTP::Headers->new;
204\& $p = HTML::HeadParser->new($h);
205\& $p->parse(<<EOT);
206\& <title>Stupid example</title>
207\& <base href="http://www.linpro.no/lwp/">
208\& Normal text starts here.
209\& EOT
210\& undef $p;
211\& print $h->title; # should print "Stupid example"
212.Ve
213.SH "SEE ALSO"
214.IX Header "SEE ALSO"
215HTML::Parser, HTTP::Headers
216.Sp
217The \fIHTTP::Headers\fR class is distributed as part of the \fIlibwww-perl\fR
218package.
219.SH "COPYRIGHT"
220.IX Header "COPYRIGHT"
221Copyright 1996\-2001 Gisle Aas. All rights reserved.
222.Sp
223This library is free software; you can redistribute it and/or
224modify it under the same terms as Perl itself.
Full OpenSPARC design & verification tarball including full HDL.