xref: /illumos-gate/usr/src/man/man1/vtfontcvt.1 (revision 3299f39fdcbdab4be7a9c70daa3873f2b78a398d)
1.\" Copyright (c) 2014 The FreeBSD Foundation.  All rights reserved.
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 Jun 23, 2017
26.Dt VTFONTCVT 1
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 n
34.Op Fl f Ar font Ns | Ns Ar source Ns | Ns Ar compressed-source
35.Op Fl h Ar height
36.Op Fl o Ar output_file
37.Op Fl v
38.Op Fl w Ar width
39.Ar normal_font
40.Op Ar bold_font
41.Sh DESCRIPTION
42The
43.Nm
44utility reads source font files in either BDF or Unifont HEX format and
45outputs a binary font file, C source, or C source with font data compressed
46by using LZ4 compression method.
47The output in C source is intended to be used to embed the font into program
48binary.
49The binary font file is for use by console system.
50The BDF file must use character cell spacing.
51HEX format files must have the file extension
52.Pa .hex .
53.Sh OPTIONS
54The following options are available:
55.Bl -tag -width "12345678"
56.It Fl f Ar font Ns | Ns Ar source Ns | Ns Ar compressed-source
57Specify the output format.
58The default is binary
59.Ar font
60file.
61.It Fl h Ar height
62Set font height.
63The default is 16.
64Font height is set automatically for BDF files that have a
65.Ql FONTBOUNDINGBOX
66property defined in the font header.
67Font height is set automatically for HEX files that have a
68.Ql # Height: Ar height
69comment before any font data.
70.It Fl n
71Do not apply output filtering with C source output.
72.It Fl o Ar output_file
73Specify the name for the output file.
74.It Fl v
75Display verbose statistics about the converted font.
76.It Fl w Ar width
77Set font width.
78The default is 8.
79Font width is set automatically for BDF files that have a
80.Ql FONTBOUNDINGBOX
81property defined in the font header.
82Font width is set automatically for HEX files that have a
83.Ql # Width: Ar width
84comment before any font data.
85.El
86.Sh SEE ALSO
87.Xr consadm 1M
88