diff options
| author | Mattias Andrée <maandree@kth.se> | 2022-07-17 18:49:27 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2022-07-17 18:49:27 +0200 |
| commit | e0e5cfa84da527d0a2cc818bcf5b9be83615e1c2 (patch) | |
| tree | 7297f946c832256845735837aa639a1975c6a9a3 /libparsepsf.h | |
| parent | Fix value of *unrecognised_versionp (diff) | |
| download | libparsepsf-e0e5cfa84da527d0a2cc818bcf5b9be83615e1c2.tar.gz libparsepsf-e0e5cfa84da527d0a2cc818bcf5b9be83615e1c2.tar.bz2 libparsepsf-e0e5cfa84da527d0a2cc818bcf5b9be83615e1c2.tar.xz | |
Add man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
| -rw-r--r-- | libparsepsf.h | 2 | ||||
| -rw-r--r-- | libparsepsf.h.0 | 39 |
2 files changed, 40 insertions, 1 deletions
diff --git a/libparsepsf.h b/libparsepsf.h index 74b229b..8e98789 100644 --- a/libparsepsf.h +++ b/libparsepsf.h @@ -60,7 +60,7 @@ struct libparsepsf_font { /** * Glyph trie, maps from byte sequences to glyph indices; * you can use `libparsepsf_get_glyph` to search it - * (enumeration has to be done manually); not that an + * (enumeration has to be done manually); note that an * entry can be multiple characters wide, for example * to deal with context dependent glyphs and grapheme * clusters diff --git a/libparsepsf.h.0 b/libparsepsf.h.0 new file mode 100644 index 0000000..b3193eb --- /dev/null +++ b/libparsepsf.h.0 @@ -0,0 +1,39 @@ +.TH LIBPARSEPSF.H 0 LIBPARSEPSF +.SH NAME +libparsepsf.h \- Header file for interpreting PSF (PC Screen Font) files. +.SH SYNOPSIS +.nf +#include <libparsepsf.h> +.fi +.PP +Link with +.IR -lparsepsf . +.SH DESCRIPTION +The +.B <libparsepsf.h> +header defines structures and functions for interpreting PSF +(PC Screen Font) files. +.PP +This header defines the following functions: +.TP +.BR libparsepsf_parse_font (3) +Parse a PSF file. +.TP +.BR libparsepsf_get_glyph (3) +Get glyph to use at a position in a text string. +.TP +.BR libparsepsf_destroy_font (3) +Deallocate a parsed PSF file. +.PP +This header defines the following structures: +.TP +.B struct libparsepsf_font +Structure containing all font information. +.TP +.B struct libparsepsf_unimap +Node for byte-sequence-to-glyph mapping trie. +.SH SEE ALSO +.BR libparsepsf (7), +.BR libparsepsf_parse_font (3), +.BR libparsepsf_get_glyph (3), +.BR libparsepsf_destroy_font (3) |