This manual page describes the GNU -mwww macros, which is part of the
groff document formatting system.
The manual page is very a basic guide, and the html device driver
has been completely rewritten but still remains as in an alpha state.
It has been included into the distribution so that a lot of people have a
chance to test it.
Note that this macro file will be automatically called (via the
troffrc file) if you use -Thtml.
To see the hyperlinks in action, please format this man page with the
Here is a summary of the functions found in this macro set.
.HTMLINDEXdetermine automatic link cut off
point for sections/headers
.BODYCOLORspecify colours on a web page
.BACKGROUNDspecify background image
.URLcreate a url using two parameters
.MAILTOcreate a html email address
.FTPcreate an ftp reference
.IMAGEinclude an image file
.HTMLpass an html raw request to the
.TAGgenerate an html name tag from $1
.LINEcreate a full width horizontal rule
Output of the
preprocessors is acceptable as input.
determines the cut off point for automatic link generation to headings.
By default all headings found in a troff document have links created to them
at the top of the html web page.
It maybe that many of the lower heading levels do not require links.
Alternatively some web pages may not need any heading links at all, in which
not to generate links.
An HTMLINDEX of 2 will mean that a heading
1.1.1 Some Title
will not be included in the links either as it is said to have a heading
level of three.
Another method for switching automatic headings is via the command line
takes five parameters: foreground, background, active hypertext link,
hypertext link not yet visited, and visited hypertext link colour.
the only parameter to this macro is the background image file.
a URL using either two or three arguments.
$1 is the name of the link, $2 is the actual URL, and $3 is optional stuff
to be printed immediately after $2.
Hyphenation is disabled while printing the actual URL; explicit breakpoints
should be inserted with the
Here is how to encode
If this is processed by a device other than -Thtml
it appears as:
homepage for groff lahttp://groff.:ffii.:orgra.
The URL macro can be of any type; for example we can reference
.URL "Eric Raymond's pic guide" pic.html
generates an email html reference.
The first argument is mandatory as the email address.
The optional second argument is the text you see in your browser, and
an optional third argument is stuff printed immediately after the
Hyphenation is disabled while printing the actual email address.
For example, the groff maintainers are
This is achieved by the following macros:
Note that all the urls actually are treated as consuming no textual space
This could be considered as a bug since it causes some problems.
To circumvent this, www.tmac inserts a zero-width character which
expands to a harmless space (only if run with -Thtml).
indicates that data can be obtained via ftp.
The first argument is the browser text and the second is the url.
A third argument, similar to the macros above, is intended for stuff printed
immediately after the second argument.
The second and the third parameter are optional.
Hyphenation is disabled while printing the actual URL.
As an example, here the location of the
The macro example above was specified by:
allows the document to include pictures.
The first argument is the image file.
The second optional argument gives the horizontal location;
puts the image to the left border,
to the right.
Any other value centers the image.
The next two arguments are optional also:
Argument three is the width in pixels (default is 400 pixels if absent).
The fourth argument is the height in pixels (default is the width value if
all text after this macro is treated as raw html.
If the document is processed without -Thtml then
the macro is ignored.
This macro is a building block for other higher level macros.
For example, the BACKGROUND macro is defined as:
. HTML <body background=\$1>
generates an html name tag from its argument.
This can then be referenced using the
As you can see, you must precede the tag name with `#' since it is
a local reference.
This link was achieved via placing a TAG in the URL description above;
the source looks like this:
a URL using either two or three
$1 is the name of the link, $2 is the actual URL.
generates a full width horizontal rule.
requests that grohtml place the automatically generated links at this position.
SECTION HEADING LINKS
generates links to all section headings and places these at the top of the
html document. (See
for details of how to switch this off or alter the position.
LIMITATIONS OF GROHTML
Tbl information is currently rendered as a png image.