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