summaryrefslogtreecommitdiff
path: root/usr/src/man/man1/vtfontcvt.1
diff options
context:
space:
mode:
Diffstat (limited to 'usr/src/man/man1/vtfontcvt.1')
-rw-r--r--usr/src/man/man1/vtfontcvt.187
1 files changed, 87 insertions, 0 deletions
diff --git a/usr/src/man/man1/vtfontcvt.1 b/usr/src/man/man1/vtfontcvt.1
new file mode 100644
index 0000000000..e81073207f
--- /dev/null
+++ b/usr/src/man/man1/vtfontcvt.1
@@ -0,0 +1,87 @@
+.\" Copyright (c) 2014 The FreeBSD Foundation. All rights reserved.
+.\"
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.Dd Jun 23, 2017
+.Dt VTFONTCVT 1
+.Os
+.Sh NAME
+.Nm vtfontcvt
+.Nd "convert font files for use by the video console"
+.Sh SYNOPSIS
+.Nm
+.Op Fl n
+.Op Fl f Ar font Ns | Ns Ar source Ns | Ns Ar compressed-source
+.Op Fl h Ar height
+.Op Fl o Ar output_file
+.Op Fl v
+.Op Fl w Ar width
+.Ar normal_font
+.Op Ar bold_font
+.Sh DESCRIPTION
+The
+.Nm
+utility reads source font files in either BDF or Unifont HEX format and
+outputs a binary font file, C source, or C source with font data compressed
+by using LZ4 compression method.
+The output in C source is intended to be used to embed the font into program
+binary.
+The binary font file is for use by console system.
+The BDF file must use character cell spacing.
+HEX format files must have the file extension
+.Pa .hex .
+.Sh OPTIONS
+The following options are available:
+.Bl -tag -width "12345678"
+.It Fl f Ar font Ns | Ns Ar source Ns | Ns Ar compressed-source
+Specify the output format.
+The default is binary
+.Ar font
+file.
+.It Fl h Ar height
+Set font height.
+The default is 16.
+Font height is set automatically for BDF files that have a
+.Ql FONTBOUNDINGBOX
+property defined in the font header.
+Font height is set automatically for HEX files that have a
+.Ql # Height: Ar height
+comment before any font data.
+.It Fl n
+Do not apply output filtering with C source output.
+.It Fl o Ar output_file
+Specify the name for the output file.
+.It Fl v
+Display verbose statistics about the converted font.
+.It Fl w Ar width
+Set font width.
+The default is 8.
+Font width is set automatically for BDF files that have a
+.Ql FONTBOUNDINGBOX
+property defined in the font header.
+Font width is set automatically for HEX files that have a
+.Ql # Width: Ar width
+comment before any font data.
+.El
+.Sh SEE ALSO
+.Xr consadm 1M