xref: /netbsd-src/usr.sbin/wsfontload/wsfontload.8 (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1.\"	$NetBSD: wsfontload.8,v 1.26 2011/06/08 12:47:51 wiz Exp $
2.\"
3.\" Copyright (c) 1999, 2001
4.\" 	Matthias Drochner.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.Dd May 4, 2003
28.Dt WSFONTLOAD 8
29.Os
30.Sh NAME
31.Nm wsfontload
32.Nd "load a font bitmap into the wsfont pool or a wscons display device"
33.Sh SYNOPSIS
34.Nm
35.Op Fl Bbv
36.Op Fl e Ar encoding
37.Op Fl f Ar wsdev
38.Op Fl h Ar height
39.Op Fl N Ar name
40.Op Fl w Ar width
41.Op Ar fontfile
42.Sh DESCRIPTION
43The
44.Nm
45utility loads a font bitmap into the wsfont font pool
46(or a wscons device if the device driver supports this).
47The font gets assigned a name in this process which it can be referred to
48by later for use on a display screen.
49The font is loaded from the specified
50.Ar fontfile ,
51or from standard input if
52.Ar fontfile
53is not provided.
54.Pp
55The options are:
56.Bl -tag -width xxxxxxxxxxx
57.It Fl B
58Specifies that the font data is ordered right-to-left byte wise.
59The default is left-to-right.
60.It Fl b
61Specifies that the font data is ordered right-to-left bit wise.
62The default is left-to-right.
63.It Fl e Ar encoding
64Sets the encoding of the font.
65This can be either a symbolic abbreviation or a numeric value.
66Currently recognized abbreviations are:
67.Bl -tag -width xxxxxxx
68.It Ql iso
69ISO-8859-1 encoding
70.It Ql ibm
71IBM encoded fonts
72.It Ql pcvt
73the custom encoding of the supplemental fonts which came with the
74.Bx
75.Dq pcvt
76console driver
77.It Ql iso2
78ISO-8859-2 (east european) encoding
79.It Ql iso7
80ISO-8859-7 (greek) encoding
81.It Ql koi8r
82KOI8-R (russian) encoding
83.El
84Per default,
85.Ql iso
86is assumed.
87.It Fl f Ar wsdev
88Specify the device to operate on.
89Default is
90.Pa /dev/wsfont .
91.It Fl h Ar height
92Sets the height of a font character in pixels.
93Default is 16.
94.It Fl N Ar name
95Specifies a name which can be used later to refer to the font.
96If none is given, the
97.Ar fontfile
98name is used to create one.
99.It Fl v
100Prints the font's properties before loading it.
101.It Fl w Ar width
102Sets the width of a font character in pixels.
103Default is 8.
104.El
105.Pp
106Typically, the
107.Nm
108utility will be executed in system startup by the
109.Pa /etc/rc.d/wscons
110script, controlled by the
111.Pa /etc/wscons.conf
112configuration file.
113.Sh FILES
114.Pa /etc/wscons.conf
115.Pa /usr/share/wscons/fonts
116.Sh EXAMPLES
117.Dl wsfontload -N myname -h 8 -e ibm /usr/share/wscons/fonts/vt220l.808
118.Pp
119Load the IBM-encoded 8\(mu8-font from the
120.Xr wscons 4
121distribution.
122This (or another 8\(mu8-font) is necessary to use the
12350-line screen type on
124.Xr vga 4
125displays.
126.Pp
127.Dl wsfontload -N orator -e ibm /usr/share/wscons/fonts/orator.816
128.Dl wsconsctl -dw font=orator
129.Pp
130Load the
131.Dq orator
132IBM-encoded 8\(mu16 font and switch the first console screen
133(ttyE0, wsconsctl's default) to this alternate font.
134.Sh SEE ALSO
135.Xr wscons 4 ,
136.Xr wsconscfg 8 ,
137.Xr wsconsctl 8
138.Sh BUGS
139Many features are missing.
140.Pp
141There is no way to remove a loaded font.
142