xref: /illumos-gate/usr/src/man/man1/vtfontcvt.1 (revision bbf21555)
14b529e40SToomas Soome.\" Copyright (c) 2014 The FreeBSD Foundation.  All rights reserved.
24b529e40SToomas Soome.\"
34b529e40SToomas Soome.\"
44b529e40SToomas Soome.\" Redistribution and use in source and binary forms, with or without
54b529e40SToomas Soome.\" modification, are permitted provided that the following conditions
64b529e40SToomas Soome.\" are met:
74b529e40SToomas Soome.\" 1. Redistributions of source code must retain the above copyright
84b529e40SToomas Soome.\"    notice, this list of conditions and the following disclaimer.
94b529e40SToomas Soome.\" 2. Redistributions in binary form must reproduce the above copyright
104b529e40SToomas Soome.\"    notice, this list of conditions and the following disclaimer in the
114b529e40SToomas Soome.\"    documentation and/or other materials provided with the distribution.
124b529e40SToomas Soome.\"
134b529e40SToomas Soome.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
144b529e40SToomas Soome.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
154b529e40SToomas Soome.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
164b529e40SToomas Soome.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
174b529e40SToomas Soome.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
184b529e40SToomas Soome.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
194b529e40SToomas Soome.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
204b529e40SToomas Soome.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
214b529e40SToomas Soome.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
224b529e40SToomas Soome.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
234b529e40SToomas Soome.\" SUCH DAMAGE.
244b529e40SToomas Soome.\"
254b529e40SToomas Soome.Dd Jun 23, 2017
264b529e40SToomas Soome.Dt VTFONTCVT 1
274b529e40SToomas Soome.Os
284b529e40SToomas Soome.Sh NAME
294b529e40SToomas Soome.Nm vtfontcvt
304b529e40SToomas Soome.Nd "convert font files for use by the video console"
314b529e40SToomas Soome.Sh SYNOPSIS
324b529e40SToomas Soome.Nm
334b529e40SToomas Soome.Op Fl n
344b529e40SToomas Soome.Op Fl f Ar font Ns | Ns Ar source Ns | Ns Ar compressed-source
354b529e40SToomas Soome.Op Fl h Ar height
364b529e40SToomas Soome.Op Fl o Ar output_file
374b529e40SToomas Soome.Op Fl v
384b529e40SToomas Soome.Op Fl w Ar width
394b529e40SToomas Soome.Ar normal_font
404b529e40SToomas Soome.Op Ar bold_font
414b529e40SToomas Soome.Sh DESCRIPTION
424b529e40SToomas SoomeThe
434b529e40SToomas Soome.Nm
444b529e40SToomas Soomeutility reads source font files in either BDF or Unifont HEX format and
454b529e40SToomas Soomeoutputs a binary font file, C source, or C source with font data compressed
464b529e40SToomas Soomeby using LZ4 compression method.
474b529e40SToomas SoomeThe output in C source is intended to be used to embed the font into program
484b529e40SToomas Soomebinary.
494b529e40SToomas SoomeThe binary font file is for use by console system.
504b529e40SToomas SoomeThe BDF file must use character cell spacing.
514b529e40SToomas SoomeHEX format files must have the file extension
524b529e40SToomas Soome.Pa .hex .
534b529e40SToomas Soome.Sh OPTIONS
544b529e40SToomas SoomeThe following options are available:
554b529e40SToomas Soome.Bl -tag -width "12345678"
564b529e40SToomas Soome.It Fl f Ar font Ns | Ns Ar source Ns | Ns Ar compressed-source
574b529e40SToomas SoomeSpecify the output format.
584b529e40SToomas SoomeThe default is binary
594b529e40SToomas Soome.Ar font
604b529e40SToomas Soomefile.
614b529e40SToomas Soome.It Fl h Ar height
624b529e40SToomas SoomeSet font height.
634b529e40SToomas SoomeThe default is 16.
644b529e40SToomas SoomeFont height is set automatically for BDF files that have a
654b529e40SToomas Soome.Ql FONTBOUNDINGBOX
664b529e40SToomas Soomeproperty defined in the font header.
674b529e40SToomas SoomeFont height is set automatically for HEX files that have a
684b529e40SToomas Soome.Ql # Height: Ar height
694b529e40SToomas Soomecomment before any font data.
704b529e40SToomas Soome.It Fl n
714b529e40SToomas SoomeDo not apply output filtering with C source output.
724b529e40SToomas Soome.It Fl o Ar output_file
734b529e40SToomas SoomeSpecify the name for the output file.
744b529e40SToomas Soome.It Fl v
754b529e40SToomas SoomeDisplay verbose statistics about the converted font.
764b529e40SToomas Soome.It Fl w Ar width
774b529e40SToomas SoomeSet font width.
784b529e40SToomas SoomeThe default is 8.
794b529e40SToomas SoomeFont width is set automatically for BDF files that have a
804b529e40SToomas Soome.Ql FONTBOUNDINGBOX
814b529e40SToomas Soomeproperty defined in the font header.
824b529e40SToomas SoomeFont width is set automatically for HEX files that have a
834b529e40SToomas Soome.Ql # Width: Ar width
844b529e40SToomas Soomecomment before any font data.
854b529e40SToomas Soome.El
864b529e40SToomas Soome.Sh SEE ALSO
87*bbf21555SRichard Lowe.Xr consadm 8
88