File: gfont.pod

package info (click to toggle)
gfont 1.0.3-1
  • links: PTS
  • area: non-free
  • in suites: sarge, woody
  • size: 504 kB
  • ctags: 513
  • sloc: ansic: 6,465; sh: 823; makefile: 284; perl: 156
file content (226 lines) | stat: -rw-r--r-- 5,971 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
##         _____ ___  _   _ _____ 
##    __ _|  ___/ _ \| \ | |_   _|
##   / _` | |_ | | | |  \| | | |  
##  | (_| |  _|| |_| | |\  | | |  
##   \__, |_|   \___/|_| \_| |_|  
##   |___/                        
##  
##  gFONT -- Create GIF image rendered with TeX-available Font
##
##  The gFONT program creates a GIF image for a given ASCII string
##  by the use of an arbitrary TeX-available font (Postscript or
##  METAFONT). The used font is converted from TeX's PK format to
##  gFONT's own GdF format (Gd Font) and rendered into the
##  resulting GIF image by the use of its own enhanced Gd library.
##  The result is intended to be included into HTML pages with an
##  IMG tag.
##
##  ======================================================================
##
##  Copyright (c) 1997 Ralf S. Engelschall, All rights reserved.
##  Copyright (c) 1999 Denis Barbier
##
##  This program is free software; it may be redistributed and/or modified
##  only under the terms of either the Artistic License or the GNU General
##  Public License, which may be found in the ePerl source distribution.
##  Look at the files ARTISTIC and COPYING or run ``eperl -l'' to receive
##  a built-in copy of both license files.
##
##  This program is distributed in the hope that it will be useful, but
##  WITHOUT ANY WARRANTY; without even the implied warranty of
##  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See either the
##  Artistic License or the GNU General Public License for more details.
##
##  ======================================================================
##
##  gfont.pod -- manual page 
##

=head1 NAME

gFONT -- Create GIF image rendered with TeX-available Font

=head1 SYNOPSIS

B<gfont>
[B<-b> I<RRGGBB>]
[B<-f> I<RRGGBB>]
[B<-F> I<NAME>]
[B<-G> I<PATH>]
[B<-a> I<NUM>]
[B<-c>]
[B<-s> I<SPEC>]
[B<-i>]
[B<-o> I<FILE>]
[B<-v>]
[I<STRING>]

B<gfont>
[B<-V>]

=head1 VERSION

@V@

=head1 DESCRIPTION

gFONT creates a GIF image for the given ASCII I<STRING> by the use of an
arbitrary TeX-available I<font> (originating either from Postscript or
METAFONT font descriptions). The used font is converted from TeX's PK format
to gFONT's own GdF format (Gd Font) and rendered into the resulting GIF image
by the use of its own enhanced I<Gd> library.  The result is intended to be
included into HTML pages with an C<E<lt>imgE<gt>> tag.

The highlight is the fact that it makes use of TeX's PK files, i.e. you can
use any TeX-available font which is accessible on your system through the
programs F<mf> (METAFONT) or F<gsftopk> (Ghostscript-Font-to-TeX-PK).

=head1 OPTIONS

=over 4

=item B<-b> I<RRGGBB>, B<--background=>I<RRGGBB>

Sets the background color. Default is no color, i.e. transparent background.

=item B<-f> I<RRGGBB>, B<--foreground=>I<RRGGBB>

Sets the foreground color. Default is `000000' which is black.

=item B<-F> I<NAME>, B<--fontname=>I<NAME>

Sets the font face to I<name>. Default is `C<CMBoldface-V>' (Computer Modern
Boldface).  The I<NAME> is either a METAFONT fontname or a Postscript fontname
plus the point size appended with a dash. Additionally the fontname can be an
alias from the file F<Fontmap>.

Typical examples for fontnames are:

  Computer Modern Family 
  (add `F',`T',`S',`L',`H',`V' or nothing after dash for size):
      CMBoldface
      CMItalic
      CMRoman
      CMSansSerif
      CMTeleType

  Adobe Type Basics:
  (add `20', `40', etc. after dash for size):
      Courier
      CourierBold
      CourierOblique
      CourierBoldOblique
      Helvetica
      HelveticaBold
      HelveticaOblique
      Times
      TimesBold
      TimesItalic
      TimesBoldItalic

=item B<-G> I<PATH>, B<--gdf-path=>I<PATH>

Set the GdF path where gFONT should search for F<.gdf> files.

=item B<-a> I<NUM>, B<--anti-alias=>I<NUM>

Applies an anti-alias filter with I<NUM> intermediate colors.
I<This is currently still experimental!>

=item B<-c>, B<--crop>

Crops the image to its physical content edges, i.e. strip off all surrounding
background pixels.

=item B<-r> I<SPEC>, B<--resize=>I<SPEC>

Adjusts the image to a particular result size. The parameters are given
in I<SPEC> and are of the form 

   SPEC    ::= x-spec 'x' y-spec
   x-spec  ::= [+] x-size [x-align]
   x-align ::= L|C|R
   y-spec  ::= [+] y-size [y-align]
   y-align ::= T|M|B

=item B<-i>, B<--interlace>

This enables the GIF I<Interlacing> feature which leads to a blending effect
in most Webbrowsers when the image is loaded.

=item B<-o> I<FILE>, B<--output-file=>I<FILE>

Forces the output to be written to F<FILE> instead of the default output
file F<out.gif>. 

=item B<-v>, B<--verbose>

Enables verbose mode.

=item B<-V>, B<--version>

Displays version identification string.

=back

=head1 ENVIRONMENT

=over

=item C<GFONT_BASE>

The directory containing all gFONT related files, except the gfont
binary and documentation (default is F<@libdir@@libsubdir@>).

=item C<GDFPATH>

The path variable to the GdF format files (default is F<@tmpgdfdir@>).

=back

=head1 FILES

=over

=item F<$GFONT_BASE/etc/Fontmap>

File containing the correspondance between fontnames and the real font
names, with the right B<mf:> or B<ps:> prefix.

=item F<$GFONT_BASE/gdf>

Default location where gFONT searches for GdF files.  Should usually be
read-only when the next directory is not the same.

=item F<$GDFPATH>

Location where gFONT's F<gfont_mkgdf> utility puts on-the-fly generated GdF
files. This per default is the same as the directory but has not to be.

=back

=head1 RESTRICTIONS

To render 8-bit characters, gFONT can use EC fonts. Unfortunately,
TeX and isolatin encodings differ for some characters. So output will be
wrong when including those characters.

Moreover, the German sz ligature is ugly and should be replaced by the
one in the CM fonts.

=head1 AUTHORS

  Ralf S. Engelschall
  rse@engelschall.com
  www.engelschall.com

  Denis Barbier
  barbier@imacs.polytechnique.fr

=head1 SEE ALSO

mf(1), gdftopk(1)

=cut

##EOF##