.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "tmp::NG7L0MUk7i::Hoola 3"
.TH tmp::NG7L0MUk7i::Hoola 3 "2018-12-25" "EN Tools" "EN Tools"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
wml::des::gfont \- Graphical Font Tag
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& #use wml::des::gfont
\&
\& <gfont [attributes]>One Single Line Of Text</gfont>
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a nice interface to the \fBgFONT\fR program which can be found at
http://www.engelschall.com/sw/gfont/. It provides a \f(CW\*(C`<gfont>\*(C'\fR tag
which can be used similar to the standard \s-1HTML\s0 tag \f(CW\*(C`<font>\*(C'\fR. But
instead of online rendering by the webbrowser the text is rendered offline via
\&\fIgfont\fR into a \s-1GIF\s0 image.  This has the following advantages:
.IP "All TeX-available fonts can be used." 4
.IX Item "All TeX-available fonts can be used."
you can use any TeX-available fonts instead of the commonly known ones the
typical browsers support. These fonts will actually look like you want, i.e.
Helvetica _is_ Helvetica with \f(CW\*(C`<gfont>\*(C'\fR while it can be Arial or a
totally different (substituted) font when using the \f(CW\*(C`<font>\*(C'\fR tag.
.IP "Fonts with much greater size can be used." 4
.IX Item "Fonts with much greater size can be used."
With \f(CW\*(C`<gfont>\*(C'\fR you can increase the \f(CW\*(C`size\*(C'\fR attribute up to \f(CW+9\fR
which is actually 200pt in size while the \s-1HTML\s0 \fBfont\fR tag usually stops at
\&\f(CW+4\fR. So \f(CW\*(C`<gfont>\*(C'\fR can be used for big headlines.
.IP "You can create banners with colored backgrounds." 4
.IX Item "You can create banners with colored backgrounds."
The standard \f(CW\*(C`<font>\*(C'\fR tag cannot use a different background color in
\&\s-1HTML 3.2,\s0 \f(CW\*(C`<gfont>\*(C'\fR can. Because it directly renders into a \s-1GIF\s0 image
which background has not to be transparent.
.PP
When an image is generated, a text file containing the command which has
been run is created, its name is the image file name with a \f(CW\*(C`.cmd\*(C'\fR
suffix.  When \s-1WML\s0 is re-run, this file is searched for and gFONT
executed only if command line has changed.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.IP "base=\fIfilename\fR" 4
.IX Item "base=filename"
Usually the created images for a source file \fIpage.wml\fR are named
\&\fIpage.gfontXXX.gif\fR where \f(CW\*(C`XXX\*(C'\fR is a number starting with \f(CW000\fR. When you
use a \f(CW\*(C`base=foo\*(C'\fR attribute, then the resulting files are named
\&\fIfoo.gfontXXX.gif\fR.  Actually you can even use a complete filename including
a directory prefix, i.e.  when you use \f(CW\*(C`base=../../common/foo\*(C'\fR attribute,
then the \s-1GIF\s0 images are created as \fI../../common/foo.gfontXXX.gif\fR. Use this
feature to direct the images to a particular directory. Additionally using a
\&\f(CW\*(C`base=""\*(C'\fR attribute leads to images which are so-called hidden Unix files or
dot-files.
.Sp
And for most flexibility when no base is specified and the variable
\&\f(CW\*(C`GFONT_BASE\*(C'\fR is defined (usually from within a \fI.wmlrc\fR file via
\&\f(CW\*(C`\-DGFONT_BASE~path/to/gfont/dir/base\*(C'\fR) it is used.  Use this feature to
redirect the created images to a particular directory.
.Sp
You may also use the variable \f(CW\*(C`IMAGE_BASE\*(C'\fR which defines in a single line
all base names for images generated by \s-1WML.\s0
.IP "file=\fIfilename\fR" 4
.IX Item "file=filename"
Use this to explicitly set the output filename for the \s-1GIF\s0 image.  This is
usually not used, because you don't need to know the actual filename. But
sometimes it can be useful to explicitly set it.
.IP "notag" 4
.IX Item "notag"
This forces \f(CW\*(C`<gfont>\*(C'\fR to expand to nothing, i.e. no resulting
\&\f(CW\*(C`<img>\*(C'\fR tag. The image itself is still generated. In combination with
the above \f(CW\*(C`file\*(C'\fR attribute this can be used to generate images to particular
files which can be used at other positions, for instance inside
\&\f(CW\*(C`<rollover>\*(C'\fR (see \fBwml::des::rollover\fR\|(3)) tags.
.IP "color=#\fIrrggbb\fR" 4
.IX Item "color=#rrggbb"
Sets the font (foreground) color. Default is \f(CW\*(C`#000000\*(C'\fR which is black.
.IP "bgcolor=#\fIrrggbb\fR" 4
.IX Item "bgcolor=#rrggbb"
Sets the image background color. Default is no color at all, i.e. transparent
background.
.IP "face=\fIfontname\fR" 4
.IX Item "face=fontname"
Sets the type of the used font where \fIfontname\fR is actually any TeX-available
font or a name alias from the \fIFontmap\fR file of gFONT. See \fBgfont\fR\|(1) for more
details. Default is \f(CW\*(C`Times\*(C'\fR.
.IP "size=\fInumber\fR" 4
.IX Item "size=number"
Sets the relative size of the font, similar to the \s-1HTML 3.2\s0 \f(CW\*(C`<font<\*(C'\fR
tag. Default is 0. The following correspondence to pt-sizes exists:
.Sp
.Vb 2
\& size:  \-2 \-1  0  1  2  3  4  5   6   7   8   9
\&   pt:  12 16 20 32 40 50 60 80 100 120 140 160
.Ve
.Sp
This leads to nearly the same font sizes for \f(CW\*(C`<font>\*(C'\fR and
\&\f(CW\*(C`<gfont>\*(C'\fR tags on typical browser setups.
.IP "align=\fIlocation\fR" 4
.IX Item "align=location"
This directly corresponds to the \f(CW\*(C`align\*(C'\fR attribute of the \f(CW\*(C`<img>\*(C'\fR
tag.
.IP "crop" 4
.IX Item "crop"
This indicates that the image should be cropped, i.e. the edges containing only
the background color should be removed.
.IP "adjust=\fIspec\fR" 4
.IX Item "adjust=spec"
This passes through \fIspec\fR to the \fB\-r\fR option of gFONT which adjusts the
size of the final image. Use this to expand the image and/or align it.
.IP ":img:\fI\s-1ATTR\s0\fR=\fI\s-1STR\s0\fR" 4
.IX Item ":img:ATTR=STR"
The ``\fI\s-1ATTR\s0\fR=\fI\s-1STR\s0\fR'' pairs are passed along to the \f(CW\*(C`<img>\*(C'\fR \s-1HTML\s0 tag.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
.Vb 3
\& <gfont face="HelveticaBold" size=+6 color="#3333cc">
\& A sample Headerline
\& </gfont>
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 3
\& Ralf S. Engelschall
\& rse@engelschall.com
\& www.engelschall.com
.Ve
.SH "REQUIRES"
.IX Header "REQUIRES"
.Vb 2
\& Internal: P1, P2, P3, Image::Size (P5M)
\& External: gfont (PATH)
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1HTML\s0 \f(CW\*(C`<font>\*(C'\fR tag,
\&\fBgfont\fR\|(1),
http://www.engelschall.com/sw/gfont/