summaryrefslogtreecommitdiffstats
path: root/usr.sbin/wsfontload/wsfontload.8
blob: 7467565f6c7429d6ec3c809f23b3aff87cb79c6a (plain) (blame)
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
.\"	$OpenBSD: wsfontload.8,v 1.5 2001/03/15 05:50:41 mickey Exp $
.\"	$NetBSD: wsfontload.8,v 1.5 1999/04/06 04:54:22 cgd Exp $
.\"
.Dd January 13, 1999
.Os
.Dt WSFONTLOAD 8
.Sh NAME
.Nm wsfontload
.Nd load a font bitmap into a wscons display device
.Sh SYNOPSIS
.Nm wsfontload
.Bk -words
.Op Fl B
.Ek
.Bk -words
.Op Fl b
.Ek
.Bk -words
.Op Fl e Ar encoding
.Ek
.Bk -words
.Op Fl f Ar file
.Ek
.Bk -words
.Op Fl h Ar height
.Ek
.Bk -words
.Op Fl l
.Ek
.Bk -words
.Op Fl N Ar name
.Ek
.Bk -words
.Op Fl w Ar width
.Ek
.Op Ar fontfile
.Sh DESCRIPTION
The
.Nm
utility loads a font bitmap to a wscons device if the device driver
supports it.
The font gets assigned a name in this process which it can be referred to
by later for use on a display screen.
The font is loaded from the specified
.Ar fontfile ,
or from
.Pa stdin
if
.Ar fontfile
is not provided.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl b
Specifies that the font data is ordered right-to-left bit wise.
The default is left-to-right.
.It Fl B
Specifies that the font data is ordered right-to-left byte wise.
The default is left-to-right.
.It Fl e Ar encoding
Sets the encoding of the font.
This can be either a symbolic abbreviation or a numeric value.
Currently recognized abbreviations are
.Dq iso
for ISO-8859-1 encoding,
.Dq ibm
for IBM encoded fonts, and
.Dq pcvt
for the custom encoding of the supplemental fonts which came with the BSD
.Xr pcvt 4
console driver.
Per default,
.Dq iso
is assumed.
.It Fl f Ar file
Specify the control device of the wscons display to operate on.
Default is
.Pa /dev/ttyCcfg .
.It Fl h Ar height
Sets the height of a font character in pixels.
Default is 16.
.It Fl l
Specifies to print out a list of loaded fonts, no other
arguments should be specified.
.It Fl N Ar name
Specifies a name which can be used later to refer to the font.
In none is given, the
.Ar fontfile
name is used to create one.
.It Fl w Ar width
Sets the width of a font character in pixels.
Default is 8.
.El
.Pp
Typically, the
.Nm
utility will be executed in system startup by the
.Pa /etc/rc.wscons
script, controlled by the
.Pa /etc/wscons.conf
configuration file.
.Pp
No font files are provided with the wscons framework.
The fonts installed by
.Xr pcvt 4
can be used instead, as can raw font files from other operating system
distributions.
.Sh EXAMPLES
The following examples demonstrate the functionality of
.Nm wsfontload .
.Pp
.Dl wsfontload -N myname -h 8 -e ibm /usr/share/pcvt/fonts/vt220l.808
.Pp
Load the IBM-encoded 8x8-font from the
.Xr pcvt 4
distribution.
This (or another 8x8-font) is necessary to use the 50-line screen type on
.Xr vga 4
displays.
.Sh FILES
.Bl -tag -width /etc/wscons.conf -compact
.It Pa /etc/wscons.conf
wscons configuration file
.El
.Sh SEE ALSO
.Xr wscons 4 ,
.Xr wsconscfg 8 ,
.Xr wsconsctl 8
.Sh HISTORY
The
.Nm
program appeared in
.Ox 2.8 .
.Sh BUGS
Many features are missing.
.Pp
There is no way to remove a loaded font.