xref: /netbsd-src/usr.sbin/wsfontload/wsfontload.8 (revision d710132b4b8ce7f7cccaaf660cb16aa16b4077a0)
1.\"	$NetBSD: wsfontload.8,v 1.22 2003/05/06 08:43:45 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.Os
29.Dt WSFONTLOAD 8
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.Bk -words
36.Op Fl f Ar wsdev
37.Ek
38.Bk -words
39.Op Fl w Ar width
40.Ek
41.Bk -words
42.Op Fl h Ar height
43.Ek
44.Bk -words
45.Op Fl e Ar encoding
46.Ek
47.Bk -words
48.Op Fl N Ar name
49.Ek
50.Bk -words
51.Op Fl b
52.Ek
53.Bk -words
54.Op Fl B
55.Ek
56.Bk -words
57.Op Fl v
58.Ek
59.Op Ar fontfile
60.Sh DESCRIPTION
61The
62.Nm
63utility loads a font bitmap into the wsfont font pool
64(or a wscons device if the device driver supports this).
65The font gets assigned a name in this process which it can be referred to
66by later for use on a display screen.
67The font is loaded from the specified
68.Ar fontfile ,
69or from standard input if
70.Ar fontfile
71is not provided.
72.Pp
73The options are:
74.Bl -tag -width xxxxxxxxxxx
75.It Fl f Ar wsdev
76Specify the device to operate on.
77Default is
78.Pa /dev/wsfont .
79.It Fl w Ar width
80Sets the width of a font character in pixels.
81Default is 8.
82.It Fl h Ar height
83Sets the height of a font character in pixels.
84Default is 16.
85.It Fl e Ar encoding
86Sets the encoding of the font.
87This can be either a symbolic abbreviation or a numeric value.
88Currently recognized abbreviations are
89.Ql iso
90for ISO-8859-1 encoding,
91.Ql ibm
92for IBM encoded fonts and
93.Ql pcvt
94for the custom encoding of the supplemental fonts which came with
95the
96.Bx
97.Dq pcvt
98console driver.
99Per default,
100.Ql iso
101is assumed.
102.It Fl N Ar name
103Specifies a name which can be used later to refer to the font.
104If none is given, the
105.Ar fontfile
106name is used to create one.
107.It Fl b
108Specifies that the font data is ordered right-to-left bit wise.
109The default is left-to-right.
110.It Fl B
111Specifies that the font data is ordered right-to-left byte wise.
112The default is left-to-right.
113.It Fl v
114Prints the font's properties before loading it.
115.El
116.Pp
117Typically, the
118.Nm
119utility will be executed in system startup by the
120.Pa /etc/rc.d/wscons
121script, controlled by the
122.Pa /etc/wscons.conf
123configuration file.
124.Sh FILES
125.Pa /etc/wscons.conf
126.Pa /usr/share/wscons/fonts
127.Sh EXAMPLES
128.Dl wsfontload -N myname -h 8 -e ibm /usr/share/wscons/fonts/vt220l.808
129.Pp
130Load the IBM-encoded 8\(mu8-font from the
131.Xr wscons 4
132distribution. This (or another 8\(mu8-font) is necessary to use the
13350-line screen type on
134.Xr vga 4
135displays.
136.Pp
137.Dl wsfontload -N orator -e ibm /usr/share/wscons/fonts/orator.816
138.Dl wsconsctl -dw font=orator
139.Pp
140Load the
141.Dq orator
142IBM-encoded 8\(mu16 font and switch the console to this
143alternate font.
144.Sh SEE ALSO
145.Xr wscons 4 ,
146.Xr wsconscfg 8 ,
147.Xr wsconsctl 8
148.Sh BUGS
149Many features are missing.
150.Pp
151There is no way to remove a loaded font.
152