xref: /freebsd/usr.bin/vtfontcvt/vtfontcvt.8 (revision 5f4c09dd85bff675e0ca63c55ea3c517e0fddfcc)
1.\" Copyright (c) 2014 The FreeBSD Foundation.
2.\"
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd July 19, 2022
26.Dt VTFONTCVT 8
27.Os
28.Sh NAME
29.Nm vtfontcvt
30.Nd "convert font files for use by the video console"
31.Sh SYNOPSIS
32.Nm
33.Op Fl nv
34.Op Fl f Ar format
35.Op Fl h Ar height
36.Op Fl w Ar width
37.Fl o Ar output_file
38.Ar normal_font
39.Op Ar bold_font
40.Sh DESCRIPTION
41The
42.Nm
43utility reads source font files in either BDF or Unifont HEX format and
44outputs a file in one of the available output formats.
45.Pp
46HEX format files
47.Po Ar normal_font
48and
49.Ar bold_font Pc
50must have the file extension
51.Pa .hex .
52.Pp
53The following options are available:
54.Bl -tag -width "-o output_file"
55.It Fl f Ar format
56Specify the output format.
57Available formats are:
58.Bl -tag -width "compressed-source"
59.It Cm compressed-source
60C source with font data compressed by using LZ4 compression method.
61.It Cm font
62A binary font file
63.Pq default .
64.It Cm source
65C source.
66.El
67.Pp
68The output in C source is intended to be used to embed the font into program
69binary.
70.Pp
71The binary font file is for use by
72.Xr vt 4 .
73.It Fl h Ar height
74Set font height.
75The default is 16.
76Font height is set automatically for BDF files and for HEX files that have a
77.D1 # Height: Ar height
78comment before any font data.
79.It Fl n
80Do not apply output filtering with C source output.
81.It Fl o Ar output_file
82Specify the name for the output file.
83.It Fl v
84Display verbose statistics about the converted font.
85.It Fl w Ar width
86Set font width.
87The default is 8.
88Font width is set automatically for BDF files and for HEX files that have a
89.D1 # Width: Ar width
90comment before any font data.
91.El
92.Sh SEE ALSO
93.Xr vidcontrol 1 ,
94.Xr vt 4
95.Sh HISTORY
96The
97.Nm
98utility first appeared in
99.Fx 10.1 .
100