d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

vtfontcvt.8: Improve synopsis and -f documentation

Browse Source 
MFC after:	2 weeks
This commit is contained in:
Mateusz Piotrowski 2022-07-19 16:28:22 +02:00
parent cd8401dbde
commit b38e3722f5
1 changed files with 27 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
usr.bin/vtfontcvt/vtfontcvt.8
View File

@ -24,7 +24,7 @@
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd August 2, 2020 .Dd July 19, 2022
.Dt VTFONTCVT 8 .Dt VTFONTCVT 8
.Os .Os
.Sh NAME .Sh NAME
@ -33,7 +33,7 @@
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Op Fl n .Op Fl n
.Op Fl f Ar font Ns | Ns Ar source Ns | Ns Ar compressed-source .Op Fl f Ar format
.Op Fl h Ar height .Op Fl h Ar height
.Fl o Ar output_file .Fl o Ar output_file
.Op Fl v .Op Fl v
@ -44,22 +44,35 @@
The The
.Nm .Nm
utility reads source font files in either BDF or Unifont HEX format and 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 outputs a file in one of the available output formats.
by using LZ4 compression method. .Pp
The output in C source is intended to be used to embed the font into program HEX format files
binary. .Po Ar normal_font
The binary font file is for use by and
.Xr vt 4 . .Ar bold_font Pc
HEX format files must have the file extension must have the file extension
.Pa .hex . .Pa .hex .
.Pp .Pp
The following options are available: The following options are available:
.Bl -tag -width "12345678" .Bl -tag -width "-o output_file"
.It Fl f Ar font Ns | Ns Ar source Ns | Ns Ar compressed-source .It Fl f Ar format
Specify the output format. Specify the output format.
The default is binary Available formats are:
.Ar font .Bl -tag -width "compressed-source"
file. .It Cm compressed-source
C source with font data compressed by using LZ4 compression method.
.It Cm font
A binary font file
.Pq default .
.It Cm source
C source.
.El
.Pp
The output in C source is intended to be used to embed the font into program
binary.
.Pp
The binary font file is for use by
.Xr vt 4 .
.It Fl h Ar height .It Fl h Ar height
Set font height. Set font height.
The default is 16. The default is 16.