ter-u12b.bdf: fix e? and u+?
[terpinus.git] / README
blob3a4c52c409dd3622d1fc617332d691e334df17b6
1 Contents:
3 1. About.
4 1.1. Quick installation.
5 1.2. Recommended modes.
6 1.3. Legend.
7 1.4. Variants.
8 1.5. Notes.
10 2. Linux console.
11 2.1. consoletools.
12 2.2. kbd.
13 2.3. Quick reference.
14 2.4. Legend.
15 2.5. Notes.
17 3. UNIX console.
18 3.1. bsd-pcvt.
19 3.2. Legend.
20 3.3. Notes.
22 4. X11 Window System.
23 4.1. Installation.
24 4.2. Notes.
26 5. Frequently Asked Questions.
28 6. Bugs.
30 7. Legal information.
31 7.1. License.
32 7.2. Copyright.
35 1. About.
37 This archive contains source code for generating and installing Terminus
38 Font for Linux console, UNIX console and X11 Window System.
40 - version       4.20
41 - sizes         6x12, 8x14, 8x16, 10x20, 12x24, 14x28, 16x32
42 - styles        normal, bold, EGA/VGA bold
43 - code pages    ISO10646-1
44 - characters    690
45 - format        Bitmap Distribution Format (BDF) version 2.1
47 The character set covers ISO8859-1/2/5/9/13/15/16, IBM-437/852/855/866,
48 Windows-1250/1251/1252/1254/1257, KOI8-R/U/E/F, Paratype-PT154/PT254,
49 Bulgarian-MIK, Macintosh-Ukrainian, Esperanto and many others (a total of
50 about 110 language sets). Also included are the IBM VGA, vt100 and xterm
51 pseudographic characters.
53 1.1. Quick installation.
55 The commands:
57 $ ./configure [--prefix=PREFIX]
58 $ make
59 # make install
61 compile and install the Linux console and X11 Window System fonts, and
63 # make fontdir
65 updates fonts.dir for X11 (if you don't know what fonts.dir is, execute the
66 command).
68 1.2. Recommended modes.
70 Obviously, the larger and better a monitor is, the higher modes (with the
71 respective rates) can be used, and the more text may fit on the screen while
72 remaining comfortably readable - and vice versa. As a comparison base, it is
73 considered normal to use 640x480 and 800x600 modes with font size 8x16 and
74 10x20 respectively (that is, 80 columns by 30 lines) on 14" and 15" CRT
75 monitors.
77 Use modes that match your display ratio. Most personal computer monitors are
78 4:3, so use 1280x960 (4:3) instead of 1280x1024 (5:4) if possible. The
79 EGA/VGA text modes are 720x400 (9:5), but the font (i.e. sizes 8x14 and
80 8x16) is designed to work with them.
82 1.3. Legend.
84 The file names are structured as follows:
86 ter-u<SIZE><STYLE>.bdf
88 where <SIZE> is 12, 14, 16, 20, 24, 28 or 32, and <STYLE> is n for normal
89 (all sizes), b for bold (all sizes except 6x12) and v for EGA/VGA bold (8x14
90 and 8x16 only, makes use of the eight character matrix column).
92 1.4. Variants.
94 Some characters are implemented in two variants. The alternate variants are
95 on the font WEB page. To use a variant, download it and execute:
97 zcat terminus-font-<VERSION>-<NAME>.diff.gz | patch -p1
99 before installation. <VERSION> is the font version and <NAME> identifies the
100 variant.
102 1.5. Notes.
104 The commands marked with $ can be executed by a regular user.
105 The configure commands are optional.
107 Almost all characters which are not part of the code pages listed above are
108 available on X11/ISO10646-1 only (UTF+8/Unicode).
111 2. Linux console.
113 - sizes         6x12, 8x14, 8x16, 12x24, 10x20, 14x28 and 16x32
114 - styles        normal, bold, framebuffer-bold
115 - code pages    ISO8859-1/ISO8859-15/Windows-1252, ISO8859-2/Windows-1250,
116                 Windows-1251/ISO8859-5, ISO8859-9/Windows-1254, ISO8859-16,
117                 ISO8859-13/Windows-1257, IBM-437, Bulgarian-MIK, KOI8-R,
118                 KOI8-U, Paratype-PT154, combined
119 - characters    582
120 - format        PC Screen Font (PSF) with unicode data
122 2.1. consoletools.
124 $ ./configure [--prefix=PREFIX | --psfdir=DIRECTORY]
125 $ make psf
126 # make install-psf
128 The files are compressed with gzip and installed in DIRECTORY. If DIRECTORY
129 does not exist, it is created. The default PREFIX is /usr. The default
130 DIRECTORY is PREFIX/share/consolefonts. Requires Perl.
132 If you don't have mappings for Windows-1252/1250/1251/1254/1257, ISO8859-16,
133 IBM-437, KOI8-R, Bulgarian-MIK or Paratype-PT154/PT254, also run:
135 $ ./configure [--prefix=PREFIX | --acmdir=DIRECTORY]
136 $ make txt
137 # make install-acm
139 The default DIRECTORY is PREFIX/share/consoletrans. Requires awk.
140 Uninstallation of the mappings is not supported. To load a font:
142 $ consolechars [-m MAPPING] -f ter-<X><SIZE><STYLE>
144 where <X> is a character identifying the code page as listed in p.2.4.
146 2.2. kbd.
148 $ ./configure [--psfdir=DIRECTORY]
149 $ make psf
150 # make install-psf
152 where DIRECTORY should be either PREFIX/lib/kbd/consolefonts or
153 PREFIX/share/kbd/consolefonts, depending on kbd version, and PREFIX is
154 usually /usr. The missing mappings are installed with:
156 $ ./configure [--prefix=PREFIX | --unidir=DIRECTORY]
157 $ make txt
158 # make install-uni
160 The default DIRECTORY is PREFIX/share/kbd/consoletrans. Requires awk. To
161 load a font:
163 $ setfont [-m MAPPING] ter-<X><SIZE><STYLE>
165 where <X> is a character identifying the code page as listed in p.2.4.
167 2.3. Quick reference.
169 $ ./configure [--prefix=PREFIX | --psfdir=DIRECTORY | --ref=FILENAME]
170 # make install-ref
172 Installs the text from p.2.4. as FILENAME (the default is README.terminus)
173 in DIRECTORY.
175 2.4. Legend.
177 names   mappings                covered codepage(s)
179 ter-1*  iso01, iso15, cp1252    ISO8859-1, ISO8859-15, Windows-1252
180 ter-2*  iso02, cp1250           ISO8859-2, Windows-1250
181 ter-9*  iso09, cp1254           ISO8859-9, Windows-1254
182 ter-c*  cp1251, iso05           Windows-1251, ISO8859-5
183 ter-d*  iso13, cp1257           ISO8859-13, Windows-1257
184 ter-g*  iso16                   ISO8859-16
185 ter-i*  cp437                   IBM-437
186 ter-k*  koi8r                   KOI8-R
187 ter-m*  mik                     Bulgarian-MIK
188 ter-p*  pt154                   Paratype-PT154
189 ter-u*  koi8u                   KOI8-U
190 ter-v*  all listed above,       all listed above, Paratype-PT254,
191         pt254 etc. (if you      Macintosh-Ukrainian, KOI8-U/E/F and
192         have such mappings)     IBM-852/855/866, 8 foreground colors
194 names   style
196 ter-*n  normal
197 ter-*b  bold
198 ter-*f  framebuffer-bold
200 2.5. Notes.
202 The combined code page is based on IBM-437 (character 0xFF is ogonek).
203 The ISO8859-16 font also includes all letters and accents from Windows-1250.
205 The Linux kernel 2.4 framebuffers support widths 8, 12 and 16 only; kernel
206 2.6 and a relevant framebuffer are required to use the other sizes.
209 3. UNIX console.
211 - sizes         8x14, 8x16
212 - styles        normal, bold, framebuffer-bold
213 - code pages    ISO8859-1/Windows-1252, ISO8859-2, ISO8859-5, ISO8859-9,
214                 ISO8859-9/Windows-1254, ISO8859-13, ISO8859-15, ISO8859-16,
215                 IBM-437, KOI8-R, KOI8-U, Paratype-PT154
216 - characters    542
217 - format        raw data
219 3.1. bsd-pcvt.
221 $ ./configure [--prefix=PREFIX | --rawdir=DIRECTORY]
222 $ make raw
223 # make install.raw
225 or, for file names with minus instead of period:
227 # make install-raw
229 The default DIRECTORY is PREFIX/share/misc/pcvtfonts. The fonts are
230 installed uncompressed. Requires Perl. To load a font:
232 $ loadfont -f /usr/share/misc/pcvtfonts/ter-<X><STYLE>.8<SIZE>
234 or, for file names with minus instead of period:
236 $ loadfont -f /usr/share/misc/pcvtfonts/ter-<X><STYLE>-8x<SIZE>
238 where <X> is a character identifying the code page as listed in p.3.2.
240 3.2. Legend.
242 names   covered codepage(s)
244 ter-1*  ISO8859-1, Windows-1252
245 ter-2*  ISO8859-2
246 ter-5*  ISO8859-5
247 ter-9*  ISO8859-9, Windows-1254
248 ter-c*  Windows-1251
249 ter-d*  ISO8859-13
250 ter-f*  ISO8859-15
251 ter-g*  ISO8859-16
252 ter-i*  IBM-437
253 ter-k*  KOI8-R
254 ter-p*  Paratype-PT154
255 ter-u*  KOI8-U
257 names   style
259 ter-*n  normal
260 ter-*b  bold
261 ter-*f  framebuffer-bold
263 3.3. Notes.
265 The RAW font contains data only and should be compatible with all UNIX
266 systems. If any of the bold fonts doesn't look good try framebuffer-bold,
267 or, if you are using an EGA/VGA adapter, program it to to clear column 8 of
268 the character matrix (attribute controller register 0x10 bit 0x02).
271 4. X11 Window System.
273 - sizes         6x12, 8x14, 8x16, 10x20, 12x24, 14x28 and 16x32
274 - styles        normal, bold
275 - code pages    ISO8859-1/Windows-1252, ISO8859-2, ISO8859-5,
276                 ISO8859-9/Windows-1254, ISO8859-13, ISO8859-15, ISO8859-16,
277                 Windows-1251, KOI8-R, KOI8-U, Paratype-PT154, ISO10646-1
278 - characters    689
279 - format        Portable Compiled Font (PCF)
281 4.1. Installation.
283 $ ./configure [--prefix=PREFIX | --x11dir=DIRECTORY]
284 $ make pcf
285 # make install-pcf
287 The files are compressed with gzip and installed in DIRECTORY. If DIRECTORY
288 does not exist, it is created. The default PREFIX is /usr. The default
289 DIRECTORY is PREFIX/X11R6/lib/X11/fonts/local. Requires Perl and bdftopcf.
290 Some X11 libraries and applications substitute the missing bold fonts by
291 shifting the normal fonts. To avoid such substitution for 6x12, run:
293 # make install-12b
295 To update fonts.dir file in DIRECTORY after (un)installation, use:
297 # make fontdir
299 The configuration file which lists the font directories must contain
300 DIRECTORY. If xfs or the X-server have been active during the installation,
301 they should be restarted so the font list can be updated.
303 See also mkfontdir(1), xorg.conf(5), xfs(1), xlsfonts(1) and fonts-conf(5).
305 4.2. Notes.
307 The ISO8859-1 and ISO8859-9 fonts contain the Windows Western characters and
308 can be used as Windows-1252 and Windows-1254 respectively.
311 5. Frequently Asked Questions.
313 Q. Italic version?
315 A. No. The quality is significantly lower, and preserving the font width
316 requires overlapping characters, which are not handled very well by X11/Xft.
317 If you need it than much, try mkitalic from FreeBSD or bdfslant from Debian.
319 Q. Scalable version?
321 A. Probably a TrueType font in 2006/7. No italic version will be included
322 unless it is very easy to implement.
324 Q. Win32 version?
326 A. No, there are problems with the raster font codepages and sizes. You can
327 try the pseudo-TrueType version by Eric Shao-yu Cheng.
329 Q. How to create an italic version with mkitalic?
331 A. Sorry, but I do not answer questions about mkitalic, bdfslant and the
332 pseudo-TrueType version, neither to questions specific to a particular Linux
333 distribution. Read the sources/documentation or write to the respective
334 package maintainer.
336 Q. How about some new characters?
338 A. Fine, if they aren't very complex - but be ready to help. To make the new
339 characters easily readable, I must have a very good idea what they should
340 look like. The digits and most of the letters and punctuation characters
341 that I'm familiar with are already included in the font, so your assistance
342 will most probably be required for the new ones.
344 Q. The bold 6x12 font...
346 A. ...does not exist - see 4.1.
348 Q. The font works in X11/Motif, but not in GNOME/KDE/Xfce.
350 A. See fonts-conf(5).
351                                                                                                         variant
352 Q. The lowercase cyrillic k...
354 A. ...has been fixed, and the previous (high) k is now a varianth.
357 6. Bugs.
359 Size 6x12, size 14x28 bold style and size 16x32 normal style are of worse
360 quality than the others. Avoid them.
362 The eth modifier should be based on curve not diagonal.
364 Shha, Dje, Tshe, shha, dje tshe and may be wrong and/or font incompliant.
366 The upper-P-part of Thorn in sizes 6x12 and 12x24 is not centered.
368 The modifiers of Ghe middlehook, ghe middlehook, Eng and eng are mostly
369 random.
371 Several accents are implemented as combining accents, commaturnedmod is
372 arbitary.
375 7. Legal information.
377 7.1. License.
379 You can use and distribute this archive and the character varianths freely
380 and without charge under the terms of the GNU General Public License version
381 2.0 or (at your choice) any later version.
383 7.2. Copyright.
385 Terminus Font 4.20, Copyright (C) 2006 Dimitar Toshkov Zhekov.
386 Report bugs to <jimmy@is-vn.bg>
389 Thanks to Anton Zinoviev, Kir Koliushkin and all others who helped.