1 .TH GROFF_WWW @MAN7EXT@ "@MDATE@" "groff @VERSION@"
3 groff_www \- groff macros for authoring web pages
5 .\" User level guide to using the -mwww macroset
8 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
9 .do nr groff_www_C \n[.C]
14 .\" ====================================================================
16 .\" ====================================================================
18 .\" Copyright (C) 2000-2018 Free Software Foundation, Inc.
20 .\" This file is part of groff, the GNU roff type-setting system.
22 .\" This program is free software: you can redistribute it and/or modify
23 .\" it under the terms of the GNU General Public License as published by
24 .\" the Free Software Foundation, either version 3 of the License, or
25 .\" (at your option) any later version.
27 .\" This program is distributed in the hope that it will be useful, but
28 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
29 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
30 .\" General Public License for more details.
32 .\" You should have received a copy of the GNU General Public License
33 .\" along with this program. If not, see
34 .\" <http://www.gnu.org/licenses/>.
37 .\" we need the .LK here as we use it in the middle as an example --
38 .\" once the user requests .LK then the automatic generation of links
39 .\" at the top of the document is suppressed.
45 .\" ====================================================================
47 .\" ====================================================================
56 .\" ====================================================================
58 .\" ====================================================================
60 This manual page describes the GNU \-mwww macro package, which is part of
61 the groff document formatting system.
63 The manual page is very a basic guide, and the HTML device driver
65 has been completely rewritten but still remains as in an alpha state.
67 It has been included into the distribution so that a lot of people have a
70 Note that this macro file is automatically called (via the
79 To see the hyperlinks in action, please format this man page with the
85 Here is a summary of the functions found in this macro set.
89 \&.JOBNAME@split output into multiple files
90 \&.HX@automatic heading level cut off
91 \&.BCL@specify colours on a web page
92 \&.BGIMG@specify background image
93 \&.URL@create a URL using two parameters
94 \&.FTP@create an FTP reference
95 \&.MTO@create an HTML email address
96 \&.TAG@generate an HTML name
97 \&.IMG@include an image file
98 \&.PIMG@include PNG image
99 \&.MPIMG@place PNG on the margin and wrap text around it
102 \&.LK@emit automatically collected links.
103 \&.HR@produce a horizontal rule
104 \&.NHR@suppress automatic generation of rules.
105 \&.HTL@only generate HTML title
106 \&.HEAD@add data to <head> block
107 \&.ULS@unorder list begin
108 \&.ULE@unorder list end
109 \&.OLS@ordered list begin
110 \&.OLE@ordered list end
111 \&.DLS@definition list begin
112 \&.DLE@definition list end
113 \&.LI@insert a list item
114 \&.DC@generate a drop capital
115 \&.HTML@pass an HTML raw request to the device driver
116 \&.CDS@code example begin
117 \&.CDE@code example end
118 \&.ALN@place links on left of main text.
119 \&.LNS@start a new two-column table with links in the left.
120 \&.LNE@end the two-column table.
121 \&.LINKSTYLE@initialize default URL attributes.
132 preprocessors is acceptable as input.
135 .\" ====================================================================
137 .\" ====================================================================
141 Split output into multiple HTML files.
143 A file is split whenever a \&.SH or \&.NH\ 1 is encountered.
145 Its argument is the file stem name for future output files.
147 This option is equivalent to
154 Specify the cut off depth when generating links from section headings.
156 For example, a parameter of\~2 would cause
158 to generate a list of links for
175 that no heading links should be created at all.
177 Another method for turning automatic headings off is by issuing the
184 .B .BCL foreground background active not-visited visited
185 This macro takes five parameters: foreground, background, active hypertext
186 link, hypertext link not yet visited, and visited hypertext link colour.
190 the only parameter to this macro is the background image file.
193 .B .URL url [description] [after]
196 a URL using either one, two or three arguments.
198 The first parameter is the actual URL, the second is the name of the
199 link, and the third is optional stuff to be printed immediately
208 becomes the anchor text.
210 Hyphenation is disabled while printing the actual URL;
211 explicit breakpoints should be inserted with the
215 Here is how to encode
216 .UR http://\:foo.\:org/
221 .B .URL http://\[rs]:foo.\[rs]:org/ "foo" :
225 If this is processed by a device other than
232 foo \[la]\f[CR]http://foo.org\f[]\[ra]:
236 The URL macro can be of any type; for example we can reference
238 Eric Raymond's pic guide
243 .B .URL pic.html \[dq]Eric Raymond's pic guide\[dq]
247 .B .MTO address [description] [after]
248 Generate an email HTML reference.
250 The first argument is mandatory as the email address.
252 The optional second argument is the text you see in your browser.
254 If an empty argument is given,
258 An optional third argument is stuff printed immediately afterwards.
260 Hyphenation is disabled while printing the actual email address.
266 can be achieved by the following macro:
269 .B .MTO joe@user.org \[dq]Joe User\[dq]
273 Note that all the URLs actually are treated as consuming no textual
276 This could be considered as a bug since it causes some problems.
280 inserts a zero-width character which expands to a harmless space (only
287 .B .FTP url [description] [after]
288 indicates that data can be obtained via FTP.
290 The first argument is the URL and the second is the browser text.
292 A third argument, similar to the macros above, is intended for stuff
293 printed immediately afterwards.
295 The second and the third parameter are optional.
297 Hyphenation is disabled while printing the actual URL.
299 As an example, here is the location of the
300 .UR ftp://\:ftp.gnu.org/
304 The macro example above can be specified as:
307 .B .FTP ftp://\[rs]:ftp.gnu.org/ \[dq]GNU FTP server\[dq] .
312 Generates an HTML name tag from its argument.
314 This can then be referenced using the
320 As you can see, you must precede the tag name with
322 since it is a local reference.
324 This link was achieved via placing a TAG in the URL description above;
325 the source looks like this:
334 a URL using either two or three arguments.
341 .B .IMG [\-R|\-L|\-C] filename [width] [height]
342 Include a picture into the document.
344 The first argument is the horizontal location: right, left, or center
350 Alignment is centered by default
353 The second argument is the filename.
355 The optional third and fourth arguments are the width and height.
357 If the width is absent it defaults to 1\~inch.
359 If the height is absent it defaults to the width.
361 This maps onto an HTML img tag.
363 If you are including a PNG image then it is advisable to use the
368 .B .PIMG [\-R|\-L|\-C] filename [width [height]]
369 Include an image in PNG format.
371 This macro takes exactly the same parameters as the
373 macro; it has the advantage of working with PostScript and HTML devices
374 also since it can automatically convert the image into the EPS format,
375 using the following programs of the
383 If the document isn't processed with
387 it is necessary to use the
392 .B .MPIMG [\-R|\-L] [\-G gap] filename [width [height]]
393 Place a PNG image on the margin and wrap text around it.
395 The first parameters are optional.
397 The alignment: left or right
401 specifies the margin where the picture is placed at.
403 The default alignment is left
408 can be used to arrange a gap between the picture and the text that
411 The default gap width is zero.
414 The first non-optional argument is the filename.
416 The optional following arguments are the width and height.
418 If the width is absent it defaults to 1\~inch.
420 If the height is absent it defaults to the width.
427 \&.MPIMG \-L \-G 2c foo.png 3c 1.5c
433 The height and width may also be given as percentages.
435 The PostScript device calculates the width from the
437 register and the height from the
446 \&.MPIMG \-L \-G 2c foo.png 15%
455 The numeric heading level
457 is specified by the first parameter.
459 Use this macro if your headings contain URL, FTP or MTO macros.
469 \&.URL http://groff.ffii.org (Groff)
471 \&.URL http://www.gnu.org/ GNU
474 \&.URL http://ffii.org/ FFII .
482 In this case you might wish to disable automatic links to headings.
486 from the command line.
487 .\" or by using a call to \[lq].HX 0\[rq].
498 Force \%grohtml to place the automatically generated links at this
501 If this manual page has been processed with
505 those links can be seen right here.
511 Generate a full-width horizontal rule for
516 No effect for all other devices.
520 Suppress generation of the top and bottom rules which \%grohtml emits
525 Generate an HTML title only.
527 This differs from the
531 macro package which generates both an HTML title and an <H1> heading.
533 Use it to provide an HTML title as search engine fodder but a graphic
534 title in the document.
536 The macro terminates when a space or break is seen (.sp, \&.br).
540 Add arbitrary HTML data to the <head> block.
542 Ignored if not processed with
551 .B ".HEAD" "\[dq]<link \[rs]"
552 .B " rel=\[dq]\[dq]icon\[dq]\[dq] \[rs]"
553 .B " type=\[dq]\[dq]image/png\[dq]\[dq] \[rs]"
554 .B " href=\[dq]\[dq]http://foo.org//bar.png\[dq]\[dq]/>\[dq]"
561 All text after this macro is treated as raw HTML.
563 If the document is processed without
567 then the macro is ignored.
569 Internally, this macro is used as a building block for other
581 \&. HTML <body background=\[rs]\[rs]$1>
589 .B .DC l text [color]
590 Produce a drop capital.
592 The first parameter is the letter to be dropped and enlarged, the second
595 is the adjoining text whose height the first letter should not exceed.
597 The optional third parameter is the color of the dropped letter.
599 It defaults to black.
603 Start displaying a code section in constant width font.
610 .B ".ALN [color] [percentage]"
611 Place section heading links automatically to the left of the main text.
613 The color argument is optional and if present indicates which HTML
614 background color is to be used under the links.
616 The optional percentage indicates the amount of width to devote to
617 displaying the links.
619 The default values are #eeeeee and 30 for color and percentage width,
622 This macro should only be called once at the beginning of the document.
624 After calling this macro each section heading emits an HTML table
625 consisting of the links in the left and the section text on the right.
629 Start a new two-column table with links in the left column.
631 This can be called if the document has text before the first \&.SH and
634 Typically this is called just before the first paragraph and after the
635 main title as it indicates that text after this point should be
636 positioned to the right of the left-hand navigational links.
640 End a two-column table.
642 This should be called at the end of the document if \&.ALN was used.
645 .B ".LINKSTYLE color [ fontstyle [ openglyph closeglyph ] ]"
646 Initialize default URL attributes to be used if this macro set is not
647 used with the HTML device.
649 The macro set initializes itself with the following call
654 \&.LINKSTYLE blue CR \e[la] \e[ra]
660 but these values will be superseded by a user call to LINKSTYLE.
663 .\" ====================================================================
664 .SH SECTION HEADING LINKS
665 .\" ====================================================================
669 generates links to all section headings and places these at the top of the
676 for details of how to switch this off or alter the position).
679 .\" ====================================================================
680 .SH LIMITATIONS OF GROHTML
681 .\" ====================================================================
685 information is currently rendered as a PNG image.
688 .\" ====================================================================
690 .\" ====================================================================
692 .I @MACRODIR@/www.tmac
695 .\" ====================================================================
697 .\" ====================================================================
702 .MT gaius@\:glam.ac.uk
710 .MT groff\-bernd.warken\-72@\:web.de
715 .\" ====================================================================
717 .\" ====================================================================
718 .BR groff (@MAN1EXT@),
719 .BR @g@troff (@MAN1EXT@),
720 .BR \%grohtml (@MAN1EXT@),
724 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
731 .\" vim: set filetype=groff: