usr.bin/vtfontcvt/vtfontcvt.8

   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 .\" $FreeBSD$
  26 .\"
  27 .Dd August 2, 2020
  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 n
  36 .Op Fl f Ar font Ns | Ns Ar source Ns | Ns Ar compressed-source
  37 .Op Fl h Ar height
  38 .Fl o Ar output_file
  39 .Op Fl v
  40 .Op Fl w Ar width
  41 .Ar normal_font
  42 .Op Ar bold_font
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 utility reads source font files in either BDF or Unifont HEX format and
  47 outputs a binary font file, C source, or C source with font data compressed
  48 by using LZ4 compression method.
  49 The output in C source is intended to be used to embed the font into program
  50 binary.
  51 The binary font file is for use by
  52 .Xr vt 4 .
  53 HEX format files must have the file extension
  54 .Pa .hex .
  55 .Pp
  56 The following options are available:
  57 .Bl -tag -width "12345678"
  58 .It Fl f Ar font Ns | Ns Ar source Ns | Ns Ar compressed-source
  59 Specify the output format.
  60 The default is binary
  61 .Ar font
  62 file.
  63 .It Fl h Ar height
  64 Set font height.
  65 The default is 16.
  66 Font height is set automatically for BDF files and for HEX files that have a
  67 .Ql # Height: Ar height
  68 comment before any font data.
  69 .It Fl n
  70 Do not apply output filtering with C source output.
  71 .It Fl o Ar output_file
  72 Specify the name for the output file.
  73 .It Fl v
  74 Display verbose statistics about the converted font.
  75 .It Fl w Ar width
  76 Set font width.
  77 The default is 8.
  78 Font width is set automatically for BDF files and for HEX files that have a
  79 .Ql # Width: Ar width
  80 comment before any font data.
  81 .El
  82 .Sh SEE ALSO
  83 .Xr vidcontrol 1 ,
  84 .Xr vt 4
  85 .Sh HISTORY
  86 The
  87 .Nm
  88 utility first appeared in
  89 .Fx 10.1 .