1.\" $OpenBSD: wsfontload.8,v 1.22 2020/09/14 09:34:08 fcambus 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 $Mdocdate: September 14 2020 $ 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 Bbl 38.Op Fl e Ar encoding 39.Op Fl f Ar file 40.Op Fl h Ar height 41.Op Fl N Ar name 42.Op Fl w Ar width 43.Op Ar fontfile 44.Ek 45.Sh DESCRIPTION 46The 47.Nm 48utility loads a font bitmap to a wscons device if the device driver 49supports it. 50The font gets assigned a name in this process which it can be referred to 51by later for use on a display screen. 52The font is loaded from the specified 53.Ar fontfile , 54or from 55.Pa stdin 56if 57.Ar fontfile 58is not provided. 59.Pp 60The options are as follows: 61.Bl -tag -width Ds 62.It Fl B 63Specifies that the font data is ordered right-to-left byte wise. 64The default is left-to-right. 65.It Fl b 66Specifies that the font data is ordered right-to-left bit wise. 67The default is left-to-right. 68.It Fl e Ar encoding 69Sets the encoding of the font. 70This can be either a symbolic abbreviation or a numeric value. 71Currently recognized abbreviations are 72.Dq iso 73for ISO 8859-1 or ISO-10646 74.Pq Unicode 75encoding 76and 77.Dq ibm 78for IBM encoded fonts. 79Per default, 80.Dq iso 81is assumed. 82.It Fl f Ar file 83Specify the control device of the wscons display to operate on. 84Default is 85.Pa /dev/ttyCcfg . 86.It Fl h Ar height 87Sets the height of a font character in pixels. 88Default is to match the currently loaded font height for raster displays, 89and 16 for text-mode VGA compatible displays. 90.It Fl l 91Specifies to print out a list of loaded fonts, no other 92arguments should be specified. 93.It Fl N Ar name 94Specifies a name which can be used later to refer to the font. 95If none is given, the 96.Ar fontfile 97name is used to create one. 98.It Fl w Ar width 99Sets the width of a font character in pixels. 100Default is to match the currently loaded font width for raster displays, 101and 8 for text-mode VGA compatible displays. 102.El 103.Pp 104.\" Typically, the 105.\" .Nm 106.\" utility will be executed in system startup by the 107.\" .Pa /etc/rc.wscons 108.\" script, controlled by the 109.\" .Pa /etc/wscons.conf 110.\" configuration file. 111.\" .Pp 112No font files are provided with the wscons framework. 113The fonts installed by PCVT can be used instead, as can raw font files from 114other operating system distributions. 115.Pp 116A maximum of 8 fonts can be loaded. 117The maximum size of a font is currently 512 KiB. 118.Sh FILES 119.Bl -tag -width "/usr/share/misc/pcvtfonts/XX" -compact 120.\" .It Pa /etc/wscons.conf 121.\" wscons configuration file 122.It Pa /usr/share/misc/pcvtfonts/ 123fonts directory. 124.El 125.Sh EXAMPLES 126Load the IBM-encoded 8x8-font from the PCVT distribution. 127This (or another 8x8-font) is necessary to use the 50-line screen type on 128.Xr vga 4 129displays. 130.Bd -literal -offset indent 131# wsfontload -N myname -h 8 -e ibm \e 132 /usr/share/misc/pcvtfonts/vt220l.808 133.Ed 134.Sh SEE ALSO 135.Xr wscons 4 , 136.Xr wsconscfg 8 , 137.Xr wsconsctl 8 138.Sh HISTORY 139The 140.Nm 141program appeared in 142.Ox 2.8 . 143.Sh BUGS 144Many features are missing. 145.Pp 146There is no way to remove a loaded font. 147