87 |
\&.DC generate a drop capital |
\&.DC generate a drop capital |
88 |
\&.HTML pass an html raw request to the |
\&.HTML pass an html raw request to the |
89 |
device driver |
device driver |
90 |
|
\&.CDS code example begin |
91 |
|
\&.CDE code example end |
92 |
.fi |
.fi |
93 |
.PP |
.PP |
94 |
Output of the |
Output of the |
102 |
. |
. |
103 |
.SH REQUESTS |
.SH REQUESTS |
104 |
.TP |
.TP |
105 |
.B JOBNAME |
.B .JOBNAME filename |
106 |
Split output into multiple files. |
Split output into multiple HTML files. |
107 |
|
A file is split whenever a .SH or .NH\ 1 is encountered. |
108 |
Its argument is the file stem name for future output files. |
Its argument is the file stem name for future output files. |
109 |
This option is equivalent to |
This option is equivalent to |
110 |
.BR \%grohtml 's |
.BR \%grohtml 's |
111 |
.B \-j |
.B \-j |
112 |
option. |
option. |
113 |
.TP |
.TP |
114 |
.B HX |
.B .HX n |
115 |
Specify the cut off depth when generating links from section headings. |
Specify the cut off depth when generating links from section headings. |
116 |
For example, a parameter of\~2 would cause |
For example, a parameter of\~2 would cause |
117 |
.B \%grohtml |
.B \%grohtml |
139 |
.BR groff . |
.BR groff . |
140 |
. |
. |
141 |
.TP |
.TP |
142 |
.B BCL |
.B .BCL foreground background active not-visited visited |
143 |
This macro takes five parameters: foreground, background, active hypertext |
This macro takes five parameters: foreground, background, active hypertext |
144 |
link, hypertext link not yet visited, and visited hypertext link colour. |
link, hypertext link not yet visited, and visited hypertext link colour. |
145 |
. |
. |
146 |
.TP |
.TP |
147 |
.B BGIMG |
.B .BGIMG imagefile |
148 |
the only parameter to this macro is the background image file. |
the only parameter to this macro is the background image file. |
149 |
. |
. |
150 |
.TP |
.TP |
151 |
.B URL |
.B .URL url [description] [after] |
152 |
generates |
generates |
153 |
.TAG URL |
.TAG URL |
154 |
a URL using either two or three arguments. |
a URL using either one, two or three arguments. |
155 |
The first parameter is the actual URL, the second is the name of the link, |
The first parameter is the actual URL, the second is the name of the link, |
156 |
and the third is optional stuff to be printed immediately afterwards. |
and the third is optional stuff to be printed immediately afterwards. |
157 |
Hyphenation is disabled while printing the actual URL; explicit breakpoints |
If |
158 |
|
.B description |
159 |
|
and |
160 |
|
.B after |
161 |
|
are absent then the |
162 |
|
.B url |
163 |
|
becomes the anchor text. |
164 |
|
Hyphenation is disabled while printing the actual URL; |
165 |
|
explicit breakpoints |
166 |
should be inserted with the |
should be inserted with the |
167 |
.B \[rs]: |
.B \[rs]: |
168 |
escape. |
escape. |
190 |
.RE |
.RE |
191 |
. |
. |
192 |
.TP |
.TP |
193 |
.B MTO |
.B .MTO address [description] [after] |
194 |
Generate an email html reference. |
Generate an email html reference. |
195 |
The first argument is mandatory as the email address. |
The first argument is mandatory as the email address. |
196 |
The optional second argument is the text you see in your browser, and |
The optional second argument is the text you see in your browser |
197 |
an optional third argument is stuff printed immediately afterwards. |
If an empty argument is given, |
198 |
|
.B address |
199 |
|
is used instead. |
200 |
|
An optional third argument is stuff printed immediately afterwards. |
201 |
Hyphenation is disabled while printing the actual email address. |
Hyphenation is disabled while printing the actual email address. |
202 |
For example, |
For example, |
203 |
.MTO joe@user.org "Joe User" |
.MTO joe@user.org "Joe User" |
217 |
.BR \-Thtml ). |
.BR \-Thtml ). |
218 |
. |
. |
219 |
.TP |
.TP |
220 |
.B FTP |
.B .FTP url [description] [after] |
221 |
indicates that data can be obtained via ftp. |
indicates that data can be obtained via ftp. |
222 |
The first argument is the url and the second is the browser text. |
The first argument is the url and the second is the browser text. |
223 |
A third argument, similar to the macros above, is intended for stuff printed |
A third argument, similar to the macros above, is intended for stuff printed |
233 |
.RE |
.RE |
234 |
. |
. |
235 |
.TP |
.TP |
236 |
.B TAG |
.B .TAG name |
237 |
Generates an html name tag from its argument. |
Generates an html name tag from its argument. |
238 |
This can then be referenced using the |
This can then be referenced using the |
239 |
.URL #URL URL |
.URL #URL URL |
258 |
.RE |
.RE |
259 |
. |
. |
260 |
.TP |
.TP |
261 |
.B IMG |
.B .IMG [-R|-L|-C] filename [width] [height] |
262 |
Include a picture into the document. |
Include a picture into the document. |
263 |
The first argument is the horizontal location: right, left, or center |
The first argument is the horizontal location: right, left, or center |
264 |
.RB ( \-R , |
.RB ( \-R , |
265 |
.BR \-L , |
.BR \-L , |
266 |
or |
or |
267 |
.BR \-C ). |
.BR \-C ). |
268 |
|
Alignment is centered by default (-C). |
269 |
The second argument is the filename. |
The second argument is the filename. |
270 |
The optional third and fourth arguments are the width and height. |
The optional third and fourth arguments are the width and height. |
271 |
If the width is absent it defaults to 1\~inch. |
If the width is absent it defaults to 1\~inch. |
276 |
macro. |
macro. |
277 |
. |
. |
278 |
.TP |
.TP |
279 |
.B PIMG |
.B .PIMG [-R|-L|-C] filename [width [height]] |
280 |
Include an image in PNG format. |
Include an image in PNG format. |
281 |
This macro takes exactly the same parameters as the |
This macro takes exactly the same parameters as the |
282 |
.B IMG |
.B IMG |
297 |
option of groff. |
option of groff. |
298 |
. |
. |
299 |
.TP |
.TP |
300 |
.B MPIMG |
.B .MPIMG [-R|-L] [-G gap] filename [width [height]] |
301 |
Place a PNG image on the margin and wrap text around it. |
Place a PNG image on the margin and wrap text around it. |
302 |
The first parameters are optional. |
The first parameters are optional. |
303 |
The alignment: left or right |
The alignment: left or right |
328 |
.RE |
.RE |
329 |
. |
. |
330 |
.TP |
.TP |
331 |
.B HnS |
.B .HnS n |
332 |
Begin heading. |
Begin heading. |
333 |
The heading level is specified by the first parameter. |
The numeric heading level |
334 |
Use this macro of your headings contain URLs. |
.I n |
335 |
|
is specified by the first parameter. |
336 |
|
Use this macro if your headings contain URL, FTP or MTO macros. |
337 |
Example: |
Example: |
338 |
.RS |
.RS |
339 |
.IP |
.IP |
353 |
.ft P |
.ft P |
354 |
.fi |
.fi |
355 |
.RE |
.RE |
356 |
|
.IP |
357 |
|
In this case you might wish to |
358 |
|
disable automatic links to headings. |
359 |
|
This can be done via |
360 |
|
.B \-P\-l |
361 |
|
from the command line. |
362 |
|
.\" or by using a call to `.HX 0'. |
363 |
|
|
364 |
. |
. |
365 |
.TP |
.TP |
366 |
.B HnE |
.B .HnE |
367 |
End heading. |
End heading. |
368 |
. |
. |
369 |
.TP |
.TP |
370 |
.B LK |
.B .LK |
371 |
.TAG LK |
.TAG LK |
372 |
Force \%grohtml to place the automatically generated links at this position. |
Force \%grohtml to place the automatically generated links at this position. |
373 |
If this manual page has been processed with |
If this manual page has been processed with |
376 |
. |
. |
377 |
.LK |
.LK |
378 |
. |
. |
|
. |
|
|
.SH SECTION HEADING LINKS |
|
|
By default |
|
|
.B \%grohtml |
|
|
generates links to all section headings and places these at the top of the |
|
|
html document. (See |
|
|
.URL #LK LINKS |
|
|
for details of how to switch this off or alter the position). |
|
|
. |
|
379 |
.TP |
.TP |
380 |
.B HR |
.B .HR |
381 |
Generate a full-width horizontal rule. |
Generate a full-width horizontal rule. |
382 |
. |
. |
383 |
.TP |
.TP |
384 |
.B NHR |
.B .NHR |
385 |
Suppress generation of the top and bottom rules which \%grohtml emits |
Suppress generation of the top and bottom rules which \%grohtml emits |
386 |
by default. |
by default. |
387 |
. |
. |
388 |
.TP |
.TP |
389 |
.B HTL |
.B .HTL |
390 |
Generate an HTML title only. |
Generate an HTML title only. |
391 |
This differs from the |
This differs from the |
392 |
.B TL |
.B TL |
393 |
macro of the |
macro of the |
394 |
.B ms |
.B ms |
395 |
macro package which generates both an HTML title and an H1 heading. |
macro package which generates both an HTML title and an <H1> heading. |
396 |
Use it to provide an HTML title as search engine fodder but a graphic title |
Use it to provide an HTML title as search engine fodder but a graphic title |
397 |
in the document. |
in the document. |
398 |
|
The macro terminates when a space or break is seen (.sp, .br). |
399 |
. |
. |
400 |
.TP |
.TP |
401 |
.B HTML |
.B .HTML |
402 |
All text after this macro is treated as raw html. |
All text after this macro is treated as raw html. |
403 |
If the document is processed without |
If the document is processed without |
404 |
.B \-Thtml |
.B \-Thtml |
421 |
.RE |
.RE |
422 |
. |
. |
423 |
.TP |
.TP |
424 |
.B DC |
.B .DC l text [color] |
425 |
Produce a drop capital. |
Produce a drop capital. |
426 |
The first parameter is the letter to be dropped and enlarged, the second |
The first parameter is the letter to be dropped and enlarged, the second |
427 |
parameter is the ajoining text whose height the first letter should not |
parameter |
428 |
exceed. |
.B text |
429 |
|
is the ajoining text whose height the first letter should not exceed. |
430 |
The optional third parameter is the color of the dropped letter. |
The optional third parameter is the color of the dropped letter. |
431 |
|
It defaults to black. |
432 |
|
. |
433 |
|
.TP |
434 |
|
.B ".CDS" |
435 |
|
Start displaying a code section in constant width font. |
436 |
|
. |
437 |
|
.TP |
438 |
|
.B ".CDE" |
439 |
|
End code display |
440 |
|
. |
441 |
|
.SH SECTION HEADING LINKS |
442 |
|
By default |
443 |
|
.B \%grohtml |
444 |
|
generates links to all section headings and places these at the top of the |
445 |
|
html document. (See |
446 |
|
.URL #LK LINKS |
447 |
|
for details of how to switch this off or alter the position). |
448 |
. |
. |
449 |
. |
. |
450 |
.SH LIMITATIONS OF GROHTML |
.SH LIMITATIONS OF GROHTML |