xref: /freebsd/usr.bin/vtfontcvt/vtfontcvt.8 (revision af23369a6deaaeb612ab266eb88b8bb8d560c322)
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.\" $FreeBSD$
26.\"
27.Dd July 19, 2022
28.Dt VTFONTCVT 8
29.Os
30.Sh NAME
31.Nm vtfontcvt
32.Nd "convert font files for use by the video console"
33.Sh SYNOPSIS
34.Nm
35.Op Fl nv
36.Op Fl f Ar format
37.Op Fl h Ar height
38.Op Fl w Ar width
39.Fl o Ar output_file
40.Ar normal_font
41.Op Ar bold_font
42.Sh DESCRIPTION
43The
44.Nm
45utility reads source font files in either BDF or Unifont HEX format and
46outputs a file in one of the available output formats.
47.Pp
48HEX format files
49.Po Ar normal_font
50and
51.Ar bold_font Pc
52must have the file extension
53.Pa .hex .
54.Pp
55The following options are available:
56.Bl -tag -width "-o output_file"
57.It Fl f Ar format
58Specify the output format.
59Available formats are:
60.Bl -tag -width "compressed-source"
61.It Cm compressed-source
62C source with font data compressed by using LZ4 compression method.
63.It Cm font
64A binary font file
65.Pq default .
66.It Cm source
67C source.
68.El
69.Pp
70The output in C source is intended to be used to embed the font into program
71binary.
72.Pp
73The binary font file is for use by
74.Xr vt 4 .
75.It Fl h Ar height
76Set font height.
77The default is 16.
78Font height is set automatically for BDF files and for HEX files that have a
79.D1 # Height: Ar height
80comment before any font data.
81.It Fl n
82Do not apply output filtering with C source output.
83.It Fl o Ar output_file
84Specify the name for the output file.
85.It Fl v
86Display verbose statistics about the converted font.
87.It Fl w Ar width
88Set font width.
89The default is 8.
90Font width is set automatically for BDF files and for HEX files that have a
91.D1 # Width: Ar width
92comment before any font data.
93.El
94.Sh SEE ALSO
95.Xr vidcontrol 1 ,
96.Xr vt 4
97.Sh HISTORY
98The
99.Nm
100utility first appeared in
101.Fx 10.1 .
102