mirror of
https://github.com/termux/termux-packages.git
synced 2025-05-10 04:35:37 +00:00
1a1e0f509c
man pages were added in upstream[1] but it requires executing the
programs with help2man. This commit adds those generated man pages.
[1]: 7f10c0edfd
327 lines
8.2 KiB
Groff
327 lines
8.2 KiB
Groff
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
|
|
.TH HB-VIEW "1" "April 2025" "HarfBuzz 11.0.1" "User Commands"
|
|
.SH NAME
|
|
hb-view \- manual page for hb-view 11.0.1
|
|
.SH DESCRIPTION
|
|
.SS "Usage:"
|
|
.IP
|
|
hb\-view [OPTION?] [FONT\-FILE] [TEXT]
|
|
.PP
|
|
View text with given font.
|
|
.SS "Help Options:"
|
|
.TP
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
Show help options
|
|
.TP
|
|
\fB\-\-help\-all\fR
|
|
Show all help options
|
|
.TP
|
|
\fB\-\-help\-face\fR
|
|
Options for the font face
|
|
.TP
|
|
\fB\-\-help\-font\fR
|
|
Options for the font instance
|
|
.TP
|
|
\fB\-\-help\-variations\fR
|
|
Options for font variations used
|
|
.TP
|
|
\fB\-\-help\-text\fR
|
|
Options for the input text
|
|
.TP
|
|
\fB\-\-help\-text\-context\fR
|
|
Options for the input context text
|
|
.TP
|
|
\fB\-\-help\-shape\fR
|
|
Options for the shaping process
|
|
.TP
|
|
\fB\-\-help\-features\fR
|
|
Options for font features used
|
|
.TP
|
|
\fB\-\-help\-view\fR
|
|
Options for output rendering
|
|
.TP
|
|
\fB\-\-help\-output\fR
|
|
Options for the destination & form of the output
|
|
.SS "Font-face options:"
|
|
.TP
|
|
\fB\-\-font\-file\fR=\fI\,filename\/\fR
|
|
Set font file\-name
|
|
.TP
|
|
\fB\-y\fR, \fB\-\-face\-index\fR=\fI\,index\/\fR
|
|
Set face index (default: 0)
|
|
.TP
|
|
\fB\-\-face\-loader\fR=\fI\,loader\/\fR
|
|
Set face loader to use (default: ot)
|
|
.IP
|
|
Supported face loaders are: ot/ft
|
|
.TP
|
|
\fB\-\-list\-face\-loaders\fR
|
|
List available face loaders and quit
|
|
.SS "Font-instance options:"
|
|
.TP
|
|
\fB\-\-font\-size\fR=\fI\,1\/\fR/2 integers or 'upem'
|
|
Font size (default: 256)
|
|
.TP
|
|
\fB\-\-font\-ppem\fR=\fI\,1\/\fR/2 integers
|
|
Set x,y pixels per EM (default: 0; disabled)
|
|
.TP
|
|
\fB\-\-font\-ptem\fR=\fI\,point\-size\/\fR
|
|
Set font point\-size (default: 0; disabled)
|
|
.TP
|
|
\fB\-\-font\-bold\fR=\fI\,1\/\fR/2 numbers; eg. 0.05
|
|
Set synthetic bold (default: 0)
|
|
.TP
|
|
\fB\-\-font\-grade\fR=\fI\,1\/\fR/2 numbers; eg. 0.05
|
|
Set synthetic grade (default: 0)
|
|
.TP
|
|
\fB\-\-font\-slant\fR=\fI\,slant\/\fR ratio; eg. 0.2
|
|
Set synthetic slant (default: 0)
|
|
.TP
|
|
\fB\-\-font\-funcs\fR=\fI\,impl\/\fR
|
|
Set font functions implementation to use (default: ot)
|
|
.IP
|
|
Supported font function implementations are: ot/ft
|
|
.TP
|
|
\fB\-\-list\-font\-funcs\fR
|
|
List available font functions and quit
|
|
.TP
|
|
\fB\-\-ft\-load\-flags\fR=\fI\,integer\/\fR
|
|
Set FreeType load\-flags (default: 2)
|
|
.SS "Variations options:"
|
|
.TP
|
|
\fB\-\-named\-instance\fR=\fI\,index\/\fR
|
|
Set named\-instance index (default: none)
|
|
.TP
|
|
\fB\-\-variations\fR=\fI\,list\/\fR
|
|
Comma\-separated list of font variations
|
|
.IP
|
|
Variations are set globally. The format for specifying variation settings
|
|
follows. All valid CSS font\-variation\-settings values other than 'normal'
|
|
and 'inherited' are also accepted, though, not documented below.
|
|
.IP
|
|
The format is a tag, optionally followed by an equals sign, followed by a
|
|
number. For example:
|
|
.IP
|
|
"wght=500"
|
|
"slnt=\-7.5"
|
|
.PP
|
|
Text options:
|
|
.PP
|
|
If no text is provided, standard input is used for input.
|
|
.TP
|
|
\fB\-\-text\fR=\fI\,string\/\fR
|
|
Set input text
|
|
.TP
|
|
\fB\-\-text\-file\fR=\fI\,filename\/\fR
|
|
Set input text file\-name
|
|
.TP
|
|
\fB\-u\fR, \fB\-\-unicodes\fR=\fI\,list\/\fR of hex numbers
|
|
Set input Unicode codepoints
|
|
.TP
|
|
\fB\-\-single\-par\fR
|
|
Treat text as single paragraph
|
|
.SS "Textual context options:"
|
|
.TP
|
|
\fB\-\-text\-before\fR=\fI\,string\/\fR
|
|
Set text context before each line
|
|
.TP
|
|
\fB\-\-text\-after\fR=\fI\,string\/\fR
|
|
Set text context after each line
|
|
.TP
|
|
\fB\-\-unicodes\-before\fR=\fI\,list\/\fR of hex numbers
|
|
Set Unicode codepoints context before each line
|
|
.TP
|
|
\fB\-\-unicodes\-after\fR=\fI\,list\/\fR of hex numbers
|
|
Set Unicode codepoints context after each line
|
|
.SS "Shape options:"
|
|
.TP
|
|
\fB\-\-shapers\fR=\fI\,comma\-separated\/\fR list
|
|
Set shapers to use (default: graphite2)
|
|
.IP
|
|
Supported shapers are: graphite2/ot/fallback
|
|
.TP
|
|
\fB\-\-list\-shapers\fR
|
|
List available shapers and quit
|
|
.TP
|
|
\fB\-\-direction\fR=\fI\,ltr\/\fR/rtl/ttb/btt
|
|
Set text direction (default: auto)
|
|
.TP
|
|
\fB\-\-language\fR=\fI\,BCP\/\fR 47 tag
|
|
Set text language (default: $LANG)
|
|
.TP
|
|
\fB\-\-script\fR=\fI\,ISO\-15924\/\fR tag
|
|
Set text script (default: auto)
|
|
.TP
|
|
\fB\-\-bot\fR
|
|
Treat text as beginning\-of\-paragraph
|
|
.TP
|
|
\fB\-\-eot\fR
|
|
Treat text as end\-of\-paragraph
|
|
.TP
|
|
\fB\-\-preserve\-default\-ignorables\fR
|
|
Preserve Default\-Ignorable characters
|
|
.TP
|
|
\fB\-\-remove\-default\-ignorables\fR
|
|
Remove Default\-Ignorable characters
|
|
.TP
|
|
\fB\-\-invisible\-glyph\fR
|
|
Glyph value to replace Default\-Ignorables with
|
|
.TP
|
|
\fB\-\-not\-found\-glyph\fR
|
|
Glyph value to replace not\-found characters with
|
|
.TP
|
|
\fB\-\-not\-found\-variation\-selector\-glyph\fR
|
|
Glyph value to replace not\-found variation\-selector characters with
|
|
.TP
|
|
\fB\-\-utf8\-clusters\fR
|
|
Use UTF8 byte indices, not char indices
|
|
.TP
|
|
\fB\-\-cluster\-level\fR=\fI\,0\/\fR/1/2/3
|
|
Cluster merging level (default: 0)
|
|
.TP
|
|
\fB\-\-normalize\-glyphs\fR
|
|
Rearrange glyph clusters in nominal order
|
|
.TP
|
|
\fB\-\-unsafe\-to\-concat\fR
|
|
Produce unsafe\-to\-concat glyph flag
|
|
.TP
|
|
\fB\-\-safe\-to\-insert\-tatweel\fR
|
|
Produce safe\-to\-insert\-tatweel glyph flag
|
|
.TP
|
|
\fB\-\-glyphs\fR
|
|
Interpret input as glyph string
|
|
.TP
|
|
\fB\-\-verify\fR
|
|
Perform sanity checks on shaping results
|
|
.SS "Features options:"
|
|
.TP
|
|
\fB\-\-features\fR=\fI\,list\/\fR
|
|
Comma\-separated list of font features
|
|
.IP
|
|
Features can be enabled or disabled, either globally or limited to
|
|
specific character ranges. The format for specifying feature settings
|
|
follows. All valid CSS font\-feature\-settings values other than 'normal'
|
|
and the global values are also accepted, though not documented below.
|
|
CSS string escapes are not supported.
|
|
The range indices refer to the positions between Unicode characters,
|
|
unless the \fB\-\-utf8\-clusters\fR is provided, in which case range indices
|
|
refer to UTF\-8 byte indices. The position before the first character
|
|
is always 0.
|
|
.TP
|
|
The format is Python\-esque.
|
|
Here is how it all works:
|
|
.TP
|
|
Syntax:
|
|
Value: Start: End:
|
|
.IP
|
|
Setting value:
|
|
.TP
|
|
"kern"
|
|
1 0 ? # Turn feature on
|
|
.TP
|
|
"+kern"
|
|
1 0 ? # Turn feature on
|
|
.TP
|
|
"\-kern"
|
|
0 0 ? # Turn feature off
|
|
.TP
|
|
"kern=0"
|
|
0 0 ? # Turn feature off
|
|
.TP
|
|
"kern=1"
|
|
1 0 ? # Turn feature on
|
|
.TP
|
|
"aalt=2"
|
|
2 0 ? # Choose 2nd alternate
|
|
.IP
|
|
Setting index:
|
|
.TP
|
|
"kern[]"
|
|
1 0 ? # Turn feature on
|
|
.TP
|
|
"kern[:]"
|
|
1 0 ? # Turn feature on
|
|
.TP
|
|
"kern[5:]"
|
|
1 5 ? # Turn feature on, partial
|
|
.TP
|
|
"kern[:5]"
|
|
1 0 5 # Turn feature on, partial
|
|
.TP
|
|
"kern[3:5]"
|
|
1 3 5 # Turn feature on, range
|
|
.TP
|
|
"kern[3]"
|
|
1 3 3+1 # Turn feature on, single char
|
|
.IP
|
|
Mixing it all:
|
|
.TP
|
|
"aalt[3:5]=2" 2
|
|
3 5 # Turn 2nd alternate on for range
|
|
.SS "View options:"
|
|
.TP
|
|
\fB\-\-background\fR=\fI\,rrggbb\/\fR/rrggbbaa
|
|
Set background color (default: #FFFFFF)
|
|
.TP
|
|
\fB\-\-foreground\fR=\fI\,rrggbb\/\fR/rrggbbaa
|
|
Set foreground color (default: #000000)
|
|
.TP
|
|
\fB\-\-font\-palette\fR=\fI\,index\/\fR
|
|
Set font palette (default: 0)
|
|
.TP
|
|
\fB\-\-custom\-palette\fR=\fI\,comma\-separated\/\fR colors
|
|
Custom palette
|
|
.TP
|
|
\fB\-\-line\-space\fR=\fI\,units\/\fR
|
|
Set space between lines (default: 0)
|
|
.TP
|
|
\fB\-\-font\-extents\fR=\fI\,one\/\fR to three numbers
|
|
Set font ascent/descent/line\-gap (default: auto)
|
|
.TP
|
|
\fB\-\-margin\fR=\fI\,one\/\fR to four numbers
|
|
Margin around output (default: 16)
|
|
.TP
|
|
\fB\-\-show\-extents\fR
|
|
Draw glyph extents
|
|
.SS "Output destination & format options:"
|
|
.TP
|
|
\fB\-o\fR, \fB\-\-output\-file\fR=\fI\,filename\/\fR
|
|
Set output file\-name (default: stdout)
|
|
.TP
|
|
\fB\-O\fR, \fB\-\-output\-format\fR=\fI\,format\/\fR
|
|
Set output format
|
|
.IP
|
|
Supported output formats are: ansi/png/svg/pdf/ps/eps/script
|
|
.SS "Application Options:"
|
|
.TP
|
|
\fB\-\-version\fR
|
|
Show version numbers
|
|
.TP
|
|
\fB\-n\fR, \fB\-\-num\-iterations\fR=\fI\,N\/\fR
|
|
Run shaper N times (default: 1)
|
|
.PP
|
|
Shows image of rendering text with a given font in various formats.
|
|
.SH "EXIT CODES"
|
|
.IP
|
|
0: Success.
|
|
.IP
|
|
1: Option parsing failed.
|
|
.IP
|
|
2: Failed loading font face.
|
|
.IP
|
|
3: Operation failed.
|
|
.IP
|
|
4: Failed setting font functions.
|
|
.SH ENVIRONMENT
|
|
.IP
|
|
HB_FACE_LOADER=face\-loader; Overrides the default face loader.
|
|
.IP
|
|
HB_FONT_FUNCS=font\-funcs; Overrides the default font\-funcs.
|
|
.IP
|
|
HB_SHAPER_LIST=shaper\-list; Overrides the default shaper list.
|
|
.SH "SEE ALSO"
|
|
.IP
|
|
hb\-view(1), hb\-shape(1), hb\-subset(1), hb\-info(1)
|
|
.PP
|
|
Find more information or report bugs at <https://github.com/harfbuzz/harfbuzz>
|